Inheritance diagram for PSEUDO_ACTION:

Public Member Functions
	PSEUDO_ACTION (const wxString &aLabel, int aHotKey, int aHotKeyAlt=0)

bool	operator== (const TOOL_ACTION &aRhs) const

bool	operator!= (const TOOL_ACTION &aRhs) const

const std::string &	GetName () const
	Return name of the action.

int	GetDefaultHotKey () const
	Return the default hotkey (if any) for the action.

int	GetDefaultHotKeyAlt () const

int	GetHotKey () const
	Return the hotkey keycode which initiates the action.

int	GetHotKeyAlt () const

void	SetHotKey (int aKeycode, int aKeycodeAlt=0)

int	GetId () const
	Return the unique id of the TOOL_ACTION object.

bool	HasCustomUIId () const
	Return true if this action has a custom UI ID set.

int	GetUIId () const
	Get the unique ID for this action in the user interface system.

TOOL_EVENT	MakeEvent () const
	Return the event associated with the action (i.e.

wxString	GetMenuLabel () const
	Return the translated label for the action.

wxString	GetMenuItem () const

wxString	GetTooltip (bool aIncludeHotkey=true) const

wxString	GetButtonTooltip () const

wxString	GetDescription () const

wxString	GetFriendlyName () const
	Return the translated user-friendly name of the action.

TOOL_ACTION_SCOPE	GetScope () const

template<typename T >
T	GetParam () const
	Return a non-standard parameter assigned to the action.

const std::optional< TOOL_ACTION_GROUP >	GetActionGroup () const

std::string	GetToolName () const
	Return name of the tool associated with the action.

bool	IsActivation () const
	Return true if the action is intended to activate a tool.

bool	IsNotification () const
	Return true if the action is a notification.

BITMAPS	GetIcon () const
	Return an icon associated with the action.

Static Public Member Functions
static int	GetBaseUIId ()
	Get the base value used to offset the user interface IDs for the actions.

Protected Attributes
std::string	m_name
	Name of the action (convention is "app.tool.actionName")

TOOL_ACTION_SCOPE	m_scope

std::optional< TOOL_ACTION_GROUP >	m_group
	Optional group for the action to belong to.

const int	m_defaultHotKey
	Default hot key.

const int	m_defaultHotKeyAlt
	Default hot key alternate.

int	m_hotKey
	The current hotkey (post-user-settings-application).

int	m_hotKeyAlt
	The alternate hotkey (post-user-settings-application).

const std::string	m_legacyName
	Name for reading legacy hotkey settings.

wxString	m_friendlyName
	User-friendly name.

std::optional< wxString >	m_menuLabel
	Menu label.

wxString	m_tooltip
	User facing tooltip help text.

std::optional< wxString >	m_description
	Description of the action.

BITMAPS	m_icon
	Icon for the menu entry.

int	m_id
	Unique ID for maps. Assigned by ACTION_MANAGER.

std::optional< int >	m_uiid
	ID to use when interacting with the UI (if empty, generate one).

TOOL_ACTION_FLAGS	m_flags

ki::any	m_param
	Generic parameter.

Static Protected Attributes
static constexpr int	ACTION_BASE_UI_ID = 20000
	Base ID to use inside the user interface system to offset the action IDs.

Detailed Description

Definition at line 32 of file hotkey_store.cpp.

Constructor & Destructor Documentation

◆ PSEUDO_ACTION()

PSEUDO_ACTION::PSEUDO_ACTION	(	const wxString &	aLabel,
		int	aHotKey,
		int	aHotKeyAlt = `0`
	)

inline

Definition at line 35 of file hotkey_store.cpp.

References TOOL_ACTION::m_friendlyName, TOOL_ACTION::m_hotKey, and TOOL_ACTION::m_hotKeyAlt.

Member Function Documentation

◆ GetActionGroup()

const std::optional< TOOL_ACTION_GROUP > TOOL_ACTION::GetActionGroup ( ) const

inlineinherited

Definition at line 394 of file tool_action.h.

References TOOL_ACTION::m_group.

◆ GetBaseUIId()

static int TOOL_ACTION::GetBaseUIId ( )

inlinestaticinherited

Get the base value used to offset the user interface IDs for the actions.

Definition at line 344 of file tool_action.h.

References TOOL_ACTION::ACTION_BASE_UI_ID.

Referenced by ACTION_GROUP::GetUIId(), ACTION_MANAGER::IsActionUIId(), and ACTION_TOOLBAR::onToolEvent().

◆ GetButtonTooltip()

wxString TOOL_ACTION::GetButtonTooltip ( ) const

inherited

Definition at line 186 of file tool_action.cpp.

References TOOL_ACTION::GetFriendlyName(), TOOL_ACTION::GetHotKey(), TOOL_ACTION::GetTooltip(), and KeyNameFromKeyCode().

Referenced by ACTION_TOOLBAR::Add(), ACTION_TOOLBAR_PALETTE::AddAction(), ACTION_TOOLBAR::AddButton(), and ACTION_TOOLBAR::doSelectAction().

◆ GetDefaultHotKey()

int TOOL_ACTION::GetDefaultHotKey ( ) const

inlineinherited

Return the default hotkey (if any) for the action.

Definition at line 307 of file tool_action.h.

References TOOL_ACTION::m_defaultHotKey.

◆ GetDefaultHotKeyAlt()

int TOOL_ACTION::GetDefaultHotKeyAlt ( ) const

inlineinherited

Definition at line 308 of file tool_action.h.

References TOOL_ACTION::m_defaultHotKeyAlt.

◆ GetDescription()

wxString TOOL_ACTION::GetDescription ( ) const

inherited

Definition at line 165 of file tool_action.cpp.

References TOOL_ACTION::GetTooltip(), and TOOL_ACTION::m_description.

Referenced by NL_3D_VIEWER_PLUGIN_IMPL::exportCommandsAndImages(), NL_SCHEMATIC_PLUGIN_IMPL::exportCommandsAndImages(), NL_PCBNEW_PLUGIN_IMPL::exportCommandsAndImages(), and NL_FOOTPRINT_PROPERTIES_PLUGIN_IMPL::exportCommandsAndImages().

◆ GetFriendlyName()

wxString TOOL_ACTION::GetFriendlyName ( ) const

inherited

Return the translated user-friendly name of the action.

Definition at line 139 of file tool_action.cpp.

References TOOL_ACTION::m_friendlyName.

Referenced by PANEL_KICAD_LAUNCHER::CreateLaunchers(), ALIGN_DISTRIBUTE_TOOL::DistributeItems(), TOOL_ACTION::GetButtonTooltip(), TOOL_ACTION::GetMenuLabel(), TOOLS_HOLDER::PushTool(), WIDGET_HOTKEY_LIST::resolveKeyConflicts(), and TOOLS_HOLDER::ShowChangedLanguage().

◆ GetHotKey()

int TOOL_ACTION::GetHotKey ( ) const

inlineinherited

Return the hotkey keycode which initiates the action.

Definition at line 313 of file tool_action.h.

References TOOL_ACTION::m_hotKey.

Referenced by APPEARANCE_CONTROLS::createControls(), TOOL_ACTION::GetButtonTooltip(), PCB_ONE_LAYER_SELECTOR::getLayerHotKey(), TOOL_ACTION::GetTooltip(), PANEL_GRID_SETTINGS::PANEL_GRID_SETTINGS(), APPEARANCE_CONTROLS::rebuildLayers(), APPEARANCE_CONTROLS::rebuildNets(), PCB_LAYER_BOX_SELECTOR::Resync(), and ACTION_MANAGER::UpdateHotKeys().

◆ GetHotKeyAlt()

int TOOL_ACTION::GetHotKeyAlt ( ) const

inlineinherited

Definition at line 314 of file tool_action.h.

References TOOL_ACTION::m_hotKeyAlt.

Referenced by ACTION_MANAGER::UpdateHotKeys().

◆ GetIcon()

BITMAPS TOOL_ACTION::GetIcon ( ) const

inlineinherited

Return an icon associated with the action.

It is used in context menu.

Definition at line 424 of file tool_action.h.

References TOOL_ACTION::m_icon.

Referenced by ACTION_MENU::Add(), ACTION_TOOLBAR::Add(), ACTION_TOOLBAR_PALETTE::AddAction(), ACTION_TOOLBAR::AddButton(), ACTION_TOOLBAR::AddGroup(), ACTION_TOOLBAR::doSelectAction(), NL_3D_VIEWER_PLUGIN_IMPL::exportCommandsAndImages(), NL_SCHEMATIC_PLUGIN_IMPL::exportCommandsAndImages(), NL_PCBNEW_PLUGIN_IMPL::exportCommandsAndImages(), and NL_FOOTPRINT_PROPERTIES_PLUGIN_IMPL::exportCommandsAndImages().

◆ GetId()

int TOOL_ACTION::GetId ( ) const

inlineinherited

Return the unique id of the TOOL_ACTION object.

It is valid only after registering the TOOL_ACTION by ACTION_MANAGER.

Returns: The unique identification number. If the number is negative, then it is not valid.

Definition at line 324 of file tool_action.h.

References TOOL_ACTION::m_id.

Referenced by CONDITIONAL_MENU::AddCheckItem(), CONDITIONAL_MENU::AddItem(), ACTION_MANAGER::GetCondition(), ACTION_MANAGER::GetHotKey(), APPEARANCE_CONTROLS::onNetclassContextMenu(), ACTION_MANAGER::SetConditions(), and ACTION_MANAGER::UpdateHotKeys().

◆ GetMenuItem()

wxString TOOL_ACTION::GetMenuItem ( ) const

inherited

Definition at line 157 of file tool_action.cpp.

References AddHotkeyName(), TOOL_ACTION::GetMenuLabel(), IS_HOTKEY, and TOOL_ACTION::m_hotKey.

Referenced by ACTION_MENU::Add().

◆ GetMenuLabel()

wxString TOOL_ACTION::GetMenuLabel ( ) const

inherited

Return the translated label for the action.

Definition at line 148 of file tool_action.cpp.

References TOOL_ACTION::GetFriendlyName(), and TOOL_ACTION::m_menuLabel.

Referenced by NL_3D_VIEWER_PLUGIN_IMPL::exportCommandsAndImages(), NL_SCHEMATIC_PLUGIN_IMPL::exportCommandsAndImages(), NL_PCBNEW_PLUGIN_IMPL::exportCommandsAndImages(), NL_FOOTPRINT_PROPERTIES_PLUGIN_IMPL::exportCommandsAndImages(), and TOOL_ACTION::GetMenuItem().

◆ GetName()

const std::string & TOOL_ACTION::GetName ( ) const

inlineinherited

Return name of the action.

It is the same one that is contained in TOOL_EVENT that is sent by activating the TOOL_ACTION. Convention is "app.tool.actionName".

Returns: Name of the action.

Definition at line 302 of file tool_action.h.

References TOOL_ACTION::m_name.

Referenced by TOOLS_HOLDER::CurrentToolName(), ACTION_TOOLBAR::doSelectAction(), NL_3D_VIEWER_PLUGIN_IMPL::exportCommandsAndImages(), NL_SCHEMATIC_PLUGIN_IMPL::exportCommandsAndImages(), NL_PCBNEW_PLUGIN_IMPL::exportCommandsAndImages(), NL_FOOTPRINT_PROPERTIES_PLUGIN_IMPL::exportCommandsAndImages(), HOTKEY_STORE::GetAppName(), TOOLS_HOLDER::IsCurrentTool(), ACTION_MANAGER::RegisterAction(), ACTION_MANAGER::RunHotKey(), NL_3D_VIEWER_PLUGIN_IMPL::SetActiveCommand(), NL_SCHEMATIC_PLUGIN_IMPL::SetActiveCommand(), NL_PCBNEW_PLUGIN_IMPL::SetActiveCommand(), and ACTION_MANAGER::SetConditions().

◆ GetParam()

template<typename T >

T TOOL_ACTION::GetParam ( ) const

inlineinherited

Return a non-standard parameter assigned to the action.

Definition at line 372 of file tool_action.h.

References ki::any::has_value(), TOOL_ACTION::m_param, name, and ki::any::type().

◆ GetScope()

TOOL_ACTION_SCOPE TOOL_ACTION::GetScope ( ) const

inlineinherited

Definition at line 366 of file tool_action.h.

References TOOL_ACTION::m_scope.

Referenced by HOTKEY_STORE::CheckKeyConflicts().

◆ GetToolName()

std::string TOOL_ACTION::GetToolName ( ) const

inherited

Return name of the tool associated with the action.

It is basically the action name stripped of the last part (e.g. for "pcbnew.InteractiveDrawing.drawCircle" it is "pcbnew.InteractiveDrawing").

Definition at line 208 of file tool_action.cpp.

References TOOL_ACTION::m_name.

Referenced by HOTKEY_STORE::CheckKeyConflicts(), NL_3D_VIEWER_PLUGIN_IMPL::exportCommandsAndImages(), NL_SCHEMATIC_PLUGIN_IMPL::exportCommandsAndImages(), NL_PCBNEW_PLUGIN_IMPL::exportCommandsAndImages(), and NL_FOOTPRINT_PROPERTIES_PLUGIN_IMPL::exportCommandsAndImages().

◆ GetTooltip()

wxString TOOL_ACTION::GetTooltip ( bool aIncludeHotkey = true ) const

inherited

Definition at line 175 of file tool_action.cpp.

References TOOL_ACTION::GetHotKey(), KeyNameFromKeyCode(), and TOOL_ACTION::m_tooltip.

Referenced by ACTION_MENU::Add(), PANEL_KICAD_LAUNCHER::CreateLaunchers(), TOOL_ACTION::GetButtonTooltip(), and TOOL_ACTION::GetDescription().

◆ GetUIId()

int TOOL_ACTION::GetUIId ( ) const

inlineinherited

Get the unique ID for this action in the user interface system.

This can be either set to a specific ID during creation or computed by offsetting the action ID by ACTION_BASE_UI_ID.

Returns: The unique ID number for use in the user interface system.

Definition at line 339 of file tool_action.h.

References TOOL_ACTION::ACTION_BASE_UI_ID, TOOL_ACTION::m_id, and TOOL_ACTION::m_uiid.

Referenced by ACTION_MENU::Add(), ACTION_TOOLBAR::Add(), ACTION_TOOLBAR_PALETTE::AddAction(), ACTION_TOOLBAR::AddButton(), ACTION_TOOLBAR::AddToolContextMenu(), ACTION_TOOLBAR_PALETTE::CheckAction(), ACTION_TOOLBAR_PALETTE::EnableAction(), EDA_BASE_FRAME::HandleUpdateUIEvent(), ACTION_TOOLBAR::popupPalette(), ACTION_MANAGER::RegisterAction(), TOOLS_HOLDER::RegisterUIUpdateHandler(), ACTION_TOOLBAR::SetToolBitmap(), ACTION_TOOLBAR::Toggle(), and TOOLS_HOLDER::UnregisterUIUpdateHandler().

◆ HasCustomUIId()

bool TOOL_ACTION::HasCustomUIId ( ) const

inlineinherited

Return true if this action has a custom UI ID set.

Definition at line 329 of file tool_action.h.

References TOOL_ACTION::m_uiid.

Referenced by ACTION_MANAGER::RegisterAction().

◆ IsActivation()

bool TOOL_ACTION::IsActivation ( ) const

inlineinherited

Return true if the action is intended to activate a tool.

Definition at line 406 of file tool_action.h.

References AF_ACTIVATE, and TOOL_ACTION::m_flags.

Referenced by TOOL_ACTION::MakeEvent().

◆ IsNotification()

bool TOOL_ACTION::IsNotification ( ) const

inlineinherited

Return true if the action is a notification.

Definition at line 414 of file tool_action.h.

References AF_NOTIFY, and TOOL_ACTION::m_flags.

Referenced by TOOL_ACTION::MakeEvent().

◆ MakeEvent()

TOOL_EVENT TOOL_ACTION::MakeEvent ( ) const

inherited

Return the event associated with the action (i.e.

the event that will be sent after activating the action).

Definition at line 116 of file tool_action.cpp.

References ki::any::has_value(), TOOL_ACTION::IsActivation(), TOOL_ACTION::IsNotification(), TOOL_ACTION::m_group, TOOL_ACTION::m_name, TOOL_ACTION::m_param, TOOL_ACTION::m_scope, TOOL_EVENT::SetActionGroup(), TOOL_EVENT::SetParameter(), TA_ACTION, TA_ACTIVATE, TA_NONE, TC_COMMAND, and TC_MESSAGE.

Referenced by EE_SELECTION_TOOL::autostartEvent(), PCB_POINT_EDITOR::changeArcEditMode(), ALIGN_DISTRIBUTE_TOOL::DistributeItems(), TOOL_MANAGER::doRunAction(), TOOL_EVENT::IsAction(), SCH_EDIT_TOOL::JustifyText(), EDIT_TOOL::JustifyText(), EE_SELECTION_TOOL::Main(), PANEL_KICAD_LAUNCHER::onLauncherButtonClick(), ACTION_TOOLBAR::onPaletteEvent(), TOOLS_HOLDER::PopTool(), ROUTER_TOOL::setTransitions(), and BOARD_EDITOR_CONTROL::setTransitions().

◆ operator!=()

bool TOOL_ACTION::operator!= ( const TOOL_ACTION & aRhs ) const

inlineinherited

Definition at line 289 of file tool_action.h.

References TOOL_ACTION::m_id.

◆ operator==()

bool TOOL_ACTION::operator== ( const TOOL_ACTION & aRhs ) const

inlineinherited

Definition at line 284 of file tool_action.h.

References TOOL_ACTION::m_id.

◆ SetHotKey()

void TOOL_ACTION::SetHotKey	(	int	aKeycode,
		int	aKeycodeAlt = `0`
	)

inherited

Definition at line 201 of file tool_action.cpp.

References TOOL_ACTION::m_hotKey, and TOOL_ACTION::m_hotKeyAlt.

Referenced by ACTION_MANAGER::processHotKey(), HOTKEY_STORE::SaveAllHotkeys(), and TOOL_ACTION::TOOL_ACTION().

Member Data Documentation

◆ ACTION_BASE_UI_ID

constexpr int TOOL_ACTION::ACTION_BASE_UI_ID = 20000

staticconstexprprotectedinherited

Base ID to use inside the user interface system to offset the action IDs.

Definition at line 435 of file tool_action.h.

Referenced by TOOL_ACTION::GetBaseUIId(), and TOOL_ACTION::GetUIId().

◆ m_defaultHotKey

const int TOOL_ACTION::m_defaultHotKey

protectedinherited

Default hot key.

Definition at line 443 of file tool_action.h.

Referenced by TOOL_ACTION::GetDefaultHotKey(), and ACTION_MANAGER::processHotKey().

◆ m_defaultHotKeyAlt

const int TOOL_ACTION::m_defaultHotKeyAlt

protectedinherited

Default hot key alternate.

Definition at line 444 of file tool_action.h.

Referenced by TOOL_ACTION::GetDefaultHotKeyAlt().

◆ m_description

std::optional<wxString> TOOL_ACTION::m_description

protectedinherited

Description of the action.

Definition at line 454 of file tool_action.h.

Referenced by TOOL_ACTION::GetDescription(), and TOOL_ACTION::TOOL_ACTION().

◆ m_flags

TOOL_ACTION_FLAGS TOOL_ACTION::m_flags

protectedinherited

Definition at line 461 of file tool_action.h.

Referenced by TOOL_ACTION::IsActivation(), and TOOL_ACTION::IsNotification().

◆ m_friendlyName

wxString TOOL_ACTION::m_friendlyName

protectedinherited

User-friendly name.

Definition at line 451 of file tool_action.h.

Referenced by TOOL_ACTION::GetFriendlyName(), and PSEUDO_ACTION().

◆ m_group

std::optional<TOOL_ACTION_GROUP> TOOL_ACTION::m_group

protectedinherited

Optional group for the action to belong to.

Definition at line 441 of file tool_action.h.

Referenced by TOOL_ACTION::GetActionGroup(), TOOL_ACTION::MakeEvent(), and TOOL_ACTION::TOOL_ACTION().

◆ m_hotKey

int TOOL_ACTION::m_hotKey

protectedinherited

The current hotkey (post-user-settings-application).

Definition at line 445 of file tool_action.h.

Referenced by TOOL_ACTION::GetHotKey(), TOOL_ACTION::GetMenuItem(), ACTION_MANAGER::processHotKey(), PSEUDO_ACTION(), and TOOL_ACTION::SetHotKey().

◆ m_hotKeyAlt

int TOOL_ACTION::m_hotKeyAlt

protectedinherited

The alternate hotkey (post-user-settings-application).

Definition at line 448 of file tool_action.h.

Referenced by TOOL_ACTION::GetHotKeyAlt(), PSEUDO_ACTION(), and TOOL_ACTION::SetHotKey().

◆ m_icon

BITMAPS TOOL_ACTION::m_icon

protectedinherited

Icon for the menu entry.

Definition at line 456 of file tool_action.h.

Referenced by TOOL_ACTION::GetIcon().

◆ m_id

int TOOL_ACTION::m_id

protectedinherited

Unique ID for maps. Assigned by ACTION_MANAGER.

Definition at line 458 of file tool_action.h.

Referenced by TOOL_ACTION::GetId(), TOOL_ACTION::GetUIId(), TOOL_ACTION::operator!=(), and TOOL_ACTION::operator==().

◆ m_legacyName

const std::string TOOL_ACTION::m_legacyName

protectedinherited

Name for reading legacy hotkey settings.

Definition at line 449 of file tool_action.h.

Referenced by ACTION_MANAGER::processHotKey().

◆ m_menuLabel

std::optional<wxString> TOOL_ACTION::m_menuLabel

protectedinherited

Menu label.

Definition at line 452 of file tool_action.h.

Referenced by TOOL_ACTION::GetMenuLabel(), and TOOL_ACTION::TOOL_ACTION().

◆ m_name

std::string TOOL_ACTION::m_name

protectedinherited

Name of the action (convention is "app.tool.actionName")

Definition at line 438 of file tool_action.h.

Referenced by TOOL_ACTION::GetName(), TOOL_ACTION::GetToolName(), TOOL_ACTION::MakeEvent(), ACTION_MANAGER::processHotKey(), ACTION_MANAGER::RegisterAction(), and TOOL_ACTION::TOOL_ACTION().

◆ m_param

ki::any TOOL_ACTION::m_param

protectedinherited

Generic parameter.

Definition at line 462 of file tool_action.h.

Referenced by TOOL_ACTION::GetParam(), TOOL_ACTION::MakeEvent(), and TOOL_ACTION::TOOL_ACTION().

◆ m_scope

TOOL_ACTION_SCOPE TOOL_ACTION::m_scope

protectedinherited

Definition at line 439 of file tool_action.h.

Referenced by TOOL_ACTION::GetScope(), and TOOL_ACTION::MakeEvent().

◆ m_tooltip

wxString TOOL_ACTION::m_tooltip

protectedinherited

User facing tooltip help text.

Definition at line 453 of file tool_action.h.

Referenced by TOOL_ACTION::GetTooltip().

◆ m_uiid

std::optional<int> TOOL_ACTION::m_uiid

protectedinherited

ID to use when interacting with the UI (if empty, generate one).

Definition at line 459 of file tool_action.h.

Referenced by TOOL_ACTION::GetUIId(), TOOL_ACTION::HasCustomUIId(), and TOOL_ACTION::TOOL_ACTION().

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

hotkey_store.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PSEUDO_ACTION()

Member Function Documentation

◆ GetActionGroup()

◆ GetBaseUIId()

◆ GetButtonTooltip()

◆ GetDefaultHotKey()

◆ GetDefaultHotKeyAlt()

◆ GetDescription()

◆ GetFriendlyName()

◆ GetHotKey()

◆ GetHotKeyAlt()

◆ GetIcon()

◆ GetId()

◆ GetMenuItem()

◆ GetMenuLabel()

◆ GetName()

◆ GetParam()

◆ GetScope()

◆ GetToolName()

◆ GetTooltip()

◆ GetUIId()

◆ HasCustomUIId()

◆ IsActivation()

◆ IsNotification()

◆ MakeEvent()

◆ operator!=()

◆ operator==()

◆ SetHotKey()

Member Data Documentation

◆ ACTION_BASE_UI_ID

◆ m_defaultHotKey

◆ m_defaultHotKeyAlt

◆ m_description

◆ m_flags

◆ m_friendlyName

◆ m_group

◆ m_hotKey

◆ m_hotKeyAlt

◆ m_icon

◆ m_id

◆ m_legacyName

◆ m_menuLabel

◆ m_name

◆ m_param

◆ m_scope

◆ m_tooltip

◆ m_uiid