CONDITIONAL_MENU Class Reference

#include <conditional_menu.h>

Inheritance diagram for CONDITIONAL_MENU:

Classes
class	ENTRY
	< Helper class to organize menu entries. Inserts the entry, preserving the requested order. More...

Public Member Functions
	CONDITIONAL_MENU (TOOL_INTERACTIVE *aTool)
ACTION_MENU *	create () const override
	Return an instance of this class. It has to be overridden in inheriting classes.
void	AddItem (const TOOL_ACTION &aAction, const SELECTION_CONDITION &aCondition, int aOrder=ANY_ORDER)
	Add a menu entry to run a TOOL_ACTION on selected items.
void	AddItem (int aId, const wxString &aText, const wxString &aTooltip, BITMAPS aIcon, const SELECTION_CONDITION &aCondition, int aOrder=ANY_ORDER)
void	AddCheckItem (const TOOL_ACTION &aAction, const SELECTION_CONDITION &aCondition, int aOrder=ANY_ORDER)
	Add a checked menu entry to run a TOOL_ACTION on selected items.
void	AddCheckItem (int aId, const wxString &aText, const wxString &aTooltip, BITMAPS aIcon, const SELECTION_CONDITION &aCondition, int aOrder=ANY_ORDER)
void	AddMenu (ACTION_MENU *aMenu, const SELECTION_CONDITION &aCondition=SELECTION_CONDITIONS::ShowAlways, int aOrder=ANY_ORDER)
	Add a submenu to the menu.
void	AddSeparator (int aOrder=ANY_ORDER)
	Add a separator to the menu.
void	AddSeparator (const SELECTION_CONDITION &aCondition, int aOrder=ANY_ORDER)
void	Evaluate (const SELECTION &aSelection)
	Update the contents of the menu based on the supplied conditions.
void	Resolve ()
	Update the initial contents so that wxWidgets doesn't get its knickers tied in a knot over the menu being empty (mainly an issue on GTK, but also on OSX with the preferences and quit menu items).
void	SetTitle (const wxString &aTitle) override
	Set title for the menu.
wxString	GetTitle () const
void	DisplayTitle (bool aDisplay=true)
	Decide whether a title for a pop up menu should be displayed.
void	SetIcon (BITMAPS aIcon)
	Assign an icon for the entry.
wxMenuItem *	Add (const wxString &aLabel, int aId, BITMAPS aIcon)
	Add a wxWidgets-style entry to the menu.
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)
	Add an entry to the menu based on the TOOL_ACTION object.
wxMenuItem *	Add (ACTION_MENU *aMenu)
	Add an action menu as a submenu.
void	AddClose (const wxString &aAppname="")
	Add a standard close item to the menu with the accelerator key CTRL-W.
void	AddQuitOrClose (KIFACE_BASE *aKiface, wxString aAppname="")
	Add either a standard Quit or Close item to the menu.
void	AddQuit (const wxString &aAppname="")
	Add a standard Quit item to the menu.
void	Clear ()
	Remove all the entries from the menu (as well as its title).
bool	HasEnabledItems () const
	Return true if the menu has any enabled items.
int	GetSelected () const
	Return the position of selected item.
void	UpdateAll ()
	Run update handlers for the menu and its submenus.
virtual void	UpdateTitle ()
	Used by some menus to just-in-time translate their titles.
void	ClearDirty ()
	Clear the dirty flag on the menu and all descendants.
void	SetDirty ()
void	SetTool (TOOL_INTERACTIVE *aTool)
	Set a tool that is the creator of the menu.
ACTION_MENU *	Clone () const
	Create a deep, recursive copy of this ACTION_MENU.
void	OnMenuEvent (wxMenuEvent &aEvent)
void	OnIdle (wxIdleEvent &event)
virtual bool	PassHelpTextToHandler ()

Static Public Attributes
static const int	ANY_ORDER = -1
	< Constant to indicate that we do not care about an #ENTRY location in the menu.
static constexpr bool	NORMAL = false
static constexpr bool	CHECK = true

Protected Member Functions
TOOL_MANAGER *	getToolManager () const
	Return an instance of TOOL_MANAGER class.
virtual void	update ()
	Update menu state stub.
virtual OPT_TOOL_EVENT	eventHandler (const wxMenuEvent &)
	Event handler stub.
void	copyFrom (const ACTION_MENU &aMenu)
	Copy another menus data to this instance.
wxMenuItem *	appendCopy (const wxMenuItem *aSource)
	Append a copy of wxMenuItem.
void	setupEvents ()
	Initialize handlers for events.
void	updateHotKeys ()
	Update hot key settings for TOOL_ACTIONs in this menu.
void	runEventHandlers (const wxMenuEvent &aMenuEvent, OPT_TOOL_EVENT &aToolEvent)
	Traverse the submenus tree looking for a submenu capable of handling a particular menu event.
void	runOnSubmenus (std::function< void(ACTION_MENU *)> aFunction)
	Run a function on the menu and all its submenus.
OPT_TOOL_EVENT	findToolAction (int aId)
	Check if any of submenus contains a TOOL_ACTION with a specific ID.

Protected Attributes
bool	m_isForcedPosition
wxPoint	m_forcedPosition
bool	m_dirty
bool	m_titleDisplayed
bool	m_isContextMenu
wxString	m_title
	Menu title.
BITMAPS	m_icon
	Optional icon.
int	m_selected
	Store the id number of selected item.
TOOL_INTERACTIVE *	m_tool
	Creator of the menu.
std::map< int, const TOOL_ACTION * >	m_toolActions
	Associates tool actions with menu item IDs. Non-owning.
std::list< ACTION_MENU * >	m_submenus
	List of submenus.

Private Member Functions
void	addEntry (ENTRY aEntry)
	List of all menu entries.

Private Attributes
std::list< ENTRY >	m_entries

Detailed Description

Definition at line 41 of file conditional_menu.h.

Constructor & Destructor Documentation

CONDITIONAL_MENU()

CONDITIONAL_MENU::CONDITIONAL_MENU

(

TOOL_INTERACTIVE *

aTool

)

Definition at line 34 of file conditional_menu.cpp.

Member Function Documentation

Add() [1/4]

wxMenuItem * ACTION_MENU::Add ( ACTION_MENU *  aMenu )

inherited

Add an action menu as a submenu.

The difference between this function and wxMenu::AppendSubMenu() is the capability to handle icons.

Parameters

aMenu

is the submenu to be added. This should be a new instance (use Clone()) if required as the menu is destructed after use.

Definition at line 190 of file action_menu.cpp.

References KIUI::AddBitmapToMenuItem(), KiBitmapBundle(), ACTION_MENU::m_icon, ACTION_MENU::m_submenus, and ACTION_MENU::m_title.

Add() [2/4]

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

inherited

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.

Parameters

aAction	is the action to be added to menu entry.
aIsCheckmarkEntry	is true to indicate a check menu entry, false for normal menu entry
aOverrideLabel	is the label to show in the menu (overriding the action's menu text) when non-empty

Definition at line 169 of file action_menu.cpp.

References KIUI::AddBitmapToMenuItem(), TOOL_ACTION::GetIcon(), TOOL_ACTION::GetMenuItem(), TOOL_ACTION::GetTooltip(), TOOL_ACTION::GetUIId(), KiBitmapBundle(), and ACTION_MENU::m_toolActions.

Add() [3/4]

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

inherited

Definition at line 154 of file action_menu.cpp.

References KIUI::AddBitmapToMenuItem(), and KiBitmapBundle().

Add() [4/4]

wxMenuItem * ACTION_MENU::Add ( const wxString &  aLabel, int  aId, BITMAPS  aIcon  )

inherited

Add a wxWidgets-style entry to the menu.

After highlighting/selecting the entry, a wxWidgets event is generated.

Definition at line 141 of file action_menu.cpp.

References KIUI::AddBitmapToMenuItem(), and KiBitmapBundle().

Referenced by ACTION_MENU::AddClose(), EDA_BASE_FRAME::AddMenuLanguageList(), ACTION_MENU::AddQuit(), ACTION_MENU::AddQuitOrClose(), EDA_3D_VIEWER_FRAME::doReCreateMenuBar(), BITMAP2CMP_FRAME::doReCreateMenuBar(), CVPCB_MAINFRAME::doReCreateMenuBar(), SCH_EDIT_FRAME::doReCreateMenuBar(), SIMULATOR_FRAME::doReCreateMenuBar(), SYMBOL_EDIT_FRAME::doReCreateMenuBar(), SYMBOL_VIEWER_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), PCB_CALCULATOR_FRAME::doReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::doReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::doReCreateMenuBar(), PCB_EDIT_FRAME::doReCreateMenuBar(), SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::DrawVia(), Evaluate(), GROUP_CONTEXT_MENU::GROUP_CONTEXT_MENU(), NET_CONTEXT_MENU::NET_CONTEXT_MENU(), LIB_TREE::onHeaderContextMenu(), LIB_TREE::onItemContextMenu(), SEARCH_PANE_MENU::SEARCH_PANE_MENU(), SELECT_MENU::SELECT_MENU(), CVPCB_MAINFRAME::setupTools(), SYMBOL_UNIT_MENU::update(), PIN_TRICKS_MENU::update(), HIGHLIGHT_MENU::update(), GRID_MENU::update(), and ZONE_CONTEXT_MENU::ZONE_CONTEXT_MENU().

AddCheckItem() [1/2]

void CONDITIONAL_MENU::AddCheckItem	(	const TOOL_ACTION &	aAction,
		const SELECTION_CONDITION &	aCondition,
		int	aOrder = ANY_ORDER
	)

Add a checked menu entry to run a TOOL_ACTION on selected items.

The condition for checking the menu entry should be supplied through a #ACTION_CONDITION registered with the ACTION_MANAGER.

Parameters

aAction	is a menu entry to be added.
aCondition	is a condition that has to be fulfilled to show the menu entry in the menu.
aOrder	determines location of the added item, higher numbers are put on the bottom. You may use ANY_ORDER here if you think it does not matter.

Definition at line 56 of file conditional_menu.cpp.

References addEntry(), and TOOL_ACTION::GetId().

Referenced by DRAWING_TOOL::Init(), and PCB_VIEWER_TOOLS::Init().

AddCheckItem() [2/2]

void CONDITIONAL_MENU::AddCheckItem	(	int	aId,
		const wxString &	aText,
		const wxString &	aTooltip,
		BITMAPS	aIcon,
		const SELECTION_CONDITION &	aCondition,
		int	aOrder = ANY_ORDER
	)

Definition at line 77 of file conditional_menu.cpp.

References KIUI::AddBitmapToMenuItem(), addEntry(), and KiBitmap().

AddClose()

void ACTION_MENU::AddClose ( const wxString &  aAppname = "" )

inherited

Add a standard close item to the menu with the accelerator key CTRL-W.

Emits the wxID_CLOSE event.

Parameters

aAppname

is the application name to append to the tooltip.

Definition at line 211 of file action_menu.cpp.

References _, and ACTION_MENU::Add().

Referenced by ACTION_MENU::AddQuitOrClose(), EDA_3D_VIEWER_FRAME::doReCreateMenuBar(), CVPCB_MAINFRAME::doReCreateMenuBar(), SIMULATOR_FRAME::doReCreateMenuBar(), SYMBOL_EDIT_FRAME::doReCreateMenuBar(), SYMBOL_VIEWER_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), PCB_CALCULATOR_FRAME::doReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::doReCreateMenuBar(), and FOOTPRINT_VIEWER_FRAME::doReCreateMenuBar().

addEntry()

void CONDITIONAL_MENU::addEntry ( ENTRY  aEntry )

private

List of all menu entries.

Definition at line 209 of file conditional_menu.cpp.

References m_entries, CONDITIONAL_MENU::ENTRY::Order(), and CONDITIONAL_MENU::ENTRY::SetOrder().

Referenced by AddCheckItem(), AddItem(), AddMenu(), and AddSeparator().

AddItem() [1/2]

void CONDITIONAL_MENU::AddItem	(	const TOOL_ACTION &	aAction,
		const SELECTION_CONDITION &	aCondition,
		int	aOrder = ANY_ORDER
	)

Add a menu entry to run a TOOL_ACTION on selected items.

Parameters

aAction	is a menu entry to be added.
aCondition	is a condition that has to be fulfilled to show the menu entry in the menu.
aOrder	determines location of the added item, higher numbers are put on the bottom. You may use ANY_ORDER here if you think it does not matter.

Definition at line 48 of file conditional_menu.cpp.

References addEntry(), and TOOL_ACTION::GetId().

Referenced by DESIGN_BLOCK_CONTROL::AddContextMenuItems(), LIBRARY_EDITOR_CONTROL::AddContextMenuItems(), EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::addMenus(), EDA_3D_CONTROLLER::Init(), SCH_DESIGN_BLOCK_CONTROL::Init(), SCH_DRAWING_TOOLS::Init(), SCH_INSPECTION_TOOL::Init(), SCH_MOVE_TOOL::Init(), SCH_POINT_EDITOR::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), SYMBOL_EDITOR_MOVE_TOOL::Init(), SYMBOL_EDITOR_PIN_TOOL::Init(), PL_EDIT_TOOL::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), CONVERT_TOOL::Init(), DRAWING_TOOL::Init(), EDIT_TOOL::Init(), GENERATOR_TOOL::Init(), PAD_TOOL::Init(), PCB_DESIGN_BLOCK_CONTROL::Init(), PCB_PICKER_TOOL::Init(), PCB_POINT_EDITOR::Init(), PCB_TOOL_BASE::Init(), PCB_VIEWER_TOOLS::Init(), and LOCK_CONTEXT_MENU::LOCK_CONTEXT_MENU().

AddItem() [2/2]

void CONDITIONAL_MENU::AddItem	(	int	aId,
		const wxString &	aText,
		const wxString &	aTooltip,
		BITMAPS	aIcon,
		const SELECTION_CONDITION &	aCondition,
		int	aOrder = ANY_ORDER
	)

Definition at line 64 of file conditional_menu.cpp.

References KIUI::AddBitmapToMenuItem(), addEntry(), and KiBitmap().

AddMenu()

void CONDITIONAL_MENU::AddMenu	(	ACTION_MENU *	aMenu,
		const SELECTION_CONDITION &	aCondition = SELECTION_CONDITIONS::ShowAlways,
		int	aOrder = ANY_ORDER
	)

Add a submenu to the menu.

CONDITIONAL_MENU takes ownership of the added menu, so it will be freed when the CONDITIONAL_MENU object is destroyed.

Parameters

aMenu	is the submenu to be added.
aExpand	determines if the added submenu items should be added as individual items or as a submenu.
aCondition	is a condition that has to be fulfilled to show the submenu entry in the menu.
aOrder	determines location of the added menu, higher numbers are put on the bottom. You may use ANY_ORDER here if you think it does not matter.

Definition at line 90 of file conditional_menu.cpp.

References addEntry().

Referenced by GROUP_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), BOARD_INSPECTION_TOOL::Init(), CONVERT_TOOL::Init(), and DRAWING_TOOL::Init().

AddQuit()

void ACTION_MENU::AddQuit ( const wxString &  aAppname = "" )

inherited

Add a standard Quit item to the menu.

Emits the wxID_EXIT event.

Parameters

aAppname

is the application name to append to the tooltip.

Definition at line 245 of file action_menu.cpp.

References _, and ACTION_MENU::Add().

Referenced by BITMAP2CMP_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), and PCB_CALCULATOR_FRAME::doReCreateMenuBar().

AddQuitOrClose()

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

inherited

Add either a standard Quit or Close item to the menu.

If aKiface is NULL or in single-instance then quit (wxID_EXIT) is used, otherwise close (wxID_CLOSE) is used.

Parameters

aAppname

is the application name to append to the tooltip.

Definition at line 227 of file action_menu.cpp.

References _, ACTION_MENU::Add(), ACTION_MENU::AddClose(), and KIFACE_BASE::IsSingle().

Referenced by SCH_EDIT_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), and PCB_EDIT_FRAME::doReCreateMenuBar().

AddSeparator() [1/2]

void CONDITIONAL_MENU::AddSeparator	(	const SELECTION_CONDITION &	aCondition,
		int	aOrder = ANY_ORDER
	)

Definition at line 103 of file conditional_menu.cpp.

References addEntry().

AddSeparator() [2/2]

void CONDITIONAL_MENU::AddSeparator

(

int

aOrder = ANY_ORDER

)

Add a separator to the menu.

Parameters

aOrder

determines location of the separator, higher numbers are put on the bottom.

Definition at line 97 of file conditional_menu.cpp.

References addEntry(), and SELECTION_CONDITIONS::ShowAlways().

Referenced by DESIGN_BLOCK_CONTROL::AddContextMenuItems(), LIBRARY_EDITOR_CONTROL::AddContextMenuItems(), EDIT_TABLE_TOOL_BASE< T_TABLE, T_TABLECELL, T_COMMIT >::addMenus(), EDA_DRAW_FRAME::AddStandardSubMenus(), EDA_3D_CONTROLLER::Init(), SCH_DESIGN_BLOCK_CONTROL::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), SYMBOL_EDITOR_PIN_TOOL::Init(), PL_EDIT_TOOL::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), CONVERT_TOOL::Init(), DRAWING_TOOL::Init(), FOOTPRINT_CHOOSER_SELECTION_TOOL::Init(), PAD_TOOL::Init(), PCB_DESIGN_BLOCK_CONTROL::Init(), PCB_PICKER_TOOL::Init(), PCB_TOOL_BASE::Init(), and PCB_VIEWER_TOOLS::Init().

appendCopy()

wxMenuItem * ACTION_MENU::appendCopy ( const wxMenuItem *  aSource )

protectedinherited

Append a copy of wxMenuItem.

Definition at line 649 of file action_menu.cpp.

References KIUI::AddBitmapToMenuItem(), ACTION_MENU::Clone(), and ACTION_MENU::m_submenus.

Referenced by ACTION_MENU::copyFrom().

Clear()

void ACTION_MENU::Clear ( )

inherited

Remove all the entries from the menu (as well as its title).

It leaves the menu in the initial state.

Definition at line 256 of file action_menu.cpp.

References ACTION_MENU::m_submenus, ACTION_MENU::m_titleDisplayed, and ACTION_MENU::m_toolActions.

Referenced by ACTION_MENU::Clone(), Evaluate(), SYMBOL_UNIT_MENU::update(), BODY_STYLE_MENU::update(), ALT_PIN_FUNCTION_MENU::update(), PIN_TRICKS_MENU::update(), BUS_UNFOLD_MENU::update(), HIGHLIGHT_MENU::update(), ZOOM_MENU::update(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), and VIA_SIZE_MENU::update().

ClearDirty()

void ACTION_MENU::ClearDirty ( )

inherited

Clear the dirty flag on the menu and all descendants.

Definition at line 299 of file action_menu.cpp.

References ACTION_MENU::ClearDirty(), ACTION_MENU::m_dirty, and ACTION_MENU::runOnSubmenus().

Referenced by ACTION_MENU::ClearDirty(), and TOOL_MENU::ShowContextMenu().

Clone()

ACTION_MENU * ACTION_MENU::Clone ( ) const

inherited

Create a deep, recursive copy of this ACTION_MENU.

Definition at line 320 of file action_menu.cpp.

References ACTION_MENU::Clear(), ACTION_MENU::copyFrom(), and ACTION_MENU::create().

Referenced by ACTION_MENU::appendCopy(), TOOL_MANAGER::DispatchContextMenu(), BITMAP2CMP_FRAME::doReCreateMenuBar(), SCH_EDIT_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), and PCB_EDIT_FRAME::doReCreateMenuBar().

copyFrom()

void ACTION_MENU::copyFrom ( const ACTION_MENU &  aMenu )

