KiCad PCB EDA Suite
CONTEXT_MENU Class Reference

Class CONTEXT_MENU. More...

#include <context_menu.h>

Inheritance diagram for CONTEXT_MENU:
GRID_MENU HIGHLIGHT_MENU LOCK_CONTEXT_MENU PAD_CONTEXT_MENU ROUTER_TOOL_MENU SELECT_MENU TRACK_VIA_SIZE_MENU TUNER_TOOL_MENU ZONE_CONTEXT_MENU ZOOM_MENU

Public Member Functions

 CONTEXT_MENU ()
 

Default constructor

More...
 
virtual ~CONTEXT_MENU ()
 
 CONTEXT_MENU (const CONTEXT_MENU &aMenu)=delete
 
CONTEXT_MENUoperator= (const CONTEXT_MENU &aMenu)=delete
 
void SetTitle (const wxString &aTitle) override
 Function SetTitle() Sets title for the context menu. More...
 
void DisplayTitle (bool aDisplay=true)
 Function DisplayTitle() Decides whether a title for a pop up menu should be displayed. More...
 
void SetIcon (const BITMAP_OPAQUE *aIcon)
 Function SetIcon() Assigns an icon for the entry. More...
 
wxMenuItem * Add (const wxString &aLabel, int aId, const BITMAP_OPAQUE *aIcon=NULL)
 Function Add() Adds an entry to the menu. More...
 
wxMenuItem * Add (const TOOL_ACTION &aAction)
 Function Add() Adds an entry to the menu, basing on the TOOL_ACTION object. More...
 
std::list< wxMenuItem * > Add (CONTEXT_MENU *aMenu, bool aExpand=false)
 Function Add() Adds a context menu as a submenu. More...
 
void Clear ()
 Function Clear() Removes all the entries from the menu (as well as its title). More...
 
bool HasEnabledItems () const
 Function HasEnabledItems();. More...
 
int GetSelected () const
 Function GetSelected() Returns the position of selected item. More...
 
void UpdateAll ()
 Function UpdateAll() Runs update handlers for the menu and its submenus. More...
 
void SetTool (TOOL_INTERACTIVE *aTool)
 Function SetTool() Sets a tool that is the creator of the menu. More...
 
CONTEXT_MENUClone () const
 Creates a deep, recursive copy of this CONTEXT_MENU. More...
 

Protected Member Functions

virtual CONTEXT_MENUcreate () const
 

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

More...
 
TOOL_MANAGERgetToolManager ()
 

Returns an instance of TOOL_MANAGER class.

More...
 
virtual void update ()
 Update menu state stub. More...
 
virtual OPT_TOOL_EVENT eventHandler (const wxMenuEvent &)
 Event handler stub. More...
 
void copyFrom (const CONTEXT_MENU &aMenu)
 Copies another menus data to this instance. More...
 

Static Protected Member Functions

static int getMenuId (const TOOL_ACTION &aAction)
 

Returns the corresponding wxMenuItem identifier for a TOOL_ACTION object.

More...
 

Private Member Functions

wxMenuItem * appendCopy (const wxMenuItem *aSource)
 Function appendCopy Appends a copy of wxMenuItem. More...
 
void setupEvents ()
 

Initializes handlers for events.

More...
 
void onMenuEvent (wxMenuEvent &aEvent)
 

The default menu event handler.

More...
 
void updateHotKeys ()
 

Updates hot key settings for TOOL_ACTIONs in this menu.

More...
 
void runEventHandlers (const wxMenuEvent &aMenuEvent, OPT_TOOL_EVENT &aToolEvent)
 

Traverses the submenus tree looking for a submenu capable of handling a particular menu event.

More...
 
void runOnSubmenus (std::function< void(CONTEXT_MENU *)> aFunction)
 

Runs a function on the menu and all its submenus.

More...
 
OPT_TOOL_EVENT findToolAction (int aId)
 

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

More...
 

Private Attributes

bool m_titleDisplayed
 

Flag indicating that the menu title was set up.

More...
 
wxString m_title
 

Menu title

More...
 
int m_selected
 

Stores the id number of selected item.

More...
 
TOOL_INTERACTIVEm_tool
 

Creator of the menu

More...
 
std::map< int, const TOOL_ACTION * > m_toolActions
 

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

More...
 
std::list< CONTEXT_MENU * > m_submenus
 

List of submenus.

More...
 
const BITMAP_OPAQUEm_icon
 

Optional icon

More...
 

Static Private Attributes

static const int ACTION_ID = 2000
 

Menu items with ID higher than that are considered TOOL_ACTIONs

More...
 

Friends

class TOOL_INTERACTIVE
 

Detailed Description

Class CONTEXT_MENU.

Defines the structure of a context (usually right-click) popup menu for a given tool.

Definition at line 44 of file context_menu.h.

Constructor & Destructor Documentation

