Define the structure of a toolbar with buttons that invoke ACTIONs. More...

#include <action_toolbar.h>

Inheritance diagram for ACTION_TOOLBAR:

Public Member Functions
	ACTION_TOOLBAR (EDA_BASE_FRAME *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxAUI_TB_DEFAULT_STYLE)

virtual	~ACTION_TOOLBAR ()

void	SetAuiManager (wxAuiManager *aManager)
	Set the AUI manager that this toolbar belongs to.

void	SetToolManager (TOOL_MANAGER *aManager)

void	Add (const TOOL_ACTION &aAction, bool aIsToggleEntry=false, bool aIsCancellable=false)
	Add a TOOL_ACTION-based button to the toolbar.

void	AddButton (const TOOL_ACTION &aAction)
	Add a large button such as used in the KiCad Manager Frame's launch bar.

void	AddScaledSeparator (wxWindow *aWindow)
	Add a separator that introduces space on either side to not squash the tools when scaled.

void	AddToolContextMenu (const TOOL_ACTION &aAction, std::unique_ptr< ACTION_MENU > aMenu)
	Add a context menu to a specific tool item on the toolbar.

void	AddGroup (ACTION_GROUP *aGroup, bool aIsToggleEntry=false)
	Add a set of actions to a toolbar as a group.

void	SelectAction (ACTION_GROUP *aGroup, const TOOL_ACTION &aAction)
	Select an action inside a group.

void	UpdateControlWidth (int aID)
	Update the toolbar item width of a control using its best size.

void	ClearToolbar ()
	Clear the toolbar and remove all associated menus.

void	SetToolBitmap (const TOOL_ACTION &aAction, const wxBitmap &aBitmap)
	Updates the bitmap of a particular tool.

void	Toggle (const TOOL_ACTION &aAction, bool aState)
	Apply the default toggle action.

void	Toggle (const TOOL_ACTION &aAction, bool aEnabled, bool aChecked)

bool	KiRealize ()
	Use this over Realize() to avoid a rendering glitch with fixed orientation toolbars.

void	RefreshBitmaps ()
	Reload all the bitmaps for the tools (e.g.

Static Public Attributes
static constexpr bool	TOGGLE = true

static constexpr bool	CANCEL = true

Protected Member Functions
void	doSelectAction (ACTION_GROUP *aGroup, const TOOL_ACTION &aAction)
	Update a group toolbar item to look like a specific action.

void	popupPalette (wxAuiToolBarItem *aItem)
	Popup the ACTION_TOOLBAR_PALETTE associated with the ACTION_GROUP of the given toolbar item.

void	onMouseClick (wxMouseEvent &aEvent)
	Handler for when a drag event occurs on an item.

void	onItemDrag (wxAuiToolBarEvent &aEvent)
	The default tool event handler.

void	onToolEvent (wxAuiToolBarEvent &aEvent)
	Handle a right-click on a menu item.

void	onToolRightClick (wxAuiToolBarEvent &aEvent)
	Handle the button select inside the palette.

void	onPaletteEvent (wxCommandEvent &aEvent)
	Handle the palette timer triggering.

void	onTimerDone (wxTimerEvent &aEvent)

void	onThemeChanged (wxSysColourChangedEvent &aEvent)
	Render the triangle in the lower-right corner that represents that an action palette is available for an item.

void	OnCustomRender (wxDC &aDc, const wxAuiToolBarItem &aItem, const wxRect &aRect) override

Protected Attributes
wxTimer *	m_paletteTimer

wxAuiManager *	m_auiManager

TOOL_MANAGER *	m_toolManager

ACTION_TOOLBAR_PALETTE *	m_palette

std::map< int, bool >	m_toolKinds

std::map< int, bool >	m_toolCancellable

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

std::map< int, ACTION_GROUP * >	m_actionGroups

std::map< int, std::unique_ptr< ACTION_MENU > >	m_toolMenus

Detailed Description

Define the structure of a toolbar with buttons that invoke ACTIONs.

Definition at line 183 of file action_toolbar.h.

Constructor & Destructor Documentation

◆ ACTION_TOOLBAR()

ACTION_TOOLBAR::ACTION_TOOLBAR	(	EDA_BASE_FRAME *	parent,
		wxWindowID	id = `wxID_ANY`,
		const wxPoint &	pos = `wxDefaultPosition`,
		const wxSize &	size = `wxDefaultSize`,
		long	style = `wxAUI_TB_DEFAULT_STYLE`
	)

Definition at line 184 of file action_toolbar.cpp.

References m_paletteTimer, onItemDrag(), onMouseClick(), onThemeChanged(), onTimerDone(), onToolEvent(), and onToolRightClick().

◆ ~ACTION_TOOLBAR()

ACTION_TOOLBAR::~ACTION_TOOLBAR ( )

virtual

Definition at line 213 of file action_toolbar.cpp.

References m_actionGroups, m_paletteTimer, m_toolActions, m_toolCancellable, m_toolKinds, and m_toolMenus.

Member Function Documentation

◆ Add()

void ACTION_TOOLBAR::Add	(	const TOOL_ACTION &	aAction,
		bool	aIsToggleEntry = `false`,
		bool	aIsCancellable = `false`
	)

Add a TOOL_ACTION-based button to the toolbar.

After selecting the entry, a TOOL_EVENT command containing name of the action is sent.

Parameters

aAction	is the action to add.
aIsToggleEntry	makes the toolbar item a toggle entry when true.
aIsCancellable	when true, cancels the tool if clicked when tool is active.

Definition at line 226 of file action_toolbar.cpp.

References TOOL_ACTION::GetButtonTooltip(), TOOL_ACTION::GetIcon(), TOOL_ACTION::GetUIId(), KiBitmapBundle(), KiDisabledBitmapBundle(), m_toolActions, m_toolCancellable, and m_toolKinds.

◆ AddButton()

void ACTION_TOOLBAR::AddButton ( const TOOL_ACTION & aAction )

Add a large button such as used in the KiCad Manager Frame's launch bar.

Parameters

aAction

Definition at line 244 of file action_toolbar.cpp.

References TOOL_ACTION::GetButtonTooltip(), TOOL_ACTION::GetIcon(), TOOL_ACTION::GetUIId(), KiBitmapBundle(), KiDisabledBitmapBundle(), m_toolActions, and m_toolKinds.

◆ AddGroup()

void ACTION_TOOLBAR::AddGroup	(	ACTION_GROUP *	aGroup,
		bool	aIsToggleEntry = `false`
	)

Add a set of actions to a toolbar as a group.

One action from the group will be displayed at a time.

Parameters

aGroup	is the group to add. The first action in the group will be the first shown on the toolbar.
aIsToggleEntry	makes the toolbar item a toggle entry when true

Definition at line 280 of file action_toolbar.cpp.

References doSelectAction(), ACTION_GROUP::GetDefaultAction(), TOOL_ACTION::GetIcon(), ACTION_GROUP::GetUIId(), KiBitmapBundle(), KiDisabledBitmapBundle(), m_actionGroups, m_toolActions, and m_toolKinds.

Referenced by FOOTPRINT_EDIT_FRAME::ReCreateVToolbar(), and PCB_EDIT_FRAME::ReCreateVToolbar().

◆ AddScaledSeparator()

void ACTION_TOOLBAR::AddScaledSeparator ( wxWindow * aWindow )

Add a separator that introduces space on either side to not squash the tools when scaled.

Parameters

aWindow is the window to get the scaling factor of

Definition at line 257 of file action_toolbar.cpp.

References KiIconScale(), and scale.

◆ AddToolContextMenu()

void ACTION_TOOLBAR::AddToolContextMenu	(	const TOOL_ACTION &	aAction,
		std::unique_ptr< ACTION_MENU >	aMenu
	)

Add a context menu to a specific tool item on the toolbar.

This toolbar gets ownership of the menu object, and will delete it when the ClearToolbar() function is called.

Parameters

aAction	is the action to get the menu
aMenu	is the context menu

Definition at line 271 of file action_toolbar.cpp.

References TOOL_ACTION::GetUIId(), and m_toolMenus.

Referenced by SCH_EDIT_FRAME::ReCreateOptToolbar(), SYMBOL_EDIT_FRAME::ReCreateOptToolbar(), PL_EDITOR_FRAME::ReCreateOptToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateOptToolbar(), PCB_EDIT_FRAME::ReCreateOptToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateVToolbar(), and PCB_EDIT_FRAME::ReCreateVToolbar().

◆ ClearToolbar()

void ACTION_TOOLBAR::ClearToolbar ( )

Clear the toolbar and remove all associated menus.

Definition at line 386 of file action_toolbar.cpp.

References m_actionGroups, m_toolActions, m_toolCancellable, m_toolKinds, and m_toolMenus.

◆ doSelectAction()

void ACTION_TOOLBAR::doSelectAction	(	ACTION_GROUP *	aGroup,
		const TOOL_ACTION &	aAction
	)

protected

Update a group toolbar item to look like a specific action.

Note: This function does not verify that the action is inside the group.

Definition at line 317 of file action_toolbar.cpp.

References TOOL_MANAGER::GetActionManager(), ACTION_MANAGER::GetCondition(), TOOL_ACTION::GetIcon(), TOOL_ACTION::GetName(), TOOL_MANAGER::GetToolHolder(), TOOL_ACTION::GetTooltip(), ACTION_GROUP::GetUIId(), KiBitmapBundle(), KiDisabledBitmapBundle(), m_toolActions, m_toolManager, Refresh(), TOOLS_HOLDER::RegisterUIUpdateHandler(), and TOOLS_HOLDER::UnregisterUIUpdateHandler().

Referenced by AddGroup(), onPaletteEvent(), and SelectAction().

◆ KiRealize()

bool ACTION_TOOLBAR::KiRealize ( )

Use this over Realize() to avoid a rendering glitch with fixed orientation toolbars.

The standard Realize() draws both horizontal and vertical to determine sizing However with many icons, potato PCs, etc, you can actually see that double draw This custom function avoids the double draw if the HORIZONTAL or VERTICAL toolbar properties are set.

Definition at line 772 of file action_toolbar.cpp.

References Refresh().

◆ OnCustomRender()

void ACTION_TOOLBAR::OnCustomRender	(	wxDC &	aDc,
		const wxAuiToolBarItem &	aItem,
		const wxRect &	aRect
	)

overrideprotected

Definition at line 735 of file action_toolbar.cpp.

References KiROUND(), and m_actionGroups.

◆ onItemDrag()

void ACTION_TOOLBAR::onItemDrag ( wxAuiToolBarEvent & aEvent )

protected

The default tool event handler.

Definition at line 545 of file action_toolbar.cpp.

References m_actionGroups, and popupPalette().

Referenced by ACTION_TOOLBAR().

◆ onMouseClick()

void ACTION_TOOLBAR::onMouseClick ( wxMouseEvent & aEvent )

protected

Handler for when a drag event occurs on an item.

Definition at line 517 of file action_toolbar.cpp.

References m_actionGroups, m_palette, m_paletteTimer, and PALETTE_OPEN_DELAY.

Referenced by ACTION_TOOLBAR().

◆ onPaletteEvent()

void ACTION_TOOLBAR::onPaletteEvent ( wxCommandEvent & aEvent )

protected

Handle the palette timer triggering.

Definition at line 578 of file action_toolbar.cpp.

References doSelectAction(), ACTION_TOOLBAR_PALETTE::GetGroup(), TOOL_MANAGER::GetToolHolder(), group, m_palette, m_toolManager, TOOL_ACTION::MakeEvent(), TOOL_MANAGER::ProcessEvent(), TOOLS_HOLDER::RefreshCanvas(), and TOOL_EVENT::SetHasPosition().

Referenced by popupPalette().

◆ onThemeChanged()

void ACTION_TOOLBAR::onThemeChanged ( wxSysColourChangedEvent & aEvent )

protected

Render the triangle in the lower-right corner that represents that an action palette is available for an item.

Definition at line 829 of file action_toolbar.cpp.

References GetBitmapStore(), RefreshBitmaps(), and BITMAP_STORE::ThemeChanged().

Referenced by ACTION_TOOLBAR().

◆ onTimerDone()

void ACTION_TOOLBAR::onTimerDone ( wxTimerEvent & aEvent )

protected

Definition at line 566 of file action_toolbar.cpp.

References KIPLATFORM::UI::GetMousePosition(), and popupPalette().

Referenced by ACTION_TOOLBAR().

◆ onToolEvent()

void ACTION_TOOLBAR::onToolEvent ( wxAuiToolBarEvent & aEvent )

protected

Handle a right-click on a menu item.

Definition at line 436 of file action_toolbar.cpp.

References TOOL_MANAGER::CancelTool(), TOOL_ACTION::GetBaseUIId(), TOOL_MANAGER::GetToolHolder(), m_toolActions, m_toolCancellable, m_toolManager, TOOL_MANAGER::ProcessEvent(), and TOOLS_HOLDER::RefreshCanvas().

Referenced by ACTION_TOOLBAR().

◆ onToolRightClick()

void ACTION_TOOLBAR::onToolRightClick ( wxAuiToolBarEvent & aEvent )

protected

Handle the button select inside the palette.

Definition at line 473 of file action_toolbar.cpp.

References m_toolActions, m_toolMenus, and ACTION_MENU::UpdateAll().

Referenced by ACTION_TOOLBAR().

◆ popupPalette()

void ACTION_TOOLBAR::popupPalette ( wxAuiToolBarItem * aItem )

protected

Popup the ACTION_TOOLBAR_PALETTE associated with the ACTION_GROUP of the given toolbar item.

Handler for a mouse up/down event

Definition at line 614 of file action_toolbar.cpp.

References ACTION_TOOLBAR_PALETTE::AddAction(), BUTTON_BORDER, ACTION_TOOLBAR_PALETTE::EnableAction(), TOOL_MANAGER::GetToolHolder(), TOOL_ACTION::GetUIId(), group, m_actionGroups, m_auiManager, m_palette, m_paletteTimer, m_toolManager, onPaletteEvent(), PALETTE_BORDER, ACTION_TOOLBAR_PALETTE::Popup(), ACTION_TOOLBAR_PALETTE::SetButtonSize(), and ACTION_TOOLBAR_PALETTE::SetGroup().

Referenced by onItemDrag(), and onTimerDone().

◆ RefreshBitmaps()

void ACTION_TOOLBAR::RefreshBitmaps ( )

Reload all the bitmaps for the tools (e.g.

when switching icon themes)

Definition at line 838 of file action_toolbar.cpp.

References KiBitmapBundle(), KiDisabledBitmapBundle(), m_toolActions, and Refresh().

Referenced by onThemeChanged().

◆ SelectAction()

void ACTION_TOOLBAR::SelectAction	(	ACTION_GROUP *	aGroup,
		const TOOL_ACTION &	aAction
	)

Select an action inside a group.

Parameters

aGroup	is the group that contains the action
aAction	is the action inside the group

Definition at line 303 of file action_toolbar.cpp.

References doSelectAction(), and ACTION_GROUP::m_actions.

◆ SetAuiManager()

void ACTION_TOOLBAR::SetAuiManager ( wxAuiManager * aManager )

inline

Set the AUI manager that this toolbar belongs to.

Parameters

aManager is the AUI manager

Definition at line 197 of file action_toolbar.h.

References m_auiManager.

◆ SetToolBitmap()

void ACTION_TOOLBAR::SetToolBitmap	(	const TOOL_ACTION &	aAction,
		const wxBitmap &	aBitmap
	)

Updates the bitmap of a particular tool.

Not icon-based because we use it for the custom-drawn layer pair bitmap.

Definition at line 400 of file action_toolbar.cpp.

References TOOL_ACTION::GetUIId(), and KIPLATFORM::UI::IsDarkTheme().

Referenced by PCB_EDIT_FRAME::PrepareLayerIndicator().

◆ SetToolManager()

void ACTION_TOOLBAR::SetToolManager ( TOOL_MANAGER * aManager )

inline

Definition at line 199 of file action_toolbar.h.

References m_toolManager.

Referenced by SIMULATOR_FRAME::ReCreateHToolbar().

◆ Toggle() [1/2]

void ACTION_TOOLBAR::Toggle	(	const TOOL_ACTION &	aAction,
		bool	aEnabled,
		bool	aChecked
	)

Definition at line 427 of file action_toolbar.cpp.

References TOOL_ACTION::GetUIId().

◆ Toggle() [2/2]

void ACTION_TOOLBAR::Toggle	(	const TOOL_ACTION &	aAction,
		bool	aState
	)

Apply the default toggle action.

For checked items this is check/uncheck; for non-checked items it's enable/disable.

Definition at line 416 of file action_toolbar.cpp.

References TOOL_ACTION::GetUIId(), and m_toolKinds.

◆ UpdateControlWidth()

void ACTION_TOOLBAR::UpdateControlWidth ( int aID )

Update the toolbar item width of a control using its best size.

Parameters

aID	is the ID of the toolbar item to update the width for

Definition at line 352 of file action_toolbar.cpp.

Referenced by GERBVIEW_FRAME::ReCreateAuxiliaryToolbar(), PCB_EDIT_FRAME::ReCreateAuxiliaryToolbar(), DISPLAY_FOOTPRINTS_FRAME::ReCreateHToolbar(), GERBVIEW_FRAME::ReCreateHToolbar(), PL_EDITOR_FRAME::ReCreateHToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateHToolbar(), DISPLAY_FOOTPRINTS_FRAME::UpdateToolbarControlSizes(), GERBVIEW_FRAME::UpdateToolbarControlSizes(), PL_EDITOR_FRAME::UpdateToolbarControlSizes(), FOOTPRINT_EDIT_FRAME::UpdateToolbarControlSizes(), and PCB_EDIT_FRAME::UpdateToolbarControlSizes().

Member Data Documentation

◆ CANCEL

constexpr bool ACTION_TOOLBAR::CANCEL = true

staticconstexpr

Definition at line 301 of file action_toolbar.h.

Referenced by DISPLAY_FOOTPRINTS_FRAME::ReCreateHToolbar(), SCH_EDIT_FRAME::ReCreateHToolbar(), SYMBOL_EDIT_FRAME::ReCreateHToolbar(), GERBVIEW_FRAME::ReCreateHToolbar(), PL_EDITOR_FRAME::ReCreateHToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateHToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateHToolbar(), and PCB_EDIT_FRAME::ReCreateHToolbar().

◆ m_actionGroups

std::map<int, ACTION_GROUP*> ACTION_TOOLBAR::m_actionGroups

protected

Definition at line 352 of file action_toolbar.h.

Referenced by AddGroup(), ClearToolbar(), OnCustomRender(), onItemDrag(), onMouseClick(), popupPalette(), and ~ACTION_TOOLBAR().

◆ m_auiManager

wxAuiManager* ACTION_TOOLBAR::m_auiManager

protected

Definition at line 345 of file action_toolbar.h.

Referenced by popupPalette(), and SetAuiManager().

◆ m_palette

ACTION_TOOLBAR_PALETTE* ACTION_TOOLBAR::m_palette

protected

Definition at line 347 of file action_toolbar.h.

Referenced by onMouseClick(), onPaletteEvent(), and popupPalette().

◆ m_paletteTimer

wxTimer* ACTION_TOOLBAR::m_paletteTimer

protected

Definition at line 343 of file action_toolbar.h.

Referenced by ACTION_TOOLBAR(), onMouseClick(), popupPalette(), and ~ACTION_TOOLBAR().

◆ m_toolActions

std::map<int, const TOOL_ACTION*> ACTION_TOOLBAR::m_toolActions

protected

Definition at line 351 of file action_toolbar.h.

Referenced by Add(), AddButton(), AddGroup(), ClearToolbar(), doSelectAction(), onToolEvent(), onToolRightClick(), RefreshBitmaps(), and ~ACTION_TOOLBAR().

◆ m_toolCancellable

std::map<int, bool> ACTION_TOOLBAR::m_toolCancellable

protected

Definition at line 350 of file action_toolbar.h.

Referenced by Add(), ClearToolbar(), onToolEvent(), and ~ACTION_TOOLBAR().

◆ m_toolKinds

std::map<int, bool> ACTION_TOOLBAR::m_toolKinds

protected

Definition at line 349 of file action_toolbar.h.

Referenced by Add(), AddButton(), AddGroup(), ClearToolbar(), Toggle(), and ~ACTION_TOOLBAR().

◆ m_toolManager

TOOL_MANAGER* ACTION_TOOLBAR::m_toolManager

protected

Definition at line 346 of file action_toolbar.h.

Referenced by doSelectAction(), onPaletteEvent(), onToolEvent(), popupPalette(), and SetToolManager().

◆ m_toolMenus

std::map<int, std::unique_ptr<ACTION_MENU> > ACTION_TOOLBAR::m_toolMenus

protected

Definition at line 354 of file action_toolbar.h.

Referenced by AddToolContextMenu(), ClearToolbar(), onToolRightClick(), and ~ACTION_TOOLBAR().

◆ TOGGLE

constexpr bool ACTION_TOOLBAR::TOGGLE = true

staticconstexpr

Definition at line 300 of file action_toolbar.h.

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

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ACTION_TOOLBAR()

◆ ~ACTION_TOOLBAR()

Member Function Documentation

◆ Add()

◆ AddButton()

◆ AddGroup()

◆ AddScaledSeparator()

◆ AddToolContextMenu()

◆ ClearToolbar()

◆ doSelectAction()

◆ KiRealize()

◆ OnCustomRender()

◆ onItemDrag()

◆ onMouseClick()

◆ onPaletteEvent()

◆ onThemeChanged()

◆ onTimerDone()

◆ onToolEvent()

◆ onToolRightClick()

◆ popupPalette()

◆ RefreshBitmaps()

◆ SelectAction()

◆ SetAuiManager()

◆ SetToolBitmap()

◆ SetToolManager()

◆ Toggle() [1/2]

◆ Toggle() [2/2]

◆ UpdateControlWidth()

Member Data Documentation

◆ CANCEL

◆ m_actionGroups

◆ m_auiManager

◆ m_palette

◆ m_paletteTimer

◆ m_toolActions

◆ m_toolCancellable

◆ m_toolKinds

◆ m_toolManager

◆ m_toolMenus

◆ TOGGLE