KiCad PCB EDA Suite
ACTIONS Class Referenceabstract

ACTIONS. More...

#include <actions.h>

Inheritance diagram for ACTIONS:
CVPCB_ACTIONS EDA_3D_ACTIONS EE_ACTIONS GERBVIEW_ACTIONS KICAD_MANAGER_ACTIONS PCB_ACTIONS PL_ACTIONS TEST_ACTIONS

Public Types

enum  CURSOR_EVENT_TYPE {
  CURSOR_NONE, CURSOR_UP, CURSOR_DOWN, CURSOR_LEFT,
  CURSOR_RIGHT, CURSOR_CLICK, CURSOR_DBL_CLICK, CURSOR_RIGHT_CLICK,
  CURSOR_FAST_MOVE = 0x8000
}
 

Cursor control event types

More...
 
enum  REMOVE_FLAGS { REMOVE_FLAGS::NORMAL = 0x00, REMOVE_FLAGS::ALT = 0x01, REMOVE_FLAGS::CUT = 0x02 }
 

Remove event modifier flags

More...
 

Public Member Functions

virtual ~ACTIONS ()
 
virtual OPT< TOOL_EVENTTranslateLegacyId (int aId)=0
 Function TranslateLegacyId() Translates legacy tool ids to the corresponding TOOL_ACTION name. More...
 

Static Public Attributes

static TOOL_ACTION doNew
 
static TOOL_ACTION newLibrary
 
static TOOL_ACTION addLibrary
 
static TOOL_ACTION open
 
static TOOL_ACTION save
 
static TOOL_ACTION saveAs
 
static TOOL_ACTION saveCopyAs
 
static TOOL_ACTION saveAll
 
static TOOL_ACTION revert
 
static TOOL_ACTION pageSettings
 
static TOOL_ACTION print
 
static TOOL_ACTION plot
 
static TOOL_ACTION quit
 
static TOOL_ACTION cancelInteractive
 
static TOOL_ACTION showContextMenu
 
static TOOL_ACTION undo
 
static TOOL_ACTION redo
 
static TOOL_ACTION cut
 
static TOOL_ACTION copy
 
static TOOL_ACTION paste
 
static TOOL_ACTION pasteSpecial
 
static TOOL_ACTION selectAll
 
static TOOL_ACTION duplicate
 
static TOOL_ACTION doDelete
 
static TOOL_ACTION deleteTool
 
static TOOL_ACTION find
 
static TOOL_ACTION findAndReplace
 
static TOOL_ACTION findNext
 
static TOOL_ACTION findNextMarker
 
static TOOL_ACTION replaceAndFindNext
 
static TOOL_ACTION replaceAll
 
static TOOL_ACTION updateFind
 
static TOOL_ACTION zoomRedraw
 
static TOOL_ACTION zoomIn
 
static TOOL_ACTION zoomOut
 
static TOOL_ACTION zoomInCenter
 
static TOOL_ACTION zoomOutCenter
 
static TOOL_ACTION zoomCenter
 
static TOOL_ACTION zoomFitScreen
 
static TOOL_ACTION zoomFitObjects
 
static TOOL_ACTION zoomPreset
 
static TOOL_ACTION zoomTool
 
static TOOL_ACTION centerContents
 
static TOOL_ACTION toggleCursor
 
static TOOL_ACTION toggleCursorStyle
 
static TOOL_ACTION highContrastMode
 
static TOOL_ACTION highContrastModeCycle
 
static TOOL_ACTION refreshPreview
 
static TOOL_ACTION pinLibrary
 
static TOOL_ACTION unpinLibrary
 
static TOOL_ACTION cursorUp
 Cursor control with keyboard. More...
 
static TOOL_ACTION cursorDown
 
static TOOL_ACTION cursorLeft
 
static TOOL_ACTION cursorRight
 
static TOOL_ACTION cursorUpFast
 
static TOOL_ACTION cursorDownFast
 
static TOOL_ACTION cursorLeftFast
 
static TOOL_ACTION cursorRightFast
 
static TOOL_ACTION cursorClick
 
static TOOL_ACTION cursorDblClick
 
static TOOL_ACTION panUp
 
static TOOL_ACTION panDown
 
static TOOL_ACTION panLeft
 
static TOOL_ACTION panRight
 
static TOOL_ACTION gridFast1
 
static TOOL_ACTION gridFast2
 
static TOOL_ACTION gridNext
 
static TOOL_ACTION gridPrev
 
static TOOL_ACTION gridSetOrigin
 
static TOOL_ACTION gridResetOrigin
 
static TOOL_ACTION gridPreset
 
static TOOL_ACTION toggleGrid
 
static TOOL_ACTION gridProperties
 
static TOOL_ACTION inchesUnits
 
static TOOL_ACTION milsUnits
 
static TOOL_ACTION millimetersUnits
 
static TOOL_ACTION updateUnits
 
static TOOL_ACTION toggleUnits
 
static TOOL_ACTION togglePolarCoords
 
static TOOL_ACTION resetLocalCoords
 
static TOOL_ACTION selectionTool
 
static TOOL_ACTION measureTool
 
static TOOL_ACTION pickerTool
 
static TOOL_ACTION show3DViewer
 
static TOOL_ACTION showSymbolBrowser
 
static TOOL_ACTION showSymbolEditor
 
static TOOL_ACTION showFootprintBrowser
 
static TOOL_ACTION showFootprintEditor
 
static TOOL_ACTION updatePcbFromSchematic
 
static TOOL_ACTION updateSchematicFromPcb
 
static TOOL_ACTION acceleratedGraphics
 
static TOOL_ACTION standardGraphics
 
static TOOL_ACTION updateMenu
 
static TOOL_ACTION activatePointEditor
 
static TOOL_ACTION changeEditMethod
 
static TOOL_ACTION configurePaths
 
static TOOL_ACTION showSymbolLibTable
 
static TOOL_ACTION showFootprintLibTable
 
static TOOL_ACTION gettingStarted
 
static TOOL_ACTION help
 
static TOOL_ACTION listHotKeys
 
static TOOL_ACTION getInvolved
 
static TOOL_ACTION reportBug
 

Detailed Description

ACTIONS.

Gathers all the actions that are shared by tools. The instance of a subclass of ACTIONS is created inside of ACTION_MANAGER object that registers the actions.

Definition at line 43 of file actions.h.

Member Enumeration Documentation

◆ CURSOR_EVENT_TYPE

Cursor control event types

Enumerator
CURSOR_NONE 
CURSOR_UP 
CURSOR_DOWN 
CURSOR_LEFT 
CURSOR_RIGHT 
CURSOR_CLICK 
CURSOR_DBL_CLICK 
CURSOR_RIGHT_CLICK 
CURSOR_FAST_MOVE 

Definition at line 191 of file actions.h.

◆ REMOVE_FLAGS

enum ACTIONS::REMOVE_FLAGS
strong

Remove event modifier flags

Enumerator
NORMAL 
ALT 
CUT 

Definition at line 196 of file actions.h.

196 { NORMAL = 0x00, ALT = 0x01, CUT = 0x02 };
Use all material properties from model file.

Constructor & Destructor Documentation

◆ ~ACTIONS()

virtual ACTIONS::~ACTIONS ( )
inlinevirtual

Definition at line 47 of file actions.h.

47 {};

Member Function Documentation

◆ TranslateLegacyId()

virtual OPT<TOOL_EVENT> ACTIONS::TranslateLegacyId ( int  aId)
pure virtual

Function TranslateLegacyId() Translates legacy tool ids to the corresponding TOOL_ACTION name.

Parameters
aIdis legacy tool id to be translated.
Returns
std::string is name of the corresponding TOOL_ACTION. It may be empty, if there is no corresponding TOOL_ACTION.

Implemented in PCB_ACTIONS, EE_ACTIONS, TEST_ACTIONS, EDA_3D_ACTIONS, GERBVIEW_ACTIONS, PL_ACTIONS, CVPCB_ACTIONS, and KICAD_MANAGER_ACTIONS.

Referenced by TOOL_DISPATCHER::DispatchWxCommand().

Member Data Documentation

◆ acceleratedGraphics

◆ activatePointEditor

◆ addLibrary

◆ cancelInteractive

◆ centerContents

TOOL_ACTION ACTIONS::centerContents
static

◆ changeEditMethod

TOOL_ACTION ACTIONS::changeEditMethod
static

Definition at line 169 of file actions.h.

Referenced by POINT_EDITOR::setTransitions().

◆ configurePaths

◆ copy

◆ cursorClick

◆ cursorDblClick