CONTEXT_MENU::CONTEXT_MENU ( )

Default constructor

Definition at line 36 of file context_menu.cpp.

References setupEvents().

Referenced by create().

36  :
37  m_titleDisplayed( false ), m_selected( -1 ), m_tool( nullptr ), m_icon( nullptr )
38 {
39  setupEvents();
40 }
TOOL_INTERACTIVE * m_tool
Creator of the menu
Definition: context_menu.h:219
int m_selected
Stores the id number of selected item.
Definition: context_menu.h:216
const BITMAP_OPAQUE * m_icon
Optional icon
Definition: context_menu.h:231
void setupEvents()
Initializes handlers for events.
bool m_titleDisplayed
Flag indicating that the menu title was set up.
Definition: context_menu.h:210
CONTEXT_MENU::~CONTEXT_MENU ( )
virtual

Definition at line 43 of file context_menu.cpp.

References m_submenus.

44 {
45  // Set parent to NULL to prevent submenus from unregistering from a notexisting object
46  for( auto menu : m_submenus )
47  menu->SetParent( nullptr );
48 
49  CONTEXT_MENU* parent = dynamic_cast<CONTEXT_MENU*>( GetParent() );
50  wxASSERT( parent || !GetParent() );
51 
52  if( parent )
53  parent->m_submenus.remove( this );
54 }
Class CONTEXT_MENU.
Definition: context_menu.h:44
std::list< CONTEXT_MENU * > m_submenus
List of submenus.
Definition: context_menu.h:228
CONTEXT_MENU::CONTEXT_MENU ( const CONTEXT_MENU aMenu)
delete

Member Function Documentation

wxMenuItem * CONTEXT_MENU::Add ( const wxString &  aLabel,
int  aId,
const BITMAP_OPAQUE aIcon = NULL 
)

Function Add() Adds an entry to the menu.

After highlighting/selecting the entry, a TOOL_EVENT command is sent that contains ID of the entry.

Parameters
aLabelis the text label show in the menu.
aIdis the ID that is sent in the TOOL_EVENT. It should be unique for every entry.
aIconis an optional icon.

Definition at line 134 of file context_menu.cpp.

References set_wxMenuIcon().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SELECTION_TOOL::disambiguationMenu(), CONDITIONAL_MENU::Generate(), ALIGN_DISTRIBUTE_TOOL::Init(), and PAD_CONTEXT_MENU::PAD_CONTEXT_MENU().

135 {
136 #ifdef DEBUG
137  if( FindItem( aId ) != NULL )
138  wxLogWarning( wxT( "Adding more than one menu entry with the same ID may result in"
139  "undefined behaviour" ) );
140 #endif
141 
142  wxMenuItem* item = new wxMenuItem( this, aId, aLabel, wxEmptyString, wxITEM_NORMAL );
143  set_wxMenuIcon( item, aIcon );
144 
145  return Append( item );
146 }
static void set_wxMenuIcon(wxMenuItem *aMenu, const BITMAP_OPAQUE *aIcon)
wxMenuItem * CONTEXT_MENU::Add ( const TOOL_ACTION aAction)

Function Add() Adds an entry to the menu, basing 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.

ID numbers for tool actions need to have a value higher than ACTION_ID

Definition at line 149 of file context_menu.cpp.

References TOOL_ACTION::GetDescription(), TOOL_ACTION::GetIcon(), getMenuId(), TOOL_ACTION::GetMenuItem(), i, m_toolActions, and set_wxMenuIcon().

150 {
152  const BITMAP_OPAQUE* icon = aAction.GetIcon();
153 
154  wxMenuItem* item = new wxMenuItem( this, getMenuId( aAction ), aAction.GetMenuItem(),
155  aAction.GetDescription(), wxITEM_NORMAL );
156 
157  set_wxMenuIcon( item, icon );
158 
159  m_toolActions[getMenuId( aAction )] = &aAction;
160 
161  wxMenuItem* i = Append( item );
162  return i;
163 }
PNG memory record (file in memory).
Definition: bitmap_types.h:41
const wxString & GetDescription() const
Definition: tool_action.h:124
std::map< int, const TOOL_ACTION * > m_toolActions
Associates tool actions with menu item IDs. Non-owning.
Definition: context_menu.h:225
const wxString & GetMenuItem() const
Definition: tool_action.h:114
static int getMenuId(const TOOL_ACTION &aAction)
Returns the corresponding wxMenuItem identifier for a TOOL_ACTION object.
Definition: context_menu.h:155
size_t i
Definition: json11.cpp:597
const BITMAP_OPAQUE * GetIcon() const
Returns an icon associated with the action.
Definition: tool_action.h:165
static void set_wxMenuIcon(wxMenuItem *aMenu, const BITMAP_OPAQUE *aIcon)
std::list< wxMenuItem * > CONTEXT_MENU::Add ( CONTEXT_MENU aMenu,
bool  aExpand = false 
)

Function Add() Adds a context 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.
aExpandallows to add all entries from the menu as individual entries rather than add everything as a submenu.

Definition at line 166 of file context_menu.cpp.

References appendCopy(), Clone(), i, m_icon, m_submenus, m_title, and set_wxMenuIcon().

167 {
168  std::list<wxMenuItem*> items;
169  CONTEXT_MENU* menuCopy = aMenu->Clone();
170  m_submenus.push_back( menuCopy );
171 
172  if( aExpand )
173  {
174  for( int i = 0; i < (int) aMenu->GetMenuItemCount(); ++i )
175  {
176  wxMenuItem* item = aMenu->FindItemByPosition( i );
177  items.push_back( appendCopy( item ) );
178  }
179  }
180  else
181  {
182  wxASSERT_MSG( !menuCopy->m_title.IsEmpty(), "Set a title for CONTEXT_MENU using SetTitle()" );
183 
184  if( aMenu->m_icon )
185  {
186  wxMenuItem* newItem = new wxMenuItem( this, -1, menuCopy->m_title );
187  set_wxMenuIcon( newItem, aMenu->m_icon );
188  newItem->SetSubMenu( menuCopy );
189  items.push_back( Append( newItem ) );
190  }
191  else
192  {
193  items.push_back( AppendSubMenu( menuCopy, menuCopy->m_title ) );
194  }
195  }
196 
197  return items;
198 }
Class CONTEXT_MENU.
Definition: context_menu.h:44
const BITMAP_OPAQUE * m_icon
Optional icon
Definition: context_menu.h:231
CONTEXT_MENU * Clone() const
Creates a deep, recursive copy of this CONTEXT_MENU.
size_t i
Definition: json11.cpp:597
std::list< CONTEXT_MENU * > m_submenus
List of submenus.
Definition: context_menu.h:228
wxMenuItem * appendCopy(const wxMenuItem *aSource)
Function appendCopy Appends a copy of wxMenuItem.
wxString m_title
Menu title
Definition: context_menu.h:213
static void set_wxMenuIcon(wxMenuItem *aMenu, const BITMAP_OPAQUE *aIcon)
wxMenuItem * CONTEXT_MENU::appendCopy ( const wxMenuItem *  aSource)
private

Function appendCopy Appends a copy of wxMenuItem.

Definition at line 453 of file context_menu.cpp.

References Clone(), PGM_BASE::GetUseIconsInMenus(), m_submenus, and Pgm().

Referenced by Add(), copyFrom(), and eventHandler().

454 {
455  wxMenuItem* newItem = new wxMenuItem( this, aSource->GetId(), aSource->GetItemLabel(),
456  aSource->GetHelp(), aSource->GetKind() );
457 
458  bool useImagesInMenus = Pgm().GetUseIconsInMenus();
459 
460  if( aSource->GetKind() == wxITEM_NORMAL && useImagesInMenus )
461  newItem->SetBitmap( aSource->GetBitmap() );
462 
463  if( aSource->IsSubMenu() )
464  {
465  CONTEXT_MENU* menu = dynamic_cast<CONTEXT_MENU*>( aSource->GetSubMenu() );
466  wxASSERT_MSG( menu, "Submenus are expected to be a CONTEXT_MENU" );
467 
468  if( menu )
469  {
470  CONTEXT_MENU* menuCopy = menu->Clone();
471  newItem->SetSubMenu( menuCopy );
472  m_submenus.push_back( menuCopy );
473  }
474  }
475 
476  // wxMenuItem has to be added before enabling/disabling or checking
477  Append( newItem );
478 
479  if( aSource->IsCheckable() )
480  newItem->Check( aSource->IsChecked() );
481 
482  newItem->Enable( aSource->IsEnabled() );
483 
484  return newItem;
485 }
Class CONTEXT_MENU.
Definition: context_menu.h:44
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: kicad.cpp:65
CONTEXT_MENU * Clone() const
Creates a deep, recursive copy of this CONTEXT_MENU.
bool GetUseIconsInMenus()
Definition: pgm_base.h:328
std::list< CONTEXT_MENU * > m_submenus
List of submenus.
Definition: context_menu.h:228
void CONTEXT_MENU::Clear ( )

Function Clear() Removes all the entries from the menu (as well as its title).

It leaves the menu in the initial state.

Definition at line 201 of file context_menu.cpp.

References i, m_submenus, m_titleDisplayed, and m_toolActions.

Referenced by Clone().

202 {
203  m_titleDisplayed = false;
204 
205  for( int i = GetMenuItemCount() - 1; i >= 0; --i )
206  Destroy( FindItemByPosition( i ) );
207 
208  m_toolActions.clear();
209  m_submenus.clear();
210 
211  wxASSERT( GetMenuItemCount() == 0 );
212 }
std::map< int, const TOOL_ACTION * > m_toolActions
Associates tool actions with menu item IDs. Non-owning.
Definition: context_menu.h:225
size_t i
Definition: json11.cpp:597
std::list< CONTEXT_MENU * > m_submenus
List of submenus.
Definition: context_menu.h:228
bool m_titleDisplayed
Flag indicating that the menu title was set up.
Definition: context_menu.h:210
CONTEXT_MENU * CONTEXT_MENU::Clone ( ) const

Creates a deep, recursive copy of this CONTEXT_MENU.

Definition at line 259 of file context_menu.cpp.

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

Referenced by Add(), appendCopy(), TOOL_MANAGER::dispatchContextMenu(), and GetSelected().

260 {
261  CONTEXT_MENU* clone = create();
262  clone->Clear();
263  clone->copyFrom( *this );
264  return clone;
265 }
Class CONTEXT_MENU.
Definition: context_menu.h:44
void copyFrom(const CONTEXT_MENU &aMenu)
Copies another menus data to this instance.
void Clear()
Function Clear() Removes all the entries from the menu (as well as its title).
virtual CONTEXT_MENU * create() const
Returns an instance of this class. It has to be overridden in inheriting classes. ...
void CONTEXT_MENU::copyFrom ( const CONTEXT_MENU aMenu)
protected

Copies another menus data to this instance.

Old entries are preserved, and ones form aMenu are copied.

Definition at line 435 of file context_menu.cpp.

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

Referenced by Clone(), and eventHandler().

436 {
437  m_icon = aMenu.m_icon;
438  m_title = aMenu.m_title;
440  m_selected = -1; // aMenu.m_selected;
441  m_tool = aMenu.m_tool;
443 
444  // Copy all menu entries
445  for( int i = 0; i < (int) aMenu.GetMenuItemCount(); ++i )
446  {
447  wxMenuItem* item = aMenu.FindItemByPosition( i );
448  appendCopy( item );
449  }
450 }
TOOL_INTERACTIVE * m_tool
Creator of the menu
Definition: context_menu.h:219
int m_selected
Stores the id number of selected item.
Definition: context_menu.h:216
const BITMAP_OPAQUE * m_icon
Optional icon
Definition: context_menu.h:231
std::map< int, const TOOL_ACTION * > m_toolActions
Associates tool actions with menu item IDs. Non-owning.
Definition: context_menu.h:225
size_t i
Definition: json11.cpp:597
wxMenuItem * appendCopy(const wxMenuItem *aSource)
Function appendCopy Appends a copy of wxMenuItem.
wxString m_title
Menu title
Definition: context_menu.h:213
bool m_titleDisplayed
Flag indicating that the menu title was set up.
Definition: context_menu.h:210
CONTEXT_MENU * CONTEXT_MENU::create ( ) const
protectedvirtual

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

Reimplemented in ROUTER_TOOL_MENU, TRACK_WIDTH_MENU, LOCK_CONTEXT_MENU, ZONE_CONTEXT_MENU, SELECT_MENU, HIGHLIGHT_MENU, TUNER_TOOL_MENU, PAD_CONTEXT_MENU, TRACK_VIA_SIZE_MENU, GRID_MENU, and ZOOM_MENU.

Definition at line 268 of file context_menu.cpp.

References CONTEXT_MENU(), and Format().

Referenced by Clone(), and GetSelected().

269 {
270  CONTEXT_MENU* menu = new CONTEXT_MENU();
271 
272  wxASSERT_MSG( typeid( *this ) == typeid( *menu ),
273  wxString::Format( "You need to override create() method for class %s", typeid(*this).name() ) );
274 
275  return menu;
276 }
Class CONTEXT_MENU.
Definition: context_menu.h:44
CONTEXT_MENU()
Default constructor
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
void CONTEXT_MENU::DisplayTitle ( bool  aDisplay = true)

Function DisplayTitle() Decides whether a title for a pop up menu should be displayed.

Definition at line 97 of file context_menu.cpp.

References m_icon, m_title, m_titleDisplayed, and set_wxMenuIcon().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SELECTION_TOOL::disambiguationMenu(), and SetTitle().

98 {
99  if( ( !aDisplay || m_title.IsEmpty() ) && m_titleDisplayed )
100  {
101  // Destroy the menu entry keeping the title..
102  wxMenuItem* item = FindItemByPosition( 0 );
103  wxASSERT( item->GetItemLabelText() == GetTitle() );
104  Destroy( item );
105  // ..and separator
106  item = FindItemByPosition( 0 );
107  wxASSERT( item->IsSeparator() );
108  Destroy( item );
109  m_titleDisplayed = false;
110  }
111 
112  else if( aDisplay && !m_title.IsEmpty() )
113  {
114  if( m_titleDisplayed )
115  {
116  // Simply update the title
117  FindItemByPosition( 0 )->SetItemLabel( m_title );
118  }
119  else
120  {
121  // Add a separator and a menu entry to display the title
122  InsertSeparator( 0 );
123  Insert( 0, new wxMenuItem( this, wxID_NONE, m_title, wxEmptyString, wxITEM_NORMAL ) );
124 
125  if( m_icon )
126  set_wxMenuIcon( FindItemByPosition( 0 ), m_icon );
127 
128  m_titleDisplayed = true;
129  }
130  }
131 }
const BITMAP_OPAQUE * m_icon
Optional icon
Definition: context_menu.h:231
wxString m_title
Menu title
Definition: context_menu.h:213
static void set_wxMenuIcon(wxMenuItem *aMenu, const BITMAP_OPAQUE *aIcon)
bool m_titleDisplayed
Flag indicating that the menu title was set up.
Definition: context_menu.h:210
virtual OPT_TOOL_EVENT CONTEXT_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 TRACK_WIDTH_MENU, GRID_MENU, and ZOOM_MENU.

Definition at line 172 of file context_menu.h.

References appendCopy(), copyFrom(), findToolAction(), onMenuEvent(), runEventHandlers(), runOnSubmenus(), setupEvents(), and updateHotKeys().

Referenced by onMenuEvent(), and runEventHandlers().

173  {
174  return OPT_TOOL_EVENT();
175  }
OPT< TOOL_EVENT > OPT_TOOL_EVENT
Definition: tool_event.h:465
OPT_TOOL_EVENT CONTEXT_MENU::findToolAction ( int  aId)
private

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

Definition at line 412 of file context_menu.cpp.

References runOnSubmenus().

Referenced by eventHandler(), and onMenuEvent().

413 {
414  OPT_TOOL_EVENT evt;
415 
416  auto findFunc = [&]( CONTEXT_MENU* m ) {
417  if( evt )
418  return;
419 
420  const auto it = m->m_toolActions.find( aId );
421 
422  if( it != m->m_toolActions.end() )
423  evt = it->second->MakeEvent();
424  };
425 
426  findFunc( this );
427 
428  if( !evt )
429  runOnSubmenus( findFunc );
430 
431  return evt;
432 }
Class CONTEXT_MENU.
Definition: context_menu.h:44
void runOnSubmenus(std::function< void(CONTEXT_MENU *)> aFunction)
Runs a function on the menu and all its submenus.
OPT< TOOL_EVENT > OPT_TOOL_EVENT
Definition: tool_event.h:465
static int CONTEXT_MENU::getMenuId ( const TOOL_ACTION aAction)
inlinestaticprotected

Returns the corresponding wxMenuItem identifier for a TOOL_ACTION object.

Definition at line 155 of file context_menu.h.

References ACTION_ID, and TOOL_ACTION::GetId().

Referenced by Add(), and PAD_CONTEXT_MENU::update().

156  {
157  return aAction.GetId() + ACTION_ID;
158  }
static const int ACTION_ID
Menu items with ID higher than that are considered TOOL_ACTIONs
Definition: context_menu.h:222
int GetId() const
Function GetId() Returns the unique id of the TOOL_ACTION object.
Definition: tool_action.h:85
int CONTEXT_MENU::GetSelected ( ) const
inline

Function GetSelected() Returns 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 context menu.

Definition at line 124 of file context_menu.h.

References Clone(), create(), getToolManager(), m_selected, SetTool(), and UpdateAll().

125  {
126  return m_selected;
127  }
int m_selected
Stores the id number of selected item.
Definition: context_menu.h:216
TOOL_MANAGER * CONTEXT_MENU::getToolManager ( )
protected

Returns an instance of TOOL_MANAGER class.

Definition at line 279 of file context_menu.cpp.

References TOOL_BASE::GetManager(), and m_tool.

Referenced by GetSelected(), PAD_CONTEXT_MENU::update(), and updateHotKeys().

280 {
281  wxASSERT( m_tool );
282  return m_tool ? m_tool->GetManager() : nullptr;
283 }
TOOL_INTERACTIVE * m_tool
Creator of the menu
Definition: context_menu.h:219
TOOL_MANAGER * GetManager() const
Function GetManager() Returns the instance of TOOL_MANAGER that takes care of the tool...
Definition: tool_base.h:144
bool CONTEXT_MENU::HasEnabledItems ( ) const

Function HasEnabledItems();.

Returns true if the menu has any enabled items

Definition at line 215 of file context_menu.cpp.

216 {
217  bool hasEnabled = false;
218 
219  auto& items = GetMenuItems();
220 
221  for( auto item : items )
222  {
223  if( item->IsEnabled() && !item->IsSeparator() )
224  {
225  hasEnabled = true;
226  break;
227  }
228  }
229 
230  return hasEnabled;
231 }
void CONTEXT_MENU::onMenuEvent ( wxMenuEvent &  aEvent)
private

The default menu event handler.

Definition at line 320 of file context_menu.cpp.

References ACTION_ID, eventHandler(), findToolAction(), TOOL_BASE::GetManager(), m_selected, m_tool, TOOL_MANAGER::ProcessEvent(), runEventHandlers(), TA_CONTEXT_MENU_CHOICE, TA_CONTEXT_MENU_UPDATE, and TC_COMMAND.

Referenced by eventHandler(), and setupEvents().

321 {
322  OPT_TOOL_EVENT evt;
323 
324  wxEventType type = aEvent.GetEventType();
325 
326  // When the currently chosen item in the menu is changed, an update event is issued.
327  // For example, the selection tool can use this to dynamically highlight the current item
328  // from selection clarification popup.
329  if( type == wxEVT_MENU_HIGHLIGHT )
330  evt = TOOL_EVENT( TC_COMMAND, TA_CONTEXT_MENU_UPDATE, aEvent.GetId() );
331 
332  // One of menu entries was selected..
333  else if( type == wxEVT_COMMAND_MENU_SELECTED )
334  {
335  // Store the selected position, so it can be checked by the tools
336  m_selected = aEvent.GetId();
337 
338  CONTEXT_MENU* parent = dynamic_cast<CONTEXT_MENU*>( GetParent() );
339 
340  while( parent )
341  {
342  parent->m_selected = m_selected;
343  parent = dynamic_cast<CONTEXT_MENU*>( parent->GetParent() );
344  }
345 
346  // Check if there is a TOOL_ACTION for the given ID
347  if( m_selected >= ACTION_ID )
348  evt = findToolAction( m_selected );
349 
350  if( !evt )
351  {
352 #ifdef __WINDOWS__
353  if( !evt )
354  {
355  // Try to find the submenu which holds the selected item
356  wxMenu* menu = nullptr;
357  FindItem( m_selected, &menu );
358 
359  if( menu && menu != this )
360  {
361  CONTEXT_MENU* cxmenu = static_cast<CONTEXT_MENU*>( menu );
362  evt = cxmenu->eventHandler( aEvent );
363  }
364  }
365 #else
366  if( !evt )
367  runEventHandlers( aEvent, evt );
368 #endif
369 
370  // Handling non-action menu entries (e.g. items in clarification list)
371  if( !evt )
372  evt = TOOL_EVENT( TC_COMMAND, TA_CONTEXT_MENU_CHOICE, aEvent.GetId() );
373  }
374  }
375 
376  wxASSERT( m_tool ); // without tool & tool manager we cannot handle events
377 
378  // forward the action/update event to the TOOL_MANAGER
379  if( evt && m_tool )
380  {
381  //aEvent.StopPropagation();
382  m_tool->GetManager()->ProcessEvent( *evt );
383  }
384 }
TOOL_INTERACTIVE * m_tool
Creator of the menu
Definition: context_menu.h:219
void runEventHandlers(const wxMenuEvent &aMenuEvent, OPT_TOOL_EVENT &aToolEvent)
Traverses the submenus tree looking for a submenu capable of handling a particular menu event...
int m_selected
Stores the id number of selected item.
Definition: context_menu.h:216
OPT_TOOL_EVENT findToolAction(int aId)
Checks if any of submenus contains a TOOL_ACTION with a specific ID.
Class CONTEXT_MENU.
Definition: context_menu.h:44
virtual OPT_TOOL_EVENT eventHandler(const wxMenuEvent &)
Event handler stub.
Definition: context_menu.h:172
static const int ACTION_ID
Menu items with ID higher than that are considered TOOL_ACTIONs
Definition: context_menu.h:222
bool ProcessEvent(const TOOL_EVENT &aEvent)
Propagates an event to tools that requested events of matching type(s).
Class TOOL_EVENT.
Definition: tool_event.h:162
TOOL_MANAGER * GetManager() const
Function GetManager() Returns the instance of TOOL_MANAGER that takes care of the tool...
Definition: tool_base.h:144
OPT< TOOL_EVENT > OPT_TOOL_EVENT
Definition: tool_event.h:465
CONTEXT_MENU& CONTEXT_MENU::operator= ( const CONTEXT_MENU aMenu)
delete
void CONTEXT_MENU::runEventHandlers ( const wxMenuEvent &  aMenuEvent,
OPT_TOOL_EVENT aToolEvent 
)
private

Traverses 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 387 of file context_menu.cpp.

References eventHandler(), and runOnSubmenus().

Referenced by eventHandler(), and onMenuEvent().

388 {
389  aToolEvent = eventHandler( aMenuEvent );
390 
391  if( !aToolEvent )
392  runOnSubmenus( std::bind( &CONTEXT_MENU::runEventHandlers, _1, aMenuEvent, aToolEvent ) );
393 }
void runEventHandlers(const wxMenuEvent &aMenuEvent, OPT_TOOL_EVENT &aToolEvent)
Traverses the submenus tree looking for a submenu capable of handling a particular menu event...
virtual OPT_TOOL_EVENT eventHandler(const wxMenuEvent &)
Event handler stub.
Definition: context_menu.h:172
void runOnSubmenus(std::function< void(CONTEXT_MENU *)> aFunction)
Runs a function on the menu and all its submenus.
void CONTEXT_MENU::runOnSubmenus ( std::function< void(CONTEXT_MENU *)>  aFunction)
private

Runs a function on the menu and all its submenus.

Definition at line 396 of file context_menu.cpp.

References Format(), and m_submenus.

Referenced by eventHandler(), findToolAction(), runEventHandlers(), SetTool(), and UpdateAll().

397 {
398  try
399  {
400  std::for_each( m_submenus.begin(), m_submenus.end(), [&]( CONTEXT_MENU* m ) {
401  aFunction( m );
402  m->runOnSubmenus( aFunction );
403  } );
404  }
405  catch( std::exception& e )
406  {
407  wxLogDebug( wxString::Format( "CONTEXT_MENU runOnSubmenus exception: %s", e.what() ) );
408  }
409 }
Class CONTEXT_MENU.
Definition: context_menu.h:44
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
std::list< CONTEXT_MENU * > m_submenus
List of submenus.
Definition: context_menu.h:228
void CONTEXT_MENU::SetIcon ( const BITMAP_OPAQUE aIcon)

Function SetIcon() Assigns an icon for the entry.

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

Definition at line 73 of file context_menu.cpp.

References m_icon.

Referenced by SELECTION_TOOL::disambiguationMenu(), GRID_MENU::GRID_MENU(), ALIGN_DISTRIBUTE_TOOL::Init(), PAD_CONTEXT_MENU::PAD_CONTEXT_MENU(), TRACK_VIA_SIZE_MENU::TRACK_VIA_SIZE_MENU(), and ZOOM_MENU::ZOOM_MENU().

74 {
75  m_icon = aIcon;
76 }
const BITMAP_OPAQUE * m_icon
Optional icon
Definition: context_menu.h:231
void CONTEXT_MENU::SetTitle ( const wxString &  aTitle)
override

Function SetTitle() Sets title for the context menu.

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

Parameters
aTitleis the new title.

Definition at line 86 of file context_menu.cpp.

References DisplayTitle(), m_title, and m_titleDisplayed.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SELECTION_TOOL::disambiguationMenu(), GRID_MENU::GRID_MENU(), ALIGN_DISTRIBUTE_TOOL::Init(), PAD_CONTEXT_MENU::PAD_CONTEXT_MENU(), and ZOOM_MENU::ZOOM_MENU().

87 {
88  // Unfortunately wxMenu::SetTitle() does not work very well, so this is an alternative version
89  m_title = aTitle;
90 
91  // Update the menu title
92  if( m_titleDisplayed )
93  DisplayTitle( true );
94 }
void DisplayTitle(bool aDisplay=true)
Function DisplayTitle() Decides whether a title for a pop up menu should be displayed.
wxString m_title
Menu title
Definition: context_menu.h:213
bool m_titleDisplayed
Flag indicating that the menu title was set up.
Definition: context_menu.h:210
void CONTEXT_MENU::SetTool ( TOOL_INTERACTIVE aTool)

Function SetTool() Sets a tool that is the creator of the menu.

Parameters
aToolis the tool that created the menu.

Definition at line 252 of file context_menu.cpp.

References m_tool, and runOnSubmenus().

Referenced by CONDITIONAL_MENU::Generate(), GetSelected(), and TOOL_INTERACTIVE::SetContextMenu().

253 {
254  m_tool = aTool;
255  runOnSubmenus( std::bind( &CONTEXT_MENU::SetTool, _1, aTool ) );
256 }
TOOL_INTERACTIVE * m_tool
Creator of the menu
Definition: context_menu.h:219
void runOnSubmenus(std::function< void(CONTEXT_MENU *)> aFunction)
Runs a function on the menu and all its submenus.
void SetTool(TOOL_INTERACTIVE *aTool)
Function SetTool() Sets a tool that is the creator of the menu.
void CONTEXT_MENU::setupEvents ( )
private

Initializes handlers for events.

Definition at line 79 of file context_menu.cpp.

References onMenuEvent().

Referenced by CONTEXT_MENU(), and eventHandler().

80 {
81  Connect( wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler( CONTEXT_MENU::onMenuEvent ), NULL, this );
82  Connect( wxEVT_COMMAND_MENU_SELECTED, wxMenuEventHandler( CONTEXT_MENU::onMenuEvent ), NULL, this );
83 }
void onMenuEvent(wxMenuEvent &aEvent)
The default menu event handler.
virtual void CONTEXT_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 ZONE_CONTEXT_MENU, SELECT_MENU, PAD_CONTEXT_MENU, HIGHLIGHT_MENU, TRACK_VIA_SIZE_MENU, GRID_MENU, and ZOOM_MENU.

Definition at line 164 of file context_menu.h.

Referenced by UpdateAll().

165  {
166  }
void CONTEXT_MENU::UpdateAll ( )

Function UpdateAll() Runs update handlers for the menu and its submenus.

Definition at line 234 of file context_menu.cpp.

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

Referenced by GetSelected().

235 {
236  try
237  {
238  update();
239  }
240  catch( std::exception& e )
241  {
242  wxLogDebug( wxString::Format( "CONTEXT_MENU update handler exception: %s", e.what() ) );
243  }
244 
245  if( m_tool )
246  updateHotKeys();
247 
248  runOnSubmenus( std::bind( &CONTEXT_MENU::UpdateAll, _1 ) );
249 }
TOOL_INTERACTIVE * m_tool
Creator of the menu
Definition: context_menu.h:219
void updateHotKeys()
Updates hot key settings for TOOL_ACTIONs in this menu.
virtual void update()
Update menu state stub.
Definition: context_menu.h:164
void runOnSubmenus(std::function< void(CONTEXT_MENU *)> aFunction)
Runs a function on the menu and all its submenus.
void UpdateAll()
Function UpdateAll() Runs update handlers for the menu and its submenus.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
void CONTEXT_MENU::updateHotKeys ( )
private

Updates hot key settings for TOOL_ACTIONs in this menu.

Definition at line 286 of file context_menu.cpp.

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

Referenced by eventHandler(), and UpdateAll().

287 {
288  TOOL_MANAGER* toolMgr = getToolManager();
289 
290  for( std::map<int, const TOOL_ACTION*>::const_iterator it = m_toolActions.begin();
291  it != m_toolActions.end(); ++it )
292  {
293  int id = it->first;
294  const TOOL_ACTION& action = *it->second;
295  int key = toolMgr->GetHotKey( action ) & ~MD_MODIFIER_MASK;
296 
297  if( key )
298  {
299  int mod = toolMgr->GetHotKey( action ) & MD_MODIFIER_MASK;
300  int flags = 0;
301  wxMenuItem* item = FindChildItem( id );
302 
303  if( item )
304  {
305  flags |= ( mod & MD_ALT ) ? wxACCEL_ALT : 0;
306  flags |= ( mod & MD_CTRL ) ? wxACCEL_CTRL : 0;
307  flags |= ( mod & MD_SHIFT ) ? wxACCEL_SHIFT : 0;
308 
309  if( !flags )
310  flags = wxACCEL_NORMAL;
311 
312  wxAcceleratorEntry accel( flags, key, id, item );
313  item->SetAccel( &accel );
314  }
315  }
316  }
317 }
int GetHotKey(const TOOL_ACTION &aAction)
>
Class TOOL_MANAGER.
Definition: tool_manager.h:49
std::map< int, const TOOL_ACTION * > m_toolActions
Associates tool actions with menu item IDs. Non-owning.
Definition: context_menu.h:225
TOOL_MANAGER * getToolManager()
Returns an instance of TOOL_MANAGER class.
Class TOOL_ACTION.
Definition: tool_action.h:46
#define mod(a, n)
Definition: greymap.cpp:24

Friends And Related Function Documentation

friend class TOOL_INTERACTIVE
friend

Definition at line 233 of file context_menu.h.

Member Data Documentation

const int CONTEXT_MENU::ACTION_ID = 2000
staticprivate

Menu items with ID higher than that are considered TOOL_ACTIONs

Definition at line 222 of file context_menu.h.

Referenced by getMenuId(), and onMenuEvent().

const BITMAP_OPAQUE* CONTEXT_MENU::m_icon
private

Optional icon

Definition at line 231 of file context_menu.h.

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

int CONTEXT_MENU::m_selected
private

Stores the id number of selected item.

Definition at line 216 of file context_menu.h.

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

std::list<CONTEXT_MENU*> CONTEXT_MENU::m_submenus
private

List of submenus.

Definition at line 228 of file context_menu.h.

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

wxString CONTEXT_MENU::m_title
private

Menu title

Definition at line 213 of file context_menu.h.

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

bool CONTEXT_MENU::m_titleDisplayed
private

Flag indicating that the menu title was set up.

Definition at line 210 of file context_menu.h.

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

TOOL_INTERACTIVE* CONTEXT_MENU::m_tool
private

Creator of the menu

Definition at line 219 of file context_menu.h.

Referenced by copyFrom(), getToolManager(), onMenuEvent(), SetTool(), and UpdateAll().

std::map<int, const TOOL_ACTION*> CONTEXT_MENU::m_toolActions
private

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

Definition at line 225 of file context_menu.h.

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


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