KiCad PCB EDA Suite
ACTION_MENU Class Reference

Defines the structure of a menu based on ACTIONs. More...

#include <action_menu.h>

Inheritance diagram for ACTION_MENU:
BUS_UNFOLD_MENU CONDITIONAL_MENU DIFF_PAIR_MENU GRID_MENU GROUP_CONTEXT_MENU HIGHLIGHT_MENU LOCK_CONTEXT_MENU NET_CONTEXT_MENU SELECT_MENU SYMBOL_UNIT_MENU TRACK_WIDTH_MENU VIA_SIZE_MENU ZONE_CONTEXT_MENU ZOOM_MENU

Public Member Functions

 ACTION_MENU (bool isContextMenu, TOOL_INTERACTIVE *aTool=nullptr)
 < Default constructor More...
 
 ~ACTION_MENU () override
 
 ACTION_MENU (const ACTION_MENU &aMenu)=delete
 
ACTION_MENUoperator= (const ACTION_MENU &aMenu)=delete
 
void SetTitle (const wxString &aTitle) override
 Set title for the menu. More...
 
void DisplayTitle (bool aDisplay=true)
 Decide whether a title for a pop up menu should be displayed. More...
 
void SetIcon (BITMAPS aIcon)
 Assign an icon for the entry. More...
 
wxMenuItem * Add (const wxString &aLabel, int aId, BITMAPS aIcon)
 Add a wxWidgets-style entry to the menu. More...
 
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. More...
 
wxMenuItem * Add (ACTION_MENU *aMenu)
 Add an action menu as a submenu. More...
 
void AddClose (const wxString &aAppname="")
 Add a standard close item to the menu with the accelerator key CTRL-W. More...
 
void AddQuitOrClose (KIFACE_BASE *aKiface, wxString aAppname="")
 Add either a standard Quit or Close item to the menu. More...
 
void Clear ()
 Remove all the entries from the menu (as well as its title). More...
 
bool HasEnabledItems () const
 Returns true if the menu has any enabled items. More...
 
int GetSelected () const
 Return the position of selected item. More...
 
void UpdateAll ()
 Run update handlers for the menu and its submenus. More...
 
virtual void UpdateTitle ()
 Used by some menus to just-in-time translate their titles. More...
 
void ClearDirty ()
 Clear the dirty flag on the menu and all descendants. More...
 
void SetDirty ()
 
void SetTool (TOOL_INTERACTIVE *aTool)
 Set a tool that is the creator of the menu. More...
 
ACTION_MENUClone () const
 Create a deep, recursive copy of this ACTION_MENU. More...
 
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

virtual ACTION_MENUcreate () const
 < Return an instance of this class. It has to be overridden in inheriting classes. More...
 
TOOL_MANAGERgetToolManager () const
 
virtual void update ()
 Update menu state stub. More...
 
virtual OPT_TOOL_EVENT eventHandler (const wxMenuEvent &)
 Event handler stub. More...
 
void copyFrom (const ACTION_MENU &aMenu)
 Copy another menus data to this instance. More...
 
wxMenuItem * appendCopy (const wxMenuItem *aSource)
 Append a copy of wxMenuItem. More...
 
void setupEvents ()
 Update hot key settings for TOOL_ACTIONs in this menu. More...
 
void updateHotKeys ()
 Traverse the submenus tree looking for a submenu capable of handling a particular menu event. More...
 
void runEventHandlers (const wxMenuEvent &aMenuEvent, OPT_TOOL_EVENT &aToolEvent)
 Run a function on the menu and all its submenus. More...
 
void runOnSubmenus (std::function< void(ACTION_MENU *)> aFunction)
 Check if any of submenus contains a TOOL_ACTION with a specific ID. More...
 
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. More...
 
wxString m_title
 Optional icon. More...
 
BITMAPS m_icon
 Stores the id number of selected item. More...
 
int m_selected
 Creator of the menu. More...
 
TOOL_INTERACTIVEm_tool
 Associates tool actions with menu item IDs. Non-owning. More...
 
std::map< int, const TOOL_ACTION * > m_toolActions
 List of submenus. More...
 
std::list< ACTION_MENU * > m_submenus
 

Friends

class TOOL_INTERACTIVE
 

Detailed Description

Defines the structure of a menu based on ACTIONs.

Definition at line 48 of file action_menu.h.

Constructor & Destructor Documentation

◆ ACTION_MENU() [1/2]

ACTION_MENU::ACTION_MENU ( bool  isContextMenu,
TOOL_INTERACTIVE aTool = nullptr 
)

< Default constructor

Definition at line 47 of file action_menu.cpp.

47  :
48  m_isForcedPosition( false ),
49  m_dirty( true ),
50  m_titleDisplayed( false ),
51  m_isContextMenu( isContextMenu ),
53  m_selected( -1 ),
54  m_tool( aTool )
55 {
56  setupEvents();
57 }
bool m_titleDisplayed
Definition: action_menu.h:253
BITMAPS m_icon
Stores the id number of selected item.
Definition: action_menu.h:260
bool m_isContextMenu
Menu title.
Definition: action_menu.h:254
int m_selected
Creator of the menu.
Definition: action_menu.h:263
TOOL_INTERACTIVE * m_tool
Associates tool actions with menu item IDs. Non-owning.
Definition: action_menu.h:266
bool m_isForcedPosition
Definition: action_menu.h:248
void setupEvents()
Update hot key settings for TOOL_ACTIONs in this menu.
Definition: action_menu.cpp:79

References INVALID_BITMAP, and setupEvents().

Referenced by create(), and BUS_UNFOLD_MENU::update().

◆ ~ACTION_MENU()

ACTION_MENU::~ACTION_MENU ( )
override

Definition at line 60 of file action_menu.cpp.

61 {
62  // Set parent to NULL to prevent submenus from unregistering from a nonexistent object
63  for( auto menu : m_submenus )
64  menu->SetParent( nullptr );
65 
66  ACTION_MENU* parent = dynamic_cast<ACTION_MENU*>( GetParent() );
67 
68  if( parent )
69  parent->m_submenus.remove( this );
70 }
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:48
std::list< ACTION_MENU * > m_submenus
Definition: action_menu.h:272

