KiCad PCB EDA Suite
Loading...
Searching...
No Matches
ACTIONS Class Reference

Gather all the actions that are shared by tools. More...

#include <actions.h>

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

Public Types

enum  CURSOR_EVENT_TYPE {
  CURSOR_NONE = 0 , CURSOR_UP , CURSOR_UP_FAST , CURSOR_DOWN ,
  CURSOR_DOWN_FAST , CURSOR_LEFT , CURSOR_LEFT_FAST , CURSOR_RIGHT ,
  CURSOR_RIGHT_FAST , CURSOR_CLICK , CURSOR_DBL_CLICK , CURSOR_RIGHT_CLICK
}
 
enum class  REMOVE_FLAGS { NORMAL = 0x00 , ALT = 0x01 , CUT = 0x02 }
 

Public Member Functions

virtual ~ACTIONS ()
 

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 saveCopy
 
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 ddAddLibrary
 
static TOOL_ACTION cancelInteractive
 
static TOOL_ACTION finishInteractive
 
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 unselectAll
 
static TOOL_ACTION duplicate
 
static TOOL_ACTION doDelete
 
static TOOL_ACTION deleteTool
 
static TOOL_ACTION leftJustify
 
static TOOL_ACTION centerJustify
 
static TOOL_ACTION rightJustify
 
static TOOL_ACTION expandAll
 
static TOOL_ACTION collapseAll
 
static TOOL_ACTION selectRows
 
static TOOL_ACTION selectColumns
 
static TOOL_ACTION selectTable
 
static TOOL_ACTION addRowAbove
 
static TOOL_ACTION addRowBelow
 
static TOOL_ACTION addColBefore
 
static TOOL_ACTION addColAfter
 
static TOOL_ACTION deleteRows
 
static TOOL_ACTION deleteColumns
 
static TOOL_ACTION mergeCells
 
static TOOL_ACTION unmergeCells
 
static TOOL_ACTION editTable
 
static TOOL_ACTION showSearch
 
static TOOL_ACTION find
 
static TOOL_ACTION findAndReplace
 
static TOOL_ACTION findNext
 
static TOOL_ACTION findPrevious
 
static TOOL_ACTION findNextMarker
 
static TOOL_ACTION replaceAndFindNext
 
static TOOL_ACTION replaceAll
 
static TOOL_ACTION updateFind
 
static TOOL_ACTION prevMarker
 
static TOOL_ACTION nextMarker
 
static TOOL_ACTION excludeMarker
 
static TOOL_ACTION zoomRedraw
 
static TOOL_ACTION zoomIn
 
static TOOL_ACTION zoomOut
 
static TOOL_ACTION zoomInCenter
 
static TOOL_ACTION zoomOutCenter
 
static TOOL_ACTION zoomInHorizontally
 
static TOOL_ACTION zoomOutHorizontally
 
static TOOL_ACTION zoomInVertically
 
static TOOL_ACTION zoomOutVertically
 
static TOOL_ACTION zoomCenter
 
static TOOL_ACTION zoomFitScreen
 
static TOOL_ACTION zoomFitObjects
 
static TOOL_ACTION zoomPreset
 
static TOOL_ACTION zoomTool
 
static TOOL_ACTION zoomUndo
 
static TOOL_ACTION zoomRedo
 
static TOOL_ACTION centerContents
 
static TOOL_ACTION toggleCursor
 
static TOOL_ACTION toggleCursorStyle
 
static TOOL_ACTION highContrastMode
 
static TOOL_ACTION highContrastModeCycle
 
static TOOL_ACTION toggleBoundingBoxes
 
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 gridFastCycle
 
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 toggleGridOverrides
 
static TOOL_ACTION gridProperties
 
static TOOL_ACTION gridOrigin
 
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 pickerSubTool
 
static TOOL_ACTION showProjectManager
 
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 showProperties
 
static TOOL_ACTION updateMenu
 
static TOOL_ACTION activatePointEditor
 
static TOOL_ACTION cycleArcEditMode
 
static TOOL_ACTION updatePreferences
 
static TOOL_ACTION selectLibTreeColumns
 
static TOOL_ACTION openPreferences
 
static TOOL_ACTION configurePaths
 
static TOOL_ACTION showSymbolLibTable
 
static TOOL_ACTION showFootprintLibTable
 
static TOOL_ACTION gettingStarted
 
static TOOL_ACTION help
 
static TOOL_ACTION about
 
static TOOL_ACTION listHotKeys
 
static TOOL_ACTION donate
 
static TOOL_ACTION getInvolved
 
static TOOL_ACTION reportBug
 Cursor control event types. More...
 

Detailed Description

Gather 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 40 of file actions.h.

Member Enumeration Documentation

◆ CURSOR_EVENT_TYPE

Enumerator
CURSOR_NONE 
CURSOR_UP 
CURSOR_UP_FAST 
CURSOR_DOWN 
CURSOR_DOWN_FAST 
CURSOR_LEFT 
CURSOR_LEFT_FAST 
CURSOR_RIGHT 
CURSOR_RIGHT_FAST 
CURSOR_CLICK 
CURSOR_DBL_CLICK 
CURSOR_RIGHT_CLICK 

Definition at line 224 of file actions.h.

◆ REMOVE_FLAGS

enum class ACTIONS::REMOVE_FLAGS
strong
Enumerator
NORMAL 
ALT 
CUT 

Definition at line 241 of file actions.h.

Constructor & Destructor Documentation

◆ ~ACTIONS()

virtual ACTIONS::~ACTIONS ( )
inlinevirtual

Definition at line 44 of file actions.h.

Member Data Documentation

◆ about

TOOL_ACTION ACTIONS::about
static

◆ activatePointEditor

◆ addColAfter

◆ addColBefore

◆ addLibrary

◆ addRowAbove

◆ addRowBelow

◆ cancelInteractive

◆ centerContents

TOOL_ACTION ACTIONS::centerContents
static

◆ centerJustify

TOOL_ACTION ACTIONS::centerJustify
static

◆ collapseAll

TOOL_ACTION ACTIONS::collapseAll
static

◆ configurePaths

◆ copy

◆ cursorClick

◆ cursorDblClick

TOOL_ACTION ACTIONS::cursorDblClick
static

Definition at line 155 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cursorDown

TOOL_ACTION ACTIONS::cursorDown
static

Definition at line 145 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cursorDownFast

TOOL_ACTION ACTIONS::cursorDownFast
static

Definition at line 150 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cursorLeft

TOOL_ACTION ACTIONS::cursorLeft
static

Definition at line 146 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cursorLeftFast

TOOL_ACTION ACTIONS::cursorLeftFast
static

Definition at line 151 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cursorRight

TOOL_ACTION ACTIONS::cursorRight
static

Definition at line 147 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cursorRightFast

TOOL_ACTION ACTIONS::cursorRightFast
static

Definition at line 152 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cursorUp

TOOL_ACTION ACTIONS::cursorUp
static

Cursor control with keyboard.

Definition at line 144 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cursorUpFast

TOOL_ACTION ACTIONS::cursorUpFast
static

Definition at line 149 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cut

◆ cycleArcEditMode

TOOL_ACTION ACTIONS::cycleArcEditMode
static

◆ ddAddLibrary

◆ deleteColumns

◆ deleteRows

◆ deleteTool

◆ doDelete

◆ donate

TOOL_ACTION ACTIONS::donate
static

◆ doNew

◆ duplicate

◆ editTable

◆ excludeMarker

◆ expandAll

◆ find

◆ findAndReplace

◆ findNext

◆ findNextMarker

TOOL_ACTION ACTIONS::findNextMarker
static

◆ findPrevious

◆ finishInteractive

◆ getInvolved

TOOL_ACTION ACTIONS::getInvolved
static

◆ gettingStarted

TOOL_ACTION ACTIONS::gettingStarted
static

◆ gridFast1

TOOL_ACTION ACTIONS::gridFast1
static

◆ gridFast2

TOOL_ACTION ACTIONS::gridFast2
static

◆ gridFastCycle

TOOL_ACTION ACTIONS::gridFastCycle
static

Definition at line 166 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ gridNext

TOOL_ACTION ACTIONS::gridNext
static

Definition at line 167 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ gridOrigin

◆ gridPreset

◆ gridPrev

TOOL_ACTION ACTIONS::gridPrev
static

Definition at line 168 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ gridProperties

◆ gridResetOrigin

TOOL_ACTION ACTIONS::gridResetOrigin
static

◆ gridSetOrigin

◆ help

TOOL_ACTION ACTIONS::help
static

◆ highContrastMode

◆ highContrastModeCycle

◆ inchesUnits

◆ leftJustify

◆ listHotKeys

TOOL_ACTION ACTIONS::listHotKeys
static

◆ measureTool

◆ mergeCells

◆ millimetersUnits

◆ milsUnits

◆ newLibrary

◆ nextMarker

◆ open

◆ openPreferences

◆ pageSettings

◆ panDown

TOOL_ACTION ACTIONS::panDown
static

Definition at line 159 of file actions.h.

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

◆ panLeft

TOOL_ACTION ACTIONS::panLeft
static

Definition at line 160 of file actions.h.

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

◆ panRight

TOOL_ACTION ACTIONS::panRight
static

Definition at line 161 of file actions.h.

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

◆ panUp

TOOL_ACTION ACTIONS::panUp
static

Definition at line 158 of file actions.h.

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

◆ paste

◆ pasteSpecial

◆ pickerSubTool

TOOL_ACTION ACTIONS::pickerSubTool
static

Definition at line 190 of file actions.h.

Referenced by EDIT_TOOL::pickReferencePoint(), and PCB_PICKER_TOOL::setTransitions().

◆ pickerTool

◆ pinLibrary

◆ plot

◆ prevMarker

◆ print

◆ quit

◆ redo

TOOL_ACTION ACTIONS::redo
static

◆ refreshPreview

◆ replaceAll

TOOL_ACTION ACTIONS::replaceAll
static

Definition at line 105 of file actions.h.

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

◆ replaceAndFindNext

TOOL_ACTION ACTIONS::replaceAndFindNext
static

Definition at line 104 of file actions.h.

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

◆ reportBug

TOOL_ACTION ACTIONS::reportBug
static

Cursor control event types.

Definition at line 221 of file actions.h.

Referenced by EDA_BASE_FRAME::AddStandardHelpMenu(), and COMMON_CONTROL::setTransitions().

◆ resetLocalCoords

TOOL_ACTION ACTIONS::resetLocalCoords
static

Definition at line 184 of file actions.h.

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

◆ revert

◆ rightJustify

TOOL_ACTION ACTIONS::rightJustify
static

Definition at line 79 of file actions.h.

Referenced by SCH_EDIT_TOOL::setTransitions(), and EDIT_TOOL::setTransitions().

◆ save

◆ saveAll

◆ saveAs

◆ saveCopy

TOOL_ACTION ACTIONS::saveCopy
static

◆ selectAll

◆ selectColumns

◆ selectionTool

◆ selectLibTreeColumns

TOOL_ACTION ACTIONS::selectLibTreeColumns
static

Definition at line 208 of file actions.h.

Referenced by LIB_TREE::onHeaderContextMenu().

◆ selectRows

◆ selectTable

◆ show3DViewer

◆ showContextMenu

TOOL_ACTION ACTIONS::showContextMenu
static

Definition at line 65 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ showFootprintBrowser

◆ showFootprintEditor

◆ showFootprintLibTable

◆ showProjectManager

TOOL_ACTION ACTIONS::showProjectManager
static

◆ showProperties

◆ showSearch

◆ showSymbolBrowser

◆ showSymbolEditor

◆ showSymbolLibTable

◆ toggleBoundingBoxes

◆ toggleCursor

TOOL_ACTION ACTIONS::toggleCursor
static

Definition at line 131 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ toggleCursorStyle

◆ toggleGrid

◆ toggleGridOverrides

◆ togglePolarCoords

◆ toggleUnits

TOOL_ACTION ACTIONS::toggleUnits
static

Definition at line 182 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ undo

TOOL_ACTION ACTIONS::undo
static

Definition at line 66 of file actions.h.

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), EDIT_TOOL::doMoveSelection(), CVPCB_MAINFRAME::doReCreateMenuBar(), SCH_EDIT_FRAME::doReCreateMenuBar(), SYMBOL_EDIT_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::doReCreateMenuBar(), PCB_EDIT_FRAME::doReCreateMenuBar(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), SCH_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), EDA_BASE_FRAME::HandleUpdateUIEvent(), ROUTER_TOOL::InlineDrag(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), CVPCB_MAINFRAME::ReCreateHToolbar(), SCH_EDIT_FRAME::ReCreateHToolbar(), SYMBOL_EDIT_FRAME::ReCreateHToolbar(), PL_EDITOR_FRAME::ReCreateHToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateHToolbar(), PCB_EDIT_FRAME::ReCreateHToolbar(), CVPCB_ASSOCIATION_TOOL::setTransitions(), SCH_EDITOR_CONTROL::setTransitions(), SYMBOL_EDITOR_EDIT_TOOL::setTransitions(), PL_EDIT_TOOL::setTransitions(), PCB_CONTROL::setTransitions(), CVPCB_MAINFRAME::setupUIConditions(), SCH_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), PL_EDITOR_FRAME::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), PCB_EDIT_FRAME::setupUIConditions(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ unmergeCells

◆ unpinLibrary

◆ unselectAll

◆ updateFind

◆ updateMenu

◆ updatePcbFromSchematic

◆ updatePreferences

TOOL_ACTION ACTIONS::updatePreferences
static

◆ updateSchematicFromPcb

◆ updateUnits

◆ zoomCenter

TOOL_ACTION ACTIONS::zoomCenter
static

Definition at line 123 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ zoomFitObjects

◆ zoomFitScreen

TOOL_ACTION ACTIONS::zoomFitScreen
static

Definition at line 124 of file actions.h.

Referenced by GERBVIEW_CONTROL::ClearAllLayers(), DIALOG_MIGRATE_BUSES::DIALOG_MIGRATE_BUSES(), EDA_3D_VIEWER_FRAME::doReCreateMenuBar(), SCH_EDIT_FRAME::doReCreateMenuBar(), SIMULATOR_FRAME::doReCreateMenuBar(), SYMBOL_EDIT_FRAME::doReCreateMenuBar(), SYMBOL_VIEWER_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::doReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::doReCreateMenuBar(), PCB_EDIT_FRAME::doReCreateMenuBar(), 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_CONTROL::ImportFootprint(), SCH_EDIT_FRAME::initScreenZoom(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PL_SELECTION_TOOL::Main(), PCB_SELECTION_TOOL::Main(), PL_EDITOR_FRAME::OnNewDrawingSheet(), SCH_EDIT_FRAME::onSize(), PCB_EDIT_FRAME::onSize(), SCH_EDIT_FRAME::OpenProjectFiles(), SIMULATOR_FRAME::ReCreateHToolbar(), DISPLAY_FOOTPRINTS_FRAME::ReCreateHToolbar(), SCH_EDIT_FRAME::ReCreateHToolbar(), SYMBOL_EDIT_FRAME::ReCreateHToolbar(), SYMBOL_VIEWER_FRAME::ReCreateHToolbar(), GERBVIEW_FRAME::ReCreateHToolbar(), PL_EDITOR_FRAME::ReCreateHToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateHToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateHToolbar(), FOOTPRINT_WIZARD_FRAME::ReCreateHToolbar(), PCB_EDIT_FRAME::ReCreateHToolbar(), EDA_3D_VIEWER_FRAME::ReCreateMainToolbar(), PL_EDITOR_FRAME::RollbackFromUndo(), SYMBOL_EDIT_FRAME::SetCurSymbol(), EDA_3D_CONTROLLER::setTransitions(), SIMULATOR_CONTROL::setTransitions(), COMMON_TOOLS::setTransitions(), SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_VIEWER_FRAME::updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), SIMULATOR_CONTROL::Zoom(), and EDA_DRAW_FRAME::Zoom_Automatique().

◆ zoomIn

◆ zoomInCenter

◆ zoomInHorizontally

◆ zoomInVertically

◆ zoomOut

TOOL_ACTION ACTIONS::zoomOut
static

Definition at line 116 of file actions.h.

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

◆ zoomOutCenter

◆ zoomOutHorizontally

◆ zoomOutVertically

◆ zoomPreset

TOOL_ACTION ACTIONS::zoomPreset
static

◆ zoomRedo

◆ zoomRedraw

◆ zoomTool

◆ zoomUndo


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