Class EDA_BASE_FRAME is the base frame for deriving all KiCad main window classes. More...

#include <eda_base_frame.h>

Inheritance diagram for EDA_BASE_FRAME:

Public Member Functions
	EDA_BASE_FRAME (wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aFrameName)

	~EDA_BASE_FRAME ()

bool	ProcessEvent (wxEvent &aEvent) override
	Function ProcessEvent overrides the default process event handler to implement the auto save feature. More...

void	SetAutoSaveInterval (int aInterval)

int	GetAutoSaveInterval () const

bool	IsType (FRAME_T aType) const

void	GetKicadHelp (wxCommandEvent &event)

void	GetKicadContribute (wxCommandEvent &event)

void	GetKicadAbout (wxCommandEvent &event)

void	PrintMsg (const wxString &text)

virtual void	LoadSettings (wxConfigBase *aCfg)
	Function LoadSettings loads common frame parameters from a configuration file. More...

virtual void	SaveSettings (wxConfigBase *aCfg)
	Function SaveSettings saves common frame parameters to a configuration data file. More...

wxString	ConfigBaseName ()
	Function ConfigBaseName. More...

virtual void	SaveProjectSettings (bool aAskForSave)
	Function SaveProjectSettings saves changes to the project settings to the project (.pro) file. More...

