KiCad PCB EDA Suite
CONTEXT_MENU Class Reference

Class CONTEXT_MENU. More...

#include <context_menu.h>

Inheritance diagram for CONTEXT_MENU:
GRID_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 35 of file context_menu.cpp.

References setupEvents().

Referenced by create().

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

Definition at line 42 of file context_menu.cpp.

References m_submenus.

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

References KiBitmap().

Referenced by 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().

108 {
109 #ifdef DEBUG
110  if( FindItem( aId ) != NULL )
111  wxLogWarning( wxT( "Adding more than one menu entry with the same ID may result in"
112  "undefined behaviour" ) );
113 #endif
114 
115  wxMenuItem* item = new wxMenuItem( this, aId, aLabel, wxEmptyString, wxITEM_NORMAL );
116 
117  if( aIcon )
118  item->SetBitmap( KiBitmap( aIcon ) );
119 
120  return Append( item );
121 }
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Function KiBitmap constructs a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:36
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 124 of file context_menu.cpp.

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

125 {
127  const BITMAP_OPAQUE* icon = aAction.GetIcon();
128 
129  wxMenuItem* item = new wxMenuItem( this, getMenuId( aAction ), aAction.GetMenuItem(),
130  aAction.GetDescription(), wxITEM_NORMAL );
131 
132  if( icon )
133  item->SetBitmap( KiBitmap( icon ) );
134 
135  m_toolActions[getMenuId( aAction )] = &aAction;
136 
137  wxMenuItem* i = Append( item );
138  return i;
139 }
PNG memory record (file in memory).
Definition: bitmap_types.h:38
const wxString & GetDescription() const
Definition: tool_action.h:124
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Function KiBitmap constructs a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:36
std::map< int, const TOOL_ACTION * > m_toolActions
Associates tool actions with menu item IDs. Non-owning.
Definition: context_menu.h:228
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:158
const BITMAP_OPAQUE * GetIcon() const
Returns an icon associated with the action.
Definition: tool_action.h:165
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 142 of file context_menu.cpp.

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

143 {
144  std::list<wxMenuItem*> items;
145  CONTEXT_MENU* menuCopy = aMenu->Clone();
146  m_submenus.push_back( menuCopy );
147 
148  if( aExpand )
149  {
150  for( int i = 0; i < (int) aMenu->GetMenuItemCount(); ++i )
151  {
152  wxMenuItem* item = aMenu->FindItemByPosition( i );
153  items.push_back( appendCopy( item ) );
154  }
155  }
156  else
157  {
158  wxASSERT_MSG( !menuCopy->m_title.IsEmpty(), "Set a title for CONTEXT_MENU using SetTitle()" );
159 
160  if( aMenu->m_icon )
161  {
162  wxMenuItem* newItem = new wxMenuItem( this, -1, menuCopy->m_title );
163  newItem->SetBitmap( KiBitmap( aMenu->m_icon ) );
164  newItem->SetSubMenu( menuCopy );
165  items.push_back( Append( newItem ) );
166  }
167  else
168  {
169  items.push_back( AppendSubMenu( menuCopy, menuCopy->m_title ) );
170  }
171  }
172 
173  return items;
174 }
Class CONTEXT_MENU.
Definition: context_menu.h:44
const BITMAP_OPAQUE * m_icon
Optional icon
Definition: context_menu.h:234
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Function KiBitmap constructs a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:36
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:231
wxMenuItem * appendCopy(const wxMenuItem *aSource)
Function appendCopy Appends a copy of wxMenuItem.
wxString m_title
Menu title
Definition: context_menu.h:216
wxMenuItem * CONTEXT_MENU::appendCopy ( const wxMenuItem *  aSource)
private

Function appendCopy Appends a copy of wxMenuItem.

Definition at line 421 of file context_menu.cpp.

References Clone(), and m_submenus.

Referenced by Add(), and copyFrom().

422 {
423  wxMenuItem* newItem = new wxMenuItem( this, aSource->GetId(), aSource->GetItemLabel(),
424  aSource->GetHelp(), aSource->GetKind() );
425 
426  if( aSource->GetKind() == wxITEM_NORMAL )
427  newItem->SetBitmap( aSource->GetBitmap() );
428 
429  if( aSource->IsSubMenu() )
430  {
431  CONTEXT_MENU* menu = dynamic_cast<CONTEXT_MENU*>( aSource->GetSubMenu() );
432  wxASSERT_MSG( menu, "Submenus are expected to be a CONTEXT_MENU" );
433 
434  if( menu )
435  {
436  CONTEXT_MENU* menuCopy = menu->Clone();
437  newItem->SetSubMenu( menuCopy );
438  m_submenus.push_back( menuCopy );
439  }
440  }
441 
442  // wxMenuItem has to be added before enabling/disabling or checking
443  Append( newItem );
444 
445  if( aSource->IsCheckable() )
446  newItem->Check( aSource->IsChecked() );
447 
448  newItem->Enable( aSource->IsEnabled() );
449 
450  return newItem;
451 }
Class CONTEXT_MENU.
Definition: context_menu.h:44
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:231
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 177 of file context_menu.cpp.