protectedinherited

Copy another menus data to this instance.

Old entries are preserved and ones form aMenu are copied.

Definition at line 631 of file action_menu.cpp.

References ACTION_MENU::appendCopy(), ACTION_MENU::m_icon, ACTION_MENU::m_selected, ACTION_MENU::m_title, ACTION_MENU::m_titleDisplayed, ACTION_MENU::m_tool, and ACTION_MENU::m_toolActions.

Referenced by ACTION_MENU::Clone().

create()

ACTION_MENU * CONDITIONAL_MENU::create ( ) const

overridevirtual

Return an instance of this class. It has to be overridden in inheriting classes.

Reimplemented from ACTION_MENU.

Reimplemented in LOCK_CONTEXT_MENU.

Definition at line 40 of file conditional_menu.cpp.

References m_entries, and ACTION_MENU::m_tool.

DisplayTitle()

void ACTION_MENU::DisplayTitle ( bool  aDisplay = true )

inherited

Decide whether a title for a pop up menu should be displayed.

Definition at line 103 of file action_menu.cpp.

References KIUI::AddBitmapToMenuItem(), ACTION_MENU::GetTitle(), KiBitmapBundle(), ACTION_MENU::m_icon, ACTION_MENU::m_title, and ACTION_MENU::m_titleDisplayed.

Referenced by SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::DrawVia(), and ACTION_MENU::SetTitle().

Evaluate()

void CONDITIONAL_MENU::Evaluate

(

const SELECTION &

aSelection

)

Update the contents of the menu based on the supplied conditions.

Definition at line 128 of file conditional_menu.cpp.

References CONDITIONAL_MENU::ENTRY::ACTION, ACTION_MENU::Add(), KIUI::AddBitmapToMenuItem(), ACTION_MENU::Clear(), Evaluate(), KiBitmap(), m_entries, CONDITIONAL_MENU::ENTRY::MENU, ACTION_MENU::runOnSubmenus(), CONDITIONAL_MENU::ENTRY::SEPARATOR, and CONDITIONAL_MENU::ENTRY::WXITEM.

Referenced by Evaluate(), Resolve(), TOOL_MENU::ShowContextMenu(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::UpdateMenu(), SELECTION_TOOL::UpdateMenu(), and FOOTPRINT_CHOOSER_SELECTION_TOOL::UpdateMenu().

eventHandler()

virtual OPT_TOOL_EVENT ACTION_MENU::eventHandler ( const wxMenuEvent &  )

inlineprotectedvirtualinherited

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.

Reimplemented in SEARCH_PANE_MENU, GRID_MENU, ZOOM_MENU, TRACK_WIDTH_MENU, DIFF_PAIR_MENU, and VIA_SIZE_MENU.

Definition at line 226 of file action_menu.h.

Referenced by ACTION_MENU::OnMenuEvent(), and ACTION_MENU::runEventHandlers().

findToolAction()

OPT_TOOL_EVENT ACTION_MENU::findToolAction ( int  aId )

protectedinherited

Check if any of submenus contains a TOOL_ACTION with a specific ID.

Definition at line 606 of file action_menu.cpp.

References ACTION_MENU::runOnSubmenus().

Referenced by ACTION_MENU::OnMenuEvent().

GetSelected()

int ACTION_MENU::GetSelected ( ) const

inlineinherited

Return the position of selected item.

If the returned value is negative, that means that menu was dismissed.

Returns

The position of selected item in the action menu.

Definition at line 162 of file action_menu.h.

References ACTION_MENU::m_selected.

GetTitle()

wxString ACTION_MENU::GetTitle ( ) const

inlineinherited

Definition at line 68 of file action_menu.h.

References ACTION_MENU::m_title.

Referenced by ACTION_MENU::DisplayTitle().

getToolManager()

TOOL_MANAGER * ACTION_MENU::getToolManager ( ) const

protectedinherited

Return an instance of TOOL_MANAGER class.

Definition at line 341 of file action_menu.cpp.

References TOOL_BASE::GetManager(), and ACTION_MENU::m_tool.

Referenced by VIA_SIZE_MENU::eventHandler(), ACTION_MENU::OnMenuEvent(), SYMBOL_UNIT_MENU::update(), BODY_STYLE_MENU::update(), ALT_PIN_FUNCTION_MENU::update(), PIN_TRICKS_MENU::update(), HIGHLIGHT_MENU::update(), VIA_SIZE_MENU::update(), and ACTION_MENU::updateHotKeys().

HasEnabledItems()

bool ACTION_MENU::HasEnabledItems ( ) const

inherited

Return true if the menu has any enabled items.

Definition at line 270 of file action_menu.cpp.

OnIdle()

void ACTION_MENU::OnIdle ( wxIdleEvent &  event )

inherited

Definition at line 398 of file action_menu.cpp.

References g_last_menu_highlighted_id, g_menu_open_position, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ACTION_MENU::setupEvents(), and ACTION_MENU::~ACTION_MENU().

OnMenuEvent()

void ACTION_MENU::OnMenuEvent ( wxMenuEvent &  aEvent )

inherited

Definition at line 406 of file action_menu.cpp.

References AS_GLOBAL, ACTION_MENU::eventHandler(), ACTION_MENU::findToolAction(), g_last_menu_highlighted_id, g_menu_open_position, TOOL_MANAGER::GetActionManager(), TOOL_MANAGER::GetMousePosition(), ACTION_MENU::getToolManager(), ID_CONTEXT_MENU_ID_MAX, ID_POPUP_MENU_END, ID_POPUP_MENU_START, ACTION_MANAGER::IsActionUIId(), kicadTraceToolStack, ACTION_MENU::m_dirty, ACTION_MENU::m_isContextMenu, ACTION_MENU::m_selected, TEXTENTRY_TRICKS::OnCharHook(), ACTION_MENU::PassHelpTextToHandler(), TOOL_MANAGER::ProcessEvent(), TOOL_MANAGER::RunAction(), ACTION_MENU::runEventHandlers(), TA_CHOICE_MENU_CHOICE, TA_CHOICE_MENU_UPDATE, TC_COMMAND, and ACTIONS::updateMenu.

Referenced by TOOL_DISPATCHER::DispatchWxEvent(), ACTION_MENU::setupEvents(), and ACTION_MENU::~ACTION_MENU().

PassHelpTextToHandler()

virtual bool ACTION_MENU::PassHelpTextToHandler ( )

inlinevirtualinherited

Reimplemented in BUS_UNFOLD_MENU.

Definition at line 198 of file action_menu.h.

Referenced by ACTION_MENU::OnMenuEvent().

Resolve()

void CONDITIONAL_MENU::Resolve

(

)

Update the initial contents so that wxWidgets doesn't get its knickers tied in a knot over the menu being empty (mainly an issue on GTK, but also on OSX with the preferences and quit menu items).

Definition at line 112 of file conditional_menu.cpp.

References Evaluate(), g_resolveDummySelection, Resolve(), ACTION_MENU::runOnSubmenus(), and ACTION_MENU::UpdateAll().

Referenced by Resolve().

runEventHandlers()

void ACTION_MENU::runEventHandlers ( const wxMenuEvent &  aMenuEvent, OPT_TOOL_EVENT &  aToolEvent  )

protectedinherited

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.

Definition at line 580 of file action_menu.cpp.

References ACTION_MENU::eventHandler(), ACTION_MENU::runEventHandlers(), and ACTION_MENU::runOnSubmenus().

Referenced by ACTION_MENU::OnMenuEvent(), and ACTION_MENU::runEventHandlers().

runOnSubmenus()

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

protectedinherited

Run a function on the menu and all its submenus.

Definition at line 589 of file action_menu.cpp.

References ACTION_MENU::m_submenus.

Referenced by ACTION_MENU::ClearDirty(), Evaluate(), ACTION_MENU::findToolAction(), Resolve(), ACTION_MENU::runEventHandlers(), ACTION_MENU::SetDirty(), ACTION_MENU::SetTool(), and ACTION_MENU::UpdateAll().

SetDirty()

void ACTION_MENU::SetDirty ( )

inherited

Definition at line 306 of file action_menu.cpp.

References ACTION_MENU::m_dirty, ACTION_MENU::runOnSubmenus(), and ACTION_MENU::SetDirty().

Referenced by ACTION_MENU::SetDirty(), and TOOL_MENU::ShowContextMenu().

SetIcon()

void ACTION_MENU::SetIcon ( BITMAPS  aIcon )

inherited

Assign an icon for the entry.

Parameters

aIcon

is the icon to be assigned. NULL is used to remove icon.

Definition at line 78 of file action_menu.cpp.

References ACTION_MENU::m_icon.

Referenced by EDA_BASE_FRAME::AddMenuLanguageList(), ALT_PIN_FUNCTION_MENU::ALT_PIN_FUNCTION_MENU(), BODY_STYLE_MENU::BODY_STYLE_MENU(), BUS_UNFOLD_MENU::BUS_UNFOLD_MENU(), DIFF_PAIR_MENU::DIFF_PAIR_MENU(), EDA_3D_VIEWER_FRAME::doReCreateMenuBar(), BITMAP2CMP_FRAME::doReCreateMenuBar(), SCH_EDIT_FRAME::doReCreateMenuBar(), SYMBOL_EDIT_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::doReCreateMenuBar(), PCB_EDIT_FRAME::doReCreateMenuBar(), SELECTION_TOOL::doSelectionMenu(), GRID_MENU::GRID_MENU(), GROUP_CONTEXT_MENU::GROUP_CONTEXT_MENU(), HIGHLIGHT_MENU::HIGHLIGHT_MENU(), ALIGN_DISTRIBUTE_TOOL::Init(), CONVERT_TOOL::Init(), LOCK_CONTEXT_MENU::LOCK_CONTEXT_MENU(), NET_CONTEXT_MENU::NET_CONTEXT_MENU(), PIN_TRICKS_MENU::PIN_TRICKS_MENU(), SYMBOL_UNIT_MENU::SYMBOL_UNIT_MENU(), TRACK_WIDTH_MENU::TRACK_WIDTH_MENU(), VIA_SIZE_MENU::VIA_SIZE_MENU(), ZONE_CONTEXT_MENU::ZONE_CONTEXT_MENU(), and ZOOM_MENU::ZOOM_MENU().

SetTitle()

void ACTION_MENU::SetTitle ( const wxString &  aTitle )

overrideinherited

Set title for the menu.

The title is shown as a text label shown on the top of the menu.

Parameters

aTitle

is the new title.

Definition at line 92 of file action_menu.cpp.

References ACTION_MENU::DisplayTitle(), ACTION_MENU::m_title, and ACTION_MENU::m_titleDisplayed.

Referenced by EDA_BASE_FRAME::AddMenuLanguageList(), ALT_PIN_FUNCTION_MENU::ALT_PIN_FUNCTION_MENU(), BODY_STYLE_MENU::BODY_STYLE_MENU(), BUS_UNFOLD_MENU::BUS_UNFOLD_MENU(), DIFF_PAIR_MENU::DIFF_PAIR_MENU(), EDA_3D_VIEWER_FRAME::doReCreateMenuBar(), BITMAP2CMP_FRAME::doReCreateMenuBar(), SCH_EDIT_FRAME::doReCreateMenuBar(), SYMBOL_EDIT_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::doReCreateMenuBar(), PCB_EDIT_FRAME::doReCreateMenuBar(), SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::DrawVia(), GROUP_CONTEXT_MENU::GROUP_CONTEXT_MENU(), HIGHLIGHT_MENU::HIGHLIGHT_MENU(), ALIGN_DISTRIBUTE_TOOL::Init(), CONVERT_TOOL::Init(), LOCK_CONTEXT_MENU::LOCK_CONTEXT_MENU(), NET_CONTEXT_MENU::NET_CONTEXT_MENU(), PIN_TRICKS_MENU::PIN_TRICKS_MENU(), SELECT_MENU::SELECT_MENU(), SYMBOL_UNIT_MENU::SYMBOL_UNIT_MENU(), TRACK_WIDTH_MENU::TRACK_WIDTH_MENU(), GRID_MENU::UpdateTitle(), ZOOM_MENU::UpdateTitle(), VIA_SIZE_MENU::VIA_SIZE_MENU(), and ZONE_CONTEXT_MENU::ZONE_CONTEXT_MENU().

SetTool()

void ACTION_MENU::SetTool ( TOOL_INTERACTIVE *  aTool )

inherited

Set a tool that is the creator of the menu.

Parameters

aTool

is the tool that created the menu.

Definition at line 313 of file action_menu.cpp.

References ACTION_MENU::m_tool, ACTION_MENU::runOnSubmenus(), and ACTION_MENU::SetTool().

Referenced by TOOL_INTERACTIVE::SetContextMenu(), ACTION_MENU::SetTool(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

setupEvents()

void ACTION_MENU::setupEvents ( )

protectedinherited

Initialize handlers for events.

Definition at line 84 of file action_menu.cpp.

References ACTION_MENU::OnIdle(), and ACTION_MENU::OnMenuEvent().

Referenced by ACTION_MENU::ACTION_MENU().

update()

virtual void ACTION_MENU::update ( )

inlineprotectedvirtualinherited

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.

Reimplemented in GROUP_CONTEXT_MENU, SYMBOL_UNIT_MENU, BODY_STYLE_MENU, ALT_PIN_FUNCTION_MENU, PIN_TRICKS_MENU, BUS_UNFOLD_MENU, HIGHLIGHT_MENU, GRID_MENU, ZOOM_MENU, TRACK_WIDTH_MENU, DIFF_PAIR_MENU, and VIA_SIZE_MENU.

Definition at line 216 of file action_menu.h.

Referenced by ACTION_MENU::UpdateAll().

UpdateAll()

void ACTION_MENU::UpdateAll ( )

inherited

Run update handlers for the menu and its submenus.

Definition at line 282 of file action_menu.cpp.

References ACTION_MENU::m_tool, ACTION_MENU::runOnSubmenus(), ACTION_MENU::update(), ACTION_MENU::UpdateAll(), and ACTION_MENU::updateHotKeys().

Referenced by ACTION_TOOLBAR::onToolRightClick(), Resolve(), TOOL_MENU::ShowContextMenu(), ACTION_MENU::UpdateAll(), EDA_3D_CONTROLLER::UpdateMenu(), CVPCB_CONTROL::UpdateMenu(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::UpdateMenu(), SELECTION_TOOL::UpdateMenu(), KICAD_MANAGER_CONTROL::UpdateMenu(), and FOOTPRINT_CHOOSER_SELECTION_TOOL::UpdateMenu().

updateHotKeys()

void ACTION_MENU::updateHotKeys ( )

protectedinherited

Update hot key settings for TOOL_ACTIONs in this menu.

Definition at line 347 of file action_menu.cpp.

References TOOL_MANAGER::GetHotKey(), ACTION_MENU::getToolManager(), ACTION_MENU::m_toolActions, MD_ALT, MD_CTRL, MD_MODIFIER_MASK, and MD_SHIFT.

Referenced by ACTION_MENU::UpdateAll().

UpdateTitle()

virtual void ACTION_MENU::UpdateTitle ( )

inlinevirtualinherited

Used by some menus to just-in-time translate their titles.

Reimplemented in GRID_MENU, and ZOOM_MENU.

Definition at line 175 of file action_menu.h.

Member Data Documentation

ANY_ORDER

const int CONDITIONAL_MENU::ANY_ORDER = -1

static

< Constant to indicate that we do not care about an #ENTRY location in the menu.

Definition at line 45 of file conditional_menu.h.

CHECK

constexpr bool ACTION_MENU::CHECK = true

staticconstexprinherited

Definition at line 201 of file action_menu.h.

Referenced by EDA_3D_VIEWER_FRAME::doReCreateMenuBar(), SCH_EDIT_FRAME::doReCreateMenuBar(), SIMULATOR_FRAME::doReCreateMenuBar(), SYMBOL_EDIT_FRAME::doReCreateMenuBar(), SYMBOL_VIEWER_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::doReCreateMenuBar(), and PCB_EDIT_FRAME::doReCreateMenuBar().

m_dirty

bool ACTION_MENU::m_dirty

protectedinherited

Definition at line 263 of file action_menu.h.

Referenced by ACTION_MENU::ClearDirty(), ACTION_MENU::OnMenuEvent(), and ACTION_MENU::SetDirty().

m_entries

std::list<ENTRY> CONDITIONAL_MENU::m_entries

private

Definition at line 254 of file conditional_menu.h.

Referenced by addEntry(), create(), and Evaluate().

m_forcedPosition

wxPoint ACTION_MENU::m_forcedPosition

protectedinherited

Definition at line 261 of file action_menu.h.

m_icon

BITMAPS ACTION_MENU::m_icon

protectedinherited

Optional icon.

Definition at line 272 of file action_menu.h.

Referenced by ACTION_MENU::Add(), ACTION_MENU::copyFrom(), ACTION_MENU::DisplayTitle(), and ACTION_MENU::SetIcon().

m_isContextMenu

bool ACTION_MENU::m_isContextMenu

protectedinherited

Definition at line 266 of file action_menu.h.

Referenced by ACTION_MENU::OnMenuEvent().

m_isForcedPosition

bool ACTION_MENU::m_isForcedPosition

protectedinherited

Definition at line 260 of file action_menu.h.

m_selected

int ACTION_MENU::m_selected

protectedinherited

Store the id number of selected item.

Definition at line 275 of file action_menu.h.

Referenced by ACTION_MENU::copyFrom(), ACTION_MENU::GetSelected(), and ACTION_MENU::OnMenuEvent().

m_submenus

std::list<ACTION_MENU*> ACTION_MENU::m_submenus

protectedinherited

List of submenus.

Definition at line 284 of file action_menu.h.

Referenced by ACTION_MENU::Add(), ACTION_MENU::appendCopy(), ACTION_MENU::Clear(), ACTION_MENU::runOnSubmenus(), and ACTION_MENU::~ACTION_MENU().

m_title

wxString ACTION_MENU::m_title

protectedinherited

Menu title.

Definition at line 269 of file action_menu.h.

Referenced by ACTION_MENU::Add(), ACTION_MENU::copyFrom(), ACTION_MENU::DisplayTitle(), ACTION_MENU::GetTitle(), and ACTION_MENU::SetTitle().

m_titleDisplayed

bool ACTION_MENU::m_titleDisplayed

protectedinherited

Definition at line 265 of file action_menu.h.

Referenced by ACTION_MENU::Clear(), ACTION_MENU::copyFrom(), ACTION_MENU::DisplayTitle(), and ACTION_MENU::SetTitle().

m_tool

TOOL_INTERACTIVE* ACTION_MENU::m_tool

protectedinherited

Creator of the menu.

Definition at line 278 of file action_menu.h.

Referenced by ACTION_MENU::copyFrom(), create(), LOCK_CONTEXT_MENU::create(), ACTION_MENU::getToolManager(), ACTION_MENU::SetTool(), BUS_UNFOLD_MENU::update(), and ACTION_MENU::UpdateAll().

m_toolActions

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

protectedinherited

Associates tool actions with menu item IDs. Non-owning.

Definition at line 281 of file action_menu.h.

Referenced by ACTION_MENU::Add(), ACTION_MENU::Clear(), ACTION_MENU::copyFrom(), and ACTION_MENU::updateHotKeys().

NORMAL

constexpr bool ACTION_MENU::NORMAL = false

staticconstexprinherited

Definition at line 200 of file action_menu.h.

Referenced by SCH_EDIT_FRAME::doReCreateMenuBar(), SYMBOL_EDIT_FRAME::doReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::doReCreateMenuBar(), and PCB_EDIT_FRAME::doReCreateMenuBar().

---

The documentation for this class was generated from the following files:

• conditional_menu.h
• conditional_menu.cpp