KiCad PCB EDA Suite
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 <stambaughw@gmail.com>
6  * Copyright (C) 1992-2021 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 <filehistory.h>
29 #include <kiface_base.h>
30 #include <menus_helpers.h>
31 #include <schematic.h>
32 #include <tool/action_manager.h>
33 #include <tool/action_menu.h>
34 #include <tool/tool_manager.h>
36 #include <tools/ee_actions.h>
37 #include "eeschema_id.h"
38 #include "sch_edit_frame.h"
39 #include <widgets/wx_menubar.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->SetTitle( _( "Open Recent" ) );
65  openRecentMenu->SetIcon( BITMAPS::recent );
66 
67  fileHistory.UseMenu( openRecentMenu );
68  fileHistory.AddFilesToMenu( openRecentMenu );
69  }
70 
71  fileMenu->Add( ACTIONS::doNew );
72  fileMenu->Add( ACTIONS::open );
73 
74  wxMenuItem* item = fileMenu->Add( openRecentMenu );
75 
76  // Add the file menu condition here since it needs the item ID for the submenu
77  ACTION_CONDITIONS cond;
78  cond.Enable( FILE_HISTORY::FileHistoryNotEmpty( fileHistory ) );
79  RegisterUIUpdateHandler( item->GetId(), cond );
80  fileMenu->AppendSeparator();
81  }
82 
83  fileMenu->Add( ACTIONS::save );
84 
85  if( Kiface().IsSingle() )
86  fileMenu->Add( ACTIONS::saveAs );
87  else
88  fileMenu->Add( ACTIONS::saveCopyAs );
89 
90  fileMenu->AppendSeparator();
91 
92  fileMenu->Add( _( "Insert Schematic Sheet Content..." ),
93  _( "Append schematic sheet content from another project to the current sheet" ),
96 
97  fileMenu->AppendSeparator();
98 
99  // Import submenu
100  ACTION_MENU* submenuImport = new ACTION_MENU( false, selTool );
101  submenuImport->SetTitle( _( "Import" ) );
102  submenuImport->SetIcon( BITMAPS::import );
103  submenuImport->Add( _( "Non-KiCad Schematic..." ),
104  _( "Replace current schematic sheet with one imported from another application" ),
107 
108  submenuImport->Add( EE_ACTIONS::importFPAssignments, ACTION_MENU::NORMAL, _( "Footprint Assignments..." ) );
109  fileMenu->Add( submenuImport );
110 
111 
112  // Export submenu
113  ACTION_MENU* submenuExport = new ACTION_MENU( false, selTool );
114  submenuExport->SetTitle( _( "Export" ) );
115  submenuExport->SetIcon( BITMAPS::export_file );
116  submenuExport->Add( EE_ACTIONS::drawSheetOnClipboard, ACTION_MENU::NORMAL, _( "Drawing to Clipboard" ) );
117  submenuExport->Add( EE_ACTIONS::exportNetlist, ACTION_MENU::NORMAL, _( "Netlist..." ) );
118  fileMenu->Add( submenuExport );
119 
120  fileMenu->AppendSeparator();
121  fileMenu->Add( EE_ACTIONS::schematicSetup );
122 
123  fileMenu->AppendSeparator();
124  fileMenu->Add( ACTIONS::pageSettings );
125  fileMenu->Add( ACTIONS::print );
126  fileMenu->Add( ACTIONS::plot );
127 
128  fileMenu->AppendSeparator();
129  fileMenu->AddQuitOrClose( &Kiface(), _( "Schematic Editor" ) );
130 
131 
132  //-- Edit menu -----------------------------------------------------------
133  //
134  ACTION_MENU* editMenu = new ACTION_MENU( false, selTool );
135 
136  editMenu->Add( ACTIONS::undo );
137  editMenu->Add( ACTIONS::redo );
138 
139  editMenu->AppendSeparator();
140  editMenu->Add( ACTIONS::cut );
141  editMenu->Add( ACTIONS::copy );
142  editMenu->Add( ACTIONS::paste );
143  editMenu->Add( ACTIONS::pasteSpecial );
144  editMenu->Add( ACTIONS::doDelete );
145 
146  editMenu->AppendSeparator();
147  editMenu->Add( ACTIONS::selectAll );
148 
149  editMenu->AppendSeparator();
150  editMenu->Add( ACTIONS::find );
151  editMenu->Add( ACTIONS::findAndReplace );
152 
153  editMenu->AppendSeparator();
154  editMenu->Add( ACTIONS::deleteTool );
156  editMenu->Add( EE_ACTIONS::changeSymbols );
157  editMenu->Add( EE_ACTIONS::editPageNumber );
158 
159  //-- View menu -----------------------------------------------------------
160  //
161  ACTION_MENU* viewMenu = new ACTION_MENU( false, selTool );
162 
163  viewMenu->Add( ACTIONS::showSymbolBrowser );
164  viewMenu->Add( EE_ACTIONS::navigateHierarchy );
165  viewMenu->Add( EE_ACTIONS::leaveSheet );
166 
167  viewMenu->AppendSeparator();
168  viewMenu->Add( ACTIONS::zoomInCenter );
169  viewMenu->Add( ACTIONS::zoomOutCenter );
170  viewMenu->Add( ACTIONS::zoomFitScreen );
171  viewMenu->Add( ACTIONS::zoomFitObjects );
172  viewMenu->Add( ACTIONS::zoomTool );
173  viewMenu->Add( ACTIONS::zoomRedraw );
174 
175  viewMenu->AppendSeparator();
177  viewMenu->Add( ACTIONS::gridProperties );
178 
179  // Units submenu
180  ACTION_MENU* unitsSubMenu = new ACTION_MENU( false, selTool );
181  unitsSubMenu->SetTitle( _( "&Units" ) );
182  unitsSubMenu->SetIcon( BITMAPS::unit_mm );
183  unitsSubMenu->Add( ACTIONS::inchesUnits, ACTION_MENU::CHECK );
184  unitsSubMenu->Add( ACTIONS::milsUnits, ACTION_MENU::CHECK );
186  viewMenu->Add( unitsSubMenu );
187 
189 
190  viewMenu->AppendSeparator();
192 
193 #ifdef __APPLE__
194  viewMenu->AppendSeparator();
195 #endif
196 
197  //-- Place menu -----------------------------------------------------------
198  //
199  ACTION_MENU* placeMenu = new ACTION_MENU( false, selTool );
200 
201  placeMenu->Add( EE_ACTIONS::placeSymbol );
202  placeMenu->Add( EE_ACTIONS::placePower );
203  placeMenu->Add( EE_ACTIONS::drawWire );
204  placeMenu->Add( EE_ACTIONS::drawBus );
205  placeMenu->Add( EE_ACTIONS::placeBusWireEntry );
206  placeMenu->Add( EE_ACTIONS::placeNoConnect );
207  placeMenu->Add( EE_ACTIONS::placeJunction );
208  placeMenu->Add( EE_ACTIONS::placeLabel );
209  placeMenu->Add( EE_ACTIONS::placeGlobalLabel );
210 
211  placeMenu->AppendSeparator();
212  placeMenu->Add( EE_ACTIONS::placeHierLabel );
213  placeMenu->Add( EE_ACTIONS::drawSheet );
214  placeMenu->Add( EE_ACTIONS::importSheetPin );
215 
216  placeMenu->AppendSeparator();
217  placeMenu->Add( EE_ACTIONS::drawLines );
218  placeMenu->Add( EE_ACTIONS::placeSchematicText );
219  placeMenu->Add( EE_ACTIONS::placeImage );
220 
221 
222  //-- Inspect menu -----------------------------------------------
223  //
224  ACTION_MENU* inspectMenu = new ACTION_MENU( false, selTool );
225 
226  inspectMenu->Add( EE_ACTIONS::runERC );
227  inspectMenu->Add( ACTIONS::prevMarker );
228  inspectMenu->Add( ACTIONS::nextMarker );
229  inspectMenu->Add( ACTIONS::excludeMarker );
230 
231 #ifdef KICAD_SPICE
232  inspectMenu->AppendSeparator();
233  inspectMenu->Add( EE_ACTIONS::runSimulation );
234 #endif
235 
236 
237  //-- Tools menu -----------------------------------------------
238  //
239  ACTION_MENU* toolsMenu = new ACTION_MENU( false, selTool );
240 
241  wxMenuItem* update = toolsMenu->Add( ACTIONS::updatePcbFromSchematic );
242  update->Enable( !Kiface().IsSingle() );
243  update = toolsMenu->Add( ACTIONS::updateSchematicFromPcb );
244  update->Enable( !Kiface().IsSingle() );
245 
246  toolsMenu->Add( EE_ACTIONS::showPcbNew );
247 
248  toolsMenu->AppendSeparator();
249  toolsMenu->Add( ACTIONS::showSymbolEditor );
250  toolsMenu->Add( EE_ACTIONS::updateSymbols );
251  toolsMenu->Add( EE_ACTIONS::rescueSymbols );
252  toolsMenu->Add( EE_ACTIONS::remapSymbols );
253 
254  toolsMenu->AppendSeparator();
255  toolsMenu->Add( EE_ACTIONS::editSymbolFields );
257 
258  toolsMenu->AppendSeparator();
259  toolsMenu->Add( EE_ACTIONS::annotate );
260  toolsMenu->Add( EE_ACTIONS::showBusManager );
261 
262  toolsMenu->AppendSeparator();
263  toolsMenu->Add( EE_ACTIONS::assignFootprints );
264  toolsMenu->Add( EE_ACTIONS::generateBOM );
265 
266 
267  //-- Preferences menu -----------------------------------------------
268  //
269  ACTION_MENU* prefsMenu = new ACTION_MENU( false, selTool );
270 
271  prefsMenu->Add( ACTIONS::configurePaths );
272  prefsMenu->Add( ACTIONS::showSymbolLibTable );
273 
274  // We can't use ACTIONS::showPreferences yet because wxWidgets moves this on
275  // Mac, and it needs the wxID_PREFERENCES id to find it.
276  prefsMenu->Add( _( "Preferences..." ) + "\tCtrl+,",
277  _( "Show preferences for all open tools" ),
278  wxID_PREFERENCES,
280 
281  prefsMenu->AppendSeparator();
282  AddMenuLanguageList( prefsMenu, selTool );
283 
284 
285  //-- Menubar -------------------------------------------------------------
286  //
287  menuBar->Append( fileMenu, _( "&File" ) );
288  menuBar->Append( editMenu, _( "&Edit" ) );
289  menuBar->Append( viewMenu, _( "&View" ) );
290  menuBar->Append( placeMenu, _( "&Place" ) );
291  menuBar->Append( inspectMenu, _( "&Inspect" ) );
292  menuBar->Append( toolsMenu, _( "&Tools" ) );
293  menuBar->Append( prefsMenu, _( "P&references" ) );
294  AddStandardHelpMenu( menuBar );
295 
296  SetMenuBar( menuBar );
297  delete oldMenuBar;
298 }
299 
300 
static TOOL_ACTION editPageNumber
Definition: ee_actions.h:151
void AddFilesToMenu() override
Add the files to all registered menus.
Definition: filehistory.h:98
static TOOL_ACTION rescueSymbols
Definition: ee_actions.h:154
static TOOL_ACTION findAndReplace
Definition: actions.h:77
static TOOL_ACTION exportNetlist
Definition: ee_actions.h:161
static TOOL_ACTION navigateHierarchy
Definition: ee_actions.h:182
static TOOL_ACTION assignFootprints
Definition: ee_actions.h:147
static TOOL_ACTION zoomInCenter
Definition: actions.h:93
static TOOL_ACTION pageSettings
Definition: actions.h:56
static TOOL_ACTION runERC
Definition: ee_actions.h:137
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:48
static TOOL_ACTION doDelete
Definition: actions.h:72
void SetIcon(BITMAPS aIcon)
Assign an icon for the entry.
Definition: action_menu.cpp:73
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
static TOOL_ACTION zoomTool
Definition: actions.h:99
void ReCreateMenuBar() override
Recreates the menu bar.
static TOOL_ACTION placeHierLabel
Definition: ee_actions.h:84
static TOOL_ACTION placeJunction
Definition: ee_actions.h:80
static TOOL_ACTION nextMarker
Definition: actions.h:86
static TOOL_ACTION remapSymbols
Definition: ee_actions.h:155
static TOOL_ACTION zoomFitScreen
Definition: actions.h:96
static TOOL_ACTION millimetersUnits
Definition: actions.h:146
virtual void RegisterUIUpdateHandler(int aID, const ACTION_CONDITIONS &aConditions) override
Register a UI update handler for the control with ID aID.
static TOOL_ACTION showSymbolLibTable
Definition: actions.h:174
static TOOL_ACTION updatePcbFromSchematic
Definition: actions.h:163
static TOOL_ACTION placeBusWireEntry
Definition: ee_actions.h:81
static TOOL_ACTION updateSymbols
Definition: ee_actions.h:144
static constexpr bool NORMAL
Definition: action_menu.h:182
static TOOL_ACTION zoomFitObjects
Definition: actions.h:97
static TOOL_ACTION print
Definition: actions.h:57
static TOOL_ACTION excludeMarker
Definition: actions.h:87
Wrapper around a wxMenuBar object that prevents the accelerator table from being used.
Definition: wx_menubar.h:45
This class implements a file history object to store a list of files, that can then be added to a men...
Definition: filehistory.h:42
static TOOL_ACTION find
Definition: actions.h:76
static TOOL_ACTION zoomOutCenter
Definition: actions.h:94
static TOOL_ACTION saveCopyAs
Definition: actions.h:53
ACTION_CONDITIONS & Enable(const SELECTION_CONDITION &aCondition)
static TOOL_ACTION leaveSheet
Definition: ee_actions.h:181
static TOOL_ACTION runSimulation
Definition: ee_actions.h:209
static TOOL_ACTION annotate
Definition: ee_actions.h:138
static TOOL_ACTION drawSheet
Definition: ee_actions.h:85
static TOOL_ACTION showPcbNew
Definition: ee_actions.h:159
static TOOL_ACTION copy
Definition: actions.h:67
static TOOL_ACTION showBusManager
Definition: ee_actions.h:149
static TOOL_ACTION updateSchematicFromPcb
Definition: actions.h:164
static TOOL_ACTION editSymbolFields
Definition: ee_actions.h:139
static TOOL_ACTION placePower
Definition: ee_actions.h:75
static TOOL_ACTION drawWire
Definition: ee_actions.h:76
static TOOL_ACTION toggleGrid
Definition: actions.h:140
static TOOL_ACTION open
Definition: actions.h:50
static TOOL_ACTION inchesUnits
Definition: actions.h:144
static TOOL_ACTION save
Definition: actions.h:51
static TOOL_ACTION placeSchematicText
Definition: ee_actions.h:87
static TOOL_ACTION doNew
Definition: actions.h:44
void AddStandardHelpMenu(wxMenuBar *aMenuBar)
Adds the standard KiCad help menu to the menubar.
static TOOL_ACTION placeImage
Definition: ee_actions.h:89
static TOOL_ACTION cut
Definition: actions.h:66
#define _(s)
static TOOL_ACTION plot
Definition: actions.h:58
static TOOL_ACTION importSheetPin
Definition: ee_actions.h:86
static TOOL_ACTION placeSymbol
Definition: ee_actions.h:74
void AddMenuLanguageList(ACTION_MENU *aMasterMenu, TOOL_INTERACTIVE *aControlTool)
Function AddMenuLanguageList creates a menu list for language choice, and add it as submenu to Master...
static TOOL_ACTION editTextAndGraphics
Definition: ee_actions.h:188
static TOOL_ACTION milsUnits
Definition: actions.h:145
static TOOL_ACTION drawBus
Definition: ee_actions.h:77
static TOOL_ACTION prevMarker
Definition: actions.h:85
static TOOL_ACTION pasteSpecial
Definition: actions.h:69
static TOOL_ACTION placeLabel
Definition: ee_actions.h:82
static TOOL_ACTION redo
Definition: actions.h:65
static constexpr bool CHECK
Definition: action_menu.h:183
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:158
void SetTitle(const wxString &aTitle) override
Set title for the menu.
Definition: action_menu.cpp:87
FILE_HISTORY & GetFileHistory()
Get the frame's main file history.
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...
static TOOL_ACTION showSymbolEditor
Definition: actions.h:160
static TOOL_ACTION saveAs
Definition: actions.h:52
static TOOL_ACTION toggleHiddenPins
Definition: ee_actions.h:191
static TOOL_ACTION zoomRedraw
Definition: actions.h:90
static TOOL_ACTION importFPAssignments
Definition: ee_actions.h:160
Functors that can be used to figure out how the action controls should be displayed in the UI and if ...
static TOOL_ACTION placeNoConnect
Definition: ee_actions.h:79
wxMenuItem * Add(const wxString &aLabel, int aId, BITMAPS aIcon)
Add a wxWidgets-style entry to the menu.
static TOOL_ACTION changeSymbols
Definition: ee_actions.h:143
static TOOL_ACTION drawSheetOnClipboard
Definition: ee_actions.h:203
static TOOL_ACTION gridProperties
Definition: actions.h:141
static TOOL_ACTION deleteTool
Definition: actions.h:73
static TOOL_ACTION undo
Definition: actions.h:64
static TOOL_ACTION generateBOM
Definition: ee_actions.h:162
static TOOL_ACTION drawLines
Definition: ee_actions.h:88
static TOOL_ACTION toggleCursorStyle
Definition: actions.h:102
static TOOL_ACTION schematicSetup
Definition: ee_actions.h:150
static TOOL_ACTION showSymbolBrowser
Definition: actions.h:159
void AddQuitOrClose(KIFACE_BASE *aKiface, wxString aAppname="")
Add either a standard Quit or Close item to the menu.
static TOOL_ACTION placeGlobalLabel
Definition: ee_actions.h:83
static TOOL_ACTION editSymbolLibraryLinks
Definition: ee_actions.h:140
static TOOL_ACTION configurePaths
Definition: actions.h:173
static TOOL_ACTION selectAll
Definition: actions.h:70
static TOOL_ACTION paste
Definition: actions.h:68