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

References set_wxMenuIcon().

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

131 {
132 #ifdef DEBUG
133  if( FindItem( aId ) != NULL )
134  wxLogWarning( wxT( "Adding more than one menu entry with the same ID may result in"
135  "undefined behaviour" ) );
136 #endif
137 
138  wxMenuItem* item = new wxMenuItem( this, aId, aLabel, wxEmptyString, wxITEM_NORMAL );
139  set_wxMenuIcon( item, aIcon );
140 
141  return Append( item );
142 }
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 145 of file context_menu.cpp.

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

146 {
148  const BITMAP_OPAQUE* icon = aAction.GetIcon();
149 
150  wxMenuItem* item = new wxMenuItem( this, getMenuId( aAction ), aAction.GetMenuItem(),
151  aAction.GetDescription(), wxITEM_NORMAL );
152 
153  set_wxMenuIcon( item, icon );
154 
155  m_toolActions[getMenuId( aAction )] = &aAction;
156 
157  wxMenuItem* i = Append( item );
158  return i;
159 }
PNG memory record (file in memory).
Definition: bitmap_types.h:38
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
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 162 of file context_menu.cpp.

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

163 {
164  std::list<wxMenuItem*> items;
165  CONTEXT_MENU* menuCopy = aMenu->Clone();
166  m_submenus.push_back( menuCopy );
167 
168  if( aExpand )
169  {
170  for( int i = 0; i < (int) aMenu->GetMenuItemCount(); ++i )
171  {
172  wxMenuItem* item = aMenu->FindItemByPosition( i );
173  items.push_back( appendCopy( item ) );
174  }
175  }
176  else
177  {
178  wxASSERT_MSG( !menuCopy->m_title.IsEmpty(), "Set a title for CONTEXT_MENU using SetTitle()" );
179 
180  if( aMenu->m_icon )
181  {
182  wxMenuItem* newItem = new wxMenuItem( this, -1, menuCopy->m_title );
183  set_wxMenuIcon( newItem, aMenu->m_icon );
184  newItem->SetSubMenu( menuCopy );
185  items.push_back( Append( newItem ) );
186  }
187  else
188  {
189  items.push_back( AppendSubMenu( menuCopy, menuCopy->m_title ) );
190  }
191  }
192 
193  return items;
194 }
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.
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 441 of file context_menu.cpp.

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

Referenced by Add(), and copyFrom().

442 {
443  wxMenuItem* newItem = new wxMenuItem( this, aSource->GetId(), aSource->GetItemLabel(),
444  aSource->GetHelp(), aSource->GetKind() );
445 
446  bool useImagesInMenus = Pgm().GetUseIconsInMenus();
447 
448  if( aSource->GetKind() == wxITEM_NORMAL && useImagesInMenus )
449  newItem->SetBitmap( aSource->GetBitmap() );
450 
451  if( aSource->IsSubMenu() )
452  {
453  CONTEXT_MENU* menu = dynamic_cast<CONTEXT_MENU*>( aSource->GetSubMenu() );
454  wxASSERT_MSG( menu, "Submenus are expected to be a CONTEXT_MENU" );
455 
456  if( menu )
457  {
458  CONTEXT_MENU* menuCopy = menu->Clone();
459  newItem->SetSubMenu( menuCopy );
460  m_submenus.push_back( menuCopy );
461  }
462  }
463 
464  // wxMenuItem has to be added before enabling/disabling or checking
465  Append( newItem );
466 
467  if( aSource->IsCheckable() )
468  newItem->Check( aSource->IsChecked() );
469 
470  newItem->Enable( aSource->IsEnabled() );
471 
472  return newItem;
473 }
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 197 of file context_menu.cpp.

References m_submenus, m_titleDisplayed, and m_toolActions.

Referenced by Clone(), and TRACK_WIDTH_MENU::SetBoard().

198 {
199  m_titleDisplayed = false;
200 
201  for( int i = GetMenuItemCount() - 1; i >= 0; --i )
202  Destroy( FindItemByPosition( i ) );
203 
204  m_toolActions.clear();
205  m_submenus.clear();
206 
207  wxASSERT( GetMenuItemCount() == 0 );
208 }
std::map< int, const TOOL_ACTION * > m_toolActions
Associates tool actions with menu item IDs. Non-owning.
Definition: context_menu.h:225
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 255 of file context_menu.cpp.

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

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

256 {
257  CONTEXT_MENU* clone = create();
258  clone->Clear();
259  clone->copyFrom( *this );
260  return clone;
261 }
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 423 of file context_menu.cpp.

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

Referenced by Clone().

424 {
425  m_icon = aMenu.m_icon;
426  m_title = aMenu.m_title;
428  m_selected = -1; // aMenu.m_selected;
429  m_tool = aMenu.m_tool;
431 
432  // Copy all menu entries
433  for( int i = 0; i < (int) aMenu.GetMenuItemCount(); ++i )
434  {
435  wxMenuItem* item = aMenu.FindItemByPosition( i );
436  appendCopy( item );
437  }
438 }
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
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 264 of file context_menu.cpp.

References CONTEXT_MENU(), and Format().

Referenced by Clone().

265 {
266  CONTEXT_MENU* menu = new CONTEXT_MENU();
267 
268  wxASSERT_MSG( typeid( *this ) == typeid( *menu ),
269  wxString::Format( "You need to override create() method for class %s", typeid(*this).name() ) );
270 
271  return menu;
272 }
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_title, and m_titleDisplayed.

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

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  m_titleDisplayed = true;
125  }
126  }
127 }
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
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.

Referenced by onMenuEvent(), and runEventHandlers().

173  {
174  return OPT_TOOL_EVENT();
175  }
OPT< TOOL_EVENT > OPT_TOOL_EVENT
Definition: tool_event.h:460
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 400 of file context_menu.cpp.

References runOnSubmenus().

Referenced by onMenuEvent().

401 {
402  OPT_TOOL_EVENT evt;
403 
404  auto findFunc = [&]( CONTEXT_MENU* m ) {
405  if( evt )
406  return;
407 
408  const auto it = m->m_toolActions.find( aId );
409 
410  if( it != m->m_toolActions.end() )
411  evt = it->second->MakeEvent();
412  };
413 
414  findFunc( this );
415 
416  if( !evt )
417  runOnSubmenus( findFunc );
418 
419  return evt;
420 }
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:460
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 m_selected.

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

References TOOL_BASE::GetManager(), and m_tool.

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

276 {
277  wxASSERT( m_tool );
278  return m_tool ? m_tool->GetManager() : nullptr;
279 }
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 211 of file context_menu.cpp.

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

The default menu event handler.

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

317 {
318  OPT_TOOL_EVENT evt;
319 
320  wxEventType type = aEvent.GetEventType();
321 
322  // When the currently chosen item in the menu is changed, an update event is issued.
323  // For example, the selection tool can use this to dynamically highlight the current item
324  // from selection clarification popup.
325  if( type == wxEVT_MENU_HIGHLIGHT )
326  evt = TOOL_EVENT( TC_COMMAND, TA_CONTEXT_MENU_UPDATE, aEvent.GetId() );
327 
328  // One of menu entries was selected..
329  else if( type == wxEVT_COMMAND_MENU_SELECTED )
330  {
331  // Store the selected position, so it can be checked by the tools
332  m_selected = aEvent.GetId();
333 
334  // Check if there is a TOOL_ACTION for the given ID
335  if( m_selected >= ACTION_ID )
336  evt = findToolAction( m_selected );
337 
338  if( !evt )
339  {
340 #ifdef __WINDOWS__
341  if( !evt )
342  {
343  // Try to find the submenu which holds the selected item
344  wxMenu* menu = nullptr;
345  FindItem( m_selected, &menu );
346 
347  if( menu && menu != this )
348  {
349  CONTEXT_MENU* cxmenu = static_cast<CONTEXT_MENU*>( menu );
350  evt = cxmenu->eventHandler( aEvent );
351  }
352  }
353 #else
354  if( !evt )
355  runEventHandlers( aEvent, evt );
356 #endif
357 
358  // Handling non-action menu entries (e.g. items in clarification list)
359  if( !evt )
360  evt = TOOL_EVENT( TC_COMMAND, TA_CONTEXT_MENU_CHOICE, aEvent.GetId() );
361  }
362  }
363 
364  wxASSERT( m_tool ); // without tool & tool manager we cannot handle events
365 
366  // forward the action/update event to the TOOL_MANAGER
367  if( evt && m_tool )
368  {
369  //aEvent.StopPropagation();
370  m_tool->GetManager()->ProcessEvent( *evt );
371  }
372 }
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:460
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 375 of file context_menu.cpp.

References eventHandler(), and runOnSubmenus().

Referenced by onMenuEvent().

376 {
377  aToolEvent = eventHandler( aMenuEvent );
378 
379  if( !aToolEvent )
380  runOnSubmenus( std::bind( &CONTEXT_MENU::runEventHandlers, _1, aMenuEvent, aToolEvent ) );
381 }
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 384 of file context_menu.cpp.

References Format(), and m_submenus.

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

385 {
386  try
387  {
388  std::for_each( m_submenus.begin(), m_submenus.end(), [&]( CONTEXT_MENU* m ) {
389  aFunction( m );
390  m->runOnSubmenus( aFunction );
391  } );
392  }
393  catch( std::exception& e )
394  {
395  wxLogDebug( wxString::Format( "CONTEXT_MENU runOnSubmenus exception: %s", e.what() ) );
396  }
397 }
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 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(), ROUTER_TOOL_MENU::ROUTER_TOOL_MENU(), TRACK_WIDTH_MENU::TRACK_WIDTH_MENU(), TUNER_TOOL_MENU::TUNER_TOOL_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 248 of file context_menu.cpp.

References m_tool, and runOnSubmenus().

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

249 {
250  m_tool = aTool;
251  runOnSubmenus( std::bind( &CONTEXT_MENU::SetTool, _1, aTool ) );
252 }
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().

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, 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 230 of file context_menu.cpp.

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

231 {
232  try
233  {
234  update();
235  }
236  catch( std::exception& e )
237  {
238  wxLogDebug( wxString::Format( "CONTEXT_MENU update handler exception: %s", e.what() ) );
239  }
240 
241  if( m_tool )
242  updateHotKeys();
243 
244  runOnSubmenus( std::bind( &CONTEXT_MENU::UpdateAll, _1 ) );
245 }
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 282 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 UpdateAll().

283 {
284  TOOL_MANAGER* toolMgr = getToolManager();
285 
286  for( std::map<int, const TOOL_ACTION*>::const_iterator it = m_toolActions.begin();
287  it != m_toolActions.end(); ++it )
288  {
289  int id = it->first;
290  const TOOL_ACTION& action = *it->second;
291  int key = toolMgr->GetHotKey( action ) & ~MD_MODIFIER_MASK;
292 
293  if( key )
294  {
295  int mod = toolMgr->GetHotKey( action ) & MD_MODIFIER_MASK;
296  int flags = 0;
297  wxMenuItem* item = FindChildItem( id );
298 
299  if( item )
300  {
301  flags |= ( mod & MD_ALT ) ? wxACCEL_ALT : 0;
302  flags |= ( mod & MD_CTRL ) ? wxACCEL_CTRL : 0;
303  flags |= ( mod & MD_SHIFT ) ? wxACCEL_SHIFT : 0;
304 
305  if( !flags )
306  flags = wxACCEL_NORMAL;
307 
308  wxAcceleratorEntry accel( flags, key, id, item );
309  item->SetAccel( &accel );
310  }
311  }
312  }
313 }
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(), 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: