KiCad PCB EDA Suite
actions.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2013-2016 CERN
5  * Copyright (C) 2016-2021 KiCad Developers, see AUTHORS.txt for contributors.
6  * @author Maciej Suminski <maciej.suminski@cern.ch>
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, you may find one here:
20  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21  * or you may search the http://www.gnu.org website for the version 2 license,
22  * or you may write to the Free Software Foundation, Inc.,
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24  */
25 
26 #ifndef __ACTIONS_H
27 #define __ACTIONS_H
28 
29 #include <tool/tool_action.h>
30 #include <tool/tool_event.h>
31 
32 #define LEGACY_HK_NAME( x ) x
33 
40 class ACTIONS
41 {
42 public:
43 
44  virtual ~ACTIONS() {};
45 
46  // Generic document actions
47  static TOOL_ACTION doNew; // sadly 'new' is a reserved word
50  static TOOL_ACTION open;
51  static TOOL_ACTION save;
58  static TOOL_ACTION plot;
59  static TOOL_ACTION quit;
60 
61  // Generic edit actions
64  static TOOL_ACTION undo;
65  static TOOL_ACTION redo;
66  static TOOL_ACTION cut;
67  static TOOL_ACTION copy;
72  static TOOL_ACTION doDelete; // sadly 'delete' is a reserved word
74 
75  // Find and Replace
76  static TOOL_ACTION find;
83 
84  // RC Lists
88 
89  // View controls
97  static TOOL_ACTION zoomFitObjects; // Zooms to bbox of items on screen (except page border)
105 
106  static TOOL_ACTION refreshPreview; // Similar to a synthetic mouseMoved event, but also
107  // used after a rotate, mirror, etc.
108 
111 
117 
122 
125 
126  // Panning with keyboard
131 
132  // Grid control
142 
143  // Units
151 
152  // Common Tools
156 
157  // Misc
165 
166  // Internal
170 
171  // Suite
182 
186  CURSOR_FAST_MOVE = 0x8000 };
187 
189  enum class REMOVE_FLAGS { NORMAL = 0x00, ALT = 0x01, CUT = 0x02 };
190 };
191 
192 
196 class EVENTS
197 {
198 public:
199  const static TOOL_EVENT SelectedEvent;
201  const static TOOL_EVENT ClearedEvent;
202 
205 
208 
212 
215 };
216 
217 #endif // __ACTIONS_H
218 
219 
static TOOL_ACTION listHotKeys
Definition: actions.h:178
static TOOL_ACTION pinLibrary
Definition: actions.h:109
static TOOL_ACTION show3DViewer
Definition: actions.h:158
static const TOOL_EVENT SelectedEvent
Definition: actions.h:199
static TOOL_ACTION zoomPreset
Definition: actions.h:98
static TOOL_ACTION findAndReplace
Definition: actions.h:77
static TOOL_ACTION zoomInCenter
Definition: actions.h:93
static TOOL_ACTION activatePointEditor
Definition: actions.h:168
virtual ~ACTIONS()
Definition: actions.h:44
static TOOL_ACTION pageSettings
Definition: actions.h:56
REMOVE_FLAGS
Definition: actions.h:189
static const TOOL_EVENT UnselectedEvent
Definition: actions.h:200
static TOOL_ACTION doDelete
Definition: actions.h:72
static const TOOL_EVENT DisambiguatePoint
Definition: actions.h:214
static TOOL_ACTION zoomTool
Definition: actions.h:99
static TOOL_ACTION gridResetOrigin
Definition: actions.h:138
static TOOL_ACTION changeEditMethod
Definition: actions.h:169
static TOOL_ACTION replaceAll
Definition: actions.h:81
static TOOL_ACTION cancelInteractive
Definition: actions.h:62
static TOOL_ACTION nextMarker
Definition: actions.h:86
static TOOL_ACTION cursorRight
Definition: actions.h:116
static TOOL_ACTION zoomFitScreen
Definition: actions.h:96
static TOOL_ACTION millimetersUnits
Definition: actions.h:146
static TOOL_ACTION reportBug
Cursor control event types.
Definition: actions.h:181
static TOOL_ACTION showSymbolLibTable
Definition: actions.h:174
static TOOL_ACTION cursorRightFast
Definition: actions.h:121
static TOOL_ACTION gridFast1
Definition: actions.h:133
static TOOL_ACTION unpinLibrary
Definition: actions.h:110
static TOOL_ACTION updatePcbFromSchematic
Definition: actions.h:163
static TOOL_ACTION donate
Definition: actions.h:179
static TOOL_ACTION zoomFitObjects
Definition: actions.h:97
static TOOL_ACTION print
Definition: actions.h:57
static TOOL_ACTION excludeMarker
Definition: actions.h:87
static TOOL_ACTION panLeft
Definition: actions.h:129
static TOOL_ACTION find
Definition: actions.h:76
static const TOOL_EVENT SelectedItemsModified
Selected items were moved, this can be very high frequency on the canvas, use with care.
Definition: actions.h:204
static TOOL_ACTION zoomOutCenter
Definition: actions.h:94
static TOOL_ACTION saveCopyAs
Definition: actions.h:53
static TOOL_ACTION pickerTool
Definition: actions.h:155
static TOOL_ACTION updateFind
Definition: actions.h:82
static TOOL_ACTION measureTool
Definition: actions.h:154
static TOOL_ACTION copy
Definition: actions.h:67
static TOOL_ACTION centerContents
Definition: actions.h:100
static TOOL_ACTION updateSchematicFromPcb
Definition: actions.h:164
static TOOL_ACTION gridFast2
Definition: actions.h:134
static TOOL_ACTION toggleCursor
Definition: actions.h:101
static TOOL_ACTION gridPreset
Definition: actions.h:139
static TOOL_ACTION showFootprintLibTable
Definition: actions.h:175
static TOOL_ACTION gridPrev
Definition: actions.h:136
static TOOL_ACTION panDown
Definition: actions.h:128
Gather all the events that are shared by tools.
Definition: actions.h:196
static TOOL_ACTION toggleGrid
Definition: actions.h:140
static TOOL_ACTION open
Definition: actions.h:50
static TOOL_ACTION showFootprintBrowser
Definition: actions.h:161
static TOOL_ACTION inchesUnits
Definition: actions.h:144
static TOOL_ACTION save
Definition: actions.h:51
static TOOL_ACTION doNew
Definition: actions.h:44
Generic, UI-independent tool event.
Definition: tool_event.h:152
static TOOL_ACTION cursorUpFast
Definition: actions.h:118
static TOOL_ACTION cursorDownFast
Definition: actions.h:119
static TOOL_ACTION cursorLeft
Definition: actions.h:115
static TOOL_ACTION panRight
Definition: actions.h:130
static TOOL_ACTION togglePolarCoords
Definition: actions.h:149
static TOOL_ACTION cut
Definition: actions.h:66
static const TOOL_EVENT UninhibitSelectionEditing
Used to inform tool that it should display the disambiguation menu.
Definition: actions.h:211
static TOOL_ACTION addLibrary
Definition: actions.h:49
static TOOL_ACTION quit
Definition: actions.h:59
static const TOOL_EVENT ClearedEvent
Selected item had a property changed (except movement)
Definition: actions.h:201
static TOOL_ACTION replaceAndFindNext
Definition: actions.h:80
static TOOL_ACTION plot
Definition: actions.h:58
static const TOOL_EVENT SelectedItemsMoved
Used to inform tools that the selection should temporarily be non-editable.
Definition: actions.h:207
static TOOL_ACTION cursorLeftFast
Definition: actions.h:120
static TOOL_ACTION updateMenu
Definition: actions.h:167
static TOOL_ACTION newLibrary
Definition: actions.h:48
static TOOL_ACTION milsUnits
Definition: actions.h:145
static TOOL_ACTION prevMarker
Definition: actions.h:85
static TOOL_ACTION pasteSpecial
Definition: actions.h:69
static TOOL_ACTION findNextMarker
Definition: actions.h:79
static TOOL_ACTION redo
Definition: actions.h:65
static TOOL_ACTION updateUnits
Definition: actions.h:147
static TOOL_ACTION showSymbolEditor
Definition: actions.h:160
static TOOL_ACTION zoomCenter
Definition: actions.h:95
static TOOL_ACTION saveAs
Definition: actions.h:52
static TOOL_ACTION cursorUp
Cursor control with keyboard.
Definition: actions.h:113
static TOOL_ACTION zoomRedraw
Definition: actions.h:90
static TOOL_ACTION cursorDblClick
Definition: actions.h:124
Represent a single user action.
Definition: tool_action.h:67
CURSOR_EVENT_TYPE
Definition: actions.h:184
static TOOL_ACTION resetLocalCoords
Definition: actions.h:150
static TOOL_ACTION help
Definition: actions.h:177
static const TOOL_EVENT InhibitSelectionEditing
Definition: actions.h:210
static TOOL_ACTION gridNext
Definition: actions.h:135
static TOOL_ACTION gridProperties
Definition: actions.h:141
Gather all the actions that are shared by tools.
Definition: actions.h:40
static TOOL_ACTION panUp
Definition: actions.h:127
static TOOL_ACTION zoomIn
Definition: actions.h:91
static TOOL_ACTION deleteTool
Definition: actions.h:73
static TOOL_ACTION zoomOut
Definition: actions.h:92
static TOOL_ACTION highContrastModeCycle
Definition: actions.h:104
static TOOL_ACTION undo
Definition: actions.h:64
static TOOL_ACTION toggleCursorStyle
Definition: actions.h:102
static TOOL_ACTION saveAll
Definition: actions.h:54
static TOOL_ACTION gridSetOrigin
Definition: actions.h:137
static TOOL_ACTION showSymbolBrowser
Definition: actions.h:159
static TOOL_ACTION openPreferences
Definition: actions.h:172
static TOOL_ACTION showContextMenu
Definition: actions.h:63
static TOOL_ACTION cursorDown
Definition: actions.h:114
static TOOL_ACTION getInvolved
Definition: actions.h:180
static TOOL_ACTION configurePaths
Definition: actions.h:173
static TOOL_ACTION highContrastMode
Definition: actions.h:103
static TOOL_ACTION toggleUnits
Definition: actions.h:148
static TOOL_ACTION selectAll
Definition: actions.h:70
static TOOL_ACTION findNext
Definition: actions.h:78
static TOOL_ACTION gettingStarted
Definition: actions.h:176
static TOOL_ACTION showFootprintEditor
Definition: actions.h:162
static TOOL_ACTION paste
Definition: actions.h:68
static TOOL_ACTION duplicate
Definition: actions.h:71
static TOOL_ACTION revert
Definition: actions.h:55
static TOOL_ACTION selectionTool
Definition: actions.h:153
static TOOL_ACTION refreshPreview
Definition: actions.h:106
static TOOL_ACTION cursorClick
Definition: actions.h:123