The base frame for deriving all KiCad main window classes. More...

#include <eda_base_frame.h>

Inheritance diagram for EDA_BASE_FRAME:

Public Types
enum	UNDO_REDO_LIST { UNDO_LIST, REDO_LIST }
	Function ClearUndoORRedoList (virtual). More...

enum	HOLDER_TYPE { DIALOG, FRAME, PANEL }

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, KIWAY aKiway)

	~EDA_BASE_FRAME ()

EDA_UNITS	GetUserUnits () const
	Return the user units currently in use. More...

void	SetUserUnits (EDA_UNITS aUnits)

void	ChangeUserUnits (EDA_UNITS aUnits)

virtual void	ToggleUserUnits ()

SETTINGS_MANAGER *	GetSettingsManager () const

virtual int	GetSeverity (int aErrorCode) const

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

virtual void	OnCharHook (wxKeyEvent &event)
	Capture the key event before it is sent to the GUI. More...

void	OnMenuEvent (wxMenuEvent &event)
	The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves. More...

virtual void	RegisterUIUpdateHandler (int aID, const ACTION_CONDITIONS &aConditions) override
	Register a UI update handler for the control with ID `aID`. More...

virtual void	UnregisterUIUpdateHandler (int aID) override
	Unregister a UI handler for a given ID that was registered using `RegisterUIUpdateHandler`. More...

virtual void	OnMove (wxMoveEvent &aEvent)

void	OnMaximize (wxMaximizeEvent &aEvent)

void	SetAutoSaveInterval (int aInterval)

int	GetAutoSaveInterval () const

bool	IsType (FRAME_T aType) const

virtual const SEARCH_STACK &	sys_search ()
	Return a SEARCH_STACK pertaining to entire program. More...

virtual wxString	help_name ()

void	OnKicadAbout (wxCommandEvent &event)

void	OnPreferences (wxCommandEvent &event)

void	PrintMsg (const wxString &text)

WX_INFOBAR *	GetInfoBar ()

void	ShowInfoBarError (const wxString &aErrorMsg)

void	ShowInfoBarWarning (const wxString &aWarningMsg)

void	ShowInfoBarMsg (const wxString &aMsg)

virtual APP_SETTINGS_BASE *	config () const
	Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME. More...

virtual void	InstallPreferences (PAGED_DIALOG , PANEL_HOTKEYS_EDITOR )
	Function InstallPreferences Allow a frame to load its preference panels (if any) into the preferences dialog. More...

void	LoadWindowState (const wxString &aFileName)

void	LoadWindowSettings (const WINDOW_SETTINGS *aCfg)
	Loads window settings from the given settings object Normally called by LoadSettings unless the window in question is a child window that stores its settings somewhere other than APP_SETTINGS_BASE::m_Window. More...

void	SaveWindowSettings (WINDOW_SETTINGS *aCfg)
	Saves window settings to the given settings object Normally called by SaveSettings unless the window in question is a child window that stores its settings somewhere other than APP_SETTINGS_BASE::m_Window. More...

virtual void	LoadSettings (APP_SETTINGS_BASE *aCfg)
	Load common frame parameters from a configuration file. More...

virtual void	SaveSettings (APP_SETTINGS_BASE *aCfg)
	Saves common frame parameters to a configuration data file. More...

virtual WINDOW_SETTINGS *	GetWindowSettings (APP_SETTINGS_BASE *aCfg)
	Returns a pointer to the window settings for this frame. More...

virtual void	LoadWindowState (const WINDOW_STATE &aState)
	Load frame state info from a configuration file. More...

wxString	ConfigBaseName () override

virtual void	SaveProjectSettings ()
	Save changes to the project settings to the project (.pro) file. More...

void	ImportHotkeyConfigFromFile (std::map< std::string, TOOL_ACTION * > aActionMap, const wxString &aDefaultShortname)
	Prompt the user for a hotkey file to read, and read it. More...

wxString	GetFileFromHistory (int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr)
	Fetches the file name from the file history list. More...

void	ClearFileHistory (FILE_HISTORY *aFileHistory=nullptr)
	Removes all files from the file history. More...

void	UpdateFileHistory (const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
	Update the list of recently opened files. More...

FILE_HISTORY &	GetFileHistory ()
	Get the frame's main file history. More...

void	SetMruPath (const wxString &aPath)

wxString	GetMruPath () const

virtual wxString	GetCurrentFileName () const
	Get the full filename + path of the currently opened file in the frame. More...

virtual void	ReCreateMenuBar ()
	Recreates the menu bar. More...

void	AddStandardHelpMenu (wxMenuBar *aMenuBar)
	Adds the standard KiCad help menu to the menubar. More...

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

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

virtual void	UpdateStatusBar ()
	Update the status bar information. More...

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

void	CommonSettingsChanged (bool aEnvVarsChanged, bool aTextVarsChanged) override
	Notification event that some of the common (suite-wide) settings have changed. More...

virtual void	ProjectChanged ()
	Notification event that the project has changed. More...

const wxString &	GetAboutTitle () const

virtual bool	IsContentModified ()
	Get if the contents of the frame have been modified since the last save. More...

wxSize	GetWindowSize ()
	Get the undecorated window size that can be used for restoring the window size. More...

virtual void	ClearUndoORRedoList (UNDO_REDO_LIST aList, int aItemCount=-1)

virtual void	ClearUndoRedoList ()
	Function ClearUndoRedoList clear undo and redo list, using ClearUndoORRedoList() picked items are deleted by ClearUndoORRedoList() according to their status. More...

virtual void	PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
	Function PushCommandToUndoList add a command to undo in undo list delete the very old commands when the max count of undo commands is reached ( using ClearUndoORRedoList) More...

virtual void	PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
	Function PushCommandToRedoList add a command to redo in redo list delete the very old commands when the max count of redo commands is reached ( using ClearUndoORRedoList) More...

virtual PICKED_ITEMS_LIST *	PopCommandFromUndoList ()
	PopCommandFromUndoList return the last command to undo and remove it from list nothing is deleted. More...

virtual PICKED_ITEMS_LIST *	PopCommandFromRedoList ()
	PopCommandFromRedoList return the last command to undo and remove it from list nothing is deleted. More...

virtual int	GetUndoCommandCount () const

virtual int	GetRedoCommandCount () const

int	GetMaxUndoItems () const

bool	NonUserClose (bool aForce)

TOOL_MANAGER *	GetToolManager () const
	Return the MVC controller. More...

virtual void	RegisterUIUpdateHandler (const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
	Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls. More...

virtual void	UnregisterUIUpdateHandler (const TOOL_ACTION &aAction)
	Unregister a UI handler for an action that was registered using `RegisterUIUpdateHandler`. More...

virtual SELECTION &	GetCurrentSelection ()
	Get the current selection from the canvas area. More...

virtual void	PushTool (const std::string &actionName)
	NB: the definition of "tool" is different at the user level. More...

virtual void	PopTool (const std::string &actionName)

bool	ToolStackIsEmpty ()

std::string	CurrentToolName () const

bool	IsCurrentTool (const TOOL_ACTION &aAction) const

virtual void	DisplayToolMsg (const wxString &msg)

bool	GetDoImmediateActions () const
	Indicates that hotkeys should perform an immediate action even if another tool is currently active. More...

bool	GetDragSelects () const
	Indicates that a drag should draw a selection rectangle, even when started over an item. More...

bool	GetMoveWarpsCursor () const
	Indicates that a move operation should warp the mouse pointer to the origin of the move object. More...

virtual wxWindow *	GetToolCanvas () const =0
	Canvas access. More...

virtual void	RefreshCanvas ()

HOLDER_TYPE	GetType () const

KIWAY &	Kiway () const
	Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...

PROJECT &	Prj () const
	Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...

void	SetKiway (wxWindow aDest, KIWAY aKiway)
	Function SetKiway. More...

Static Public Member Functions
static void	HandleUpdateUIEvent (wxUpdateUIEvent &aEvent, EDA_BASE_FRAME *aFrame, ACTION_CONDITIONS aCond)
	Handles events generated when the UI is trying to figure out the current state of the UI controls related to TOOL_ACTIONS (e.g. More...

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

virtual bool	isAutoSaveRequired () const
	Return the auto save status of the application. More...

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

virtual bool	canCloseWindow (wxCloseEvent &aCloseEvent)

virtual void	doCloseWindow ()

virtual void	unitsChangeRefresh ()
	Called when when the units setting has changed to allow for any derived classes to handle refreshing and controls that have units based measurements in them. More...

virtual void	setupUIConditions ()
	Setup the UI conditions for the various actions and their controls in this frame. More...

Static Protected Member Functions
static wxString	GetBackupSuffix ()

static wxString	GetAutoSaveFilePrefix ()

Protected Attributes
FRAME_T	m_ident

wxPoint	m_framePos

wxSize	m_frameSize

bool	m_maximizeByDefault

wxPoint	m_normalFramePos

wxSize	m_normalFrameSize

wxString	m_aboutTitle

wxAuiManager	m_auimgr

wxString	m_perspective

WX_INFOBAR *	m_infoBar

wxString	m_configName

SETTINGS_MANAGER *	m_settingsManager

FILE_HISTORY *	m_fileHistory

bool	m_hasAutoSave

bool	m_autoSaveState

int	m_autoSaveInterval

wxTimer *	m_autoSaveTimer

int	m_undoRedoCountMax

UNDO_REDO_CONTAINER	m_undoList

UNDO_REDO_CONTAINER	m_redoList

wxString	m_mruPath

EDA_UNITS	m_userUnits

std::map< int, UIUpdateHandler >	m_uiUpdateMap

bool	m_isClosing

bool	m_isNonUserClose

TOOL_MANAGER *	m_toolManager

ACTIONS *	m_actions

TOOL_DISPATCHER *	m_toolDispatcher

SELECTION	m_dummySelection

std::vector< std::string >	m_toolStack

bool	m_immediateActions

bool	m_dragSelects

bool	m_moveWarpsCursor

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)
	(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 ()

virtual bool	IsModal () const
	Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame In modal mode, the caller that created the frame is responsible to Destroy() this frame after closing. More...

Detailed Description

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 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 105 of file eda_base_frame.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE

inherited

Enumerator
DIALOG
FRAME
PANEL

Definition at line 42 of file kiway_holder.h.

42 { DIALOG, FRAME, PANEL };

KIWAY_HOLDER::DIALOG

Definition: kiway_holder.h:42

KIWAY_HOLDER::PANEL

Definition: kiway_holder.h:42

KIWAY_HOLDER::FRAME

Definition: kiway_holder.h:42

◆ UNDO_REDO_LIST

enum EDA_BASE_FRAME::UNDO_REDO_LIST

Function ClearUndoORRedoList (virtual).

this function must remove the aItemCount old commands from aList and delete commands, pickers and picked items if needed Because picked items must be deleted only if they are not in use, this is a virtual pure function that must be created for SCH_SCREEN and PCB_SCREEN

Parameters

aList	= the UNDO_REDO_CONTAINER of commands
aItemCount	= number of old commands to delete. -1 to remove all old commands this will empty the list of commands. Commands are deleted from the older to the last.

Enumerator
UNDO_LIST
REDO_LIST

Definition at line 588 of file eda_base_frame.h.

588 { UNDO_LIST, REDO_LIST };

EDA_BASE_FRAME::UNDO_LIST

Definition: eda_base_frame.h:588

EDA_BASE_FRAME::REDO_LIST

Definition: eda_base_frame.h:588

Constructor & Destructor Documentation

◆ EDA_BASE_FRAME()

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,
		KIWAY *	aKiway
	)

Definition at line 81 of file eda_base_frame.cpp.

                                                                                          :
         wxFrame( aParent, wxID_ANY, aTitle, aPos, aSize, aStyle, aFrameName ),
         TOOLS_HOLDER(),
         KIWAY_HOLDER( aKiway, KIWAY_HOLDER::FRAME ),
         m_ident( aFrameType ),
         m_maximizeByDefault( false ),
         m_infoBar( nullptr ),
         m_settingsManager( nullptr ),
         m_fileHistory( nullptr ),
         m_hasAutoSave( false ),
         m_autoSaveState( false ),
         m_autoSaveInterval(-1 ),
         m_undoRedoCountMax( DEFAULT_MAX_UNDO_ITEMS ),
         m_userUnits( EDA_UNITS::MILLIMETRES ),
         m_isClosing( false ),
         m_isNonUserClose( false )
 {
     m_autoSaveTimer = new wxTimer( this, ID_AUTO_SAVE_TIMER );
     m_mruPath       = wxStandardPaths::Get().GetDocumentsDir();
     m_frameSize     = wxSize( s_defaultSize_x, s_defaultSize_y );
 
     m_auimgr.SetArtProvider( new WX_AUI_DOCK_ART() );
 
     m_settingsManager = &Pgm().GetSettingsManager();
 
     // Set a reasonable minimal size for the frame
     SetSizeHints( s_minsize_x, s_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 ) );
 }

References ID_AUTO_SAVE_TIMER, onAutoSaveTimer(), Pgm(), s_defaultSize_x, s_defaultSize_y, s_minsize_x, s_minsize_y, and windowClosing().

◆ ~EDA_BASE_FRAME()

EDA_BASE_FRAME::~EDA_BASE_FRAME ( )

Definition at line 196 of file eda_base_frame.cpp.

 {
     delete m_autoSaveTimer;
     delete m_fileHistory;
 
     ClearUndoRedoList();
 
     KIPLATFORM::APP::RemoveShutdownBlockReason( this );
 }

References ClearUndoRedoList(), m_autoSaveTimer, m_fileHistory, and KIPLATFORM::APP::RemoveShutdownBlockReason().

Member Function Documentation

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar * aMenuBar )

