Inheritance diagram for PSEUDO_ACTION:

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

bool	operator== (const TOOL_ACTION &aRhs) const

bool	operator!= (const TOOL_ACTION &aRhs) const

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

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

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

void	SetHotKey (int aKeycode)

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

int	GetUIId () const

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

wxString	GetLabel () const

wxString	GetMenuItem () const

wxString	GetDescription (bool aIncludeHotkey=true) const

TOOL_ACTION_SCOPE	GetScope () const

void *	GetParam () const

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

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

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

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

Static Public Member Functions
static int	GetBaseUIId ()

Protected Attributes
std::string	m_name

TOOL_ACTION_SCOPE	m_scope

const int	m_defaultHotKey

int	m_hotKey

const std::string	m_legacyName

wxString	m_label

wxString	m_tooltip

BITMAPS	m_icon

int	m_id

TOOL_ACTION_FLAGS	m_flags

void *	m_param

Static Protected Attributes
static constexpr int	ACTION_BASE_UI_ID = 20000
	Name of the action (convention is "app.tool.actionName") More...

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
	)

inline

Definition at line 35 of file hotkey_store.cpp.

References TOOL_ACTION::m_hotKey, and TOOL_ACTION::m_label.

Member Function Documentation

◆ GetBaseUIId()

static int TOOL_ACTION::GetBaseUIId ( )

inlinestaticinherited

Definition at line 148 of file tool_action.h.

References TOOL_ACTION::ACTION_BASE_UI_ID.

Referenced by ACTION_GROUP::GetUIId(), ACTION_MENU::OnMenuEvent(), and ACTION_TOOLBAR::onToolEvent().

◆ GetDefaultHotKey()

int TOOL_ACTION::GetDefaultHotKey ( ) const

inlineinherited

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

Definition at line 106 of file tool_action.h.

References TOOL_ACTION::m_defaultHotKey.

◆ GetDescription()

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

inherited

Definition at line 97 of file tool_action.cpp.

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

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

◆ GetHotKey()

int TOOL_ACTION::GetHotKey ( ) const

inlineinherited

Return the hotkey keycode which initiates the action.

Definition at line 111 of file tool_action.h.

References TOOL_ACTION::m_hotKey.

Referenced by APPEARANCE_CONTROLS::createControls(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), PAD_TOOL::EditPad(), TOOL_ACTION::GetDescription(), APPEARANCE_CONTROLS::rebuildLayers(), APPEARANCE_CONTROLS::rebuildNets(), PCB_LAYER_BOX_SELECTOR::Resync(), and 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 192 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(), and NL_PCBNEW_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 121 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().

◆ GetLabel()

wxString TOOL_ACTION::GetLabel ( ) const

inherited

Definition at line 83 of file tool_action.cpp.

References TOOL_ACTION::m_label.

Referenced by PANEL_KICAD_LAUNCHER::CreateLaunchers(), NL_3D_VIEWER_PLUGIN_IMPL::exportCommandsAndImages(), NL_SCHEMATIC_PLUGIN_IMPL::exportCommandsAndImages(), NL_PCBNEW_PLUGIN_IMPL::exportCommandsAndImages(), TOOLS_HOLDER::PushTool(), WIDGET_HOTKEY_LIST::resolveKeyConflicts(), and TOOLS_HOLDER::ShowChangedLanguage().

◆ GetMenuItem()

wxString TOOL_ACTION::GetMenuItem ( ) const

inherited

Definition at line 89 of file tool_action.cpp.

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

Referenced by ACTION_MENU::Add().

◆ 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 101 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(), 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()

void * TOOL_ACTION::GetParam ( ) const

inlineinherited

Definition at line 162 of file tool_action.h.

References TOOL_ACTION::m_param.

◆ GetScope()

TOOL_ACTION_SCOPE TOOL_ACTION::GetScope ( ) const

inlineinherited

Definition at line 160 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 114 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(), and NL_PCBNEW_PLUGIN_IMPL::exportCommandsAndImages().

◆ GetUIId()

int TOOL_ACTION::GetUIId ( ) const

inlineinherited

Definition at line 130 of file tool_action.h.

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

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(), TOOLS_HOLDER::RegisterUIUpdateHandler(), ACTION_TOOLBAR::SetToolBitmap(), ACTION_TOOLBAR::Toggle(), and TOOLS_HOLDER::UnregisterUIUpdateHandler().

◆ IsActivation()

bool TOOL_ACTION::IsActivation ( ) const

inlineinherited

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

Definition at line 174 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 182 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 72 of file tool_action.cpp.

References TOOL_ACTION::IsActivation(), TOOL_ACTION::IsNotification(), TOOL_ACTION::m_name, TOOL_ACTION::m_param, TOOL_ACTION::m_scope, TA_ACTION, TA_ACTIVATE, TA_NONE, TC_COMMAND, and TC_MESSAGE.

Referenced by EE_SELECTION_TOOL::autostartEvent(), PCB_POINT_EDITOR::changeArcEditMode(), PANEL_KICAD_LAUNCHER::CreateLaunchers(), EDIT_TOOL::Duplicate(), TOOL_EVENT::IsAction(), EE_SELECTION_TOOL::Main(), ACTION_TOOLBAR::onPaletteEvent(), EDIT_TOOL::pickReferencePoint(), TOOLS_HOLDER::PopTool(), TOOL_MANAGER::RunAction(), ROUTER_TOOL::setTransitions(), and BOARD_EDITOR_CONTROL::setTransitions().

◆ operator!=()

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

inlineinherited

Definition at line 88 of file tool_action.h.

References TOOL_ACTION::m_id.

◆ operator==()

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

inlineinherited

Definition at line 83 of file tool_action.h.

References TOOL_ACTION::m_id.

◆ SetHotKey()

void TOOL_ACTION::SetHotKey ( int aKeycode )

inherited

Definition at line 108 of file tool_action.cpp.

References TOOL_ACTION::m_hotKey.

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

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

Definition at line 203 of file tool_action.h.

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

◆ m_defaultHotKey

const int TOOL_ACTION::m_defaultHotKey

protectedinherited

Definition at line 209 of file tool_action.h.

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

◆ m_flags

TOOL_ACTION_FLAGS TOOL_ACTION::m_flags

protectedinherited

Definition at line 219 of file tool_action.h.

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

◆ m_hotKey

int TOOL_ACTION::m_hotKey

protectedinherited

Definition at line 210 of file tool_action.h.

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

◆ m_icon

BITMAPS TOOL_ACTION::m_icon

protectedinherited

Definition at line 215 of file tool_action.h.

Referenced by TOOL_ACTION::GetIcon().

◆ m_id

int TOOL_ACTION::m_id

protectedinherited

Definition at line 217 of file tool_action.h.

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

◆ m_label

wxString TOOL_ACTION::m_label

protectedinherited

Definition at line 213 of file tool_action.h.

Referenced by TOOL_ACTION::GetLabel(), TOOL_ACTION::GetMenuItem(), and PSEUDO_ACTION().

◆ m_legacyName

const std::string TOOL_ACTION::m_legacyName

protectedinherited

Definition at line 211 of file tool_action.h.

Referenced by ACTION_MANAGER::processHotKey().

◆ m_name

std::string TOOL_ACTION::m_name

protectedinherited

Definition at line 206 of file tool_action.h.

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

◆ m_param

void* TOOL_ACTION::m_param

protectedinherited

Definition at line 220 of file tool_action.h.

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

◆ m_scope

TOOL_ACTION_SCOPE TOOL_ACTION::m_scope

protectedinherited

Definition at line 207 of file tool_action.h.

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

◆ m_tooltip

wxString TOOL_ACTION::m_tooltip

protectedinherited

Definition at line 214 of file tool_action.h.

Referenced by TOOL_ACTION::GetDescription().

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

◆ GetBaseUIId()

◆ GetDefaultHotKey()

◆ GetDescription()

◆ GetHotKey()

◆ GetIcon()

◆ GetId()

◆ GetLabel()

◆ GetMenuItem()

◆ GetName()

◆ GetParam()

◆ GetScope()

◆ GetToolName()

◆ GetUIId()

◆ IsActivation()

◆ IsNotification()

◆ MakeEvent()

◆ operator!=()

◆ operator==()

◆ SetHotKey()

Member Data Documentation

◆ ACTION_BASE_UI_ID

◆ m_defaultHotKey

◆ m_flags

◆ m_hotKey

◆ m_icon

◆ m_id

◆ m_label

◆ m_legacyName

◆ m_name

◆ m_param

◆ m_scope

◆ m_tooltip