KiCad PCB EDA Suite
action_menu.cpp
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2013-2019 CERN
5  * Copyright (C) 2013-2020 KiCad Developers, see AUTHORS.txt for contributors.
6  * @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
7  * @author Maciej Suminski <maciej.suminski@cern.ch>
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, you may find one here:
21  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22  * or you may search the http://www.gnu.org website for the version 2 license,
23  * or you may write to the Free Software Foundation, Inc.,
24  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25  */
26 
27 #include <bitmaps.h>
28 #include <eda_base_frame.h>
29 #include <functional>
30 #include <id.h>
31 #include <kiface_i.h>
32 #include <menus_helpers.h>
33 #include <tool/action_menu.h>
34 #include <tool/actions.h>
35 #include <tool/tool_event.h>
36 #include <tool/tool_interactive.h>
37 #include <tool/tool_manager.h>
38 #include <trace_helpers.h>
39 #include <wx/log.h>
40 #include <wx/stc/stc.h>
41 #include <textentry_tricks.h>
42 #include <wx/listctrl.h>
43 
44 using namespace std::placeholders;
45 
46 
47 ACTION_MENU::ACTION_MENU( bool isContextMenu, TOOL_INTERACTIVE* aTool ) :
48  m_dirty( true ),
49  m_titleDisplayed( false ),
50  m_isContextMenu( isContextMenu ),
51  m_icon( BITMAPS::INVALID_BITMAP ),
52  m_selected( -1 ),
53  m_tool( aTool )
54 {
55  setupEvents();
56 }
57 
58 
60 {
61  // Set parent to NULL to prevent submenus from unregistering from a notexisting object
62  for( auto menu : m_submenus )
63  menu->SetParent( nullptr );
64 
65  ACTION_MENU* parent = dynamic_cast<ACTION_MENU*>( GetParent() );
66 
67  if( parent )
68  parent->m_submenus.remove( this );
69 }
70 
71 
73 {
74  m_icon = aIcon;
75 }
76 
77 
79 {
80 // See wxWidgets hack in TOOL_DISPATCHER::DispatchWxEvent().
81 // Connect( wxEVT_MENU_OPEN, wxMenuEventHandler( ACTION_MENU::OnMenuEvent ), NULL, this );
82 // Connect( wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler( ACTION_MENU::OnMenuEvent ), NULL, this );
83 // Connect( wxEVT_MENU_CLOSE, wxMenuEventHandler( ACTION_MENU::OnMenuEvent ), NULL, this );
84 
85  Connect( wxEVT_COMMAND_MENU_SELECTED, wxMenuEventHandler( ACTION_MENU::OnMenuEvent ), NULL, this );
86  Connect( wxEVT_IDLE, wxIdleEventHandler( ACTION_MENU::OnIdle ), NULL, this );
87 }
88 
89 
90 void ACTION_MENU::SetTitle( const wxString& aTitle )
91 {
92  // Unfortunately wxMenu::SetTitle() does not work very well, so this is an alternative version
93  m_title = aTitle;
94 
95  // Update the menu title
96  if( m_titleDisplayed )
97  DisplayTitle( true );
98 }
99 
100 
101 void ACTION_MENU::DisplayTitle( bool aDisplay )
102 {
103  if( ( !aDisplay || m_title.IsEmpty() ) && m_titleDisplayed )
104  {
105  // Destroy the menu entry keeping the title..
106  wxMenuItem* item = FindItemByPosition( 0 );
107  wxASSERT( item->GetItemLabelText() == GetTitle() );
108  Destroy( item );
109  // ..and separator
110  item = FindItemByPosition( 0 );
111  wxASSERT( item->IsSeparator() );
112  Destroy( item );
113  m_titleDisplayed = false;
114  }
115 
116  else if( aDisplay && !m_title.IsEmpty() )
117  {
118  if( m_titleDisplayed )
119  {
120  // Simply update the title
121  FindItemByPosition( 0 )->SetItemLabel( m_title );
122  }
123  else
124  {
125  // Add a separator and a menu entry to display the title
126  InsertSeparator( 0 );
127  Insert( 0, new wxMenuItem( this, wxID_NONE, m_title, wxEmptyString, wxITEM_NORMAL ) );
128 
129  if( !!m_icon )
130  AddBitmapToMenuItem( FindItemByPosition( 0 ), KiBitmap( m_icon ) );
131 
132  m_titleDisplayed = true;
133  }
134  }
135 }
136 
137 
138 wxMenuItem* ACTION_MENU::Add( const wxString& aLabel, int aId, BITMAPS aIcon )
139 {
140  wxASSERT_MSG( FindItem( aId ) == nullptr, "Duplicate menu IDs!" );
141 
142  wxMenuItem* item = new wxMenuItem( this, aId, aLabel, wxEmptyString, wxITEM_NORMAL );
143 
144  if( !!aIcon )
145  AddBitmapToMenuItem( item, KiBitmap( aIcon ) );
146 
147  return Append( item );
148 }
149 
150 
151 wxMenuItem* ACTION_MENU::Add( const wxString& aLabel, const wxString& aTooltip, int aId,
152  BITMAPS aIcon, bool aIsCheckmarkEntry )
153 {
154  wxASSERT_MSG( FindItem( aId ) == nullptr, "Duplicate menu IDs!" );
155 
156  wxMenuItem* item = new wxMenuItem( this, aId, aLabel, aTooltip,
157  aIsCheckmarkEntry ? wxITEM_CHECK : wxITEM_NORMAL );
158 
159  if( !!aIcon )
160  AddBitmapToMenuItem( item, KiBitmap( aIcon ) );
161 
162  return Append( item );
163 }
164 
165 
166 wxMenuItem* ACTION_MENU::Add( const TOOL_ACTION& aAction, bool aIsCheckmarkEntry,
167  const wxString& aOverrideLabel )
168 {
170  BITMAPS icon = aAction.GetIcon();
171 
172  // Allow the label to be overridden at point of use
173  wxString menuLabel = aOverrideLabel.IsEmpty() ? aAction.GetMenuItem() : aOverrideLabel;
174 
175  wxMenuItem* item = new wxMenuItem( this, aAction.GetUIId(), menuLabel,
176  aAction.GetDescription(),
177  aIsCheckmarkEntry ? wxITEM_CHECK : wxITEM_NORMAL );
178  if( !!icon )
179  AddBitmapToMenuItem( item, KiBitmap( icon ) );
180 
181  m_toolActions[aAction.GetUIId()] = &aAction;
182 
183  return Append( item );
184 }
185 
186 
187 wxMenuItem* ACTION_MENU::Add( ACTION_MENU* aMenu )
188 {
189  ACTION_MENU* menuCopy = aMenu->Clone();
190  m_submenus.push_back( menuCopy );
191 
192  wxASSERT_MSG( !menuCopy->m_title.IsEmpty(), "Set a title for ACTION_MENU using SetTitle()" );
193 
194  if( !!aMenu->m_icon )
195  {
196  wxMenuItem* newItem = new wxMenuItem( this, -1, menuCopy->m_title );
197  AddBitmapToMenuItem( newItem, KiBitmap( aMenu->m_icon ) );
198  newItem->SetSubMenu( menuCopy );
199  return Append( newItem );
200  }
201  else
202  {
203  return AppendSubMenu( menuCopy, menuCopy->m_title );
204  }
205 }
206 
207 
208 void ACTION_MENU::AddClose( wxString aAppname )
209 {
210  Add( _( "Close" ) + "\tCtrl+W",
211  wxString::Format( _( "Close %s" ), aAppname ),
212  wxID_CLOSE,
213  BITMAPS::exit );
214 }
215 
216 
217 void ACTION_MENU::AddQuitOrClose( KIFACE_I* aKiface, wxString aAppname )
218 {
219  if( !aKiface || aKiface->IsSingle() ) // not when under a project mgr
220  {
221  // Don't use ACTIONS::quit; wxWidgets moves this on OSX and expects to find it via
222  // wxID_EXIT
223  Add( _( "Quit" ),
224  wxString::Format( _( "Quit %s" ), aAppname ),
225  wxID_EXIT,
226  BITMAPS::exit );
227  }
228  else
229  {
230  AddClose( aAppname );
231  }
232 }
233 
234 
236 {
237  m_titleDisplayed = false;
238 
239  for( int i = GetMenuItemCount() - 1; i >= 0; --i )
240  Destroy( FindItemByPosition( i ) );
241 
242  m_toolActions.clear();
243  m_submenus.clear();
244 
245  wxASSERT( GetMenuItemCount() == 0 );
246 }
247 
248 
250 {
251  bool hasEnabled = false;
252 
253  auto& items = GetMenuItems();
254 
255  for( auto item : items )
256  {
257  if( item->IsEnabled() && !item->IsSeparator() )
258  {
259  hasEnabled = true;
260  break;
261  }
262  }
263 
264  return hasEnabled;
265 }
266 
267 
269 {
270  try
271  {
272  update();
273  }
274  catch( std::exception& )
275  {
276  }
277 
278  if( m_tool )
279  updateHotKeys();
280 
281  runOnSubmenus( std::bind( &ACTION_MENU::UpdateAll, _1 ) );
282 }
283 
284 
286 {
287  m_dirty = false;
288  runOnSubmenus( std::bind( &ACTION_MENU::ClearDirty, _1 ) );
289 }
290 
291 
293 {
294  m_dirty = true;
295  runOnSubmenus( std::bind( &ACTION_MENU::SetDirty, _1 ) );
296 }
297 
298 
300 {
301  m_tool = aTool;
302  runOnSubmenus( std::bind( &ACTION_MENU::SetTool, _1, aTool ) );
303 }
304 
305 
307 {
308  ACTION_MENU* clone = create();
309  clone->Clear();
310  clone->copyFrom( *this );
311  return clone;
312 }
313 
314 
316 {
317  ACTION_MENU* menu = new ACTION_MENU( false );
318 
319  wxASSERT_MSG( typeid( *this ) == typeid( *menu ),
320  wxString::Format( "You need to override create() method for class %s", typeid(*this).name() ) );
321 
322  return menu;
323 }
324 
325 
327 {
328  wxASSERT( m_tool );
329  return m_tool ? m_tool->GetManager() : nullptr;
330 }
331 
332 
334 {
335  TOOL_MANAGER* toolMgr = getToolManager();
336 
337  for( auto& ii : m_toolActions )
338  {
339  int id = ii.first;
340  const TOOL_ACTION& action = *ii.second;
341  int key = toolMgr->GetHotKey( action ) & ~MD_MODIFIER_MASK;
342 
343  if( key )
344  {
345  int mod = toolMgr->GetHotKey( action ) & MD_MODIFIER_MASK;
346  int flags = 0;
347  wxMenuItem* item = FindChildItem( id );
348 
349  if( item )
350  {
351  flags |= ( mod & MD_ALT ) ? wxACCEL_ALT : 0;
352  flags |= ( mod & MD_CTRL ) ? wxACCEL_CTRL : 0;
353  flags |= ( mod & MD_SHIFT ) ? wxACCEL_SHIFT : 0;
354 
355  if( !flags )
356  flags = wxACCEL_NORMAL;
357 
358  wxAcceleratorEntry accel( flags, key, id, item );
359  item->SetAccel( &accel );
360  }
361  }
362  }
363 }
364 
365 
366 // wxWidgets doesn't tell us when a menu command was generated from a hotkey or from
367 // a menu selection. It's important to us because a hotkey can be an immediate action
368 // while the menu selection can not (as it has no associated position).
369 //
370 // We get around this by storing the last highlighted menuId. If it matches the command
371 // id then we know this is a menu selection. (You might think we could use the menuOpen
372 // menuClose events, but these are actually generated for hotkeys as well.)
373 
375 
376 // We need to store the position of the mouse when the menu was opened so it can be passed
377 // to the command event generated when the menu item is selected.
379 
380 
381 void ACTION_MENU::OnIdle( wxIdleEvent& event )
382 {
384  g_menu_open_position.x = 0.0;
385  g_menu_open_position.y = 0.0;
386 }
387 
388 
389 void ACTION_MENU::OnMenuEvent( wxMenuEvent& aEvent )
390 {
391  OPT_TOOL_EVENT evt;
392  wxString menuText;
393  wxEventType type = aEvent.GetEventType();
394  wxWindow* focus = wxWindow::FindFocus();
395 
396  if( type == wxEVT_MENU_OPEN )
397  {
398  if( m_dirty && m_tool )
399  getToolManager()->RunAction( ACTIONS::updateMenu, true, this );
400 
401  wxMenu* parent = dynamic_cast<wxMenu*>( GetParent() );
402 
403  // Don't update the position if this menu has a parent
404  if( !parent && m_tool )
406 
408  }
409  else if( type == wxEVT_MENU_HIGHLIGHT )
410  {
411  if( aEvent.GetId() > 0 )
412  g_last_menu_highlighted_id = aEvent.GetId();
413 
414  evt = TOOL_EVENT( TC_COMMAND, TA_CHOICE_MENU_UPDATE, aEvent.GetId() );
415  }
416  else if( type == wxEVT_COMMAND_MENU_SELECTED )
417  {
418  // Despite our attempts to catch the theft of text editor CHAR_HOOK and CHAR events
419  // in TOOL_DISPATCHER::DispatchWxEvent, wxWidgets sometimes converts those it knows
420  // about into menu commands without ever generating the appropriate CHAR_HOOK and CHAR
421  // events first.
422  if( dynamic_cast<wxTextEntry*>( focus )
423  || dynamic_cast<wxStyledTextCtrl*>( focus )
424  || dynamic_cast<wxListView*>( focus ) )
425  {
426  // Original key event has been lost, so we have to re-create it from the menu's
427  // wxAcceleratorEntry.
428  wxMenuItem* menuItem = FindItem( aEvent.GetId() );
429  wxAcceleratorEntry* acceleratorKey = menuItem ? menuItem->GetAccel() : nullptr;
430 
431  if( acceleratorKey )
432  {
433  wxKeyEvent keyEvent( wxEVT_CHAR_HOOK );
434  keyEvent.m_keyCode = acceleratorKey->GetKeyCode();
435  keyEvent.m_controlDown = ( acceleratorKey->GetFlags() & wxMOD_CONTROL ) > 0;
436  keyEvent.m_shiftDown = ( acceleratorKey->GetFlags() & wxMOD_SHIFT ) > 0;
437  keyEvent.m_altDown = ( acceleratorKey->GetFlags() & wxMOD_ALT ) > 0;
438 
439  if( auto ctrl = dynamic_cast<wxTextEntry*>( focus ) )
440  TEXTENTRY_TRICKS::OnCharHook( ctrl, keyEvent );
441  else
442  focus->HandleWindowEvent( keyEvent );
443 
444  if( keyEvent.GetSkipped() )
445  {
446  keyEvent.SetEventType( wxEVT_CHAR );
447  focus->HandleWindowEvent( keyEvent );
448  }
449 
450  // If the event was used as KEY event (not skipped) by the focused window,
451  // just finish.
452  // Otherwise this is actually a wxEVT_COMMAND_MENU_SELECTED, or the
453  // focused window is read only
454  if( !keyEvent.GetSkipped() )
455  return;
456  }
457  }
458 
459  // Store the selected position, so it can be checked by the tools
460  m_selected = aEvent.GetId();
461 
462  ACTION_MENU* parent = dynamic_cast<ACTION_MENU*>( GetParent() );
463 
464  while( parent )
465  {
466  parent->m_selected = m_selected;
467  parent = dynamic_cast<ACTION_MENU*>( parent->GetParent() );
468  }
469 
470  // Check if there is a TOOL_ACTION for the given ID
472  evt = findToolAction( m_selected );
473 
474  if( !evt )
475  {
476 #ifdef __WINDOWS__
477  if( !evt )
478  {
479  // Try to find the submenu which holds the selected item
480  wxMenu* menu = nullptr;
481  FindItem( m_selected, &menu );
482 
483  // This conditional compilation is probably not needed.
484  // It will be removed later, for the Kicad V 6.x version.
485  // But in "old" 3.0 version, the "&& menu != this" contition was added to avoid hang
486  // This hang is no longer encountered in wxWidgets 3.0.4 version, and this condition is no longer needed.
487  // And in 3.1.2, we have to remove it, as "menu != this" never happens
488  // ("menu != this" always happens in 3.1.1 and older!).
489  #if wxCHECK_VERSION(3, 1, 2)
490  if( menu )
491  #else
492  if( menu && menu != this )
493  #endif
494  {
495  ACTION_MENU* cxmenu = static_cast<ACTION_MENU*>( menu );
496  evt = cxmenu->eventHandler( aEvent );
497  }
498  }
499 #else
500  if( !evt )
501  runEventHandlers( aEvent, evt );
502 #endif
503 
504  // Handling non-ACTION menu entries. Two ranges of ids are supported:
505  // between 0 and ID_CONTEXT_MENU_ID_MAX
506  // between ID_POPUP_MENU_START and ID_POPUP_MENU_END
507 
508  #define ID_CONTEXT_MENU_ID_MAX wxID_LOWEST /* = 100 should be plenty */
509 
510  if( !evt &&
511  ( ( m_selected >= 0 && m_selected < ID_CONTEXT_MENU_ID_MAX ) ||
513  {
514  ACTION_MENU* actionMenu = dynamic_cast<ACTION_MENU*>( GetParent() );
515 
516  if( actionMenu && actionMenu->PassHelpTextToHandler() )
517  menuText = GetHelpString( aEvent.GetId() );
518  else
519  menuText = GetLabelText( aEvent.GetId() );
520 
522  &menuText );
523  }
524  }
525  }
526 
527  // forward the action/update event to the TOOL_MANAGER
528  // clients that don't supply a tool will have to check GetSelected() themselves
529  if( evt && m_tool )
530  {
531  wxLogTrace( kicadTraceToolStack, "ACTION_MENU::OnMenuEvent %s", evt->Format() );
532 
533  // WARNING: if you're squeamish, look away.
534  // What follows is a series of egregious hacks necessitated by a lack of information from
535  // wxWidgets on where context-menu-commands and command-key-events originated.
536 
537  // If it's a context menu then fetch the mouse position from our context-menu-position
538  // hack.
539  if( m_isContextMenu )
540  {
541  evt->SetMousePosition( g_menu_open_position );
542  }
543  // Otherwise, if g_last_menu_highlighted_id matches then it's a menubar menu event and has
544  // no position.
545  else if( g_last_menu_highlighted_id == aEvent.GetId() )
546  {
547  evt->SetHasPosition( false );
548  }
549  // Otherwise it's a command-key-event and we need to get the mouse position from the tool
550  // manager so that immediate actions work.
551  else
552  {
553  evt->SetMousePosition( getToolManager()->GetMousePosition() );
554  }
555 
556  if( m_tool->GetManager() )
557  m_tool->GetManager()->ProcessEvent( *evt );
558  }
559  else
560  {
561  aEvent.Skip();
562  }
563 }
564 
565 
566 void ACTION_MENU::runEventHandlers( const wxMenuEvent& aMenuEvent, OPT_TOOL_EVENT& aToolEvent )
567 {
568  aToolEvent = eventHandler( aMenuEvent );
569 
570  if( !aToolEvent )
571  runOnSubmenus( std::bind( &ACTION_MENU::runEventHandlers, _1, aMenuEvent, aToolEvent ) );
572 }
573 
574 
575 void ACTION_MENU::runOnSubmenus( std::function<void(ACTION_MENU*)> aFunction )
576 {
577  try
578  {
579  std::for_each( m_submenus.begin(), m_submenus.end(), [&]( ACTION_MENU* m ) {
580  aFunction( m );
581  m->runOnSubmenus( aFunction );
582  } );
583  }
584  catch( std::exception& )
585  {
586  }
587 }
588 
589 
591 {
592  OPT_TOOL_EVENT evt;
593 
594  auto findFunc = [&]( ACTION_MENU* m ) {
595  if( evt )
596  return;
597 
598  const auto it = m->m_toolActions.find( aId );
599 
600  if( it != m->m_toolActions.end() )
601  evt = it->second->MakeEvent();
602  };
603 
604  findFunc( this );
605 
606  if( !evt )
607  runOnSubmenus( findFunc );
608 
609  return evt;
610 }
611 
612 
613 void ACTION_MENU::copyFrom( const ACTION_MENU& aMenu )
614 {
615  m_icon = aMenu.m_icon;
616  m_title = aMenu.m_title;
618  m_selected = -1; // aMenu.m_selected;
619  m_tool = aMenu.m_tool;
621 
622  // Copy all menu entries
623  for( int i = 0; i < (int) aMenu.GetMenuItemCount(); ++i )
624  {
625  wxMenuItem* item = aMenu.FindItemByPosition( i );
626  appendCopy( item );
627  }
628 }
629 
630 
631 wxMenuItem* ACTION_MENU::appendCopy( const wxMenuItem* aSource )
632 {
633  wxMenuItem* newItem = new wxMenuItem( this, aSource->GetId(), aSource->GetItemLabel(),
634  aSource->GetHelp(), aSource->GetKind() );
635 
636  // Add the source bitmap if it is not the wxNullBitmap
637  // On Windows, for Checkable Menu items, adding a bitmap adds also
638  // our predefined checked alternate bitmap
639  // On other OS, wxITEM_CHECK and wxITEM_RADIO Menu items do not use custom bitmaps.
640 #if defined(_WIN32)
641  // On Windows, AddBitmapToMenuItem() uses the unchecked bitmap for wxITEM_CHECK and wxITEM_RADIO menuitems
642  // and autoamtically adds a checked bitmap.
643  // For other menuitrms, use the "checked" bitmap.
644  bool use_checked_bm = ( aSource->GetKind() == wxITEM_CHECK || aSource->GetKind() == wxITEM_RADIO ) ? false : true;
645  const wxBitmap& src_bitmap = aSource->GetBitmap( use_checked_bm );
646 #else
647  const wxBitmap& src_bitmap = aSource->GetBitmap();
648 #endif
649 
650  if( src_bitmap.IsOk() && src_bitmap.GetHeight() > 1 ) // a null bitmap has a 0 size
651  AddBitmapToMenuItem( newItem, src_bitmap );
652 
653  if( aSource->IsSubMenu() )
654  {
655  ACTION_MENU* menu = dynamic_cast<ACTION_MENU*>( aSource->GetSubMenu() );
656  wxASSERT_MSG( menu, "Submenus are expected to be a ACTION_MENU" );
657 
658  if( menu )
659  {
660  ACTION_MENU* menuCopy = menu->Clone();
661  newItem->SetSubMenu( menuCopy );
662  m_submenus.push_back( menuCopy );
663  }
664  }
665 
666  // wxMenuItem has to be added before enabling/disabling or checking
667  Append( newItem );
668 
669  if( aSource->IsCheckable() )
670  newItem->Check( aSource->IsChecked() );
671 
672  newItem->Enable( aSource->IsEnabled() );
673 
674  return newItem;
675 }
A KIFACE (I)mplementation.
Definition: kiface_i.h:37
virtual void update()
Update menu state stub.
Definition: action_menu.h:197
bool m_titleDisplayed
Definition: action_menu.h:246
OPT_TOOL_EVENT findToolAction(int aId)
static int g_last_menu_highlighted_id
int GetUIId() const
Definition: tool_action.h:112
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:47
void SetIcon(BITMAPS aIcon)
Assign an icon for the entry.
Definition: action_menu.cpp:72
VECTOR2D GetMousePosition() const
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:141
void runEventHandlers(const wxMenuEvent &aMenuEvent, OPT_TOOL_EVENT &aToolEvent)
Run a function on the menu and all its submenus.
void ClearDirty()
Clear the dirty flag on the menu and all descendants.
void UpdateAll()
Run update handlers for the menu and its submenus.
BITMAPS m_icon
Stores the id number of selected item.
Definition: action_menu.h:253
virtual ACTION_MENU * create() const
< Return an instance of this class. It has to be overridden in inheriting classes.
static int GetBaseUIId()
Definition: tool_action.h:117
void SetTool(TOOL_INTERACTIVE *aTool)
Set a tool that is the creator of the menu.
TOOL_MANAGER * GetManager() const
Return the instance of TOOL_MANAGER that takes care of the tool.
Definition: tool_base.h:144
virtual OPT_TOOL_EVENT eventHandler(const wxMenuEvent &)
Event handler stub.
Definition: action_menu.h:207
virtual bool PassHelpTextToHandler()
Definition: action_menu.h:179
Master controller class:
Definition: tool_manager.h:52
#define ID_CONTEXT_MENU_ID_MAX
void copyFrom(const ACTION_MENU &aMenu)
Copy another menus data to this instance.
void AddBitmapToMenuItem(wxMenuItem *aMenu, const wxBitmap &aImage)
Add a bitmap to a menuitem.
Definition: bitmap.cpp:231
#define NULL
bool IsSingle() const
Is this KIFACE_I running under single_top?
Definition: kiface_i.h:104
bool m_isContextMenu
Menu title.
Definition: action_menu.h:247
bool ProcessEvent(const TOOL_EVENT &aEvent)
Propagate an event to tools that requested events of matching type(s).
wxString m_title
Optional icon.
Definition: action_menu.h:250
std::list< ACTION_MENU * > m_submenus
Definition: action_menu.h:265
Generic, UI-independent tool event.
Definition: tool_event.h:173
static VECTOR2D g_menu_open_position
Base window classes and related definitions.
int m_selected
Creator of the menu.
Definition: action_menu.h:256
const BITMAPS GetIcon() const
Return an icon associated with the action.
Definition: tool_action.h:169
wxLogTrace helper definitions.
ACTION_MENU * Clone() const
Create a deep, recursive copy of this ACTION_MENU.
static TOOL_ACTION updateMenu
Definition: actions.h:170
Global action (toolbar/main menu event, global shortcut)
Definition: tool_event.h:151
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:104
TOOL_INTERACTIVE * m_tool
Associates tool actions with menu item IDs. Non-owning.
Definition: action_menu.h:259
wxString GetDescription(bool aIncludeHotkey=true) const
Definition: tool_action.cpp:84
wxMenuItem * appendCopy(const wxMenuItem *aSource)
Append a copy of wxMenuItem.
void runOnSubmenus(std::function< void(ACTION_MENU *)> aFunction)
Check if any of submenus contains a TOOL_ACTION with a specific ID.
std::map< int, const TOOL_ACTION * > m_toolActions
List of submenus.
Definition: action_menu.h:262
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
void OnMenuEvent(wxMenuEvent &aEvent)
void SetTitle(const wxString &aTitle) override
Set title for the menu.
Definition: action_menu.cpp:90
BITMAPS
A list of all bitmap identifiers.
Definition: bitmaps_list.h:32
void AddQuitOrClose(KIFACE_I *aKiface, wxString aAppname="")
Add either a standard Quit or Close item to the menu.
ACTION_MENU(bool isContextMenu, TOOL_INTERACTIVE *aTool=nullptr)
< Default constructor
Definition: action_menu.cpp:47
#define _(s)
Definition: 3d_actions.cpp:33
static void OnCharHook(wxTextEntry *aTextEntry, wxKeyEvent &aEvent)
TOOL_MANAGER * getToolManager() const
Represent a single user action.
Definition: tool_action.h:49
void setupEvents()
Update hot key settings for TOOL_ACTIONs in this menu.
Definition: action_menu.cpp:78
wxMenuItem * Add(const wxString &aLabel, int aId, BITMAPS aIcon)
Add a wxWidgets-style entry to the menu.
void Clear()
Remove all the entries from the menu (as well as its title).
const wxChar *const kicadTraceToolStack
Flag to enable tracing of the tool handling stack.
bool HasEnabledItems() const
Returns true if the menu has any enabled items.
void OnIdle(wxIdleEvent &event)
void updateHotKeys()
Traverse the submenus tree looking for a submenu capable of handling a particular menu event.
wxString GetMenuItem() const
Definition: tool_action.cpp:76
~ACTION_MENU() override
Definition: action_menu.cpp:59
void SetDirty()
OPT< TOOL_EVENT > OPT_TOOL_EVENT
Definition: tool_event.h:574
int GetHotKey(const TOOL_ACTION &aAction) const
void AddClose(wxString aAppname="")
Add a standard close item to the menu with the accelerator key CTRL-W.
void DisplayTitle(bool aDisplay=true)
Decide whether a title for a pop up menu should be displayed.