kicad/include/tool/action_menu.h

278 lines
8.0 KiB
C
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2013-2017 CERN
2020-12-27 00:41:04 +00:00
* Copyright (C) 2020 KiCad Developers, see AUTHORS.txt for contributors.
*
* @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
* @author Maciej Suminski <maciej.suminski@cern.ch>
*
* 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, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef __CONTEXT_MENU_H
#define __CONTEXT_MENU_H
#include <map>
#include <list>
#include <functional>
#include <wx/menu.h>
#include <wx/textentry.h>
#include <tool/tool_event.h>
2021-09-14 22:45:14 +00:00
class KIFACE_BASE;
class TOOL_INTERACTIVE;
class TOOL_MANAGER;
enum class BITMAPS : unsigned int;
/**
* Defines the structure of a menu based on ACTIONs.
*/
class ACTION_MENU : public wxMenu
{
public:
2020-12-27 00:41:04 +00:00
///< Default constructor
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;
/**
2020-12-27 00:41:04 +00:00
* Set title for the menu. The title is shown as a text label shown on the top of
* the menu.
*
* @param aTitle is the new title.
*/
2016-09-24 18:53:15 +00:00
void SetTitle( const wxString& aTitle ) override;
/**
2020-12-27 00:41:04 +00:00
* Decide whether a title for a pop up menu should be displayed.
*/
void DisplayTitle( bool aDisplay = true );
2015-04-02 14:09:48 +00:00
/**
2020-12-27 00:41:04 +00:00
* Assign an icon for the entry.
*
2015-04-02 14:09:48 +00:00
* @param aIcon is the icon to be assigned. NULL is used to remove icon.
*/
void SetIcon( BITMAPS aIcon );
2015-04-02 14:09:48 +00:00
/**
2020-12-27 00:41:04 +00:00
* Add a wxWidgets-style entry to the menu.
*
* After highlighting/selecting the entry, a wxWidgets event is generated.
*/
wxMenuItem* Add( const wxString& aLabel, int aId, BITMAPS aIcon );
wxMenuItem* Add( const wxString& aLabel, const wxString& aToolTip, int aId,
BITMAPS aIcon, bool aIsCheckmarkEntry = false );
/**
2020-12-27 00:41:04 +00:00
* Add an entry to the menu based on the #TOOL_ACTION object.
*
* After selecting the entry, a #TOOL_EVENT command containing name of the action is sent.
*
* @param aAction is the action to be added to menu entry.
* @param aIsCheckmarkEntry is true to indicate a check menu entry, false for normal menu entry
* @param aOverrideLabel is the label to show in the menu (overriding the action's menu text)
* when non-empty
*/
wxMenuItem* Add( const TOOL_ACTION& aAction, bool aIsCheckmarkEntry = false,
const wxString& aOverrideLabel = wxEmptyString );
2015-04-02 14:09:48 +00:00
/**
2020-12-27 00:41:04 +00:00
* Add an action menu as a submenu.
*
* The difference between this function and wxMenu::AppendSubMenu() is the capability to
* handle icons.
*
* @param aMenu is the submenu to be added. This should be a new instance (use Clone()) if required
* as the menu is destructed after use.
2015-04-02 14:09:48 +00:00
*/
wxMenuItem* Add( ACTION_MENU* aMenu );
2015-04-02 14:09:48 +00:00
/**
* Add a standard close item to the menu with the accelerator key CTRL-W.
2020-12-27 00:41:04 +00:00
*
* Emits the wxID_CLOSE event.
*
2020-12-27 00:41:04 +00:00
* @param aAppname is the application name to append to the tooltip.
*/
void AddClose( const wxString& aAppname = "" );
/**
2020-12-27 00:41:04 +00:00
* Add either a standard Quit or Close item to the menu.
*
* If \a aKiface is NULL or in single-instance then quit (wxID_QUIT) is used, otherwise
* close (wxID_CLOSE) is used.
*
2020-12-27 00:41:04 +00:00
* @param aAppname is the application name to append to the tooltip.
*/
2021-09-14 22:45:14 +00:00
void AddQuitOrClose( KIFACE_BASE* aKiface, wxString aAppname = "" );
/**
2020-12-27 00:41:04 +00:00
* Remove all the entries from the menu (as well as its title).
*
* It leaves the menu in the initial state.
*/
void Clear();
/**
* Returns true if the menu has any enabled items
*/
bool HasEnabledItems() const;
/**
2020-12-27 00:41:04 +00:00
* Return the position of selected item.
*
* If the returned value is negative, that means that menu was dismissed.
*
* @return The position of selected item in the action menu.
*/
inline int GetSelected() const
{
return m_selected;
}
/**
2020-12-27 00:41:04 +00:00
* Run update handlers for the menu and its submenus.
*/
void UpdateAll();
/**
* Used by some menus to just-in-time translate their titles.
*/
virtual void UpdateTitle() {}
/**
2020-12-27 00:41:04 +00:00
* Clear the dirty flag on the menu and all descendants.
*/
void ClearDirty();
void SetDirty();
/**
2020-12-27 00:41:04 +00:00
* Set a tool that is the creator of the menu.
*
* @param aTool is the tool that created the menu.
*/
void SetTool( TOOL_INTERACTIVE* aTool );
/**
2020-12-27 00:41:04 +00:00
* Create a deep, recursive copy of this ACTION_MENU.
*/
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;
2015-06-19 15:32:33 +00:00
protected:
2020-12-27 00:41:04 +00:00
///< Return an instance of this class. It has to be overridden in inheriting classes.
virtual ACTION_MENU* create() const;
2020-12-27 00:41:04 +00:00
///< Returns an instance of TOOL_MANAGER class.
TOOL_MANAGER* getToolManager() const;
2015-06-19 15:32:33 +00:00
/**
2020-12-27 00:41:04 +00:00
* Update menu state stub.
*
* It is called before a menu is shown, in order to update its state. Here you can tick
* current settings, enable/disable entries, etc.
*/
virtual void update()
{
}
/**
2020-12-27 00:41:04 +00:00
* Event handler stub.
*
* It should be used if you want to generate a #TOOL_EVENT from a wxMenuEvent. It will be
* called when a menu entry is clicked.
*/
virtual OPT_TOOL_EVENT eventHandler( const wxMenuEvent& )
{
return OPT_TOOL_EVENT();
}
/**
2020-12-27 00:41:04 +00:00
* Copy another menus data to this instance.
*
* Old entries are preserved and ones form aMenu are copied.
*/
void copyFrom( const ACTION_MENU& aMenu );
protected:
/**
2020-12-27 00:41:04 +00:00
* Append a copy of wxMenuItem.
*/
wxMenuItem* appendCopy( const wxMenuItem* aSource );
2020-12-27 00:41:04 +00:00
///< Initialize handlers for events.
void setupEvents();
2020-12-27 00:41:04 +00:00
///< Update hot key settings for TOOL_ACTIONs in this menu.
void updateHotKeys();
2020-12-27 00:41:04 +00:00
///< Traverse the submenus tree looking for a submenu capable of handling a particular menu
///< event. In case it is handled, it is returned the aToolEvent parameter.
void runEventHandlers( const wxMenuEvent& aMenuEvent, OPT_TOOL_EVENT& aToolEvent );
2020-12-27 00:41:04 +00:00
///< Run a function on the menu and all its submenus.
void runOnSubmenus( std::function<void(ACTION_MENU*)> aFunction );
2020-12-27 00:41:04 +00:00
///< Check if any of submenus contains a TOOL_ACTION with a specific ID.
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;
2020-12-27 00:41:04 +00:00
///< Menu title
wxString m_title;
2020-12-27 00:41:04 +00:00
///< Optional icon
BITMAPS m_icon;
2020-12-27 00:41:04 +00:00
///< Stores the id number of selected item.
int m_selected;
2020-12-27 00:41:04 +00:00
///< Creator of the menu
TOOL_INTERACTIVE* m_tool;
2020-12-27 00:41:04 +00:00
///< Associates tool actions with menu item IDs. Non-owning.
std::map<int, const TOOL_ACTION*> m_toolActions;
2020-12-27 00:41:04 +00:00
///< List of submenus.
std::list<ACTION_MENU*> m_submenus;
friend class TOOL_INTERACTIVE;
};
#endif