KiCad PCB EDA Suite
menubar_footprint_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) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
5  * Copyright (C) 2015 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
6  * Copyright (C) 2015 Wayne Stambaugh <stambaughw@gmail.com>
7  * Copyright (C) 1992-2020 KiCad Developers, see AUTHORS.txt for contributors.
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 "footprint_edit_frame.h"
28 #include "pcbnew_id.h"
29 #include <bitmaps.h>
30 #include <menus_helpers.h>
31 #include <tool/actions.h>
32 #include <tool/action_menu.h>
33 #include <tool/tool_manager.h>
34 #include <tools/pcb_actions.h>
36 #include <widgets/wx_menubar.h>
37 
38 
40 {
42  // wxWidgets handles the Mac Application menu behind the scenes, but that means
43  // we always have to start from scratch with a new wxMenuBar.
44  wxMenuBar* oldMenuBar = GetMenuBar();
45  WX_MENUBAR* menuBar = new WX_MENUBAR();
46 
47  //-- File menu ----------------------------------------------------------
48  //
49  ACTION_MENU* fileMenu = new ACTION_MENU( false, selTool );
50 
51  fileMenu->Add( ACTIONS::newLibrary );
52  fileMenu->Add( ACTIONS::addLibrary );
53  fileMenu->Add( PCB_ACTIONS::newFootprint );
54 
55 #ifdef KICAD_SCRIPTING
56  fileMenu->Add( PCB_ACTIONS::createFootprint );
57 #endif
58 
59  fileMenu->AppendSeparator();
60 
61  fileMenu->Add( ACTIONS::save );
62  fileMenu->Add( ACTIONS::saveAs );
63  fileMenu->Add( ACTIONS::revert );
64 
65  fileMenu->AppendSeparator();
66 
67  ACTION_MENU* submenuImport = new ACTION_MENU( false, selTool );
68  submenuImport->SetTitle( _( "Import" ) );
69  submenuImport->SetIcon( BITMAPS::import );
70 
71  submenuImport->Add( PCB_ACTIONS::importFootprint, ACTION_MENU::NORMAL, _( "Footprint..." ) );
72  submenuImport->Add( PCB_ACTIONS::placeImportedGraphics, ACTION_MENU::NORMAL, _( "Graphics..." ) );
73 
74  fileMenu->Add( submenuImport );
75 
76  ACTION_MENU* submenuExport = new ACTION_MENU( false, selTool );
77  submenuExport->SetTitle( _( "Export" ) );
78  submenuExport->SetIcon( BITMAPS::export_file );
79 
80  submenuExport->Add( PCB_ACTIONS::exportFootprint, ACTION_MENU::NORMAL, _( "Footprint..." ) );
81  submenuExport->Add( _( "View as &PNG..." ),
82  _( "Create a PNG file from the current view" ),
85 
86  fileMenu->Add( submenuExport );
87 
88  fileMenu->AppendSeparator();
89  fileMenu->Add( ACTIONS::print );
90 
91  fileMenu->AppendSeparator();
92  fileMenu->AddClose( _( "Footprint Editor" ) );
93 
94 
95  //-- Edit menu -------------------------------------------------------
96  //
97  ACTION_MENU* editMenu = new ACTION_MENU( false, selTool );
98 
99  editMenu->Add( ACTIONS::undo );
100  editMenu->Add( ACTIONS::redo );
101 
102  editMenu->AppendSeparator();
103  editMenu->Add( ACTIONS::cut );
104  editMenu->Add( ACTIONS::copy );
105  editMenu->Add( ACTIONS::paste );
106  editMenu->Add( ACTIONS::doDelete );
107  editMenu->Add( ACTIONS::duplicate );
108 
109  editMenu->AppendSeparator();
110  editMenu->Add( ACTIONS::selectAll );
111 
112  editMenu->AppendSeparator();
115 
116  editMenu->AppendSeparator();
117  editMenu->Add( PCB_ACTIONS::cleanupGraphics );
118 
119 
120  //-- View menu -------------------------------------------------------
121  //
122  ACTION_MENU* viewMenu = new ACTION_MENU( false, selTool );
123 
124  viewMenu->Add( ACTIONS::showFootprintBrowser );
125  viewMenu->Add( ACTIONS::show3DViewer );
126 
127  viewMenu->AppendSeparator();
128  viewMenu->Add( ACTIONS::zoomInCenter );
129  viewMenu->Add( ACTIONS::zoomOutCenter );
130  viewMenu->Add( ACTIONS::zoomFitScreen );
131  viewMenu->Add( ACTIONS::zoomTool );
132  viewMenu->Add( ACTIONS::zoomRedraw );
133 
134  viewMenu->AppendSeparator();
136  viewMenu->Add( ACTIONS::gridProperties );
138 
139  // Units submenu
140  ACTION_MENU* unitsSubMenu = new ACTION_MENU( false, selTool );
141  unitsSubMenu->SetTitle( _( "&Units" ) );
142  unitsSubMenu->SetIcon( BITMAPS::unit_mm );
143  unitsSubMenu->Add( ACTIONS::inchesUnits, ACTION_MENU::CHECK );
144  unitsSubMenu->Add( ACTIONS::milsUnits, ACTION_MENU::CHECK );
146  viewMenu->Add( unitsSubMenu );
147 
149 
150  viewMenu->AppendSeparator();
151  // Drawing Mode Submenu
152  ACTION_MENU* drawingModeSubMenu = new ACTION_MENU( false, selTool );
153  drawingModeSubMenu->SetTitle( _( "&Drawing Mode" ) );
154  drawingModeSubMenu->SetIcon( BITMAPS::add_zone );
155 
156  drawingModeSubMenu->Add( PCB_ACTIONS::padDisplayMode, ACTION_MENU::CHECK );
157  drawingModeSubMenu->Add( PCB_ACTIONS::graphicsOutlines, ACTION_MENU::CHECK );
158  drawingModeSubMenu->Add( PCB_ACTIONS::textOutlines, ACTION_MENU::CHECK );
159  viewMenu->Add( drawingModeSubMenu );
160 
161  // Contrast Mode Submenu
162  ACTION_MENU* contrastModeSubMenu = new ACTION_MENU( false, selTool );
163  contrastModeSubMenu->SetTitle( _( "&Contrast Mode" ) );
164  contrastModeSubMenu->SetIcon( BITMAPS::contrast_mode );
165 
166  contrastModeSubMenu->Add( ACTIONS::highContrastMode, ACTION_MENU::CHECK );
167  contrastModeSubMenu->Add( PCB_ACTIONS::layerAlphaDec );
168  contrastModeSubMenu->Add( PCB_ACTIONS::layerAlphaInc );
169  viewMenu->Add( contrastModeSubMenu );
170 
172 
173  viewMenu->AppendSeparator();
175 
176 
177  //-- Place menu -------------------------------------------------------
178  //
179  ACTION_MENU* placeMenu = new ACTION_MENU( false, selTool );
180 
181  placeMenu->Add( PCB_ACTIONS::placePad );
182 
183  placeMenu->AppendSeparator();
184  placeMenu->Add( PCB_ACTIONS::placeText );
185  placeMenu->Add( PCB_ACTIONS::drawLine );
186  placeMenu->Add( PCB_ACTIONS::drawArc );
187  placeMenu->Add( PCB_ACTIONS::drawRectangle );
188  placeMenu->Add( PCB_ACTIONS::drawCircle );
189  placeMenu->Add( PCB_ACTIONS::drawPolygon );
190  placeMenu->Add( PCB_ACTIONS::drawRuleArea );
191 
192  placeMenu->AppendSeparator();
193  placeMenu->Add( PCB_ACTIONS::setAnchor );
194  placeMenu->Add( ACTIONS::gridSetOrigin );
195 
196 
197  //-- Inspect menu ------------------------------------------------------
198  //
199  ACTION_MENU* inspectMenu = new ACTION_MENU( false, selTool );
200 
201  inspectMenu->Add( ACTIONS::measureTool );
202 
203  inspectMenu->AppendSeparator();
204  inspectMenu->Add( PCB_ACTIONS::checkFootprint );
205 
206 
207  //-- Tools menu --------------------------------------------------------
208  //
209  ACTION_MENU* toolsMenu = new ACTION_MENU( false, selTool );
210 
211  toolsMenu->Add( _( "&Load Footprint from PCB..." ),
212  _( "Load a footprint from the current board into the editor" ),
215 
216  toolsMenu->Add( _( "&Insert Footprint on PCB" ),
217  _( "Insert footprint onto current board" ),
220 
221 
222  //-- Preferences menu -------------------------------------------------
223  //
224  ACTION_MENU* prefsMenu = new ACTION_MENU( false, selTool );
225 
226  prefsMenu->Add( ACTIONS::configurePaths );
227  prefsMenu->Add( ACTIONS::showFootprintLibTable );
228  prefsMenu->Add( _( "Preferences..." ) + "\tCtrl+,",
229  _( "Show preferences for all open tools" ),
230  wxID_PREFERENCES,
232 
233  prefsMenu->AppendSeparator();
234  AddMenuLanguageList( prefsMenu, selTool );
235 
236  //--MenuBar -----------------------------------------------------------
237  //
238  menuBar->Append( fileMenu, _( "&File" ) );
239  menuBar->Append( editMenu, _( "&Edit" ) );
240  menuBar->Append( viewMenu, _( "&View" ) );
241  menuBar->Append( placeMenu, _( "&Place" ) );
242  menuBar->Append( inspectMenu, _( "&Inspect" ) );
243  menuBar->Append( toolsMenu, _( "&Tools" ) );
244  menuBar->Append( prefsMenu, _( "P&references" ) );
245  AddStandardHelpMenu( menuBar );
246 
247  SetMenuBar( menuBar );
248  delete oldMenuBar;
249 }
static TOOL_ACTION drawLine
Definition: pcb_actions.h:146
static TOOL_ACTION show3DViewer
Definition: actions.h:161
static TOOL_ACTION placeImportedGraphics
Definition: pcb_actions.h:165
static TOOL_ACTION footprintProperties
Definition: pcb_actions.h:376
static TOOL_ACTION zoomInCenter
Definition: actions.h:96
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:47
static TOOL_ACTION doDelete
Definition: actions.h:75
static TOOL_ACTION checkFootprint
Definition: pcb_actions.h:379
static TOOL_ACTION drawArc
Definition: pcb_actions.h:150
void SetIcon(BITMAPS aIcon)
Assign an icon for the entry.
Definition: action_menu.cpp:72
static TOOL_ACTION cleanupGraphics
Definition: pcb_actions.h:324
static TOOL_ACTION layerAlphaDec
Definition: pcb_actions.h:293
static TOOL_ACTION zoomTool
Definition: actions.h:102
static TOOL_ACTION layerAlphaInc
Definition: pcb_actions.h:292
static TOOL_ACTION zoomFitScreen
Definition: actions.h:99
static TOOL_ACTION millimetersUnits
Definition: actions.h:149
static TOOL_ACTION drawPolygon
Definition: pcb_actions.h:147
static TOOL_ACTION placePad
Activation of the drawing tool (placing a PAD)
Definition: pcb_actions.h:382
static constexpr bool NORMAL
Definition: action_menu.h:181
static TOOL_ACTION print
Definition: actions.h:60
Wrapper around a wxMenuBar object that prevents the accelerator table from being used.
Definition: wx_menubar.h:45
static TOOL_ACTION setAnchor
Definition: pcb_actions.h:166
static TOOL_ACTION placeText
Definition: pcb_actions.h:151
static TOOL_ACTION zoomOutCenter
Definition: actions.h:97
static TOOL_ACTION createFootprint
Definition: pcb_actions.h:361
static TOOL_ACTION measureTool
Definition: actions.h:157
void ReCreateMenuBar() override
(Re)Create the menubar for the Footprint Editor frame
static TOOL_ACTION copy
Definition: actions.h:70
static TOOL_ACTION showFootprintLibTable
Definition: actions.h:177
static TOOL_ACTION toggleGrid
Definition: actions.h:143
static TOOL_ACTION exportFootprint
Definition: pcb_actions.h:374
static TOOL_ACTION showFootprintBrowser
Definition: actions.h:164
static TOOL_ACTION inchesUnits
Definition: actions.h:147
static TOOL_ACTION save
Definition: actions.h:54
void AddStandardHelpMenu(wxMenuBar *aMenuBar)
Adds the standard KiCad help menu to the menubar.
static TOOL_ACTION togglePolarCoords
Definition: actions.h:152
static TOOL_ACTION cut
Definition: actions.h:69
static TOOL_ACTION drawRectangle
Definition: pcb_actions.h:148
static TOOL_ACTION addLibrary
Definition: actions.h:52
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 newLibrary
Definition: actions.h:51
static TOOL_ACTION milsUnits
Definition: actions.h:148
static TOOL_ACTION importFootprint
Definition: pcb_actions.h:373
static TOOL_ACTION padDisplayMode
Definition: pcb_actions.h:248
static TOOL_ACTION drawCircle
Definition: pcb_actions.h:149
static TOOL_ACTION graphicsOutlines
Display footprint graphics as outlines.
Definition: pcb_actions.h:394
static TOOL_ACTION redo
Definition: actions.h:68
static TOOL_ACTION defaultPadProperties
Definition: pcb_actions.h:377
static constexpr bool CHECK
Definition: action_menu.h:182
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
static TOOL_ACTION drawRuleArea
Definition: pcb_actions.h:158
void SetTitle(const wxString &aTitle) override
Set title for the menu.
Definition: action_menu.cpp:90
static TOOL_ACTION showFootprintTree
Definition: pcb_actions.h:353
static TOOL_ACTION saveAs
Definition: actions.h:55
#define _(s)
Definition: 3d_actions.cpp:33
static TOOL_ACTION zoomRedraw
Definition: actions.h:93
wxMenuItem * Add(const wxString &aLabel, int aId, BITMAPS aIcon)
Add a wxWidgets-style entry to the menu.
The selection tool: currently supports:
static TOOL_ACTION gridProperties
Definition: actions.h:144
static TOOL_ACTION undo
Definition: actions.h:67
static TOOL_ACTION toggleCursorStyle
Definition: actions.h:105
static TOOL_ACTION flipBoard
Definition: pcb_actions.h:298
static TOOL_ACTION gridSetOrigin
Definition: actions.h:140
static TOOL_ACTION configurePaths
Definition: actions.h:175
static TOOL_ACTION highContrastMode
Definition: actions.h:106
static TOOL_ACTION selectAll
Definition: actions.h:73
static TOOL_ACTION paste
Definition: actions.h:71
static TOOL_ACTION duplicate
Definition: actions.h:74
static TOOL_ACTION revert
Definition: actions.h:58
static TOOL_ACTION newFootprint
Definition: pcb_actions.h:358
void AddClose(wxString aAppname="")
Add a standard close item to the menu with the accelerator key CTRL-W.
static TOOL_ACTION textOutlines
Display texts as lines.
Definition: pcb_actions.h:397