menubtn.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef INCLUDED_VCL_MENUBTN_HXX
#define INCLUDED_VCL_MENUBTN_HXX

#include <config_options.h>
#include <vcl/button.hxx>
#include <vcl/dllapi.h>
#include <memory>

class Timer;
class PopupMenu;

class VCL_DLLPUBLIC MenuButton : public PushButton
{
private:
    friend class VclBuilder;

    std::unique_ptr<Timer> mpMenuTimer;
    VclPtr<PopupMenu> mpMenu;
    VclPtr<Window>  mpFloatingWindow;
    OString         msCurItemIdent;
    sal_uInt16      mnCurItemId;
    bool            mbDelayMenu;
    bool            mbStartingMenu;
    Link<MenuButton*,void> maActivateHdl;
    Link<MenuButton*,void> maSelectHdl;

    DECL_DLLPRIVATE_LINK( ImplMenuTimeoutHdl, Timer*, void );

                           MenuButton( const MenuButton & ) = delete;
                           MenuButton& operator=( const MenuButton & ) = delete;

protected:
    using Window::ImplInit;
    SAL_DLLPRIVATE void    ImplInit( vcl::Window* pParent, WinBits nStyle );

public:
    explicit        MenuButton( vcl::Window* pParent, WinBits nStyle = 0 );
    virtual         ~MenuButton() override;
    virtual void    dispose() override;

    virtual void    MouseButtonDown( const MouseEvent& rMEvt ) override;
    virtual void    KeyInput( const KeyEvent& rKEvt ) override;

    virtual void    Activate() override;
    virtual void    Select();

    void            ExecuteMenu();
    bool            InPopupMode() const;
    void            CancelMenu();

    //if false then the whole button launches the menu
    //if true, then the button has a separator
    //where the right portion launches the menu immediately
    //where the left portion activates the underlying Button handlers
    //before launching the menu in an idle, allowing it to be cancelled
    //before being shown
    void            SetDelayMenu(bool bDelay) { mbDelayMenu = bDelay; }

    void            SetPopupMenu(PopupMenu* pNewMenu);
    PopupMenu*      GetPopupMenu() const { return mpMenu; }

    void            SetPopover(Window* pWindow);

    OString const & GetCurItemIdent() const { return msCurItemIdent; }

    void            SetActivateHdl( const Link<MenuButton *, void>& rLink ) { maActivateHdl = rLink; }
    void            SetSelectHdl( const Link<MenuButton *, void>& rLink ) { maSelectHdl = rLink; }

    virtual FactoryFunction GetUITestFactory() const override;

    void SetCurItemId();

};

#endif // INCLUDED_VCL_MENUBTN_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */