KiCad PCB EDA Suite
PSEUDO_ACTION Class Reference
Inheritance diagram for PSEUDO_ACTION:
TOOL_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...
 
const 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.

36  {
37  m_label = aLabel;
38  m_hotKey = aHotKey;
39  }
wxString m_label
Definition: tool_action.h:200

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

Member Function Documentation

◆ GetBaseUIId()

static int TOOL_ACTION::GetBaseUIId ( )
inlinestaticinherited

Definition at line 135 of file tool_action.h.

135 { 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:190

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.

106 { return m_defaultHotKey; }
const int m_defaultHotKey
Definition: tool_action.h:196

References TOOL_ACTION::m_defaultHotKey.

◆ GetDescription()

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

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 }
wxString m_tooltip
Definition: tool_action.h:201
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
wxString KeyNameFromKeyCode(int aKeycode, bool *aIsFound)
Return the key name from the key code.
int GetHotKey() const
Return the hotkey keycode which initiates the action.
Definition: tool_action.h:111

References Format(), 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(), and ACTION_TOOLBAR::doSelectAction().

◆ GetHotKey()

int TOOL_ACTION::GetHotKey ( ) const
inlineinherited

◆ GetIcon()

const BITMAPS TOOL_ACTION::GetIcon ( ) const
inlineinherited

Return an icon associated with the action.

It is used in context menu.

Definition at line 179 of file tool_action.h.

180  {
181  return m_icon;
182  }
BITMAPS m_icon
Definition: tool_action.h:202

References TOOL_ACTION::m_icon.

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

◆ GetId()

int TOOL_ACTION::GetId ( ) const
inlineinherited

◆ GetLabel()

wxString TOOL_ACTION::GetLabel ( ) const
inherited

◆ GetMenuItem()

wxString TOOL_ACTION::GetMenuItem ( ) const
inherited

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 m_label
Definition: tool_action.h:200
wxString AddHotkeyName(const wxString &aText, int aHotKey, HOTKEY_ACTION_TYPE aStyle)

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 ( void  ) 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.

101 { return m_name; }
std::string m_name
Definition: tool_action.h:193

References TOOL_ACTION::m_name.

Referenced by ACTION_TOOLBAR::doSelectAction(), HOTKEY_STORE::GetAppName(), TOOL_EVENT::IsCancelInteractive(), TOOLS_HOLDER::IsCurrentTool(), ACTION_MANAGER::RegisterAction(), ACTION_MANAGER::RunHotKey(), and ACTION_MANAGER::SetConditions().

◆ GetParam()

void* TOOL_ACTION::GetParam ( ) const
inlineinherited

Definition at line 149 of file tool_action.h.

149 { return m_param; }
void * m_param
Definition: tool_action.h:207

References TOOL_ACTION::m_param.

◆ GetScope()

TOOL_ACTION_SCOPE TOOL_ACTION::GetScope ( ) const
inlineinherited

Definition at line 147 of file tool_action.h.

147 { return m_scope; }
TOOL_ACTION_SCOPE m_scope
Definition: tool_action.h:194

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.

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 }
std::string m_name
Definition: tool_action.h:193

References TOOL_ACTION::m_name.

Referenced by HOTKEY_STORE::CheckKeyConflicts().

◆ GetUIId()

◆ IsActivation()

bool TOOL_ACTION::IsActivation ( ) const
inlineinherited

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

Definition at line 161 of file tool_action.h.

162  {
163  return m_flags & AF_ACTIVATE;
164  }
Action activates a tool.
Definition: tool_action.h:52
TOOL_ACTION_FLAGS m_flags
Definition: tool_action.h:206

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 169 of file tool_action.h.

170  {
171  return m_flags & AF_NOTIFY;
172  }
TOOL_ACTION_FLAGS m_flags
Definition: tool_action.h:206
Action is a notification (it is by default passed to all tools)
Definition: tool_action.h:53

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.

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:161
std::string m_name
Definition: tool_action.h:193
TOOL_ACTION_SCOPE m_scope
Definition: tool_action.h:194
Generic, UI-independent tool event.
Definition: tool_event.h:152
bool IsNotification() const
Return true if the action is a notification.
Definition: tool_action.h:169
void * m_param
Definition: tool_action.h:207

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 PANEL_KICAD_LAUNCHER::CreateLaunchers(), EDIT_TOOL::Duplicate(), TOOL_EVENT::IsAction(), EE_SELECTION_TOOL::Main(), ACTION_TOOLBAR::onPaletteEvent(), DIALOG_SCH_FIND::OnReplace(), 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.

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

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.

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

References TOOL_ACTION::m_id.

◆ SetHotKey()

void TOOL_ACTION::SetHotKey ( int  aKeycode)
inherited

Definition at line 108 of file tool_action.cpp.

109 {
110  m_hotKey = aKeycode;
111 }

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
staticprotectedinherited

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

Definition at line 190 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 196 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 206 of file tool_action.h.

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

◆ m_hotKey

int TOOL_ACTION::m_hotKey
protectedinherited

◆ m_icon

BITMAPS TOOL_ACTION::m_icon
protectedinherited

Definition at line 202 of file tool_action.h.

Referenced by TOOL_ACTION::GetIcon().

◆ m_id

int TOOL_ACTION::m_id
protectedinherited

◆ m_label

wxString TOOL_ACTION::m_label
protectedinherited

Definition at line 200 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 198 of file tool_action.h.

Referenced by ACTION_MANAGER::processHotKey().

◆ m_name

std::string TOOL_ACTION::m_name
protectedinherited

◆ m_param

void* TOOL_ACTION::m_param
protectedinherited

Definition at line 207 of file tool_action.h.

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

◆ m_scope

TOOL_ACTION_SCOPE TOOL_ACTION::m_scope
protectedinherited

Definition at line 194 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 201 of file tool_action.h.

Referenced by TOOL_ACTION::GetDescription().


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