KiCad PCB EDA Suite
|
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... | |
Definition at line 32 of file hotkey_store.cpp.
|
inline |
Definition at line 35 of file hotkey_store.cpp.
References TOOL_ACTION::m_hotKey, and TOOL_ACTION::m_label.
|
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().
|
inlineinherited |
Return the default hotkey (if any) for the action.
Definition at line 106 of file tool_action.h.
References TOOL_ACTION::m_defaultHotKey.
|
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().
|
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().
|
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().
|
inlineinherited |
Return the unique id of the TOOL_ACTION object.
It is valid only after registering the TOOL_ACTION by ACTION_MANAGER.
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().
|
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().
|
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().
|
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".
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().
|
inlineinherited |
Definition at line 162 of file tool_action.h.
References TOOL_ACTION::m_param.
|
inlineinherited |
Definition at line 160 of file tool_action.h.
References TOOL_ACTION::m_scope.
Referenced by HOTKEY_STORE::CheckKeyConflicts().
|
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().
|
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().
|
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().
|
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().
|
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().
|
inlineinherited |
Definition at line 88 of file tool_action.h.
References TOOL_ACTION::m_id.
|
inlineinherited |
Definition at line 83 of file tool_action.h.
References TOOL_ACTION::m_id.
|
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().
|
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().
|
protectedinherited |
Definition at line 209 of file tool_action.h.
Referenced by TOOL_ACTION::GetDefaultHotKey(), and ACTION_MANAGER::processHotKey().
|
protectedinherited |
Definition at line 219 of file tool_action.h.
Referenced by TOOL_ACTION::IsActivation(), and TOOL_ACTION::IsNotification().
|
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().
|
protectedinherited |
Definition at line 215 of file tool_action.h.
Referenced by TOOL_ACTION::GetIcon().
|
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==().
|
protectedinherited |
Definition at line 213 of file tool_action.h.
Referenced by TOOL_ACTION::GetLabel(), TOOL_ACTION::GetMenuItem(), and PSEUDO_ACTION().
|
protectedinherited |
Definition at line 211 of file tool_action.h.
Referenced by ACTION_MANAGER::processHotKey().
|
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().
|
protectedinherited |
Definition at line 220 of file tool_action.h.
Referenced by TOOL_ACTION::GetParam(), TOOL_ACTION::GetUIId(), and TOOL_ACTION::MakeEvent().
|
protectedinherited |
Definition at line 207 of file tool_action.h.
Referenced by TOOL_ACTION::GetScope(), and TOOL_ACTION::MakeEvent().
|
protectedinherited |
Definition at line 214 of file tool_action.h.
Referenced by TOOL_ACTION::GetDescription().