kicad/eeschema/menubar_libedit.cpp

367 lines
12 KiB
C++
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2007 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
* Copyright (C) 2009 Wayne Stambaugh <stambaughw@gmail.com>
* Copyright (C) 1992-2018 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
2010-03-18 20:40:18 +00:00
/**
* @file eeschema/menubar_libedit.cpp
* @brief (Re)Create the main menubar for the part editor frame (LibEdit)
2010-03-18 20:40:18 +00:00
*/
#include <menus_helpers.h>
* KIWAY Milestone A): Make major modules into DLL/DSOs. ! The initial testing of this commit should be done using a Debug build so that all the wxASSERT()s are enabled. Also, be sure and keep enabled the USE_KIWAY_DLLs option. The tree won't likely build without it. Turning it off is senseless anyways. If you want stable code, go back to a prior version, the one tagged with "stable". * Relocate all functionality out of the wxApp derivative into more finely targeted purposes: a) DLL/DSO specific b) PROJECT specific c) EXE or process specific d) configuration file specific data e) configuration file manipulations functions. All of this functionality was blended into an extremely large wxApp derivative and that was incompatible with the desire to support multiple concurrently loaded DLL/DSO's ("KIFACE")s and multiple concurrently open projects. An amazing amount of organization come from simply sorting each bit of functionality into the proper box. * Switch to wxConfigBase from wxConfig everywhere except instantiation. * Add classes KIWAY, KIFACE, KIFACE_I, SEARCH_STACK, PGM_BASE, PGM_KICAD, PGM_SINGLE_TOP, * Remove "Return" prefix on many function names. * Remove obvious comments from CMakeLists.txt files, and from else() and endif()s. * Fix building boost for use in a DSO on linux. * Remove some of the assumptions in the CMakeLists.txt files that windows had to be the host platform when building windows binaries. * Reduce the number of wxStrings being constructed at program load time via static construction. * Pass wxConfigBase* to all SaveSettings() and LoadSettings() functions so that these functions are useful even when the wxConfigBase comes from another source, as is the case in the KICAD_MANAGER_FRAME. * Move the setting of the KIPRJMOD environment variable into class PROJECT, so that it can be moved into a project variable soon, and out of FP_LIB_TABLE. * Add the KIWAY_PLAYER which is associated with a particular PROJECT, and all its child wxFrames and wxDialogs now have a Kiway() member function which returns a KIWAY& that that window tree branch is in support of. This is like wxWindows DNA in that child windows get this member with proper value at time of construction. * Anticipate some of the needs for milestones B) and C) and make code adjustments now in an effort to reduce work in those milestones. * No testing has been done for python scripting, since milestone C) has that being largely reworked and re-thought-out.
2014-03-20 00:42:08 +00:00
#include <pgm_base.h>
2010-03-18 20:40:18 +00:00
#include "eeschema_id.h"
#include "general.h"
#include "help_common_strings.h"
#include "hotkeys.h"
2018-01-30 10:49:51 +00:00
#include "lib_edit_frame.h"
2010-03-18 20:40:18 +00:00
2010-03-18 20:40:18 +00:00
/**
* @brief (Re)Create the menubar for the part editor frame
2010-03-18 20:40:18 +00:00
*/
void LIB_EDIT_FRAME::ReCreateMenuBar()
2010-03-18 20:40:18 +00:00
{
// wxWidgets handles the Mac Application menu behind the scenes, but that means
// we always have to start from scratch with a new wxMenuBar.
wxMenuBar* oldMenuBar = GetMenuBar();
wxMenuBar* menuBar = new wxMenuBar();
2010-03-18 20:40:18 +00:00
wxString text;
// Recreate all menus:
// Menu File:
wxMenu* fileMenu = new wxMenu;
2010-03-18 20:40:18 +00:00
2017-10-31 11:13:20 +00:00
// Creating/loading libraries
AddMenuItem( fileMenu,
ID_LIBEDIT_NEW_LIBRARY,
_( "&New Library..." ),
2017-10-31 11:13:20 +00:00
_( "Creates an empty library" ),
KiBitmap( new_library_xpm ) );
AddMenuItem( fileMenu,
2017-10-31 11:13:20 +00:00
ID_LIBEDIT_ADD_LIBRARY,
_( "&Add Library..." ),
2017-10-31 11:13:20 +00:00
_( "Adds a previously created library" ),
KiBitmap( add_library_xpm ) );
2017-10-31 11:13:20 +00:00
// Separator
fileMenu->AppendSeparator();
2017-10-31 11:13:20 +00:00
// Save library variants
AddMenuItem( fileMenu,
ID_LIBEDIT_SAVE_LIBRARY,
_( "&Save Library" ),
_( "Save the current library" ),
KiBitmap( save_library_xpm ) );
2010-03-18 20:40:18 +00:00
AddMenuItem( fileMenu,
2017-10-31 11:13:20 +00:00
ID_LIBEDIT_SAVE_LIBRARY_AS,
2017-12-21 12:46:21 +00:00
_( "Save Library As..." ),
2017-10-31 11:13:20 +00:00
_( "Save the current library to a new file" ),
KiBitmap( save_as_xpm ) );
2010-03-18 20:40:18 +00:00
text = AddHotkeyName( _( "Save All &Libraries" ), g_Libedit_Hokeys_Descr, HK_SAVE_ALL_LIBS );
AddMenuItem( fileMenu, ID_LIBEDIT_SAVE_ALL_LIBS, text, _( "Save all library changes" ),
2017-10-31 11:13:20 +00:00
KiBitmap( save_xpm ) );
// Separator
fileMenu->AppendSeparator();
2010-03-18 20:40:18 +00:00
// Export as png file
AddMenuItem( fileMenu,
ID_LIBEDIT_GEN_PNG_FILE,
_( "Export Current View as &PNG..." ),
_( "Create a PNG file from the current view" ),
KiBitmap( plot_xpm ) );
2010-03-18 20:40:18 +00:00
// Export as SVG file
AddMenuItem( fileMenu,
ID_LIBEDIT_GEN_SVG_FILE,
2017-02-07 21:19:48 +00:00
_( "Create S&VG File..." ),
_( "Create a SVG file from the current symbol" ),
KiBitmap( plot_svg_xpm ) );
// Separator
fileMenu->AppendSeparator();
// Quit
AddMenuItem( fileMenu,
wxID_EXIT,
_( "&Quit" ),
_( "Quit Library Editor" ),
KiBitmap( exit_xpm ) );
// Edit menu
2010-03-18 20:40:18 +00:00
wxMenu* editMenu = new wxMenu;
// Undo
text = AddHotkeyName( _( "&Undo" ), g_Libedit_Hokeys_Descr, HK_UNDO );
2010-03-18 20:40:18 +00:00
AddMenuItem( editMenu,
wxID_UNDO,
text,
_( "Undo last edit" ),
KiBitmap( undo_xpm ) );
2010-03-18 20:40:18 +00:00
// Redo
text = AddHotkeyName( _( "&Redo" ), g_Libedit_Hokeys_Descr, HK_REDO );
AddMenuItem( editMenu,
wxID_REDO,
text,
_( "Redo the last undo command" ),
KiBitmap( redo_xpm ) );
2010-03-18 20:40:18 +00:00
// Menu View:
2010-03-18 20:40:18 +00:00
wxMenu* viewMenu = new wxMenu;
/**
* Important Note for ZOOM IN and ZOOM OUT commands from menubar:
2010-03-18 20:40:18 +00:00
* we cannot add hotkey info here, because the hotkey HK_ZOOM_IN and HK_ZOOM_OUT
* events(default = WXK_F1 and WXK_F2) are *NOT* equivalent to this menu command:
* zoom in and out from hotkeys are equivalent to the pop up menu zoom
* From here, zooming is made around the screen center
* From hotkeys, zooming is made around the mouse cursor position
* (obviously not possible from the toolbar or menubar command)
2010-03-18 20:40:18 +00:00
*
* in others words HK_ZOOM_IN and HK_ZOOM_OUT *are NOT* accelerators
* for Zoom in and Zoom out sub menus
*/
// Zoom in
text = _( "Zoom &In" );
AddMenuItem( viewMenu, ID_ZOOM_IN, text, HELP_ZOOM_IN, KiBitmap( zoom_in_xpm ) );
2010-03-18 20:40:18 +00:00
// Zoom out
text = _( "Zoom &Out" );
AddMenuItem( viewMenu, ID_ZOOM_OUT, text, HELP_ZOOM_OUT, KiBitmap( zoom_out_xpm ) );
2010-03-18 20:40:18 +00:00
// Fit on screen
text = AddHotkeyName( _( "&Zoom to Fit" ), g_Libedit_Hokeys_Descr, HK_ZOOM_AUTO );
AddMenuItem( viewMenu, ID_ZOOM_PAGE, text, _( "Zoom to fit symbol" ),
KiBitmap( zoom_fit_in_page_xpm ) );
2010-03-18 20:40:18 +00:00
text = AddHotkeyName( _( "Zoom to Selection" ),
g_Schematic_Hokeys_Descr, HK_ZOOM_SELECTION );
AddMenuItem( viewMenu, ID_MENU_ZOOM_SELECTION, text, KiBitmap( zoom_area_xpm ) );
// Redraw
text = AddHotkeyName( _( "&Redraw" ), g_Libedit_Hokeys_Descr, HK_ZOOM_REDRAW );
AddMenuItem( viewMenu, ID_ZOOM_REDRAW, text, HELP_ZOOM_REDRAW, KiBitmap( zoom_redraw_xpm ) );
2010-03-18 20:40:18 +00:00
2017-10-31 11:13:20 +00:00
// Separator
viewMenu->AppendSeparator();
AddMenuItem( viewMenu,
ID_LIBEDIT_SHOW_HIDE_SEARCH_TREE,
_( "&Search Tree" ),
2017-10-31 11:13:20 +00:00
_( "Toggles the search tree visibility" ),
KiBitmap( search_tree_xpm ) );
// Menu Part:
wxMenu* partMenu = new wxMenu;
2017-10-31 11:13:20 +00:00
AddMenuItem( partMenu,
2017-10-31 11:13:20 +00:00
ID_LIBEDIT_NEW_PART,
_( "&New Symbol..." ),
_( "Create a new empty symbol" ),
2017-10-31 11:13:20 +00:00
KiBitmap( new_component_xpm ) );
AddMenuItem( partMenu,
2017-10-31 11:13:20 +00:00
ID_LIBEDIT_SAVE_PART,
_( "&Save Symbol" ),
_( "Saves the current symbol to the library" ),
KiBitmap( save_part_xpm ) );
2017-10-31 11:13:20 +00:00
partMenu->AppendSeparator();
2017-10-31 11:13:20 +00:00
AddMenuItem( partMenu,
2017-10-31 11:13:20 +00:00
ID_LIBEDIT_IMPORT_PART,
_( "&Import Symbol..." ),
_( "Import a symbol to the current library" ),
KiBitmap( import_part_xpm ) );
2017-10-31 11:13:20 +00:00
AddMenuItem( partMenu,
2017-10-31 11:13:20 +00:00
ID_LIBEDIT_EXPORT_PART,
_( "&Export Symbol..." ),
_( "Export the current symbol" ),
KiBitmap( export_part_xpm ) );
2017-10-31 11:13:20 +00:00
partMenu->AppendSeparator();
2017-10-31 11:13:20 +00:00
AddMenuItem( partMenu,
2017-10-31 11:13:20 +00:00
ID_LIBEDIT_GET_FRAME_EDIT_PART,
_( "&Properties..." ),
_( "Edit symbol properties" ),
2017-10-31 11:13:20 +00:00
KiBitmap( part_properties_xpm ) );
AddMenuItem( partMenu,
2017-10-31 11:13:20 +00:00
ID_LIBEDIT_GET_FRAME_EDIT_FIELDS,
_( "&Fields..." ),
2017-10-31 11:13:20 +00:00
_( "Edit field properties" ),
KiBitmap( edit_text_xpm ) );
partMenu->AppendSeparator();
2017-10-31 11:13:20 +00:00
AddMenuItem( partMenu,
2017-10-31 11:13:20 +00:00
ID_LIBEDIT_EDIT_PIN_BY_TABLE,
_( "Pi&n Table..." ),
2017-10-31 11:13:20 +00:00
_( "Show pin table" ),
KiBitmap( pin_table_xpm ) );
AddMenuItem( partMenu,
2017-10-31 11:13:20 +00:00
ID_LIBEDIT_CHECK_PART,
_( "Electrical Rules Checker" ),
2017-10-31 11:13:20 +00:00
_( "Check duplicate and off grid pins" ),
KiBitmap( erc_xpm ) );
// Menu Place:
2010-03-18 20:40:18 +00:00
wxMenu* placeMenu = new wxMenu;
// Pin
AddMenuItem( placeMenu,
ID_LIBEDIT_PIN_BUTT,
_( "&Pin" ),
HELP_ADD_PIN,
KiBitmap( pin_xpm ) );
2010-03-18 20:40:18 +00:00
// Graphic text
AddMenuItem( placeMenu,
ID_LIBEDIT_BODY_TEXT_BUTT,
_( "Graphic &Text" ),
HELP_ADD_BODYTEXT,
KiBitmap( text_xpm ) );
2010-03-18 20:40:18 +00:00
// Graphic rectangle
AddMenuItem( placeMenu,
ID_LIBEDIT_BODY_RECT_BUTT,
_( "&Rectangle" ),
HELP_ADD_BODYRECT,
KiBitmap( add_rectangle_xpm ) );
2010-03-18 20:40:18 +00:00
// Graphic Circle
AddMenuItem( placeMenu,
ID_LIBEDIT_BODY_CIRCLE_BUTT,
_( "&Circle" ),
HELP_ADD_BODYCIRCLE,
KiBitmap( add_circle_xpm ) );
2010-03-18 20:40:18 +00:00
// Graphic Arc
AddMenuItem( placeMenu,
ID_LIBEDIT_BODY_ARC_BUTT,
_( "&Arc" ),
HELP_ADD_BODYARC,
KiBitmap( add_arc_xpm ) );
2010-03-18 20:40:18 +00:00
// Graphic Line or Polygon
AddMenuItem( placeMenu,
ID_LIBEDIT_BODY_LINE_BUTT,
_( "&Line or Polygon" ),
HELP_ADD_BODYPOLYGON,
KiBitmap( add_polygon_xpm ) );
2010-03-18 20:40:18 +00:00
// Menu Preferences:
wxMenu* preferencesMenu = new wxMenu;
// Environment varialbes
AddMenuItem( preferencesMenu,
ID_PREFERENCES_CONFIGURE_PATHS,
_( "Configure Pa&ths..." ),
_( "Edit path configuration environment variables" ),
KiBitmap( path_xpm ) );
// Library list
AddMenuItem( preferencesMenu,
ID_EDIT_SYM_LIB_TABLE,
_( "Manage Symbol Libraries..." ),
_( "Edit the global and project symbol library tables." ),
KiBitmap( library_table_xpm ) );
preferencesMenu->AppendSeparator();
// Default values and options
AddMenuItem( preferencesMenu,
wxID_PREFERENCES,
_( "General &Options..." ),
_( "Set Symbol Editor default values and options" ),
KiBitmap( preference_xpm ) );
// Language submenu
* KIWAY Milestone A): Make major modules into DLL/DSOs. ! The initial testing of this commit should be done using a Debug build so that all the wxASSERT()s are enabled. Also, be sure and keep enabled the USE_KIWAY_DLLs option. The tree won't likely build without it. Turning it off is senseless anyways. If you want stable code, go back to a prior version, the one tagged with "stable". * Relocate all functionality out of the wxApp derivative into more finely targeted purposes: a) DLL/DSO specific b) PROJECT specific c) EXE or process specific d) configuration file specific data e) configuration file manipulations functions. All of this functionality was blended into an extremely large wxApp derivative and that was incompatible with the desire to support multiple concurrently loaded DLL/DSO's ("KIFACE")s and multiple concurrently open projects. An amazing amount of organization come from simply sorting each bit of functionality into the proper box. * Switch to wxConfigBase from wxConfig everywhere except instantiation. * Add classes KIWAY, KIFACE, KIFACE_I, SEARCH_STACK, PGM_BASE, PGM_KICAD, PGM_SINGLE_TOP, * Remove "Return" prefix on many function names. * Remove obvious comments from CMakeLists.txt files, and from else() and endif()s. * Fix building boost for use in a DSO on linux. * Remove some of the assumptions in the CMakeLists.txt files that windows had to be the host platform when building windows binaries. * Reduce the number of wxStrings being constructed at program load time via static construction. * Pass wxConfigBase* to all SaveSettings() and LoadSettings() functions so that these functions are useful even when the wxConfigBase comes from another source, as is the case in the KICAD_MANAGER_FRAME. * Move the setting of the KIPRJMOD environment variable into class PROJECT, so that it can be moved into a project variable soon, and out of FP_LIB_TABLE. * Add the KIWAY_PLAYER which is associated with a particular PROJECT, and all its child wxFrames and wxDialogs now have a Kiway() member function which returns a KIWAY& that that window tree branch is in support of. This is like wxWindows DNA in that child windows get this member with proper value at time of construction. * Anticipate some of the needs for milestones B) and C) and make code adjustments now in an effort to reduce work in those milestones. * No testing has been done for python scripting, since milestone C) has that being largely reworked and re-thought-out.
2014-03-20 00:42:08 +00:00
Pgm().AddMenuLanguageList( preferencesMenu );
// Hotkey submenu
AddHotkeyConfigMenu( preferencesMenu );
// Menu Help:
2010-03-18 20:40:18 +00:00
wxMenu* helpMenu = new wxMenu;
// Contents
AddMenuItem( helpMenu,
wxID_HELP,
_( "Eeschema &Manual" ),
_( "Open the Eeschema Manual" ),
KiBitmap( online_help_xpm ) );
AddMenuItem( helpMenu,
wxID_INDEX,
_( "&Getting Started in KiCad" ),
_( "Open the \"Getting Started in KiCad\" guide for beginners" ),
KiBitmap( help_xpm ) );
2018-02-15 08:23:06 +00:00
text = AddHotkeyName( _( "&List Hotkeys..." ), g_Eeschema_Hokeys_Descr, HK_HELP );
AddMenuItem( helpMenu,
ID_PREFERENCES_HOTKEY_SHOW_CURRENT_LIST,
2018-02-15 08:23:06 +00:00
text,
_( "Displays the current hotkeys list and corresponding commands" ),
KiBitmap( hotkeys_xpm ) );
helpMenu->AppendSeparator();
AddMenuItem( helpMenu, ID_HELP_GET_INVOLVED,
_( "Get &Involved" ),
_( "Contribute to KiCad (opens a web browser)" ),
KiBitmap( info_xpm ) );
// About Eeschema
helpMenu->AppendSeparator();
AddMenuItem( helpMenu,
wxID_ABOUT,
_( "&About KiCad" ),
_( "About KiCad" ),
KiBitmap( about_xpm ) );
2010-03-18 20:40:18 +00:00
// Create the menubar and append all submenus
menuBar->Append( fileMenu, _( "&File" ) );
2010-03-18 20:40:18 +00:00
menuBar->Append( editMenu, _( "&Edit" ) );
menuBar->Append( viewMenu, _( "&View" ) );
menuBar->Append( partMenu, _( "&Symbol" ) );
2010-03-18 20:40:18 +00:00
menuBar->Append( placeMenu, _( "&Place" ) );
menuBar->Append( preferencesMenu, _( "P&references" ) );
2010-03-18 20:40:18 +00:00
menuBar->Append( helpMenu, _( "&Help" ) );
SetMenuBar( menuBar );
delete oldMenuBar;
2010-03-18 20:40:18 +00:00
}