KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
SYMBOL_UNIT_MENU Class Reference
Inheritance diagram for SYMBOL_UNIT_MENU:
ACTION_MENU

Public Member Functions

 SYMBOL_UNIT_MENU ()
 
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
 Returns 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 constexpr bool NORMAL = false
 
static constexpr bool CHECK = true
 

Protected Member Functions

ACTION_MENU * create () const override
 < Return an instance of this class. It has to be overridden in inheriting classes.
 
TOOL_MANAGER * getToolManager () const
 
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 ()
 Update hot key settings for TOOL_ACTIONs in this menu.
 
void updateHotKeys ()
 Traverse the submenus tree looking for a submenu capable of handling a particular menu event.
 
void runEventHandlers (const wxMenuEvent &aMenuEvent, OPT_TOOL_EVENT &aToolEvent)
 Run a function on the menu and all its submenus.
 
void runOnSubmenus (std::function< void(ACTION_MENU *)> aFunction)
 Check if any of submenus contains a TOOL_ACTION with a specific ID.
 
OPT_TOOL_EVENT findToolAction (int aId)
 

Protected Attributes

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

Private Member Functions

void update () override
 Update menu state stub.
 

Detailed Description

Definition at line 70 of file sch_edit_tool.cpp.

Constructor & Destructor Documentation

◆ SYMBOL_UNIT_MENU()

SYMBOL_UNIT_MENU::SYMBOL_UNIT_MENU ( )
inline

Definition at line 73 of file sch_edit_tool.cpp.

References _, ACTION_MENU::SetIcon(), and ACTION_MENU::SetTitle().

Referenced by create().

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
aMenuis 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 189 of file action_menu.cpp.

References KIUI::AddBitmapToMenuItem(), KiBitmap(), 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
aActionis the action to be added to menu entry.
aIsCheckmarkEntryis true to indicate a check menu entry, false for normal menu entry
aOverrideLabelis the label to show in the menu (overriding the action's menu text) when non-empty

ID numbers for tool actions are assigned above ACTION_BASE_UI_ID inside TOOL_EVENT

Definition at line 168 of file action_menu.cpp.

References KIUI::AddBitmapToMenuItem(), TOOL_ACTION::GetIcon(), TOOL_ACTION::GetMenuItem(), TOOL_ACTION::GetTooltip(), TOOL_ACTION::GetUIId(), KiBitmap(), 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 153 of file action_menu.cpp.

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

◆ 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 140 of file action_menu.cpp.

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

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(), CONDITIONAL_MENU::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(), update(), PIN_TRICKS_MENU::update(), HIGHLIGHT_MENU::update(), GRID_MENU::update(), and ZONE_CONTEXT_MENU::ZONE_CONTEXT_MENU().

◆ 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
aAppnameis the application name to append to the tooltip.

Definition at line 209 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().

◆ AddQuit()

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

Add a standard Quit item to the menu.

Emits the wxID_EXIT event.

Parameters
aAppnameis the application name to append to the tooltip.

Definition at line 243 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
aAppnameis the application name to append to the tooltip.

Definition at line 225 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().

◆ appendCopy()

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

Append a copy of wxMenuItem.

Initialize handlers for events.

Definition at line 647 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 254 of file action_menu.cpp.

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

Referenced by ACTION_MENU::Clone(), CONDITIONAL_MENU::Evaluate(), 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 297 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 318 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 629 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 * SYMBOL_UNIT_MENU::create ( ) const
inlineoverrideprotectedvirtual

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

Returns an instance of TOOL_MANAGER class.

Reimplemented from ACTION_MENU.

Definition at line 81 of file sch_edit_tool.cpp.

References SYMBOL_UNIT_MENU().

◆ 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(), KiBitmap(), 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().

◆ 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

Definition at line 604 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

Definition at line 339 of file action_menu.cpp.

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

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

◆ HasEnabledItems()

bool ACTION_MENU::HasEnabledItems ( ) const
inherited

Returns true if the menu has any enabled items.

Definition at line 268 of file action_menu.cpp.

◆ OnIdle()

void ACTION_MENU::OnIdle ( wxIdleEvent &  event)
inherited

Definition at line 396 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 404 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().

◆ runEventHandlers()

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

Run a function on the menu and all its submenus.

Definition at line 578 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

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

Definition at line 587 of file action_menu.cpp.

References ACTION_MENU::m_submenus.

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

◆ SetDirty()

void ACTION_MENU::SetDirty ( )
inherited

Definition at line 304 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
aIconis 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(), SCH_EDIT_TOOL::Init(), CONVERT_TOOL::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), LOCK_CONTEXT_MENU::LOCK_CONTEXT_MENU(), NET_CONTEXT_MENU::NET_CONTEXT_MENU(), PIN_TRICKS_MENU::PIN_TRICKS_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
aTitleis 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(), SCH_EDIT_TOOL::Init(), CONVERT_TOOL::Init(), ALIGN_DISTRIBUTE_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(), 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
aToolis the tool that created the menu.

Definition at line 311 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

Update hot key settings for TOOL_ACTIONs in this menu.

Definition at line 84 of file action_menu.cpp.

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

Referenced by ACTION_MENU::ACTION_MENU().

◆ update()

void SYMBOL_UNIT_MENU::update ( )
inlineoverrideprivatevirtual

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 from ACTION_MENU.

Definition at line 87 of file sch_edit_tool.cpp.

References _, ACTION_MENU::Add(), ACTION_MENU::Clear(), SCH_SYMBOL::GetLibSymbolRef(), EE_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), ACTION_MENU::getToolManager(), SCH_ITEM::GetUnit(), GetUnplacedUnitsForSymbol(), ID_POPUP_SCH_SELECT_UNIT1, ID_POPUP_SCH_SELECT_UNIT_END, EE_ACTIONS::placeNextSymbolUnit, and SCH_SYMBOL::SubReference().

◆ UpdateAll()

void ACTION_MENU::UpdateAll ( )
inherited

Run update handlers for the menu and its submenus.

Definition at line 280 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(), CONDITIONAL_MENU::Resolve(), TOOL_MENU::ShowContextMenu(), ACTION_MENU::UpdateAll(), EDA_3D_CONTROLLER::UpdateMenu(), CVPCB_CONTROL::UpdateMenu(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::UpdateMenu(), SELECTION_TOOL::UpdateMenu(), and KICAD_MANAGER_CONTROL::UpdateMenu().

◆ updateHotKeys()

void ACTION_MENU::updateHotKeys ( )
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 345 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

◆ 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(), PCB_EDIT_FRAME::doReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateVToolbar(), and PCB_EDIT_FRAME::ReCreateVToolbar().

◆ 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_forcedPosition

wxPoint ACTION_MENU::m_forcedPosition
protectedinherited

Definition at line 261 of file action_menu.h.

◆ m_icon

BITMAPS ACTION_MENU::m_icon
protectedinherited

Stores the id number of selected item.

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

Menu title.

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

Creator of the menu.

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

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

Optional icon.

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

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

Definition at line 278 of file action_menu.h.

Referenced by ACTION_MENU::copyFrom(), CONDITIONAL_MENU::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

List of submenus.

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 file: