Hotkey submenu added, fixed typos. See CHANGELOG.txt

CHANGELOG.txt

@@ -4,6 +4,19 @@ KiCad ChangeLog 2009
 Please add newer entries at the top, list the date and your name with
 email address.
 
+
+2009-oct-27 UPDATE Jerry Jacobs <xor.gate.engineering@gmail.com>
+================================================================================
+++common
+    Doxygen output directory changed to Documentation/doxygen
+    Cleanup of HOTKEY IDs
+    Creation and cleanup of hotkey submenu
+
+++misc
+    Moved pcbcfg.cpp to pcbnew_config.cpp
+    Moved eeconfig.ccp to eeschema_config.cpp
+    Fixed typos
+
 2009-oct-23 UPDATE Jean-Pierre Charras <jean-pierre.charras@gipsa-lab.inpg.fr>
 ================================================================================
 ++pcbnew

Doxyfile

@@ -4,9 +4,9 @@
 # Project related configuration options
 #---------------------------------------------------------------------------
 DOXYFILE_ENCODING      = UTF-8
-PROJECT_NAME           = Kicad
+PROJECT_NAME           = KiCad PCB EDA Suite
 PROJECT_NUMBER         = 
-OUTPUT_DIRECTORY       = 
+OUTPUT_DIRECTORY       = Documentation/doxygen
 CREATE_SUBDIRS         = NO
 OUTPUT_LANGUAGE        = English
 BRIEF_MEMBER_DESC      = YES

common/hotkeys_basic.cpp

@@ -629,60 +629,77 @@ wxString    ReturnHotkeyConfigFilePath( int choice )
 void AddHotkeyConfigMenu( wxMenu* menu )
 /***************************************/
 
