action_menu.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2013-2017 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Tomasz Wlostowski <[email protected]>
 * @author Maciej Suminski <[email protected]>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <map>
#include <list>
#include <functional>
 
#include <wx/menu.h>
#include <tool/tool_event.h>
 
class KIFACE_BASE;
class TOOL_INTERACTIVE;
class TOOL_MANAGER;
 
enum class BITMAPS : unsigned int;

class ACTION_MENU : public wxMenu
{
public:
    ACTION_MENU( bool isContextMenu, TOOL_INTERACTIVE* aTool = nullptr );
 
    ~ACTION_MENU() override;
 
    ACTION_MENU( const ACTION_MENU& aMenu ) = delete;
    ACTION_MENU& operator=( const ACTION_MENU& aMenu ) = delete;

    void SetTitle( const wxString& aTitle ) override;
    void SetUntranslatedTitle( const wxString& aTitle ) { m_untranslatedTitle = aTitle; }
 
    // Yes, it hides a non-virtual method in the parent class.
    wxString GetTitle() const { return m_title; }

    void DisplayTitle( bool aDisplay = true );

    void SetIcon( BITMAPS aIcon );

    wxMenuItem* Add( const wxString& aLabel, int aId, BITMAPS aIcon );
    wxMenuItem* Add( const wxString& aLabel, const wxString& aToolTip, int aId,
                     BITMAPS aIcon,  bool aIsCheckmarkEntry = false );

    wxMenuItem* Add( const TOOL_ACTION& aAction, bool aIsCheckmarkEntry = false,
                     const wxString& aOverrideLabel = wxEmptyString );

    wxMenuItem* Add( ACTION_MENU* aMenu );

    void AddClose( const wxString& aAppname = "" );

    void AddQuitOrClose( KIFACE_BASE* aKiface, wxString aAppname = "" );

    void AddQuit( const wxString& aAppname = "" );

    void Clear();

    bool HasEnabledItems() const;

    inline int GetSelected() const
    {
        return m_selected;
    }

    void UpdateAll();

    virtual void UpdateTitle()
    {
        if( !m_untranslatedTitle.IsEmpty() )
            m_title = wxGetTranslation( m_untranslatedTitle );
    }

    void ClearDirty();
    void SetDirty();

    void SetTool( TOOL_INTERACTIVE* aTool );

    ACTION_MENU* Clone() const;
 
    void OnMenuEvent( wxMenuEvent& aEvent );
    void OnIdle( wxIdleEvent& event );
 
    virtual bool PassHelpTextToHandler() { return false; }
 
    static constexpr bool NORMAL = false;
    static constexpr bool CHECK  = true;
 
protected:
    virtual ACTION_MENU* create() const;

    TOOL_MANAGER* getToolManager() const;

    virtual void update()
    {
    }

    virtual OPT_TOOL_EVENT eventHandler( const wxMenuEvent& )
    {
        return OPT_TOOL_EVENT();
    }

    void copyFrom( const ACTION_MENU& aMenu );
 
protected:
    wxMenuItem* appendCopy( const wxMenuItem* aSource );

    void setupEvents();

    void updateHotKeys();

    void runEventHandlers( const wxMenuEvent& aMenuEvent, OPT_TOOL_EVENT& aToolEvent );

    void runOnSubmenus( std::function<void(ACTION_MENU*)> aFunction );

    OPT_TOOL_EVENT findToolAction( int aId );
 
    bool    m_isForcedPosition;
    wxPoint m_forcedPosition;
 
    bool m_dirty;               // Menu requires update before display
 
    bool m_titleDisplayed;
    bool m_isContextMenu;

    wxString m_title;
    wxString m_untranslatedTitle;

    BITMAPS m_icon;

    int m_selected;

    TOOL_INTERACTIVE* m_tool;

    std::map<int, const TOOL_ACTION*> m_toolActions;

    std::list<ACTION_MENU*> m_submenus;
 
    friend class TOOL_INTERACTIVE;
};