TOOL_ACTION ACTIONS::cursorDblClick
static

Definition at line 122 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cursorDown

TOOL_ACTION ACTIONS::cursorDown
static

Definition at line 112 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cursorDownFast

TOOL_ACTION ACTIONS::cursorDownFast
static

Definition at line 117 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cursorLeft

TOOL_ACTION ACTIONS::cursorLeft
static

Definition at line 113 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cursorLeftFast

TOOL_ACTION ACTIONS::cursorLeftFast
static

Definition at line 118 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cursorRight

TOOL_ACTION ACTIONS::cursorRight
static

Definition at line 114 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cursorRightFast

TOOL_ACTION ACTIONS::cursorRightFast
static

Definition at line 119 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cursorUp

TOOL_ACTION ACTIONS::cursorUp
static

Cursor control with keyboard.

Definition at line 111 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cursorUpFast

TOOL_ACTION ACTIONS::cursorUpFast
static

Definition at line 116 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cut

◆ deleteTool

◆ doDelete

◆ doNew

◆ duplicate

◆ find

◆ findAndReplace

◆ findNext

◆ findNextMarker

TOOL_ACTION ACTIONS::findNextMarker
static

Definition at line 82 of file actions.h.

Referenced by SCH_EDITOR_CONTROL::FindNext(), and SCH_EDITOR_CONTROL::setTransitions().

◆ getInvolved

TOOL_ACTION ACTIONS::getInvolved
static

◆ gettingStarted

TOOL_ACTION ACTIONS::gettingStarted
static

◆ gridFast1

TOOL_ACTION ACTIONS::gridFast1
static

◆ gridFast2

TOOL_ACTION ACTIONS::gridFast2
static

◆ gridNext

TOOL_ACTION ACTIONS::gridNext
static

Definition at line 133 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ gridPreset

◆ gridPrev

TOOL_ACTION ACTIONS::gridPrev
static

Definition at line 134 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ gridProperties

◆ gridResetOrigin

TOOL_ACTION ACTIONS::gridResetOrigin
static

Definition at line 136 of file actions.h.

Referenced by PCBNEW_CONTROL::setTransitions().

◆ gridSetOrigin

◆ help

TOOL_ACTION ACTIONS::help
static

◆ highContrastMode

◆ highContrastModeCycle

TOOL_ACTION ACTIONS::highContrastModeCycle
static

Definition at line 102 of file actions.h.

Referenced by PCBNEW_CONTROL::setTransitions().

◆ inchesUnits

◆ listHotKeys

TOOL_ACTION ACTIONS::listHotKeys
static

◆ measureTool

◆ millimetersUnits

◆ milsUnits

◆ newLibrary

◆ open

◆ pageSettings

◆ panDown

TOOL_ACTION ACTIONS::panDown
static

Definition at line 126 of file actions.h.

Referenced by EDA_3D_CONTROLLER::setTransitions(), and COMMON_TOOLS::setTransitions().

◆ panLeft

TOOL_ACTION ACTIONS::panLeft
static

Definition at line 127 of file actions.h.

Referenced by EDA_3D_CONTROLLER::setTransitions(), and COMMON_TOOLS::setTransitions().

◆ panRight

TOOL_ACTION ACTIONS::panRight
static

Definition at line 128 of file actions.h.

Referenced by EDA_3D_CONTROLLER::setTransitions(), and COMMON_TOOLS::setTransitions().

◆ panUp

TOOL_ACTION ACTIONS::panUp
static

Definition at line 125 of file actions.h.

Referenced by EDA_3D_CONTROLLER::setTransitions(), and COMMON_TOOLS::setTransitions().

◆ paste

◆ pasteSpecial

◆ pickerTool

◆ pinLibrary

◆ plot

◆ print

◆ quit

TOOL_ACTION ACTIONS::quit
static

Definition at line 62 of file actions.h.

Referenced by PCBNEW_CONTROL::setTransitions(), and SCH_EDITOR_CONTROL::setTransitions().

◆ redo

◆ refreshPreview

◆ replaceAll

TOOL_ACTION ACTIONS::replaceAll
static

Definition at line 84 of file actions.h.

Referenced by DIALOG_SCH_FIND::OnReplace(), and SCH_EDITOR_CONTROL::setTransitions().

◆ replaceAndFindNext

TOOL_ACTION ACTIONS::replaceAndFindNext
static

Definition at line 83 of file actions.h.

Referenced by DIALOG_SCH_FIND::OnReplace(), and SCH_EDITOR_CONTROL::setTransitions().

◆ reportBug

TOOL_ACTION ACTIONS::reportBug
static

◆ resetLocalCoords

TOOL_ACTION ACTIONS::resetLocalCoords
static

Definition at line 148 of file actions.h.

Referenced by DRAWING_TOOL::drawSegment(), and COMMON_TOOLS::setTransitions().

◆ revert

◆ save

◆ saveAll

◆ saveAs

◆ saveCopyAs

◆ selectAll

◆ selectionTool

◆ show3DViewer

◆ showContextMenu

TOOL_ACTION ACTIONS::showContextMenu
static

Definition at line 66 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ showFootprintBrowser

◆ showFootprintEditor

◆ showFootprintLibTable

◆ showSymbolBrowser

◆ showSymbolEditor

◆ showSymbolLibTable

◆ standardGraphics

◆ toggleCursor

TOOL_ACTION ACTIONS::toggleCursor
static

Definition at line 99 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ toggleCursorStyle

◆ toggleGrid

◆ togglePolarCoords

◆ toggleUnits

TOOL_ACTION ACTIONS::toggleUnits
static

Definition at line 146 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ undo

◆ unpinLibrary

◆ updateFind

◆ updateMenu

◆ updatePcbFromSchematic

◆ updateSchematicFromPcb

◆ updateUnits

◆ zoomCenter

TOOL_ACTION ACTIONS::zoomCenter
static

Definition at line 93 of file actions.h.

Referenced by EDA_DRAW_FRAME::AddStandardSubMenus(), and COMMON_TOOLS::setTransitions().

◆ zoomFitObjects

◆ zoomFitScreen

TOOL_ACTION ACTIONS::zoomFitScreen
static

Definition at line 94 of file actions.h.

Referenced by EDA_DRAW_FRAME::AddStandardSubMenus(), SCH_EDIT_FRAME::AppendSchematic(), GERBVIEW_CONTROL::ClearAllLayers(), EDA_3D_VIEWER::CreateMenuBar(), DIALOG_MIGRATE_BUSES::DIALOG_MIGRATE_BUSES(), SCH_EDIT_FRAME::DisplayCurrentSheet(), SYMBOL_EDIT_FRAME::emptyScreen(), EVT_GRID_CMD_CELL_CHANGED(), EVT_UPDATE_UI_RANGE(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), SCH_EDIT_FRAME::importFile(), FOOTPRINT_EDITOR_TOOLS::ImportFootprint(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), SYMBOL_EDIT_FRAME::LoadOneLibraryPartAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PL_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), SELECTION_TOOL::Main(), PL_EDITOR_FRAME::OnNewPageLayout(), SCH_EDIT_FRAME::onSize(), PCB_EDIT_FRAME::onSize(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::PutDataInPreviousState(), DISPLAY_FOOTPRINTS_FRAME::ReCreateHToolbar(), LIB_VIEW_FRAME::ReCreateHToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateHToolbar(), PL_EDITOR_FRAME::ReCreateHToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateHToolbar(), FOOTPRINT_WIZARD_FRAME::ReCreateHToolbar(), SCH_EDIT_FRAME::ReCreateHToolbar(), GERBVIEW_FRAME::ReCreateHToolbar(), SYMBOL_EDIT_FRAME::ReCreateHToolbar(), PCB_EDIT_FRAME::ReCreateHToolbar(), EDA_3D_VIEWER::ReCreateMainToolbar(), LIB_VIEW_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::ReCreateMenuBar(), SYMBOL_EDIT_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), LIB_VIEW_FRAME::SetSelectedComponent(), EDA_3D_CONTROLLER::setTransitions(), COMMON_TOOLS::setTransitions(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), FOOTPRINT_VIEWER_FRAME::updateView(), and EDA_DRAW_FRAME::Zoom_Automatique().

◆ zoomIn

◆ zoomInCenter

◆ zoomOut

◆ zoomOutCenter

◆ zoomPreset

TOOL_ACTION ACTIONS::zoomPreset
static

Definition at line 96 of file actions.h.

Referenced by ZOOM_MENU::eventHandler(), and COMMON_TOOLS::setTransitions().

◆ zoomRedraw

◆ zoomTool


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