KiCad PCB EDA Suite
GERBVIEW_ACTIONS Class Reference

Class GERBVIEW_ACTIONS. More...

#include <gerbview_actions.h>

Inheritance diagram for GERBVIEW_ACTIONS:
ACTIONS

Public Types

enum  CURSOR_EVENT_TYPE {
  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 OPT< TOOL_EVENTTranslateLegacyId (int aId) override
 

More...
 

Static Public Attributes

static TOOL_ACTION selectionActivate
 Activation of the selection tool. More...
 
static TOOL_ACTION selectionCursor
 Select a single item under the cursor position. More...
 
static TOOL_ACTION selectionClear
 Clears the current selection. More...
 
static TOOL_ACTION selectItem
 Selects an item (specified as the event parameter). More...
 
static TOOL_ACTION unselectItem
 Unselects an item (specified as the event parameter). More...
 
static TOOL_ACTION properties
 Activation of the edit tool. More...
 
static TOOL_ACTION linesDisplayOutlines
 
static TOOL_ACTION flashedDisplayOutlines
 
static TOOL_ACTION polygonsDisplayOutlines
 
static TOOL_ACTION negativeObjectDisplay
 
static TOOL_ACTION dcodeDisplay
 
static TOOL_ACTION toggleDiffMode
 
static TOOL_ACTION layerPrev
 
static TOOL_ACTION layerNext
 
static TOOL_ACTION layerChanged
 
static TOOL_ACTION highlightClear
 
static TOOL_ACTION highlightNet
 
static TOOL_ACTION highlightComponent
 
static TOOL_ACTION highlightAttribute
 
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 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 zoomPreset
 
static TOOL_ACTION zoomTool
 
static TOOL_ACTION centerContents
 
static TOOL_ACTION toggleCursor
 
static TOOL_ACTION toggleCursorStyle
 
static TOOL_ACTION highContrastMode
 
static TOOL_ACTION refreshPreview
 
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 imperialUnits
 
static TOOL_ACTION metricUnits
 
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 acceleratedGraphics
 
static TOOL_ACTION standardGraphics
 
static TOOL_ACTION updateMenu
 
static TOOL_ACTION activatePointEditor
 
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
 

Detailed Description

Class GERBVIEW_ACTIONS.

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

Definition at line 37 of file gerbview_actions.h.

Member Enumeration Documentation

◆ CURSOR_EVENT_TYPE

Cursor control event types

Enumerator
CURSOR_UP 
CURSOR_DOWN 
CURSOR_LEFT 
CURSOR_RIGHT 
CURSOR_CLICK 
CURSOR_DBL_CLICK 
CURSOR_RIGHT_CLICK 
CURSOR_FAST_MOVE 

Definition at line 179 of file actions.h.

◆ REMOVE_FLAGS

enum ACTIONS::REMOVE_FLAGS
stronginherited

Remove event modifier flags

Enumerator
NORMAL 
ALT 
CUT 

Definition at line 184 of file actions.h.

184 { NORMAL = 0x00, ALT = 0x01, CUT = 0x02 };

Member Function Documentation

◆ TranslateLegacyId()

OPT< TOOL_EVENT > GERBVIEW_ACTIONS::TranslateLegacyId ( int  aId)
overridevirtual

Implements ACTIONS.

Definition at line 27 of file gerbview_actions.cpp.

28 {
29  switch( aId )
30  {
33 
36 
39 
42  }
43 
44  return OPT<TOOL_EVENT>();
45 }
static TOOL_ACTION highlightNet
static TOOL_ACTION highlightAttribute
static TOOL_ACTION highlightClear
TOOL_EVENT MakeEvent() const
Function MakeEvent() Returns the event associated with the action (i.e.
Definition: tool_action.h:107
boost::optional< T > OPT
Definition: optional.h:7
static TOOL_ACTION highlightComponent

References highlightAttribute, highlightClear, highlightComponent, highlightNet, ID_HIGHLIGHT_APER_ATTRIBUTE_ITEMS, ID_HIGHLIGHT_CMP_ITEMS, ID_HIGHLIGHT_NET_ITEMS, ID_HIGHLIGHT_REMOVE_ALL, and TOOL_ACTION::MakeEvent().

Member Data Documentation

◆ acceleratedGraphics

◆ activatePointEditor

◆ addLibrary

◆ cancelInteractive

◆ centerContents

TOOL_ACTION ACTIONS::centerContents
staticinherited

◆ configurePaths

◆ copy

◆ cursorClick

◆ cursorDblClick

TOOL_ACTION ACTIONS::cursorDblClick
staticinherited

Definition at line 115 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cursorDown

TOOL_ACTION ACTIONS::cursorDown
staticinherited

Definition at line 105 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cursorDownFast

TOOL_ACTION ACTIONS::cursorDownFast
staticinherited

Definition at line 110 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cursorLeft

TOOL_ACTION ACTIONS::cursorLeft
staticinherited

Definition at line 106 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cursorLeftFast

TOOL_ACTION ACTIONS::cursorLeftFast
staticinherited

Definition at line 111 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cursorRight

TOOL_ACTION ACTIONS::cursorRight
staticinherited

Definition at line 107 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cursorRightFast

TOOL_ACTION ACTIONS::cursorRightFast
staticinherited

Definition at line 112 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cursorUp

TOOL_ACTION ACTIONS::cursorUp
staticinherited

Cursor control with keyboard.

Definition at line 104 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cursorUpFast

TOOL_ACTION ACTIONS::cursorUpFast
staticinherited

Definition at line 109 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ cut

◆ dcodeDisplay

◆ deleteTool

◆ doDelete

◆ doNew

◆ duplicate

◆ find

◆ findAndReplace

◆ findNext

TOOL_ACTION ACTIONS::findNext
staticinherited

◆ findNextMarker

TOOL_ACTION ACTIONS::findNextMarker
staticinherited

Definition at line 80 of file actions.h.

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

◆ flashedDisplayOutlines

◆ getInvolved

TOOL_ACTION ACTIONS::getInvolved
staticinherited

◆ gettingStarted

TOOL_ACTION ACTIONS::gettingStarted
staticinherited

◆ gridFast1

TOOL_ACTION ACTIONS::gridFast1
staticinherited

◆ gridFast2

TOOL_ACTION ACTIONS::gridFast2
staticinherited

◆ gridNext

TOOL_ACTION ACTIONS::gridNext
staticinherited

Definition at line 126 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ gridPreset

◆ gridPrev

TOOL_ACTION ACTIONS::gridPrev
staticinherited

Definition at line 127 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ gridProperties

◆ gridResetOrigin

TOOL_ACTION ACTIONS::gridResetOrigin
staticinherited

Definition at line 129 of file actions.h.

Referenced by PCBNEW_CONTROL::setTransitions().

◆ gridSetOrigin

◆ help

TOOL_ACTION ACTIONS::help
staticinherited

◆ highContrastMode

◆ highlightAttribute

TOOL_ACTION GERBVIEW_ACTIONS::highlightAttribute
static

◆ highlightClear

TOOL_ACTION GERBVIEW_ACTIONS::highlightClear
static

◆ highlightComponent

TOOL_ACTION GERBVIEW_ACTIONS::highlightComponent
static

◆ highlightNet

TOOL_ACTION GERBVIEW_ACTIONS::highlightNet
static

◆ imperialUnits

◆ layerChanged

TOOL_ACTION GERBVIEW_ACTIONS::layerChanged
static

Definition at line 71 of file gerbview_actions.h.

Referenced by GERBVIEW_FRAME::SetActiveLayer().

◆ layerNext

TOOL_ACTION GERBVIEW_ACTIONS::layerNext
static

Definition at line 69 of file gerbview_actions.h.

Referenced by GERBVIEW_CONTROL::setTransitions().

◆ layerPrev

TOOL_ACTION GERBVIEW_ACTIONS::layerPrev
static

Definition at line 68 of file gerbview_actions.h.

Referenced by GERBVIEW_CONTROL::setTransitions().

◆ linesDisplayOutlines

◆ listHotKeys

TOOL_ACTION ACTIONS::listHotKeys
staticinherited

◆ measureTool

◆ metricUnits

◆ negativeObjectDisplay

◆ newLibrary

◆ open

◆ pageSettings

◆ panDown

TOOL_ACTION ACTIONS::panDown
staticinherited

Definition at line 119 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ panLeft

TOOL_ACTION ACTIONS::panLeft
staticinherited

Definition at line 120 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ panRight

TOOL_ACTION ACTIONS::panRight
staticinherited

Definition at line 121 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ panUp

TOOL_ACTION ACTIONS::panUp
staticinherited

Definition at line 118 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ paste

◆ pickerTool

◆ plot

◆ polygonsDisplayOutlines

◆ print

◆ properties

TOOL_ACTION GERBVIEW_ACTIONS::properties
static

Activation of the edit tool.

Definition at line 57 of file gerbview_actions.h.

◆ quit

TOOL_ACTION ACTIONS::quit
staticinherited

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
staticinherited

Definition at line 82 of file actions.h.

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

◆ replaceAndFindNext

TOOL_ACTION ACTIONS::replaceAndFindNext
staticinherited

Definition at line 81 of file actions.h.

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

◆ resetLocalCoords

TOOL_ACTION ACTIONS::resetLocalCoords
staticinherited

Definition at line 139 of file actions.h.

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

◆ revert

◆ save

◆ saveAll

◆ saveAs

◆ saveCopyAs

◆ selectionActivate

TOOL_ACTION GERBVIEW_ACTIONS::selectionActivate
static

Activation of the selection tool.

Definition at line 42 of file gerbview_actions.h.

Referenced by GERBVIEW_SELECTION_TOOL::setTransitions().

◆ selectionClear

TOOL_ACTION GERBVIEW_ACTIONS::selectionClear
static

Clears the current selection.

Definition at line 48 of file gerbview_actions.h.

Referenced by GERBVIEW_CONTROL::Print(), and GERBVIEW_SELECTION_TOOL::setTransitions().

◆ selectionCursor

TOOL_ACTION GERBVIEW_ACTIONS::selectionCursor
static

Select a single item under the cursor position.

Definition at line 45 of file gerbview_actions.h.

◆ selectionTool

◆ selectItem

TOOL_ACTION GERBVIEW_ACTIONS::selectItem
static

Selects an item (specified as the event parameter).

Definition at line 51 of file gerbview_actions.h.

Referenced by GERBVIEW_SELECTION_TOOL::setTransitions().

◆ show3DViewer

◆ showContextMenu

TOOL_ACTION ACTIONS::showContextMenu
staticinherited

Definition at line 66 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ showFootprintBrowser

◆ showFootprintEditor

TOOL_ACTION ACTIONS::showFootprintEditor
staticinherited

◆ showFootprintLibTable

◆ showSymbolBrowser

◆ showSymbolEditor

◆ showSymbolLibTable

◆ standardGraphics

◆ toggleCursor

TOOL_ACTION ACTIONS::toggleCursor
staticinherited

Definition at line 96 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

◆ toggleCursorStyle

◆ toggleDiffMode

◆ toggleGrid

◆ togglePolarCoords

◆ toggleUnits

TOOL_ACTION ACTIONS::toggleUnits
staticinherited

Definition at line 137 of file actions.h.

Referenced by EDIT_TOOL::MeasureTool(), and COMMON_TOOLS::setTransitions().

◆ undo

◆ unselectItem

TOOL_ACTION GERBVIEW_ACTIONS::unselectItem
static

Unselects an item (specified as the event parameter).

Definition at line 54 of file gerbview_actions.h.

Referenced by GERBVIEW_SELECTION_TOOL::setTransitions().

◆ updateFind

◆ updateMenu

◆ updatePcbFromSchematic

◆ zoomCenter

TOOL_ACTION ACTIONS::zoomCenter
staticinherited

Definition at line 91 of file actions.h.

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

◆ zoomFitScreen

TOOL_ACTION ACTIONS::zoomFitScreen
staticinherited

Definition at line 92 of file actions.h.

Referenced by EDA_DRAW_FRAME::AddStandardSubMenus(), SCH_EDIT_FRAME::AppendSchematic(), DIALOG_MIGRATE_BUSES::DIALOG_MIGRATE_BUSES(), SCH_EDIT_FRAME::DisplayCurrentSheet(), LIB_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(), MODULE_EDITOR_TOOLS::ImportFootprint(), LIB_EDIT_FRAME::LIB_EDIT_FRAME(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), LIB_EDIT_FRAME::LoadOneLibraryPartAux(), PL_EDITOR_FRAME::OnNewPageLayout(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), DISPLAY_FOOTPRINTS_FRAME::ReCreateHToolbar(), LIB_VIEW_FRAME::ReCreateHToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateHToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateHToolbar(), PL_EDITOR_FRAME::ReCreateHToolbar(), FOOTPRINT_WIZARD_FRAME::ReCreateHToolbar(), GERBVIEW_FRAME::ReCreateHToolbar(), LIB_EDIT_FRAME::ReCreateHToolbar(), SCH_EDIT_FRAME::ReCreateHToolbar(), PCB_EDIT_FRAME::ReCreateHToolbar(), LIB_VIEW_FRAME::ReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), LIB_EDIT_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), LIB_VIEW_FRAME::SetSelectedComponent(), COMMON_TOOLS::setTransitions(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), FOOTPRINT_VIEWER_FRAME::updateView(), FOOTPRINT_EDIT_FRAME::updateView(), and EDA_DRAW_FRAME::Zoom_Automatique().

◆ zoomIn

TOOL_ACTION ACTIONS::zoomIn
staticinherited

◆ zoomInCenter

◆ zoomOut

TOOL_ACTION ACTIONS::zoomOut
staticinherited

Definition at line 88 of file actions.h.

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

◆ zoomOutCenter

◆ zoomPreset

TOOL_ACTION ACTIONS::zoomPreset
staticinherited

Definition at line 93 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: