KiCad PCB EDA Suite
TOOL_ACTION Class Reference

Represent a single user action. More...

#include <tool_action.h>

Inheritance diagram for TOOL_ACTION:
PSEUDO_ACTION

Public Member Functions

 TOOL_ACTION (const std::string &aName, TOOL_ACTION_SCOPE aScope=AS_CONTEXT, int aDefaultHotKey=0, const std::string &aLegacyHotKeyName="", const wxString &aMenuText=wxEmptyString, const wxString &aTooltip=wxEmptyString, BITMAPS aIcon=static_cast< BITMAPS >(0), TOOL_ACTION_FLAGS aFlags=AF_NONE, void *aParam=nullptr)
 
 ~TOOL_ACTION ()
 
 TOOL_ACTION (const TOOL_ACTION &)=delete
 
TOOL_ACTIONoperator= (const TOOL_ACTION &)=delete
 
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...
 
const BITMAPS GetIcon () const
 Return an icon associated with the action. More...
 

Static Public Member Functions

static int GetBaseUIId ()
 

Protected Member Functions

 TOOL_ACTION ()
 

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...
 

Friends

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

Detailed Description

Represent a single user action.

For instance:

  • changing layer to top by pressing PgUp
  • running the DRC from the menu and so on, and so forth....

Action class groups all necessary properties of an action, including explanation, icons, hotkeys, menu items, etc.

Definition at line 67 of file tool_action.h.

Constructor & Destructor Documentation

◆ TOOL_ACTION() [1/3]

TOOL_ACTION::TOOL_ACTION ( const std::string &  aName,
TOOL_ACTION_SCOPE  aScope = AS_CONTEXT,
int  aDefaultHotKey = 0,
const std::string &  aLegacyHotKeyName = "",
const wxString &  aMenuText = wxEmptyString,
const wxString &  aTooltip = wxEmptyString,
BITMAPS  aIcon = static_cast<BITMAPS>( 0 ),
TOOL_ACTION_FLAGS  aFlags = AF_NONE,
void *  aParam = nullptr 
)

Definition at line 34 of file tool_action.cpp.

37 :
38 m_name( aName ),
39 m_scope( aScope ),
40 m_defaultHotKey( aDefaultHotKey ),
41 m_legacyName( aLegacyHotKeyName ),
42 m_label( aLabel ),
43 m_tooltip( aTooltip ),
44 m_icon( aIcon ),
45 m_id( -1 ),
46 m_flags( aFlags ),
47 m_param( aParam )
48{
49 SetHotKey( aDefaultHotKey );
50 ACTION_MANAGER::GetActionList().push_back( this );
51}
static std::list< TOOL_ACTION * > & GetActionList()
Return list of TOOL_ACTIONs.
TOOL_ACTION_SCOPE m_scope
Definition: tool_action.h:207
void SetHotKey(int aKeycode)
TOOL_ACTION_FLAGS m_flags
Definition: tool_action.h:219
BITMAPS m_icon
Definition: tool_action.h:215
wxString m_label
Definition: tool_action.h:213
wxString m_tooltip
Definition: tool_action.h:214
const int m_defaultHotKey
Definition: tool_action.h:209
const std::string m_legacyName
Definition: tool_action.h:211
std::string m_name
Definition: tool_action.h:206
void * m_param
Definition: tool_action.h:220

References ACTION_MANAGER::GetActionList(), and SetHotKey().

◆ ~TOOL_ACTION()

TOOL_ACTION::~TOOL_ACTION ( )

Definition at line 66 of file tool_action.cpp.

67{
68 ACTION_MANAGER::GetActionList().remove( this );
69}

References ACTION_MANAGER::GetActionList().

◆ TOOL_ACTION() [2/3]

TOOL_ACTION::TOOL_ACTION ( const TOOL_ACTION )
delete

◆ TOOL_ACTION() [3/3]

TOOL_ACTION::TOOL_ACTION ( )
protected

Definition at line 54 of file tool_action.cpp.

