KiCad PCB EDA Suite
Loading...
Searching...
No Matches
toolbars_sch_editor.cpp
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 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 2008 Wayne Stambaugh <[email protected]>
6 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
7 * Copyright (C) 2019 CERN
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, you may find one here:
21 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22 * or you may search the http://www.gnu.org website for the version 2 license,
23 * or you may write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25 */
26
27#include <advanced_config.h>
29#include <sch_draw_panel.h>
30#include <sch_edit_frame.h>
31#include <kiface_base.h>
32#include <bitmaps.h>
33#include <eeschema_id.h>
34#include <pgm_base.h>
35#include <python_scripting.h>
36#include <tool/tool_manager.h>
37#include <tool/action_toolbar.h>
38#include <tools/sch_actions.h>
45#include <toolbars_sch_editor.h>
46
47
48std::optional<TOOLBAR_CONFIGURATION> SCH_EDIT_TOOLBAR_SETTINGS::DefaultToolbarConfig( TOOLBAR_LOC aToolbar )
49{
51
52 // clang-format off
53 switch( aToolbar )
54 {
56 return std::nullopt;
57
59 config.AppendAction( ACTIONS::toggleGrid )
60 .AppendAction( ACTIONS::toggleGridOverrides )
61 .AppendAction( ACTIONS::inchesUnits )
62 .AppendAction( ACTIONS::milsUnits )
63 .AppendAction( ACTIONS::millimetersUnits )
64 .AppendGroup( TOOLBAR_GROUP_CONFIG( _( "Crosshair modes" ) )
67 .AddAction( ACTIONS::cursor45Crosshairs ) );
68
69 config.AppendSeparator()
70 .AppendAction( SCH_ACTIONS::toggleHiddenPins );
71
72 config.AppendSeparator()
73 .AppendAction( SCH_ACTIONS::lineModeFree )
74 .AppendAction( SCH_ACTIONS::lineMode90 )
75 .AppendAction( SCH_ACTIONS::lineMode45 );
76
77 config.AppendSeparator()
78 .AppendAction( SCH_ACTIONS::toggleAnnotateAuto );
79
80 config.AppendSeparator()
81 .AppendAction( SCH_ACTIONS::showHierarchy )
82 .AppendAction( ACTIONS::showProperties );
83
84 if( ADVANCED_CFG::GetCfg().m_DrawBoundingBoxes )
86
87 /* TODO (ISM): Handle context menus
88 EE_SELECTION_TOOL* selTool = m_toolManager->GetTool<EE_SELECTION_TOOL>();
89 std::unique_ptr<ACTION_MENU> gridMenu = std::make_unique<ACTION_MENU>( false, selTool );
90 gridMenu->Add( ACTIONS::gridProperties );
91 m_tbLeft->AddToolContextMenu( ACTIONS::toggleGrid, std::move( gridMenu ) );
92 */
93 break;
94
96 config.AppendGroup( TOOLBAR_GROUP_CONFIG( _( "Selection modes" ) )
97 .AddAction( ACTIONS::selectSetRect )
98 .AddAction( ACTIONS::selectSetLasso ) )
99 .AppendAction( SCH_ACTIONS::highlightNetTool );
100
101 config.AppendSeparator()
102 .AppendAction( SCH_ACTIONS::placeSymbol )
103 .AppendAction( SCH_ACTIONS::placePower )
104 .AppendAction( SCH_ACTIONS::drawWire )
105 .AppendAction( SCH_ACTIONS::drawBus )
106 .AppendAction( SCH_ACTIONS::placeBusWireEntry )
107 .AppendAction( SCH_ACTIONS::placeNoConnect )
108 .AppendAction( SCH_ACTIONS::placeJunction )
109 .AppendAction( SCH_ACTIONS::placeLabel )
110 .AppendAction( SCH_ACTIONS::placeClassLabel )
111 .AppendAction( SCH_ACTIONS::drawRuleArea )
112 .AppendAction( SCH_ACTIONS::placeGlobalLabel )
113 .AppendAction( SCH_ACTIONS::placeHierLabel )
114 .AppendAction( SCH_ACTIONS::drawSheet )
115 .AppendAction( SCH_ACTIONS::placeSheetPin )
116 .AppendAction( SCH_ACTIONS::syncAllSheetsPins );
117
118 config.AppendSeparator()
119 .AppendAction( SCH_ACTIONS::placeSchematicText )
120 .AppendAction( SCH_ACTIONS::drawTextBox )
121 .AppendAction( SCH_ACTIONS::drawTable )
122 .AppendAction( SCH_ACTIONS::drawRectangle )
123 .AppendAction( SCH_ACTIONS::drawCircle )
124 .AppendAction( SCH_ACTIONS::drawArc )
125 .AppendAction( SCH_ACTIONS::drawBezier )
126 .AppendAction( SCH_ACTIONS::drawLines )
127 .AppendAction( SCH_ACTIONS::placeImage )
128 .AppendAction( ACTIONS::deleteTool );
129
130 break;
131
133 if( Kiface().IsSingle() ) // not when under a project mgr
134 {
135 config.AppendAction( ACTIONS::doNew );
136 config.AppendAction( ACTIONS::open );
137 }
138
139 config.AppendAction( ACTIONS::save );
140
141 config.AppendSeparator()
142 .AppendAction( SCH_ACTIONS::schematicSetup );
143
144 config.AppendSeparator()
145 .AppendAction( ACTIONS::pageSettings )
146 .AppendAction( ACTIONS::print )
147 .AppendAction( ACTIONS::plot );
148
149 config.AppendSeparator()
150 .AppendAction( ACTIONS::paste );
151
152 config.AppendSeparator()
153 .AppendAction( ACTIONS::undo )
154 .AppendAction( ACTIONS::redo );
155
156 config.AppendSeparator()
157 .AppendAction( ACTIONS::find )
158 .AppendAction( ACTIONS::findAndReplace );
159
160 config.AppendSeparator()
161 .AppendAction( ACTIONS::zoomRedraw )
162 .AppendAction( ACTIONS::zoomInCenter )
163 .AppendAction( ACTIONS::zoomOutCenter )
164 .AppendAction( ACTIONS::zoomFitScreen )
165 .AppendAction( ACTIONS::zoomFitObjects )
166 .AppendAction( ACTIONS::zoomTool );
167
168 config.AppendSeparator()
169 .AppendAction( SCH_ACTIONS::navigateBack )
170 .AppendAction( SCH_ACTIONS::navigateUp )
171 .AppendAction( SCH_ACTIONS::navigateForward );
172
173 config.AppendSeparator()
174 .AppendAction( SCH_ACTIONS::rotateCCW )
175 .AppendAction( SCH_ACTIONS::rotateCW )
176 .AppendAction( SCH_ACTIONS::mirrorV )
177 .AppendAction( SCH_ACTIONS::mirrorH )
178 .AppendAction( ACTIONS::group )
179 .AppendAction( ACTIONS::ungroup );
180
181 config.AppendSeparator()
182 .AppendAction( ACTIONS::showSymbolEditor )
183 .AppendAction( ACTIONS::showSymbolBrowser )
184 .AppendAction( ACTIONS::showFootprintEditor );
185
186 config.AppendSeparator()
187 .AppendAction( SCH_ACTIONS::annotate )
188 .AppendAction( SCH_ACTIONS::runERC )
189 .AppendAction( SCH_ACTIONS::showSimulator )
190 .AppendAction( SCH_ACTIONS::assignFootprints )
191 .AppendAction( SCH_ACTIONS::editSymbolFields )
192 .AppendAction( SCH_ACTIONS::generateBOM );
193
194 config.AppendSeparator()
195 .AppendAction( SCH_ACTIONS::showPcbNew );
196
197 // Insert all the IPC plugins here on the toolbar
198 // TODO (ISM): Move this to individual actions for each script
200
201 break;
202 }
203
204 // clang-format on
205 return config;
206}
207
208
210{
212
213 // IPC/Scripting plugin control
214 // TODO (ISM): Clean this up to make IPC actions just normal tool actions to get rid of this entire
215 // control
216 auto pluginControlFactory =
217 [this]( ACTION_TOOLBAR* aToolbar )
218 {
219 // Add scripting console and API plugins
220 bool scriptingAvailable = SCRIPTING::IsWxAvailable();
221
222 #ifdef KICAD_IPC_API
223 bool haveApiPlugins = Pgm().GetCommonSettings()->m_Api.enable_server &&
224 !Pgm().GetPluginManager().GetActionsForScope( PluginActionScope() ).empty();
225 #else
226 bool haveApiPlugins = false;
227 #endif
228
229 if( scriptingAvailable || haveApiPlugins )
230 {
231 aToolbar->AddScaledSeparator( aToolbar->GetParent() );
232
233 if( haveApiPlugins )
234 AddApiPluginTools( aToolbar );
235 }
236 };
237
239}
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
static TOOL_ACTION toggleGrid
Definition actions.h:197
static TOOL_ACTION paste
Definition actions.h:80
static TOOL_ACTION zoomRedraw
Definition actions.h:131
static TOOL_ACTION millimetersUnits
Definition actions.h:205
static TOOL_ACTION cursorSmallCrosshairs
Definition actions.h:151
static TOOL_ACTION zoomOutCenter
Definition actions.h:135
static TOOL_ACTION selectSetLasso
Definition actions.h:220
static TOOL_ACTION selectSetRect
Set lasso selection mode.
Definition actions.h:219
static TOOL_ACTION group
Definition actions.h:238
static TOOL_ACTION showSymbolEditor
Definition actions.h:259
static TOOL_ACTION showSymbolBrowser
Definition actions.h:258
static TOOL_ACTION findAndReplace
Definition actions.h:117
static TOOL_ACTION milsUnits
Definition actions.h:204
static TOOL_ACTION ungroup
Definition actions.h:239
static TOOL_ACTION toggleBoundingBoxes
Definition actions.h:156
static TOOL_ACTION plot
Definition actions.h:65
static TOOL_ACTION open
Definition actions.h:57
static TOOL_ACTION pageSettings
Definition actions.h:63
static TOOL_ACTION undo
Definition actions.h:75
static TOOL_ACTION inchesUnits
Definition actions.h:203
static TOOL_ACTION save
Definition actions.h:58
static TOOL_ACTION zoomFitScreen
Definition actions.h:141
static TOOL_ACTION redo
Definition actions.h:76
static TOOL_ACTION deleteTool
Definition actions.h:86
static TOOL_ACTION zoomTool
Definition actions.h:145
static TOOL_ACTION cursor45Crosshairs
Definition actions.h:153
static TOOL_ACTION showFootprintEditor
Definition actions.h:261
static TOOL_ACTION print
Definition actions.h:64
static TOOL_ACTION showProperties
Definition actions.h:265
static TOOL_ACTION doNew
Definition actions.h:54
static TOOL_ACTION zoomFitObjects
Definition actions.h:142
static TOOL_ACTION zoomInCenter
Definition actions.h:134
static TOOL_ACTION toggleGridOverrides
Definition actions.h:198
static TOOL_ACTION cursorFullCrosshairs
Definition actions.h:152
static TOOL_ACTION find
Definition actions.h:116
static ACTION_TOOLBAR_CONTROL ipcScripting
Define the structure of a toolbar with buttons that invoke ACTIONs.
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
void RegisterCustomToolbarControlFactory(const ACTION_TOOLBAR_CONTROL &aControlDesc, const ACTION_TOOLBAR_CONTROL_FACTORY &aControlFactory)
Register a creation factory for toolbar controls that are present in this frame.
virtual void configureToolbars()
virtual void AddApiPluginTools(ACTION_TOOLBAR *aToolbar)
Append actions from API plugins to the given toolbar.
virtual COMMON_SETTINGS * GetCommonSettings() const
Definition pgm_base.cpp:576
static TOOL_ACTION showPcbNew
static TOOL_ACTION rotateCCW
static TOOL_ACTION placeClassLabel
Definition sch_actions.h:79
static TOOL_ACTION placeSheetPin
Definition sch_actions.h:85
static TOOL_ACTION assignFootprints
static TOOL_ACTION mirrorV
static TOOL_ACTION placeGlobalLabel
Definition sch_actions.h:80
static TOOL_ACTION editSymbolFields
static TOOL_ACTION drawTextBox
Definition sch_actions.h:93
static TOOL_ACTION toggleAnnotateAuto
static TOOL_ACTION syncAllSheetsPins
Definition sch_actions.h:91
static TOOL_ACTION drawArc
Definition sch_actions.h:97
static TOOL_ACTION drawSheet
Definition sch_actions.h:82
static TOOL_ACTION navigateBack
static TOOL_ACTION schematicSetup
static TOOL_ACTION highlightNetTool
static TOOL_ACTION drawRectangle
Definition sch_actions.h:95
static TOOL_ACTION drawLines
Definition sch_actions.h:99
static TOOL_ACTION placeHierLabel
Definition sch_actions.h:81
static TOOL_ACTION placeLabel
Definition sch_actions.h:78
static TOOL_ACTION drawCircle
Definition sch_actions.h:96
static TOOL_ACTION placeBusWireEntry
Definition sch_actions.h:77
static TOOL_ACTION drawBezier
Definition sch_actions.h:98
static TOOL_ACTION drawWire
Definition sch_actions.h:72
static TOOL_ACTION lineMode45
static TOOL_ACTION rotateCW
static TOOL_ACTION generateBOM
static TOOL_ACTION showHierarchy
static TOOL_ACTION placeJunction
Definition sch_actions.h:76
static TOOL_ACTION drawRuleArea
static TOOL_ACTION placeSymbol
Definition sch_actions.h:66
static TOOL_ACTION placeImage
static TOOL_ACTION navigateForward
static TOOL_ACTION mirrorH
static TOOL_ACTION showSimulator
static TOOL_ACTION drawBus
Definition sch_actions.h:73
static TOOL_ACTION runERC
Inspection and Editing.
static TOOL_ACTION drawTable
Definition sch_actions.h:94
static TOOL_ACTION lineMode90
static TOOL_ACTION placeSchematicText
Definition sch_actions.h:92
static TOOL_ACTION lineModeFree
static TOOL_ACTION annotate
static TOOL_ACTION placeNoConnect
Definition sch_actions.h:75
static TOOL_ACTION toggleHiddenPins
static TOOL_ACTION placePower
Definition sch_actions.h:68
static TOOL_ACTION navigateUp
void configureToolbars() override
PLUGIN_ACTION_SCOPE PluginActionScope() const override
std::optional< TOOLBAR_CONFIGURATION > DefaultToolbarConfig(TOOLBAR_LOC aToolbar) override
Get the default tools to show on the specified canvas toolbar.
#define _(s)
PGM_BASE & Pgm()
The global program "get" accessor.
Definition pgm_base.cpp:913
see class PGM_BASE
@ RIGHT
Toolbar on the right side of the canvas.
@ LEFT
Toolbar on the left side of the canvas.
@ TOP_AUX
Toolbar on the top of the canvas.
@ TOP_MAIN
Toolbar on the top of the canvas.