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 <[email protected]>
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 #include <advanced_config.h>
41 
42 
44 {
46  // wxWidgets handles the Mac Application menu behind the scenes, but that means
47  // we always have to start from scratch with a new wxMenuBar.
48  wxMenuBar* oldMenuBar = GetMenuBar();
49  WX_MENUBAR* menuBar = new WX_MENUBAR();
50 
51  //-- File menu -----------------------------------------------------------
52  //
53  ACTION_MENU* fileMenu = new ACTION_MENU( false, selTool );
54  static ACTION_MENU* openRecentMenu;
55 
56  if( Kiface().IsSingle() ) // When not under a project mgr
57  {
58  FILE_HISTORY& fileHistory = GetFileHistory();
59 
60  // Add this menu to the list of menus managed by the file history
61  // (the file history will be updated when adding/removing files in history)
62  if( !openRecentMenu )
63  {
64  openRecentMenu = new ACTION_MENU( false, selTool );
65  openRecentMenu->SetIcon( BITMAPS::recent );
66 
67  fileHistory.UseMenu( openRecentMenu );
68  fileHistory.AddFilesToMenu( openRecentMenu );
69  }
70 
71  // Ensure the title is up to date after changing language
72  openRecentMenu->SetTitle( _( "Open Recent" ) );
73  fileHistory.UpdateClearText( openRecentMenu, _( "Clear Recent Files" ) );
74 
75  fileMenu->Add( ACTIONS::doNew );
76  fileMenu->Add( ACTIONS::open );
77 
78  wxMenuItem* item = fileMenu->Add( openRecentMenu->Clone() );
79 
80  // Add the file menu condition here since it needs the item ID for the submenu
81  ACTION_CONDITIONS cond;
82  cond.Enable( FILE_HISTORY::FileHistoryNotEmpty( fileHistory ) );
83  RegisterUIUpdateHandler( item->GetId(), cond );
84  fileMenu->AppendSeparator();
85  }
86 
87  fileMenu->Add( ACTIONS::save );
88 
89  if( Kiface().IsSingle() )
90  fileMenu->Add( ACTIONS::saveAs );
91  else
93 
94  fileMenu->AppendSeparator();
95 
96  fileMenu->Add( _( "Insert Schematic Sheet Content..." ),
97  _( "Append schematic sheet content from another project to the current sheet" ),
100 
101  fileMenu->AppendSeparator();
102 
103  // Import submenu
104  ACTION_MENU* submenuImport = new ACTION_MENU( false, selTool );
105  submenuImport->SetTitle( _( "Import" ) );
106  submenuImport->SetIcon( BITMAPS::import );
107  submenuImport->Add( _( "Non-KiCad Schematic..." ),
108  _( "Replace current schematic sheet with one imported from another application" ),
111 
112  submenuImport->Add( EE_ACTIONS::importFPAssignments, ACTION_MENU::NORMAL, _( "Footprint Assignments..." ) );
113  fileMenu->Add( submenuImport );
114 
115 
116  // Export submenu
117  ACTION_MENU* submenuExport = new ACTION_MENU( false, selTool );
118  submenuExport->SetTitle( _( "Export" ) );
119  submenuExport->SetIcon( BITMAPS::export_file );
120  submenuExport->Add( EE_ACTIONS::drawSheetOnClipboard, ACTION_MENU::NORMAL, _( "Drawing to Clipboard" ) );
121  submenuExport->Add( EE_ACTIONS::exportNetlist, ACTION_MENU::NORMAL, _( "Netlist..." ) );
122  fileMenu->Add( submenuExport );
123 
124  fileMenu->AppendSeparator();
125  fileMenu->Add( EE_ACTIONS::schematicSetup );
126 
127  fileMenu->AppendSeparator();
128  fileMenu->Add( ACTIONS::pageSettings );
129  fileMenu->Add( ACTIONS::print );
130  fileMenu->Add( ACTIONS::plot );
131 
132  fileMenu->AppendSeparator();
133  fileMenu->AddQuitOrClose( &Kiface(), _( "Schematic Editor" ) );
134 
135 
136  //-- Edit menu -----------------------------------------------------------
137  //
138  ACTION_MENU* editMenu = new ACTION_MENU( false, selTool );
139 
140  editMenu->Add( ACTIONS::undo );
141  editMenu->Add( ACTIONS::redo );
142 
143  editMenu->AppendSeparator();
144  editMenu->Add( ACTIONS::cut );
145  editMenu->Add( ACTIONS::copy );
146  editMenu->Add( ACTIONS::paste );
147  editMenu->Add( ACTIONS::pasteSpecial );
148  editMenu->Add( ACTIONS::doDelete );
149 
150  editMenu->AppendSeparator();
151  editMenu->Add( ACTIONS::selectAll );
152 
153  editMenu->AppendSeparator();
154  editMenu->Add( ACTIONS::find );
155  editMenu->Add( ACTIONS::findAndReplace );
156 
157  editMenu->AppendSeparator();
158  editMenu->Add( ACTIONS::deleteTool );
160  editMenu->Add( EE_ACTIONS::changeSymbols );
161  editMenu->Add( EE_ACTIONS::editPageNumber );
162 
163  //-- View menu -----------------------------------------------------------
164  //
165  ACTION_MENU* viewMenu = new ACTION_MENU( false, selTool );
166 
167  viewMenu->Add( ACTIONS::showSymbolBrowser );
168  viewMenu->Add( EE_ACTIONS::navigateHierarchy );
169  viewMenu->Add( EE_ACTIONS::leaveSheet );
170 
171  viewMenu->AppendSeparator();
172  viewMenu->Add( ACTIONS::zoomInCenter );
173  viewMenu->Add( ACTIONS::zoomOutCenter );
174  viewMenu->Add( ACTIONS::zoomFitScreen );
175  viewMenu->Add( ACTIONS::zoomFitObjects );
176  viewMenu->Add( ACTIONS::zoomTool );
177  viewMenu->Add( ACTIONS::zoomRedraw );
178 
179  viewMenu->AppendSeparator();
181  viewMenu->Add( ACTIONS::gridProperties );
182 
183  // Units submenu
184  ACTION_MENU* unitsSubMenu = new ACTION_MENU( false, selTool );
185  unitsSubMenu->SetTitle( _( "&Units" ) );
186  unitsSubMenu->SetIcon( BITMAPS::unit_mm );
187  unitsSubMenu->Add( ACTIONS::inchesUnits, ACTION_MENU::CHECK );
188  unitsSubMenu->Add( ACTIONS::milsUnits, ACTION_MENU::CHECK );
190  viewMenu->Add( unitsSubMenu );
191 
193 
194  viewMenu->AppendSeparator();
196 
197 #ifdef __APPLE__
198  viewMenu->AppendSeparator();
199 #endif
200 
201  //-- Place menu -----------------------------------------------------------
202  //
203  ACTION_MENU* placeMenu = new ACTION_MENU( false, selTool );
204 
205  placeMenu->Add( EE_ACTIONS::placeSymbol );
206  placeMenu->Add( EE_ACTIONS::placePower );
207  placeMenu->Add( EE_ACTIONS::drawWire );
208  placeMenu->Add( EE_ACTIONS::drawBus );
209  placeMenu->Add( EE_ACTIONS::placeBusWireEntry );
210  placeMenu->Add( EE_ACTIONS::placeNoConnect );
211  placeMenu->Add( EE_ACTIONS::placeJunction );
212  placeMenu->Add( EE_ACTIONS::placeLabel );
213  placeMenu->Add( EE_ACTIONS::placeGlobalLabel );
214 
215  placeMenu->AppendSeparator();
216  placeMenu->Add( EE_ACTIONS::placeHierLabel );
217  placeMenu->Add( EE_ACTIONS::drawSheet );
218  placeMenu->Add( EE_ACTIONS::importSheetPin );
219 
220  placeMenu->AppendSeparator();
221  placeMenu->Add( EE_ACTIONS::drawLines );
222  placeMenu->Add( EE_ACTIONS::placeSchematicText );
223  placeMenu->Add( EE_ACTIONS::placeImage );
224 
225 
226  //-- Inspect menu -----------------------------------------------
227  //
228  ACTION_MENU* inspectMenu = new ACTION_MENU( false, selTool );
229 
230  inspectMenu->Add( EE_ACTIONS::runERC );
231  inspectMenu->Add( ACTIONS::prevMarker );
232  inspectMenu->Add( ACTIONS::nextMarker );
233  inspectMenu->Add( ACTIONS::excludeMarker );
234 
235 #ifdef KICAD_SPICE
236  inspectMenu->AppendSeparator();
237  inspectMenu->Add( EE_ACTIONS::runSimulation );
238 #endif
239 
240 
241  //-- Tools menu -----------------------------------------------
242  //
243  ACTION_MENU* toolsMenu = new ACTION_MENU( false, selTool );
244 
245  wxMenuItem* update = toolsMenu->Add( ACTIONS::updatePcbFromSchematic );
246  update->Enable( !Kiface().IsSingle() );
247  update = toolsMenu->Add( ACTIONS::updateSchematicFromPcb );
248  update->Enable( !Kiface().IsSingle() );
249 
250  toolsMenu->Add( EE_ACTIONS::showPcbNew );
251 
252  toolsMenu->AppendSeparator();
253  toolsMenu->Add( ACTIONS::showSymbolEditor );
254  toolsMenu->Add( EE_ACTIONS::updateSymbols );
255 
256  toolsMenu->AppendSeparator();
257  toolsMenu->Add( EE_ACTIONS::rescueSymbols );
258  toolsMenu->Add( EE_ACTIONS::remapSymbols );
259 
260  if( ADVANCED_CFG::GetCfg().m_ShowRepairSchematic )
261  toolsMenu->Add( EE_ACTIONS::repairSchematic );
262 
263  toolsMenu->AppendSeparator();
264  toolsMenu->Add( EE_ACTIONS::editSymbolFields );
266 
267  toolsMenu->AppendSeparator();
268  toolsMenu->Add( EE_ACTIONS::annotate );
269  toolsMenu->Add( EE_ACTIONS::showBusManager );
270 
271  toolsMenu->AppendSeparator();
272  toolsMenu->Add( EE_ACTIONS::assignFootprints );
273  toolsMenu->Add( EE_ACTIONS::generateBOM );
274 
275 
276  //-- Preferences menu -----------------------------------------------
277  //
278  ACTION_MENU* prefsMenu = new ACTION_MENU( false, selTool );
279 
280  prefsMenu->Add( ACTIONS::configurePaths );
281  prefsMenu->Add( ACTIONS::showSymbolLibTable );
282 
283  // We can't use ACTIONS::showPreferences yet because wxWidgets moves this on
284  // Mac, and it needs the wxID_PREFERENCES id to find it.
285  prefsMenu->Add( _( "Preferences..." ) + "\tCtrl+,",
286  _( "Show preferences for all open tools" ),
287  wxID_PREFERENCES,
289 
290  prefsMenu->AppendSeparator();
291  AddMenuLanguageList( prefsMenu, selTool );
292 
293 
294  //-- Menubar -------------------------------------------------------------
295  //
296  menuBar->Append( fileMenu, _( "&File" ) );
297  menuBar->Append( editMenu, _( "&Edit" ) );
298  menuBar->Append( viewMenu, _( "&View" ) );
299  menuBar->Append( placeMenu, _( "&Place" ) );
300  menuBar->Append( inspectMenu, _( "&Inspect" ) );
301  menuBar->Append( toolsMenu, _( "&Tools" ) );
302  menuBar->Append( prefsMenu, _( "P&references" ) );
303  AddStandardHelpMenu( menuBar );
304 
305  SetMenuBar( menuBar );
306  delete oldMenuBar;
307 }
308 
309 
static TOOL_ACTION editPageNumber
Definition: ee_actions.h:155
void AddFilesToMenu() override
Add the files to all registered menus.
Definition: filehistory.h:98
static TOOL_ACTION rescueSymbols
Definition: ee_actions.h:158
static TOOL_ACTION findAndReplace
Definition: actions.h:77
static TOOL_ACTION exportNetlist
Definition: ee_actions.h:166
static TOOL_ACTION navigateHierarchy
Definition: ee_actions.h:187
static TOOL_ACTION assignFootprints
Definition: ee_actions.h:151
static TOOL_ACTION zoomInCenter
Definition: actions.h:93
static TOOL_ACTION pageSettings
Definition: actions.h:56
static TOOL_ACTION runERC
Definition: ee_actions.h:141
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:88
static TOOL_ACTION placeJunction
Definition: ee_actions.h:84
static TOOL_ACTION nextMarker
Definition: actions.h:86
static TOOL_ACTION remapSymbols
Definition: ee_actions.h:159
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:175
static TOOL_ACTION updatePcbFromSchematic
Definition: actions.h:163
static TOOL_ACTION placeBusWireEntry
Definition: ee_actions.h:85
static TOOL_ACTION updateSymbols
Definition: ee_actions.h:148
static constexpr bool NORMAL
Definition: action_menu.h:188
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 saveCurrSheetCopyAs
Definition: ee_actions.h:42
static TOOL_ACTION zoomOutCenter
Definition: actions.h:94
ACTION_CONDITIONS & Enable(const SELECTION_CONDITION &aCondition)
static TOOL_ACTION leaveSheet
Definition: ee_actions.h:186
static TOOL_ACTION runSimulation
Definition: ee_actions.h:215
static TOOL_ACTION annotate
Definition: ee_actions.h:142
static TOOL_ACTION drawSheet
Definition: ee_actions.h:89
static TOOL_ACTION showPcbNew
Definition: ee_actions.h:164
static TOOL_ACTION copy
Definition: actions.h:67
static TOOL_ACTION showBusManager
Definition: ee_actions.h:153
static TOOL_ACTION updateSchematicFromPcb
Definition: actions.h:164
static TOOL_ACTION editSymbolFields
Definition: ee_actions.h:143
static TOOL_ACTION placePower
Definition: ee_actions.h:79
static TOOL_ACTION drawWire
Definition: ee_actions.h:80
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:91
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:93
static TOOL_ACTION cut
Definition: actions.h:66
void UpdateClearText(wxMenu *aMenu, wxString aClearText)
Update the text displayed on the menu item that clears the entire menu.
#define _(s)
ACTION_MENU * Clone() const
Create a deep, recursive copy of this ACTION_MENU.
static TOOL_ACTION plot
Definition: actions.h:58
static TOOL_ACTION importSheetPin
Definition: ee_actions.h:90
static TOOL_ACTION placeSymbol
Definition: ee_actions.h:78
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:193
static TOOL_ACTION milsUnits
Definition: actions.h:145
static TOOL_ACTION drawBus
Definition: ee_actions.h:81
static TOOL_ACTION prevMarker
Definition: actions.h:85
static TOOL_ACTION pasteSpecial
Definition: actions.h:69
static TOOL_ACTION placeLabel
Definition: ee_actions.h:86
static TOOL_ACTION redo
Definition: actions.h:65
static constexpr bool CHECK
Definition: action_menu.h:189
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:196
static TOOL_ACTION zoomRedraw
Definition: actions.h:90
static TOOL_ACTION importFPAssignments
Definition: ee_actions.h:165
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:83
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:147
static TOOL_ACTION drawSheetOnClipboard
Definition: ee_actions.h:208
static TOOL_ACTION repairSchematic
Definition: ee_actions.h:212
static TOOL_ACTION gridProperties
Definition: actions.h:141
static TOOL_ACTION deleteTool
Definition: actions.h:73
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
static TOOL_ACTION undo
Definition: actions.h:64
static TOOL_ACTION generateBOM
Definition: ee_actions.h:167
static TOOL_ACTION drawLines
Definition: ee_actions.h:92
static TOOL_ACTION toggleCursorStyle
Definition: actions.h:102
static TOOL_ACTION schematicSetup
Definition: ee_actions.h:154
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:87
static TOOL_ACTION editSymbolLibraryLinks
Definition: ee_actions.h:144
static TOOL_ACTION configurePaths
Definition: actions.h:174
static TOOL_ACTION selectAll
Definition: actions.h:70
static TOOL_ACTION paste
Definition: actions.h:68