KiCad PCB EDA Suite
action_toolbar.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) 2019 CERN
5  * Copyright (C) 2019-2021 KiCad Developers, see CHANGELOG.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #include <algorithm>
26 #include <advanced_config.h>
27 #include <bitmaps.h>
28 #include <bitmap_store.h>
29 #include <eda_draw_frame.h>
30 #include <functional>
31 #include <kiplatform/ui.h>
32 #include <math/util.h>
33 #include <memory>
34 #include <pgm_base.h>
36 #include <tool/action_toolbar.h>
37 #include <tool/actions.h>
38 #include <tool/tool_action.h>
39 #include <tool/tool_event.h>
40 #include <tool/tool_interactive.h>
41 #include <tool/tool_manager.h>
42 #include <widgets/bitmap_button.h>
44 #include <wx/popupwin.h>
45 #include <wx/renderer.h>
46 #include <wx/sizer.h>
47 #include <wx/dcclient.h>
48 #include <wx/settings.h>
49 
50 
51 wxBitmap MakeDisabledBitmap( const wxBitmap& aSource )
52 {
53  return aSource.ConvertToDisabled( KIPLATFORM::UI::IsDarkTheme() ? 70 : 255 );
54 }
55 
56 
57 ACTION_GROUP::ACTION_GROUP( const std::string& aName,
58  const std::vector<const TOOL_ACTION*>& aActions )
59 {
60  wxASSERT_MSG( aActions.size() > 0, "Action groups must have at least one action" );
61 
62  // The default action is just the first action in the vector
63  m_actions = aActions;
65 
66  m_name = aName;
68 }
69 
70 
72 {
73  return m_id + TOOL_ACTION::GetBaseUIId();
74 }
75 
76 
78 {
79  bool valid = std::any_of( m_actions.begin(), m_actions.end(),
80  [&]( const TOOL_ACTION* aAction ) -> bool
81  {
82  // For some reason, we can't compare the actions directly
83  return aAction->GetId() == aDefault.GetId();
84  } );
85 
86  wxASSERT_MSG( valid, "Action must be present in a group to be the default" );
87 
88  m_defaultAction = &aDefault;
89 }
90 
91 
92 #define PALETTE_BORDER 4 // The border around the palette buttons on all sides
93 #define BUTTON_BORDER 1 // The border on the sides of the buttons that touch other buttons
94 
95 
96 ACTION_TOOLBAR_PALETTE::ACTION_TOOLBAR_PALETTE( wxWindow* aParent, bool aVertical ) :
97  wxPopupTransientWindow( aParent, wxBORDER_NONE ),
98  m_group( nullptr ),
99  m_isVertical( aVertical ),
100  m_panel( nullptr ),
101  m_mainSizer( nullptr ),
102  m_buttonSizer( nullptr )
103 {
104  m_panel = new wxPanel( this, wxID_ANY );
105  m_panel->SetBackgroundColour( wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOW ) );
106 
107  // This sizer holds the buttons for the actions
108  m_buttonSizer = new wxBoxSizer( aVertical ? wxVERTICAL : wxHORIZONTAL );
109 
110  // This sizer holds the other sizer, so that a consistent border is present on all sides
111  m_mainSizer = new wxBoxSizer( aVertical ? wxVERTICAL : wxHORIZONTAL );
112  m_mainSizer->Add( m_buttonSizer, wxSizerFlags().Border( wxALL, PALETTE_BORDER ) );
113 
114  m_panel->SetSizer( m_mainSizer );
115 
116  Connect( wxEVT_CHAR_HOOK, wxCharEventHandler( ACTION_TOOLBAR_PALETTE::onCharHook ),
117  nullptr, this );
118 }
119 
120 
122 {
123  wxBitmap normalBmp = KiScaledBitmap( aAction.GetIcon(), this );
124  wxBitmap disabledBmp = MakeDisabledBitmap( normalBmp );
125 
126  int padding = ( m_buttonSize.GetWidth() - normalBmp.GetWidth() ) / 2;
127 
128  BITMAP_BUTTON* button = new BITMAP_BUTTON( m_panel, aAction.GetUIId() );
129 
130  button->SetBitmap( normalBmp );
131  button->SetDisabledBitmap( disabledBmp );
132  button->SetPadding( padding );
133  button->SetToolTip( aAction.GetDescription() );
134  button->AcceptDragInAsClick();
135 
136  m_buttons[aAction.GetUIId()] = button;
137 
138  if( m_isVertical )
139  m_buttonSizer->Add( button, wxSizerFlags().Border( wxTOP | wxBOTTOM, BUTTON_BORDER ) );
140  else
141  m_buttonSizer->Add( button, wxSizerFlags().Border( wxLEFT | wxRIGHT, BUTTON_BORDER ) );
142 
143  m_buttonSizer->Layout();
144 }
145 
146 
147 void ACTION_TOOLBAR_PALETTE::EnableAction( const TOOL_ACTION& aAction, bool aEnable )
148 {
149  auto it = m_buttons.find( aAction.GetUIId() );
150 
151  if( it != m_buttons.end() )
152  it->second->Enable( aEnable );
153 }
154 
155 
156 void ACTION_TOOLBAR_PALETTE::CheckAction( const TOOL_ACTION& aAction, bool aCheck )
157 {
158  auto it = m_buttons.find( aAction.GetUIId() );
159 
160  if( it != m_buttons.end() )
161  it->second->Check( aCheck );
162 }
163 
164 
165 void ACTION_TOOLBAR_PALETTE::Popup( wxWindow* aFocus )
166 {
167  m_mainSizer->Fit( m_panel );
168  SetClientSize( m_panel->GetSize() );
169 
170  wxPopupTransientWindow::Popup( aFocus );
171 }
172 
173 
174 void ACTION_TOOLBAR_PALETTE::onCharHook( wxKeyEvent& aEvent )
175 {
176  // Allow the escape key to dismiss this popup
177  if( aEvent.GetKeyCode() == WXK_ESCAPE )
178  Dismiss();
179  else
180  aEvent.Skip();
181 }
182 
183 
184 ACTION_TOOLBAR::ACTION_TOOLBAR( EDA_BASE_FRAME* parent, wxWindowID id, const wxPoint& pos,
185  const wxSize& size, long style ) :
186  wxAuiToolBar( parent, id, pos, size, style ),
187  m_paletteTimer( nullptr ),
188  m_auiManager( nullptr ),
189  m_toolManager( parent->GetToolManager() ),
190  m_palette( nullptr )
191 {
192  m_paletteTimer = new wxTimer( this );
193 
194 #if !wxCHECK_VERSION( 3, 1, 0 )
195  // Custom art provider makes dark mode work on wx < 3.1
196  WX_AUI_TOOLBAR_ART* newArt = new WX_AUI_TOOLBAR_ART();
197  SetArtProvider( newArt );
198 #endif
199 
200  Connect( wxEVT_COMMAND_TOOL_CLICKED, wxAuiToolBarEventHandler( ACTION_TOOLBAR::onToolEvent ),
201  nullptr, this );
202  Connect( wxEVT_AUITOOLBAR_RIGHT_CLICK,
203  wxAuiToolBarEventHandler( ACTION_TOOLBAR::onToolRightClick ),
204  nullptr, this );
205  Connect( wxEVT_AUITOOLBAR_BEGIN_DRAG, wxAuiToolBarEventHandler( ACTION_TOOLBAR::onItemDrag ),
206  nullptr, this );
207  Connect( wxEVT_LEFT_DOWN, wxMouseEventHandler( ACTION_TOOLBAR::onMouseClick ), nullptr, this );
208  Connect( wxEVT_LEFT_UP, wxMouseEventHandler( ACTION_TOOLBAR::onMouseClick ), nullptr, this );
209  Connect( m_paletteTimer->GetId(), wxEVT_TIMER,
210  wxTimerEventHandler( ACTION_TOOLBAR::onTimerDone ), nullptr, this );
211 
212  Bind( wxEVT_SYS_COLOUR_CHANGED,
213  wxSysColourChangedEventHandler( ACTION_TOOLBAR::onThemeChanged ), this );
214 }
215 
216 
218 {
219  delete m_paletteTimer;
220 
221  // Clear all the maps keeping track of our items on the toolbar
222  m_toolMenus.clear();
223  m_actionGroups.clear();
224  m_toolCancellable.clear();
225  m_toolKinds.clear();
226  m_toolActions.clear();
227 }
228 
229 
230 void ACTION_TOOLBAR::Add( const TOOL_ACTION& aAction, bool aIsToggleEntry, bool aIsCancellable )
231 {
232  wxASSERT( GetParent() );
233  wxASSERT_MSG( !( aIsCancellable && !aIsToggleEntry ), "aIsCancellable requires aIsToggleEntry" );
234 
235  int toolId = aAction.GetUIId();
236  wxBitmap bmp = KiScaledBitmap( aAction.GetIcon(), GetParent() );
237 
238  AddTool( toolId, wxEmptyString, bmp, MakeDisabledBitmap( bmp ),
239  aIsToggleEntry ? wxITEM_CHECK : wxITEM_NORMAL,
240  aAction.GetDescription(), wxEmptyString, nullptr );
241 
242  m_toolKinds[ toolId ] = aIsToggleEntry;
243  m_toolActions[ toolId ] = &aAction;
244  m_toolCancellable[ toolId ] = aIsCancellable;
245 }
246 
247 
249 {
250  int toolId = aAction.GetUIId();
251  wxBitmap bmp = KiScaledBitmap( aAction.GetIcon(), GetParent() );
252 
253  AddTool( toolId, wxEmptyString, bmp, MakeDisabledBitmap( bmp ),
254  wxITEM_NORMAL, aAction.GetDescription(), wxEmptyString, nullptr );
255 
256  m_toolKinds[ toolId ] = false;
257  m_toolActions[ toolId ] = &aAction;
258 }
259 
260 
261 void ACTION_TOOLBAR::AddScaledSeparator( wxWindow* aWindow )
262 {
263  int scale = Pgm().GetCommonSettings()->m_Appearance.icon_scale;
264 
265  if( scale == 0 )
266  scale = KiIconScale( aWindow );
267 
268  if( scale > 4 )
269  AddSpacer( 16 * ( scale - 4 ) / 4 );
270 
271  AddSeparator();
272 
273  if( scale > 4 )
274  AddSpacer( 16 * ( scale - 4 ) / 4 );
275 }
276 
277 
279  std::unique_ptr<ACTION_MENU> aMenu )
280 {
281  int toolId = aAction.GetUIId();
282 
283  m_toolMenus[toolId] = std::move( aMenu );
284 }
285 
286 
287 void ACTION_TOOLBAR::AddGroup( ACTION_GROUP* aGroup, bool aIsToggleEntry )
288 {
289  int groupId = aGroup->GetUIId();
290  const TOOL_ACTION* defaultAction = aGroup->GetDefaultAction();
291  wxBitmap bmp = KiScaledBitmap( defaultAction->GetIcon(), GetParent() );
292 
293  wxASSERT( GetParent() );
294  wxASSERT( defaultAction );
295 
296  m_toolKinds[ groupId ] = aIsToggleEntry;
297  m_toolActions[ groupId ] = defaultAction;
298  m_actionGroups[ groupId ] = aGroup;
299 
300  // Add the main toolbar item representing the group
301  AddTool( groupId, wxEmptyString, bmp, MakeDisabledBitmap( bmp ),
302  aIsToggleEntry ? wxITEM_CHECK : wxITEM_NORMAL,
303  wxEmptyString, wxEmptyString, nullptr );
304 
305  // Select the default action
306  doSelectAction( aGroup, *defaultAction );
307 }
308 
309 
311 {
312  bool valid = std::any_of( aGroup->m_actions.begin(), aGroup->m_actions.end(),
313  [&]( const TOOL_ACTION* action2 ) -> bool
314  {
315  // For some reason, we can't compare the actions directly
316  return aAction.GetId() == action2->GetId();
317  } );
318 
319  if( valid )
320  doSelectAction( aGroup, aAction );
321 }
322 
323 
325 {
326  wxASSERT( GetParent() );
327 
328  int groupId = aGroup->GetUIId();
329 
330  wxAuiToolBarItem* item = FindTool( groupId );
331 
332  if( !item )
333  return;
334 
335  // Update the item information
336  item->SetShortHelp( aAction.GetDescription() );
337  item->SetBitmap( KiScaledBitmap( aAction.GetIcon(), GetParent() ) );
338  item->SetDisabledBitmap( MakeDisabledBitmap( item->GetBitmap() ) );
339 
340  // Register a new handler with the new UI conditions
341  if( m_toolManager )
342  {
343  const ACTION_CONDITIONS* cond = m_toolManager->GetActionManager()->GetCondition( aAction );
344 
345  wxASSERT_MSG( cond, wxString::Format( "Missing UI condition for action %s",
346  aAction.GetName() ) );
347 
350  }
351 
352  // Update the currently selected action
353  m_toolActions[ groupId ] = &aAction;
354 
355  Refresh();
356 }
357 
358 
360 {
361  wxAuiToolBarItem* item = FindTool( aID );
362  wxASSERT_MSG( item, wxString::Format( "No toolbar item found for ID %d", aID ) );
363 
364  // The control on the toolbar is stored inside the window field of the item
365  wxControl* control = dynamic_cast<wxControl*>( item->GetWindow() );
366  wxASSERT_MSG( control, wxString::Format( "No control located in toolbar item with ID %d", aID ) );
367 
368  // Update the size the item has stored using the best size of the control
369  wxSize bestSize = control->GetBestSize();
370  item->SetMinSize( bestSize );
371 
372  // Update the sizer item sizes
373  // This is a bit convoluted because there are actually 2 sizers that need to be updated:
374  // 1. The main sizer that is used for the entire toolbar (this sizer item can be found in the
375  // toolbar item)
376  if( wxSizerItem* szrItem = item->GetSizerItem() )
377  szrItem->SetMinSize( bestSize );
378 
379  // 2. The controls have a second sizer that allows for padding above/below the control with
380  // stretch space, so we also need to update the sizer item for the control in that sizer with
381  // the new size. We let wx do the search for us, since SetItemMinSize is recursive and will
382  // locate the control on that sizer.
383  if( m_sizer )
384  {
385  m_sizer->SetItemMinSize( control, bestSize );
386 
387  // Now actually update the toolbar with the new sizes
388  m_sizer->Layout();
389  }
390 }
391 
392 
394 {
395  // Clear all the maps keeping track of our items on the toolbar
396  m_toolMenus.clear();
397  m_actionGroups.clear();
398  m_toolCancellable.clear();
399  m_toolKinds.clear();
400  m_toolActions.clear();
401 
402  // Remove the actual tools from the toolbar
403  Clear();
404 }
405 
406 
407 void ACTION_TOOLBAR::SetToolBitmap( const TOOL_ACTION& aAction, const wxBitmap& aBitmap )
408 {
409  int toolId = aAction.GetUIId();
410  wxAuiToolBar::SetToolBitmap( toolId, aBitmap );
411 
412  // Set the disabled bitmap: we use the disabled bitmap version of aBitmap.
413  wxAuiToolBarItem* tb_item = wxAuiToolBar::FindTool( toolId );
414 
415  if( tb_item )
416  tb_item->SetDisabledBitmap( MakeDisabledBitmap( aBitmap ) );
417 }
418 
419 
420 void ACTION_TOOLBAR::Toggle( const TOOL_ACTION& aAction, bool aState )
421 {
422  int toolId = aAction.GetUIId();
423 
424  if( m_toolKinds[ toolId ] )
425  ToggleTool( toolId, aState );
426  else
427  EnableTool( toolId, aState );
428 }
429 
430 
431 void ACTION_TOOLBAR::Toggle( const TOOL_ACTION& aAction, bool aEnabled, bool aChecked )
432 {
433  int toolId = aAction.GetUIId();
434 
435  EnableTool( toolId, aEnabled );
436  ToggleTool( toolId, aEnabled && aChecked );
437 }
438 
439 
440 void ACTION_TOOLBAR::onToolEvent( wxAuiToolBarEvent& aEvent )
441 {
442  int id = aEvent.GetId();
443  wxEventType type = aEvent.GetEventType();
444  OPT_TOOL_EVENT evt;
445 
446  bool handled = false;
447 
448  if( m_toolManager && type == wxEVT_COMMAND_TOOL_CLICKED && id >= TOOL_ACTION::GetBaseUIId() )
449  {
450  const auto actionIt = m_toolActions.find( id );
451 
452  // The toolbar item is toggled before the event is sent, so we check for it not being
453  // toggled to see if it was toggled originally
454  if( m_toolCancellable[id] && !GetToolToggled( id ) )
455  {
456  // Send a cancel event
458  handled = true;
459  }
460  else if( actionIt != m_toolActions.end() )
461  {
462  // Dispatch a tool event
463  evt = actionIt->second->MakeEvent();
464  evt->SetHasPosition( false );
465  m_toolManager->ProcessEvent( *evt );
467  handled = true;
468  }
469  }
470 
471  // Skip the event if we don't handle it
472  if( !handled )
473  aEvent.Skip();
474 }
475 
476 
477 void ACTION_TOOLBAR::onToolRightClick( wxAuiToolBarEvent& aEvent )
478 {
479  int toolId = aEvent.GetToolId();
480 
481  // This means the event was not on a button
482  if( toolId == -1 )
483  return;
484 
485  // Ensure that the ID used maps to a proper tool ID.
486  // If right-clicked on a group item, this is needed to get the ID of the currently selected
487  // action, since the event's ID is that of the group.
488  const auto actionIt = m_toolActions.find( toolId );
489 
490  if( actionIt != m_toolActions.end() )
491  toolId = actionIt->second->GetUIId();
492 
493  // Find the menu for the action
494  const auto menuIt = m_toolMenus.find( toolId );
495 
496  if( menuIt == m_toolMenus.end() )
497  return;
498 
499  // Update and show the menu
500  std::unique_ptr<ACTION_MENU>& owningMenu = menuIt->second;
501 
502  // Get the actual menu pointer to show it
503  ACTION_MENU* menu = owningMenu.get();
504  SELECTION dummySel;
505 
506  if( CONDITIONAL_MENU* condMenu = dynamic_cast<CONDITIONAL_MENU*>( menu ) )
507  condMenu->Evaluate( dummySel );
508 
509  menu->UpdateAll();
510  PopupMenu( menu );
511 
512  // Remove hovered item when the menu closes, otherwise it remains hovered even if the
513  // mouse is not on the toolbar
514  SetHoverItem( nullptr );
515 }
516 
517 // The time (in milliseconds) between pressing the left mouse button and opening the palette
518 #define PALETTE_OPEN_DELAY 500
519 
520 
521 void ACTION_TOOLBAR::onMouseClick( wxMouseEvent& aEvent )
522 {
523  wxAuiToolBarItem* item = FindToolByPosition( aEvent.GetX(), aEvent.GetY() );
524 
525  if( item )
526  {
527  // Ensure there is no active palette
528  if( m_palette )
529  {
530  m_palette->Hide();
531  m_palette->Destroy();
532  m_palette = nullptr;
533  }
534 
535  // Start the popup conditions if it is a left mouse click and the tool clicked is a group
536  if( aEvent.LeftDown() && ( m_actionGroups.find( item->GetId() ) != m_actionGroups.end() ) )
537  m_paletteTimer->StartOnce( PALETTE_OPEN_DELAY );
538 
539  // Clear the popup conditions if it is a left up, because that implies a click happened
540  if( aEvent.LeftUp() )
541  m_paletteTimer->Stop();
542  }
543 
544  // Skip the event so wx can continue processing the mouse event
545  aEvent.Skip();
546 }
547 
548 
549 void ACTION_TOOLBAR::onItemDrag( wxAuiToolBarEvent& aEvent )
550 {
551  int toolId = aEvent.GetToolId();
552 
553  if( m_actionGroups.find( toolId ) != m_actionGroups.end() )
554  {
555  wxAuiToolBarItem* item = FindTool( toolId );
556 
557  // Use call after because opening the palette from a mouse handler
558  // creates a weird mouse state that causes problems on OSX.
559  CallAfter( &ACTION_TOOLBAR::popupPalette, item );
560 
561  // Don't skip this event since we are handling it
562  return;
563  }
564 
565  // Skip since we don't care about it
566  aEvent.Skip();
567 }
568 
569 
570 void ACTION_TOOLBAR::onTimerDone( wxTimerEvent& aEvent )
571 {
572  // We need to search for the tool using the client coordinates
573  wxPoint mousePos = ScreenToClient( wxGetMousePosition() );
574 
575  wxAuiToolBarItem* item = FindToolByPosition( mousePos.x, mousePos.y );
576 
577  if( item )
578  popupPalette( item );
579 }
580 
581 
582 void ACTION_TOOLBAR::onPaletteEvent( wxCommandEvent& aEvent )
583 {
584  if( !m_palette )
585  return;
586 
587  OPT_TOOL_EVENT evt;
589 
590  // Find the action corresponding to the button press
591  auto actionIt = std::find_if( group->GetActions().begin(), group->GetActions().end(),
592  [=]( const TOOL_ACTION* aAction )
593  {
594  return aAction->GetUIId() == aEvent.GetId();
595  } );
596 
597  if( actionIt != group->GetActions().end() )
598  {
599  const TOOL_ACTION* action = *actionIt;
600 
601  // Dispatch a tool event
602  evt = action->MakeEvent();
603  evt->SetHasPosition( false );
604  m_toolManager->ProcessEvent( *evt );
606 
607  // Update the main toolbar item with the selected action
608  doSelectAction( group, *action );
609  }
610 
611  // Hide the palette
612  m_palette->Hide();
613  m_palette->Destroy();
614  m_palette = nullptr;
615 }
616 
617 
618 void ACTION_TOOLBAR::popupPalette( wxAuiToolBarItem* aItem )
619 {
620  // Clear all popup conditions
621  m_paletteTimer->Stop();
622 
623  wxWindow* toolParent = dynamic_cast<wxWindow*>( m_toolManager->GetToolHolder() );
624 
625  wxASSERT( GetParent() );
626  wxASSERT( m_auiManager );
627  wxASSERT( toolParent );
628 
629  // Ensure the item we are using for the palette has a group associated with it.
630  const auto it = m_actionGroups.find( aItem->GetId() );
631 
632  if( it == m_actionGroups.end() )
633  return;
634 
635  ACTION_GROUP* group = it->second;
636 
637  wxAuiPaneInfo& pane = m_auiManager->GetPane( this );
638 
639  // We use the size of the toolbar items for our palette buttons
640  wxRect toolRect = GetToolRect( aItem->GetId() );
641 
642  // The position for the palette window must be in screen coordinates
643  wxPoint pos( ClientToScreen( toolRect.GetPosition() ) );
644 
645  // True for vertical buttons, false for horizontal
646  bool dir = true;
647  size_t numActions = group->m_actions.size();
648 
649  // The size of the palette in the long dimension
650  int paletteLongDim = ( 2 * PALETTE_BORDER ) // The border on all sides of the buttons
651  + ( BUTTON_BORDER ) // The border on the start of the buttons
652  + ( numActions * BUTTON_BORDER ) // The other button borders
653  + ( numActions * toolRect.GetHeight() ); // The size of the buttons
654 
655  // Determine the position of the top left corner of the palette window
656  switch( pane.dock_direction )
657  {
658  case wxAUI_DOCK_TOP:
659  // Top toolbars need to shift the palette window down by the toolbar padding
660  dir = true; // Buttons are vertical in the palette
661  pos = ClientToScreen( toolRect.GetBottomLeft() );
662  pos += wxPoint( -PALETTE_BORDER, // Shift left to align the button edges
663  m_bottomPadding ); // Shift down to move away from the toolbar
664  break;
665 
666  case wxAUI_DOCK_BOTTOM:
667  // Bottom toolbars need to shift the palette window up by its height (all buttons +
668  // border + toolbar padding)
669  dir = true; // Buttons are vertical in the palette
670  pos = ClientToScreen( toolRect.GetTopLeft() );
671  pos += wxPoint( -PALETTE_BORDER, // Shift left to align the button
672  // Shift up by the entire length of the palette.
673  -( paletteLongDim + m_topPadding ) );
674  break;
675 
676  case wxAUI_DOCK_LEFT:
677  // Left toolbars need to shift the palette window up by the toolbar padding
678  dir = false; // Buttons are horizontal in the palette
679  pos = ClientToScreen( toolRect.GetTopRight() );
680  pos += wxPoint( m_rightPadding, // Shift right to move away from the toolbar
681  -( PALETTE_BORDER ) ); // Shift up to align the button tops
682  break;
683 
684  case wxAUI_DOCK_RIGHT:
685  // Right toolbars need to shift the palette window left by its width (all buttons +
686  // border + toolbar padding)
687  dir = false; // Buttons are horizontal in the palette
688  pos = ClientToScreen( toolRect.GetTopLeft() );
689 
690  // Shift left by the entire length of the palette.
691  pos += wxPoint( -( paletteLongDim + m_leftPadding ),
692  -( PALETTE_BORDER ) ); // Shift up to align the button
693  break;
694  }
695 
696  m_palette = new ACTION_TOOLBAR_PALETTE( GetParent(), dir );
697 
698  // We handle the button events in the toolbar class, so connect the right handler
700  m_palette->SetButtonSize( toolRect );
701  m_palette->Connect( wxEVT_BUTTON, wxCommandEventHandler( ACTION_TOOLBAR::onPaletteEvent ),
702  nullptr, this );
703 
704 
705  // Add the actions in the group to the palette and update their enabled state
706  // We purposely don't check items in the palette
707  for( const TOOL_ACTION* action : group->m_actions )
708  {
709  wxUpdateUIEvent evt( action->GetUIId() );
710 
711  toolParent->ProcessWindowEvent( evt );
712 
713  m_palette->AddAction( *action );
714 
715  if( evt.GetSetEnabled() )
716  m_palette->EnableAction( *action, evt.GetEnabled() );
717  }
718 
719  // Release the mouse to ensure the first click will be recognized in the palette
720  ReleaseMouse();
721 
722  m_palette->SetPosition( pos );
723  m_palette->Popup();
724 
725  // Clear the mouse state on the toolbar because otherwise wxWidgets gets confused
726  // and won't properly display any highlighted items after the palette is closed.
727  // (This is the equivalent of calling the DoResetMouseState() private function)
728  RefreshOverflowState();
729  SetHoverItem( nullptr );
730  SetPressedItem( nullptr );
731 
732  m_dragging = false;
733  m_tipItem = nullptr;
734  m_actionPos = wxPoint( -1, -1 );
735  m_actionItem = nullptr;
736 }
737 
738 
739 void ACTION_TOOLBAR::OnCustomRender(wxDC& aDc, const wxAuiToolBarItem& aItem, const wxRect& aRect )
740 {
741  auto it = m_actionGroups.find( aItem.GetId() );
742 
743  if( it == m_actionGroups.end() )
744  return;
745 
746  // Choose the color to draw the triangle
747  wxColour clr;
748 
749  if( aItem.GetState() & wxAUI_BUTTON_STATE_DISABLED )
750  clr = wxSystemSettings::GetColour( wxSYS_COLOUR_GRAYTEXT );
751  else
752  clr = wxSystemSettings::GetColour( wxSYS_COLOUR_BTNTEXT );
753 
754  // Must set both the pen (for the outline) and the brush (for the polygon fill)
755  aDc.SetPen( wxPen( clr ) );
756  aDc.SetBrush( wxBrush( clr ) );
757 
758  // Make the side length of the triangle approximately 1/5th of the bitmap
759  int sideLength = KiROUND( aRect.height / 5.0 );
760 
761  // This will create a triangle with its point at the bottom right corner,
762  // and its other two corners along the right and bottom sides
763  wxPoint btmRight = aRect.GetBottomRight();
764  wxPoint topCorner( btmRight.x, btmRight.y - sideLength );
765  wxPoint btmCorner( btmRight.x - sideLength, btmRight.y );
766 
767  wxPointList points;
768  points.Append( &btmRight );
769  points.Append( &topCorner );
770  points.Append( &btmCorner );
771 
772  aDc.DrawPolygon( &points );
773 }
774 
775 
777 {
778  wxClientDC dc( this );
779 
780  if( !dc.IsOk() )
781  return false;
782 
783  // calculate hint sizes for both horizontal and vertical
784  // in the order that leaves toolbar in correct final state
785 
786  // however, skip calculating alternate orientations if we don't need them due to window style
787  bool retval = true;
788 
789  if( m_orientation == wxHORIZONTAL )
790  {
791  if( !( GetWindowStyle() & wxAUI_TB_HORIZONTAL ) )
792  {
793  m_vertHintSize = GetSize();
794  retval = RealizeHelper( dc, false );
795  }
796 
797  if( retval && RealizeHelper( dc, true ) )
798  {
799  m_horzHintSize = GetSize();
800  }
801  else
802  {
803  retval = false;
804  }
805  }
806  else
807  {
808  if( !( GetWindowStyle() & wxAUI_TB_VERTICAL ) )
809  {
810  m_horzHintSize = GetSize();
811  retval = RealizeHelper( dc, true );
812  }
813 
814  if( retval && RealizeHelper( dc, false ) )
815  {
816  m_vertHintSize = GetSize();
817  }
818  else
819  {
820  retval = false;
821  }
822  }
823 
824  Refresh( false );
825  return retval;
826 }
827 
828 
829 void ACTION_TOOLBAR::onThemeChanged( wxSysColourChangedEvent &aEvent )
830 {
832  RefreshBitmaps();
833 
834  aEvent.Skip();
835 }
836 
837 
839 {
840  for( const std::pair<int, const TOOL_ACTION*> pair : m_toolActions )
841  {
842  wxAuiToolBarItem* tool = FindTool( pair.first );
843 
844  wxBitmap bmp = KiScaledBitmap( pair.second->GetIcon(), GetParent() );
845 
846  tool->SetBitmap( bmp );
847  tool->SetDisabledBitmap( MakeDisabledBitmap( bmp ) );
848  }
849 
850  Refresh();
851 }
wxBitmap MakeDisabledBitmap(const wxBitmap &aSource)
const TOOL_ACTION * m_defaultAction
The actions that compose the group.
A bitmap button widget that behaves like an AUI toolbar item's button when it is drawn.
Definition: bitmap_button.h:39
void onItemDrag(wxAuiToolBarEvent &aEvent)
The default tool event handler.
void CheckAction(const TOOL_ACTION &aAction, bool aCheck=true)
Check/Toggle the button for an action on the palette.
static int MakeActionId(const std::string &aActionName)
Generate an unique ID from for an action with given name.
int GetUIId() const
Definition: tool_action.h:130
ACTION_GROUP * GetGroup()
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:48
void SetButtonSize(wxRect &aSize)
Set the size all the buttons on this palette should be.
void AddToolContextMenu(const TOOL_ACTION &aAction, std::unique_ptr< ACTION_MENU > aMenu)
Add a context menu to a specific tool item on the toolbar.
virtual void RefreshCanvas()
Definition: tools_holder.h:153
void AddScaledSeparator(wxWindow *aWindow)
Add a separator that introduces space on either side to not squash the tools when scaled.
void popupPalette(wxAuiToolBarItem *aItem)
Popup the ACTION_TOOLBAR_PALETTE associated with the ACTION_GROUP of the given toolbar item.
void Add(const TOOL_ACTION &aAction, bool aIsToggleEntry=false, bool aIsCancellable=false)
Add a TOOL_ACTION-based button to the toolbar.
int KiIconScale(wxWindow *aWindow)
Return the automatic scale factor that would be used for a given window by KiScaledBitmap and KiScale...
Definition: bitmap.cpp:122
#define PALETTE_OPEN_DELAY
void onToolRightClick(wxAuiToolBarEvent &aEvent)
Handle the button select inside the palette.
virtual void UnregisterUIUpdateHandler(const TOOL_ACTION &aAction)
Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler.
Definition: tools_holder.h:83
void onTimerDone(wxTimerEvent &aEvent)
bool IsDarkTheme()
Determine if the desktop interface is currently using a dark theme or a light theme.
Definition: gtk/ui.cpp:31
void AddGroup(ACTION_GROUP *aGroup, bool aIsToggleEntry=false)
Add a set of actions to a toolbar as a group.
void UpdateAll()
Run update handlers for the menu and its submenus.
ACTION_TOOLBAR_PALETTE(wxWindow *aParent, bool aVertical)
Create the palette.
void onToolEvent(wxAuiToolBarEvent &aEvent)
Handle a right-click on a menu item.
std::map< int, const TOOL_ACTION * > m_toolActions
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
bool KiRealize()
Use this over Realize() to avoid a rendering glitch with fixed orientation toolbars.
static int GetBaseUIId()
Definition: tool_action.h:135
void SetDefaultAction(const TOOL_ACTION &aDefault)
Set the default action to use when first creating the toolbar palette icon.
void onMouseClick(wxMouseEvent &aEvent)
Handler for when a drag event occurs on an item.
A group of actions that will be displayed together on a toolbar palette.
ACTION_GROUP(const std::string &aName, const std::vector< const TOOL_ACTION * > &aActions)
void AddAction(const TOOL_ACTION &aAction)
Add an action to the palette.
void AddButton(const TOOL_ACTION &aAction)
Add a large button such as used in the KiCad Manager Frame's launch bar.
wxWidgets 3.1 has support for dark mode detection, but 3.0 doesn't.
void Refresh()
Update the board display after modifying it by a python script (note: it is automatically called by a...
void doSelectAction(ACTION_GROUP *aGroup, const TOOL_ACTION &aAction)
Update a group toolbar item to look like a specific action.
bool ProcessEvent(const TOOL_EVENT &aEvent)
Propagate an event to tools that requested events of matching type(s).
std::map< int, bool > m_toolCancellable
void UpdateControlWidth(int aID)
Update the toolbar item width of a control using its best size.
void SetGroup(ACTION_GROUP *aGroup)
Set the action group that this palette contains the actions for.
void SetPadding(int aPadding)
Set the amount of padding present on each side of the bitmap.
const BITMAPS GetIcon() const
Return an icon associated with the action.
Definition: tool_action.h:179
void OnCustomRender(wxDC &aDc, const wxAuiToolBarItem &aItem, const wxRect &aRect) override
void onThemeChanged(wxSysColourChangedEvent &aEvent)
Render the triangle in the lower-right corner that represents that an action palette is available for...
void ThemeChanged()
Notifies the store that the icon theme has been changed by the user, so caches must be invalidated.
ACTION_TOOLBAR_PALETTE * m_palette
wxString GetDescription(bool aIncludeHotkey=true) const
Definition: tool_action.cpp:97
std::vector< const TOOL_ACTION * > m_actions
ACTION_TOOLBAR(EDA_BASE_FRAME *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxAUI_TB_DEFAULT_STYLE)
wxBitmap KiScaledBitmap(BITMAPS aBitmap, wxWindow *aWindow, int aHeight, bool aQuantized)
Construct a wxBitmap from a memory record, scaling it if device DPI demands it.
Definition: bitmap.cpp:148
std::map< int, std::unique_ptr< ACTION_MENU > > m_toolMenus
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
wxRect m_buttonSize
True if the palette uses vertical buttons, false for horizontal buttons.
TOOLS_HOLDER * GetToolHolder() const
Definition: tool_manager.h:294
wxAuiManager * m_auiManager
void RefreshBitmaps()
Reload all the bitmaps for the tools (e.g.
const TOOL_ACTION * GetDefaultAction() const
Get the default action to use when first creating this group's toolbar palette icon.
TOOL_MANAGER * m_toolManager
int GetId() const
Return the unique id of the TOOL_ACTION object.
Definition: tool_action.h:121
const int scale
see class PGM_BASE
std::map< int, ACTION_GROUP * > m_actionGroups
void SetBitmap(const wxBitmap &aBmp)
Set the bitmap shown when the button is enabled.
Functors that can be used to figure out how the action controls should be displayed in the UI and if ...
std::map< int, BITMAP_BUTTON * > m_buttons
The base frame for deriving all KiCad main window classes.
Represent a single user action.
Definition: tool_action.h:67
#define PALETTE_BORDER
void SetToolBitmap(const TOOL_ACTION &aAction, const wxBitmap &aBitmap)
Updates the bitmap of a particular tool.
TOOL_EVENT MakeEvent() const
Return the event associated with the action (i.e.
Definition: tool_action.cpp:72
void Toggle(const TOOL_ACTION &aAction, bool aState)
Apply the default toggle action.
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:73
int GetUIId() const
Get the ID used in the UI to reference this group.
wxBoxSizer * m_buttonSizer
The buttons that act as the toolbar on the palette.
virtual ~ACTION_TOOLBAR()
void AcceptDragInAsClick(bool aAcceptDragIn=true)
Accept mouse-up as click even if mouse-down happened outside of the control.
ACTION_MANAGER * GetActionManager() const
Definition: tool_manager.h:199
void SelectAction(ACTION_GROUP *aGroup, const TOOL_ACTION &aAction)
Select an action inside a group.
const ACTION_CONDITIONS * GetCondition(const TOOL_ACTION &aAction) const
Get the conditions to use for a specific tool action.
void SetDisabledBitmap(const wxBitmap &aBmp)
Set the bitmap shown when the button is disabled.
int m_id
< The action ID for this action group
void Popup(wxWindow *aFocus=nullptr) override
Popup this window.
#define BUTTON_BORDER
virtual void RegisterUIUpdateHandler(const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
Register an action's update conditions with the UI layer to allow the UI to appropriately display the...
Definition: tools_holder.h:63
void EnableAction(const TOOL_ACTION &aAction, bool aEnable=true)
Enable the button for an action on the palette.
void onCharHook(wxKeyEvent &aEvent)
std::map< int, bool > m_toolKinds
wxTimer * m_paletteTimer
A popup window that contains a row of toolbar-like buttons for the user to choose from.
void SetHasPosition(bool aHasPosition)
Returns if the action associated with this event should be treated as immediate regardless of the cur...
Definition: tool_event.h:241
void CancelTool()
Send a cancel event to the tool currently at the top of the tool stack.
void onPaletteEvent(wxCommandEvent &aEvent)
Handle the palette timer triggering.
OPT< TOOL_EVENT > OPT_TOOL_EVENT
Definition: tool_event.h:548
std::string m_name
The default action to display on the toolbar item.
const std::string & GetName() const
Return name of the action.
Definition: tool_action.h:101
void ClearToolbar()
Clear the toolbar and remove all associated menus.
BITMAP_STORE * GetBitmapStore()
Definition: bitmap.cpp:93