References m_submenus.

◆ ACTION_MENU() [2/2]

ACTION_MENU::ACTION_MENU ( const ACTION_MENU aMenu)
delete

Member Function Documentation

◆ Add() [1/4]

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

Add a wxWidgets-style entry to the menu.

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

Definition at line 135 of file action_menu.cpp.

136 {
137  wxASSERT_MSG( FindItem( aId ) == nullptr, wxT( "Duplicate menu IDs!" ) );
138 
139  wxMenuItem* item = new wxMenuItem( this, aId, aLabel, wxEmptyString, wxITEM_NORMAL );
140 
141  if( !!aIcon )
142  AddBitmapToMenuItem( item, KiBitmap( aIcon ) );
143 
144  return Append( item );
145 }
void AddBitmapToMenuItem(wxMenuItem *aMenu, const wxBitmap &aImage)
Add a bitmap to a menuitem.
Definition: bitmap.cpp:243
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:105

References AddBitmapToMenuItem(), and KiBitmap().

Referenced by AddClose(), AddMenuLanguageList(), AddQuitOrClose(), EDA_3D_VIEWER_FRAME::CreateMenuBar(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PL_SELECTION_TOOL::doSelectionMenu(), CONDITIONAL_MENU::Evaluate(), GROUP_CONTEXT_MENU::GROUP_CONTEXT_MENU(), ALIGN_DISTRIBUTE_TOOL::Init(), NET_CONTEXT_MENU::NET_CONTEXT_MENU(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), SYMBOL_VIEWER_FRAME::ReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::ReCreateMenuBar(), SYMBOL_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), CVPCB_MAINFRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), and CVPCB_MAINFRAME::setupTools().

◆ Add() [2/4]

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

Definition at line 148 of file action_menu.cpp.

150 {
151  wxASSERT_MSG( FindItem( aId ) == nullptr, wxT( "Duplicate menu IDs!" ) );
152 
153  wxMenuItem* item = new wxMenuItem( this, aId, aLabel, aTooltip,
154  aIsCheckmarkEntry ? wxITEM_CHECK : wxITEM_NORMAL );
155 
156  if( !!aIcon )
157  AddBitmapToMenuItem( item, KiBitmap( aIcon ) );
158 
159  return Append( item );
160 }
void AddBitmapToMenuItem(wxMenuItem *aMenu, const wxBitmap &aImage)
Add a bitmap to a menuitem.
Definition: bitmap.cpp:243
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:105

References AddBitmapToMenuItem(), and KiBitmap().

◆ Add() [3/4]

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

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

165 {
167  BITMAPS icon = aAction.GetIcon();
168 
169  // Allow the label to be overridden at point of use
170  wxString menuLabel = aOverrideLabel.IsEmpty() ? aAction.GetMenuItem() : aOverrideLabel;
171 
172  wxMenuItem* item = new wxMenuItem( this, aAction.GetUIId(), menuLabel,
173  aAction.GetDescription(),
174  aIsCheckmarkEntry ? wxITEM_CHECK : wxITEM_NORMAL );
175  if( !!icon )
176  AddBitmapToMenuItem( item, KiBitmap( icon ) );
177 
178  m_toolActions[aAction.GetUIId()] = &aAction;
179 
180  return Append( item );
181 }
int GetUIId() const
Definition: tool_action.h:130
void AddBitmapToMenuItem(wxMenuItem *aMenu, const wxBitmap &aImage)
Add a bitmap to a menuitem.
Definition: bitmap.cpp:243
const BITMAPS GetIcon() const
Return an icon associated with the action.
Definition: tool_action.h:179
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:105
wxString GetDescription(bool aIncludeHotkey=true) const
Definition: tool_action.cpp:97
std::map< int, const TOOL_ACTION * > m_toolActions
List of submenus.
Definition: action_menu.h:269
BITMAPS
A list of all bitmap identifiers.
Definition: bitmaps_list.h:32
wxString GetMenuItem() const
Definition: tool_action.cpp:89

References AddBitmapToMenuItem(), TOOL_ACTION::GetDescription(), TOOL_ACTION::GetIcon(), TOOL_ACTION::GetMenuItem(), TOOL_ACTION::GetUIId(), KiBitmap(), and m_toolActions.

◆ Add() [4/4]

wxMenuItem * ACTION_MENU::Add ( ACTION_MENU aMenu)

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

185 {
186  m_submenus.push_back( aMenu );
187 
188  wxASSERT_MSG( !aMenu->m_title.IsEmpty(), wxT( "Set a title for ACTION_MENU using SetTitle()" ) );
189 
190  if( !!aMenu->m_icon )
191  {
192  wxMenuItem* newItem = new wxMenuItem( this, -1, aMenu->m_title );
193  AddBitmapToMenuItem( newItem, KiBitmap( aMenu->m_icon ) );
194  newItem->SetSubMenu( aMenu );
195  return Append( newItem );
196  }
197  else
198  {
199  return AppendSubMenu( aMenu, aMenu->m_title );
200  }
201 }
BITMAPS m_icon
Stores the id number of selected item.
Definition: action_menu.h:260
void AddBitmapToMenuItem(wxMenuItem *aMenu, const wxBitmap &aImage)
Add a bitmap to a menuitem.
Definition: bitmap.cpp:243
wxString m_title
Optional icon.
Definition: action_menu.h:257
std::list< ACTION_MENU * > m_submenus
Definition: action_menu.h:272
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:105

References AddBitmapToMenuItem(), KiBitmap(), m_icon, m_submenus, and m_title.

◆ AddClose()

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

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

205 {
206 #ifdef __WINDOWS__
207  Add( _( "Close" ),
208  wxString::Format( _( "Close %s" ), aAppname ),
209  wxID_CLOSE,
210  BITMAPS::exit );
211 #else
212  Add( _( "Close" ) + "\tCtrl+W",
213  wxString::Format( _( "Close %s" ), aAppname ),
214  wxID_CLOSE,
215  BITMAPS::exit );
216 #endif
217 }
#define _(s)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
wxMenuItem * Add(const wxString &aLabel, int aId, BITMAPS aIcon)
Add a wxWidgets-style entry to the menu.

References _, Add(), exit, and Format().

Referenced by AddQuitOrClose(), EDA_3D_VIEWER_FRAME::CreateMenuBar(), SYMBOL_VIEWER_FRAME::ReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::ReCreateMenuBar(), SYMBOL_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), and CVPCB_MAINFRAME::ReCreateMenuBar().

◆ AddQuitOrClose()

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

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

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

Parameters
aAppnameis the application name to append to the tooltip.

Definition at line 220 of file action_menu.cpp.

221 {
222  if( !aKiface || aKiface->IsSingle() ) // not when under a project mgr
223  {
224  // Don't use ACTIONS::quit; wxWidgets moves this on OSX and expects to find it via
225  // wxID_EXIT
226  Add( _( "Quit" ) + "\tCtrl+Q",
227  wxString::Format( _( "Quit %s" ), aAppname ),
228  wxID_EXIT,
229  BITMAPS::exit );
230  }
231  else
232  {
233  AddClose( aAppname );
234  }
235 }
#define _(s)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
wxMenuItem * Add(const wxString &aLabel, int aId, BITMAPS aIcon)
Add a wxWidgets-style entry to the menu.
bool IsSingle() const
Is this KIFACE running under single_top?
Definition: kiface_base.h:104
void AddClose(const wxString &aAppname="")
Add a standard close item to the menu with the accelerator key CTRL-W.

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

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

◆ appendCopy()

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

Append a copy of wxMenuItem.

Initialize handlers for events.

Definition at line 629 of file action_menu.cpp.

630 {
631  wxMenuItem* newItem = new wxMenuItem( this, aSource->GetId(), aSource->GetItemLabel(),
632  aSource->GetHelp(), aSource->GetKind() );
633 
634  // Add the source bitmap if it is not the wxNullBitmap
635  // On Windows, for Checkable Menu items, adding a bitmap adds also
636  // our predefined checked alternate bitmap
637  // On other OS, wxITEM_CHECK and wxITEM_RADIO Menu items do not use custom bitmaps.
638 #if defined( _WIN32 )
639  // On Windows, AddBitmapToMenuItem() uses the unchecked bitmap for wxITEM_CHECK and
640  // wxITEM_RADIO menuitems and autoamtically adds a checked bitmap.
641  // For other menuitrms, use the "checked" bitmap.
642  bool use_checked_bm = ( aSource->GetKind() == wxITEM_CHECK ||
643  aSource->GetKind() == wxITEM_RADIO ) ? false : true;
644  const wxBitmap& src_bitmap = aSource->GetBitmap( use_checked_bm );
645 #else
646  const wxBitmap& src_bitmap = aSource->GetBitmap();
647 #endif
648 
649  if( src_bitmap.IsOk() && src_bitmap.GetHeight() > 1 ) // a null bitmap has a 0 size
650  AddBitmapToMenuItem( newItem, src_bitmap );
651 
652  if( aSource->IsSubMenu() )
653  {
654  ACTION_MENU* menu = dynamic_cast<ACTION_MENU*>( aSource->GetSubMenu() );
655  wxASSERT_MSG( menu, wxT( "Submenus are expected to be a ACTION_MENU" ) );
656 
657  if( menu )
658  {
659  ACTION_MENU* menuCopy = menu->Clone();
660  newItem->SetSubMenu( menuCopy );
661  m_submenus.push_back( menuCopy );
662  }
663  }
664 
665  // wxMenuItem has to be added before enabling/disabling or checking
666  Append( newItem );
667 
668  if( aSource->IsCheckable() )
669  newItem->Check( aSource->IsChecked() );
670 
671  newItem->Enable( aSource->IsEnabled() );
672 
673  return newItem;
674 }
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:48
void AddBitmapToMenuItem(wxMenuItem *aMenu, const wxBitmap &aImage)
Add a bitmap to a menuitem.
Definition: bitmap.cpp:243
std::list< ACTION_MENU * > m_submenus
Definition: action_menu.h:272
ACTION_MENU * Clone() const
Create a deep, recursive copy of this ACTION_MENU.

References AddBitmapToMenuItem(), Clone(), and m_submenus.

Referenced by copyFrom().

◆ Clear()

void ACTION_MENU::Clear ( )

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

It leaves the menu in the initial state.

Definition at line 238 of file action_menu.cpp.

239 {
240  m_titleDisplayed = false;
241 
242  for( int i = GetMenuItemCount() - 1; i >= 0; --i )
243  Destroy( FindItemByPosition( i ) );
244 
245  m_toolActions.clear();
246  m_submenus.clear();
247 
248  wxASSERT( GetMenuItemCount() == 0 );
249 }
bool m_titleDisplayed
Definition: action_menu.h:253
std::list< ACTION_MENU * > m_submenus
Definition: action_menu.h:272
std::map< int, const TOOL_ACTION * > m_toolActions
List of submenus.
Definition: action_menu.h:269

References m_submenus, m_titleDisplayed, and m_toolActions.

Referenced by Clone(), CONDITIONAL_MENU::Evaluate(), ZOOM_MENU::update(), SYMBOL_UNIT_MENU::update(), VIA_SIZE_MENU::update(), BUS_UNFOLD_MENU::update(), TRACK_WIDTH_MENU::update(), and DIFF_PAIR_MENU::update().

◆ ClearDirty()

void ACTION_MENU::ClearDirty ( )

Clear the dirty flag on the menu and all descendants.

Definition at line 281 of file action_menu.cpp.

282 {
283  m_dirty = false;
284  runOnSubmenus( std::bind( &ACTION_MENU::ClearDirty, _1 ) );
285 }
void ClearDirty()
Clear the dirty flag on the menu and all descendants.
void runOnSubmenus(std::function< void(ACTION_MENU *)> aFunction)
Check if any of submenus contains a TOOL_ACTION with a specific ID.

References m_dirty, and runOnSubmenus().

Referenced by TOOL_MENU::ShowContextMenu().

◆ Clone()

ACTION_MENU * ACTION_MENU::Clone ( ) const

Create a deep, recursive copy of this ACTION_MENU.

Definition at line 302 of file action_menu.cpp.

303 {
304  ACTION_MENU* clone = create();
305  clone->Clear();
306  clone->copyFrom( *this );
307  return clone;
308 }
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:48
virtual ACTION_MENU * create() const
< Return an instance of this class. It has to be overridden in inheriting classes.
void copyFrom(const ACTION_MENU &aMenu)
Copy another menus data to this instance.
void Clear()
Remove all the entries from the menu (as well as its title).

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

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

◆ copyFrom()

void ACTION_MENU::copyFrom ( const ACTION_MENU aMenu)
protected

Copy another menus data to this instance.

Old entries are preserved and ones form aMenu are copied.

Definition at line 611 of file action_menu.cpp.

612 {
613  m_icon = aMenu.m_icon;
614  m_title = aMenu.m_title;
616  m_selected = -1; // aMenu.m_selected;
617  m_tool = aMenu.m_tool;
619 
620  // Copy all menu entries
621  for( int i = 0; i < (int) aMenu.GetMenuItemCount(); ++i )
622  {
623  wxMenuItem* item = aMenu.FindItemByPosition( i );
624  appendCopy( item );
625  }
626 }
bool m_titleDisplayed
Definition: action_menu.h:253
BITMAPS m_icon
Stores the id number of selected item.
Definition: action_menu.h:260
wxString m_title
Optional icon.
Definition: action_menu.h:257
int m_selected
Creator of the menu.
Definition: action_menu.h:263
TOOL_INTERACTIVE * m_tool
Associates tool actions with menu item IDs. Non-owning.
Definition: action_menu.h:266
wxMenuItem * appendCopy(const wxMenuItem *aSource)
Append a copy of wxMenuItem.
std::map< int, const TOOL_ACTION * > m_toolActions
List of submenus.
Definition: action_menu.h:269

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

Referenced by Clone().

◆ create()

ACTION_MENU * ACTION_MENU::create ( ) const
protectedvirtual

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

Returns an instance of TOOL_MANAGER class.

Reimplemented in DIFF_PAIR_MENU, TRACK_WIDTH_MENU, LOCK_CONTEXT_MENU, HIGHLIGHT_MENU, ZONE_CONTEXT_MENU, BUS_UNFOLD_MENU, SELECT_MENU, VIA_SIZE_MENU, SYMBOL_UNIT_MENU, NET_CONTEXT_MENU, GROUP_CONTEXT_MENU, CONDITIONAL_MENU, GRID_MENU, and ZOOM_MENU.

Definition at line 311 of file action_menu.cpp.

312 {
313  ACTION_MENU* menu = new ACTION_MENU( false );
314 
315  wxASSERT_MSG( typeid( *this ) == typeid( *menu ),
316  wxString::Format( "You need to override create() method for class %s",
317  typeid( *this ).name() ) );
318 
319  return menu;
320 }
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:48
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
ACTION_MENU(bool isContextMenu, TOOL_INTERACTIVE *aTool=nullptr)
< Default constructor
Definition: action_menu.cpp:47

References ACTION_MENU(), and Format().

Referenced by Clone().

◆ DisplayTitle()

void ACTION_MENU::DisplayTitle ( bool  aDisplay = true)

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

Definition at line 98 of file action_menu.cpp.

99 {
100  if( ( !aDisplay || m_title.IsEmpty() ) && m_titleDisplayed )
101  {
102  // Destroy the menu entry keeping the title..
103  wxMenuItem* item = FindItemByPosition( 0 );
104  wxASSERT( item->GetItemLabelText() == GetTitle() );
105  Destroy( item );
106  // ..and separator
107  item = FindItemByPosition( 0 );
108  wxASSERT( item->IsSeparator() );
109  Destroy( item );
110  m_titleDisplayed = false;
111  }
112 
113  else if( aDisplay && !m_title.IsEmpty() )
114  {
115  if( m_titleDisplayed )
116  {
117  // Simply update the title
118  FindItemByPosition( 0 )->SetItemLabel( m_title );
119  }
120  else
121  {
122  // Add a separator and a menu entry to display the title
123  InsertSeparator( 0 );
124  Insert( 0, new wxMenuItem( this, wxID_NONE, m_title, wxEmptyString, wxITEM_NORMAL ) );
125 
126  if( !!m_icon )
127  AddBitmapToMenuItem( FindItemByPosition( 0 ), KiBitmap( m_icon ) );
128 
129  m_titleDisplayed = true;
130  }
131  }
132 }
bool m_titleDisplayed
Definition: action_menu.h:253
BITMAPS m_icon
Stores the id number of selected item.
Definition: action_menu.h:260
void AddBitmapToMenuItem(wxMenuItem *aMenu, const wxBitmap &aImage)
Add a bitmap to a menuitem.
Definition: bitmap.cpp:243
wxString m_title
Optional icon.
Definition: action_menu.h:257
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:105

References AddBitmapToMenuItem(), KiBitmap(), m_icon, m_title, and m_titleDisplayed.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PL_SELECTION_TOOL::doSelectionMenu(), and SetTitle().

◆ eventHandler()

virtual OPT_TOOL_EVENT ACTION_MENU::eventHandler ( const wxMenuEvent &  )
inlineprotectedvirtual

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 DIFF_PAIR_MENU, TRACK_WIDTH_MENU, VIA_SIZE_MENU, GRID_MENU, and ZOOM_MENU.

Definition at line 214 of file action_menu.h.

215  {
216  return OPT_TOOL_EVENT();
217  }
OPT< TOOL_EVENT > OPT_TOOL_EVENT
Definition: tool_event.h:548

