KiCad PCB EDA Suite
Loading...
Searching...
No Matches
eeschema/menubar.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) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 2009 Wayne Stambaugh <[email protected]>
6 * Copyright (C) 1992-2023 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 <bitmaps.h>
28#include <file_history.h>
29#include <kiface_base.h>
30#include <schematic.h>
31#include <tool/action_manager.h>
32#include <tool/action_menu.h>
33#include <tool/tool_manager.h>
35#include <tools/ee_actions.h>
36#include "eeschema_id.h"
37#include "sch_edit_frame.h"
38#include <widgets/wx_menubar.h>
39#include <advanced_config.h>
40
41
43{
45 // wxWidgets handles the Mac Application menu behind the scenes, but that means
46 // we always have to start from scratch with a new wxMenuBar.
47 wxMenuBar* oldMenuBar = GetMenuBar();
48 WX_MENUBAR* menuBar = new WX_MENUBAR();
49
50 //-- File menu -----------------------------------------------------------
51 //
52 ACTION_MENU* fileMenu = new ACTION_MENU( false, selTool );
53 static ACTION_MENU* openRecentMenu;
54
55 if( Kiface().IsSingle() ) // When not under a project mgr
56 {
57 FILE_HISTORY& fileHistory = GetFileHistory();
58
59 // Add this menu to the list of menus managed by the file history
60 // (the file history will be updated when adding/removing files in history)
61 if( !openRecentMenu )
62 {
63 openRecentMenu = new ACTION_MENU( false, selTool );
64 openRecentMenu->SetIcon( BITMAPS::recent );
65
66 fileHistory.UseMenu( openRecentMenu );
67 fileHistory.AddFilesToMenu( openRecentMenu );
68 }
69
70 // Ensure the title is up to date after changing language
71 openRecentMenu->SetTitle( _( "Open Recent" ) );
72 fileHistory.UpdateClearText( openRecentMenu, _( "Clear Recent Files" ) );
73
74 fileMenu->Add( ACTIONS::doNew );
75 fileMenu->Add( ACTIONS::open );
76
77 wxMenuItem* item = fileMenu->Add( openRecentMenu->Clone() );
78
79 // Add the file menu condition here since it needs the item ID for the submenu
81 cond.Enable( FILE_HISTORY::FileHistoryNotEmpty( fileHistory ) );
82 RegisterUIUpdateHandler( item->GetId(), cond );
83 fileMenu->AppendSeparator();
84 }
85
86 fileMenu->Add( ACTIONS::save );
87
88 if( Kiface().IsSingle() )
89 fileMenu->Add( ACTIONS::saveAs );
90 else
92
93 fileMenu->Add( ACTIONS::revert );
94
95 fileMenu->AppendSeparator();
96
97 fileMenu->Add( _( "Insert Schematic Sheet Content..." ),
98 _( "Append schematic sheet content from another project to the current sheet" ),
100 BITMAPS::add_document );
101
102 fileMenu->AppendSeparator();
103
104 // Import submenu
105 ACTION_MENU* submenuImport = new ACTION_MENU( false, selTool );
106 submenuImport->SetTitle( _( "Import" ) );
107 submenuImport->SetIcon( BITMAPS::import );
108
109 submenuImport->Add( _( "Non-KiCad Schematic..." ),
110 _( "Replace current schematic sheet with one imported from another application" ),
112 BITMAPS::import_document );
113
115 _( "Footprint Assignments..." ) );
116 submenuImport->Add( EE_ACTIONS::schImportGraphics, ACTION_MENU::NORMAL, _( "Graphics..." ) );
117
118 fileMenu->Add( submenuImport );
119
120
121 // Export submenu
122 ACTION_MENU* submenuExport = new ACTION_MENU( false, selTool );
123 submenuExport->SetTitle( _( "Export" ) );
124 submenuExport->SetIcon( BITMAPS::export_file );
126 _( "Drawing to Clipboard" ) );
127 submenuExport->Add( EE_ACTIONS::exportNetlist, ACTION_MENU::NORMAL, _( "Netlist..." ) );
129 _( "Symbols to Library..." ) );
131 _( "Symbols to New Library..." ) );
132 fileMenu->Add( submenuExport );
133
134 fileMenu->AppendSeparator();
135 fileMenu->Add( EE_ACTIONS::schematicSetup );
136
137 fileMenu->AppendSeparator();
138 fileMenu->Add( ACTIONS::pageSettings );
139 fileMenu->Add( ACTIONS::print );
140 fileMenu->Add( ACTIONS::plot );
141
142 fileMenu->AppendSeparator();
143 fileMenu->AddQuitOrClose( &Kiface(), _( "Schematic Editor" ) );
144
145
146 //-- Edit menu -----------------------------------------------------------
147 //
148 ACTION_MENU* editMenu = new ACTION_MENU( false, selTool );
149
150 editMenu->Add( ACTIONS::undo );
151 editMenu->Add( ACTIONS::redo );
152
153 editMenu->AppendSeparator();
154 editMenu->Add( ACTIONS::cut );
155 editMenu->Add( ACTIONS::copy );
156 editMenu->Add( ACTIONS::paste );
157 editMenu->Add( ACTIONS::pasteSpecial );
158 editMenu->Add( ACTIONS::doDelete );
159
160 editMenu->AppendSeparator();
161 editMenu->Add( ACTIONS::selectAll );
162 editMenu->Add( ACTIONS::unselectAll );
163
164 editMenu->AppendSeparator();
165 editMenu->Add( ACTIONS::find );
166 editMenu->Add( ACTIONS::findAndReplace );
167
168 editMenu->AppendSeparator();
169 editMenu->Add( ACTIONS::deleteTool );
171 editMenu->Add( EE_ACTIONS::changeSymbols );
172 editMenu->Add( EE_ACTIONS::editPageNumber );
173
174 //-- View menu -----------------------------------------------------------
175 //
176 ACTION_MENU* viewMenu = new ACTION_MENU( false, selTool );
177
178 viewMenu->Add( ACTIONS::showSymbolBrowser );
182 viewMenu->Add( EE_ACTIONS::navigateBack );
183 viewMenu->Add( EE_ACTIONS::navigateUp );
184 viewMenu->Add( EE_ACTIONS::navigateForward );
186 viewMenu->Add( EE_ACTIONS::navigateNext );
187
188 if( ADVANCED_CFG::GetCfg().m_IncrementalConnectivity )
189 {
190 viewMenu->AppendSeparator();
192 }
193
194 viewMenu->AppendSeparator();
195 viewMenu->Add( ACTIONS::zoomInCenter );
196 viewMenu->Add( ACTIONS::zoomOutCenter );
197 viewMenu->Add( ACTIONS::zoomFitScreen );
198 viewMenu->Add( ACTIONS::zoomFitObjects );
199 viewMenu->Add( ACTIONS::zoomTool );
200 viewMenu->Add( ACTIONS::zoomRedraw );
201
202 viewMenu->AppendSeparator();
211
212#ifdef __APPLE__
213 viewMenu->AppendSeparator();
214#endif
215
216 //-- Place menu -----------------------------------------------------------
217 //
218 ACTION_MENU* placeMenu = new ACTION_MENU( false, selTool );
219
220 placeMenu->Add( EE_ACTIONS::placeSymbol );
221 placeMenu->Add( EE_ACTIONS::placePower );
222 placeMenu->Add( EE_ACTIONS::drawWire );
223 placeMenu->Add( EE_ACTIONS::drawBus );
225 placeMenu->Add( EE_ACTIONS::placeNoConnect );
226 placeMenu->Add( EE_ACTIONS::placeJunction );
227 placeMenu->Add( EE_ACTIONS::placeLabel );
228 placeMenu->Add( EE_ACTIONS::placeClassLabel );
229 placeMenu->Add( EE_ACTIONS::placeGlobalLabel );
230
231 placeMenu->AppendSeparator();
232 placeMenu->Add( EE_ACTIONS::placeHierLabel );
233 placeMenu->Add( EE_ACTIONS::drawSheet );
234 placeMenu->Add( EE_ACTIONS::importSheetPin );
235
236 placeMenu->AppendSeparator();
238 placeMenu->Add( EE_ACTIONS::drawTextBox );
239 placeMenu->Add( EE_ACTIONS::drawRectangle );
240 placeMenu->Add( EE_ACTIONS::drawCircle );
241 placeMenu->Add( EE_ACTIONS::drawArc );
242 placeMenu->Add( EE_ACTIONS::drawLines );
243 placeMenu->Add( EE_ACTIONS::placeImage );
244
245
246 //-- Inspect menu -----------------------------------------------
247 //
248 ACTION_MENU* inspectMenu = new ACTION_MENU( false, selTool );
249
250 inspectMenu->Add( EE_ACTIONS::runERC );
251 inspectMenu->Add( ACTIONS::prevMarker );
252 inspectMenu->Add( ACTIONS::nextMarker );
253 inspectMenu->Add( ACTIONS::excludeMarker );
254
255 inspectMenu->AppendSeparator();
256 inspectMenu->Add( EE_ACTIONS::diffSymbol );
257
258 inspectMenu->AppendSeparator();
259 inspectMenu->Add( EE_ACTIONS::showSimulator );
260
261
262 //-- Tools menu -----------------------------------------------
263 //
264 ACTION_MENU* toolsMenu = new ACTION_MENU( false, selTool );
265
266 wxMenuItem* update = toolsMenu->Add( ACTIONS::updatePcbFromSchematic );
267 update->Enable( !Kiface().IsSingle() );
268
269 toolsMenu->Add( EE_ACTIONS::showPcbNew );
270
271 if( !Kiface().IsSingle() )
272 toolsMenu->Add( ACTIONS::showProjectManager );
273
274 toolsMenu->AppendSeparator();
275 toolsMenu->Add( ACTIONS::showSymbolEditor );
276 toolsMenu->Add( EE_ACTIONS::updateSymbols );
277
278 toolsMenu->AppendSeparator();
279 toolsMenu->Add( EE_ACTIONS::rescueSymbols );
280 toolsMenu->Add( EE_ACTIONS::remapSymbols );
281
282 if( ADVANCED_CFG::GetCfg().m_ShowRepairSchematic )
283 toolsMenu->Add( EE_ACTIONS::repairSchematic );
284
285 toolsMenu->AppendSeparator();
286 toolsMenu->Add( EE_ACTIONS::editSymbolFields );
288
289 toolsMenu->AppendSeparator();
290 toolsMenu->Add( EE_ACTIONS::annotate );
291
292 toolsMenu->AppendSeparator();
293 toolsMenu->Add( EE_ACTIONS::assignFootprints );
294 toolsMenu->Add( EE_ACTIONS::generateBOM );
296
297 toolsMenu->AppendSeparator();
298 update = toolsMenu->Add( ACTIONS::updateSchematicFromPcb );
299 update->Enable( !Kiface().IsSingle() );
300
301 //-- Preferences menu -----------------------------------------------
302 //
303 ACTION_MENU* prefsMenu = new ACTION_MENU( false, selTool );
304
305 prefsMenu->Add( ACTIONS::configurePaths );
306 prefsMenu->Add( ACTIONS::showSymbolLibTable );
307 prefsMenu->Add( ACTIONS::openPreferences );
308
309 prefsMenu->AppendSeparator();
310 AddMenuLanguageList( prefsMenu, selTool );
311
312
313 //-- Menubar -------------------------------------------------------------
314 //
315 menuBar->Append( fileMenu, _( "&File" ) );
316 menuBar->Append( editMenu, _( "&Edit" ) );
317 menuBar->Append( viewMenu, _( "&View" ) );
318 menuBar->Append( placeMenu, _( "&Place" ) );
319 menuBar->Append( inspectMenu, _( "&Inspect" ) );
320 menuBar->Append( toolsMenu, _( "&Tools" ) );
321 menuBar->Append( prefsMenu, _( "P&references" ) );
322 AddStandardHelpMenu( menuBar );
323
324 SetMenuBar( menuBar );
325 delete oldMenuBar;
326}
327
328
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
static TOOL_ACTION updatePcbFromSchematic
Definition: actions.h:175
static TOOL_ACTION paste
Definition: actions.h:69
static TOOL_ACTION excludeMarker
Definition: actions.h:91
static TOOL_ACTION nextMarker
Definition: actions.h:90
static TOOL_ACTION zoomRedraw
Definition: actions.h:94
static TOOL_ACTION unselectAll
Definition: actions.h:72
static TOOL_ACTION revert
Definition: actions.h:55
static TOOL_ACTION zoomOutCenter
Definition: actions.h:98
static TOOL_ACTION saveAs
Definition: actions.h:52
static TOOL_ACTION copy
Definition: actions.h:68
static TOOL_ACTION showSymbolLibTable
Definition: actions.h:189
static TOOL_ACTION showSymbolEditor
Definition: actions.h:172
static TOOL_ACTION showSymbolBrowser
Definition: actions.h:171
static TOOL_ACTION pasteSpecial
Definition: actions.h:70
static TOOL_ACTION findAndReplace
Definition: actions.h:80
static TOOL_ACTION openPreferences
Definition: actions.h:187
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 showSearch
Definition: actions.h:78
static TOOL_ACTION undo
Definition: actions.h:65
static TOOL_ACTION prevMarker
Definition: actions.h:89
static TOOL_ACTION doDelete
Definition: actions.h:74
static TOOL_ACTION save
Definition: actions.h:51
static TOOL_ACTION zoomFitScreen
Definition: actions.h:100
static TOOL_ACTION redo
Definition: actions.h:66
static TOOL_ACTION deleteTool
Definition: actions.h:75
static TOOL_ACTION zoomTool
Definition: actions.h:103
static TOOL_ACTION updateSchematicFromPcb
Definition: actions.h:176
static TOOL_ACTION print
Definition: actions.h:57
static TOOL_ACTION showProperties
Definition: actions.h:177
static TOOL_ACTION doNew
Definition: actions.h:47
static TOOL_ACTION zoomFitObjects
Definition: actions.h:101
static TOOL_ACTION zoomInCenter
Definition: actions.h:97
static TOOL_ACTION cut
Definition: actions.h:67
static TOOL_ACTION configurePaths
Definition: actions.h:188
static TOOL_ACTION showProjectManager
Definition: actions.h:169
static TOOL_ACTION selectAll
Definition: actions.h:71
static TOOL_ACTION find
Definition: actions.h:79
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:49
void AddQuitOrClose(KIFACE_BASE *aKiface, wxString aAppname="")
Add either a standard Quit or Close item to the menu.
static constexpr bool CHECK
Definition: action_menu.h:198
ACTION_MENU * Clone() const
Create a deep, recursive copy of this ACTION_MENU.
void SetTitle(const wxString &aTitle) override
Set title for the menu.
Definition: action_menu.cpp:91
static constexpr bool NORMAL
Definition: action_menu.h:197
void SetIcon(BITMAPS aIcon)
Assign an icon for the entry.
Definition: action_menu.cpp:77
wxMenuItem * Add(const wxString &aLabel, int aId, BITMAPS aIcon)
Add a wxWidgets-style entry to the menu.
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
void AddMenuLanguageList(ACTION_MENU *aMasterMenu, TOOL_INTERACTIVE *aControlTool)
Function AddMenuLanguageList creates a menu list for language choice, and add it as submenu to Master...
void SetMenuBar(wxMenuBar *menu_bar) override
FILE_HISTORY & GetFileHistory()
Get the frame's main file history.
virtual void RegisterUIUpdateHandler(int aID, const ACTION_CONDITIONS &aConditions) override
Register a UI update handler for the control with ID aID.
void AddStandardHelpMenu(wxMenuBar *aMenuBar)
Adds the standard KiCad help menu to the menubar.
static TOOL_ACTION importFPAssignments
Definition: ee_actions.h:175
static TOOL_ACTION repairSchematic
Definition: ee_actions.h:253
static TOOL_ACTION remapSymbols
Definition: ee_actions.h:169
static TOOL_ACTION runERC
Definition: ee_actions.h:151
static TOOL_ACTION toggleHiddenPins
Definition: ee_actions.h:231
static TOOL_ACTION navigateForward
Definition: ee_actions.h:219
static TOOL_ACTION placeSymbol
Definition: ee_actions.h:79
static TOOL_ACTION navigateBack
Definition: ee_actions.h:220
static TOOL_ACTION toggleERCWarnings
Definition: ee_actions.h:234
static TOOL_ACTION toggleERCExclusions
Definition: ee_actions.h:236
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:96
static TOOL_ACTION drawBus
Definition: ee_actions.h:82
static TOOL_ACTION generateBOMLegacy
Definition: ee_actions.h:178
static TOOL_ACTION toggleERCErrors
Definition: ee_actions.h:235
static TOOL_ACTION placePower
Definition: ee_actions.h:80
static TOOL_ACTION drawLines
Definition: ee_actions.h:98
static TOOL_ACTION toggleOPCurrents
Definition: ee_actions.h:238
static TOOL_ACTION showSimulator
Definition: ee_actions.h:271
static TOOL_ACTION importSheetPin
Definition: ee_actions.h:92
static TOOL_ACTION exportNetlist
Definition: ee_actions.h:176
static TOOL_ACTION assignFootprints
Definition: ee_actions.h:161
static TOOL_ACTION diffSymbol
Definition: ee_actions.h:166
static TOOL_ACTION rescueSymbols
Definition: ee_actions.h:168
static TOOL_ACTION toggleHiddenFields
Definition: ee_actions.h:232
static TOOL_ACTION placeGlobalLabel
Definition: ee_actions.h:89
static TOOL_ACTION exportSymbolsToLibrary
Definition: ee_actions.h:180
static TOOL_ACTION placeHierLabel
Definition: ee_actions.h:90
static TOOL_ACTION schImportGraphics
Definition: ee_actions.h:100
static TOOL_ACTION drawSheetOnClipboard
Definition: ee_actions.h:249
static TOOL_ACTION editSymbolFields
Definition: ee_actions.h:153
static TOOL_ACTION drawTextBox
Definition: ee_actions.h:94
static TOOL_ACTION showNetNavigator
Definition: ee_actions.h:288
static TOOL_ACTION editPageNumber
Definition: ee_actions.h:164
static TOOL_ACTION drawRectangle
Definition: ee_actions.h:95
static TOOL_ACTION annotate
Definition: ee_actions.h:152
static TOOL_ACTION placeImage
Definition: ee_actions.h:99
static TOOL_ACTION toggleDirectiveLabels
Definition: ee_actions.h:233
static TOOL_ACTION updateSymbols
Definition: ee_actions.h:158
static TOOL_ACTION showHierarchy
Definition: ee_actions.h:223
static TOOL_ACTION placeSchematicText
Definition: ee_actions.h:93
static TOOL_ACTION toggleOPVoltages
Definition: ee_actions.h:237
static TOOL_ACTION changeSymbols
Definition: ee_actions.h:157
static TOOL_ACTION drawArc
Definition: ee_actions.h:97
static TOOL_ACTION drawSheet
Definition: ee_actions.h:91
static TOOL_ACTION navigateNext
Definition: ee_actions.h:222
static TOOL_ACTION navigateUp
Definition: ee_actions.h:218
static TOOL_ACTION editSymbolLibraryLinks
Definition: ee_actions.h:154
static TOOL_ACTION placeLabel
Definition: ee_actions.h:87
static TOOL_ACTION saveCurrSheetCopyAs
Definition: ee_actions.h:42
static TOOL_ACTION editTextAndGraphics
Definition: ee_actions.h:228
static TOOL_ACTION showPcbNew
Definition: ee_actions.h:174
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:177
static TOOL_ACTION navigatePrevious
Definition: ee_actions.h:221
static TOOL_ACTION placeNoConnect
Definition: ee_actions.h:84
static TOOL_ACTION schematicSetup
Definition: ee_actions.h:163
static TOOL_ACTION exportSymbolsToNewLibrary
Definition: ee_actions.h:181
This class implements a file history object to store a list of files, that can then be added to a men...
Definition: file_history.h:43
static SELECTION_CONDITION FileHistoryNotEmpty(const FILE_HISTORY &aHistory)
Create a SELECTION_CONDITION that can be used to enable a menu item when the file history has items i...
void UpdateClearText(wxMenu *aMenu, wxString aClearText)
Update the text displayed on the menu item that clears the entire menu.
void AddFilesToMenu() override
Add the files to all registered menus.
Definition: file_history.h:98
void doReCreateMenuBar() override
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:165
Wrapper around a wxMenuBar object that prevents the accelerator table from being used.
Definition: wx_menubar.h:46
#define _(s)
@ ID_IMPORT_NON_KICAD_SCH
Definition: eeschema_id.h:57
@ ID_APPEND_PROJECT
Definition: id.h:74
Functors that can be used to figure out how the action controls should be displayed in the UI and if ...
ACTION_CONDITIONS & Enable(const SELECTION_CONDITION &aCondition)