KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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 GetDefaultHotKeyAlt () const
 
int GetHotKey () const
 Return the hotkey keycode which initiates the action. More...
 
int GetHotKeyAlt () const
 
void SetHotKey (int aKeycode, int aKeycodeAlt=0)
 
int GetId () const
 Return the unique id of the TOOL_ACTION object. More...
 
bool HasCustomUIId () const
 Return true if this action has a custom UI ID set. More...
 
int GetUIId () const
 
TOOL_EVENT MakeEvent () const
 Return the event associated with the action (i.e. More...
 
wxString GetMenuLabel () const
 Return the translated label for the action. More...
 
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. More...
 
TOOL_ACTION_SCOPE GetScope () const
 
template<typename T >
GetParam () const
 Return a non-standard parameter assigned to the action. More...
 
const std::optional< TOOL_ACTION_GROUPGetActionGroup () 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
 
std::optional< TOOL_ACTION_GROUPm_group
 
const int m_defaultHotKey
 
const int m_defaultHotKeyAlt
 
int m_hotKey
 
int m_hotKeyAlt
 
const std::string m_legacyName
 
wxString m_friendlyName
 
std::optional< wxString > m_menuLabel
 
wxString m_tooltip
 
std::optional< wxString > m_description
 
BITMAPS m_icon
 
int m_id
 
std::optional< int > m_uiid
 
TOOL_ACTION_FLAGS m_flags
 
std::any 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_friendlyName, and TOOL_ACTION::m_hotKey.

Member Function Documentation

◆ GetActionGroup()

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

Definition at line 392 of file tool_action.h.

References TOOL_ACTION::m_group.

◆ GetBaseUIId()

static int TOOL_ACTION::GetBaseUIId ( )
inlinestaticinherited

◆ GetButtonTooltip()

wxString TOOL_ACTION::GetButtonTooltip ( ) const
inherited

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

◆ GetFriendlyName()

wxString TOOL_ACTION::GetFriendlyName ( ) const
inherited

◆ GetHotKey()

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

◆ 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

◆ GetMenuLabel()

wxString TOOL_ACTION::GetMenuLabel ( ) const
inherited

◆ GetName()

◆ 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 TOOL_ACTION::m_param, and name.

◆ 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(), and NL_PCBNEW_PLUGIN_IMPL::exportCommandsAndImages().

◆ GetTooltip()

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

◆ GetUIId()

◆ 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 404 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 412 of file tool_action.h.

References AF_NOTIFY, and TOOL_ACTION::m_flags.

Referenced by TOOL_ACTION::MakeEvent().

◆ MakeEvent()

◆ 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

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

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

◆ m_defaultHotKeyAlt

const int TOOL_ACTION::m_defaultHotKeyAlt
protectedinherited

Definition at line 442 of file tool_action.h.

Referenced by TOOL_ACTION::GetDefaultHotKeyAlt().

◆ m_description

std::optional<wxString> TOOL_ACTION::m_description
protectedinherited

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

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

◆ m_friendlyName

wxString TOOL_ACTION::m_friendlyName
protectedinherited

Definition at line 447 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

◆ m_hotKey

int TOOL_ACTION::m_hotKey
protectedinherited

◆ m_hotKeyAlt

int TOOL_ACTION::m_hotKeyAlt
protectedinherited

Definition at line 444 of file tool_action.h.

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

◆ m_icon

BITMAPS TOOL_ACTION::m_icon
protectedinherited

Definition at line 452 of file tool_action.h.

Referenced by TOOL_ACTION::GetIcon().

◆ m_id

int TOOL_ACTION::m_id
protectedinherited

◆ m_legacyName

const std::string TOOL_ACTION::m_legacyName
protectedinherited

Definition at line 445 of file tool_action.h.

Referenced by ACTION_MANAGER::processHotKey().

◆ m_menuLabel

std::optional<wxString> TOOL_ACTION::m_menuLabel
protectedinherited

Definition at line 448 of file tool_action.h.

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

◆ m_name

◆ m_param

std::any TOOL_ACTION::m_param
protectedinherited

◆ m_scope

TOOL_ACTION_SCOPE TOOL_ACTION::m_scope
protectedinherited

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

Referenced by TOOL_ACTION::GetTooltip().

◆ m_uiid

std::optional<int> TOOL_ACTION::m_uiid
protectedinherited

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