-/** add hotkey config options to a menu
+/** add hotkey config options submenu to a menu
  * @param menu : initial menu
  */
 {
     wxMenuItem* item;
+    wxMenu* HotkeySubmenu = new wxMenu();
 
     if( menu == NULL )
         return;
 
-    item = new wxMenuItem( menu, ID_PREFERENCES_HOTKEY_SHOW_CURRENT_LIST,
-                           _( "Show Current Hotkey List" ),
-                           _( "Show the current hotkey config" ) );
+    /* Show hotkey configuration */
+    item = new wxMenuItem( HotkeySubmenu, ID_PREFERENCES_HOTKEY_SHOW_CURRENT_LIST,
+                           _( "Show" ),
+                           _( "Show the current hotkey configuration" ) );
     item->SetBitmap( info_xpm );
-    menu->Append( item );
+    HotkeySubmenu->Append( item );
 
-    item = new wxMenuItem( menu, ID_PREFERENCES_CREATE_CONFIG_HOTKEYS,
-                           _( "Create Hotkey config file" ),
-                           _( "Create or Recreate the hotkey config file from current hotkey list" )
+    /* (Re)create hotkey file */
+    item = new wxMenuItem( HotkeySubmenu, ID_PREFERENCES_HOTKEY_CREATE_CONFIG,
+                           _( "(Re)create" ),
+                           _( "Create or recreate the hotkey configuration file from current hotkey list" )
                            );
     item->SetBitmap( save_setup_xpm );
-    menu->Append( item );
+    HotkeySubmenu->Append( item );
 
-    item = new wxMenuItem( menu, ID_PREFERENCES_READ_CONFIG_HOTKEYS,
-                           _( "Reread Hotkey config file" ),
-                           _( "Reread the hotkey config file" ) );
+    /* Reload hotkey file */
+    item = new wxMenuItem( HotkeySubmenu, ID_PREFERENCES_HOTKEY_READ_CONFIG,
+                           _( "Reload" ),
+                           _( "Reload the hotkey configuration file" ) );
     item->SetBitmap( reload_xpm );
-    menu->Append( item );
-    item = new wxMenuItem( menu, ID_PREFERENCES_EDIT_CONFIG_HOTKEYS,
-                          _( "Edit Hotkey config file" ),
-                          _( "Run the text editor and edit the hotkey config file" ) );
+    HotkeySubmenu->Append( item );
+
+    /* Edit hotkey file */
+    item = new wxMenuItem( HotkeySubmenu, ID_PREFERENCES_HOTKEY_EDIT_CONFIG,
+                          _( "Edit" ),
+                          _( "Edit the hotkey configuration file in a text editor" ) );
     item->SetBitmap( editor_xpm );
-    menu->Append( item );
+    HotkeySubmenu->Append( item );
+
+    /* Append HotkeySubmenu to menu */
+    menu->Append( ID_PREFERENCES_HOTKEY_SUBMENU,
+                  _("Hotkey"),
+                  HotkeySubmenu,
+                  _("Hotkey configuration and preferences"));
+
+    /* Hotkey path */
+    wxMenu* HotkeyLocationSubmenu = new wxMenu();
 
-    wxMenu* submenu_hkcfg = new wxMenu();
-    item = new wxMenuItem( submenu_hkcfg, ID_PREFERENCES_HOTKEY_PATH_IS_HOME,
-                           _( "home directory" ),
+    /* Home directory */
+    item = new wxMenuItem( HotkeyLocationSubmenu, ID_PREFERENCES_HOTKEY_PATH_IS_HOME,
+                           _( "Home directory" ),
                            _( "Use home directory to load or store Hotkey config files" ),
                            wxITEM_CHECK );
-    submenu_hkcfg->Append( item );
+    HotkeyLocationSubmenu->Append( item );
 
-    item = new wxMenuItem( submenu_hkcfg, ID_PREFERENCES_HOTKEY_PATH_IS_KICAD,
-                           _( "kicad/template directory" ),
+    /* KiCad template directory */ 
+    item = new wxMenuItem( HotkeyLocationSubmenu, ID_PREFERENCES_HOTKEY_PATH_IS_KICAD,
+                           _( "KiCad template directory" ),
                            _( "Use kicad/template directory to load or store Hotkey config files" ),
                            wxITEM_CHECK );
-    submenu_hkcfg->Append( item );
+    HotkeyLocationSubmenu->Append( item );
 
+    /* Append location submenu to HotkeySubmenu */
     ADD_MENUITEM_WITH_HELP_AND_SUBMENU(
-        menu, submenu_hkcfg, -1,
-        _( "Hotkey config location" ),
-        _( "Select hotkey config file location (home directory or kicad tree)" ),
+        HotkeySubmenu, HotkeyLocationSubmenu, -1,
+        _( "Location" ),
+        _( "Select hotkey configuration file location" ),
         right_xpm );
-    submenu_hkcfg->Check( ID_PREFERENCES_HOTKEY_PATH_IS_HOME,
+    HotkeyLocationSubmenu->Check( ID_PREFERENCES_HOTKEY_PATH_IS_HOME,
                           g_ConfigFileLocationChoice == 0 );
-    submenu_hkcfg->Check( ID_PREFERENCES_HOTKEY_PATH_IS_KICAD,
+    HotkeyLocationSubmenu->Check( ID_PREFERENCES_HOTKEY_PATH_IS_KICAD,
                           g_ConfigFileLocationChoice == 1 );
 }
 

eeschema/CMakeLists.txt

@@ -67,12 +67,12 @@ set(EESCHEMA_SRCS
     edit_component_in_lib.cpp
     edit_component_in_schematic.cpp
     edit_label.cpp
-    eeconfig.cpp
     eelayer.cpp
     eelibs_draw_components.cpp
     eelibs_read_libraryfiles.cpp
     eeredraw.cpp
     eeschema.cpp
+    eeschema_config.cpp
     erc.cpp
     files-io.cpp
     find.cpp

eeschema/eeconfig.cpp → eeschema/eeschema_config.cpp

@@ -70,18 +70,20 @@ void WinEDA_SchematicFrame::Process_Config( wxCommandEvent& event )
     }
     break;
 
-    case ID_PREFERENCES_CREATE_CONFIG_HOTKEYS:
+
+    /* Hotkey IDs */
+    case ID_PREFERENCES_HOTKEY_CREATE_CONFIG:
         fn = wxFileName( ReturnHotkeyConfigFilePath( g_ConfigFileLocationChoice ),
                          HOTKEY_FILENAME,
                          DEFAULT_HOTKEY_FILENAME_EXT );
         WriteHotkeyConfigFile( fn.GetFullPath(), s_Eeschema_Hokeys_Descr, true );
         break;
 
-    case ID_PREFERENCES_READ_CONFIG_HOTKEYS:
+    case ID_PREFERENCES_HOTKEY_READ_CONFIG:
         Read_Hotkey_Config( this, true );
         break;
 
-    case ID_PREFERENCES_EDIT_CONFIG_HOTKEYS:
+    case ID_PREFERENCES_HOTKEY_EDIT_CONFIG:
     {
         fn = wxFileName( ReturnHotkeyConfigFilePath( g_ConfigFileLocationChoice ),
                          HOTKEY_FILENAME, DEFAULT_HOTKEY_FILENAME_EXT );

eeschema/menubar.cpp

@@ -288,7 +288,7 @@ void WinEDA_SchematicFrame::ReCreateMenuBar()
     item->SetBitmap( add_text_xpm );
     placeMenu->Append( item );
 
-    // Menu Configuration:
+    /* Preferences Menu */
     wxMenu* configmenu = new wxMenu;
     item = new wxMenuItem( configmenu, ID_CONFIG_REQ, _( "&Library" ),
                            _( "Library preferences" ) );
@@ -308,6 +308,8 @@ void WinEDA_SchematicFrame::ReCreateMenuBar()
 
     wxGetApp().AddMenuLanguageList( configmenu );
 
+    AddHotkeyConfigMenu( configmenu );
+
     configmenu->AppendSeparator();
     item = new wxMenuItem( configmenu, ID_CONFIG_SAVE, _( "&Save preferences" ),
                            _( "Save application preferences" ) );
@@ -319,10 +321,7 @@ void WinEDA_SchematicFrame::ReCreateMenuBar()
     item->SetBitmap( read_setup_xpm );
     configmenu->Append( item );
 
-    configmenu->AppendSeparator();
-    AddHotkeyConfigMenu( configmenu );
-
-    // Menu Help:
+    /* Help Menu*/
     wxMenu* helpMenu = new wxMenu;
     item = new wxMenuItem( helpMenu, ID_GENERAL_HELP, _( "&Contents" ),
                            _( "Open the eeschema manual" ) );

gerbview/gerbview_config.cpp

@@ -60,7 +60,8 @@ void WinEDA_GerberFrame::Process_Config( wxCommandEvent& event )
         Update_config();
         break;
 
-    case ID_PREFERENCES_CREATE_CONFIG_HOTKEYS:
+   /* Hotkey IDs */
+    case ID_PREFERENCES_HOTKEY_CREATE_CONFIG:
         FullFileName  = ReturnHotkeyConfigFilePath( g_ConfigFileLocationChoice );
         FullFileName += HOTKEY_FILENAME;
         FullFileName +=  wxT(".");
@@ -68,11 +69,11 @@ void WinEDA_GerberFrame::Process_Config( wxCommandEvent& event )
         WriteHotkeyConfigFile( FullFileName, s_Gerbview_Hokeys_Descr, true );
         break;
 
-    case ID_PREFERENCES_READ_CONFIG_HOTKEYS:
+    case ID_PREFERENCES_HOTKEY_READ_CONFIG:
         Read_Hotkey_Config( this, true );
         break;
 
-    case ID_PREFERENCES_EDIT_CONFIG_HOTKEYS:
+    case ID_PREFERENCES_HOTKEY_EDIT_CONFIG:
     {
         FullFileName  = ReturnHotkeyConfigFilePath( g_ConfigFileLocationChoice );
         FullFileName += HOTKEY_FILENAME;

include/id.h

@@ -33,12 +33,15 @@ enum main_id
     ID_CONFIG_REQ,
     ID_CONFIG_SAVE,
     ID_CONFIG_READ,
-    ID_PREFERENCES_CREATE_CONFIG_HOTKEYS,
-    ID_PREFERENCES_READ_CONFIG_HOTKEYS,
-    ID_PREFERENCES_EDIT_CONFIG_HOTKEYS,
+
+    ID_PREFERENCES_HOTKEY_SUBMENU,
+    ID_PREFERENCES_HOTKEY_CREATE_CONFIG,
+    ID_PREFERENCES_HOTKEY_READ_CONFIG,
+    ID_PREFERENCES_HOTKEY_EDIT_CONFIG,
     ID_PREFERENCES_HOTKEY_PATH_IS_HOME,
     ID_PREFERENCES_HOTKEY_PATH_IS_KICAD,
     ID_PREFERENCES_HOTKEY_SHOW_CURRENT_LIST,
+
     ID_PREFERENCES_UNUSED2,
     ID_PREFERENCES_UNUSED3,
     ID_CONFIG_AND_PREFERENCES_END,

pcbnew/CMakeLists.txt

@@ -119,9 +119,9 @@ set(PCBNEW_SRCS
     netlist.cpp
     onleftclick.cpp
     onrightclick.cpp
-    pcbcfg.cpp
     pcbframe.cpp
     pcbnew.cpp
+    pcbnew_config.cpp
     pcbplot.cpp
     plotgerb.cpp
     plothpgl.cpp

pcbnew/dialog_general_options_BoardEditor_base.cpp

@@ -66,7 +66,7 @@ DialogGeneralOptionsBoardEditor_base::DialogGeneralOptionsBoardEditor_base( wxWi
 
     bMiddleLeftSizer->Add( m_MaxShowLinks, 0, wxBOTTOM|wxRIGHT|wxLEFT|wxEXPAND, 5 );
 
-    m_staticTextautosave = new wxStaticText( this, wxID_ANY, _("Auto Save (minuts):"), wxDefaultPosition, wxDefaultSize, 0 );
+    m_staticTextautosave = new wxStaticText( this, wxID_ANY, _("Auto Save (minutes):"), wxDefaultPosition, wxDefaultSize, 0 );
     m_staticTextautosave->Wrap( -1 );
     bMiddleLeftSizer->Add( m_staticTextautosave, 0, wxTOP|wxRIGHT|wxLEFT|wxEXPAND, 5 );
 

pcbnew/dialog_general_options_BoardEditor_base.fbp

@@ -429,7 +429,7 @@
                                 <property name="font"></property>
                                 <property name="hidden">0</property>
                                 <property name="id">wxID_ANY</property>
-                                <property name="label">Auto Save (minuts):</property>
+                                <property name="label">Auto Save (minutes):</property>
                                 <property name="maximum_size"></property>
                                 <property name="minimum_size"></property>
                                 <property name="name">m_staticTextautosave</property>

pcbnew/menubarpcb.cpp

@@ -160,7 +160,7 @@ void WinEDA_PcbFrame::ReCreateMenuBar()
     // Add exit menu
     filesMenu->AppendSeparator();
     item = new wxMenuItem( filesMenu, ID_EXIT, _( "E&xit" ),
-                           _( "Quit PCBNEW" ) );
+                           _( "Quit PCBnew" ) );
     item->SetBitmap( exit_xpm );
     filesMenu->Append( item );
 
@@ -181,7 +181,7 @@ void WinEDA_PcbFrame::ReCreateMenuBar()
     configmenu->Append( item );
 
     item = new wxMenuItem( configmenu, ID_OPTIONS_SETUP, _( "&General" ),
-                           _( "Select general options for PCBNEW" ) );
+                           _( "Select general options for PCBnew" ) );
     item->SetBitmap( preference_xpm );
     configmenu->Append( item );
 
@@ -192,6 +192,8 @@ void WinEDA_PcbFrame::ReCreateMenuBar()
 
     wxGetApp().AddMenuLanguageList( configmenu );
 
+    AddHotkeyConfigMenu( configmenu );
+
     configmenu->AppendSeparator();
     item = new wxMenuItem( configmenu, ID_CONFIG_SAVE, _( "&Save Preferences" ),
                            _( "Save application preferences" ) );
@@ -203,9 +205,6 @@ void WinEDA_PcbFrame::ReCreateMenuBar()
     item->SetBitmap( read_setup_xpm );
     configmenu->Append( item );
 
-    configmenu->AppendSeparator();
-    AddHotkeyConfigMenu( configmenu );
-
     // Add access to the Design Rules Dialog:
     wxMenu* designRulesMenu = new wxMenu;
     item = new wxMenuItem( designRulesMenu, ID_MENU_PCB_SHOW_DESIGN_RULES_DIALOG,
@@ -320,12 +319,12 @@ void WinEDA_PcbFrame::ReCreateMenuBar()
     ////////////////
     wxMenu* helpMenu = new wxMenu;
     item = new wxMenuItem( helpMenu, ID_GENERAL_HELP, _( "&Contents" ),
-                           _( "Open the PCBNEW manual" ) );
+                           _( "Open the PCBnew manual" ) );
     item->SetBitmap( help_xpm );
     helpMenu->Append( item );
 
-    item = new wxMenuItem( helpMenu, ID_KICAD_ABOUT, _( "&About PCBNEW" ),
-                           _( "About PCBNEW printed circuit board designer" ) );
+    item = new wxMenuItem( helpMenu, ID_KICAD_ABOUT, _( "&About PCBnew" ),
+                           _( "About PCBnew printed circuit board designer" ) );
     item->SetBitmap( info_xpm );
     helpMenu->Append( item );
 

pcbnew/pcbcfg.cpp → pcbnew/pcbnew_config.cpp

@@ -94,7 +94,7 @@ void WinEDA_PcbFrame::Process_Config( wxCommandEvent& event )
         Read_Config( dlg.GetPath() );
         break;
     }
-    case ID_PREFERENCES_CREATE_CONFIG_HOTKEYS:
+    case ID_PREFERENCES_HOTKEY_CREATE_CONFIG:
         fn.SetPath( ReturnHotkeyConfigFilePath( g_ConfigFileLocationChoice ) );
         fn.SetName( HOTKEY_FILENAME );
         fn.SetExt( DEFAULT_HOTKEY_FILENAME_EXT );
@@ -102,11 +102,11 @@ void WinEDA_PcbFrame::Process_Config( wxCommandEvent& event )
                                true );
         break;
 
-    case ID_PREFERENCES_READ_CONFIG_HOTKEYS:
+    case ID_PREFERENCES_HOTKEY_READ_CONFIG:
         Read_Hotkey_Config( this, true );
         break;
 
-    case ID_PREFERENCES_EDIT_CONFIG_HOTKEYS:
+    case ID_PREFERENCES_HOTKEY_EDIT_CONFIG:
     {
         fn.SetPath( ReturnHotkeyConfigFilePath( g_ConfigFileLocationChoice ) );
         fn.SetName( HOTKEY_FILENAME );

pcbnew/tool_pcb.cpp

@@ -426,12 +426,12 @@ void WinEDA_PcbFrame::ReCreateVToolbar()
     m_VToolBar->AddSeparator();
 
     m_VToolBar->AddTool( ID_PCB_HIGHLIGHT_BUTT, wxEmptyString,
-                         wxBitmap( net_hightlight_xpm ), _( "Net highlight" ),
+                         wxBitmap( net_hightlight_xpm ), _( "Highlight net" ),
                          wxITEM_CHECK );
 
     m_VToolBar->AddTool( ID_PCB_SHOW_1_RATSNEST_BUTT, wxEmptyString,
                          wxBitmap( tool_ratsnet_xpm ),
-                         _( "Display local ratsnest (pad or module)" ),
+                         _( "Display local ratsnest" ),
                          wxITEM_CHECK );
 
     m_VToolBar->AddSeparator();