Adds the standard KiCad help menu to the menubar.

Definition at line 388 of file eda_base_frame.cpp.

 {
     COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
     ACTION_MENU*    helpMenu = new ACTION_MENU( false, commonControl );
 
     helpMenu->Add( ACTIONS::help );
     helpMenu->Add( ACTIONS::gettingStarted );
     helpMenu->Add( ACTIONS::listHotKeys );
     helpMenu->Add( ACTIONS::getInvolved );
     helpMenu->Add( ACTIONS::reportBug );
 
     helpMenu->AppendSeparator();
     helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, about_xpm );
 
     aMenuBar->Append( helpMenu, _( "&Help" ) );
 }

References _, about_xpm, ACTIONS::getInvolved, ACTIONS::gettingStarted, TOOL_MANAGER::GetTool(), ACTIONS::help, ACTIONS::listHotKeys, TOOLS_HOLDER::m_toolManager, and ACTIONS::reportBug.

Referenced by EDA_3D_VIEWER::CreateMenuBar(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), LIB_VIEW_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::ReCreateMenuBar(), SYMBOL_EDIT_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), CVPCB_MAINFRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), and PCB_EDIT_FRAME::ReCreateMenuBar().

◆ canCloseWindow()

virtual bool EDA_BASE_FRAME::canCloseWindow ( wxCloseEvent & aCloseEvent )

inlineprotectedvirtual

Reimplemented in SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, PCB_EDIT_FRAME, CVPCB_MAINFRAME, PL_EDITOR_FRAME, FOOTPRINT_EDIT_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 211 of file eda_base_frame.h.

211 { return true; }

Referenced by windowClosing().

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS aUnits )

Definition at line 970 of file eda_base_frame.cpp.

 {
     SetUserUnits( aUnits );
     unitsChangeRefresh();
 
     wxCommandEvent e( UNITS_CHANGED );
     ProcessEventLocally( e );
 }

References SetUserUnits(), and unitsChangeRefresh().

Referenced by COMMON_TOOLS::SwitchUnits(), and COMMON_TOOLS::ToggleUnits().

◆ CheckForAutoSaveFile()

void EDA_BASE_FRAME::CheckForAutoSaveFile ( const wxFileName & aFileName )

Check 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.

Definition at line 868 of file eda_base_frame.cpp.

 {
     wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
 
     wxFileName autoSaveFileName = aFileName;
 
     // Check for auto save file.
     autoSaveFileName.SetName( GetAutoSaveFilePrefix() + 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?" ),
             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 )
     {
         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() );
     }
 }

References _, Format(), GetAutoSaveFilePrefix(), Pgm(), and traceAutoSave.

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

◆ ClearFileHistory()

void EDA_BASE_FRAME::ClearFileHistory ( FILE_HISTORY * aFileHistory = nullptr )

Removes all files from the file history.

Parameters

aFileHistory The FILE_HISTORY in use. If null, the main application file history is used

Definition at line 765 of file eda_base_frame.cpp.

 {
     if( !aFileHistory )
         aFileHistory = m_fileHistory;
 
     wxASSERT( aFileHistory );
 
     aFileHistory->ClearFileHistory();
 
     // Update the menubar to update the file history menu
     if( GetMenuBar() )
     {
         ReCreateMenuBar();
         GetMenuBar()->Refresh();
     }
 }

References FILE_HISTORY::ClearFileHistory(), m_fileHistory, and ReCreateMenuBar().

Referenced by GERBVIEW_FRAME::OnClearDrlFileHistory(), KICAD_MANAGER_FRAME::OnClearFileHistory(), PL_EDITOR_FRAME::OnClearFileHistory(), PCB_EDIT_FRAME::OnClearFileHistory(), SCH_EDIT_FRAME::OnClearFileHistory(), GERBVIEW_FRAME::OnClearGbrFileHistory(), GERBVIEW_FRAME::OnClearJobFileHistory(), and GERBVIEW_FRAME::OnClearZipFileHistory().

◆ ClearUndoORRedoList()

virtual void EDA_BASE_FRAME::ClearUndoORRedoList	(	UNDO_REDO_LIST	aList,
		int	aItemCount = `-1`
	)

inlinevirtual

Reimplemented in SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, PL_EDITOR_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 589 of file eda_base_frame.h.

590 { }

Referenced by ClearUndoRedoList(), PushCommandToRedoList(), and PushCommandToUndoList().

◆ ClearUndoRedoList()

void EDA_BASE_FRAME::ClearUndoRedoList ( )

virtual

Function ClearUndoRedoList clear undo and redo list, using ClearUndoORRedoList() picked items are deleted by ClearUndoORRedoList() according to their status.

Definition at line 921 of file eda_base_frame.cpp.

 {
     ClearUndoORRedoList( UNDO_LIST );
     ClearUndoORRedoList( REDO_LIST );
 }

References ClearUndoORRedoList(), REDO_LIST, and UNDO_LIST.

Referenced by FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), SYMBOL_EDIT_FRAME::emptyScreen(), SCH_EDIT_FRAME::importFile(), FOOTPRINT_EDITOR_TOOLS::ImportFootprint(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), PL_EDITOR_FRAME::OnNewPageLayout(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDITOR_CONTROL::rescueProject(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), and ~EDA_BASE_FRAME().

◆ CommonSettingsChanged()

void EDA_BASE_FRAME::CommonSettingsChanged	(	bool	aEnvVarsChanged,
		bool	aTextVarsChanged
	)

overridevirtual

Notification event that some of the common (suite-wide) settings have changed.

Update menus, toolbars, local variables, etc.

Reimplemented from TOOLS_HOLDER.

Reimplemented in PCB_EDIT_FRAME, PCB_BASE_FRAME, FOOTPRINT_EDIT_FRAME, EDA_DRAW_FRAME, FOOTPRINT_VIEWER_FRAME, KICAD_MANAGER_FRAME, and PL_EDITOR_FRAME.

Definition at line 416 of file eda_base_frame.cpp.

 {
     TOOLS_HOLDER::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
 
     COMMON_SETTINGS* settings = Pgm().GetCommonSettings();
 
     if( m_fileHistory )
     {
         int historySize = settings->m_System.file_history_size;
         m_fileHistory->SetMaxFiles( (unsigned) std::max( 0, historySize ) );
     }
 
     if( GetMenuBar() )
     {
         // For icons in menus, icon scaling & hotkeys
         ReCreateMenuBar();
         GetMenuBar()->Refresh();
     }
 }

References TOOLS_HOLDER::CommonSettingsChanged(), COMMON_SETTINGS::SYSTEM::file_history_size, m_fileHistory, COMMON_SETTINGS::m_System, Pgm(), ReCreateMenuBar(), and FILE_HISTORY::SetMaxFiles().

Referenced by KICAD_MANAGER_FRAME::CommonSettingsChanged(), EDA_3D_VIEWER::CommonSettingsChanged(), EDA_DRAW_FRAME::CommonSettingsChanged(), and KIWAY::CommonSettingsChanged().

◆ config()

APP_SETTINGS_BASE * EDA_BASE_FRAME::config ( ) const

virtual

Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 661 of file eda_base_frame.cpp.

 {
     // KICAD_MANAGER_FRAME overrides this
     return Kiface().KifaceSettings();
 }

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

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::ActivateGalCanvas(), BM2CMP_FRAME::BM2CMP_FRAME(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), SIM_PLOT_FRAME::doCloseWindow(), SCH_BASE_FRAME::eeconfig(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), DISPLAY_FOOTPRINTS_FRAME::GetAutoZoom(), GRID_MENU::GRID_MENU(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), EDA_DRAW_FRAME::IsGridVisible(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), SCH_BASE_FRAME::libeditconfig(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), EDA_DRAW_FRAME::resolveCanvasType(), DISPLAY_FOOTPRINTS_FRAME::SetAutoZoom(), PCB_BASE_EDIT_FRAME::SetBoard(), EDA_DRAW_FRAME::SetGridVisibility(), PL_EDITOR_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupTools(), LIB_VIEW_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), SYMBOL_EDIT_FRAME::setupTools(), CVPCB_MAINFRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), ZOOM_MENU::update(), GRID_MENU::update(), EDA_DRAW_FRAME::UpdateGridSelectBox(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), windowClosing(), ZOOM_MENU::ZOOM_MENU(), and BM2CMP_FRAME::~BM2CMP_FRAME().

◆ ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )

inlineoverridevirtual

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, except for frames shown in multiple modes in which case the m_configName must be set to the base name so that a single config can be used.

Reimplemented from TOOLS_HOLDER.

Definition at line 404 of file eda_base_frame.h.

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

References m_configName.

Referenced by SaveWindowSettings().

◆ CurrentToolName()

std::string TOOLS_HOLDER::CurrentToolName ( ) const

inherited

Definition at line 99 of file tools_holder.cpp.

 {
     if( m_toolStack.empty() )
         return ACTIONS::selectionTool.GetName();
     else
         return m_toolStack.back();
 }

References TOOLS_HOLDER::m_toolStack, and ACTIONS::selectionTool.

Referenced by TOOL_MANAGER::processEvent().

◆ DisplayToolMsg()

virtual void TOOLS_HOLDER::DisplayToolMsg ( const wxString & msg )

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 141 of file tools_holder.h.

141 {};

Referenced by TOOLS_HOLDER::PopTool(), and TOOLS_HOLDER::PushTool().

◆ doAutoSave()

bool EDA_BASE_FRAME::doAutoSave ( )

protectedvirtual

This 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 272 of file eda_base_frame.cpp.

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

Referenced by onAutoSaveTimer().

◆ doCloseWindow()

virtual void EDA_BASE_FRAME::doCloseWindow ( )

inlineprotectedvirtual

Reimplemented in SCH_EDIT_FRAME, SIM_PLOT_FRAME, SYMBOL_EDIT_FRAME, PCB_EDIT_FRAME, GERBVIEW_FRAME, CVPCB_MAINFRAME, FOOTPRINT_WIZARD_FRAME, FOOTPRINT_VIEWER_FRAME, PL_EDITOR_FRAME, FOOTPRINT_EDIT_FRAME, KICAD_MANAGER_FRAME, DISPLAY_FOOTPRINTS_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 212 of file eda_base_frame.h.

212 { }

Referenced by windowClosing().

◆ findQuasiModalDialog()

wxWindow * EDA_BASE_FRAME::findQuasiModalDialog ( )

private

Definition at line 123 of file eda_base_frame.cpp.

 {
     for( wxWindow* 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;
 }

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

Referenced by ProcessEvent(), and windowClosing().

◆ GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const

inline

Definition at line 554 of file eda_base_frame.h.

554 { return m_aboutTitle; }

EDA_BASE_FRAME::m_aboutTitle

wxString m_aboutTitle

Definition: eda_base_frame.h:139

References m_aboutTitle.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT(), and COMMON_CONTROL::ReportBug().

◆ GetAutoSaveFilePrefix()

static wxString EDA_BASE_FRAME::GetAutoSaveFilePrefix ( )

inlinestaticprotected

Returns: the string to prepend to a file name for automatic save.

Definition at line 187 of file eda_base_frame.h.

     {
         return wxT( "_autosave-" );
     }

Referenced by CheckForAutoSaveFile(), SCH_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::OnExportSTEP(), SCH_EDIT_FRAME::SaveEEFile(), and PCB_EDIT_FRAME::SavePcbFile().

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const

inline

Definition at line 315 of file eda_base_frame.h.

315 { return m_autoSaveInterval; }

EDA_BASE_FRAME::m_autoSaveInterval

int m_autoSaveInterval

Definition: eda_base_frame.h:155

References m_autoSaveInterval.

◆ GetBackupSuffix()

static wxString EDA_BASE_FRAME::GetBackupSuffix ( )

inlinestaticprotected

Returns: the suffix to be appended to the file extension on backup

Definition at line 179 of file eda_base_frame.h.

     {
         return wxT( "-bak" );
     }

◆ GetCurrentFileName()

virtual wxString EDA_BASE_FRAME::GetCurrentFileName ( ) const

inlinevirtual

Get the full filename + path of the currently opened file in the frame.

If no file is open, an empty string is returned.

Returns: the filename and full path to the open file

Reimplemented in PCB_EDIT_FRAME, SCH_EDIT_FRAME, PL_EDITOR_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 485 of file eda_base_frame.h.

485 { return wxEmptyString; }

Referenced by SaveSettings().

◆ GetCurrentSelection()

virtual SELECTION& TOOLS_HOLDER::GetCurrentSelection ( )

inlinevirtualinherited

Get the current selection from the canvas area.

Returns: the current selection

Reimplemented in PCB_EDIT_FRAME, GERBVIEW_FRAME, SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, LIB_VIEW_FRAME, DISPLAY_FOOTPRINTS_FRAME, PL_EDITOR_FRAME, FOOTPRINT_EDIT_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 123 of file tools_holder.h.

     {
         return m_dummySelection;
     }

References TOOLS_HOLDER::m_dummySelection.

Referenced by HandleUpdateUIEvent(), and ACTION_MANAGER::RunHotKey().

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const

inlineinherited

Indicates that hotkeys should perform an immediate action even if another tool is currently active.

If false, the first hotkey should select the relevant tool.

Definition at line 147 of file tools_holder.h.

147 { return m_immediateActions; }

TOOLS_HOLDER::m_immediateActions

bool m_immediateActions

Definition: tools_holder.h:61

References TOOLS_HOLDER::m_immediateActions.

◆ GetDragSelects()

bool TOOLS_HOLDER::GetDragSelects ( ) const

inlineinherited

Indicates that a drag should draw a selection rectangle, even when started over an item.

Definition at line 153 of file tools_holder.h.

153 { return m_dragSelects; }

TOOLS_HOLDER::m_dragSelects

bool m_dragSelects

Definition: tools_holder.h:65

References TOOLS_HOLDER::m_dragSelects.

Referenced by PL_SELECTION_TOOL::Main(), and EE_SELECTION_TOOL::Main().

◆ GetFileFromHistory()

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

Fetches the file name from the file history list.

This removes the selected file, if this file does not exist. The menu is also updated, if FILE_HISTORY::UseMenu was called at init time

Parameters

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

Returns: a wxString containing the selected filename

Definition at line 725 of file eda_base_frame.cpp.

 {
     if( !aFileHistory )
         aFileHistory = m_fileHistory;
 
     wxASSERT( aFileHistory );
 
     int baseId = aFileHistory->GetBaseId();
 
     wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );
 
     unsigned i = cmdId - baseId;
 
     if( i < aFileHistory->GetCount() )
     {
         wxString fn = aFileHistory->GetHistoryFile( i );
 
         if( wxFileName::FileExists( fn ) )
             return fn;
         else
         {
             wxString msg = wxString::Format( _( "File \"%s\" was not found." ), fn );
             wxMessageBox( msg );
 
             aFileHistory->RemoveFileFromHistory( i );
         }
     }
 
     // Update the menubar to update the file history menu
     if( GetMenuBar() )
     {
         ReCreateMenuBar();
         GetMenuBar()->Refresh();
     }
 
     return wxEmptyString;
 }

References _, Format(), m_fileHistory, and ReCreateMenuBar().

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

◆ GetFileHistory()

FILE_HISTORY& EDA_BASE_FRAME::GetFileHistory ( )

inline

Get the frame's main file history.

Returns: the main file history

Definition at line 470 of file eda_base_frame.h.

     {
         return *m_fileHistory;
     }

References m_fileHistory.

Referenced by KICAD_MANAGER_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), and PCB_EDIT_FRAME::ReCreateMenuBar().

◆ GetInfoBar()

WX_INFOBAR* EDA_BASE_FRAME::GetInfoBar ( )

inline

Definition at line 333 of file eda_base_frame.h.

333 { return m_infoBar; }

EDA_BASE_FRAME::m_infoBar

WX_INFOBAR * m_infoBar

Definition: eda_base_frame.h:144

References m_infoBar.

Referenced by FOOTPRINT_EDIT_FRAME::AddFootprintToBoard(), AUTOPLACE_TOOL::autoplace(), PAD_TOOL::EditPad(), ZONE_FILLER_TOOL::FillAllZones(), SYMBOL_EDIT_FRAME::LoadOneLibraryPartAux(), APPEARANCE_CONTROLS::onReadOnlySwatch(), EDA_DRAW_PANEL_GAL::onSize(), ROUTER_TOOL::onViaCommand(), SYMBOL_EDIT_FRAME::SetCurPart(), ShowInfoBarError(), ShowInfoBarMsg(), and ShowInfoBarWarning().

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const

inline

Definition at line 633 of file eda_base_frame.h.

633 { return m_undoRedoCountMax; }

EDA_BASE_FRAME::m_undoRedoCountMax

int m_undoRedoCountMax

Definition: eda_base_frame.h:158

References m_undoRedoCountMax.

Referenced by EDA_DRAW_FRAME::SaveSettings().

◆ GetMoveWarpsCursor()

bool TOOLS_HOLDER::GetMoveWarpsCursor ( ) const

inlineinherited

Indicates that a move operation should warp the mouse pointer to the origin of the move object.

This improves snapping, but some users are alergic to mouse warping.

Definition at line 159 of file tools_holder.h.

159 { return m_moveWarpsCursor; }

TOOLS_HOLDER::m_moveWarpsCursor

bool m_moveWarpsCursor

Definition: tools_holder.h:66

References TOOLS_HOLDER::m_moveWarpsCursor.

Referenced by EDIT_TOOL::doMoveSelection(), LIB_MOVE_TOOL::Main(), and SCH_MOVE_TOOL::Main().

◆ GetMruPath()

wxString EDA_BASE_FRAME::GetMruPath ( ) const

inline

Definition at line 477 of file eda_base_frame.h.

477 { return m_mruPath; }

EDA_BASE_FRAME::m_mruPath

wxString m_mruPath

Definition: eda_base_frame.h:163

References m_mruPath.

Referenced by GERBVIEW_CONTROL::ExportToPcbnew(), PCB_EDIT_FRAME::Files_io_from_id(), PANEL_HOTKEYS_EDITOR::ImportHotKeys(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), KICAD_MANAGER_CONTROL::NewProject(), KICAD_MANAGER_CONTROL::OpenProject(), SCH_EDIT_FRAME::SaveEEFile(), and KICAD_MANAGER_CONTROL::SaveProjectAs().

◆ GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const

inlinevirtual

Reimplemented in CVPCB_MAINFRAME.

Definition at line 631 of file eda_base_frame.h.

631 { return m_redoList.m_CommandsList.size(); }

UNDO_REDO_CONTAINER::m_CommandsList

std::vector< PICKED_ITEMS_LIST * > m_CommandsList

Definition: undo_redo_container.h:324

EDA_BASE_FRAME::m_redoList

UNDO_REDO_CONTAINER m_redoList

Definition: eda_base_frame.h:161

References UNDO_REDO_CONTAINER::m_CommandsList, and m_redoList.

Referenced by PL_EDITOR_FRAME::GetLayoutFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), PushCommandToRedoList(), SCH_EDITOR_CONTROL::Redo(), and EDITOR_CONDITIONS::redoFunc().

◆ GetSettingsManager()

SETTINGS_MANAGER* EDA_BASE_FRAME::GetSettingsManager ( ) const

inline

Definition at line 253 of file eda_base_frame.h.

253 { return m_settingsManager; }

EDA_BASE_FRAME::m_settingsManager

SETTINGS_MANAGER * m_settingsManager

Definition: eda_base_frame.h:149

References m_settingsManager.

Referenced by GERBVIEW_FRAME::applyDisplaySettingsToGAL(), KICAD_MANAGER_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CreateNewProject(), SCH_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::Files_io_from_id(), DIALOG_SCHEMATIC_SETUP::OnAuxiliaryAction(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), SCH_EDIT_FRAME::OnImportProject(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::Save_File(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ GetSeverity()

virtual int EDA_BASE_FRAME::GetSeverity ( int aErrorCode ) const

inlinevirtual

Reimplemented in PCB_BASE_FRAME.

Definition at line 255 of file eda_base_frame.h.

255 { return RPT_SEVERITY_UNDEFINED; }

RPT_SEVERITY_UNDEFINED

Definition: ui_common.h:84

References RPT_SEVERITY_UNDEFINED.

Referenced by RC_TREE_MODEL::GetValue().

◆ GetToolCanvas()

virtual wxWindow* TOOLS_HOLDER::GetToolCanvas ( ) const

pure virtualinherited

Canvas access.

Implemented in EDA_DRAW_FRAME, PCB_CALCULATOR_FRAME, SIM_PLOT_FRAME, PANEL_PREV_3D, KICAD_MANAGER_FRAME, BM2CMP_FRAME, CVPCB_MAINFRAME, and EDA_3D_VIEWER.

Referenced by TOOL_DISPATCHER::DispatchWxEvent(), and EDA_3D_CONTROLLER::Reset().

◆ GetToolManager()

TOOL_MANAGER* TOOLS_HOLDER::GetToolManager ( ) const

inlineinherited

Return the MVC controller.

Definition at line 76 of file tools_holder.h.

76 { return m_toolManager; }

TOOLS_HOLDER::m_toolManager

TOOL_MANAGER * m_toolManager

Definition: tools_holder.h:48

References TOOLS_HOLDER::m_toolManager.

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), LIB_CONTROL::AddSymbolToSchematic(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), BOARD_COMMIT::BOARD_COMMIT(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), TOOLS_HOLDER::CommonSettingsChanged(), DIALOG_FOOTPRINT_CHECKER::deleteAllMarkers(), DIALOG_ERC::deleteAllMarkers(), DIALOG_DRC::deleteAllMarkers(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_MIGRATE_BUSES::DIALOG_MIGRATE_BUSES(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), SIM_PLOT_FRAME::doCloseWindow(), SCH_FIELD::DoHypertextMenu(), DRAWING_TOOL::DrawVia(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), GERBVIEW_FRAME::GERBVIEW_FRAME(), FP_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_NAVIGATE_TOOL::HypertextCommand(), ROUTER_TOOL::InlineBreakTrack(), KICAD_MANAGER_FRAME::InstallPreferences(), PL_EDITOR_FRAME::InstallPreferences(), FOOTPRINT_EDIT_FRAME::InstallPreferences(), SYMBOL_EDIT_FRAME::InstallPreferences(), GERBVIEW_FRAME::InstallPreferences(), PCB_EDIT_FRAME::InstallPreferences(), SCH_EDIT_FRAME::InstallPreferences(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), SYMBOL_EDIT_FRAME::LoadPart(), PCB_EDIT_FRAME::LoadProjectSettings(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_DRC::OnActivateDlg(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_DRC::OnCancelClick(), DIALOG_INSPECTOR::onCellClicked(), DIALOG_ERC::OnCloseErcDialog(), SYMBOL_TREE_PANE::onComponentSelected(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_ERC::OnERCItemSelected(), DIALOG_CONSTRAINTS_REPORTER::OnErrorLinkClicked(), DIALOG_INSPECTION_REPORTER::OnErrorLinkClicked(), KICAD_MANAGER_FRAME::OnIdle(), FOOTPRINTS_LISTBOX::OnLeftDClick(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetContextMenu(), SIM_PLOT_FRAME::onProbe(), DIALOG_PLOT::onRunDRC(), DIALOG_DRC::OnRunDRCClick(), HIERARCHY_NAVIG_DLG::onSelectSheetPath(), SCH_EDIT_FRAME::onSize(), DIALOG_FIELDS_EDITOR_GLOBAL::OnTableCellClick(), SIM_PLOT_FRAME::onTune(), PANEL_SELECTION_FILTER::PANEL_SELECTION_FILTER(), DIALOG_PLOT::Plot(), TOOLS_HOLDER::PopTool(), SCH_EDIT_FRAME::PutDataInPreviousState(), EDA_DRAW_FRAME::resolveCanvasType(), PL_EDITOR_FRAME::RollbackFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), PCB_EDIT_FRAME::SaveProjectSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), EDA_3D_VIEWER::SaveSettings(), DIALOG_FIND::search(), CVPCB_MAINFRAME::setupEventHandlers(), APPEARANCE_CONTROLS::showNetclass(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_3D_VIEW_OPTIONS::TransferDataFromWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataFromWindow(), DIALOG_FIELDS_EDITOR_GLOBAL::TransferDataToWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataToWindow(), DIALOG_3D_VIEW_OPTIONS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), EDA_DRAW_FRAME::UpdateMsgPanel(), NET_GRID_TABLE::updateNetVisibility(), DIALOG_NETLIST::~DIALOG_NETLIST(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const

inlineinherited

Definition at line 49 of file kiway_holder.h.

49 { return m_type; }

KIWAY_HOLDER::m_type

HOLDER_TYPE m_type

Definition: kiway_holder.h:82

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUndoCommandCount()

virtual int EDA_BASE_FRAME::GetUndoCommandCount ( ) const

inlinevirtual

Reimplemented in CVPCB_MAINFRAME.

Definition at line 630 of file eda_base_frame.h.

630 { return m_undoList.m_CommandsList.size(); }

EDA_BASE_FRAME::m_undoList

UNDO_REDO_CONTAINER m_undoList

Definition: eda_base_frame.h:160

UNDO_REDO_CONTAINER::m_CommandsList

std::vector< PICKED_ITEMS_LIST * > m_CommandsList

Definition: undo_redo_container.h:324

References UNDO_REDO_CONTAINER::m_CommandsList, and m_undoList.

Referenced by PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), PushCommandToUndoList(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDITOR_CONTROL::Undo(), and EDITOR_CONDITIONS::undoFunc().

◆ GetUserUnits()

EDA_UNITS EDA_BASE_FRAME::GetUserUnits ( ) const

inline

Return the user units currently in use.

Definition at line 239 of file eda_base_frame.h.

     {
         return m_userUnits;
     }

References m_userUnits.

◆ GetWindowSettings()

WINDOW_SETTINGS * EDA_BASE_FRAME::GetWindowSettings ( APP_SETTINGS_BASE * aCfg )

virtual

Returns a pointer to the window settings for this frame.

By default, points to aCfg->m_Window for top-level frames.

Parameters

aCfg	is this frame's config object

Reimplemented in SIM_PLOT_FRAME, FOOTPRINT_WIZARD_FRAME, FOOTPRINT_VIEWER_FRAME, LIB_VIEW_FRAME, and DISPLAY_FOOTPRINTS_FRAME.

Definition at line 655 of file eda_base_frame.cpp.

 {
     return &aCfg->m_Window;
 }

References APP_SETTINGS_BASE::m_Window.

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

◆ GetWindowSize()

wxSize EDA_BASE_FRAME::GetWindowSize ( )

Get the undecorated window size that can be used for restoring the window size.

This is needed for GTK, since the normal wxWidgets GetSize() call will return a window size that includes the window decorations added by the window manager.

Returns: the undecorated window size

Definition at line 1002 of file eda_base_frame.cpp.

 {
 #ifdef __WXGTK__
     // GTK includes the window decorations in the normal GetSize call,
     // so we have to use a GTK-specific sizing call that returns the
     // non-decorated window size.
     int width  = 0;
     int height = 0;
     GTKDoGetSize( &width, &height );
 
     wxSize winSize( width, height );
 #else
     wxSize winSize = GetSize();
 #endif
 
     return winSize;
 }

Referenced by OnMaximize(), and SaveWindowSettings().

◆ HandleUpdateUIEvent()

void EDA_BASE_FRAME::HandleUpdateUIEvent	(	wxUpdateUIEvent &	aEvent,
		EDA_BASE_FRAME *	aFrame,
		ACTION_CONDITIONS	aCond
	)

static

Handles events generated when the UI is trying to figure out the current state of the UI controls related to TOOL_ACTIONS (e.g.

enabled, checked, etc.).

Parameters

aEvent	is the wxUpdateUIEvent to be processed.
aFrame	is the frame to get the selection from
aCond	are the UI SELECTION_CONDITIONS used

Definition at line 320 of file eda_base_frame.cpp.

 {
     bool       checkRes  = false;
     bool       enableRes = true;
     bool       showRes   = true;
     SELECTION& selection = aFrame->GetCurrentSelection();
 
     try
     {
         checkRes  = aCond.checkCondition( selection );
         enableRes = aCond.enableCondition( selection );
         showRes   = aCond.showCondition( selection );
     }
     catch( std::exception& )
     {
         // Something broke with the conditions, just skip the event.
         aEvent.Skip();
         return;
     }
 
     aEvent.Enable( enableRes );
     aEvent.Show( showRes );
 
     // wxWidgets 3.1.5+ includes a field in the event that says if the event supports being
     // checked, since wxMenuItems don't want to be checked unless they actually are checkable
 #if wxCHECK_VERSION( 3, 1, 5 )
     if( aEvent.IsCheckable() )
         aEvent.Check( checkRes );
 #else
     bool canCheck = true;
 
     // wxMenuItems don't want to be checked unless they actually are checkable, so we have to check to
     // see if they can be and can't just universally apply a check in this event.
     if( auto menu = dynamic_cast<wxMenu*>( aEvent.GetEventObject() ) )
         canCheck = menu->FindItem( aEvent.GetId() )->IsCheckable();
 
     if( canCheck )
         aEvent.Check( checkRes );
 #endif
 }

References ACTION_CONDITIONS::checkCondition, ACTION_CONDITIONS::enableCondition, TOOLS_HOLDER::GetCurrentSelection(), and ACTION_CONDITIONS::showCondition.

Referenced by RegisterUIUpdateHandler().

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )

virtual

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 674 of file eda_base_frame.cpp.

 {
     return Kiface().GetHelpFileName();
 }

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

Referenced by COMMON_CONTROL::ShowHelp().

◆ ImportHotkeyConfigFromFile()

void EDA_BASE_FRAME::ImportHotkeyConfigFromFile	(	std::map< std::string, TOOL_ACTION * >	aActionMap,
		const wxString &	aDefaultShortname
	)

Prompt the user for a hotkey file to read, and read it.

Parameters

aActionMap	= current hotkey map (over which the imported hotkeys will be applied)
aDefaultShortname	= a default short name (extension not needed) like eechema, kicad...

◆ InstallPreferences()

virtual void EDA_BASE_FRAME::InstallPreferences	(	PAGED_DIALOG *	,
		PANEL_HOTKEYS_EDITOR *
	)

inlinevirtual

Function InstallPreferences Allow a frame to load its preference panels (if any) into the preferences dialog.

Parameters

aParent a paged dialog into which the preference panels should be installed

Reimplemented in SCH_EDIT_FRAME, PCB_EDIT_FRAME, GERBVIEW_FRAME, SYMBOL_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, PL_EDITOR_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 350 of file eda_base_frame.h.

350 { }

Referenced by OnPreferences().

◆ isAutoSaveRequired()

virtual bool EDA_BASE_FRAME::isAutoSaveRequired ( ) const

inlineprotectedvirtual

Return 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 202 of file eda_base_frame.h.

202 { return false; }

Referenced by ProcessEvent().

◆ IsContentModified()

bool EDA_BASE_FRAME::IsContentModified ( )

virtual

Get if the contents of the frame have been modified since the last save.

Returns: true if the contents of the frame have not been saved

Reimplemented in PCB_EDIT_FRAME, SCH_EDIT_FRAME, CVPCB_MAINFRAME, SYMBOL_EDIT_FRAME, PL_EDITOR_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 914 of file eda_base_frame.cpp.

 {
     // This function should be overridden in child classes
     return false;
 }

Referenced by EDITOR_CONDITIONS::contentModifiedFunc().

◆ IsCurrentTool()

bool TOOLS_HOLDER::IsCurrentTool ( const TOOL_ACTION & aAction ) const

inherited

Definition at line 108 of file tools_holder.cpp.

 {
     if( m_toolStack.empty() )
         return &aAction == &ACTIONS::selectionTool;
     else
         return m_toolStack.back() == aAction.GetName();
 }

References TOOL_ACTION::GetName(), TOOLS_HOLDER::m_toolStack, and ACTIONS::selectionTool.

Referenced by PCB_INSPECTION_TOOL::HighlightNetTool(), SCH_EDIT_TOOL::Init(), PCB_EDITOR_CONTROL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), EDIT_TOOL::Init(), and EDITOR_CONDITIONS::toolFunc().

◆ IsModal()

virtual bool EDA_BASE_FRAME::IsModal ( ) const

inlineprivatevirtual

Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame In modal mode, the caller that created the frame is responsible to Destroy() this frame after closing.

Reimplemented in KIWAY_PLAYER.

Definition at line 127 of file eda_base_frame.h.

127 { return false; }

Referenced by HTML_MESSAGE_BOX::OnOKButtonClick(), and windowClosing().

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T aType ) const

inline

Definition at line 317 of file eda_base_frame.h.

317 { return m_ident == aType; }

EDA_BASE_FRAME::m_ident

FRAME_T m_ident

Definition: eda_base_frame.h:130

References m_ident.

◆ IsWritable()

bool EDA_BASE_FRAME::IsWritable ( const wxFileName & aFileName )

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 824 of file eda_base_frame.cpp.

 {
     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\"." ),
                     fn.GetPath() );
     }
     else if( !fn.FileExists() && !fn.IsDirWritable() )
     {
         msg.Printf( _( "You do not have write permissions to save file \"%s\" to folder \"%s\"." ),
                     fn.GetFullName(), fn.GetPath() );
     }
     else if( fn.FileExists() && !fn.IsFileWritable() )
     {
         msg.Printf( _( "You do not have write permissions to save file \"%s\"." ),
                     fn.GetFullPath() );
     }
 
     if( !msg.IsEmpty() )
     {
         wxMessageBox( msg );
         return false;
     }
 
     return true;
 }

References _.

Referenced by SCH_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::SaveEEFile(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), and SCH_EDIT_FRAME::SaveProjectSettings().

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const

inlineinherited

Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in.

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 56 of file kiway_holder.h.

     {
         wxASSERT( m_kiway );    // smoke out bugs in Debug build, then Release runs fine.
         return *m_kiway;
     }

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), SYMBOL_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_TOOLS::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), CVPCB_MAINFRAME::DisplayStatus(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), PCB_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithLibEdit(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), PCB_EDIT_FRAME::importFile(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), CVPCB_MAINFRAME::LoadFootprintFiles(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), SYMBOL_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SYMBOL_EDIT_FRAME::refreshSchematic(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SetCrossProbeConnection(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), PCB_EDITOR_CONTROL::UpdateSchematicFromPCB(), LIB_CONTROL::UpdateSymbolInSchematic(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ LoadSettings()

void EDA_BASE_FRAME::LoadSettings ( APP_SETTINGS_BASE * aCfg )

virtual

Load 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, CVPCB_MAINFRAME, SYMBOL_EDIT_FRAME, SIM_PLOT_FRAME, EDA_3D_VIEWER, FOOTPRINT_WIZARD_FRAME, PL_EDITOR_FRAME, SCH_EDIT_FRAME, BM2CMP_FRAME, FOOTPRINT_VIEWER_FRAME, KICAD_MANAGER_FRAME, SCH_BASE_FRAME, LIB_VIEW_FRAME, PCB_CALCULATOR_FRAME, FOOTPRINT_EDIT_FRAME, and DISPLAY_FOOTPRINTS_FRAME.

Definition at line 614 of file eda_base_frame.cpp.

 {
     LoadWindowSettings( GetWindowSettings( aCfg ) );
 
     // Get file history size from common settings
     int fileHistorySize = Pgm().GetCommonSettings()->m_System.file_history_size;
 
     // Load the recently used files into the history menu
     m_fileHistory = new FILE_HISTORY( (unsigned) std::max( 0, fileHistorySize ),
                                       ID_FILE1, ID_FILE_LIST_CLEAR );
     m_fileHistory->Load( *aCfg );
 }

References GetWindowSettings(), ID_FILE1, ID_FILE_LIST_CLEAR, FILE_HISTORY::Load(), LoadWindowSettings(), m_fileHistory, and Pgm().

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

◆ LoadWindowSettings()

void EDA_BASE_FRAME::LoadWindowSettings ( const WINDOW_SETTINGS * aCfg )

Loads window settings from the given settings object Normally called by LoadSettings unless the window in question is a child window that stores its settings somewhere other than APP_SETTINGS_BASE::m_Window.

Definition at line 555 of file eda_base_frame.cpp.

 {
     LoadWindowState( aCfg->state );
 
     if( m_hasAutoSave )
         m_autoSaveInterval = Pgm().GetCommonSettings()->m_System.autosave_interval;
 
     m_perspective = aCfg->perspective;
     m_mruPath = aCfg->mru_path;
 
     TOOLS_HOLDER::CommonSettingsChanged( false, false );
 }

References TOOLS_HOLDER::CommonSettingsChanged(), LoadWindowState(), m_autoSaveInterval, m_hasAutoSave, m_mruPath, m_perspective, WINDOW_SETTINGS::mru_path, WINDOW_SETTINGS::perspective, Pgm(), and WINDOW_SETTINGS::state.

Referenced by LoadSettings().

◆ LoadWindowState() [1/2]

void EDA_BASE_FRAME::LoadWindowState ( const wxString & aFileName )

Definition at line 437 of file eda_base_frame.cpp.

 {
     if( !Pgm().GetCommonSettings()->m_Session.remember_open_files )
         return;
 
     const PROJECT_FILE_STATE* state = Prj().GetLocalSettings().GetFileState( aFileName );
 
     if( state != nullptr )
     {
         LoadWindowState( state->window );
     }
 }

References PROJECT_LOCAL_SETTINGS::GetFileState(), PROJECT::GetLocalSettings(), Pgm(), KIWAY_HOLDER::Prj(), and PROJECT_FILE_STATE::window.

Referenced by KICAD_MANAGER_FRAME::LoadProject(), PCB_EDIT_FRAME::LoadProjectSettings(), LoadWindowSettings(), and SCH_EDIT_FRAME::OpenProjectFiles().

◆ LoadWindowState() [2/2]

void EDA_BASE_FRAME::LoadWindowState ( const WINDOW_STATE & aState )

virtual

Load frame state info from a configuration file.

Definition at line 451 of file eda_base_frame.cpp.

 {
     bool wasDefault = false;
 
     m_framePos.x  = aState.pos_x;
     m_framePos.y  = aState.pos_y;
     m_frameSize.x = aState.size_x;
     m_frameSize.y = aState.size_y;
 
     wxLogTrace( traceDisplayLocation, "Config position (%d, %d) with size (%d, %d)",
                 m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
 
     // Ensure minimum size is set if the stored config was zero-initialized
     if( m_frameSize.x < s_minsize_x || m_frameSize.y < s_minsize_y )
     {
         m_frameSize.x = s_defaultSize_x;
         m_frameSize.y = s_defaultSize_y;
         wasDefault    = true;
 
         wxLogTrace( traceDisplayLocation, "Using minimum size (%d, %d)", m_frameSize.x, m_frameSize.y );
     }
 
     wxLogTrace( traceDisplayLocation, "Number of displays: %d", wxDisplay::GetCount() );
 
     if( aState.display >= wxDisplay::GetCount() )
     {
         wxLogTrace( traceDisplayLocation, "Previous display not found" );
 
         // If it isn't attached, use the first display
         // Warning wxDisplay has 2 ctor variants. the parameter needs a type:
         const unsigned int index = 0;
         wxDisplay display( index );
         wxRect    clientSize = display.GetGeometry();
 
         m_framePos = wxDefaultPosition;
 
         // Ensure the window fits on the display, since the other one could have been larger
         if( m_frameSize.x > clientSize.width )
             m_frameSize.x = clientSize.width;
 
         if( m_frameSize.y > clientSize.height )
             m_frameSize.y = clientSize.height;
     }
     else
     {
         wxPoint upperRight( m_framePos.x + m_frameSize.x, m_framePos.y );
         wxPoint upperLeft( m_framePos.x, m_framePos.y );
 
         wxDisplay display( aState.display );
         wxRect clientSize = display.GetClientArea();
 
         // The percentage size (represented in decimal) of the region around the screen's border where
         // an upper corner is not allowed
 #define SCREEN_BORDER_REGION 0.10
 
         int yLim      = clientSize.y + ( clientSize.height * ( 1.0 - SCREEN_BORDER_REGION ) );
         int xLimLeft  = clientSize.x + ( clientSize.width  * SCREEN_BORDER_REGION );
         int xLimRight = clientSize.x + ( clientSize.width  * ( 1.0 - SCREEN_BORDER_REGION ) );
 
         if( upperLeft.x  > xLimRight ||  // Upper left corner too close to right edge of screen
             upperRight.x < xLimLeft  ||  // Upper right corner too close to left edge of screen
             upperRight.y > yLim )        // Upper corner too close to the bottom of the screen
         {
             m_framePos = wxDefaultPosition;
             wxLogTrace( traceDisplayLocation, "Resetting to default position" );
         }
     }
 
     // Ensure Window title bar is visible
 #if defined( __WXOSX__ )
     // for macOSX, the window must be below system (macOSX) toolbar
     int Ypos_min = 20;
 #else
     int Ypos_min = 0;
 #endif
     if( m_framePos.y < Ypos_min )
         m_framePos.y = Ypos_min;
 
     wxLogTrace( traceDisplayLocation, "Final window position (%d, %d) with size (%d, %d)",
                 m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
 
     SetSize( m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
 
     // Center the window if we reset to default
     if( m_framePos.x == -1 )
     {
         wxLogTrace( traceDisplayLocation, "Centering window" );
         Center();
         m_framePos = GetPosition();
     }
 
     // Record the frame sizes in an un-maximized state
     m_normalFrameSize = m_frameSize;
     m_normalFramePos  = m_framePos;
 
     // Maximize if we were maximized before
     if( aState.maximized || ( wasDefault && m_maximizeByDefault ) )
     {
         wxLogTrace( traceDisplayLocation, "Maximizing window" );
         Maximize();
     }
 }

References PCAD2KICAD::Center, WINDOW_STATE::display, m_framePos, m_frameSize, m_maximizeByDefault, m_normalFramePos, m_normalFrameSize, WINDOW_STATE::maximized, WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, s_defaultSize_x, s_defaultSize_y, s_minsize_x, s_minsize_y, SCREEN_BORDER_REGION, WINDOW_STATE::size_x, WINDOW_STATE::size_y, and traceDisplayLocation.

◆ NonUserClose()

bool EDA_BASE_FRAME::NonUserClose ( bool aForce )

inline

Definition at line 635 of file eda_base_frame.h.

     {
         m_isNonUserClose = true;
         return Close( aForce );
     }

References m_isNonUserClose.

Referenced by KIWAY::PlayerClose().

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent & aEvent )

protected

Handle the auto save timer event.

Definition at line 265 of file eda_base_frame.cpp.

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

References doAutoSave(), m_autoSaveInterval, and m_autoSaveTimer.

Referenced by EDA_BASE_FRAME().

◆ OnCharHook()

void EDA_BASE_FRAME::OnCharHook ( wxKeyEvent & event )

virtual

Capture the key event before it is sent to the GUI.

The basic frame does not capture this event. Editor frames should override this event function to capture and filter these keys when they are used as hotkeys, and skip it if the key is not used as hotkey (otherwise the key events will be not sent to menus).

Reimplemented in FOOTPRINT_VIEWER_FRAME.

Definition at line 278 of file eda_base_frame.cpp.

 {
     wxLogTrace( kicadTraceKeyEvent, "EDA_BASE_FRAME::OnCharHook %s", dump( event ) );
     // Key events can be filtered here.
     // Currently no filtering is made.
     event.Skip();
 }

References dump(), and kicadTraceKeyEvent.

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent & event )

Definition at line 783 of file eda_base_frame.cpp.

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

References ShowAboutDialog().

◆ OnMaximize()

void EDA_BASE_FRAME::OnMaximize ( wxMaximizeEvent & aEvent )

Definition at line 980 of file eda_base_frame.cpp.

 {
     // When we maximize the window, we want to save the old information
     // so that we can add it to the settings on next window load.
     // Contrary to the documentation, this event seems to be generated
     // when the window is also being unmaximized on OSX, so we only
     // capture the size information when we maximize the window when on OSX.
 #ifdef __WXOSX__
     if( !IsMaximized() )
 #endif
     {
         m_normalFrameSize = GetWindowSize();
         m_normalFramePos  = GetPosition();
         wxLogTrace( traceDisplayLocation, "Maximizing window - Saving position (%d, %d) with size (%d, %d)",
                     m_normalFramePos.x, m_normalFramePos.y, m_normalFrameSize.x, m_normalFrameSize.y );
     }
 
     // Skip event to actually maximize the window
     aEvent.Skip();
 }

References GetWindowSize(), m_normalFramePos, m_normalFrameSize, and traceDisplayLocation.

◆ OnMenuEvent()

void EDA_BASE_FRAME::OnMenuEvent ( wxMenuEvent & event )

The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves.

Definition at line 287 of file eda_base_frame.cpp.

 {
     if( !m_toolDispatcher )
         aEvent.Skip();
     else
         m_toolDispatcher->DispatchWxEvent( aEvent );
 }

References TOOL_DISPATCHER::DispatchWxEvent(), and TOOLS_HOLDER::m_toolDispatcher.

◆ OnMove()

virtual void EDA_BASE_FRAME::OnMove ( wxMoveEvent & aEvent )

inlinevirtual

Reimplemented in EDA_DRAW_FRAME.

Definition at line 306 of file eda_base_frame.h.

     {
         aEvent.Skip();
     }

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent & event )

Definition at line 790 of file eda_base_frame.cpp.

 {
     PAGED_DIALOG dlg( this, _( "Preferences" ), true );
     wxTreebook* book = dlg.GetTreebook();
 
     book->AddPage( new PANEL_COMMON_SETTINGS( &dlg, book ), _( "Common" ) );
 
     book->AddPage( new PANEL_MOUSE_SETTINGS( &dlg, book ), _( "Mouse and Touchpad" ) );
 
     PANEL_HOTKEYS_EDITOR* hotkeysPanel = new PANEL_HOTKEYS_EDITOR( this, book, false );
     book->AddPage( hotkeysPanel, _( "Hotkeys" ) );
 
     for( unsigned i = 0; i < KIWAY_PLAYER_COUNT;  ++i )
     {
         KIWAY_PLAYER* frame = dlg.Kiway().Player( (FRAME_T) i, false );
 
         if( frame )
             frame->InstallPreferences( &dlg, hotkeysPanel );
     }
 
     // The Kicad manager frame is not a player so we have to add it by hand
     wxWindow* manager = wxFindWindowByName( KICAD_MANAGER_FRAME_NAME );
 
     if( manager )
         static_cast<EDA_BASE_FRAME*>( manager )->InstallPreferences( &dlg, hotkeysPanel );
 
     for( size_t i = 0; i < book->GetPageCount(); ++i )
         book->GetPage( i )->Layout();
 
     if( dlg.ShowModal() == wxID_OK )
         dlg.Kiway().CommonSettingsChanged( false, false );
 }

References _, KIWAY::CommonSettingsChanged(), PAGED_DIALOG::GetTreebook(), InstallPreferences(), KICAD_MANAGER_FRAME_NAME, KIWAY_HOLDER::Kiway(), KIWAY_PLAYER_COUNT, and KIWAY::Player().

Referenced by APPEARANCE_CONTROLS::onReadOnlySwatch().

◆ PopCommandFromRedoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromRedoList ( )

virtual

PopCommandFromRedoList return the last command to undo and remove it from list nothing is deleted.

Definition at line 964 of file eda_base_frame.cpp.

 {
     return m_redoList.PopCommand();
 }

References m_redoList, and UNDO_REDO_CONTAINER::PopCommand().

Referenced by PL_EDITOR_FRAME::GetLayoutFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), and SCH_EDITOR_CONTROL::Redo().

◆ PopCommandFromUndoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromUndoList ( )

virtual

PopCommandFromUndoList return the last command to undo and remove it from list nothing is deleted.

Definition at line 958 of file eda_base_frame.cpp.

 {
     return m_undoList.PopCommand();
 }

References m_undoList, and UNDO_REDO_CONTAINER::PopCommand().

Referenced by LIB_PIN_TOOL::EditPinProperties(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), PCB_EDITOR_CONTROL::PlaceModule(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_FRAME::RollbackSchematicFromUndo(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), SCH_EDIT_FRAME::SaveCopyInUndoList(), and SCH_EDITOR_CONTROL::Undo().

◆ PopTool()

void TOOLS_HOLDER::PopTool ( const std::string & actionName )

virtualinherited

Definition at line 61 of file tools_holder.cpp.

 {
     // Push/pop events can get out of order (such as when they're generated by the Simulator
     // frame but not processed until the mouse is back in the Schematic frame), so make sure
     // we're popping the right stack frame.
 
     for( int i = (int) m_toolStack.size() - 1; i >= 0; --i )
     {
         if( m_toolStack[ i ] == actionName )
         {
             m_toolStack.erase( m_toolStack.begin() + i );
 
             // If there's something underneath us, and it's now the top of the stack, then
             // re-activate it
             if( ( --i ) >= 0 && i == (int)m_toolStack.size() - 1 )
             {
                 std::string  back = m_toolStack[ i ];
                 TOOL_ACTION* action = m_toolManager->GetActionManager()->FindAction( back );
 
                 if( action )
                 {
                     // Pop the action as running it will push it back onto the stack
                     m_toolStack.pop_back();
 
                     TOOL_EVENT evt = action->MakeEvent();
                     evt.SetHasPosition( false );
                     GetToolManager()->PostEvent( evt );
                 }
             }
             else
                 DisplayToolMsg( ACTIONS::selectionTool.GetLabel() );
 
             return;
         }
     }
 }

References TOOLS_HOLDER::DisplayToolMsg(), ACTION_MANAGER::FindAction(), TOOL_MANAGER::GetActionManager(), TOOLS_HOLDER::GetToolManager(), TOOLS_HOLDER::m_toolManager, TOOLS_HOLDER::m_toolStack, TOOL_ACTION::MakeEvent(), TOOL_MANAGER::PostEvent(), ACTIONS::selectionTool, and TOOL_EVENT::SetHasPosition().

Referenced by EDIT_TOOL::copyToClipboard(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), LIB_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), LIB_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), PCBNEW_PICKER_TOOL::Main(), PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), LIB_DRAWING_TOOLS::PlaceAnchor(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), LIB_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ PrintMsg()

void EDA_BASE_FRAME::PrintMsg ( const wxString & text )

Definition at line 680 of file eda_base_frame.cpp.

 {
     SetStatusText( text );
 }

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const

inherited

Function Prj returns a reference to the PROJECT "associated with" this KIWAY.

Definition at line 35 of file kiway_holder.cpp.

 {
     return Kiway().Prj();
 }

References KIWAY_HOLDER::Kiway(), and KIWAY::Prj().

◆ ProcessEvent()

bool EDA_BASE_FRAME::ProcessEvent ( wxEvent & aEvent )

override

Override 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 207 of file eda_base_frame.cpp.

 {
 #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;
 }

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

Referenced by COMMON_TOOLS::GridProperties(), LIB_VIEW_FRAME::onSelectNextSymbol(), LIB_VIEW_FRAME::onSelectPreviousSymbol(), KIWAY::ProcessEvent(), and LIB_VIEW_FRAME::ReCreateListCmp().

◆ ProjectChanged()

virtual void EDA_BASE_FRAME::ProjectChanged ( )

inlinevirtual

Notification event that the project has changed.

Reimplemented in PCB_EDIT_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 552 of file eda_base_frame.h.

552 {}

Referenced by KIWAY::ProjectChanged().

◆ PushCommandToRedoList()

void EDA_BASE_FRAME::PushCommandToRedoList ( PICKED_ITEMS_LIST * aItem )

virtual

Function PushCommandToRedoList add a command to redo in redo list delete the very old commands when the max count of redo commands is reached ( using ClearUndoORRedoList)

Definition at line 943 of file eda_base_frame.cpp.

 {
     m_redoList.PushCommand( aNewitem );
 
     // Delete the extra items, if count max reached
     if( m_undoRedoCountMax > 0 )
     {
         int extraitems = GetRedoCommandCount() - m_undoRedoCountMax;
 
         if( extraitems > 0 )
             ClearUndoORRedoList( REDO_LIST, extraitems );
     }
 }

References ClearUndoORRedoList(), GetRedoCommandCount(), m_redoList, m_undoRedoCountMax, UNDO_REDO_CONTAINER::PushCommand(), and REDO_LIST.

Referenced by PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), and SCH_EDITOR_CONTROL::Undo().

◆ PushCommandToUndoList()

void EDA_BASE_FRAME::PushCommandToUndoList ( PICKED_ITEMS_LIST * aItem )

virtual

Function PushCommandToUndoList add a command to undo in undo list delete the very old commands when the max count of undo commands is reached ( using ClearUndoORRedoList)

Definition at line 928 of file eda_base_frame.cpp.

 {
     m_undoList.PushCommand( aNewitem );
 
     // Delete the extra items, if count max reached
     if( m_undoRedoCountMax > 0 )
     {
         int extraitems = GetUndoCommandCount() - m_undoRedoCountMax;
 
         if( extraitems > 0 )
             ClearUndoORRedoList( UNDO_LIST, extraitems );
     }
 }

References ClearUndoORRedoList(), GetUndoCommandCount(), m_undoList, m_undoRedoCountMax, UNDO_REDO_CONTAINER::PushCommand(), and UNDO_LIST.

Referenced by PL_EDITOR_FRAME::GetLayoutFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SCH_EDITOR_CONTROL::Redo(), PL_EDITOR_FRAME::SaveCopyInUndoList(), SYMBOL_EDIT_FRAME::SaveCopyInUndoList(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ PushTool()

void TOOLS_HOLDER::PushTool ( const std::string & actionName )

virtualinherited

NB: the definition of "tool" is different at the user level.

The implementation uses a single TOOL_BASE derived class to implement several user "tools", such as rectangle and circle, or wire and bus. So each user-level tool is actually a TOOL_ACTION.

Definition at line 44 of file tools_holder.cpp.

 {
     m_toolStack.push_back( actionName );
 
     // Human cognitive stacking is very shallow; deeper tool stacks just get annoying
     if( m_toolStack.size() > 3 )
         m_toolStack.erase( m_toolStack.begin() );
 
     TOOL_ACTION* action = m_toolManager->GetActionManager()->FindAction( actionName );
 
     if( action )
         DisplayToolMsg( action->GetLabel() );
     else
         DisplayToolMsg( actionName );
 }

References TOOLS_HOLDER::DisplayToolMsg(), ACTION_MANAGER::FindAction(), TOOL_MANAGER::GetActionManager(), TOOL_ACTION::GetLabel(), TOOLS_HOLDER::m_toolManager, and TOOLS_HOLDER::m_toolStack.

Referenced by EDIT_TOOL::copyToClipboard(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), LIB_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), LIB_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), PCBNEW_PICKER_TOOL::Main(), PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), LIB_DRAWING_TOOLS::PlaceAnchor(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), LIB_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ ReCreateMenuBar()

void EDA_BASE_FRAME::ReCreateMenuBar ( )

virtual

Recreates the menu bar.

Needed when the language is changed

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

Definition at line 383 of file eda_base_frame.cpp.

384 {

385 }

Referenced by ClearFileHistory(), CommonSettingsChanged(), GetFileFromHistory(), ShowChangedLanguage(), and UpdateFileHistory().

◆ RefreshCanvas()

virtual void TOOLS_HOLDER::RefreshCanvas ( )

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 171 of file tools_holder.h.

171 { }

Referenced by TOOL_MANAGER::ProcessEvent().

◆ RegisterUIUpdateHandler() [1/2]

virtual void TOOLS_HOLDER::RegisterUIUpdateHandler	(	const TOOL_ACTION &	aAction,
		const ACTION_CONDITIONS &	aConditions
	)

inlinevirtualinherited

Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls.

Parameters

aAction	is the action to register
aConditions	are the UI conditions to use for the control states

Definition at line 85 of file tools_holder.h.

     {
         RegisterUIUpdateHandler( aAction.GetUIId(), aConditions );
     }

References TOOL_ACTION::GetUIId().

Referenced by ACTION_TOOLBAR::doSelectAction(), and ACTION_MANAGER::SetConditions().

◆ RegisterUIUpdateHandler() [2/2]

void EDA_BASE_FRAME::RegisterUIUpdateHandler	(	int	aID,
		const ACTION_CONDITIONS &	aConditions
	)

overridevirtual

Register a UI update handler for the control with ID aID.

Parameters

aID	is the control ID to register the handler for
aConditions	are the UI conditions to use for the control states

Reimplemented from TOOLS_HOLDER.

Definition at line 296 of file eda_base_frame.cpp.

 {
     UIUpdateHandler evtFunc = std::bind( &EDA_BASE_FRAME::HandleUpdateUIEvent,
                                          std::placeholders::_1,
                                          this,
                                          aConditions );
 
     m_uiUpdateMap[aID] = evtFunc;
 
     Bind( wxEVT_UPDATE_UI, evtFunc, aID );
 }

References HandleUpdateUIEvent(), and m_uiUpdateMap.

Referenced by KICAD_MANAGER_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), EDA_3D_VIEWER::setupUIConditions(), KICAD_MANAGER_FRAME::setupUIConditions(), setupUIConditions(), and SYMBOL_EDIT_FRAME::setupUIConditions().

◆ SaveProjectSettings()

virtual void EDA_BASE_FRAME::SaveProjectSettings ( )

inlinevirtual

Save 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 417 of file eda_base_frame.h.

417 {};

Referenced by DIALOG_PAGES_SETTINGS::OnOkClick().

◆ SaveSettings()

void EDA_BASE_FRAME::SaveSettings ( APP_SETTINGS_BASE * aCfg )

virtual

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, CVPCB_MAINFRAME, SYMBOL_EDIT_FRAME, SIM_PLOT_FRAME, FOOTPRINT_WIZARD_FRAME, PL_EDITOR_FRAME, EDA_3D_VIEWER, SCH_EDIT_FRAME, BM2CMP_FRAME, FOOTPRINT_VIEWER_FRAME, KICAD_MANAGER_FRAME, SCH_BASE_FRAME, LIB_VIEW_FRAME, PCB_CALCULATOR_FRAME, FOOTPRINT_EDIT_FRAME, and DISPLAY_FOOTPRINTS_FRAME.

Definition at line 628 of file eda_base_frame.cpp.

 {
     SaveWindowSettings( GetWindowSettings( aCfg ) );
 
     bool fileOpen = m_isClosing && m_isNonUserClose;
 
     wxString currentlyOpenedFile = GetCurrentFileName();
 
     if( Pgm().GetCommonSettings()->m_Session.remember_open_files && !currentlyOpenedFile.IsEmpty() )
     {
         wxFileName rfn( currentlyOpenedFile );
         rfn.MakeRelativeTo( Prj().GetProjectPath() );
         Prj().GetLocalSettings().SaveFileState( rfn.GetFullPath(), &aCfg->m_Window, fileOpen );
     }
 
     // Save the recently used files list
     if( m_fileHistory )
     {
         // Save the currently opened file in the file history
         if( !currentlyOpenedFile.IsEmpty() )
             UpdateFileHistory( currentlyOpenedFile );
 
         m_fileHistory->Save( *aCfg );
     }
 }

References GetCurrentFileName(), PROJECT::GetLocalSettings(), GetWindowSettings(), m_fileHistory, m_isClosing, m_isNonUserClose, APP_SETTINGS_BASE::m_Window, Pgm(), KIWAY_HOLDER::Prj(), FILE_HISTORY::Save(), PROJECT_LOCAL_SETTINGS::SaveFileState(), SaveWindowSettings(), and UpdateFileHistory().

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

◆ SaveWindowSettings()

void EDA_BASE_FRAME::SaveWindowSettings ( WINDOW_SETTINGS * aCfg )

Saves window settings to the given settings object Normally called by SaveSettings unless the window in question is a child window that stores its settings somewhere other than APP_SETTINGS_BASE::m_Window.

Definition at line 569 of file eda_base_frame.cpp.

 {
     wxString        text;
 
     if( IsIconized() )
         return;
 
     wxString baseCfgName = ConfigBaseName();
 
     // If the window is maximized, we use the saved window size from before it was maximized
     if( IsMaximized() )
     {
         m_framePos  = m_normalFramePos;
         m_frameSize = m_normalFrameSize;
     }
     else
     {
         m_frameSize = GetWindowSize();
         m_framePos  = GetPosition();
     }
 
     aCfg->state.pos_x     = m_framePos.x;
     aCfg->state.pos_y     = m_framePos.y;
     aCfg->state.size_x    = m_frameSize.x;
     aCfg->state.size_y    = m_frameSize.y;
     aCfg->state.maximized = IsMaximized();
     aCfg->state.display   = wxDisplay::GetFromWindow( this );
 
     wxLogTrace( traceDisplayLocation, "Saving window maximized: %s", IsMaximized() ? "true" : "false" );
     wxLogTrace( traceDisplayLocation, "Saving config position (%d, %d) with size (%d, %d)",
                 m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
 
     // TODO(JE) should auto-save in common settings be overwritten by every app?
     if( m_hasAutoSave )
         Pgm().GetCommonSettings()->m_System.autosave_interval = 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.
     aCfg->perspective = m_auimgr.SavePerspective().ToStdString();
 
     aCfg->mru_path = m_mruPath;
 }

References ConfigBaseName(), WINDOW_STATE::display, GetWindowSize(), m_auimgr, m_autoSaveInterval, m_framePos, m_frameSize, m_hasAutoSave, m_mruPath, m_normalFramePos, m_normalFrameSize, WINDOW_STATE::maximized, WINDOW_SETTINGS::mru_path, WINDOW_SETTINGS::perspective, Pgm(), WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, WINDOW_STATE::size_x, WINDOW_STATE::size_y, WINDOW_SETTINGS::state, and traceDisplayLocation.

Referenced by SaveSettings().

◆ SetAutoSaveInterval()

void EDA_BASE_FRAME::SetAutoSaveInterval ( int aInterval )

Definition at line 246 of file eda_base_frame.cpp.

 {
     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;
         }
     }
 }

References m_autoSaveInterval, m_autoSaveState, and m_autoSaveTimer.

Referenced by EDA_DRAW_FRAME::CommonSettingsChanged().

◆ SetKiway()

void KIWAY_HOLDER::SetKiway	(	wxWindow *	aDest,
		KIWAY *	aKiway
	)

inherited

Function SetKiway.

Parameters

aDest	is the recipient of aKiway pointer. It is only used for debugging, since "this" is not a wxWindow*. "this" is a KIWAY_HOLDER mix-in.
aKiway	is often from a parent window, or from KIFACE::CreateWindow().

Definition at line 42 of file kiway_holder.cpp.

 {
 #if defined(DEBUG)
     // offer a trap point for debugging most any window
     wxASSERT( aDest );
     if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
     {
         int breakhere=1;
         (void) breakhere;
     }
 #endif
 
     (void) aDest;
 
     m_kiway = aKiway;
 }

References KIWAY_HOLDER::m_kiway, and name.

Referenced by BM2CMP_FRAME::BM2CMP_FRAME(), PCB::IFACE::CreateWindow(), InvokePcbLibTableEditor(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

◆ SetMruPath()

void EDA_BASE_FRAME::SetMruPath ( const wxString & aPath )

inline

Definition at line 475 of file eda_base_frame.h.

475 { m_mruPath = aPath; }

EDA_BASE_FRAME::m_mruPath

wxString m_mruPath

Definition: eda_base_frame.h:163

References m_mruPath.

Referenced by GERBVIEW_CONTROL::ExportToPcbnew(), PANEL_HOTKEYS_EDITOR::ImportHotKeys(), and KICAD_MANAGER_FRAME::LoadProject().

◆ setupUIConditions()

void EDA_BASE_FRAME::setupUIConditions ( )

protectedvirtual

Setup the UI conditions for the various actions and their controls in this frame.

Reimplemented in FOOTPRINT_EDIT_FRAME, SYMBOL_EDIT_FRAME, SCH_EDIT_FRAME, KICAD_MANAGER_FRAME, EDA_3D_VIEWER, GERBVIEW_FRAME, LIB_VIEW_FRAME, DISPLAY_FOOTPRINTS_FRAME, PCB_EDIT_FRAME, CVPCB_MAINFRAME, PL_EDITOR_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 363 of file eda_base_frame.cpp.

 {
     // Setup the conditions to check a language menu item
     auto isCurrentLang =
         [] ( const SELECTION& aSel, int aLangIdentifier )
         {
             return Pgm().GetSelectedLanguageIdentifier() == aLangIdentifier;
         };
 
     for( unsigned ii = 0;  LanguagesList[ii].m_KI_Lang_Identifier != 0; ii++ )
     {
         ACTION_CONDITIONS cond;
         cond.Check( std::bind( isCurrentLang, std::placeholders::_1,
                                LanguagesList[ii].m_WX_Lang_Identifier ) );
 
         RegisterUIUpdateHandler( LanguagesList[ii].m_KI_Lang_Identifier, cond );
     }
 }

References ACTION_CONDITIONS::Check(), LanguagesList, LANGUAGE_DESCR::m_KI_Lang_Identifier, Pgm(), and RegisterUIUpdateHandler().

Referenced by FOOTPRINT_VIEWER_FRAME::setupUIConditions(), PL_EDITOR_FRAME::setupUIConditions(), CVPCB_MAINFRAME::setupUIConditions(), PCB_EDIT_FRAME::setupUIConditions(), DISPLAY_FOOTPRINTS_FRAME::setupUIConditions(), LIB_VIEW_FRAME::setupUIConditions(), GERBVIEW_FRAME::setupUIConditions(), EDA_3D_VIEWER::setupUIConditions(), KICAD_MANAGER_FRAME::setupUIConditions(), SCH_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), and FOOTPRINT_EDIT_FRAME::setupUIConditions().

◆ SetUserUnits()

void EDA_BASE_FRAME::SetUserUnits ( EDA_UNITS aUnits )

inline

Definition at line 244 of file eda_base_frame.h.

     {
         m_userUnits = aUnits;
     }

References m_userUnits.

Referenced by ChangeUserUnits(), EDA_DRAW_FRAME::LoadSettings(), and EDA_DRAW_FRAME::ToggleUserUnits().

◆ ShowChangedLanguage()

void EDA_BASE_FRAME::ShowChangedLanguage ( )

virtual

Redraw the menus and what not in current language.

Reimplemented in SCH_EDIT_FRAME, PCB_EDIT_FRAME, SYMBOL_EDIT_FRAME, GERBVIEW_FRAME, FOOTPRINT_EDIT_FRAME, PCB_BASE_FRAME, CVPCB_MAINFRAME, and KICAD_MANAGER_FRAME.

Definition at line 406 of file eda_base_frame.cpp.

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

References ReCreateMenuBar().

Referenced by KIWAY::SetLanguage(), KICAD_MANAGER_FRAME::ShowChangedLanguage(), CVPCB_MAINFRAME::ShowChangedLanguage(), PCB_BASE_FRAME::ShowChangedLanguage(), GERBVIEW_FRAME::ShowChangedLanguage(), SYMBOL_EDIT_FRAME::ShowChangedLanguage(), and SCH_EDIT_FRAME::ShowChangedLanguage().

◆ ShowInfoBarError()

void EDA_BASE_FRAME::ShowInfoBarError ( const wxString & aErrorMsg )

Definition at line 686 of file eda_base_frame.cpp.

 {
     m_infoBar->RemoveAllButtons();
     GetInfoBar()->ShowMessageFor( aErrorMsg, 8000, wxICON_ERROR );
 }

References GetInfoBar(), m_infoBar, WX_INFOBAR::RemoveAllButtons(), and WX_INFOBAR::ShowMessageFor().

Referenced by SCH_EDITOR_CONTROL::AssignNetclass(), MICROWAVE_TOOL::createInductorBetween(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), MICROWAVE_TOOL::createPolygonShape(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), SYMBOL_EDIT_FRAME::ExportPart(), PCB_INSPECTION_TOOL::InspectClearance(), PCB_INSPECTION_TOOL::InspectConstraints(), ROUTER_TOOL::onViaCommand(), ROUTER_TOOL::prepareInteractive(), GERBVIEW_FRAME::Read_EXCELLON_File(), GERBVIEW_FRAME::Read_GERBER_File(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SYMBOL_EDIT_FRAME::saveLibrary(), and SYMBOL_EDIT_FRAME::SelectLibraryFromList().

◆ ShowInfoBarMsg()

void EDA_BASE_FRAME::ShowInfoBarMsg ( const wxString & aMsg )

Definition at line 700 of file eda_base_frame.cpp.

 {
     m_infoBar->RemoveAllButtons();
     GetInfoBar()->ShowMessageFor( aMsg, 10000, wxICON_INFORMATION );
 }

References GetInfoBar(), m_infoBar, WX_INFOBAR::RemoveAllButtons(), and WX_INFOBAR::ShowMessageFor().

Referenced by EDIT_TOOL::FilletTracks(), and DIALOG_FIND::search().

◆ ShowInfoBarWarning()

void EDA_BASE_FRAME::ShowInfoBarWarning ( const wxString & aWarningMsg )

Definition at line 693 of file eda_base_frame.cpp.

 {
     m_infoBar->RemoveAllButtons();
     GetInfoBar()->ShowMessageFor( aWarningMsg, 8000, wxICON_WARNING );
 }

References GetInfoBar(), m_infoBar, WX_INFOBAR::RemoveAllButtons(), and WX_INFOBAR::ShowMessageFor().

Referenced by DIALOG_PAD_PROPERTIES::padValuesOK().

◆ sys_search()

const SEARCH_STACK & EDA_BASE_FRAME::sys_search ( )

virtual

Return a SEARCH_STACK pertaining to entire program.

This is overloaded in KICAD_MANAGER_FRAME

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 668 of file eda_base_frame.cpp.

 {
     return Kiface().KifaceSearch();
 }

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

Referenced by COMMON_CONTROL::ShowHelp().

◆ ToggleUserUnits()

virtual void EDA_BASE_FRAME::ToggleUserUnits ( )

inlinevirtual

Reimplemented in EDA_DRAW_FRAME.

Definition at line 251 of file eda_base_frame.h.

251 { }

Referenced by DIALOG_SHIM::OnCharHook().

◆ ToolStackIsEmpty()

bool TOOLS_HOLDER::ToolStackIsEmpty ( )

inlineinherited

Definition at line 136 of file tools_holder.h.

136 { return m_toolStack.empty(); }

TOOLS_HOLDER::m_toolStack

std::vector< std::string > m_toolStack

Definition: tools_holder.h:54

References TOOLS_HOLDER::m_toolStack.

Referenced by PCB_VIEWER_TOOLS::Init(), PCB_EDITOR_CONTROL::Init(), SELECTION_TOOL::Init(), EDIT_TOOL::Init(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PL_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), SELECTION_TOOL::Main(), EDITOR_CONDITIONS::noToolFunc(), EE_SELECTION_TOOL::OnIdle(), EE_POINT_EDITOR::setEditedPoint(), PL_POINT_EDITOR::setEditedPoint(), PCB_EDITOR_CONTROL::TrackWidthDec(), PCB_EDITOR_CONTROL::TrackWidthInc(), PCB_EDITOR_CONTROL::ViaSizeDec(), and PCB_EDITOR_CONTROL::ViaSizeInc().

◆ unitsChangeRefresh()

virtual void EDA_BASE_FRAME::unitsChangeRefresh ( )

inlineprotectedvirtual

Called when when the units setting has changed to allow for any derived classes to handle refreshing and controls that have units based measurements in them.

The default version only updates the status bar. Don't forget to call the default in your derived class or the status bar will not get updated properly.

Reimplemented in PCB_BASE_EDIT_FRAME, GERBVIEW_FRAME, EDA_DRAW_FRAME, and PCB_BASE_FRAME.

Definition at line 220 of file eda_base_frame.h.

220 { }

Referenced by ChangeUserUnits().

◆ UnregisterUIUpdateHandler() [1/2]

virtual void TOOLS_HOLDER::UnregisterUIUpdateHandler ( const TOOL_ACTION & aAction )

inlinevirtualinherited

Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler.

Parameters

aAction is the action to unregister the handler for

Definition at line 105 of file tools_holder.h.

     {
         UnregisterUIUpdateHandler( aAction.GetUIId() );
     }

References TOOL_ACTION::GetUIId().

Referenced by ACTION_TOOLBAR::doSelectAction(), and ACTION_MANAGER::SetConditions().

◆ UnregisterUIUpdateHandler() [2/2]

void EDA_BASE_FRAME::UnregisterUIUpdateHandler ( int aID )

overridevirtual

Unregister a UI handler for a given ID that was registered using RegisterUIUpdateHandler.

Parameters

aID	is the control ID to unregister the handler for

Reimplemented from TOOLS_HOLDER.

Definition at line 309 of file eda_base_frame.cpp.

 {
     const auto it = m_uiUpdateMap.find( aID );
 
     if( it == m_uiUpdateMap.end() )
         return;
 
     Unbind( wxEVT_UPDATE_UI, it->second, aID );
 }

References m_uiUpdateMap.

◆ UpdateFileHistory()

void EDA_BASE_FRAME::UpdateFileHistory	(	const wxString &	FullFileName,
		FILE_HISTORY *	aFileHistory = `nullptr`
	)

Update the list of recently opened files.

The menu is also updated, if FILE_HISTORY::UseMenu was called at init time.

Parameters

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

Definition at line 707 of file eda_base_frame.cpp.

 {
     if( !aFileHistory )
         aFileHistory = m_fileHistory;
 
     wxASSERT( aFileHistory );
 
     aFileHistory->AddFileToHistory( FullFileName );
 
     // Update the menubar to update the file history menu
     if( !m_isClosing && GetMenuBar() )
     {
         ReCreateMenuBar();
         GetMenuBar()->Refresh();
     }
 }

References FILE_HISTORY::AddFileToHistory(), m_fileHistory, m_isClosing, and ReCreateMenuBar().

Referenced by KICAD_MANAGER_FRAME::CreateNewProject(), SCH_EDIT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::importFile(), GERBVIEW_FRAME::LoadExcellonFiles(), GERBVIEW_FRAME::LoadGerberJobFile(), GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles(), PL_EDITOR_FRAME::LoadPageLayoutDescrFile(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), SaveSettings(), and GERBVIEW_FRAME::unarchiveFiles().

◆ UpdateStatusBar()

virtual void EDA_BASE_FRAME::UpdateStatusBar ( )

inlinevirtual

Update the status bar information.

The status bar can draw itself. This is not a drawing function per se, but rather updates lines of text held by the components within the status bar which is owned by the wxFrame.

Reimplemented in EDA_DRAW_FRAME, PCB_BASE_FRAME, GERBVIEW_FRAME, SCH_BASE_FRAME, and PL_EDITOR_FRAME.

Definition at line 536 of file eda_base_frame.h.

536 { }

Referenced by TOOL_MANAGER::UpdateUI().

◆ windowClosing()

void EDA_BASE_FRAME::windowClosing ( wxCloseEvent & event )

private

(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 147 of file eda_base_frame.cpp.

 {
     // 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();
 
         if( event.CanVeto() )
             event.Veto();
 
         return;
     }
 
 
     if( event.GetId() == wxEVT_QUERY_END_SESSION
         || event.GetId() == wxEVT_END_SESSION )
     {
         // End session means the OS is going to terminate us
         m_isNonUserClose = true;
     }
 
     if( canCloseWindow( event ) )
     {
         m_isClosing = true;
         APP_SETTINGS_BASE* cfg = config();
 
         if( cfg )
             SaveSettings( cfg );    // virtual, wxFrame specific
 
         doCloseWindow();
 
         // Destroy (safe delete frame) this frame only in non modal mode.
         // In modal mode, the caller will call Destroy().
         if( !IsModal() )
             Destroy();
     }
     else
     {
         if( event.CanVeto() )
             event.Veto();
     }
 }

References canCloseWindow(), config(), doCloseWindow(), findQuasiModalDialog(), IsModal(), m_isClosing, m_isNonUserClose, and SaveSettings().

Referenced by EDA_BASE_FRAME().

Member Data Documentation

◆ KICAD_AUI_TB_STYLE

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 174 of file eda_base_frame.h.

Referenced by 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(), FOOTPRINT_WIZARD_FRAME::ReCreateHToolbar(), SCH_EDIT_FRAME::ReCreateHToolbar(), CVPCB_MAINFRAME::ReCreateHToolbar(), GERBVIEW_FRAME::ReCreateHToolbar(), SYMBOL_EDIT_FRAME::ReCreateHToolbar(), PCB_EDIT_FRAME::ReCreateHToolbar(), KICAD_MANAGER_FRAME::RecreateLauncher(), EDA_3D_VIEWER::ReCreateMainToolbar(), DISPLAY_FOOTPRINTS_FRAME::ReCreateOptToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateOptToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateOptToolbar(), SCH_EDIT_FRAME::ReCreateOptToolbar(), SYMBOL_EDIT_FRAME::ReCreateOptToolbar(), GERBVIEW_FRAME::ReCreateOptToolbar(), PCB_EDIT_FRAME::ReCreateOptToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateVToolbar(), PL_EDITOR_FRAME::ReCreateVToolbar(), SCH_EDIT_FRAME::ReCreateVToolbar(), SYMBOL_EDIT_FRAME::ReCreateVToolbar(), and PCB_EDIT_FRAME::ReCreateVToolbar().

◆ m_aboutTitle

wxString EDA_BASE_FRAME::m_aboutTitle

protected

Definition at line 139 of file eda_base_frame.h.

Referenced by CVPCB_MAINFRAME::CVPCB_MAINFRAME(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), GetAboutTitle(), and LIB_VIEW_FRAME::LIB_VIEW_FRAME().

◆ m_actions

ACTIONS* TOOLS_HOLDER::m_actions

protectedinherited

Definition at line 49 of file tools_holder.h.

Referenced by FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), PANEL_PREV_3D::PANEL_PREV_3D(), PL_EDITOR_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupTools(), LIB_VIEW_FRAME::setupTools(), KICAD_MANAGER_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), SYMBOL_EDIT_FRAME::setupTools(), CVPCB_MAINFRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), CVPCB_MAINFRAME::~CVPCB_MAINFRAME(), EDA_DRAW_FRAME::~EDA_DRAW_FRAME(), and KICAD_MANAGER_FRAME::~KICAD_MANAGER_FRAME().

◆ m_auimgr

wxAuiManager EDA_BASE_FRAME::m_auimgr

protected

Definition at line 141 of file eda_base_frame.h.

Referenced by CVPCB_MAINFRAME::CVPCB_MAINFRAME(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), FOOTPRINT_EDIT_FRAME::IsSearchTreeShown(), SYMBOL_EDIT_FRAME::IsSearchTreeShown(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), KICAD_MANAGER_FRAME::OnSize(), LIB_VIEW_FRAME::OnSize(), FOOTPRINT_WIZARD_FRAME::OnSize(), FOOTPRINT_VIEWER_FRAME::OnSize(), SYMBOL_EDIT_FRAME::OnToggleSearchTree(), 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(), FOOTPRINT_WIZARD_FRAME::ReCreateHToolbar(), SCH_EDIT_FRAME::ReCreateHToolbar(), CVPCB_MAINFRAME::ReCreateHToolbar(), GERBVIEW_FRAME::ReCreateHToolbar(), SYMBOL_EDIT_FRAME::ReCreateHToolbar(), PCB_EDIT_FRAME::ReCreateHToolbar(), KICAD_MANAGER_FRAME::RecreateLauncher(), FOOTPRINT_EDIT_FRAME::ReCreateLayerBox(), PCB_EDIT_FRAME::ReCreateLayerBox(), EDA_3D_VIEWER::ReCreateMainToolbar(), DISPLAY_FOOTPRINTS_FRAME::ReCreateOptToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateOptToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateOptToolbar(), SCH_EDIT_FRAME::ReCreateOptToolbar(), SYMBOL_EDIT_FRAME::ReCreateOptToolbar(), GERBVIEW_FRAME::ReCreateOptToolbar(), PCB_EDIT_FRAME::ReCreateOptToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateVToolbar(), PL_EDITOR_FRAME::ReCreateVToolbar(), SCH_EDIT_FRAME::ReCreateVToolbar(), SYMBOL_EDIT_FRAME::ReCreateVToolbar(), PCB_EDIT_FRAME::ReCreateVToolbar(), GERBVIEW_FRAME::ReFillLayerWidget(), CVPCB_MAINFRAME::refreshAfterComponentSearch(), FOOTPRINT_WIZARD_FRAME::SaveSettings(), SaveWindowSettings(), PCB_BASE_FRAME::SetDrawBgColor(), FOOTPRINT_EDIT_FRAME::ShowChangedLanguage(), GERBVIEW_FRAME::ShowChangedLanguage(), GERBVIEW_FRAME::ToggleLayerManager(), PCB_EDIT_FRAME::ToggleLayersManager(), FOOTPRINT_EDIT_FRAME::ToggleSearchTree(), GERBVIEW_FRAME::updateDCodeSelectBox(), GERBVIEW_FRAME::UpdateTitleAndInfo(), CVPCB_MAINFRAME::~CVPCB_MAINFRAME(), EDA_3D_VIEWER::~EDA_3D_VIEWER(), EDA_DRAW_FRAME::~EDA_DRAW_FRAME(), and KICAD_MANAGER_FRAME::~KICAD_MANAGER_FRAME().

◆ m_autoSaveInterval

int EDA_BASE_FRAME::m_autoSaveInterval

protected

Definition at line 155 of file eda_base_frame.h.

Referenced by GetAutoSaveInterval(), LoadWindowSettings(), onAutoSaveTimer(), ProcessEvent(), SaveWindowSettings(), and SetAutoSaveInterval().

◆ m_autoSaveState

bool EDA_BASE_FRAME::m_autoSaveState

protected

Definition at line 154 of file eda_base_frame.h.

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

◆ m_autoSaveTimer

wxTimer* EDA_BASE_FRAME::m_autoSaveTimer

protected

Definition at line 156 of file eda_base_frame.h.

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

◆ m_configName

wxString EDA_BASE_FRAME::m_configName

protected

Definition at line 146 of file eda_base_frame.h.

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

◆ m_dragSelects

bool TOOLS_HOLDER::m_dragSelects

protectedinherited

Definition at line 65 of file tools_holder.h.

Referenced by TOOLS_HOLDER::CommonSettingsChanged(), and TOOLS_HOLDER::GetDragSelects().

◆ m_dummySelection

SELECTION TOOLS_HOLDER::m_dummySelection

protectedinherited

Definition at line 52 of file tools_holder.h.

Referenced by TOOLS_HOLDER::GetCurrentSelection().

◆ m_fileHistory

FILE_HISTORY* EDA_BASE_FRAME::m_fileHistory

protected

Definition at line 151 of file eda_base_frame.h.

Referenced by ClearFileHistory(), CommonSettingsChanged(), GetFileFromHistory(), GetFileHistory(), LoadSettings(), SaveSettings(), UpdateFileHistory(), and ~EDA_BASE_FRAME().

◆ m_framePos

wxPoint EDA_BASE_FRAME::m_framePos

protected

Definition at line 131 of file eda_base_frame.h.

Referenced by BM2CMP_FRAME::BM2CMP_FRAME(), LoadWindowState(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SaveWindowSettings().

◆ m_frameSize

wxSize EDA_BASE_FRAME::m_frameSize

protected

Definition at line 132 of file eda_base_frame.h.

Referenced by BM2CMP_FRAME::BM2CMP_FRAME(), SCH_BASE_FRAME::createCanvas(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), LIB_VIEW_FRAME::LoadSettings(), LoadWindowState(), EDA_DRAW_FRAME::OnSize(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SaveWindowSettings().

◆ m_hasAutoSave

bool EDA_BASE_FRAME::m_hasAutoSave

protected

Definition at line 153 of file eda_base_frame.h.

Referenced by LoadWindowSettings(), ProcessEvent(), and SaveWindowSettings().

◆ m_ident

FRAME_T EDA_BASE_FRAME::m_ident

protected

Definition at line 130 of file eda_base_frame.h.

Referenced by findQuasiModalDialog(), IsType(), and EDA_DRAW_FRAME::saveCanvasTypeSetting().

◆ m_immediateActions

bool TOOLS_HOLDER::m_immediateActions

protectedinherited

Definition at line 61 of file tools_holder.h.

Referenced by TOOLS_HOLDER::CommonSettingsChanged(), and TOOLS_HOLDER::GetDoImmediateActions().

◆ m_infoBar

WX_INFOBAR* EDA_BASE_FRAME::m_infoBar

protected

Definition at line 144 of file eda_base_frame.h.

Referenced by SCH_EDIT_FRAME::ClearFindReplaceStatus(), GetInfoBar(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), PL_EDITOR_FRAME::LoadPageLayoutDescrFile(), SCH_EDIT_FRAME::OpenProjectFiles(), SYMBOL_EDIT_FRAME::saveAllLibraries(), SCH_EDIT_FRAME::ShowFindReplaceStatus(), ShowInfoBarError(), ShowInfoBarMsg(), and ShowInfoBarWarning().

◆ m_isClosing

bool EDA_BASE_FRAME::m_isClosing

protected

Definition at line 169 of file eda_base_frame.h.

Referenced by GERBVIEW_FRAME::doCloseWindow(), SaveSettings(), UpdateFileHistory(), and windowClosing().

◆ m_isNonUserClose

bool EDA_BASE_FRAME::m_isNonUserClose

protected

Definition at line 171 of file eda_base_frame.h.

Referenced by NonUserClose(), SaveSettings(), and windowClosing().

◆ m_maximizeByDefault

bool EDA_BASE_FRAME::m_maximizeByDefault

protected

Definition at line 133 of file eda_base_frame.h.

Referenced by GERBVIEW_FRAME::GERBVIEW_FRAME(), and LoadWindowState().

◆ m_moveWarpsCursor

bool TOOLS_HOLDER::m_moveWarpsCursor

protectedinherited

Definition at line 66 of file tools_holder.h.

Referenced by TOOLS_HOLDER::CommonSettingsChanged(), and TOOLS_HOLDER::GetMoveWarpsCursor().

◆ m_mruPath

wxString EDA_BASE_FRAME::m_mruPath

protected

Definition at line 163 of file eda_base_frame.h.

Referenced by FOOTPRINT_EDIT_FRAME::ExportFootprint(), SYMBOL_EDIT_FRAME::ExportPart(), BM2CMP_FRAME::exportPcbnewFormat(), GetMruPath(), FOOTPRINT_EDIT_FRAME::ImportFootprint(), SYMBOL_EDIT_FRAME::ImportPart(), GERBVIEW_FRAME::LoadExcellonFiles(), GERBVIEW_FRAME::LoadGerberFiles(), GERBVIEW_FRAME::LoadGerberJobFile(), SCH_EDIT_FRAME::LoadProject(), LoadWindowSettings(), GERBVIEW_FRAME::LoadZipArchiveFile(), SCH_EDIT_FRAME::NewProject(), BM2CMP_FRAME::OnLoadFile(), GERBVIEW_FRAME::OpenProjectFiles(), SaveWindowSettings(), and SetMruPath().

◆ m_normalFramePos

wxPoint EDA_BASE_FRAME::m_normalFramePos

protected

Definition at line 136 of file eda_base_frame.h.

Referenced by LoadWindowState(), OnMaximize(), and SaveWindowSettings().

◆ m_normalFrameSize

wxSize EDA_BASE_FRAME::m_normalFrameSize

protected

Definition at line 137 of file eda_base_frame.h.

Referenced by LoadWindowState(), OnMaximize(), and SaveWindowSettings().

◆ m_perspective

wxString EDA_BASE_FRAME::m_perspective

protected

Definition at line 142 of file eda_base_frame.h.

Referenced by LoadWindowSettings().

◆ m_redoList

UNDO_REDO_CONTAINER EDA_BASE_FRAME::m_redoList

protected

Definition at line 161 of file eda_base_frame.h.

Referenced by PL_EDITOR_FRAME::ClearUndoORRedoList(), SYMBOL_EDIT_FRAME::ClearUndoORRedoList(), SCH_EDIT_FRAME::ClearUndoORRedoList(), GetRedoCommandCount(), PopCommandFromRedoList(), and PushCommandToRedoList().

◆ m_settingsManager

SETTINGS_MANAGER* EDA_BASE_FRAME::m_settingsManager

protected

Definition at line 149 of file eda_base_frame.h.

Referenced by GetSettingsManager().

◆ m_toolDispatcher

TOOL_DISPATCHER* TOOLS_HOLDER::m_toolDispatcher

protectedinherited

Definition at line 50 of file tools_holder.h.

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::ActivateGalCanvas(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), PANEL_PREV_3D::OnMenuEvent(), OnMenuEvent(), PANEL_PREV_3D::PANEL_PREV_3D(), PL_EDITOR_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupTools(), LIB_VIEW_FRAME::setupTools(), KICAD_MANAGER_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), SYMBOL_EDIT_FRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), EDA_DRAW_FRAME::~EDA_DRAW_FRAME(), and KICAD_MANAGER_FRAME::~KICAD_MANAGER_FRAME().

◆ m_toolManager

TOOL_MANAGER* TOOLS_HOLDER::m_toolManager

protectedinherited

Definition at line 48 of file tools_holder.h.

◆ m_toolStack

std::vector<std::string> TOOLS_HOLDER::m_toolStack

protectedinherited

Definition at line 54 of file tools_holder.h.

Referenced by TOOLS_HOLDER::CurrentToolName(), TOOLS_HOLDER::IsCurrentTool(), TOOLS_HOLDER::PopTool(), TOOLS_HOLDER::PushTool(), and TOOLS_HOLDER::ToolStackIsEmpty().

◆ m_uiUpdateMap

std::map<int, UIUpdateHandler> EDA_BASE_FRAME::m_uiUpdateMap

protected

Definition at line 168 of file eda_base_frame.h.

Referenced by RegisterUIUpdateHandler(), and UnregisterUIUpdateHandler().

◆ m_undoList

UNDO_REDO_CONTAINER EDA_BASE_FRAME::m_undoList

protected

Definition at line 160 of file eda_base_frame.h.

Referenced by PL_EDITOR_FRAME::ClearUndoORRedoList(), SYMBOL_EDIT_FRAME::ClearUndoORRedoList(), SCH_EDIT_FRAME::ClearUndoORRedoList(), GetUndoCommandCount(), PopCommandFromUndoList(), and PushCommandToUndoList().

◆ m_undoRedoCountMax

int EDA_BASE_FRAME::m_undoRedoCountMax

protected

Definition at line 158 of file eda_base_frame.h.

Referenced by GetMaxUndoItems(), PushCommandToRedoList(), and PushCommandToUndoList().

◆ m_userUnits

EDA_UNITS EDA_BASE_FRAME::m_userUnits

protected

Definition at line 165 of file eda_base_frame.h.

Referenced by PL_EDITOR_FRAME::DisplayGridMsg(), GERBVIEW_FRAME::DisplayGridMsg(), PCB_BASE_FRAME::DisplayGridMsg(), EDA_DRAW_FRAME::DisplayUnitsMsg(), GetUserUnits(), SCH_EDIT_FRAME::SaveSettings(), EDA_DRAW_FRAME::SaveSettings(), SetUserUnits(), and EDA_DRAW_FRAME::ToggleUserUnits().

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

Member Enumeration Documentation

◆ HOLDER_TYPE

◆ UNDO_REDO_LIST

Constructor & Destructor Documentation

◆ EDA_BASE_FRAME()

◆ ~EDA_BASE_FRAME()

Member Function Documentation

◆ AddStandardHelpMenu()

◆ canCloseWindow()

◆ ChangeUserUnits()

◆ CheckForAutoSaveFile()

◆ ClearFileHistory()

◆ ClearUndoORRedoList()

◆ ClearUndoRedoList()

◆ CommonSettingsChanged()

◆ config()

◆ ConfigBaseName()

◆ CurrentToolName()

◆ DisplayToolMsg()

◆ doAutoSave()

◆ doCloseWindow()

◆ findQuasiModalDialog()

◆ GetAboutTitle()

◆ GetAutoSaveFilePrefix()

◆ GetAutoSaveInterval()

◆ GetBackupSuffix()

◆ GetCurrentFileName()

◆ GetCurrentSelection()

◆ GetDoImmediateActions()

◆ GetDragSelects()

◆ GetFileFromHistory()

◆ GetFileHistory()

◆ GetInfoBar()

◆ GetMaxUndoItems()

◆ GetMoveWarpsCursor()

◆ GetMruPath()

◆ GetRedoCommandCount()

◆ GetSettingsManager()

◆ GetSeverity()

◆ GetToolCanvas()

◆ GetToolManager()

◆ GetType()

◆ GetUndoCommandCount()

◆ GetUserUnits()

◆ GetWindowSettings()

◆ GetWindowSize()

◆ HandleUpdateUIEvent()

◆ help_name()

◆ ImportHotkeyConfigFromFile()

◆ InstallPreferences()

◆ isAutoSaveRequired()

◆ IsContentModified()

◆ IsCurrentTool()

◆ IsModal()

◆ IsType()

◆ IsWritable()

◆ Kiway()

◆ LoadSettings()

◆ LoadWindowSettings()

◆ LoadWindowState() [1/2]

◆ LoadWindowState() [2/2]

◆ NonUserClose()

◆ onAutoSaveTimer()

◆ OnCharHook()

◆ OnKicadAbout()

◆ OnMaximize()

◆ OnMenuEvent()

◆ OnMove()

◆ OnPreferences()

◆ PopCommandFromRedoList()

◆ PopCommandFromUndoList()