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

Public Member Functions

 GATE_SWAP_MENU ()
 
void SetTitle (const wxString &aTitle) override
 Set title for the menu.
 
void SetUntranslatedTitle (const wxString &aTitle)
 
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 Member Functions

static const FOOTPRINT * GetSingleEligibleFootprint (const SELECTION &aSelection)
 
static std::unordered_set< wxString > CollectSelectedPadNumbers (const SELECTION &aSelection, const FOOTPRINT *aFootprint)
 
static std::vector< int > GetUnitsHitIndices (const FOOTPRINT *aFootprint, const std::unordered_set< wxString > &aSelPadNums)
 
static bool EqualPinCounts (const FOOTPRINT *aFootprint, const std::vector< int > &aUnitIndices)
 
static std::vector< int > GetCompatibleTargets (const FOOTPRINT *aFootprint, int aSourceIdx)
 

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.
 
void update () override
 Update menu state stub.
 
OPT_TOOL_EVENT eventHandler (const wxMenuEvent &aEvent) override
 Event handler stub.
 
TOOL_MANAGER * getToolManager () const
 Return an instance of TOOL_MANAGER class.
 
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.
 
wxString m_untranslatedTitle
 
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.
 

Detailed Description

Definition at line 244 of file edit_tool.cpp.

Constructor & Destructor Documentation

◆ GATE_SWAP_MENU()

GATE_SWAP_MENU::GATE_SWAP_MENU ( )
inline

Definition at line 247 of file edit_tool.cpp.

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

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

References ACTION_MENU(), KIUI::AddBitmapToMenuItem(), KiBitmapBundle(), m_icon, m_submenus, and 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

Definition at line 180 of file action_menu.cpp.

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

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

Referenced by AddClose(), EDA_BASE_FRAME::AddMenuLanguageList(), AddQuit(), AddQuitOrClose(), BITMAP2CMP_FRAME::doReCreateMenuBar(), CVPCB_MAINFRAME::doReCreateMenuBar(), EDA_3D_VIEWER_FRAME::doReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::doReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PCB_CALCULATOR_FRAME::doReCreateMenuBar(), PCB_EDIT_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), SCH_EDIT_FRAME::doReCreateMenuBar(), SIMULATOR_FRAME::doReCreateMenuBar(), SYMBOL_EDIT_FRAME::doReCreateMenuBar(), SYMBOL_VIEWER_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(), GRID_MENU::update(), HIGHLIGHT_MENU::update(), PIN_TRICKS_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 220 of file action_menu.cpp.

References _, Add(), and exit.

Referenced by AddQuitOrClose(), CVPCB_MAINFRAME::doReCreateMenuBar(), EDA_3D_VIEWER_FRAME::doReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::doReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::doReCreateMenuBar(), PCB_CALCULATOR_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), SIMULATOR_FRAME::doReCreateMenuBar(), SYMBOL_EDIT_FRAME::doReCreateMenuBar(), and SYMBOL_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 254 of file action_menu.cpp.

References _, Add(), and exit.

Referenced by BITMAP2CMP_FRAME::doReCreateMenuBar(), PCB_CALCULATOR_FRAME::doReCreateMenuBar(), and PL_EDITOR_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 236 of file action_menu.cpp.

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

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

◆ appendCopy()

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

Append a copy of wxMenuItem.

Definition at line 656 of file action_menu.cpp.

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

Referenced by 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 265 of file action_menu.cpp.

References m_submenus, m_titleDisplayed, and m_toolActions.

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

◆ ClearDirty()

void ACTION_MENU::ClearDirty ( )
inherited

Clear the dirty flag on the menu and all descendants.

Definition at line 308 of file action_menu.cpp.

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

Referenced by ClearDirty().

◆ Clone()

ACTION_MENU * ACTION_MENU::Clone ( ) const
inherited

Create a deep, recursive copy of this ACTION_MENU.

Definition at line 329 of file action_menu.cpp.

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

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

◆ CollectSelectedPadNumbers()

static std::unordered_set< wxString > GATE_SWAP_MENU::CollectSelectedPadNumbers ( const SELECTION & aSelection,
const FOOTPRINT * aFootprint )
inlinestatic

Definition at line 308 of file edit_tool.cpp.

References pad, and PCB_PAD_T.

Referenced by EDIT_TOOL::Init(), and update().

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

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

Referenced by Clone().

◆ create()

ACTION_MENU * GATE_SWAP_MENU::create ( ) const
inlineoverrideprotectedvirtual

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

Reimplemented from ACTION_MENU.

Definition at line 401 of file edit_tool.cpp.

References ACTION_MENU::ACTION_MENU(), and GATE_SWAP_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 113 of file action_menu.cpp.

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

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

◆ EqualPinCounts()

static bool GATE_SWAP_MENU::EqualPinCounts ( const FOOTPRINT * aFootprint,
const std::vector< int > & aUnitIndices )
inlinestatic

Definition at line 360 of file edit_tool.cpp.

References FOOTPRINT::GetUnitInfo().

Referenced by EDIT_TOOL::Init().

◆ eventHandler()

OPT_TOOL_EVENT GATE_SWAP_MENU::eventHandler ( const wxMenuEvent & )
inlineoverrideprotectedvirtual

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

Definition at line 439 of file edit_tool.cpp.

References PCB_SELECTION_TOOL::GetSelection(), GetSingleEligibleFootprint(), TOOL_MANAGER::GetTool(), ACTION_MENU::getToolManager(), FOOTPRINT::GetUnitInfo(), ID_POPUP_PCB_SWAP_UNIT_BASE, ID_POPUP_PCB_SWAP_UNIT_LAST, TOOL_EVENT::SetParameter(), and PCB_ACTIONS::swapGateNets.

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

References ACTION_MENU(), and runOnSubmenus().

Referenced by OnMenuEvent().

◆ GetCompatibleTargets()

static std::vector< int > GATE_SWAP_MENU::GetCompatibleTargets ( const FOOTPRINT * aFootprint,
int aSourceIdx )
inlinestatic

Definition at line 379 of file edit_tool.cpp.

References FOOTPRINT::GetUnitInfo().

Referenced by EDIT_TOOL::Init(), and update().

◆ 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 161 of file action_menu.h.

References m_selected.

◆ GetSingleEligibleFootprint()

static const FOOTPRINT * GATE_SWAP_MENU::GetSingleEligibleFootprint ( const SELECTION & aSelection)
inlinestatic

Definition at line 257 of file edit_tool.cpp.

References FOOTPRINT::GetUnitInfo(), pad, and PCB_PAD_T.

Referenced by eventHandler(), EDIT_TOOL::Init(), and update().

◆ GetTitle()

wxString ACTION_MENU::GetTitle ( ) const
inlineinherited

Definition at line 67 of file action_menu.h.

References m_title.

Referenced by DisplayTitle().

◆ getToolManager()

TOOL_MANAGER * ACTION_MENU::getToolManager ( ) const
protectedinherited

Return an instance of TOOL_MANAGER class.

Definition at line 349 of file action_menu.cpp.

References m_tool.

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

◆ GetUnitsHitIndices()

static std::vector< int > GATE_SWAP_MENU::GetUnitsHitIndices ( const FOOTPRINT * aFootprint,
const std::unordered_set< wxString > & aSelPadNums )
inlinestatic

Definition at line 331 of file edit_tool.cpp.

References FOOTPRINT::GetUnitInfo().

Referenced by EDIT_TOOL::Init(), and update().

◆ HasEnabledItems()

bool ACTION_MENU::HasEnabledItems ( ) const
inherited

Return true if the menu has any enabled items.

Definition at line 279 of file action_menu.cpp.

◆ OnIdle()

void ACTION_MENU::OnIdle ( wxIdleEvent & event)
inherited

Definition at line 406 of file action_menu.cpp.

References g_last_menu_highlighted_id, and g_menu_open_position.

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

◆ OnMenuEvent()

void ACTION_MENU::OnMenuEvent ( wxMenuEvent & aEvent)
inherited

Definition at line 414 of file action_menu.cpp.

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

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

◆ PassHelpTextToHandler()

virtual bool ACTION_MENU::PassHelpTextToHandler ( )
inlinevirtualinherited

Reimplemented in BUS_UNFOLD_MENU.

Definition at line 201 of file action_menu.h.

Referenced by OnMenuEvent().

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

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

Referenced by OnMenuEvent(), and 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 596 of file action_menu.cpp.

References ACTION_MENU(), and m_submenus.

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

◆ SetDirty()

void ACTION_MENU::SetDirty ( )
inherited

Definition at line 315 of file action_menu.cpp.

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

Referenced by SetDirty().

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

References 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(), BITMAP2CMP_FRAME::doReCreateMenuBar(), EDA_3D_VIEWER_FRAME::doReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PCB_EDIT_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), SCH_EDIT_FRAME::doReCreateMenuBar(), SYMBOL_EDIT_FRAME::doReCreateMenuBar(), SELECTION_TOOL::doSelectionMenu(), GATE_SWAP_MENU::GATE_SWAP_MENU(), GRID_MENU::GRID_MENU(), GROUP_CONTEXT_MENU::GROUP_CONTEXT_MENU(), HIGHLIGHT_MENU::HIGHLIGHT_MENU(), ROUTER_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
aTitleis the new title.

Definition at line 102 of file action_menu.cpp.

