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 (C) 2004-2019 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/ee_actions.h>
44
45/* Create the main Horizontal Toolbar for the schematic editor
46 */
48{
49 if( m_mainToolBar )
50 {
52 }
53 else
54 {
56 wxDefaultPosition, wxDefaultSize,
57 KICAD_AUI_TB_STYLE | wxAUI_TB_HORZ_LAYOUT | wxAUI_TB_HORIZONTAL );
59 }
60
61 // Set up toolbar
62 if( Kiface().IsSingle() ) // not when under a project mgr
63 {
66 }
67
69
72
77
80
84
88
96
101
107
112
120
123
124 // Add scripting console and API plugins
125 bool scriptingAvailable = SCRIPTING::IsWxAvailable();
126#ifdef KICAD_IPC_API
127 bool haveApiPlugins = Pgm().GetCommonSettings()->m_Api.enable_server &&
128 !Pgm().GetPluginManager().GetActionsForScope( PLUGIN_ACTION_SCOPE::SCHEMATIC ).empty();
129#else
130 bool haveApiPlugins = false;
131#endif
132
133 if( scriptingAvailable || haveApiPlugins )
134 {
136
137 if( scriptingAvailable )
139
140 if( haveApiPlugins )
142 }
143
144 // after adding the tools to the toolbar, must call Realize() to reflect the changes
146}
147
148
149/* Create Vertical Right Toolbar
150 */
152{
153 if( m_drawToolBar )
154 {
156 }
157 else
158 {
159 m_drawToolBar = new ACTION_TOOLBAR( this, ID_V_TOOLBAR, wxDefaultPosition, wxDefaultSize,
160 KICAD_AUI_TB_STYLE | wxAUI_TB_VERTICAL );
162 }
163
164 // Set up toolbar
167
184
195
197}
198
199
200/* Create Vertical Left Toolbar (Option Toolbar)
201 */
203{
204 if( m_optionsToolBar )
205 {
207 }
208 else
209 {
211 wxDefaultPosition, wxDefaultSize,
212 KICAD_AUI_TB_STYLE | wxAUI_TB_VERTICAL );
214 }
215
222
225
230
233
237
238 if( ADVANCED_CFG::GetCfg().m_DrawBoundingBoxes )
240
242 std::unique_ptr<ACTION_MENU> gridMenu = std::make_unique<ACTION_MENU>( false, selTool );
243 gridMenu->Add( ACTIONS::gridProperties );
245
247}
248
249
251{
253
254 // Ensure m_show_search is up to date (the pane can be closed outside the menu)
255 m_show_search = m_auimgr.GetPane( SearchPaneName() ).IsShown();
256
258
259 wxAuiPaneInfo& searchPaneInfo = m_auimgr.GetPane( SearchPaneName() );
260 searchPaneInfo.Show( m_show_search );
261
262 if( m_show_search )
263 {
264 searchPaneInfo.Direction( cfg->m_AuiPanels.search_panel_dock_direction );
265
266 if( cfg->m_AuiPanels.search_panel_dock_direction == wxAUI_DOCK_TOP
267 || cfg->m_AuiPanels.search_panel_dock_direction == wxAUI_DOCK_BOTTOM )
268 {
269 SetAuiPaneSize( m_auimgr, searchPaneInfo, -1, cfg->m_AuiPanels.search_panel_height );
270 }
271 else if( cfg->m_AuiPanels.search_panel_dock_direction == wxAUI_DOCK_LEFT
272 || cfg->m_AuiPanels.search_panel_dock_direction == wxAUI_DOCK_RIGHT )
273 {
274 SetAuiPaneSize( m_auimgr, searchPaneInfo, cfg->m_AuiPanels.search_panel_width, -1 );
275 }
276
278 }
279 else
280 {
281 cfg->m_AuiPanels.search_panel_height = m_searchPane->GetSize().y;
282 cfg->m_AuiPanels.search_panel_width = m_searchPane->GetSize().x;
283 cfg->m_AuiPanels.search_panel_dock_direction = searchPaneInfo.dock_direction;
284 m_auimgr.Update();
285 }
286}
287
288
290{
291 if( !m_propertiesPanel )
292 return;
293
294 bool show = !m_propertiesPanel->IsShownOnScreen();
295
296 wxAuiPaneInfo& propertiesPaneInfo = m_auimgr.GetPane( PropertiesPaneName() );
297 propertiesPaneInfo.Show( show );
298
300
301 EESCHEMA_SETTINGS* settings = eeconfig();
302
303 if( show )
304 {
305 SetAuiPaneSize( m_auimgr, propertiesPaneInfo,
306 settings->m_AuiPanels.properties_panel_width, -1 );
307 }
308 else
309 {
311 m_auimgr.Update();
312 }
313}
314
315
317{
319
320 wxCHECK( cfg, /* void */ );
321
322 wxAuiPaneInfo& hierarchy_pane = m_auimgr.GetPane( SchematicHierarchyPaneName() );
323
324 hierarchy_pane.Show( !hierarchy_pane.IsShown() );
325
327
328 if( hierarchy_pane.IsShown() )
329 {
330 if( hierarchy_pane.IsFloating() )
331 {
332 hierarchy_pane.FloatingSize( cfg->m_AuiPanels.hierarchy_panel_float_width,
334 m_auimgr.Update();
335 }
336 else if( cfg->m_AuiPanels.hierarchy_panel_docked_width > 0 )
337 {
338 // SetAuiPaneSize also updates m_auimgr
339 SetAuiPaneSize( m_auimgr, hierarchy_pane,
341 }
342 }
343 else
344 {
345 if( hierarchy_pane.IsFloating() )
346 {
347 cfg->m_AuiPanels.hierarchy_panel_float_width = hierarchy_pane.floating_size.x;
348 cfg->m_AuiPanels.hierarchy_panel_float_height = hierarchy_pane.floating_size.y;
349 }
350 else
351 {
353 }
354
355 m_auimgr.Update();
356 }
357}
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
static TOOL_ACTION gridProperties
Definition: actions.h:178
static TOOL_ACTION toggleGrid
Definition: actions.h:176
static TOOL_ACTION paste
Definition: actions.h:71
static TOOL_ACTION zoomRedraw
Definition: actions.h:115
static TOOL_ACTION millimetersUnits
Definition: actions.h:184
static TOOL_ACTION zoomOutCenter
Definition: actions.h:119
static TOOL_ACTION showSymbolEditor
Definition: actions.h:200
static TOOL_ACTION showSymbolBrowser
Definition: actions.h:199
static TOOL_ACTION findAndReplace
Definition: actions.h:101
static TOOL_ACTION milsUnits
Definition: actions.h:183
static TOOL_ACTION toggleBoundingBoxes
Definition: actions.h:136
static TOOL_ACTION plot
Definition: actions.h:58
static TOOL_ACTION open
Definition: actions.h:50
static TOOL_ACTION pageSettings
Definition: actions.h:56
static TOOL_ACTION undo
Definition: actions.h:67
static TOOL_ACTION inchesUnits
Definition: actions.h:182
static TOOL_ACTION toggleCursorStyle
Definition: actions.h:133
static TOOL_ACTION selectionTool
Definition: actions.h:191
static TOOL_ACTION save
Definition: actions.h:51
static TOOL_ACTION zoomFitScreen
Definition: actions.h:125
static TOOL_ACTION redo
Definition: actions.h:68
static TOOL_ACTION deleteTool
Definition: actions.h:77
static TOOL_ACTION zoomTool
Definition: actions.h:128
static TOOL_ACTION showFootprintEditor
Definition: actions.h:202
static TOOL_ACTION print
Definition: actions.h:57
static TOOL_ACTION showProperties
Definition: actions.h:205
static TOOL_ACTION doNew
Definition: actions.h:47
static TOOL_ACTION zoomFitObjects
Definition: actions.h:126
static TOOL_ACTION zoomInCenter
Definition: actions.h:118
static TOOL_ACTION toggleGridOverrides
Definition: actions.h:177
static TOOL_ACTION find
Definition: actions.h:100
Define the structure of a toolbar with buttons that invoke ACTIONs.
static constexpr bool TOGGLE
static constexpr bool CANCEL
void SetAuiManager(wxAuiManager *aManager)
Set the AUI manager that this toolbar belongs to.
void AddToolContextMenu(const TOOL_ACTION &aAction, std::unique_ptr< ACTION_MENU > aMenu)
Add a context menu to a specific tool item on the toolbar.
void AddScaledSeparator(wxWindow *aWindow)
Add a separator that introduces space on either side to not squash the tools when scaled.
bool KiRealize()
Use this over Realize() to avoid a rendering glitch with fixed orientation toolbars.
void ClearToolbar()
Clear the toolbar and remove all associated menus.
void Add(const TOOL_ACTION &aAction, bool aIsToggleEntry=false, bool aIsCancellable=false)
Add a TOOL_ACTION-based button to the toolbar.
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
static constexpr int KICAD_AUI_TB_STYLE
< Default style flags used for wxAUI toolbars.
wxAuiManager m_auimgr
ACTION_TOOLBAR * m_optionsToolBar
static const wxString PropertiesPaneName()
ACTION_TOOLBAR * m_mainToolBar
ACTION_TOOLBAR * m_drawToolBar
SEARCH_PANE * m_searchPane
PROPERTIES_PANEL * m_propertiesPanel
virtual void addApiPluginTools()
Append actions from API plugins to the main toolbar.
static TOOL_ACTION mirrorV
Definition: ee_actions.h:126
static TOOL_ACTION runERC
Definition: ee_actions.h:151
static TOOL_ACTION toggleAnnotateAuto
Definition: ee_actions.h:267
static TOOL_ACTION lineMode90
Definition: ee_actions.h:262
static TOOL_ACTION toggleHiddenPins
Definition: ee_actions.h:233
static TOOL_ACTION drawTable
Definition: ee_actions.h:99
static TOOL_ACTION syncAllSheetsPins
Definition: ee_actions.h:96
static TOOL_ACTION navigateForward
Definition: ee_actions.h:221
static TOOL_ACTION placeSymbol
Definition: ee_actions.h:79
static TOOL_ACTION navigateBack
Definition: ee_actions.h:222
static TOOL_ACTION showPythonConsole
Definition: ee_actions.h:257
static TOOL_ACTION drawRuleArea
Definition: ee_actions.h:107
static TOOL_ACTION placeClassLabel
Definition: ee_actions.h:88
static TOOL_ACTION drawWire
Definition: ee_actions.h:81
static TOOL_ACTION drawCircle
Definition: ee_actions.h:101
static TOOL_ACTION rotateCCW
Definition: ee_actions.h:125
static TOOL_ACTION lineModeFree
Definition: ee_actions.h:261
static TOOL_ACTION drawBus
Definition: ee_actions.h:82
static TOOL_ACTION placePower
Definition: ee_actions.h:80
static TOOL_ACTION placeSheetPin
Definition: ee_actions.h:92
static TOOL_ACTION drawLines
Definition: ee_actions.h:103
static TOOL_ACTION mirrorH
Definition: ee_actions.h:127
static TOOL_ACTION showSimulator
Definition: ee_actions.h:278
static TOOL_ACTION highlightNetTool
Definition: ee_actions.h:294
static TOOL_ACTION rotateCW
Definition: ee_actions.h:124
static TOOL_ACTION assignFootprints
Definition: ee_actions.h:161
static TOOL_ACTION placeGlobalLabel
Definition: ee_actions.h:89
static TOOL_ACTION placeHierLabel
Definition: ee_actions.h:90
static TOOL_ACTION editSymbolFields
Definition: ee_actions.h:153
static TOOL_ACTION drawTextBox
Definition: ee_actions.h:98
static TOOL_ACTION drawRectangle
Definition: ee_actions.h:100
static TOOL_ACTION annotate
Definition: ee_actions.h:152
static TOOL_ACTION placeImage
Definition: ee_actions.h:104
static TOOL_ACTION showHierarchy
Definition: ee_actions.h:225
static TOOL_ACTION placeSchematicText
Definition: ee_actions.h:97
static TOOL_ACTION drawArc
Definition: ee_actions.h:102
static TOOL_ACTION lineMode45
Definition: ee_actions.h:263
static TOOL_ACTION drawSheet
Definition: ee_actions.h:91
static TOOL_ACTION navigateUp
Definition: ee_actions.h:220
static TOOL_ACTION placeLabel
Definition: ee_actions.h:87
static TOOL_ACTION showPcbNew
Definition: ee_actions.h:175
static TOOL_ACTION placeBusWireEntry
Definition: ee_actions.h:86
static TOOL_ACTION placeJunction
Definition: ee_actions.h:85
static TOOL_ACTION generateBOM
Definition: ee_actions.h:178
static TOOL_ACTION placeNoConnect
Definition: ee_actions.h:84
static TOOL_ACTION schematicSetup
Definition: ee_actions.h:163
virtual COMMON_SETTINGS * GetCommonSettings() const
Definition: pgm_base.cpp:678
EESCHEMA_SETTINGS * eeconfig() const
void ToggleProperties() override
void updateSelectionFilterVisbility() override
Selection filter panel doesn't have a dedicated visibility control, so show it if any other AUI panel...
void ReCreateVToolbar() override
void ToggleSearch()
Toggle the show/hide state of Search pane.
static const wxString SearchPaneName()
void ToggleSchematicHierarchy()
Toggle the show/hide state of the left side schematic navigation panel.
static const wxString SchematicHierarchyPaneName()
void ReCreateOptToolbar() override
HIERARCHY_PANE * m_hierarchy
void ReCreateHToolbar() override
void FocusSearch()
Definition: search_pane.cpp:96
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:167
@ ID_OPT_TOOLBAR
Definition: id.h:102
@ ID_V_TOOLBAR
Definition: id.h:101
@ ID_H_TOOLBAR
Definition: id.h:100
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: pgm_base.cpp:1059
see class PGM_BASE
void SetAuiPaneSize(wxAuiManager &aManager, wxAuiPaneInfo &aPane, int aWidth, int aHeight)
Sets the size of an AUI pane, working around http://trac.wxwidgets.org/ticket/13180.