Referenced by OnMenuEvent(), and runEventHandlers().

◆ findToolAction()

OPT_TOOL_EVENT ACTION_MENU::findToolAction ( int  aId)
protected

Definition at line 588 of file action_menu.cpp.

589 {
590  OPT_TOOL_EVENT evt;
591 
592  auto findFunc = [&]( ACTION_MENU* m ) {
593  if( evt )
594  return;
595 
596  const auto it = m->m_toolActions.find( aId );
597 
598  if( it != m->m_toolActions.end() )
599  evt = it->second->MakeEvent();
600  };
601 
602  findFunc( this );
603 
604  if( !evt )
605  runOnSubmenus( findFunc );
606 
607  return evt;
608 }
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:48
void runOnSubmenus(std::function< void(ACTION_MENU *)> aFunction)
Check if any of submenus contains a TOOL_ACTION with a specific ID.
OPT< TOOL_EVENT > OPT_TOOL_EVENT
Definition: tool_event.h:548

References runOnSubmenus().

Referenced by OnMenuEvent().

◆ GetSelected()

int ACTION_MENU::GetSelected ( ) const
inline

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

151  {
152  return m_selected;
153  }
int m_selected
Creator of the menu.
Definition: action_menu.h:263

References m_selected.

◆ getToolManager()

TOOL_MANAGER * ACTION_MENU::getToolManager ( ) const
protected

Definition at line 323 of file action_menu.cpp.

324 {
325  wxASSERT( m_tool );
326  return m_tool ? m_tool->GetManager() : nullptr;
327 }
TOOL_MANAGER * GetManager() const
Return the instance of TOOL_MANAGER that takes care of the tool.
Definition: tool_base.h:143
TOOL_INTERACTIVE * m_tool
Associates tool actions with menu item IDs. Non-owning.
Definition: action_menu.h:266

References TOOL_BASE::GetManager(), and m_tool.

Referenced by VIA_SIZE_MENU::eventHandler(), OnMenuEvent(), GROUP_CONTEXT_MENU::update(), SYMBOL_UNIT_MENU::update(), VIA_SIZE_MENU::update(), BUS_UNFOLD_MENU::update(), and updateHotKeys().

◆ HasEnabledItems()

bool ACTION_MENU::HasEnabledItems ( ) const

Returns true if the menu has any enabled items.

Definition at line 252 of file action_menu.cpp.

253 {
254  for( wxMenuItem* item : GetMenuItems() )
255  {
256  if( item->IsEnabled() && !item->IsSeparator() )
257  return true;
258  }
259 
260  return false;
261 }

◆ OnIdle()

void ACTION_MENU::OnIdle ( wxIdleEvent &  event)

Definition at line 379 of file action_menu.cpp.

380 {
382  g_menu_open_position.x = 0.0;
383  g_menu_open_position.y = 0.0;
384 }
static int g_last_menu_highlighted_id
static VECTOR2D g_menu_open_position

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

Referenced by setupEvents().

◆ OnMenuEvent()

void ACTION_MENU::OnMenuEvent ( wxMenuEvent &  aEvent)

Definition at line 387 of file action_menu.cpp.

388 {
389  OPT_TOOL_EVENT evt;
390  wxString menuText;
391  wxEventType type = aEvent.GetEventType();
392  wxWindow* focus = wxWindow::FindFocus();
393 
394  if( type == wxEVT_MENU_OPEN )
395  {
396  if( m_dirty && m_tool )
397  getToolManager()->RunAction( ACTIONS::updateMenu, true, this );
398 
399  wxMenu* parent = dynamic_cast<wxMenu*>( GetParent() );
400 
401  // Don't update the position if this menu has a parent
402  if( !parent && m_tool )
404 
406  }
407  else if( type == wxEVT_MENU_HIGHLIGHT )
408  {
409  if( aEvent.GetId() > 0 )
410  g_last_menu_highlighted_id = aEvent.GetId();
411 
412  evt = TOOL_EVENT( TC_COMMAND, TA_CHOICE_MENU_UPDATE, aEvent.GetId() );
413  }
414  else if( type == wxEVT_COMMAND_MENU_SELECTED )
415  {
416  // Despite our attempts to catch the theft of text editor CHAR_HOOK and CHAR events
417  // in TOOL_DISPATCHER::DispatchWxEvent, wxWidgets sometimes converts those it knows
418  // about into menu commands without ever generating the appropriate CHAR_HOOK and CHAR
419  // events first.
420  if( dynamic_cast<wxTextEntry*>( focus )
421  || dynamic_cast<wxStyledTextCtrl*>( focus )
422  || dynamic_cast<wxListView*>( focus ) )
423  {
424  // Original key event has been lost, so we have to re-create it from the menu's
425  // wxAcceleratorEntry.
426  wxMenuItem* menuItem = FindItem( aEvent.GetId() );
427  wxAcceleratorEntry* acceleratorKey = menuItem ? menuItem->GetAccel() : nullptr;
428 
429  if( acceleratorKey )
430  {
431  wxKeyEvent keyEvent( wxEVT_CHAR_HOOK );
432  keyEvent.m_keyCode = acceleratorKey->GetKeyCode();
433  keyEvent.m_controlDown = ( acceleratorKey->GetFlags() & wxMOD_CONTROL ) > 0;
434  keyEvent.m_shiftDown = ( acceleratorKey->GetFlags() & wxMOD_SHIFT ) > 0;
435  keyEvent.m_altDown = ( acceleratorKey->GetFlags() & wxMOD_ALT ) > 0;
436 
437  if( auto ctrl = dynamic_cast<wxTextEntry*>( focus ) )
438  TEXTENTRY_TRICKS::OnCharHook( ctrl, keyEvent );
439  else
440  focus->HandleWindowEvent( keyEvent );
441 
442  if( keyEvent.GetSkipped() )
443  {
444  keyEvent.SetEventType( wxEVT_CHAR );
445  focus->HandleWindowEvent( keyEvent );
446  }
447 
448  // If the event was used as KEY event (not skipped) by the focused window,
449  // just finish.
450  // Otherwise this is actually a wxEVT_COMMAND_MENU_SELECTED, or the
451  // focused window is read only
452  if( !keyEvent.GetSkipped() )
453  return;
454  }
455  }
456 
457  // Store the selected position, so it can be checked by the tools
458  m_selected = aEvent.GetId();
459 
460  ACTION_MENU* parent = dynamic_cast<ACTION_MENU*>( GetParent() );
461 
462  while( parent )
463  {
464  parent->m_selected = m_selected;
465  parent = dynamic_cast<ACTION_MENU*>( parent->GetParent() );
466  }
467 
468  // Check if there is a TOOL_ACTION for the given ID
470  evt = findToolAction( m_selected );
471 
472  if( !evt )
473  {
474 #ifdef __WINDOWS__
475  if( !evt )
476  {
477  // Try to find the submenu which holds the selected item
478  wxMenu* menu = nullptr;
479  FindItem( m_selected, &menu );
480 
481  // This conditional compilation is probably not needed.
482  // It will be removed later, for the Kicad V 6.x version.
483  // But in "old" 3.0 version, the "&& menu != this" contition was added to avoid
484  // hang. This hang is no longer encountered in wxWidgets 3.0.4 version, and this
485  // condition is no longer needed. And in 3.1.2, we have to remove it, as
486  // "menu != this" never happens ("menu != this" always happens in 3.1.1 and older!).
487 #if wxCHECK_VERSION( 3, 1, 2 )
488  if( menu )
489 #else
490  if( menu && menu != this )
491 #endif
492  {
493  ACTION_MENU* cxmenu = static_cast<ACTION_MENU*>( menu );
494  evt = cxmenu->eventHandler( aEvent );
495  }
496  }
497 #else
498  if( !evt )
499  runEventHandlers( aEvent, evt );
500 #endif
501 
502  // Handling non-ACTION menu entries. Two ranges of ids are supported:
503  // between 0 and ID_CONTEXT_MENU_ID_MAX
504  // between ID_POPUP_MENU_START and ID_POPUP_MENU_END
505 
506  #define ID_CONTEXT_MENU_ID_MAX wxID_LOWEST /* = 100 should be plenty */
507 
508  if( !evt &&
509  ( ( m_selected >= 0 && m_selected < ID_CONTEXT_MENU_ID_MAX ) ||
511  {
512  ACTION_MENU* actionMenu = dynamic_cast<ACTION_MENU*>( GetParent() );
513 
514  if( actionMenu && actionMenu->PassHelpTextToHandler() )
515  menuText = GetHelpString( aEvent.GetId() );
516  else
517  menuText = GetLabelText( aEvent.GetId() );
518 
520  &menuText );
521  }
522  }
523  }
524 
525  // forward the action/update event to the TOOL_MANAGER
526  // clients that don't supply a tool will have to check GetSelected() themselves
527  if( evt && m_tool )
528  {
529  wxLogTrace( kicadTraceToolStack, wxT( "ACTION_MENU::OnMenuEvent %s" ), evt->Format() );
530 
531  // WARNING: if you're squeamish, look away.
532  // What follows is a series of egregious hacks necessitated by a lack of information from
533  // wxWidgets on where context-menu-commands and command-key-events originated.
534 
535  // If it's a context menu then fetch the mouse position from our context-menu-position
536  // hack.
537  if( m_isContextMenu )
538  {
539  evt->SetMousePosition( g_menu_open_position );
540  }
541  // Otherwise, if g_last_menu_highlighted_id matches then it's a menubar menu event and has
542  // no position.
543  else if( g_last_menu_highlighted_id == aEvent.GetId() )
544  {
545  evt->SetHasPosition( false );
546  }
547  // Otherwise it's a command-key-event and we need to get the mouse position from the tool
548  // manager so that immediate actions work.
549  else
550  {
551  evt->SetMousePosition( getToolManager()->GetMousePosition() );
552  }
553 
554  if( m_tool->GetManager() )
555  m_tool->GetManager()->ProcessEvent( *evt );
556  }
557  else
558  {
559  aEvent.Skip();
560  }
561 }
OPT_TOOL_EVENT findToolAction(int aId)
static int g_last_menu_highlighted_id
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:48
VECTOR2D GetMousePosition() const
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:143
void runEventHandlers(const wxMenuEvent &aMenuEvent, OPT_TOOL_EVENT &aToolEvent)
Run a function on the menu and all its submenus.
static int GetBaseUIId()
Definition: tool_action.h:135
TOOL_MANAGER * GetManager() const
Return the instance of TOOL_MANAGER that takes care of the tool.
Definition: tool_base.h:143
virtual OPT_TOOL_EVENT eventHandler(const wxMenuEvent &)
Event handler stub.
Definition: action_menu.h:214
virtual bool PassHelpTextToHandler()
Definition: action_menu.h:186
#define ID_CONTEXT_MENU_ID_MAX
bool m_isContextMenu
Menu title.
Definition: action_menu.h:254
bool ProcessEvent(const TOOL_EVENT &aEvent)
Propagate an event to tools that requested events of matching type(s).
Generic, UI-independent tool event.
Definition: tool_event.h:152
static VECTOR2D g_menu_open_position
int m_selected
Creator of the menu.
Definition: action_menu.h:263
static TOOL_ACTION updateMenu
Definition: actions.h:167
TOOL_INTERACTIVE * m_tool
Associates tool actions with menu item IDs. Non-owning.
Definition: action_menu.h:266
Global action (toolbar/main menu event, global shortcut)
static void OnCharHook(wxTextEntry *aTextEntry, wxKeyEvent &aEvent)
TOOL_MANAGER * getToolManager() const
const wxChar *const kicadTraceToolStack
Flag to enable tracing of the tool handling stack.
OPT< TOOL_EVENT > OPT_TOOL_EVENT
Definition: tool_event.h:548

References AS_GLOBAL, eventHandler(), findToolAction(), g_last_menu_highlighted_id, g_menu_open_position, TOOL_ACTION::GetBaseUIId(), TOOL_BASE::GetManager(), TOOL_MANAGER::GetMousePosition(), getToolManager(), ID_CONTEXT_MENU_ID_MAX, ID_POPUP_MENU_END, ID_POPUP_MENU_START, kicadTraceToolStack, m_dirty, m_isContextMenu, m_selected, m_tool, 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(), and setupEvents().

◆ operator=()

ACTION_MENU& ACTION_MENU::operator= ( const ACTION_MENU aMenu)
delete

◆ PassHelpTextToHandler()

virtual bool ACTION_MENU::PassHelpTextToHandler ( )
inlinevirtual

Reimplemented in BUS_UNFOLD_MENU.

Definition at line 186 of file action_menu.h.

186 { return false; }

Referenced by OnMenuEvent().

◆ runEventHandlers()

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

Run a function on the menu and all its submenus.

Definition at line 564 of file action_menu.cpp.

565 {
566  aToolEvent = eventHandler( aMenuEvent );
567 
568  if( !aToolEvent )
569  runOnSubmenus( std::bind( &ACTION_MENU::runEventHandlers, _1, aMenuEvent, aToolEvent ) );
570 }
void runEventHandlers(const wxMenuEvent &aMenuEvent, OPT_TOOL_EVENT &aToolEvent)
Run a function on the menu and all its submenus.
virtual OPT_TOOL_EVENT eventHandler(const wxMenuEvent &)
Event handler stub.
Definition: action_menu.h:214
void runOnSubmenus(std::function< void(ACTION_MENU *)> aFunction)
Check if any of submenus contains a TOOL_ACTION with a specific ID.

References eventHandler(), and runOnSubmenus().

Referenced by OnMenuEvent().

◆ runOnSubmenus()

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

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

Definition at line 573 of file action_menu.cpp.

574 {
575  try
576  {
577  std::for_each( m_submenus.begin(), m_submenus.end(), [&]( ACTION_MENU* m ) {
578  aFunction( m );
579  m->runOnSubmenus( aFunction );
580  } );
581  }
582  catch( std::exception& )
583  {
584  }
585 }
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:48
std::list< ACTION_MENU * > m_submenus
Definition: action_menu.h:272

References m_submenus.

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

◆ SetDirty()

void ACTION_MENU::SetDirty ( )

Definition at line 288 of file action_menu.cpp.

289 {
290  m_dirty = true;
291  runOnSubmenus( std::bind( &ACTION_MENU::SetDirty, _1 ) );
292 }
void runOnSubmenus(std::function< void(ACTION_MENU *)> aFunction)
Check if any of submenus contains a TOOL_ACTION with a specific ID.
void SetDirty()

References m_dirty, and runOnSubmenus().

Referenced by TOOL_MENU::ShowContextMenu().

◆ SetIcon()

◆ SetTitle()

void ACTION_MENU::SetTitle ( const wxString &  aTitle)
override

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

88 {
89  // Unfortunately wxMenu::SetTitle() does not work very well, so this is an alternative version
90  m_title = aTitle;
91 
92  // Update the menu title
93  if( m_titleDisplayed )
94  DisplayTitle( true );
95 }
bool m_titleDisplayed
Definition: action_menu.h:253
wxString m_title
Optional icon.
Definition: action_menu.h:257
void DisplayTitle(bool aDisplay=true)
Decide whether a title for a pop up menu should be displayed.
Definition: action_menu.cpp:98

References DisplayTitle(), m_title, and m_titleDisplayed.

Referenced by AddMenuLanguageList(), BUS_UNFOLD_MENU::BUS_UNFOLD_MENU(), EDA_3D_VIEWER_FRAME::CreateMenuBar(), DIFF_PAIR_MENU::DIFF_PAIR_MENU(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PL_SELECTION_TOOL::doSelectionMenu(), GROUP_CONTEXT_MENU::GROUP_CONTEXT_MENU(), ROUTER_TOOL::Init(), LENGTH_TUNER_TOOL::Init(), CONVERT_TOOL::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), NET_CONTEXT_MENU::NET_CONTEXT_MENU(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), SYMBOL_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), SPECIAL_TOOLS_CONTEXT_MENU::SPECIAL_TOOLS_CONTEXT_MENU(), SYMBOL_UNIT_MENU::SYMBOL_UNIT_MENU(), TRACK_WIDTH_MENU::TRACK_WIDTH_MENU(), ZOOM_MENU::UpdateTitle(), GRID_MENU::UpdateTitle(), and VIA_SIZE_MENU::VIA_SIZE_MENU().

◆ SetTool()

void ACTION_MENU::SetTool ( TOOL_INTERACTIVE aTool)

Set a tool that is the creator of the menu.

Parameters
aToolis the tool that created the menu.

Definition at line 295 of file action_menu.cpp.

296 {
297  m_tool = aTool;
298  runOnSubmenus( std::bind( &ACTION_MENU::SetTool, _1, aTool ) );
299 }
void SetTool(TOOL_INTERACTIVE *aTool)
Set a tool that is the creator of the menu.
TOOL_INTERACTIVE * m_tool
Associates tool actions with menu item IDs. Non-owning.
Definition: action_menu.h:266
void runOnSubmenus(std::function< void(ACTION_MENU *)> aFunction)
Check if any of submenus contains a TOOL_ACTION with a specific ID.

References m_tool, and runOnSubmenus().

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

◆ setupEvents()

void ACTION_MENU::setupEvents ( )
protected

Update hot key settings for TOOL_ACTIONs in this menu.

Definition at line 79 of file action_menu.cpp.

80 {
81  Connect( wxEVT_COMMAND_MENU_SELECTED, wxMenuEventHandler( ACTION_MENU::OnMenuEvent ), nullptr,
82  this );
83  Connect( wxEVT_IDLE, wxIdleEventHandler( ACTION_MENU::OnIdle ), nullptr, this );
84 }
void OnMenuEvent(wxMenuEvent &aEvent)
void OnIdle(wxIdleEvent &event)

References OnIdle(), and OnMenuEvent().

Referenced by ACTION_MENU().

◆ update()

virtual void ACTION_MENU::update ( )
inlineprotectedvirtual

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 DIFF_PAIR_MENU, TRACK_WIDTH_MENU, BUS_UNFOLD_MENU, SYMBOL_UNIT_MENU, VIA_SIZE_MENU, GROUP_CONTEXT_MENU, HIGHLIGHT_MENU, GRID_MENU, and ZOOM_MENU.

Definition at line 204 of file action_menu.h.

205  {
206  }

Referenced by UpdateAll().

◆ UpdateAll()

void ACTION_MENU::UpdateAll ( )

Run update handlers for the menu and its submenus.

Definition at line 264 of file action_menu.cpp.

265 {
266  try
267  {
268  update();
269  }
270  catch( std::exception& )
271  {
272  }
273 
274  if( m_tool )
275  updateHotKeys();
276 
277  runOnSubmenus( std::bind( &ACTION_MENU::UpdateAll, _1 ) );
278 }
virtual void update()
Update menu state stub.
Definition: action_menu.h:204
void UpdateAll()
Run update handlers for the menu and its submenus.
TOOL_INTERACTIVE * m_tool
Associates tool actions with menu item IDs. Non-owning.
Definition: action_menu.h:266
void runOnSubmenus(std::function< void(ACTION_MENU *)> aFunction)
Check if any of submenus contains a TOOL_ACTION with a specific ID.
void updateHotKeys()
Traverse the submenus tree looking for a submenu capable of handling a particular menu event.

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

Referenced by ACTION_TOOLBAR::onToolRightClick(), CONDITIONAL_MENU::Resolve(), TOOL_MENU::ShowContextMenu(), KICAD_MANAGER_CONTROL::UpdateMenu(), PL_SELECTION_TOOL::UpdateMenu(), EDA_3D_CONTROLLER::UpdateMenu(), GERBVIEW_SELECTION_TOOL::UpdateMenu(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::UpdateMenu(), EE_SELECTION_TOOL::UpdateMenu(), CVPCB_CONTROL::UpdateMenu(), and PCB_SELECTION_TOOL::UpdateMenu().

◆ updateHotKeys()

void ACTION_MENU::updateHotKeys ( )
protected

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

331 {
332  TOOL_MANAGER* toolMgr = getToolManager();
333 
334  for( std::pair<const int, const TOOL_ACTION*>& ii : m_toolActions )
335  {
336  int id = ii.first;
337  const TOOL_ACTION& action = *ii.second;
338  int key = toolMgr->GetHotKey( action ) & ~MD_MODIFIER_MASK;
339 
340  if( key > 0 )
341  {
342  int mod = toolMgr->GetHotKey( action ) & MD_MODIFIER_MASK;
343  int flags = 0;
344  wxMenuItem* item = FindChildItem( id );
345 
346  if( item )
347  {
348  flags |= ( mod & MD_ALT ) ? wxACCEL_ALT : 0;
349  flags |= ( mod & MD_CTRL ) ? wxACCEL_CTRL : 0;
350  flags |= ( mod & MD_SHIFT ) ? wxACCEL_SHIFT : 0;
351 
352  if( !flags )
353  flags = wxACCEL_NORMAL;
354 
355  wxAcceleratorEntry accel( flags, key, id, item );
356  item->SetAccel( &accel );
357  }
358  }
359  }
360 }
Master controller class:
Definition: tool_manager.h:54
std::map< int, const TOOL_ACTION * > m_toolActions
List of submenus.
Definition: action_menu.h:269
TOOL_MANAGER * getToolManager() const
Represent a single user action.
Definition: tool_action.h:67
int GetHotKey(const TOOL_ACTION &aAction) const

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 ( )
inlinevirtual

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

Reimplemented in GRID_MENU, and ZOOM_MENU.

Definition at line 163 of file action_menu.h.

163 {}

Friends And Related Function Documentation

◆ TOOL_INTERACTIVE

friend class TOOL_INTERACTIVE
friend

Definition at line 274 of file action_menu.h.

Member Data Documentation

◆ CHECK

◆ m_dirty

bool ACTION_MENU::m_dirty
protected

Definition at line 251 of file action_menu.h.

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

◆ m_forcedPosition

wxPoint ACTION_MENU::m_forcedPosition
protected

Definition at line 249 of file action_menu.h.

◆ m_icon

BITMAPS ACTION_MENU::m_icon
protected

Stores the id number of selected item.

Definition at line 260 of file action_menu.h.

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

◆ m_isContextMenu

bool ACTION_MENU::m_isContextMenu
protected

Menu title.

Definition at line 254 of file action_menu.h.

Referenced by OnMenuEvent().

◆ m_isForcedPosition

bool ACTION_MENU::m_isForcedPosition
protected

Definition at line 248 of file action_menu.h.

◆ m_selected

int ACTION_MENU::m_selected
protected

Creator of the menu.

Definition at line 263 of file action_menu.h.

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

◆ m_submenus

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

Definition at line 272 of file action_menu.h.

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

◆ m_title

wxString ACTION_MENU::m_title
protected

Optional icon.

Definition at line 257 of file action_menu.h.

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

◆ m_titleDisplayed

bool ACTION_MENU::m_titleDisplayed
protected

Definition at line 253 of file action_menu.h.

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

◆ m_tool

TOOL_INTERACTIVE* ACTION_MENU::m_tool
protected

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

Definition at line 266 of file action_menu.h.

Referenced by copyFrom(), CONDITIONAL_MENU::create(), getToolManager(), OnMenuEvent(), SetTool(), BUS_UNFOLD_MENU::update(), and UpdateAll().

◆ m_toolActions

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

List of submenus.

Definition at line 269 of file action_menu.h.

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

◆ NORMAL

constexpr bool ACTION_MENU::NORMAL = false
static

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