References DisplayTitle(), m_title, and 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(), BITMAP2CMP_FRAME::doReCreateMenuBar(), EDA_3D_VIEWER_FRAME::doReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PCB_EDIT_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), SCH_EDIT_FRAME::doReCreateMenuBar(), SYMBOL_EDIT_FRAME::doReCreateMenuBar(), SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::DrawVia(), GATE_SWAP_MENU::GATE_SWAP_MENU(), GROUP_CONTEXT_MENU::GROUP_CONTEXT_MENU(), HIGHLIGHT_MENU::HIGHLIGHT_MENU(), ROUTER_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
aToolis the tool that created the menu.

Definition at line 322 of file action_menu.cpp.

References m_tool, runOnSubmenus(), SetTool(), and TOOL_INTERACTIVE.

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

◆ SetUntranslatedTitle()

void ACTION_MENU::SetUntranslatedTitle ( const wxString & aTitle)
inlineinherited

Definition at line 64 of file action_menu.h.

References m_untranslatedTitle.

◆ setupEvents()

void ACTION_MENU::setupEvents ( )
protectedinherited

Initialize handlers for events.

Definition at line 95 of file action_menu.cpp.

References OnIdle(), and OnMenuEvent().

Referenced by ACTION_MENU().

◆ update()

void GATE_SWAP_MENU::update ( )
inlineoverrideprotectedvirtual

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 408 of file edit_tool.cpp.

References _, ACTION_MENU::Clear(), CollectSelectedPadNumbers(), GetCompatibleTargets(), PCB_SELECTION_TOOL::GetSelection(), GetSingleEligibleFootprint(), TOOL_MANAGER::GetTool(), ACTION_MENU::getToolManager(), FOOTPRINT::GetUnitInfo(), GetUnitsHitIndices(), and ID_POPUP_PCB_SWAP_UNIT_BASE.

◆ UpdateAll()

void ACTION_MENU::UpdateAll ( )
inherited

Run update handlers for the menu and its submenus.

Definition at line 291 of file action_menu.cpp.

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

Referenced by ACTION_TOOLBAR::onRightClick(), CONDITIONAL_MENU::Resolve(), UpdateAll(), CVPCB_CONTROL::UpdateMenu(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::UpdateMenu(), EDA_3D_CONTROLLER::UpdateMenu(), FOOTPRINT_CHOOSER_SELECTION_TOOL::UpdateMenu(), KICAD_MANAGER_CONTROL::UpdateMenu(), and SELECTION_TOOL::UpdateMenu().

◆ updateHotKeys()

void ACTION_MENU::updateHotKeys ( )
protectedinherited

Update hot key settings for TOOL_ACTIONs in this menu.

Definition at line 355 of file action_menu.cpp.

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

Referenced by 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 174 of file action_menu.h.

References m_title, and m_untranslatedTitle.

Member Data Documentation

◆ CHECK

bool ACTION_MENU::CHECK = true
staticconstexprinherited

Definition at line 204 of file action_menu.h.

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

◆ m_dirty

bool ACTION_MENU::m_dirty
protectedinherited

Definition at line 266 of file action_menu.h.

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

◆ m_forcedPosition

wxPoint ACTION_MENU::m_forcedPosition
protectedinherited

Definition at line 264 of file action_menu.h.

◆ m_icon

BITMAPS ACTION_MENU::m_icon
protectedinherited

Optional icon.

Definition at line 276 of file action_menu.h.

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

◆ m_isContextMenu

bool ACTION_MENU::m_isContextMenu
protectedinherited

Definition at line 269 of file action_menu.h.

Referenced by ACTION_MENU(), and OnMenuEvent().

◆ m_isForcedPosition

bool ACTION_MENU::m_isForcedPosition
protectedinherited

Definition at line 263 of file action_menu.h.

Referenced by ACTION_MENU().

◆ m_selected

int ACTION_MENU::m_selected
protectedinherited

Store the id number of selected item.

Definition at line 279 of file action_menu.h.

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

◆ m_submenus

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

List of submenus.

Definition at line 288 of file action_menu.h.

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

◆ m_title

wxString ACTION_MENU::m_title
protectedinherited

Menu title.

Definition at line 272 of file action_menu.h.

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

◆ m_titleDisplayed

bool ACTION_MENU::m_titleDisplayed
protectedinherited

Definition at line 268 of file action_menu.h.

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

◆ m_tool

TOOL_INTERACTIVE* ACTION_MENU::m_tool
protectedinherited

Creator of the menu.

Definition at line 282 of file action_menu.h.

Referenced by ACTION_MENU(), copyFrom(), CONDITIONAL_MENU::create(), LOCK_CONTEXT_MENU::create(), getToolManager(), SetTool(), BUS_UNFOLD_MENU::update(), and 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 285 of file action_menu.h.

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

◆ m_untranslatedTitle

wxString ACTION_MENU::m_untranslatedTitle
protectedinherited

Definition at line 273 of file action_menu.h.

Referenced by SetUntranslatedTitle(), and UpdateTitle().

◆ NORMAL

bool ACTION_MENU::NORMAL = false
staticconstexprinherited

Definition at line 203 of file action_menu.h.

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

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