54 :
56 m_defaultHotKey( 0 ),
58 m_id( -1 ),
60 m_param( nullptr )
61{
62 SetHotKey( 0 );
63}
@ INVALID_BITMAP
@ AS_GLOBAL
Global action (toolbar/main menu event, global shortcut)
Definition: tool_action.h:45
@ AF_NONE
Definition: tool_action.h:51

References INVALID_BITMAP, and SetHotKey().

Member Function Documentation

◆ GetBaseUIId()

static int TOOL_ACTION::GetBaseUIId ( )
inlinestatic

Definition at line 148 of file tool_action.h.

148{ return ACTION_BASE_UI_ID; }
static constexpr int ACTION_BASE_UI_ID
Name of the action (convention is "app.tool.actionName")
Definition: tool_action.h:203

References ACTION_BASE_UI_ID.

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

◆ GetDefaultHotKey()

int TOOL_ACTION::GetDefaultHotKey ( ) const
inline

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

Definition at line 106 of file tool_action.h.

106{ return m_defaultHotKey; }

References m_defaultHotKey.

◆ GetDescription()

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

Definition at line 97 of file tool_action.cpp.

98{
99 wxString tooltip = wxGetTranslation( m_tooltip );
100
101 if( aIncludeHotkey && GetHotKey() )
102 tooltip += wxString::Format( wxT( " (%s)" ), KeyNameFromKeyCode( GetHotKey() ) );
103
104 return tooltip;
105}
int GetHotKey() const
Return the hotkey keycode which initiates the action.
Definition: tool_action.h:111
wxString KeyNameFromKeyCode(int aKeycode, bool *aIsFound)
Return the key name from the key code.
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

References Format(), GetHotKey(), KeyNameFromKeyCode(), and 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
inline

◆ GetIcon()

◆ GetId()

int TOOL_ACTION::GetId ( ) const
inline

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.

121{ return m_id; }

References 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()

◆ GetMenuItem()

wxString TOOL_ACTION::GetMenuItem ( ) const

Definition at line 89 of file tool_action.cpp.

90{
91 wxString label = wxGetTranslation( m_label );
92 label.Replace( "&", "&&" );
93 return AddHotkeyName( label, m_hotKey, IS_HOTKEY );
94}
wxString AddHotkeyName(const wxString &aText, int aHotKey, HOTKEY_ACTION_TYPE aStyle)
@ IS_HOTKEY
Definition: hotkeys_basic.h:77

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

Referenced by ACTION_MENU::Add().

◆ GetName()

◆ GetParam()

void * TOOL_ACTION::GetParam ( ) const
inline

Definition at line 162 of file tool_action.h.

162{ return m_param; }

References m_param.

◆ GetScope()

TOOL_ACTION_SCOPE TOOL_ACTION::GetScope ( ) const
inline

Definition at line 160 of file tool_action.h.

160{ return m_scope; }

References m_scope.

Referenced by HOTKEY_STORE::CheckKeyConflicts().

◆ GetToolName()

std::string TOOL_ACTION::GetToolName ( ) const

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.

115{
116 int dotCount = std::count( m_name.begin(), m_name.end(), '.' );
117
118 switch( dotCount )
119 {
120 case 0:
121 assert( false ); // Invalid action name format
122 return "";
123
124 case 1:
125 return m_name;
126
127 case 2:
128 return m_name.substr( 0, m_name.rfind( '.' ) );
129
130 default:
131 assert( false ); // TODO not implemented
132 return "";
133 }
134}

References 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
inline

Definition at line 130 of file tool_action.h.

131 {
132 // Hack for wxWidgets' use in stuff like search controls in standard file dialogs. If
133 // it doesn't find these specific IDs somewhere in the menus then it won't enable
134 // cut/copy/paste.
135 if( m_param == (void*) wxID_CUT )
136 return wxID_CUT;
137 else if( m_param == (void*) wxID_COPY )
138 return wxID_COPY;
139 else if( m_param == (void*) wxID_PASTE )
140 return wxID_PASTE;
141
142 return m_id + ACTION_BASE_UI_ID;
143 }

References ACTION_BASE_UI_ID, m_id, and 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
inline

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

Definition at line 174 of file tool_action.h.

175 {
176 return m_flags & AF_ACTIVATE;
177 }
@ AF_ACTIVATE
Action activates a tool.
Definition: tool_action.h:52

References AF_ACTIVATE, and m_flags.

Referenced by MakeEvent().

◆ IsNotification()

bool TOOL_ACTION::IsNotification ( ) const
inline

Return true if the action is a notification.

Definition at line 182 of file tool_action.h.

183 {
184 return m_flags & AF_NOTIFY;
185 }
@ AF_NOTIFY
Action is a notification (it is by default passed to all tools)
Definition: tool_action.h:53

References AF_NOTIFY, and m_flags.

Referenced by MakeEvent().

◆ MakeEvent()

TOOL_EVENT TOOL_ACTION::MakeEvent ( ) const

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.

73{
74 if( IsActivation() )
76 else if( IsNotification() )
78 else
80}
bool IsActivation() const
Return true if the action is intended to activate a tool.
Definition: tool_action.h:174
bool IsNotification() const
Return true if the action is a notification.
Definition: tool_action.h:182
Generic, UI-independent tool event.
Definition: tool_event.h:156
@ TA_ACTIVATE
Definition: tool_event.h:110
@ TA_ACTION
Definition: tool_event.h:107
@ TA_NONE
Definition: tool_event.h:61
@ TC_COMMAND
Definition: tool_event.h:52
@ TC_MESSAGE
Definition: tool_event.h:53

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

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

◆ operator!=()

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

Definition at line 88 of file tool_action.h.

89 {
90 return m_id != aRhs.m_id;
91 }

References m_id.

◆ operator=()

TOOL_ACTION & TOOL_ACTION::operator= ( const TOOL_ACTION )
delete

◆ operator==()

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

Definition at line 83 of file tool_action.h.

84 {
85 return m_id == aRhs.m_id;
86 }

References m_id.

◆ SetHotKey()

void TOOL_ACTION::SetHotKey ( int  aKeycode)

Definition at line 108 of file tool_action.cpp.

109{
110 m_hotKey = aKeycode;
111}

References m_hotKey.

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

Friends And Related Function Documentation

◆ ACTION_MANAGER

friend class ACTION_MANAGER
friend

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

Definition at line 200 of file tool_action.h.

Member Data Documentation

◆ ACTION_BASE_UI_ID

constexpr int TOOL_ACTION::ACTION_BASE_UI_ID = 20000
staticconstexprprotected

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

Definition at line 203 of file tool_action.h.

Referenced by GetBaseUIId(), and GetUIId().

◆ m_defaultHotKey

const int TOOL_ACTION::m_defaultHotKey
protected

Definition at line 209 of file tool_action.h.

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

◆ m_flags

TOOL_ACTION_FLAGS TOOL_ACTION::m_flags
protected

Definition at line 219 of file tool_action.h.

Referenced by IsActivation(), and IsNotification().

◆ m_hotKey

int TOOL_ACTION::m_hotKey
protected

◆ m_icon

BITMAPS TOOL_ACTION::m_icon
protected

Definition at line 215 of file tool_action.h.

Referenced by GetIcon().

◆ m_id

int TOOL_ACTION::m_id
protected

Definition at line 217 of file tool_action.h.

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

◆ m_label

wxString TOOL_ACTION::m_label
protected

Definition at line 213 of file tool_action.h.

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

◆ m_legacyName

const std::string TOOL_ACTION::m_legacyName
protected

Definition at line 211 of file tool_action.h.

Referenced by ACTION_MANAGER::processHotKey().

◆ m_name

std::string TOOL_ACTION::m_name
protected

◆ m_param

void* TOOL_ACTION::m_param
protected

Definition at line 220 of file tool_action.h.

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

◆ m_scope

TOOL_ACTION_SCOPE TOOL_ACTION::m_scope
protected

Definition at line 207 of file tool_action.h.

Referenced by GetScope(), and MakeEvent().

◆ m_tooltip

wxString TOOL_ACTION::m_tooltip
protected

Definition at line 214 of file tool_action.h.

Referenced by GetDescription().


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