virtual void	OnSelectPreferredEditor (wxCommandEvent &event)
	Function OnSelectPreferredEditor Open a dialog to select the editor that will used in KiCad to edit or display files (reports ... More...

virtual int	WriteHotkeyConfig (struct EDA_HOTKEY_CONFIG aDescList, wxString aFullFileName=NULL)
	Function WriteHotkeyConfig Store the current hotkey list It is stored using the standard wxConfig mechanism or a file. More...

void	ImportHotkeyConfigFromFile (EDA_HOTKEY_CONFIG *aDescList, const wxString &aDefaultShortname)
	Function ImportHotkeyConfigFromFile Prompt the user for an old hotkey file to read, and read it. More...

void	ExportHotkeyConfigToFile (EDA_HOTKEY_CONFIG *aDescList, const wxString &aDefaultShortname)
	Function ExportHotkeyConfigToFile Prompt the user for an old hotkey file to read, and read it. More...

wxString	GetFileFromHistory (int cmdId, const wxString &type, wxFileHistory *aFileHistory=NULL)
	Function GetFileFromHistory fetches the file name from the file history list. More...

void	UpdateFileHistory (const wxString &FullFileName, wxFileHistory *aFileHistory=NULL)
	Function UpdateFileHistory Updates the list of recently opened files. More...

void	SetMruPath (const wxString &aPath)

wxString	GetMruPath () const

virtual void	ReCreateMenuBar ()
	Function ReCreateMenuBar Creates recreates the menu bar. More...

bool	IsWritable (const wxFileName &aFileName)
	Function IsWritable checks if aFileName can be written. More...

void	CheckForAutoSaveFile (const wxFileName &aFileName, const wxString &aBackupFileExtension)
	Function CheckForAutoSaveFile checks if an auto save file exists for aFileName and takes the appropriate action depending on the user input. More...

virtual void	ShowChangedLanguage ()
	Function ShowChangedLanguage redraws the menus and what not in current language. More...

virtual void	OnChangeIconsOptions (wxCommandEvent &event)
	Function OnChangeIconsOptions Selects the current icons options in menus (or toolbars) in Kicad (the default for toolbars/menus is 26x26 pixels, and shows icons in menus). More...

virtual void	ShowChangedIcons ()
	Function ShowChangedIcons redraws items menus after a icon was changed option. More...

void	AddMenuIconsOptions (wxMenu *MasterMenu)
	Function AddMenuIconsOptions creates a menu list for icons in menu and icon sizes choice, and add it as submenu to MasterMenu. More...

bool	PostCommandMenuEvent (int evt_type)
	Function PostCommandMenuEvent. More...

virtual int	GetIconScale ()
	Function GetIconScale. More...

virtual void	SetIconScale (int aScale)
	Function SetIconScale. More...

Protected Member Functions
void	onAutoSaveTimer (wxTimerEvent &aEvent)
	Function onAutoSaveTimer handles the auto save timer event. More...

virtual bool	isAutoSaveRequired () const
	Function autoSaveRequired returns the auto save status of the application. More...

virtual bool	doAutoSave ()
	Function doAutoSave should be overridden by the derived class to handle the auto save feature. More...

virtual wxConfigBase *	config ()
	Function config returns the wxConfigBase used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME. More...

virtual const SEARCH_STACK &	sys_search ()
	Function sys_search returns a SEARCH_STACK pertaining to entire program, and is overloaded in KICAD_MANAGER_FRAME. More...

virtual wxString	help_name ()

Protected Attributes
FRAME_T	m_Ident
	Id Type (pcb, schematic, library..) More...

wxPoint	m_FramePos

wxSize	m_FrameSize

wxString	m_configFrameName
	prefix used in config to identify some params (frame size...) if empty, the frame name defined in CTOR is used More...

wxAuiToolBar *	m_mainToolBar
	Standard horizontal Toolbar. More...

wxString	m_AboutTitle
	Name of program displayed in About. More...

wxAuiManager	m_auimgr

bool	m_hasAutoSave
	Flag to indicate if this frame supports auto save. More...

bool	m_autoSaveState
	Flag to indicate the last auto save state. More...

int	m_autoSaveInterval
	The auto save interval time in seconds. More...

wxTimer *	m_autoSaveTimer
	The timer used to implement the auto save feature;. More...

wxString	m_perspective
	wxAuiManager perspective. More...

wxString	m_mruPath
	Most recently used path. More...

Static Protected Attributes
static constexpr int	KICAD_AUI_TB_STYLE = wxAUI_TB_DEFAULT_STYLE \| wxAUI_TB_PLAIN_BACKGROUND
	Default style flags used for wxAUI toolbars More...

Private Member Functions
void	windowClosing (wxCloseEvent &event)
	Function windowClosing (with its unexpected name so it does not collide with the real OnWindowClose() function provided in derived classes) is called just before a window closing, and is used to call a derivation specific SaveSettings(). More...

wxWindow *	findQuasiModalDialog ()

void	removePaneBorder (wxShowEvent &event)
	Removes border from wxAui panes. More...

Detailed Description

Class EDA_BASE_FRAME is the base frame for deriving all KiCad main window classes.

This class is not intended to be used directly. It provides support for automatic calls to a SaveSettings() function. SaveSettings() for a derived class can choose to do nothing, or rely on basic SaveSettings() support in this base class to do most of the work by calling it from the derived class's SaveSettings().

This class is not a KIWAY_PLAYER because KICAD_MANAGER_FRAME is derived from it and that class is not a player.

Definition at line 109 of file eda_base_frame.h.

Constructor & Destructor Documentation

EDA_BASE_FRAME::EDA_BASE_FRAME	(	wxWindow *	aParent,
		FRAME_T	aFrameType,
		const wxString &	aTitle,
		const wxPoint &	aPos,
		const wxSize &	aSize,
		long	aStyle,
		const wxString &	aFrameName
	)

Definition at line 73 of file eda_base_frame.cpp.

References ID_AUTO_SAVE_TIMER, m_autoSaveInterval, m_autoSaveState, m_autoSaveTimer, m_FrameSize, m_hasAutoSave, m_Ident, m_mainToolBar, m_mruPath, onAutoSaveTimer(), removePaneBorder(), and windowClosing().

Referenced by isAutoSaveRequired().

                                                   :
     wxFrame( aParent, wxID_ANY, aTitle, aPos, aSize, aStyle, aFrameName )
 {
     m_Ident = aFrameType;
     m_mainToolBar = NULL;
     m_hasAutoSave = false;
     m_autoSaveState = false;
     m_autoSaveInterval = -1;
     m_autoSaveTimer = new wxTimer( this, ID_AUTO_SAVE_TIMER );
     m_mruPath = wxStandardPaths::Get().GetDocumentsDir();
 
     // Gives a reasonable minimal size to the frame:
     const int minsize_x = 500;
     const int  minsize_y = 400;
     SetSizeHints( minsize_x, minsize_y, -1, -1, -1, -1 );
 
     // Store dimensions of the user area of the main window.
     GetClientSize( &m_FrameSize.x, &m_FrameSize.y );
 
     Connect( ID_AUTO_SAVE_TIMER, wxEVT_TIMER,
              wxTimerEventHandler( EDA_BASE_FRAME::onAutoSaveTimer ) );
 
     // hook wxEVT_CLOSE_WINDOW so we can call SaveSettings().  This function seems
     // to be called before any other hook for wxCloseEvent, which is necessary.
     Connect( wxEVT_CLOSE_WINDOW, wxCloseEventHandler( EDA_BASE_FRAME::windowClosing ) );
 
     // remove border from wxAui panes for all derived classes
     Connect( wxEVT_SHOW, wxShowEventHandler( EDA_BASE_FRAME::removePaneBorder ) );
 }

EDA_BASE_FRAME::~EDA_BASE_FRAME ( )

Definition at line 169 of file eda_base_frame.cpp.

References m_autoSaveTimer.

Referenced by isAutoSaveRequired().

 {
     delete m_autoSaveTimer;
 
     // This is needed for OSX: avoids further OnDraw processing after this
     // destructor and before the native window is destroyed
     this->Freeze();
 }

Member Function Documentation

void EDA_BASE_FRAME::AddMenuIconsOptions ( wxMenu * MasterMenu )

Function AddMenuIconsOptions creates a menu list for icons in menu and icon sizes choice, and add it as submenu to MasterMenu.

Parameters

MasterMenu The main menu. The sub menu list will be accessible from the menu item with id ID_KICAD_SELECT_ICONS_OPTIONS

Definition at line 686 of file eda_base_frame.cpp.

References AddMenuItem(), ID_KICAD_SELECT_ICONS_IN_MENUS, ID_KICAD_SELECT_ICONS_OPTIONS, KiBitmap(), and Pgm().

Referenced by GetMruPath(), preparePreferencesMenu(), PL_EDITOR_FRAME::ReCreateMenuBar(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), and GERBVIEW_FRAME::ReCreateMenuBar().

 {
     wxMenu*      menu = NULL;
     wxMenuItem*  item = MasterMenu->FindItem( ID_KICAD_SELECT_ICONS_OPTIONS );
 
     if( item )     // This menu exists, do nothing
         return;
 
     menu = new wxMenu;
 
     menu->Append( new wxMenuItem( menu, ID_KICAD_SELECT_ICONS_IN_MENUS,
                   _( "Icons in Menus" ), wxEmptyString,
                   wxITEM_CHECK ) );
     menu->Check( ID_KICAD_SELECT_ICONS_IN_MENUS, Pgm().GetUseIconsInMenus() );
 
     AddMenuItem( MasterMenu, menu,
                  ID_KICAD_SELECT_ICONS_OPTIONS,
                  _( "Icons Options" ),
                  _( "Select show icons in menus and icons sizes" ),
                  KiBitmap( icon_xpm ) );
 }

void EDA_BASE_FRAME::CheckForAutoSaveFile	(	const wxFileName &	aFileName,
		const wxString &	aBackupFileExtension
	)

Function CheckForAutoSaveFile checks if an auto save file exists for aFileName and takes the appropriate action depending on the user input.

If an auto save file exists for aFileName, the user is prompted if they wish to replace file aFileName with the auto saved file. If the user chooses to replace the file, the backup file of aFileName is removed, aFileName is renamed to the backup file name, and the auto save file is renamed to aFileName. If user chooses to keep the existing version of aFileName, the auto save file is removed.

Parameters

aFileName	A wxFileName object containing the file name to check.
aBackupFileExtension	A wxString object containing the backup file extension used to create the backup file name.

Definition at line 591 of file eda_base_frame.cpp.

References AUTOSAVE_PREFIX_FILENAME, Format(), GetChars(), Pgm(), and traceAutoSave.

Referenced by GetMruPath(), and PCB_EDIT_FRAME::OpenProjectFiles().

 {
     wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
     wxCHECK_RET( !aBackupFileExtension.IsEmpty(), wxT( "Invalid backup file extension!" ) );
 
     wxFileName autoSaveFileName = aFileName;
 
     // Check for auto save file.
     autoSaveFileName.SetName( AUTOSAVE_PREFIX_FILENAME + aFileName.GetName() );
 
     wxLogTrace( traceAutoSave,
                 wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
 
     if( !autoSaveFileName.FileExists() )
         return;
 
     wxString msg = wxString::Format( _(
             "Well this is potentially embarrassing!\n"
             "It appears that the last time you were editing the file\n"
             "\"%s\"\n"
             "it was not saved properly.  Do you wish to restore the last saved edits you made?" ),
             GetChars( aFileName.GetFullName() )
         );
 
     int response = wxMessageBox( msg, Pgm().App().GetAppName(), wxYES_NO | wxICON_QUESTION, this );
 
     // Make a backup of the current file, delete the file, and rename the auto save file to
     // the file name.
     if( response == wxYES )
     {
         // Get the backup file name.
         wxFileName backupFileName = aFileName;
         backupFileName.SetExt( aBackupFileExtension );
 
         // If an old backup file exists, delete it.  If an old copy of the file exists, rename
         // it to the backup file name
         if( aFileName.FileExists() )
         {
             // Remove the old file backup file.
             if( backupFileName.FileExists() )
                 wxRemoveFile( backupFileName.GetFullPath() );
 
             // Rename the old file to the backup file name.
             if( !wxRenameFile( aFileName.GetFullPath(), backupFileName.GetFullPath() ) )
             {
                 msg.Printf( _( "Could not create backup file \"%s\"" ),
                             GetChars( backupFileName.GetFullPath() ) );
                 wxMessageBox( msg );
             }
         }
 
         if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
         {
             wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
                           Pgm().App().GetAppName(), wxOK | wxICON_EXCLAMATION, this );
         }
     }
     else
     {
         wxLogTrace( traceAutoSave,
                     wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
 
         // Remove the auto save file when using the previous file as is.
         wxRemoveFile( autoSaveFileName.GetFullPath() );
     }
 }

wxConfigBase * EDA_BASE_FRAME::config ( )

protectedvirtual

Function config returns the wxConfigBase used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 374 of file eda_base_frame.cpp.

References Kiface(), and KIFACE_I::KifaceSettings().

Referenced by CVPCB_MAINFRAME::CVPCB_MAINFRAME(), FOOTPRINT_EDIT_FRAME::Export_Module(), GERBVIEW_FRAME::GERBVIEW_FRAME(), FOOTPRINT_EDIT_FRAME::Import_Module(), isAutoSaveRequired(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), SIM_PLOT_FRAME::onClose(), FOOTPRINT_WIZARD_FRAME::OnCloseWindow(), LIB_EDIT_FRAME::OnPreferencesOptions(), SCH_EDIT_FRAME::OnPreferencesOptions(), SCH_EDIT_FRAME::OpenProjectFiles(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), and windowClosing().

 {
     // KICAD_MANAGER_FRAME overrides this
     wxConfigBase* ret = Kiface().KifaceSettings();
     //wxASSERT( ret );
     return ret;
 }

wxString EDA_BASE_FRAME::ConfigBaseName ( )

inline

Function ConfigBaseName.

Returns: a base name prefix used in Load/Save settings to build the full name of keys used in config. This is usually the name of the frame set by CTOR, unless m_configFrameName contains a base name. this is the case of frames which can be shown in normal or modal mode. This is needed because we want only one base name prefix, regardless the mode used.

Definition at line 260 of file eda_base_frame.h.

References m_configFrameName.

Referenced by LoadSettings(), EDA_DRAW_FRAME::LoadSettings(), SaveSettings(), and EDA_DRAW_FRAME::SaveSettings().

     {
         wxString baseCfgName = m_configFrameName.IsEmpty() ? GetName() : m_configFrameName;
         return baseCfgName;
     }

bool EDA_BASE_FRAME::doAutoSave ( )

protectedvirtual

Function doAutoSave should be overridden by the derived class to handle the auto save feature.

Returns: true if the auto save was successful otherwise false.

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 244 of file eda_base_frame.cpp.

Referenced by isAutoSaveRequired(), and onAutoSaveTimer().

 {
     wxCHECK_MSG( false, true, wxT( "Auto save timer function not overridden.  Bad programmer!" ) );
 }

void EDA_BASE_FRAME::ExportHotkeyConfigToFile	(	EDA_HOTKEY_CONFIG *	aDescList,
		const wxString &	aDefaultShortname
	)

Function ExportHotkeyConfigToFile Prompt the user for an old hotkey file to read, and read it.

Parameters

aDescList	= current hotkey list descr. to initialize.
aDefaultShortname	= a default short name (extention not needed) like eechema, kicad...

Definition at line 777 of file hotkeys_basic.cpp.

References DEFAULT_HOTKEY_FILENAME_EXT, EDA_FILE_SELECTOR(), and Prj().

Referenced by KICAD_MANAGER_FRAME::Process_Config(), LIB_EDIT_FRAME::Process_Config(), SCH_EDIT_FRAME::Process_Config(), PL_EDITOR_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Config(), GERBVIEW_FRAME::Process_Config(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), and SaveProjectSettings().

 {
     wxString ext  = DEFAULT_HOTKEY_FILENAME_EXT;
     wxString mask = wxT( "*." ) + ext;
 
 #if 0
     wxString path = wxPathOnly( Prj().GetProjectFullName() );
 #else
     wxString path = GetMruPath();
 #endif
     wxFileName fn( aDefaultShortname );
     fn.SetExt( DEFAULT_HOTKEY_FILENAME_EXT );
 
     wxString filename = EDA_FILE_SELECTOR( _( "Write Hotkey Configuration File:" ),
                                            path,
                                            fn.GetFullPath(),
                                            ext,
                                            mask,
                                            this,
                                            wxFD_SAVE,
                                            true );
 
     if( filename.IsEmpty() )
         return;
 
     WriteHotkeyConfig( aDescList, &filename );
     SetMruPath( wxFileName( filename ).GetPath() );
 }

wxWindow * EDA_BASE_FRAME::findQuasiModalDialog ( )

private

Definition at line 106 of file eda_base_frame.cpp.

References FRAME_SCH, DIALOG_SHIM::IsQuasiModal(), and m_Ident.

Referenced by ProcessEvent(), and windowClosing().

 {
     for( auto& iter : GetChildren() )
     {
         DIALOG_SHIM* dlg = dynamic_cast<DIALOG_SHIM*>( iter );
         if( dlg && dlg->IsQuasiModal() )
             return dlg;
     }
 
     // FIXME: CvPcb is currently implemented on top of KIWAY_PLAYER rather than DIALOG_SHIM,
     // so we have to look for it separately.
     if( m_Ident == FRAME_SCH )
     {
         wxWindow* cvpcb = wxWindow::FindWindowByName( "CvpcbFrame" );
         if( cvpcb )
             return cvpcb;
     }
 
     return nullptr;
 }

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const

inline

Definition at line 219 of file eda_base_frame.h.

References m_autoSaveInterval.

Referenced by DIALOG_GENERALOPTIONS::init(), and SCH_EDIT_FRAME::OnPreferencesOptions().

219 { return m_autoSaveInterval; }

EDA_BASE_FRAME::m_autoSaveInterval

int m_autoSaveInterval

The auto save interval time in seconds.

Definition: eda_base_frame.h:152

wxString EDA_BASE_FRAME::GetFileFromHistory	(	int	cmdId,
		const wxString &	type,
		wxFileHistory *	aFileHistory = `NULL`
	)

Function GetFileFromHistory fetches the file name from the file history list.

and removes the selected file, if this file does not exists Note also the menu is updated, if wxFileHistory::UseMenu was called at init time

Parameters

cmdId	The command ID associated with the aFileHistory object.
type	Please document me!
aFileHistory	The wxFileHistory in use. If null, the main application file history is used

Returns: a wxString containing the selected filename

Definition at line 413 of file eda_base_frame.cpp.

References Format(), GetChars(), KIFACE_I::GetFileHistory(), i, and Kiface().

Referenced by GERBVIEW_FRAME::OnDrlFileHistory(), KICAD_MANAGER_FRAME::OnFileHistory(), PL_EDITOR_FRAME::OnFileHistory(), PCB_EDIT_FRAME::OnFileHistory(), GERBVIEW_FRAME::OnGbrFileHistory(), GERBVIEW_FRAME::OnJobFileHistory(), GERBVIEW_FRAME::OnZipFileHistory(), and SaveProjectSettings().

 {
     wxFileHistory* fileHistory = aFileHistory;
 
     if( !fileHistory )
         fileHistory = &Kiface().GetFileHistory();
 
     int baseId = fileHistory->GetBaseId();
 
     wxASSERT( cmdId >= baseId && cmdId < baseId + (int) fileHistory->GetCount() );
 
     unsigned i = cmdId - baseId;
 
     if( i < fileHistory->GetCount() )
     {
         wxString fn = fileHistory->GetHistoryFile( i );
 
         if( wxFileName::FileExists( fn ) )
             return fn;
         else
         {
             wxString msg = wxString::Format(
                         _( "File \"%s\" was not found." ),
                         GetChars( fn ) );
 
             wxMessageBox( msg );
 
             fileHistory->RemoveFileFromHistory( i );
         }
     }
 
     return wxEmptyString;
 }

virtual int EDA_BASE_FRAME::GetIconScale ( )

inlinevirtual

Function GetIconScale.

Return the desired scaling for toolbar/menubar icons in fourths (e.g. 4 is unity). A negative number indicates autoscale based on font size.

Reimplemented in PCB_EDIT_FRAME, SCH_EDIT_FRAME, GERBVIEW_FRAME, LIB_EDIT_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 437 of file eda_base_frame.h.

Referenced by get_scale_factor().

437 { return -1; }

void EDA_BASE_FRAME::GetKicadAbout ( wxCommandEvent & event )

Definition at line 540 of file eda_base_frame.cpp.

References ShowAboutDialog().

Referenced by add_search_paths(), and IsType().

 {
     void ShowAboutDialog(EDA_BASE_FRAME * aParent); // See AboutDialog_main.cpp
     ShowAboutDialog( this );
 }

void EDA_BASE_FRAME::GetKicadContribute ( wxCommandEvent & event )

Definition at line 527 of file eda_base_frame.cpp.

References URL_GET_INVOLVED.

Referenced by add_search_paths(), and IsType().

 {
     if( !wxLaunchDefaultBrowser( URL_GET_INVOLVED ) )
     {
         wxString msg;
         msg.Printf( _( "Could not launch the default browser.\n"
                        "For information on how to help the KiCad project, visit %s" ),
                     URL_GET_INVOLVED );
         wxMessageBox( msg, _( "Get involved with KiCad" ), wxOK, this );
     }
 }

void EDA_BASE_FRAME::GetKicadHelp ( wxCommandEvent & event )

Definition at line 449 of file eda_base_frame.cpp.

References DIM, Format(), GetAssociatedDocument(), GetChars(), help_name(), SearchHelpFileFullPath(), and sys_search().

Referenced by add_search_paths(), and IsType().

 {
     const SEARCH_STACK& search = sys_search();
 
     /* We have to get document for beginners,
      * or the full specific doc
      * if event id is wxID_INDEX, we want the document for beginners.
      * else the specific doc file (its name is in Kiface().GetHelpFileName())
      * The document for beginners is the same for all KiCad utilities
      */
     if( event.GetId() == wxID_INDEX )
     {
         // List of possible names for Getting Started in KiCad
         const wxChar* names[2] = {
             wxT( "getting_started_in_kicad" ),
             wxT( "Getting_Started_in_KiCad" )
             };
 
         wxString helpFile;
         // Search for "getting_started_in_kicad.html" or "getting_started_in_kicad.pdf"
         // or "Getting_Started_in_KiCad.html" or "Getting_Started_in_KiCad.pdf"
         for( unsigned ii = 0; ii < DIM( names ); ii++ )
         {
             helpFile = SearchHelpFileFullPath( search, names[ii] );
 
             if( !helpFile.IsEmpty() )
                break;
         }
 
         if( !helpFile )
         {
             wxString msg = wxString::Format( _(
                 "Html or pdf help file \n\"%s\"\n or\n\"%s\" could not be found." ), names[0], names[1] );
             wxMessageBox( msg );
         }
         else
         {
             GetAssociatedDocument( this, helpFile );
         }
 
         return;
     }
 
     wxString base_name = help_name();
     wxString helpFile = SearchHelpFileFullPath( search, base_name );
 
     if( !helpFile )
     {
         wxString msg = wxString::Format( _(
             "Help file \"%s\" could not be found." ),
             GetChars( base_name )
             );
         wxMessageBox( msg );
     }
     else
     {
         GetAssociatedDocument( this, helpFile );
     }
 }

wxString EDA_BASE_FRAME::GetMruPath ( ) const

inline

Definition at line 347 of file eda_base_frame.h.

References AddMenuIconsOptions(), CheckForAutoSaveFile(), IsWritable(), m_mruPath, OnChangeIconsOptions(), PostCommandMenuEvent(), ReCreateMenuBar(), ShowChangedIcons(), and ShowChangedLanguage().

Referenced by KICAD_MANAGER_FRAME::OnImportEagleFiles(), KICAD_MANAGER_FRAME::OnLoadProject(), and KICAD_MANAGER_FRAME::OnNewProject().

347 { return m_mruPath; }

EDA_BASE_FRAME::m_mruPath

wxString m_mruPath

Most recently used path.

Definition: eda_base_frame.h:159

wxString EDA_BASE_FRAME::help_name ( )

protectedvirtual

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 389 of file eda_base_frame.cpp.

References KIFACE_I::GetHelpFileName(), and Kiface().

Referenced by GetKicadHelp(), and isAutoSaveRequired().

 {
     return Kiface().GetHelpFileName();
 }

void EDA_BASE_FRAME::ImportHotkeyConfigFromFile	(	EDA_HOTKEY_CONFIG *	aDescList,
		const wxString &	aDefaultShortname
	)

Function ImportHotkeyConfigFromFile Prompt the user for an old hotkey file to read, and read it.

Parameters

aDescList	= current hotkey list descr. to initialize.
aDefaultShortname	= a default short name (extention not needed) like eechema, kicad...

Definition at line 748 of file hotkeys_basic.cpp.

References DEFAULT_HOTKEY_FILENAME_EXT, EDA_FILE_SELECTOR(), and ReadHotkeyConfigFile().

Referenced by KICAD_MANAGER_FRAME::Process_Config(), LIB_EDIT_FRAME::Process_Config(), SCH_EDIT_FRAME::Process_Config(), PL_EDITOR_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Config(), GERBVIEW_FRAME::Process_Config(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), and SaveProjectSettings().

 {
     wxString ext  = DEFAULT_HOTKEY_FILENAME_EXT;
     wxString mask = wxT( "*." ) + ext;
 
 
     wxString path = GetMruPath();
     wxFileName fn( aDefaultShortname );
     fn.SetExt( DEFAULT_HOTKEY_FILENAME_EXT );
 
     wxString  filename = EDA_FILE_SELECTOR( _( "Read Hotkey Configuration File:" ),
                                            path,
                                            fn.GetFullPath(),
                                            ext,
                                            mask,
                                            this,
                                            wxFD_OPEN,
                                            true );
 
     if( filename.IsEmpty() )
         return;
 
     ::ReadHotkeyConfigFile( filename, aDescList, false );
     WriteHotkeyConfig( aDescList );
     SetMruPath( wxFileName( filename ).GetPath() );
 }

virtual bool EDA_BASE_FRAME::isAutoSaveRequired ( ) const

inlineprotectedvirtual

Function autoSaveRequired returns the auto save status of the application.

Override this function if your derived frame supports automatic file saving.

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 175 of file eda_base_frame.h.

References config(), doAutoSave(), EDA_BASE_FRAME(), help_name(), ProcessEvent(), SetAutoSaveInterval(), sys_search(), and ~EDA_BASE_FRAME().

Referenced by ProcessEvent().

175 { return false; }

bool EDA_BASE_FRAME::IsType ( FRAME_T aType ) const

inline

Definition at line 221 of file eda_base_frame.h.

References GetKicadAbout(), GetKicadContribute(), GetKicadHelp(), LoadSettings(), PrintMsg(), and SaveSettings().

Referenced by BOARD_COMMIT::BOARD_COMMIT(), LIB_PIN::drawGraphic(), BOARD_PRINTOUT_CONTROLLER::DrawPage(), DIALOG_EDIT_ONE_FIELD::init(), SELECTION_TOOL::Init(), DIALOG_PAD_PROPERTIES::initValues(), PCB_LAYER_WIDGET::OnRenderEnable(), PCBNEW_CONTROL::PasteItemsFromClipboard(), PCB_BASE_FRAME::PlaceTexteModule(), and PCB_BASE_FRAME::RotateTextModule().

221 { return m_Ident == aType; }

EDA_BASE_FRAME::m_Ident

FRAME_T m_Ident

Id Type (pcb, schematic, library..)

Definition: eda_base_frame.h:132

bool EDA_BASE_FRAME::IsWritable ( const wxFileName & aFileName )

Function IsWritable checks if aFileName can be written.

The function performs a number of tests on aFileName to verify that it can be saved. If aFileName defines a path with no file name, them the path is tested for user write permission. If aFileName defines a file name that does not exist in the path, the path is tested for user write permission. If aFileName defines a file that already exits, the file name is tested for user write permissions.

Note: The file name path must be set or an assertion will be raised on debug builds and return false on release builds.

Parameters

aFileName The full path and/or file name of the file to test.

Returns: False if aFileName cannot be written.

Definition at line 547 of file eda_base_frame.cpp.

References GetChars().

Referenced by SCH_EDIT_FRAME::doAutoSave(), GetMruPath(), SCH_EDIT_FRAME::SaveEEFile(), LIB_EDIT_FRAME::saveLibrary(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), CVPCB_MAINFRAME::SaveProjectFile(), and SCH_EDIT_FRAME::SaveProjectSettings().

 {
     wxString msg;
     wxFileName fn = aFileName;
 
     // Check for absence of a file path with a file name.  Unfortunately KiCad
     // uses paths relative to the current project path without the ./ part which
     // confuses wxFileName. Making the file name path absolute may be less than
     // elegant but it solves the problem.
     if( fn.GetPath().IsEmpty() && fn.HasName() )
         fn.MakeAbsolute();
 
     wxCHECK_MSG( fn.IsOk(), false,
                  wxT( "File name object is invalid.  Bad programmer!" ) );
     wxCHECK_MSG( !fn.GetPath().IsEmpty(), false,
                  wxT( "File name object path <" ) + fn.GetFullPath() +
                  wxT( "> is not set.  Bad programmer!" ) );
 
     if( fn.IsDir() && !fn.IsDirWritable() )
     {
         msg.Printf( _( "You do not have write permissions to folder \"%s\"." ),
                     GetChars( fn.GetPath() ) );
     }
     else if( !fn.FileExists() && !fn.IsDirWritable() )
     {
         msg.Printf( _( "You do not have write permissions to save file \"%s\" to folder \"%s\"." ),
                     GetChars( fn.GetFullName() ), GetChars( fn.GetPath() ) );
     }
     else if( fn.FileExists() && !fn.IsFileWritable() )
     {
         msg.Printf( _( "You do not have write permissions to save file \"%s\"." ),
                     GetChars( fn.GetFullPath() ) );
     }
 
     if( !msg.IsEmpty() )
     {
         wxMessageBox( msg );
         return false;
     }
 
     return true;
 }

void EDA_BASE_FRAME::LoadSettings ( wxConfigBase * aCfg )

virtual

Function LoadSettings loads common frame parameters from a configuration file.

Don't forget to call the base method or your frames won't remember their positions and sizes.

Reimplemented in EDA_DRAW_FRAME, PCB_BASE_FRAME, GERBVIEW_FRAME, PCB_EDIT_FRAME, LIB_EDIT_FRAME, SCH_EDIT_FRAME, KICAD_MANAGER_FRAME, CVPCB_MAINFRAME, PL_EDITOR_FRAME, EDA_3D_VIEWER, FOOTPRINT_WIZARD_FRAME, SIM_PLOT_FRAME, FOOTPRINT_VIEWER_FRAME, LIB_VIEW_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 269 of file eda_base_frame.cpp.

References ConfigBaseName(), DEFAULT_AUTO_SAVE_INTERVAL, entryAutoSaveInterval, entryMaximized, entryMruPath, entryPerspective, entryPosX, entryPosY, entrySizeX, entrySizeY, m_autoSaveInterval, m_FramePos, m_FrameSize, m_hasAutoSave, m_mruPath, m_perspective, wxPoint::x, and wxPoint::y.

Referenced by IsType(), SIM_PLOT_FRAME::LoadSettings(), EDA_3D_VIEWER::LoadSettings(), CVPCB_MAINFRAME::LoadSettings(), KICAD_MANAGER_FRAME::LoadSettings(), and EDA_DRAW_FRAME::LoadSettings().

 {
     int maximized = 0;
 
     wxString baseCfgName = ConfigBaseName();
 
     wxString text = baseCfgName + entryPosX;
     aCfg->Read( text, &m_FramePos.x, m_FramePos.x );
 
     text = baseCfgName + entryPosY;
     aCfg->Read( text, &m_FramePos.y, m_FramePos.y );
 
     text = baseCfgName + entrySizeX;
     aCfg->Read( text, &m_FrameSize.x, m_FrameSize.x );
 
     text = baseCfgName + entrySizeY;
     aCfg->Read( text, &m_FrameSize.y, m_FrameSize.y );
 
     text = baseCfgName + entryMaximized;
     aCfg->Read( text, &maximized, 0 );
 
     if( m_hasAutoSave )
     {
         text = baseCfgName + entryAutoSaveInterval;
         aCfg->Read( text, &m_autoSaveInterval, DEFAULT_AUTO_SAVE_INTERVAL );
     }
 
     // Ensure the window is on a connected display, and is visible.
     // (at least a corner of the frame must be visible on screen)
     // Sometimes, if a window was moved on an auxiliary display, and when this
     // display is no more available, it is not the case.
     wxRect rect( m_FramePos, m_FrameSize );
 
     if( wxDisplay::GetFromPoint( rect.GetTopLeft() ) == wxNOT_FOUND &&
         wxDisplay::GetFromPoint( rect.GetTopRight() ) == wxNOT_FOUND &&
         wxDisplay::GetFromPoint( rect.GetBottomLeft() ) == wxNOT_FOUND &&
         wxDisplay::GetFromPoint( rect.GetBottomRight() ) == wxNOT_FOUND )
     {
         m_FramePos = wxDefaultPosition;
     }
 
     // Ensure Window title bar is visible
 #if defined( __WXMAC__ )
     // for macOSX, the window must be below system (macOSX) toolbar
     // Ypos_min = GetMBarHeight(); seems no more exist in new API (subject to change)
     int Ypos_min = 20;
 #else
     int Ypos_min = 0;
 #endif
     if( m_FramePos.y < Ypos_min )
         m_FramePos.y = Ypos_min;
 
     if( maximized )
         Maximize();
 
     aCfg->Read( baseCfgName + entryPerspective, &m_perspective );
     aCfg->Read( baseCfgName + entryMruPath, &m_mruPath );
 }

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent & aEvent )

protected

Function onAutoSaveTimer handles the auto save timer event.

Definition at line 237 of file eda_base_frame.cpp.

References doAutoSave(), m_autoSaveInterval, and m_autoSaveTimer.

Referenced by EDA_BASE_FRAME().

 {
     if( !doAutoSave() )
         m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
 }

void EDA_BASE_FRAME::OnChangeIconsOptions ( wxCommandEvent & event )

virtual

Function OnChangeIconsOptions Selects the current icons options in menus (or toolbars) in Kicad (the default for toolbars/menus is 26x26 pixels, and shows icons in menus).

Reimplemented in KIWAY_PLAYER, and KICAD_MANAGER_FRAME.

Definition at line 675 of file eda_base_frame.cpp.

References ID_KICAD_SELECT_ICONS_IN_MENUS, Pgm(), ReCreateMenuBar(), and PGM_BASE::SetUseIconsInMenus().

Referenced by GetMruPath(), KICAD_MANAGER_FRAME::OnChangeIconsOptions(), and KIWAY_PLAYER::OnChangeIconsOptions().

 {
     if( event.GetId() == ID_KICAD_SELECT_ICONS_IN_MENUS )
     {
         Pgm().SetUseIconsInMenus( event.IsChecked() );
     }
 
     ReCreateMenuBar();
 }

void EDA_BASE_FRAME::OnSelectPreferredEditor ( wxCommandEvent & event )

virtual

Function OnSelectPreferredEditor Open a dialog to select the editor that will used in KiCad to edit or display files (reports ...

) The full filename editor is saved in configuration (global params)

Definition at line 510 of file eda_base_frame.cpp.

References PGM_BASE::AskUserForPreferredEditor(), PGM_BASE::GetEditorName(), Pgm(), and PGM_BASE::SetEditorName().

Referenced by SaveProjectSettings().

 {
     // Ask for the current editor and instruct GetEditorName() to not show
     // unless we pass false as argument.
     wxString editorname = Pgm().GetEditorName( false );
 
     // Ask the user to select a new editor, but suggest the current one as the default.
     editorname = Pgm().AskUserForPreferredEditor( editorname );
 
     // If we have a new editor name request it to be copied to m_editor_name and saved
     // to the preferences file. If the user cancelled the dialog then the previous
     // value will be retained.
     if( !editorname.IsEmpty() )
         Pgm().SetEditorName( editorname );
 }

bool EDA_BASE_FRAME::PostCommandMenuEvent ( int evt_type )

Function PostCommandMenuEvent.

Post a menu event to the frame, which can be used to trigger actions bound to menu items.

Definition at line 660 of file eda_base_frame.cpp.

Referenced by GetMruPath(), FOOTPRINT_EDIT_FRAME::OnHotKey(), FOOTPRINT_EDIT_FRAME::OnHotkeyDeleteItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyDuplicateItem(), PCB_EDIT_FRAME::OnHotkeyDuplicateOrArrayItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyEditItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyMoveItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyMoveItemExact(), and FOOTPRINT_EDIT_FRAME::OnHotkeyRotateItem().

 {
     if( evt_type != 0 )
     {
         wxCommandEvent evt( wxEVT_COMMAND_MENU_SELECTED );
         evt.SetEventObject( this );
         evt.SetId( evt_type );
         wxPostEvent( this, evt );
         return true;
     }
 
     return false;
 }

void EDA_BASE_FRAME::PrintMsg ( const wxString & text )

Definition at line 395 of file eda_base_frame.cpp.

Referenced by IsType().

 {
     SetStatusText( text );
 }

bool EDA_BASE_FRAME::ProcessEvent ( wxEvent & aEvent )

override

Function ProcessEvent overrides the default process event handler to implement the auto save feature.

Warning: If you override this function in a derived class, make sure you call down to this or the auto save feature will be disabled.

Definition at line 179 of file eda_base_frame.cpp.

References findQuasiModalDialog(), isAutoSaveRequired(), m_autoSaveInterval, m_autoSaveState, m_autoSaveTimer, m_hasAutoSave, and traceAutoSave.

Referenced by isAutoSaveRequired(), STATUS_POPUP::onCharHook(), LIB_VIEW_FRAME::onSelectNextSymbol(), LIB_VIEW_FRAME::onSelectPreviousSymbol(), KIWAY::ProcessEvent(), LIB_VIEW_FRAME::ReCreateListCmp(), GERBVIEW_CONTROL::SwitchUnits(), and PCBNEW_CONTROL::SwitchUnits().

 {
 #ifdef  __WXMAC__
     // Apple in its infinite wisdom will raise a disabled window before even passing
     // us the event, so we have no way to stop it.  Instead, we have to catch an
     // improperly ordered disabled window and quasi-modal dialog here and reorder
     // them.
     if( !IsEnabled() && IsActive() )
     {
         wxWindow* dlg = findQuasiModalDialog();
         if( dlg )
             dlg->Raise();
     }
 #endif
 
     if( !wxFrame::ProcessEvent( aEvent ) )
         return false;
 
     if( IsShown() && m_hasAutoSave && IsActive() &&
         (m_autoSaveState != isAutoSaveRequired()) && (m_autoSaveInterval > 0) )
     {
         if( !m_autoSaveState )
         {
             wxLogTrace( traceAutoSave, wxT( "Starting auto save timer." ) );
             m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
             m_autoSaveState = true;
         }
         else if( m_autoSaveTimer->IsRunning() )
         {
             wxLogTrace( traceAutoSave, wxT( "Stopping auto save timer." ) );
             m_autoSaveTimer->Stop();
             m_autoSaveState = false;
         }
     }
 
     return true;
 }

void EDA_BASE_FRAME::ReCreateMenuBar ( void )

virtual

Function ReCreateMenuBar Creates recreates the menu bar.

Needed when the language is changed

Reimplemented in PCB_EDIT_FRAME, EDA_DRAW_FRAME, SCH_EDIT_FRAME, GERBVIEW_FRAME, PCB_BASE_FRAME, LIB_EDIT_FRAME, KICAD_MANAGER_FRAME, PL_EDITOR_FRAME, FOOTPRINT_EDIT_FRAME, CVPCB_MAINFRAME, FOOTPRINT_VIEWER_FRAME, and LIB_VIEW_FRAME.

Definition at line 250 of file eda_base_frame.cpp.

Referenced by GetMruPath(), InstallHotkeyFrame(), OnChangeIconsOptions(), ShowChangedIcons(), and ShowChangedLanguage().

251 {

252 }

void EDA_BASE_FRAME::removePaneBorder ( wxShowEvent & event )

private

Removes border from wxAui panes.

Definition at line 153 of file eda_base_frame.cpp.

References i, and m_auimgr.

Referenced by EDA_BASE_FRAME().

 {
     // nothing to be set
     if( !m_auimgr.GetManagedWindow() )
         return;
 
     // remove the ugly 1-pixel white border on AUI panes
     wxAuiPaneInfoArray panes = m_auimgr.GetAllPanes();
 
     for( size_t i = 0; i < panes.GetCount(); i++ )
         m_auimgr.GetPane( panes.Item( i ).name ).PaneBorder( false );
 
     m_auimgr.Update();
 }

virtual void EDA_BASE_FRAME::SaveProjectSettings ( bool aAskForSave )

inlinevirtual

Function SaveProjectSettings saves changes to the project settings to the project (.pro) file.

The method is virtual so you can override it to call the suitable save method. The base method do nothing

Parameters

aAskForSave = true to open a dialog before saving the settings

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 274 of file eda_base_frame.h.

References ExportHotkeyConfigToFile(), GetFileFromHistory(), ImportHotkeyConfigFromFile(), OnSelectPreferredEditor(), UpdateFileHistory(), and WriteHotkeyConfig().

Referenced by DIALOG_PAGES_SETTINGS::OnOkClick(), SCH_EDIT_FRAME::OnPreferencesOptions(), and SCH_EDIT_FRAME::Process_Config().

274 {};

void EDA_BASE_FRAME::SaveSettings ( wxConfigBase * aCfg )

virtual

Function SaveSettings saves common frame parameters to a configuration data file.

Don't forget to call the base class's SaveSettings() from your derived SaveSettings() otherwise the frames won't remember their positions and sizes.

Reimplemented in EDA_DRAW_FRAME, PCB_BASE_FRAME, GERBVIEW_FRAME, PCB_EDIT_FRAME, LIB_EDIT_FRAME, SCH_EDIT_FRAME, KICAD_MANAGER_FRAME, CVPCB_MAINFRAME, PL_EDITOR_FRAME, EDA_3D_VIEWER, FOOTPRINT_WIZARD_FRAME, SIM_PLOT_FRAME, FOOTPRINT_VIEWER_FRAME, LIB_VIEW_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 329 of file eda_base_frame.cpp.

References ConfigBaseName(), entryAutoSaveInterval, entryMruPath, entryPerspective, m_auimgr, m_autoSaveInterval, m_FramePos, m_FrameSize, m_hasAutoSave, m_mruPath, wxPoint::x, and wxPoint::y.

Referenced by IsType(), SIM_PLOT_FRAME::SaveSettings(), EDA_3D_VIEWER::SaveSettings(), CVPCB_MAINFRAME::SaveSettings(), KICAD_MANAGER_FRAME::SaveSettings(), EDA_DRAW_FRAME::SaveSettings(), and windowClosing().

 {
     wxString        text;
 
     if( IsIconized() )
         return;
 
     wxString baseCfgName = ConfigBaseName();
 
     m_FrameSize = GetSize();
     m_FramePos  = GetPosition();
 
     text = baseCfgName + wxT( "Pos_x" );
     aCfg->Write( text, (long) m_FramePos.x );
 
     text = baseCfgName + wxT( "Pos_y" );
     aCfg->Write( text, (long) m_FramePos.y );
 
     text = baseCfgName + wxT( "Size_x" );
     aCfg->Write( text, (long) m_FrameSize.x );
 
     text = baseCfgName + wxT( "Size_y" );
     aCfg->Write( text, (long) m_FrameSize.y );
 
     text = baseCfgName + wxT( "Maximized" );
     aCfg->Write( text, IsMaximized() );
 
     if( m_hasAutoSave )
     {
         text = baseCfgName + entryAutoSaveInterval;
         aCfg->Write( text, m_autoSaveInterval );
     }
 
     // Once this is fully implemented, wxAuiManager will be used to maintain
     // the persistance of the main frame and all it's managed windows and
     // all of the legacy frame persistence position code can be removed.
     wxString perspective = m_auimgr.SavePerspective();
 
     // printf( "perspective(%s): %s\n",
     //    TO_UTF8( m_FrameName + entryPerspective ), TO_UTF8( perspective ) );
     aCfg->Write( baseCfgName + entryPerspective, perspective );
     aCfg->Write( baseCfgName + entryMruPath, m_mruPath );
 }

void EDA_BASE_FRAME::SetAutoSaveInterval ( int aInterval )

Definition at line 218 of file eda_base_frame.cpp.

References m_autoSaveInterval, m_autoSaveState, and m_autoSaveTimer.

Referenced by isAutoSaveRequired(), DIALOG_GENERALOPTIONS::OnOkClick(), and SCH_EDIT_FRAME::OnPreferencesOptions().

 {
     m_autoSaveInterval = aInterval;
 
     if( m_autoSaveTimer->IsRunning() )
     {
         if( m_autoSaveInterval > 0 )
         {
             m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
         }
         else
         {
             m_autoSaveTimer->Stop();
             m_autoSaveState = false;
         }
     }
 }

virtual void EDA_BASE_FRAME::SetIconScale ( int aScale )

inlinevirtual

Function SetIconScale.

Modify the scale of icons in the window; should refresh them and save the setting.

Reimplemented in PCB_EDIT_FRAME, SCH_EDIT_FRAME, GERBVIEW_FRAME, and LIB_EDIT_FRAME.

Definition at line 444 of file eda_base_frame.h.

444 {}

void EDA_BASE_FRAME::SetMruPath ( const wxString & aPath )

inline

Definition at line 345 of file eda_base_frame.h.

Referenced by KICAD_MANAGER_FRAME::LoadProject().

345 { m_mruPath = aPath; }

EDA_BASE_FRAME::m_mruPath

wxString m_mruPath

Most recently used path.

Definition: eda_base_frame.h:159

void EDA_BASE_FRAME::ShowChangedIcons ( )

virtual

Function ShowChangedIcons redraws items menus after a icon was changed option.

Definition at line 262 of file eda_base_frame.cpp.

References ReCreateMenuBar().

Referenced by GetMruPath(), and KIWAY::ShowChangedIcons().

 {
     ReCreateMenuBar();
     GetMenuBar()->Refresh();
 }

void EDA_BASE_FRAME::ShowChangedLanguage ( )

virtual

Function ShowChangedLanguage redraws the menus and what not in current language.

Reimplemented in PCB_EDIT_FRAME, GERBVIEW_FRAME, PCB_BASE_FRAME, and CVPCB_MAINFRAME.

Definition at line 255 of file eda_base_frame.cpp.

References ReCreateMenuBar().

Referenced by GetMruPath(), KIWAY::SetLanguage(), CVPCB_MAINFRAME::ShowChangedLanguage(), PCB_BASE_FRAME::ShowChangedLanguage(), and GERBVIEW_FRAME::ShowChangedLanguage().

 {
     ReCreateMenuBar();
     GetMenuBar()->Refresh();
 }

const SEARCH_STACK & EDA_BASE_FRAME::sys_search ( )

protectedvirtual

Function sys_search returns a SEARCH_STACK pertaining to entire program, and is overloaded in KICAD_MANAGER_FRAME.

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 383 of file eda_base_frame.cpp.

References Kiface(), and KIFACE_I::KifaceSearch().

Referenced by GetKicadHelp(), and isAutoSaveRequired().

 {
     return Kiface().KifaceSearch();
 }

void EDA_BASE_FRAME::UpdateFileHistory	(	const wxString &	FullFileName,
		wxFileHistory *	aFileHistory = `NULL`
	)

Function UpdateFileHistory Updates the list of recently opened files.

Note also the menu is updated, if wxFileHistory::UseMenu was called at init time

Parameters

FullFileName	The full file name including the path.
aFileHistory	The wxFileHistory in use. If NULL, the main application file history is used.

Definition at line 401 of file eda_base_frame.cpp.

References KIFACE_I::GetFileHistory(), and Kiface().

Referenced by SCH_EDIT_FRAME::importFile(), GERBVIEW_FRAME::LoadExcellonFiles(), GERBVIEW_FRAME::loadListOfGerberFiles(), PL_EDITOR_FRAME::LoadPageLayoutDescrFile(), KICAD_MANAGER_FRAME::LoadProject(), KICAD_MANAGER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::SavePcbFile(), SaveProjectSettings(), and GERBVIEW_FRAME::unarchiveFiles().

 {
     wxFileHistory* fileHistory = aFileHistory;
 
     if( !fileHistory )
         fileHistory = &Kiface().GetFileHistory();
 
     fileHistory->AddFileToHistory( FullFileName );
 }

void EDA_BASE_FRAME::windowClosing ( wxCloseEvent & event )

private

Function windowClosing (with its unexpected name so it does not collide with the real OnWindowClose() function provided in derived classes) is called just before a window closing, and is used to call a derivation specific SaveSettings().

SaveSettings() is called for all derived wxFrames in this base class overload. (Calling it from a destructor is deprecated since the wxFrame's position is not available in the destructor on linux.) In other words, you should not need to call SaveSettings() anywhere, except in this one function found only in this class.

Definition at line 128 of file eda_base_frame.cpp.

References config(), findQuasiModalDialog(), and SaveSettings().

Referenced by EDA_BASE_FRAME().

 {
     // Don't allow closing when a quasi-modal is open.
     wxWindow* quasiModal = findQuasiModalDialog();
 
     if( quasiModal )
     {
         // Raise and notify; don't give the user a warning regarding "quasi-modal dialogs"
         // when they have no idea what those are.
         quasiModal->Raise();
         wxBell();
 
         event.Veto();
         return;
     }
 
     wxConfigBase* cfg = config();
 
     if( cfg )
         SaveSettings( cfg );       // virtual, wxFrame specific
 
     event.Skip();       // we did not "handle" the event, only eavesdropped on it.
 }

int EDA_BASE_FRAME::WriteHotkeyConfig	(	struct EDA_HOTKEY_CONFIG *	aDescList,
		wxString *	aFullFileName = `NULL`
	)

virtual

Function WriteHotkeyConfig Store the current hotkey list It is stored using the standard wxConfig mechanism or a file.

Parameters

aDescList	= pointer to the current hotkey list.
aFullFileName	= a wxString pointer to a full file name. if NULL, use the standard wxConfig mechanism (default) the output format is: shortcut "key" "function" lines starting with # are comments

Reimplemented in EDA_DRAW_FRAME.

Definition at line 529 of file hotkeys_basic.cpp.

References AddDelimiterString(), DEFAULT_HOTKEY_FILENAME_EXT, EESCHEMA_HOTKEY_NAME, FOOTPRINT_EDIT_FRAME_NAME, GetChars(), GetKicadConfigPath(), KeyNameFromKeyCode(), LIB_EDIT_FRAME_NAME, EDA_HOTKEY_CONFIG::m_HK_InfoList, EDA_HOTKEY::m_InfoMsg, EDA_HOTKEY::m_KeyCode, EDA_HOTKEY_CONFIG::m_SectionTag, EDA_HOTKEY_CONFIG::m_Title, PCB_EDIT_FRAME_NAME, PCBNEW_HOTKEY_NAME, and SCH_EDIT_FRAME_NAME.

Referenced by SaveProjectSettings(), HOTKEYS_EDITOR_DIALOG::TransferDataFromWindow(), and EDA_DRAW_FRAME::WriteHotkeyConfig().

 {
     wxString msg;
     wxString keyname, infokey;
     FILE* file;
 
     msg = wxT( "$hotkey list\n" );
 
     // Print the current hotkey list
     EDA_HOTKEY** list;
 
     for( ; aDescList->m_HK_InfoList != nullptr; aDescList++ )
     {
         if( aDescList->m_Title )
         {
             msg += wxT( "# " );
             msg += *aDescList->m_Title;
             msg += wxT( "\n" );
         }
 
         msg += *aDescList->m_SectionTag;
         msg += wxT( "\n" );
 
         list = aDescList->m_HK_InfoList;
 
         for( ; *list != nullptr; list++ )
         {
             EDA_HOTKEY* hk_decr = *list;
             msg    += wxT( "shortcut   " );
             keyname = KeyNameFromKeyCode( hk_decr->m_KeyCode );
             AddDelimiterString( keyname );
             infokey = hk_decr->m_InfoMsg;
             AddDelimiterString( infokey );
             msg += keyname + wxT( ":    " ) + infokey + wxT( "\n" );
         }
     }
 
     msg += wxT( "$Endlist\n" );
 
     if( aFullFileName )
         file = wxFopen( *aFullFileName, wxT( "wt" ) );
     else
     {
         wxString configName( ConfigBaseName() );
         if( configName == SCH_EDIT_FRAME_NAME  || configName == LIB_EDIT_FRAME_NAME )
             configName = EESCHEMA_HOTKEY_NAME;
         else if( configName == PCB_EDIT_FRAME_NAME  ||
                 configName == FOOTPRINT_EDIT_FRAME_NAME )
             configName = PCBNEW_HOTKEY_NAME;
 
         wxFileName fn( configName );
         fn.SetExt( DEFAULT_HOTKEY_FILENAME_EXT );
         fn.SetPath( GetKicadConfigPath() );
         file = wxFopen( fn.GetFullPath(), wxT( "wt" ) );
     }
 
     if( file )
     {
         wxFputs( msg, file );
         fclose( file );
     }
     else
     {
         msg.Printf( wxT( "Unable to write file %s" ), GetChars( *aFullFileName ) );
         return 0;
     }
 
     return 1;
 }

Member Data Documentation

constexpr int EDA_BASE_FRAME::KICAD_AUI_TB_STYLE = wxAUI_TB_DEFAULT_STYLE | wxAUI_TB_PLAIN_BACKGROUND

staticprotected

Default style flags used for wxAUI toolbars

Definition at line 162 of file eda_base_frame.h.

Referenced by FOOTPRINT_EDIT_FRAME::ReCreateAuxiliaryToolbar(), GERBVIEW_FRAME::ReCreateAuxiliaryToolbar(), PCB_EDIT_FRAME::ReCreateAuxiliaryToolbar(), KICAD_MANAGER_FRAME::RecreateBaseHToolbar(), DISPLAY_FOOTPRINTS_FRAME::ReCreateHToolbar(), LIB_VIEW_FRAME::ReCreateHToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateHToolbar(), PL_EDITOR_FRAME::ReCreateHToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateHToolbar(), CVPCB_MAINFRAME::ReCreateHToolbar(), FOOTPRINT_WIZARD_FRAME::ReCreateHToolbar(), GERBVIEW_FRAME::ReCreateHToolbar(), SCH_EDIT_FRAME::ReCreateHToolbar(), LIB_EDIT_FRAME::ReCreateHToolbar(), PCB_EDIT_FRAME::ReCreateHToolbar(), EDA_3D_VIEWER::ReCreateMainToolbar(), PCB_EDIT_FRAME::ReCreateMicrowaveVToolbar(), DISPLAY_FOOTPRINTS_FRAME::ReCreateOptToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateOptToolbar(), GERBVIEW_FRAME::ReCreateOptToolbar(), SCH_EDIT_FRAME::ReCreateOptToolbar(), LIB_EDIT_FRAME::ReCreateOptToolbar(), PCB_EDIT_FRAME::ReCreateOptToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateVToolbar(), PL_EDITOR_FRAME::ReCreateVToolbar(), GERBVIEW_FRAME::ReCreateVToolbar(), SCH_EDIT_FRAME::ReCreateVToolbar(), LIB_EDIT_FRAME::ReCreateVToolbar(), and PCB_EDIT_FRAME::ReCreateVToolbar().

wxString EDA_BASE_FRAME::m_AboutTitle

protected

Name of program displayed in About.

Definition at line 141 of file eda_base_frame.h.

wxAuiManager EDA_BASE_FRAME::m_auimgr

protected

Definition at line 143 of file eda_base_frame.h.

Referenced by CVPCB_MAINFRAME::CVPCB_MAINFRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), LIB_EDIT_FRAME::IsSearchTreeShown(), KICAD_MANAGER_FRAME::KICAD_MANAGER_FRAME(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), PCB_EDIT_FRAME::OnSelectOptionToolbar(), LIB_VIEW_FRAME::OnSize(), FOOTPRINT_WIZARD_FRAME::OnSize(), FOOTPRINT_VIEWER_FRAME::OnSize(), KICAD_MANAGER_FRAME::OnSize(), LIB_EDIT_FRAME::OnToggleSearchTree(), GERBVIEW_FRAME::OnToggleShowLayerManager(), PCB_EDIT_FRAME::OnUpdateShowLayerManager(), PCB_EDIT_FRAME::OnUpdateShowMicrowaveToolbar(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), PCB_EDIT_FRAME::ReCreateAuxiliaryToolbar(), PCB_EDIT_FRAME::ReCreateLayerBox(), GERBVIEW_FRAME::ReFillLayerWidget(), CVPCB_MAINFRAME::refreshAfterComponentSearch(), removePaneBorder(), FOOTPRINT_WIZARD_FRAME::SaveSettings(), SaveSettings(), GERBVIEW_FRAME::ShowChangedLanguage(), GERBVIEW_FRAME::updateDCodeSelectBox(), GERBVIEW_FRAME::UpdateTitleAndInfo(), EDA_DRAW_FRAME::UseGalCanvas(), CVPCB_MAINFRAME::~CVPCB_MAINFRAME(), EDA_3D_VIEWER::~EDA_3D_VIEWER(), EDA_DRAW_FRAME::~EDA_DRAW_FRAME(), and KICAD_MANAGER_FRAME::~KICAD_MANAGER_FRAME().

int EDA_BASE_FRAME::m_autoSaveInterval

protected

The auto save interval time in seconds.

Definition at line 152 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME(), GetAutoSaveInterval(), LoadSettings(), onAutoSaveTimer(), ProcessEvent(), SaveSettings(), and SetAutoSaveInterval().

bool EDA_BASE_FRAME::m_autoSaveState

protected

Flag to indicate the last auto save state.

Definition at line 149 of file eda_base_frame.h.

Referenced by SCH_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::doAutoSave(), EDA_BASE_FRAME(), ProcessEvent(), and SetAutoSaveInterval().

wxTimer* EDA_BASE_FRAME::m_autoSaveTimer

protected

The timer used to implement the auto save feature;.

Definition at line 155 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME(), onAutoSaveTimer(), ProcessEvent(), SetAutoSaveInterval(), and ~EDA_BASE_FRAME().

wxString EDA_BASE_FRAME::m_configFrameName

protected

prefix used in config to identify some params (frame size...) if empty, the frame name defined in CTOR is used

Definition at line 136 of file eda_base_frame.h.

Referenced by ConfigBaseName(), and LIB_VIEW_FRAME::LIB_VIEW_FRAME().

wxPoint EDA_BASE_FRAME::m_FramePos

protected

Definition at line 133 of file eda_base_frame.h.

Referenced by CVPCB_MAINFRAME::CVPCB_MAINFRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), KICAD_MANAGER_FRAME::KICAD_MANAGER_FRAME(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), SIM_PLOT_FRAME::LoadSettings(), LoadSettings(), KICAD_MANAGER_FRAME::OnCloseWindow(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), and SaveSettings().

wxSize EDA_BASE_FRAME::m_FrameSize

protected

Definition at line 134 of file eda_base_frame.h.

Referenced by CVPCB_MAINFRAME::CVPCB_MAINFRAME(), EDA_BASE_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), KICAD_MANAGER_FRAME::KICAD_MANAGER_FRAME(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), LIB_VIEW_FRAME::LoadSettings(), SIM_PLOT_FRAME::LoadSettings(), CVPCB_MAINFRAME::LoadSettings(), LoadSettings(), KICAD_MANAGER_FRAME::OnCloseWindow(), EDA_DRAW_FRAME::OnSize(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), and SaveSettings().

bool EDA_BASE_FRAME::m_hasAutoSave

protected

Flag to indicate if this frame supports auto save.

Definition at line 146 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME(), LoadSettings(), ProcessEvent(), and SaveSettings().

FRAME_T EDA_BASE_FRAME::m_Ident

protected

Id Type (pcb, schematic, library..)

Definition at line 132 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME(), and findQuasiModalDialog().

wxAuiToolBar* EDA_BASE_FRAME::m_mainToolBar

protected

Standard horizontal Toolbar.

Definition at line 139 of file eda_base_frame.h.

wxString EDA_BASE_FRAME::m_mruPath

protected

Most recently used path.

Definition at line 159 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME(), FOOTPRINT_EDIT_FRAME::Export_Module(), GetMruPath(), FOOTPRINT_EDIT_FRAME::Import_Module(), GERBVIEW_FRAME::LoadExcellonFiles(), GERBVIEW_FRAME::LoadGerberFiles(), LoadSettings(), GERBVIEW_FRAME::LoadZipArchiveFile(), LIB_EDIT_FRAME::OnExportPart(), LIB_EDIT_FRAME::OnImportPart(), GERBVIEW_FRAME::OpenProjectFiles(), and SaveSettings().

wxString EDA_BASE_FRAME::m_perspective

protected

wxAuiManager perspective.

Definition at line 157 of file eda_base_frame.h.

Referenced by LoadSettings().

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation