KiCad PCB EDA Suite
pcb_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 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 __PCB_ACTIONS_H
27 #define __PCB_ACTIONS_H
28 
29 #include <tool/tool_action.h>
30 #include <tool/actions.h>
31 #include <core/optional.h>
32 
33 class TOOL_EVENT;
34 class TOOL_MANAGER;
35 
42 class PCB_ACTIONS : public ACTIONS
43 {
44 public:
45  // Selection Tool
48 
51 
54 
58 
62 
65 
68 
71 
74 
77 
80 
83 
86 
87  // Edit Tool
90 
92  static TOOL_ACTION move;
93 
97 
99  static TOOL_ACTION flip;
100 
103 
106 
109 
112 
115 
118 
121 
125 
128 
131 
134 
135 
136  // Drawing Tool Activations
152 
155 
158 
161 
162  // Push and Shove Router Tool
163 
166 
169 
172 
175 
178 
182 
183 
186 
187  // Point Editor
190 
193 
194  // Placement tool
203 
204  // Position Relative Tool
207 
210 
211  // Display modes
223 
224  // Layer control
238 
239  static TOOL_ACTION layerChanged; // notification
240 
241  // Track & via size control
246 
247  static TOOL_ACTION trackViaSizeChanged; // notification
248 
249  // Zone actions
255 
258 
259  // Module editor tools
262 
265 
268 
271 
274 
277 
278  // Pad tools
281 
284 
287 
288  // Microwave tools
290 
292 
294 
296 
298 
299  // Locking
303 
304  // Miscellaneous
320 
321  // Ratsnest
325 
328 
331 
333 
336 
338  virtual OPT<TOOL_EVENT> TranslateLegacyId( int aId ) override;
339 };
340 
341 #endif
static TOOL_ACTION selectItems
Selects a list of items (specified as the event parameter)
Definition: pcb_actions.h:60
static TOOL_ACTION alignRight
Definition: pcb_actions.h:198
static TOOL_ACTION selectionClear
Clears the current selection.
Definition: pcb_actions.h:53
static TOOL_ACTION selectionActivate
Activation of the selection tool.
Definition: pcb_actions.h:47
static TOOL_ACTION layerBottom
Definition: pcb_actions.h:232
static TOOL_ACTION toggleLock
Definition: pcb_actions.h:300
static TOOL_ACTION drawLine
Definition: pcb_actions.h:137
static TOOL_ACTION placeModule
Definition: pcb_actions.h:149
static TOOL_ACTION placeImportedGraphics
Definition: pcb_actions.h:150
static TOOL_ACTION move
move an item
Definition: pcb_actions.h:92
static TOOL_ACTION unlock
Definition: pcb_actions.h:302
static TOOL_ACTION layerNext
Definition: pcb_actions.h:233
static TOOL_ACTION layerInner2
Definition: pcb_actions.h:227
static TOOL_ACTION editActivate
Activation of the edit tool.
Definition: pcb_actions.h:89
static TOOL_ACTION incWidth
Increase width of currently drawn line.
Definition: pcb_actions.h:154
static TOOL_ACTION layerInner5
Definition: pcb_actions.h:230
static TOOL_ACTION autoplaceOffboardComponents
Definition: pcb_actions.h:334
static TOOL_ACTION drawSimilarZone
Definition: pcb_actions.h:147
static TOOL_ACTION drillOrigin
Definition: pcb_actions.h:315
static TOOL_ACTION lock
Definition: pcb_actions.h:301
static TOOL_ACTION layerInner6
Definition: pcb_actions.h:231
static TOOL_ACTION zoneFillAll
Definition: pcb_actions.h:251
static TOOL_ACTION viaSizeInc
Definition: pcb_actions.h:244
static TOOL_ACTION drawArc
Definition: pcb_actions.h:140
static TOOL_ACTION microwaveCreateStubArc
Definition: pcb_actions.h:293
static TOOL_ACTION showHelp
Definition: pcb_actions.h:318
static TOOL_ACTION ratsnestLineMode
Definition: pcb_actions.h:212
static TOOL_ACTION autoplaceSelectedComponents
Definition: pcb_actions.h:335
static TOOL_ACTION layerAlphaDec
Definition: pcb_actions.h:236
static TOOL_ACTION zoneDisplayOutlines
Definition: pcb_actions.h:219
static TOOL_ACTION unselectItem
Definition: pcb_actions.h:57
static TOOL_ACTION selectNet
Selects all connections belonging to a single net.
Definition: pcb_actions.h:76
static TOOL_ACTION dragFreeAngle
Definition: pcb_actions.h:133
static TOOL_ACTION explodePadToShapes
Definition: pcb_actions.h:264
static TOOL_ACTION drawZoneKeepout
Definition: pcb_actions.h:145
static TOOL_ACTION enumeratePads
Tool for quick pad enumeration.
Definition: pcb_actions.h:267
static TOOL_ACTION unselectItems
Definition: pcb_actions.h:61
static TOOL_ACTION layerAlphaInc
Definition: pcb_actions.h:235
static TOOL_ACTION alignCenterY
Definition: pcb_actions.h:200
static TOOL_ACTION properties
Activation of the edit tool.
Definition: pcb_actions.h:105
static TOOL_ACTION zoneDisplayDisable
Definition: pcb_actions.h:218
static TOOL_ACTION trackWidthDec
Definition: pcb_actions.h:243
static TOOL_ACTION selectionMenu
Runs a selection menu to select from a list of items.
Definition: pcb_actions.h:64
static TOOL_ACTION selectConnection
Selects a connection between junctions.
Definition: pcb_actions.h:67
static TOOL_ACTION selectpositionRelativeItem
Selection of anchor item for position relative tool.
Definition: pcb_actions.h:209
static TOOL_ACTION microwaveCreateLine
Definition: pcb_actions.h:297
static TOOL_ACTION removeAlt
Definition: pcb_actions.h:124
static TOOL_ACTION trackViaSizeChanged
Definition: pcb_actions.h:247
static TOOL_ACTION placePad
Activation of the drawing tool (placing a PAD)
Definition: pcb_actions.h:261
static TOOL_ACTION drag45Degree
Definition: pcb_actions.h:132
static TOOL_ACTION mirror
Mirroring of selected items.
Definition: pcb_actions.h:102
static TOOL_ACTION distributeVertically
Definition: pcb_actions.h:202
static TOOL_ACTION routerActivateSingle
Activation of the Push and Shove router.
Definition: pcb_actions.h:165
static TOOL_ACTION updateUnits
Definition: pcb_actions.h:309
static TOOL_ACTION highlightNetCursor
Definition: pcb_actions.h:313
static TOOL_ACTION layerInner3
Definition: pcb_actions.h:228
static TOOL_ACTION setAnchor
Definition: pcb_actions.h:151
static TOOL_ACTION deleteItemCursor
Definition: pcb_actions.h:310
static TOOL_ACTION routerActivateTuneSingleTrace
Activation of the Push and Shove router (tune single line mode)
Definition: pcb_actions.h:171
static TOOL_ACTION placeText
Definition: pcb_actions.h:141
static TOOL_ACTION showLocalRatsnest
Definition: pcb_actions.h:322
static TOOL_ACTION zoneFill
Definition: pcb_actions.h:250
static TOOL_ACTION resetCoords
Definition: pcb_actions.h:307
static TOOL_ACTION crossProbeSchToPcb
Definition: pcb_actions.h:316
static TOOL_ACTION alignBottom
Definition: pcb_actions.h:196
static TOOL_ACTION decWidth
Decrease width of currently drawn line.
Definition: pcb_actions.h:157
static TOOL_ACTION drawGraphicPolygon
Definition: pcb_actions.h:138
static TOOL_ACTION moveExact
Activation of the exact move tool.
Definition: pcb_actions.h:108
static TOOL_ACTION layerTop
Definition: pcb_actions.h:225
static TOOL_ACTION distributeHorizontally
Definition: pcb_actions.h:201
static TOOL_ACTION pushPadSettings
Copy the current pad's settings to other pads in the module or on the board.
Definition: pcb_actions.h:286
Class TOOL_MANAGER.
Definition: tool_manager.h:49
static TOOL_ACTION highContrastMode
Definition: pcb_actions.h:220
static TOOL_ACTION duplicate
Activation of the duplication tool.
Definition: pcb_actions.h:111
static TOOL_ACTION trackWidthInc
Definition: pcb_actions.h:242
static TOOL_ACTION duplicateIncrement
Activation of the duplication tool with incrementing (e.g. pad number)
Definition: pcb_actions.h:114
static TOOL_ACTION appendBoard
Definition: pcb_actions.h:317
static TOOL_ACTION rotateCw
Rotation of selected objects.
Definition: pcb_actions.h:95
static TOOL_ACTION layerPrev
Definition: pcb_actions.h:234
static TOOL_ACTION routerActivateTuneDiffPairSkew
Activation of the Push and Shove router (skew tuning mode)
Definition: pcb_actions.h:177
static TOOL_ACTION toBeDone
Definition: pcb_actions.h:319
static TOOL_ACTION drawDimension
Definition: pcb_actions.h:142
static TOOL_ACTION find
Find an item.
Definition: pcb_actions.h:327
static TOOL_ACTION copyPadSettings
Copy the selected pad's settings to the board design settings.
Definition: pcb_actions.h:280
static TOOL_ACTION hideLocalRatsnest
Definition: pcb_actions.h:323
static TOOL_ACTION pickerTool
Definition: pcb_actions.h:306
static TOOL_ACTION pointEditorAddCorner
Break outline (insert additional points to an edge)
Definition: pcb_actions.h:189
static TOOL_ACTION pointEditorRemoveCorner
Removes a corner.
Definition: pcb_actions.h:192
Class TOOL_EVENT.
Definition: tool_event.h:167
static TOOL_ACTION createArray
Tool for creating an array of objects.
Definition: pcb_actions.h:270
static TOOL_ACTION applyPadSettings
Copy the pad settings in the board design settings to the selected pad.
Definition: pcb_actions.h:283
static TOOL_ACTION zoneMerge
Definition: pcb_actions.h:254
static TOOL_ACTION alignLeft
Definition: pcb_actions.h:197
static TOOL_ACTION microwaveCreateGap
Definition: pcb_actions.h:289
static TOOL_ACTION routerActivateTuneDiffPair
Activation of the Push and Shove router (diff pair tuning mode)
Definition: pcb_actions.h:174
static TOOL_ACTION drawVia
Definition: pcb_actions.h:144
static TOOL_ACTION alignTop
Definition: pcb_actions.h:195
static TOOL_ACTION exchangeFootprints
Exchange footprints of modules.
Definition: pcb_actions.h:120
static TOOL_ACTION selectCopper
Selects whole copper connection.
Definition: pcb_actions.h:73
static TOOL_ACTION drawZoneCutout
Definition: pcb_actions.h:146
static TOOL_ACTION placeTarget
Definition: pcb_actions.h:148
static TOOL_ACTION routerInlineDrag
Activation of the Push and Shove router (inline dragging mode)
Definition: pcb_actions.h:185
static TOOL_ACTION zoneUnfillAll
Definition: pcb_actions.h:253
static TOOL_ACTION selectionTool
Definition: pcb_actions.h:305
static TOOL_ACTION moduleEdgeOutlines
Display module edges as outlines.
Definition: pcb_actions.h:273
static TOOL_ACTION inlineBreakTrack
Breaks track when router is not activated.
Definition: pcb_actions.h:130
static TOOL_ACTION microwaveCreateStub
Definition: pcb_actions.h:291
static TOOL_ACTION zoneUnfill
Definition: pcb_actions.h:252
static TOOL_ACTION expandSelectedConnection
Expands the current selection to select a connection between two junctions.
Definition: pcb_actions.h:70
static TOOL_ACTION breakTrack
Break a single track into two segments at the cursor.
Definition: pcb_actions.h:127
static TOOL_ACTION clearHighlight
Definition: pcb_actions.h:311
static TOOL_ACTION updateFootprints
Update footprints to reflect any changes in the library.
Definition: pcb_actions.h:117
static TOOL_ACTION padDisplayMode
Definition: pcb_actions.h:214
static TOOL_ACTION rotateCcw
Definition: pcb_actions.h:96
static TOOL_ACTION drawCircle
Definition: pcb_actions.h:139
static TOOL_ACTION viaDisplayMode
Definition: pcb_actions.h:215
static TOOL_ACTION filterSelection
Filters the items in the current selection (invokes dialog)
Definition: pcb_actions.h:85
static TOOL_ACTION moduleTextOutlines
Display module texts as outlines.
Definition: pcb_actions.h:276
static TOOL_ACTION zoneDuplicate
Duplicate zone onto another layer.
Definition: pcb_actions.h:257
static TOOL_ACTION createPadFromShapes
Definition: pcb_actions.h:263
static TOOL_ACTION flip
Flipping of selected objects.
Definition: pcb_actions.h:99
static TOOL_ACTION microwaveCreateFunctionShape
Definition: pcb_actions.h:295
static TOOL_ACTION arcPosture
Switch posture when drawing arc.
Definition: pcb_actions.h:160
static TOOL_ACTION layerChanged
Definition: pcb_actions.h:239
Class PCB_ACTIONS.
Definition: pcb_actions.h:42
static TOOL_ACTION highContrastInc
Definition: pcb_actions.h:221
static TOOL_ACTION highlightNet
Definition: pcb_actions.h:312
static TOOL_ACTION highlightNetSelection
Definition: pcb_actions.h:314
static TOOL_ACTION routerActivateSettingsDialog
Activation of the Push and Shove settings dialogs.
Definition: pcb_actions.h:180
static TOOL_ACTION selectOnSheetFromEeschema
Selects all components on sheet from Eeschema crossprobing.
Definition: pcb_actions.h:79
static TOOL_ACTION editFootprintInFpEditor
Definition: pcb_actions.h:332
Class TOOL_ACTION.
Definition: tool_action.h:46
static TOOL_ACTION selectItem
Selects an item (specified as the event parameter).
Definition: pcb_actions.h:56
static TOOL_ACTION graphicDisplayMode
Definition: pcb_actions.h:216
static TOOL_ACTION positionRelative
Activation of the position relative tool.
Definition: pcb_actions.h:206
boost::optional< T > OPT
Definition: optional.h:7
Class ACTIONS.
Definition: actions.h:41
static TOOL_ACTION layerInner4
Definition: pcb_actions.h:229
static TOOL_ACTION findMove
Find an item and start moving.
Definition: pcb_actions.h:330
static TOOL_ACTION updateLocalRatsnest
Definition: pcb_actions.h:324
static TOOL_ACTION remove
Deleting a BOARD_ITEM.
Definition: pcb_actions.h:123
virtual OPT< TOOL_EVENT > TranslateLegacyId(int aId) override
Definition: pcb_actions.cpp:32
static TOOL_ACTION layerInner1
Definition: pcb_actions.h:226
static TOOL_ACTION alignCenterX
Definition: pcb_actions.h:199
static TOOL_ACTION routerActivateDiffPair
Activation of the Push and Shove router (differential pair mode)
Definition: pcb_actions.h:168
static TOOL_ACTION highContrastDec
Definition: pcb_actions.h:222
static TOOL_ACTION viaSizeDec
Definition: pcb_actions.h:245
static TOOL_ACTION drawZone
Definition: pcb_actions.h:143
static TOOL_ACTION measureTool
Definition: pcb_actions.h:308
static TOOL_ACTION selectionCursor
Select a single item under the cursor position.
Definition: pcb_actions.h:50
static TOOL_ACTION trackDisplayMode
Definition: pcb_actions.h:213
static TOOL_ACTION selectSameSheet
Selects all components on the same sheet as the selected footprint.
Definition: pcb_actions.h:82
static TOOL_ACTION layerToggle
Definition: pcb_actions.h:237
static TOOL_ACTION zoneDisplayEnable
Definition: pcb_actions.h:217
static TOOL_ACTION routerActivateDpDimensionsDialog
Definition: pcb_actions.h:181