References m_submenus, m_titleDisplayed, and m_toolActions.

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

178 {
179  m_titleDisplayed = false;
180 
181  for( int i = GetMenuItemCount() - 1; i >= 0; --i )
182  Destroy( FindItemByPosition( i ) );
183 
184  m_toolActions.clear();
185  m_submenus.clear();
186 
187  wxASSERT( GetMenuItemCount() == 0 );
188 }
std::map< int, const TOOL_ACTION * > m_toolActions
Associates tool actions with menu item IDs. Non-owning.
Definition: context_menu.h:228
std::list< CONTEXT_MENU * > m_submenus
List of submenus.
Definition: context_menu.h:231
bool m_titleDisplayed
Flag indicating that the menu title was set up.
Definition: context_menu.h:213
CONTEXT_MENU * CONTEXT_MENU::Clone ( ) const

Creates a deep, recursive copy of this CONTEXT_MENU.

Definition at line 235 of file context_menu.cpp.

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

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

236 {
237  CONTEXT_MENU* clone = create();
238  clone->Clear();
239  clone->copyFrom( *this );
240  return clone;
241 }
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 403 of file context_menu.cpp.

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

Referenced by Clone().

404 {
405  m_icon = aMenu.m_icon;
406  m_title = aMenu.m_title;
408  m_selected = -1; // aMenu.m_selected;
409  m_tool = aMenu.m_tool;
411 
412  // Copy all menu entries
413  for( int i = 0; i < (int) aMenu.GetMenuItemCount(); ++i )
414  {
415  wxMenuItem* item = aMenu.FindItemByPosition( i );
416  appendCopy( item );
417  }
418 }
TOOL_INTERACTIVE * m_tool
Creator of the menu
Definition: context_menu.h:222
int m_selected
Stores the id number of selected item.
Definition: context_menu.h:219
const BITMAP_OPAQUE * m_icon
Optional icon
Definition: context_menu.h:234
std::map< int, const TOOL_ACTION * > m_toolActions
Associates tool actions with menu item IDs. Non-owning.
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:216
bool m_titleDisplayed
Flag indicating that the menu title was set up.
Definition: context_menu.h:213
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, TUNER_TOOL_MENU, PAD_CONTEXT_MENU, TRACK_VIA_SIZE_MENU, GRID_MENU, and ZOOM_MENU.

Definition at line 244 of file context_menu.cpp.

References CONTEXT_MENU(), and Format().

Referenced by Clone().

245 {
246  CONTEXT_MENU* menu = new CONTEXT_MENU();
247 
248  wxASSERT_MSG( typeid( *this ) == typeid( *menu ),
249  wxString::Format( "You need to override create() method for class %s", typeid(*this).name() ) );
250 
251  return menu;
252 }
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 74 of file context_menu.cpp.

References m_title, and m_titleDisplayed.

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

75 {
76  if( ( !aDisplay || m_title.IsEmpty() ) && m_titleDisplayed )
77  {
78  // Destroy the menu entry keeping the title..
79  wxMenuItem* item = FindItemByPosition( 0 );
80  wxASSERT( item->GetItemLabelText() == GetTitle() );
81  Destroy( item );
82  // ..and separator
83  item = FindItemByPosition( 0 );
84  wxASSERT( item->IsSeparator() );
85  Destroy( item );
86  m_titleDisplayed = false;
87  }
88 
89  else if( aDisplay && !m_title.IsEmpty() )
90  {
91  if( m_titleDisplayed )
92  {
93  // Simply update the title
94  FindItemByPosition( 0 )->SetItemLabel( m_title );
95  }
96  else
97  {
98  // Add a separator and a menu entry to display the title
99  InsertSeparator( 0 );
100  Insert( 0, new wxMenuItem( this, wxID_NONE, m_title, wxEmptyString, wxITEM_NORMAL ) );
101  m_titleDisplayed = true;
102  }
103  }
104 }
wxString m_title
Menu title
Definition: context_menu.h:216
bool m_titleDisplayed
Flag indicating that the menu title was set up.
Definition: context_menu.h:213
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 175 of file context_menu.h.

Referenced by onMenuEvent(), and runEventHandlers().

176  {
177  return OPT_TOOL_EVENT();
178  }
boost::optional< 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 380 of file context_menu.cpp.

References runOnSubmenus().

Referenced by onMenuEvent().

381 {
382  OPT_TOOL_EVENT evt;
383 
384  auto findFunc = [&]( CONTEXT_MENU* m ) {
385  if( evt )
386  return;
387 
388  const auto it = m->m_toolActions.find( aId );
389 
390  if( it != m->m_toolActions.end() )
391  evt = it->second->MakeEvent();
392  };
393 
394  findFunc( this );
395 
396  if( !evt )
397  runOnSubmenus( findFunc );
398 
399  return evt;
400 }
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.
static int CONTEXT_MENU::getMenuId ( const TOOL_ACTION aAction)
inlinestaticprotected

Returns the corresponding wxMenuItem identifier for a TOOL_ACTION object.

Definition at line 158 of file context_menu.h.

References ACTION_ID, and TOOL_ACTION::GetId().

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

159  {
160  return aAction.GetId() + ACTION_ID;
161  }
static const int ACTION_ID
Menu items with ID higher than that are considered TOOL_ACTIONs
Definition: context_menu.h:225
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 127 of file context_menu.h.

References m_selected.

128  {
129  return m_selected;
130  }
int m_selected
Stores the id number of selected item.
Definition: context_menu.h:219
TOOL_MANAGER * CONTEXT_MENU::getToolManager ( )
protected

Returns an instance of TOOL_MANAGER class.

Definition at line 255 of file context_menu.cpp.

References TOOL_BASE::GetManager(), and m_tool.

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

256 {
257  wxASSERT( m_tool );
258  return m_tool ? m_tool->GetManager() : nullptr;
259 }
TOOL_INTERACTIVE * m_tool
Creator of the menu
Definition: context_menu.h:222
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 191 of file context_menu.cpp.

192 {
193  bool hasEnabled = false;
194 
195  auto& items = GetMenuItems();
196 
197  for( auto item : items )
198  {
199  if( item->IsEnabled() && !item->IsSeparator() )
200  {
201  hasEnabled = true;
202  break;
203  }
204  }
205 
206  return hasEnabled;
207 }
void CONTEXT_MENU::onMenuEvent ( wxMenuEvent &  aEvent)
private

The default menu event handler.

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

297 {
298  OPT_TOOL_EVENT evt;
299 
300  wxEventType type = aEvent.GetEventType();
301 
302  // When the currently chosen item in the menu is changed, an update event is issued.
303  // For example, the selection tool can use this to dynamically highlight the current item
304  // from selection clarification popup.
305  if( type == wxEVT_MENU_HIGHLIGHT )
306  evt = TOOL_EVENT( TC_COMMAND, TA_CONTEXT_MENU_UPDATE, aEvent.GetId() );
307 
308  // One of menu entries was selected..
309  else if( type == wxEVT_COMMAND_MENU_SELECTED )
310  {
311  // Store the selected position, so it can be checked by the tools
312  m_selected = aEvent.GetId();
313 
314  // Check if there is a TOOL_ACTION for the given ID
315  if( m_selected >= ACTION_ID )
316  evt = findToolAction( m_selected );
317 
318  if( !evt )
319  {
320 #ifdef __WINDOWS__
321  if( !evt )
322  {
323  // Try to find the submenu which holds the selected item
324  wxMenu* menu = nullptr;
325  FindItem( m_selected, &menu );
326 
327  if( menu && menu != this )
328  {
329  CONTEXT_MENU* cxmenu = static_cast<CONTEXT_MENU*>( menu );
330  evt = cxmenu->eventHandler( aEvent );
331  }
332  }
333 #else
334  if( !evt )
335  runEventHandlers( aEvent, evt );
336 #endif
337 
338  // Handling non-action menu entries (e.g. items in clarification list)
339  if( !evt )
340  evt = TOOL_EVENT( TC_COMMAND, TA_CONTEXT_MENU_CHOICE, aEvent.GetId() );
341  }
342  }
343 
344  wxASSERT( m_tool ); // without tool & tool manager we cannot handle events
345 
346  // forward the action/update event to the TOOL_MANAGER
347  if( evt && m_tool )
348  {
349  //aEvent.StopPropagation();
350  m_tool->GetManager()->ProcessEvent( *evt );
351  }
352 }
TOOL_INTERACTIVE * m_tool
Creator of the menu
Definition: context_menu.h:222
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:219
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:175
static const int ACTION_ID
Menu items with ID higher than that are considered TOOL_ACTIONs
Definition: context_menu.h:225
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
void ProcessEvent(const TOOL_EVENT &aEvent)
Propagates an event to tools that requested events of matching type(s).
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 355 of file context_menu.cpp.

References eventHandler(), and runOnSubmenus().

Referenced by onMenuEvent().

356 {
357  aToolEvent = eventHandler( aMenuEvent );
358 
359  if( !aToolEvent )
360  runOnSubmenus( std::bind( &CONTEXT_MENU::runEventHandlers, _1, aMenuEvent, aToolEvent ) );
361 }
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:175
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 364 of file context_menu.cpp.

References Format(), and m_submenus.

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

365 {
366  try
367  {
368  std::for_each( m_submenus.begin(), m_submenus.end(), [&]( CONTEXT_MENU* m ) {
369  aFunction( m );
370  m->runOnSubmenus( aFunction );
371  } );
372  }
373  catch( std::exception& e )
374  {
375  wxLogDebug( wxString::Format( "CONTEXT_MENU runOnSubmenus exception: %s", e.what() ) );
376  }
377 }
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:231
void CONTEXT_MENU::SetIcon ( const BITMAP_OPAQUE aIcon)
inline

Function SetIcon() Assigns an icon for the entry.

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

Definition at line 74 of file context_menu.h.

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

75  {
76  m_icon = aIcon;
77  }
const BITMAP_OPAQUE * m_icon
Optional icon
Definition: context_menu.h:234
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 63 of file context_menu.cpp.

References DisplayTitle(), m_title, and m_titleDisplayed.

Referenced by 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().

64 {
65  // Unfortunately wxMenu::SetTitle() does not work very well, so this is an alternative version
66  m_title = aTitle;
67 
68  // Update the menu title
69  if( m_titleDisplayed )
70  DisplayTitle( true );
71 }
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:216
bool m_titleDisplayed
Flag indicating that the menu title was set up.
Definition: context_menu.h:213
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 228 of file context_menu.cpp.

References m_tool, and runOnSubmenus().

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

229 {
230  m_tool = aTool;
231  runOnSubmenus( std::bind( &CONTEXT_MENU::SetTool, _1, aTool ) );
232 }
TOOL_INTERACTIVE * m_tool
Creator of the menu
Definition: context_menu.h:222
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 56 of file context_menu.cpp.

References onMenuEvent().

Referenced by CONTEXT_MENU().

57 {
58  Connect( wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler( CONTEXT_MENU::onMenuEvent ), NULL, this );
59  Connect( wxEVT_COMMAND_MENU_SELECTED, wxMenuEventHandler( CONTEXT_MENU::onMenuEvent ), NULL, this );
60 }
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, GRID_MENU, and ZOOM_MENU.

Definition at line 167 of file context_menu.h.

Referenced by UpdateAll().

168  {
169  }
void CONTEXT_MENU::UpdateAll ( )

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

Definition at line 210 of file context_menu.cpp.

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

211 {
212  try
213  {
214  update();
215  }
216  catch( std::exception& e )
217  {
218  wxLogDebug( wxString::Format( "CONTEXT_MENU update handler exception: %s", e.what() ) );
219  }
220 
221  if( m_tool )
222  updateHotKeys();
223 
224  runOnSubmenus( std::bind( &CONTEXT_MENU::UpdateAll, _1 ) );
225 }
TOOL_INTERACTIVE * m_tool
Creator of the menu
Definition: context_menu.h:222
void updateHotKeys()
Updates hot key settings for TOOL_ACTIONs in this menu.
virtual void update()
Update menu state stub.
Definition: context_menu.h:167
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 262 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().

263 {
264  TOOL_MANAGER* toolMgr = getToolManager();
265 
266  for( std::map<int, const TOOL_ACTION*>::const_iterator it = m_toolActions.begin();
267  it != m_toolActions.end(); ++it )
268  {
269  int id = it->first;
270  const TOOL_ACTION& action = *it->second;
271  int key = toolMgr->GetHotKey( action ) & ~MD_MODIFIER_MASK;
272 
273  if( key )
274  {
275  int mod = toolMgr->GetHotKey( action ) & MD_MODIFIER_MASK;
276  int flags = 0;
277  wxMenuItem* item = FindChildItem( id );
278 
279  if( item )
280  {
281  flags |= ( mod & MD_ALT ) ? wxACCEL_ALT : 0;
282  flags |= ( mod & MD_CTRL ) ? wxACCEL_CTRL : 0;
283  flags |= ( mod & MD_SHIFT ) ? wxACCEL_SHIFT : 0;
284 
285  if( !flags )
286  flags = wxACCEL_NORMAL;
287 
288  wxAcceleratorEntry accel( flags, key, id, item );
289  item->SetAccel( &accel );
290  }
291  }
292  }
293 }
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:228
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 236 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 225 of file context_menu.h.

Referenced by getMenuId(), and onMenuEvent().

const BITMAP_OPAQUE* CONTEXT_MENU::m_icon
private

Optional icon

Definition at line 234 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 219 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 231 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 216 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 213 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 222 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 228 of file context_menu.h.

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


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