EDA_BASE_FRAME Class Reference

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 }
	Specifies whether we are interacting with the undo or redo stacks. 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 (FRAME_T aFrameType, 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 SEVERITY	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 &aKeyEvent)
	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)
virtual void	OnSize (wxSizeEvent &aEvent)
void	OnMaximize (wxMaximizeEvent &aEvent)
void	SetAutoSaveInterval (int aInterval)
int	GetAutoSaveInterval () const
bool	IsType (FRAME_T aType) const
FRAME_T	GetFrameType () 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)
	Displays the preferences and settings of all opened editors paged dialog. More...
void	PrintMsg (const wxString &text)
void	CreateInfoBar ()
void	FinishAUIInitialization ()
WX_INFOBAR *	GetInfoBar ()
void	ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton=false, WX_INFOBAR::MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...
void	ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton, std::function< void(void)> aCallback)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...
void	ShowInfoBarWarning (const wxString &aWarningMsg, bool aShowCloseButton=false)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar. More...
void	ShowInfoBarMsg (const wxString &aMsg, bool aShowCloseButton=false)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar. More...
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 *)
	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)
	Load window settings from the given settings object. More...
void	SaveWindowSettings (WINDOW_SETTINGS *aCfg)
	Save window settings to the given settings object. More...
virtual void	LoadSettings (APP_SETTINGS_BASE *aCfg)
	Load common frame parameters from a configuration file. More...
virtual void	SaveSettings (APP_SETTINGS_BASE *aCfg)
	Save common frame parameters to a configuration data file. More...
virtual WINDOW_SETTINGS *	GetWindowSettings (APP_SETTINGS_BASE *aCfg)
	Return 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
	Get the configuration base name. More...
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, bool aVerbose=true)
	Checks if aFileName can be written. More...
virtual 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...
void	ShowChangedLanguage () override
	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	ThemeChanged ()
	Process light/dark theme change. More...
virtual void	ProjectChanged ()
	Notification event that the project has changed. More...
const wxString &	GetAboutTitle () const
virtual bool	IsContentModified () const
	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)
	Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed. More...
virtual void	ClearUndoRedoList ()
	Clear the undo and redo list using ClearUndoORRedoList() More...
virtual void	PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
	Add a command to undo in the undo list. More...
virtual void	PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
	Add a command to redo in the redo list. More...
virtual PICKED_ITEMS_LIST *	PopCommandFromUndoList ()
	Return the last command to undo and remove it from list, nothing is deleted. More...
virtual PICKED_ITEMS_LIST *	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)
virtual void	HandleSystemColorChange ()
	Update the UI in response to a change in the system colors. More...
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
	Indicate that hotkeys should perform an immediate action even if another tool is currently active. More...
MOUSE_DRAG_ACTION	GetDragAction () const
	Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects. More...
bool	GetMoveWarpsCursor () const
	Indicate 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
	Return a reference to the KIWAY that this object has an opportunity to participate in. More...
PROJECT &	Prj () const
	Return a reference to the PROJECT associated with this KIWAY. More...
void	SetKiway (wxWindow *aDest, KIWAY *aKiway)
	It is only used for debugging, since "this" is not a wxWindow*. More...

Static Public Member Functions
static void	HandleUpdateUIEvent (wxUpdateUIEvent &aEvent, EDA_BASE_FRAME *aFrame, ACTION_CONDITIONS aCond)
	Handle 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 ()
void	onSystemColorChange (wxSysColourChangedEvent &aEvent)
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...
void	initExitKey ()
	Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id. More...
void	ensureWindowIsOnScreen ()

Static Protected Member Functions
static wxString	GetAutoSaveFilePrefix ()

Protected Attributes
FRAME_T	m_ident
wxPoint	m_framePos
wxSize	m_frameSize
bool	m_maximizeByDefault
int	m_displayIndex
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
	Map containing the UI update handlers registered with wx for each action. More...
std::map< int, UIUpdateHandler >	m_uiUpdateMap
	Set by the close window event handler after frames are asked if they can close. More...
bool	m_isClosing
	Set by NonUserClose() to indicate that the user did not request the current close. More...
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
MOUSE_DRAG_ACTION	m_dragAction
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...
void	commonInit (FRAME_T aFrameType)
	Collect common initialization functions used in all CTORs. 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. 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 103 of file eda_base_frame.h.

Member Enumeration Documentation

HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE

inherited

Enumerator
DIALOG
FRAME
PANEL

Definition at line 39 of file kiway_holder.h.

{ DIALOG, FRAME, PANEL };

UNDO_REDO_LIST

enum EDA_BASE_FRAME::UNDO_REDO_LIST

Specifies whether we are interacting with the undo or redo stacks.

Enumerator
UNDO_LIST
REDO_LIST

Definition at line 109 of file eda_base_frame.h.

 {
 UNDO_LIST,
 REDO_LIST
 };

Constructor & Destructor Documentation

EDA_BASE_FRAME() [1/2]

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

 :
 wxFrame( aParent, wxID_ANY, aTitle, aPos, aSize, aStyle, aFrameName ),
 TOOLS_HOLDER(),
 KIWAY_HOLDER( aKiway, KIWAY_HOLDER::FRAME )
{
 commonInit( aFrameType );
}

References commonInit().

EDA_BASE_FRAME() [2/2]

EDA_BASE_FRAME::EDA_BASE_FRAME	(	FRAME_T	aFrameType,
		KIWAY *	aKiway
	)

Definition at line 152 of file eda_base_frame.cpp.

 :
 wxFrame(),
 TOOLS_HOLDER(),
 KIWAY_HOLDER( aKiway, KIWAY_HOLDER::FRAME )
{
 commonInit( aFrameType );
}

References commonInit().

~EDA_BASE_FRAME()

EDA_BASE_FRAME::~EDA_BASE_FRAME

(

)

Definition at line 245 of file eda_base_frame.cpp.

{
 delete m_autoSaveTimer;
 delete m_fileHistory;

 ClearUndoRedoList();

 SocketCleanup();

 KIPLATFORM::APP::RemoveShutdownBlockReason( this );
}

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

Member Function Documentation

AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu

(

wxMenuBar *

aMenuBar

)

Adds the standard KiCad help menu to the menubar.

Definition at line 460 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::donate );
 helpMenu->Add( ACTIONS::reportBug );

 helpMenu->AppendSeparator();
 helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, BITMAPS::about );

 // Trailing space keeps OSX from hijacking our menu (and disabling everything in it).
 aMenuBar->Append( helpMenu, _( "&Help" ) + wxS( " " ) );
}

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

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

canCloseWindow()

virtual bool EDA_BASE_FRAME::canCloseWindow ( wxCloseEvent &  aCloseEvent )

inlineprotectedvirtual

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

Definition at line 626 of file eda_base_frame.h.

{ return true; }

Referenced by windowClosing().

ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits

(

EDA_UNITS

aUnits

)

Definition at line 1203 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 )

virtual

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.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1091 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().GetAppDisplayName(), 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().GetAppDisplayName(), 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 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 976 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

Remove the aItemCount of 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. Commands are deleted from the older to the last.

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.

Reimplemented in SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, PL_EDITOR_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 545 of file eda_base_frame.h.

 { }

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

ClearUndoRedoList()

void EDA_BASE_FRAME::ClearUndoRedoList ( )

virtual

Clear the undo and redo list using ClearUndoORRedoList()

Picked items are deleted by ClearUndoORRedoList() according to their status.

Definition at line 1154 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_CONTROL::ImportFootprint(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), SCH_EDIT_FRAME::OnImportProject(), PL_EDITOR_FRAME::OnNewDrawingSheet(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDITOR_CONTROL::rescueProject(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), and ~EDA_BASE_FRAME().

commonInit()

void EDA_BASE_FRAME::commonInit ( FRAME_T  aFrameType )

private

Collect common initialization functions used in all CTORs.

Definition at line 112 of file eda_base_frame.cpp.

{
 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 = PATHS::GetDefaultUserProjectsPath();
 m_frameSize = defaultSize( aFrameType );
 m_displayIndex = -1;

 m_auimgr.SetArtProvider( new WX_AUI_DOCK_ART() );

 m_settingsManager = &Pgm().GetSettingsManager();

 // Set a reasonable minimal size for the frame
 SetSizeHints( minSize( aFrameType ).x, minSize( aFrameType ).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 ) );

 initExitKey();
}

References DEFAULT_MAX_UNDO_ITEMS, defaultSize(), PATHS::GetDefaultUserProjectsPath(), ID_AUTO_SAVE_TIMER, MILLIMETRES, minSize(), onAutoSaveTimer(), Pgm(), and windowClosing().

Referenced by 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 492 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 ) );
 }

 GetBitmapStore()->ThemeChanged();
 ThemeChanged();

 if( GetMenuBar() )
 {
 // For icons in menus, icon scaling & hotkeys
 ReCreateMenuBar();
 GetMenuBar()->Refresh();
 }
}

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

Referenced by EDA_3D_VIEWER_FRAME::CommonSettingsChanged(), KICAD_MANAGER_FRAME::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 SYMBOL_EDIT_FRAME, KICAD_MANAGER_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 816 of file eda_base_frame.cpp.

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

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

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_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(), GRID_MENU::GRID_MENU(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), EDA_DRAW_FRAME::IsGridVisible(), SCH_BASE_FRAME::libeditconfig(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), GERBVIEW_FRAME::Read_EXCELLON_File(), DIALOG_GRID_SETTINGS::RebuildGridSizes(), EDA_DRAW_FRAME::resolveCanvasType(), PCB_BASE_EDIT_FRAME::SetBoard(), EDA_DRAW_FRAME::SetGridVisibility(), PL_EDITOR_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), CVPCB_MAINFRAME::setupTools(), GERBVIEW_FRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), PANEL_GERBVIEW_EXCELLON_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), PANEL_GERBVIEW_EXCELLON_SETTINGS::TransferDataToWindow(), ZOOM_MENU::update(), GRID_MENU::update(), EDA_DRAW_FRAME::UpdateGridSelectBox(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), windowClosing(), and BM2CMP_FRAME::~BM2CMP_FRAME().

ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )

inlineoverridevirtual

Get the configuration base name.

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 configuration can be used.

Returns

a base name prefix used in Load/Save settings to build the full name of keys used in configuration.

Reimplemented from TOOLS_HOLDER.

Definition at line 358 of file eda_base_frame.h.

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

References m_configName.

Referenced by SaveWindowSettings().

CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar

(

)

Definition at line 841 of file eda_base_frame.cpp.

{
#if defined( __WXOSX_MAC__ )
 m_infoBar = new WX_INFOBAR( GetToolCanvas() );
#else
 m_infoBar = new WX_INFOBAR( this, &m_auimgr );

 m_auimgr.AddPane( m_infoBar, EDA_PANE().InfoBar().Name( wxT( "InfoBar" ) ).Top().Layer(1) );
#endif
}

References TOOLS_HOLDER::GetToolCanvas(), m_auimgr, and m_infoBar.

CurrentToolName()

std::string TOOLS_HOLDER::CurrentToolName ( ) const

inherited

Definition at line 100 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(), and TOOLS_HOLDER::ShowChangedLanguage().

DisplayToolMsg()

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

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 121 of file tools_holder.h.

{};

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

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 SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 327 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, PCB_EDIT_FRAME, SIM_PLOT_FRAME, SYMBOL_EDIT_FRAME, CVPCB_MAINFRAME, FOOTPRINT_WIZARD_FRAME, FOOTPRINT_VIEWER_FRAME, PL_EDITOR_FRAME, SYMBOL_VIEWER_FRAME, FOOTPRINT_EDIT_FRAME, GERBVIEW_FRAME, KICAD_MANAGER_FRAME, PCB_BASE_EDIT_FRAME, and DISPLAY_FOOTPRINTS_FRAME.

Definition at line 627 of file eda_base_frame.h.

{ }

Referenced by windowClosing().

ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )

protected

Definition at line 657 of file eda_base_frame.cpp.

{
 wxDisplay display( wxDisplay::GetFromWindow( this ) );
 wxRect clientSize = display.GetClientArea();
 wxPoint pos = GetPosition();
 wxSize size = GetWindowSize();

 wxLogTrace( traceDisplayLocation,
 wxT( "ensureWindowIsOnScreen: clientArea (%d, %d) w %d h %d" ), clientSize.x, clientSize.y,
 clientSize.width, clientSize.height );

 if( pos.y < clientSize.y )
 {
 wxLogTrace( traceDisplayLocation,
 wxT( "ensureWindowIsOnScreen: y pos %d below minimum, setting to %d" ), pos.y,
 clientSize.y );
 pos.y = clientSize.y;
 }

 if( pos.x < clientSize.x )
 {
 wxLogTrace( traceDisplayLocation,
 wxT( "ensureWindowIsOnScreen: x pos %d is off the client rect, setting to %d" ), pos.x,
 clientSize.x );
 pos.x = clientSize.x;
 }

 if( pos.x + size.x - clientSize.x > clientSize.width )
 {
 int newWidth = clientSize.width - ( pos.x - clientSize.x );
 wxLogTrace( traceDisplayLocation,
 wxT( "ensureWindowIsOnScreen: effective width %d above available %d, setting to %d" ),
 pos.x + size.x, clientSize.width, newWidth );
 size.x = newWidth;
 }

 if( pos.y + size.y - clientSize.y > clientSize.height )
 {
 int newHeight = clientSize.height - ( pos.y - clientSize.y );
 wxLogTrace( traceDisplayLocation,
 wxT( "ensureWindowIsOnScreen: effective height %d above available %d, setting to %d" ),
 pos.y + size.y, clientSize.height, newHeight );
 size.y = newHeight;
 }

 wxLogTrace( traceDisplayLocation, wxT( "Updating window position (%d, %d) with size (%d, %d)" ),
 pos.x, pos.y, size.x, size.y );

 SetSize( pos.x, pos.y, size.x, size.y );
}

References GetWindowSize(), and traceDisplayLocation.

Referenced by OnSize().

findQuasiModalDialog()

wxWindow * EDA_BASE_FRAME::findQuasiModalDialog ( )

private

Definition at line 172 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( wxT( "CvpcbFrame" ) );

 if( cvpcb )
 return cvpcb;
 }

 return nullptr;
}

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

Referenced by ProcessEvent(), and windowClosing().

FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization

(

)

Definition at line 853 of file eda_base_frame.cpp.

{
#if defined( __WXOSX_MAC__ )
 m_auimgr.Update();
#else
 // Call Update() to fix all pane default sizes, especially the "InfoBar" pane before
 // hiding it.
 m_auimgr.Update();

 // We don't want the infobar displayed right away
 m_auimgr.GetPane( wxT( "InfoBar" ) ).Hide();
 m_auimgr.Update();
#endif
}

References m_auimgr.

GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const

inline

Definition at line 514 of file eda_base_frame.h.

{ return m_aboutTitle; }

References m_aboutTitle.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT(), PGM_SINGLE_TOP::OnPgmInit(), 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 602 of file eda_base_frame.h.

 {
 return wxT( "_autosave-" );
 }

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

GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const

inline

Definition at line 204 of file eda_base_frame.h.

{ return m_autoSaveInterval; }

References m_autoSaveInterval.

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

{ 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, SYMBOL_VIEWER_FRAME, SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, DISPLAY_FOOTPRINTS_FRAME, PL_EDITOR_FRAME, FOOTPRINT_VIEWER_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 101 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

Indicate 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 129 of file tools_holder.h.

{ return m_immediateActions; }

References TOOLS_HOLDER::m_immediateActions.

GetDragAction()

MOUSE_DRAG_ACTION TOOLS_HOLDER::GetDragAction ( ) const

inlineinherited

Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects.

Definition at line 135 of file tools_holder.h.

{ return m_dragAction; }

References TOOLS_HOLDER::m_dragAction.

Referenced by PL_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), and PCB_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 initialization 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 936 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
 {
 DisplayErrorMessage( this, wxString::Format( _( "File '%s' was not found." ), fn ) );
 aFileHistory->RemoveFileFromHistory( i );
 }
 }

 // Update the menubar to update the file history menu
 if( GetMenuBar() )
 {
 ReCreateMenuBar();
 GetMenuBar()->Refresh();
 }

 return wxEmptyString;
}

References _, DisplayErrorMessage(), 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 423 of file eda_base_frame.h.

 {
 return *m_fileHistory;
 }

References m_fileHistory.

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

GetFrameType()

FRAME_T EDA_BASE_FRAME::GetFrameType ( ) const

inline

Definition at line 207 of file eda_base_frame.h.

{ return m_ident; }

References m_ident.

GetInfoBar()

WX_INFOBAR* EDA_BASE_FRAME::GetInfoBar ( )

inline

Returns

the WX_INFOBAR that can be displayed on the top of the canvas.

Definition at line 234 of file eda_base_frame.h.

{ return m_infoBar; }

References m_infoBar.

Referenced by FOOTPRINT_EDIT_FRAME::AddFootprintToBoard(), AUTOPLACE_TOOL::autoplace(), FOOTPRINT_EDIT_FRAME::CanCloseFPFromBoard(), SYMBOL_EDIT_FRAME::CanCloseSymbolFromSchematic(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawVia(), PAD_TOOL::EditPad(), ZONE_FILLER_TOOL::FillAllZones(), ROUTER_TOOL::handleLayerSwitch(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), PL_EDIT_TOOL::Main(), SCH_MOVE_TOOL::Main(), APPEARANCE_CONTROLS::onReadOnlySwatch(), EDA_DRAW_PANEL_GAL::onSize(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_DRAWING_TOOLS::PlaceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), PAD_TOOL::Reset(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), SYMBOL_EDIT_FRAME::SetCurSymbol(), ShowInfoBarError(), ShowInfoBarMsg(), ShowInfoBarWarning(), SCH_DRAWING_TOOLS::SingleClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and PCB_CONTROL::unfilledZoneCheck().

GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const

inline

Definition at line 582 of file eda_base_frame.h.

{ return m_undoRedoCountMax; }

References m_undoRedoCountMax.

Referenced by EDA_DRAW_FRAME::SaveSettings().

GetMoveWarpsCursor()

bool TOOLS_HOLDER::GetMoveWarpsCursor ( ) const

inlineinherited

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

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

Definition at line 141 of file tools_holder.h.

{ return m_moveWarpsCursor; }

References TOOLS_HOLDER::m_moveWarpsCursor.

Referenced by EDIT_TOOL::doMoveSelection(), ROUTER_TOOL::InlineDrag(), SYMBOL_EDITOR_MOVE_TOOL::Main(), and SCH_MOVE_TOOL::Main().

GetMruPath()

wxString EDA_BASE_FRAME::GetMruPath ( ) const

inline

Definition at line 430 of file eda_base_frame.h.

{ return m_mruPath; }

References m_mruPath.

Referenced by AskLoadBoardFileName(), PANEL_HOTKEYS_EDITOR::dumpHotkeys(), GERBVIEW_CONTROL::ExportToPcbnew(), PCB_EDIT_FRAME::Files_io_from_id(), PANEL_HOTKEYS_EDITOR::ImportHotKeys(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), EDA_DRAW_FRAME::LibraryFileBrowser(), KICAD_MANAGER_CONTROL::NewProject(), KICAD_MANAGER_CONTROL::OpenProject(), SCH_EDIT_FRAME::SaveProject(), and KICAD_MANAGER_CONTROL::SaveProjectAs().

GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const

inlinevirtual

Reimplemented in CVPCB_MAINFRAME.

Definition at line 580 of file eda_base_frame.h.

{ return m_redoList.m_CommandsList.size(); }

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

{ return m_settingsManager; }

References m_settingsManager.

Referenced by GERBVIEW_FRAME::applyDisplaySettingsToGAL(), KICAD_MANAGER_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CreateNewProject(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::Files_io_from_id(), DIALOG_PLOT_SCHEMATIC::getColorSettings(), GetSettingsManager(), DIALOG_PLOT_SCHEMATIC::initDlg(), DIALOG_SCHEMATIC_SETUP::OnAuxiliaryAction(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), SCH_EDIT_FRAME::OnImportProject(), GERBER_LAYER_WIDGET::OnLayerColorChange(), GERBER_LAYER_WIDGET::OnRenderColorChange(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), PANEL_SYM_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_FP_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_PCBNEW_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataToWindow(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

GetSeverity()

virtual SEVERITY EDA_BASE_FRAME::GetSeverity ( int  aErrorCode ) const

inlinevirtual

Reimplemented in PCB_BASE_FRAME, and SCH_EDIT_FRAME.

Definition at line 142 of file eda_base_frame.h.

{ return RPT_SEVERITY_UNDEFINED; }

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, BM2CMP_FRAME, KICAD_MANAGER_FRAME, SIM_PLOT_FRAME, CVPCB_MAINFRAME, PANEL_PREVIEW_3D_MODEL, EDA_3D_VIEWER_FRAME, and PCB_CALCULATOR_FRAME.

Referenced by CreateInfoBar(), TOOL_DISPATCHER::DispatchWxEvent(), EDA_3D_CONTROLLER::Main(), WX_INFOBAR::onSize(), and EDA_3D_CONTROLLER::Reset().

GetToolManager()

TOOL_MANAGER* TOOLS_HOLDER::GetToolManager ( ) const

inlineinherited

Return the MVC controller.

Definition at line 54 of file tools_holder.h.

{ return m_toolManager; }

References TOOLS_HOLDER::m_toolManager.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_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::DisplayDrawingSheet(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), SIM_PLOT_FRAME::doCloseWindow(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), SCH_FIELD::DoHypertextMenu(), DRAWING_TOOL::DrawVia(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_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(), DIALOG_PAD_PROPERTIES::initValues(), ROUTER_TOOL::InlineBreakTrack(), EDA_3D_VIEWER_FRAME::InstallPreferences(), 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(), PCB_EDIT_FRAME::LoadProjectSettings(), FOOTPRINT_EDIT_FRAME::LoadSettings(), SYMBOL_EDIT_FRAME::LoadSymbol(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_DRC::OnActivateDlg(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_DRC::OnCancelClick(), DIALOG_INSPECTOR::onCellClicked(), DIALOG_ERC::OnCloseErcDialog(), DIALOG_FOOTPRINT_CHECKER::OnDeleteOneClick(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_ABOUT::onDonateClick(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_ERC::OnERCItemSelected(), DIALOG_CONSTRAINTS_REPORTER::OnErrorLinkClicked(), KICAD_MANAGER_FRAME::OnIdle(), FOOTPRINTS_LISTBOX::OnLeftDClick(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetContextMenu(), PANEL_PCBNEW_ACTION_PLUGINS::OnOpenDirectoryButtonClick(), SIM_PLOT_FRAME::onProbe(), PANEL_PCBNEW_ACTION_PLUGINS::OnReloadButtonClick(), DIALOG_ABOUT::onReportBug(), DIALOG_PLOT::onRunDRC(), DIALOG_DRC::OnRunDRCClick(), HIERARCHY_NAVIG_DLG::onSelectSheetPath(), SCH_EDIT_FRAME::onSize(), SYMBOL_TREE_PANE::onSymbolSelected(), DIALOG_SYMBOL_FIELDS_TABLE::OnTableCellClick(), SIM_PLOT_FRAME::onTune(), PANEL_KICAD_LAUNCHER::PANEL_KICAD_LAUNCHER(), PANEL_SELECTION_FILTER::PANEL_SELECTION_FILTER(), DIALOG_UPDATE_PCB::PerformUpdate(), DIALOG_PLOT::Plot(), TOOLS_HOLDER::PopTool(), SCH_EDIT_FRAME::PutDataInPreviousState(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), Refresh(), PL_EDITOR_FRAME::RollbackFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), PCB_EDIT_FRAME::SaveProjectSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), EDA_3D_VIEWER_FRAME::SaveSettings(), DIALOG_FIND::search(), CVPCB_MAINFRAME::setupEventHandlers(), APPEARANCE_CONTROLS::showNetclass(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), PANEL_3D_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), PANEL_3D_DISPLAY_OPTIONS::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), EDA_DRAW_FRAME::UpdateMsgPanel(), NET_GRID_TABLE::updateNetVisibility(), DIALOG_NETLIST_IMPORT::~DIALOG_NETLIST_IMPORT(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().

GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const

inlineinherited

Definition at line 46 of file kiway_holder.h.

{ return m_type; }

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

{ return m_undoList.m_CommandsList.size(); }

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

 {
 return m_userUnits;
 }

References m_userUnits.

Referenced by DIALOG_CONSTRAINTS_REPORTER::AddPage(), PANEL_SETUP_TRACKS_AND_VIAS::AppendDiffPairs(), PANEL_SETUP_TRACKS_AND_VIAS::AppendTrackWidth(), PANEL_SETUP_TRACKS_AND_VIAS::AppendViaSize(), EE_INSPECTION_TOOL::CheckSymbol(), PANEL_SETUP_BOARD_STACKUP::computeBoardThickness(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), EDA_DRAW_FRAME::DisplayGridMsg(), GERBER_FILE_IMAGE::DisplayImageInfo(), DIALOG_GROUP_PROPERTIES::DoAddMember(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawBoardCharacteristics(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawSpecificationStackup(), EVT_GRID_CMD_CELL_CHANGED(), PCB_EDIT_FRAME::GenFootprintsReport(), PANEL_FP_EDITOR_DEFAULTS::getGridValue(), PANEL_SETUP_TEXT_AND_GRAPHICS::getGridValue(), BOARD_INSPECTION_TOOL::getItemDescription(), SCH_PIN::GetMsgPanelInfo(), PL_EDITOR_LAYOUT::GetMsgPanelInfo(), PCB_MARKER::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), DS_DRAW_ITEM_BASE::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), SCH_BITMAP::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), EDA_DRAW_FRAME::GetUnitPair(), GetUserUnits(), FP_TEXT_GRID_TABLE::GetValue(), PIN_TABLE_DATA_MODEL::GetValue(), RC_TREE_MODEL::GetValue(), BOARD_INSPECTION_TOOL::InspectClearance(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), DIALOG_NET_INSPECTOR::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PANEL_SETUP_BOARD_STACKUP::PANEL_SETUP_BOARD_STACKUP(), POSITION_RELATIVE_TOOL::PositionRelative(), DRC_TOOL::RunTests(), FP_TEXT_GRID_TABLE::SetValue(), PIN_TABLE_DATA_MODEL::SetValue(), EDA_SHAPE::ShapeGetMsgPanelInfo(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), PIN_TABLE_DATA_MODEL::SortRows(), COMMON_TOOLS::ToggleUnits(), PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup(), PANEL_SETUP_NETCLASSES::TransferDataFromWindow(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataFromWindow(), PANEL_SETUP_NETCLASSES::TransferDataToWindow(), PANEL_SETUP_CONSTRAINTS::TransferDataToWindow(), UNIT_BINDER::UNIT_BINDER(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), EDITOR_CONDITIONS::unitsFunc(), VIA_SIZE_MENU::update(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), GERBVIEW_FRAME::updateDCodeSelectBox(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), ROUTER_TOOL::UpdateMessagePanel(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), GERBVIEW_FRAME::UpdateStatusBar(), PL_EDITOR_FRAME::UpdateStatusBar(), SCH_BASE_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), and DRC_TOOL::userUnits().

GetWindowSettings()

WINDOW_SETTINGS * EDA_BASE_FRAME::GetWindowSettings ( APP_SETTINGS_BASE *  aCfg )

virtual

Return 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 FOOTPRINT_WIZARD_FRAME, SIM_PLOT_FRAME, FOOTPRINT_VIEWER_FRAME, SYMBOL_VIEWER_FRAME, and DISPLAY_FOOTPRINTS_FRAME.

Definition at line 810 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 1237 of file eda_base_frame.cpp.

{
#ifdef __WXGTK__
 wxSize winSize = GetSize();

 // 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.
 if( m_ident == KICAD_MAIN_FRAME_T )
 {
 int width = 0;
 int height = 0;
 GTKDoGetSize( &width, &height );

 winSize.Set( width, height );
 }
#else
 wxSize winSize = GetSize();
#endif

 return winSize;
}

References KICAD_MAIN_FRAME_T, and m_ident.

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

HandleSystemColorChange()

void EDA_BASE_FRAME::HandleSystemColorChange ( )

virtual

Update the UI in response to a change in the system colors.

Definition at line 1261 of file eda_base_frame.cpp.

{
 // Update the icon theme when the system theme changes and update the toolbars
 GetBitmapStore()->ThemeChanged();
 ThemeChanged();

 // This isn't handled by ThemeChanged()
 if( GetMenuBar() )
 {
 // For icons in menus, icon scaling & hotkeys
 ReCreateMenuBar();
 GetMenuBar()->Refresh();
 }
}

References GetBitmapStore(), ReCreateMenuBar(), BITMAP_STORE::ThemeChanged(), and ThemeChanged().

Referenced by onSystemColorChange().

HandleUpdateUIEvent()

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

static

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

{
 bool checkRes = false;
 bool enableRes = true;
 bool showRes = true;
 bool isCut = aEvent.GetId() == ACTIONS::cut.GetUIId();
 bool isCopy = aEvent.GetId() == ACTIONS::copy.GetUIId();
 bool isPaste = aEvent.GetId() == ACTIONS::paste.GetUIId();
 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;
 }

 if( isCut || isCopy || isPaste )
 {
 wxWindow* focus = wxWindow::FindFocus();
 wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( focus );

 if( textEntry && isCut && textEntry->CanCut() )
 enableRes = true;
 else if( textEntry && isCopy && textEntry->CanCopy() )
 enableRes = true;
 else if( textEntry && isPaste && textEntry->CanPaste() )
 enableRes = true;
 }

 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, ACTIONS::copy, ACTIONS::cut, ACTION_CONDITIONS::enableCondition, TOOLS_HOLDER::GetCurrentSelection(), TOOL_ACTION::GetUIId(), ACTIONS::paste, and ACTION_CONDITIONS::showCondition.

Referenced by RegisterUIUpdateHandler().

help_name()

wxString EDA_BASE_FRAME::help_name ( )

virtual

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 829 of file eda_base_frame.cpp.

{
 return Kiface().GetHelpFileName();
}

References KIFACE_BASE::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 Eeschema, KiCad...

initExitKey()

void EDA_BASE_FRAME::initExitKey ( )

protected

Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id.

This is useful in sub-applications to pass the event up to a non-owning window.

Definition at line 1145 of file eda_base_frame.cpp.

{
 wxAcceleratorEntry entries[1];
 entries[0].Set( wxACCEL_CTRL, int( 'Q' ), wxID_EXIT );
 wxAcceleratorTable accel( 1, entries );
 SetAcceleratorTable( accel );
}

InstallPreferences()

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

inlinevirtual

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, KICAD_MANAGER_FRAME, and EDA_3D_VIEWER_FRAME.

Definition at line 298 of file eda_base_frame.h.

{ }

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 SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 617 of file eda_base_frame.h.

{ return false; }

Referenced by ProcessEvent().

IsContentModified()

bool EDA_BASE_FRAME::IsContentModified ( ) const

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 SCH_EDIT_FRAME, CVPCB_MAINFRAME, PCB_EDIT_FRAME, PL_EDITOR_FRAME, SYMBOL_EDIT_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 1138 of file eda_base_frame.cpp.

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

Referenced by GERBVIEW_FRAME::Clear_DrawLayers(), and EDITOR_CONDITIONS::contentModifiedFunc().

IsCurrentTool()

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

inherited

Definition at line 109 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 SCH_EDIT_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_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 684 of file eda_base_frame.h.

{ return false; }

Referenced by windowClosing().

IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T  aType ) const

inline

Definition at line 206 of file eda_base_frame.h.

{ return m_ident == aType; }

References m_ident.

Referenced by SYMBOL_EDITOR_CONTROL::AddLibrary(), PCB_CONTROL::AddLibrary(), SYMBOL_EDITOR_CONTROL::AddSymbol(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), BOARD_COMMIT::BOARD_COMMIT(), CONVERT_TOOL::CreatePolys(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), KIGFX::SCH_VIEW::DisplaySheet(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), COMMON_TOOLS::doZoomFit(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), SYMBOL_EDITOR_CONTROL::EditSymbol(), SYMBOL_EDITOR_CONTROL::ExportSymbol(), PCB_EDITOR_CONDITIONS::get45degModeFunc(), FOOTPRINT::GetMsgPanelInfo(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), CONVERT_TOOL::Init(), SYMBOL_EDITOR_CONTROL::Init(), DIALOG_FIELD_PROPERTIES::init(), PCB_SELECTION_TOOL::Init(), DIALOG_PAD_PROPERTIES::initValues(), PCB_SELECTION_TOOL::Main(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), PCB_CONTROL::Paste(), SYMBOL_EDITOR_CONTROL::PinLibrary(), PCB_CONTROL::placeBoardItems(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), SYMBOL_EDITOR_CONTROL::Revert(), SYMBOL_EDITOR_CONTROL::Save(), APPEARANCE_CONTROLS::setVisibleObjects(), EE_INSPECTION_TOOL::ShowDatasheet(), EE_INSPECTION_TOOL::ShowERCDialog(), DRAWING_TOOL::ToggleLine45degMode(), SYMBOL_EDITOR_CONTROL::ToggleSymbolTree(), SYMBOL_EDITOR_CONTROL::UnpinLibrary(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), and DRAWING_TOOL::updateStatusBar().

IsWritable()

bool EDA_BASE_FRAME::IsWritable	(	const wxFileName &	aFileName,
		bool	aVerbose = true
	)

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.
aVerbose	If true will show an error dialog if the file is not writable

Returns

False if aFileName cannot be written.

Definition at line 1045 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( _( "Insufficient permissions to folder '%s'." ),
 fn.GetPath() );
 }
 else if( !fn.FileExists() && !fn.IsDirWritable() )
 {
 msg.Printf( _( "Insufficient permissions to save file '%s'." ),
 fn.GetFullName(), fn.GetPath() );
 }
 else if( fn.FileExists() && !fn.IsFileWritable() )
 {
 msg.Printf( _( "Insufficient permissions to save file '%s'." ),
 fn.GetFullPath() );
 }

 if( !msg.IsEmpty() )
 {
 if( aVerbose )
 wxMessageBox( msg );

 return false;
 }

 return true;
}

References _.

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

Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const

inlineinherited

Return 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 53 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 PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::AddLibraryFile(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_EDIT_FRAME::AskToSaveChanges(), SYMBOL_EDIT_FRAME::CanCloseSymbolFromSchematic(), SCH_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), SCRIPTING_TOOL::Init(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), 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(), 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_SYMBOL::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_FIELD_PROPERTIES::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(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SYMBOL_EDIT_FRAME::Save(), SYMBOL_EDIT_FRAME::saveCurrentSymbol(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), 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(), SYMBOL_EDIT_FRAME::SetCurSymbol(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), 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 PCB_BASE_FRAME, EDA_DRAW_FRAME, CVPCB_MAINFRAME, GERBVIEW_FRAME, PCB_EDIT_FRAME, SYMBOL_EDIT_FRAME, PL_EDITOR_FRAME, SCH_EDIT_FRAME, FOOTPRINT_WIZARD_FRAME, BM2CMP_FRAME, SIM_PLOT_FRAME, FOOTPRINT_VIEWER_FRAME, KICAD_MANAGER_FRAME, EDA_3D_VIEWER_FRAME, SCH_BASE_FRAME, SYMBOL_VIEWER_FRAME, PCB_CALCULATOR_FRAME, FOOTPRINT_EDIT_FRAME, and DISPLAY_FOOTPRINTS_FRAME.

Definition at line 769 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(), EDA_3D_VIEWER_FRAME::LoadSettings(), KICAD_MANAGER_FRAME::LoadSettings(), SIM_PLOT_FRAME::LoadSettings(), BM2CMP_FRAME::LoadSettings(), CVPCB_MAINFRAME::LoadSettings(), and EDA_DRAW_FRAME::LoadSettings().

LoadWindowSettings()

void EDA_BASE_FRAME::LoadWindowSettings

(

const WINDOW_SETTINGS *

aCfg

)

Load 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 709 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 549 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 563 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, wxT( "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 < minSize( m_ident ).x || m_frameSize.y < minSize( m_ident ).y )
 {
 m_frameSize = defaultSize( m_ident );
 wasDefault = true;

 wxLogTrace( traceDisplayLocation, wxT( "Using minimum size (%d, %d)" ),
 m_frameSize.x, m_frameSize.y );
 }

 wxLogTrace( traceDisplayLocation, wxT( "Number of displays: %d" ), wxDisplay::GetCount() );

 if( aState.display >= wxDisplay::GetCount() )
 {
 wxLogTrace( traceDisplayLocation, wxT( "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();

 int yLimTop = clientSize.y;
 int yLimBottom = clientSize.y + clientSize.height;
 int xLimLeft = clientSize.x;
 int xLimRight = clientSize.x + clientSize.width;

 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
 upperLeft.y < yLimTop || // Upper corner too close to the bottom of the screen
 upperLeft.y > yLimBottom )
 {
 m_framePos = wxDefaultPosition;
 wxLogTrace( traceDisplayLocation, wxT( "Resetting to default position" ) );
 }
 }

 wxLogTrace( traceDisplayLocation, wxT( "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, wxT( "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, wxT( "Maximizing window" ) );
 Maximize();
 }

 m_displayIndex = wxDisplay::GetFromWindow( this );
}

References PCAD2KICAD::Center, defaultSize(), WINDOW_STATE::display, m_displayIndex, m_framePos, m_frameSize, m_ident, m_maximizeByDefault, m_normalFramePos, m_normalFrameSize, WINDOW_STATE::maximized, minSize(), WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, WINDOW_STATE::size_x, WINDOW_STATE::size_y, and traceDisplayLocation.

NonUserClose()

bool EDA_BASE_FRAME::NonUserClose ( bool  aForce )

inline

Definition at line 584 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 320 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 commonInit().

OnCharHook()

void EDA_BASE_FRAME::OnCharHook ( wxKeyEvent &  aKeyEvent )

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

{
 wxLogTrace( kicadTraceKeyEvent, wxT( "EDA_BASE_FRAME::OnCharHook %s" ), dump( aKeyEvent ) );

 // Key events can be filtered here.
 // Currently no filtering is made.
 aKeyEvent.Skip();
}

References dump(), and kicadTraceKeyEvent.

OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout

(

wxCommandEvent &

event

)

Definition at line 994 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 1213 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,
 wxT( "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 343 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 193 of file eda_base_frame.h.

 {
 aEvent.Skip();
 }

OnPreferences()

void EDA_BASE_FRAME::OnPreferences

(

wxCommandEvent &

event

)

Displays the preferences and settings of all opened editors paged dialog.

Definition at line 1001 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" ) );

 wxWindow* viewer3D = nullptr;

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

 if( !viewer3D )
 viewer3D = wxFindWindowByName( QUALIFIED_VIEWER3D_FRAMENAME( frame ) );
 }
 }

 if( viewer3D )
 static_cast<EDA_BASE_FRAME*>( viewer3D )->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, KIWAY::Player(), and QUALIFIED_VIEWER3D_FRAMENAME.

Referenced by APPEARANCE_CONTROLS::onReadOnlySwatch(), and COMMON_CONTROL::OpenPreferences().

OnSize()

void EDA_BASE_FRAME::OnSize ( wxSizeEvent &  aEvent )

virtual

Reimplemented in EDA_DRAW_FRAME, FOOTPRINT_VIEWER_FRAME, FOOTPRINT_WIZARD_FRAME, SYMBOL_VIEWER_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 531 of file eda_base_frame.cpp.

{
#ifdef __WXMAC__
 int currentDisplay = wxDisplay::GetFromWindow( this );

 if( m_displayIndex >= 0 && currentDisplay >= 0 && currentDisplay != m_displayIndex )
 {
 wxLogTrace( traceDisplayLocation, wxT( "OnSize: current display changed %d to %d" ),
 m_displayIndex, currentDisplay );
 m_displayIndex = currentDisplay;
 ensureWindowIsOnScreen();
 }
#endif

 aEvent.Skip();
}

References ensureWindowIsOnScreen(), m_displayIndex, and traceDisplayLocation.

Referenced by EDA_DRAW_FRAME::OnSize().

onSystemColorChange()

void EDA_BASE_FRAME::onSystemColorChange ( wxSysColourChangedEvent &  aEvent )

protected

Definition at line 1277 of file eda_base_frame.cpp.

{
 // Call the handler to update the colors used in the frame
 HandleSystemColorChange();

 // Skip the change event to ensure the rest of the window controls get it
 aEvent.Skip();
}

References HandleSystemColorChange().

PopCommandFromRedoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromRedoList ( )

virtual

Return the last command to undo and remove it from list, nothing is deleted.

Definition at line 1197 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

Return the last command to undo and remove it from list, nothing is deleted.

Definition at line 1191 of file eda_base_frame.cpp.

{
 return m_undoList.PopCommand();
}

References m_undoList, and UNDO_REDO_CONTAINER::PopCommand().

Referenced by SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_FRAME::RollbackSchematicFromUndo(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), PCB_EDIT_FRAME::RunActionPlugin(), 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 );
 evt.SetReactivate( true );
 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, TOOL_EVENT::SetHasPosition(), and TOOL_EVENT::SetReactivate().

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(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), DRAWING_TOOL::InteractivePlaceWithPreview(), ZOOM_TOOL::Main(), PCB_PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), BOARD_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SYMBOL_EDITOR_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 835 of file eda_base_frame.cpp.

{
 SetStatusText( text );
}

References text.

Referenced by KICAD_MANAGER_CONTROL::Execute(), TERMINATE_HANDLER::OnTerminate(), and KICAD_MANAGER_FRAME::OnUnarchiveFiles().

Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const

inherited

Return a reference to the PROJECT associated with this KIWAY.

Definition at line 36 of file kiway_holder.cpp.

{
 return Kiway().Prj();
}

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_LIBRARY_MANAGER::addLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), SCH_EDIT_FRAME::AppendSchematic(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLibrariesListBox(), SIM_PLOT_FRAME::canCloseWindow(), PANEL_FP_PROPERTIES_3D_MODEL::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), PCB_BASE_EDIT_FRAME::createNewLibrary(), PCB_BASE_EDIT_FRAME::CreateNewProjectLibrary(), DIALOG_PLOT_SCHEMATIC::createPDFFile(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::CreateScreens(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_NETLIST_IMPORT::DIALOG_NETLIST_IMPORT(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), SYMBOL_VIEWER_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), BOARD_EDITOR_CONTROL::ExportNetlist(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SYMBOL_EDITOR_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), SYMBOL_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SIM_PLOT_FRAME::getDefaultFilename(), SIM_PLOT_FRAME::getDefaultPath(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), SCH_BASE_FRAME::GetLibSymbol(), DIALOG_PLOT_SCHEMATIC::getOutputPath(), KICAD_MANAGER_FRAME::GetProjectFileName(), SCH_EDIT_FRAME::GetSchematicJunctionSize(), SYMBOL_VIEWER_FRAME::GetSelectedSymbol(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), SCH_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), SIM_PLOT_FRAME::LoadSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), LoadWindowState(), SIM_PLOT_FRAME::loadWorkbook(), SIM_PLOT_FRAME::menuSaveWorkbook(), SIM_PLOT_FRAME::menuSaveWorkbookAs(), PANEL_FP_PROPERTIES_3D_MODEL::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_NETLIST_IMPORT::onBrowseNetlistFiles(), WX_HTML_REPORT_PANEL::onBtnSaveToFile(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_SYMBOLS_LIBID::onClickOrphansButton(), DIALOG_EXPORT_STEP::onExportButton(), DIALOG_GENDRILL::OnGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), DIALOG_CONFIG_EQUFILES::OnOkClick(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_SCHEMATIC_SETUP::OnPageChange(), DIALOG_BOARD_SETUP::OnPageChange(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), DIALOG_TEXT_AND_LABEL_PROPERTIES::onScintillaCharAdded(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), DIALOG_SPICE_MODEL::onSelectLibrary(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), SCH_BASE_FRAME::PickSymbolFromLibTree(), DIALOG_PLOT_SCHEMATIC::plotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetHpgl(), DIALOG_CHOOSE_SYMBOL::PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), EDA_DRAW_FRAME::PrintDrawingSheet(), SCH_EDIT_FRAME::PrintPage(), KICAD_MANAGER_FRAME::PrintPrjInfo(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), SYMBOL_VIEWER_FRAME::ReCreateSymbolList(), PANEL_FP_PROPERTIES_3D_MODEL::ReloadModelsFromFootprint(), EDA_3D_VIEWER_FRAME::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), SYMBOL_EDIT_FRAME::saveLibrary(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SCH_EDIT_FRAME::saveSchematicFile(), SIM_PLOT_FRAME::SaveSettings(), SaveSettings(), SYMBOL_EDIT_FRAME::saveSymbolAs(), SCH_BASE_FRAME::saveSymbolLibTables(), SIM_PLOT_FRAME::saveWorkbook(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectLibrary(), SYMBOL_EDIT_FRAME::SelectLibraryFromList(), PCB_BASE_EDIT_FRAME::selectLibTable(), SYMBOL_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), SYMBOL_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), SYMBOL_EDIT_FRAME::SetCurSymbol(), GERBVIEW_FRAME::SetPageSettings(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_SYMBOL::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), SYMBOL_VIEWER_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SYMBOL_LIBRARY_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER_FRAME::takeScreenshot(), PANEL_SETUP_RULES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), SCH_EDIT_FRAME::updateAutoSaveFile(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), SIM_PLOT_FRAME::updateTitle(), FOOTPRINT_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::UpdateTitle(), PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), PANEL_FP_PROPERTIES_3D_MODEL::~PANEL_FP_PROPERTIES_3D_MODEL(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

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 258 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( Pgm().m_Quitting )
 return true;

 if( !m_isClosing && m_hasAutoSave && IsShown() && 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, m_isClosing, Pgm(), and traceAutoSave.

Referenced by COMMON_TOOLS::GridProperties(), SYMBOL_VIEWER_FRAME::onSelectNextSymbol(), SYMBOL_VIEWER_FRAME::onSelectPreviousSymbol(), KIWAY::ProcessEvent(), and SYMBOL_VIEWER_FRAME::ReCreateSymbolList().

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

{}

Referenced by KIWAY::ProjectChanged().

PushCommandToRedoList()

void EDA_BASE_FRAME::PushCommandToRedoList ( PICKED_ITEMS_LIST *  aItem )

virtual

Add a command to redo in the redo list.

Delete the very old commands when the max count of redo commands is reached.

Definition at line 1176 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

Add a command to undo in the undo list.

Delete the very old commands when the max count of undo commands is reached.

Definition at line 1161 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(), PCB_EDIT_FRAME::RunActionPlugin(), PL_EDITOR_FRAME::SaveCopyInUndoList(), SYMBOL_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::StartNewUndo(), and SCH_EDITOR_CONTROL::Undo().

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(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), DRAWING_TOOL::InteractivePlaceWithPreview(), ZOOM_TOOL::Main(), PCB_PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), BOARD_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SYMBOL_EDITOR_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 or icons are changed

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

Definition at line 455 of file eda_base_frame.cpp.

{
}

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

RefreshCanvas()

virtual void TOOLS_HOLDER::RefreshCanvas ( )

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 153 of file tools_holder.h.

{ }

Referenced by ACTION_TOOLBAR::onPaletteEvent(), ACTION_TOOLBAR::onToolEvent(), and 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 63 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 352 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(), GERBVIEW_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), EDA_3D_VIEWER_FRAME::setupUIConditions(), KICAD_MANAGER_FRAME::setupUIConditions(), and 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 does nothing.

Parameters

aAskForSave

true to open a dialog before saving the settings.

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 372 of file eda_base_frame.h.

{};

Referenced by DIALOG_PAGES_SETTINGS::TransferDataFromWindow().

SaveSettings()

void EDA_BASE_FRAME::SaveSettings ( APP_SETTINGS_BASE *  aCfg )

virtual

Save 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 PCB_BASE_FRAME, EDA_DRAW_FRAME, CVPCB_MAINFRAME, GERBVIEW_FRAME, PCB_EDIT_FRAME, SYMBOL_EDIT_FRAME, PL_EDITOR_FRAME, SCH_EDIT_FRAME, FOOTPRINT_WIZARD_FRAME, BM2CMP_FRAME, SIM_PLOT_FRAME, KICAD_MANAGER_FRAME, FOOTPRINT_VIEWER_FRAME, EDA_3D_VIEWER_FRAME, SCH_BASE_FRAME, SYMBOL_VIEWER_FRAME, PCB_CALCULATOR_FRAME, FOOTPRINT_EDIT_FRAME, and DISPLAY_FOOTPRINTS_FRAME.

Definition at line 783 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(), EDA_3D_VIEWER_FRAME::SaveSettings(), KICAD_MANAGER_FRAME::SaveSettings(), SIM_PLOT_FRAME::SaveSettings(), BM2CMP_FRAME::SaveSettings(), CVPCB_MAINFRAME::SaveSettings(), EDA_DRAW_FRAME::SaveSettings(), and windowClosing().

SaveWindowSettings()

void EDA_BASE_FRAME::SaveWindowSettings

(

WINDOW_SETTINGS *

aCfg

)

Save 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 723 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, wxT( "Saving window maximized: %s" ),
 IsMaximized() ? wxT( "true" ) : wxT( "false" ) );
 wxLogTrace( traceDisplayLocation, wxT( "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 persistence 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, text, and traceDisplayLocation.

Referenced by SaveSettings().

SetAutoSaveInterval()

void EDA_BASE_FRAME::SetAutoSaveInterval

(

int

aInterval

)

Definition at line 301 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

It is only used for debugging, since "this" is not a wxWindow*.

"this" is a KIWAY_HOLDER mix-in.

Parameters

aDest	is the recipient of aKiway pointer.
aKiway	is often from a parent window or from KIFACE::CreateWindow().

Definition at line 43 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;
 ignore_unused( breakhere );
 }
#endif

 ignore_unused( aDest );

 m_kiway = aKiway;
}

References ignore_unused(), KIWAY_HOLDER::m_kiway, and name.

Referenced by BM2CMP_FRAME::BM2CMP_FRAME(), PCB::IFACE::CreateWindow(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), 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 428 of file eda_base_frame.h.

{ m_mruPath = aPath; }

References m_mruPath.

Referenced by AskLoadBoardFileName(), GERBVIEW_CONTROL::ExportToPcbnew(), PANEL_HOTKEYS_EDITOR::ImportHotKeys(), EDA_DRAW_FRAME::LibraryFileBrowser(), 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 PCB_EDIT_FRAME, GERBVIEW_FRAME, SYMBOL_EDIT_FRAME, CVPCB_MAINFRAME, FOOTPRINT_EDIT_FRAME, PL_EDITOR_FRAME, SCH_EDIT_FRAME, KICAD_MANAGER_FRAME, SYMBOL_VIEWER_FRAME, EDA_3D_VIEWER_FRAME, DISPLAY_FOOTPRINTS_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 435 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(), DISPLAY_FOOTPRINTS_FRAME::setupUIConditions(), EDA_3D_VIEWER_FRAME::setupUIConditions(), SYMBOL_VIEWER_FRAME::setupUIConditions(), KICAD_MANAGER_FRAME::setupUIConditions(), SCH_EDIT_FRAME::setupUIConditions(), PL_EDITOR_FRAME::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), CVPCB_MAINFRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), GERBVIEW_FRAME::setupUIConditions(), and PCB_EDIT_FRAME::setupUIConditions().

SetUserUnits()

void EDA_BASE_FRAME::SetUserUnits ( EDA_UNITS  aUnits )

inline

Definition at line 131 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 ( )

overridevirtual

Redraw the menus and what not in current language.

Reimplemented from TOOLS_HOLDER.

Reimplemented in PCB_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, PCB_BASE_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 480 of file eda_base_frame.cpp.

{
 TOOLS_HOLDER::ShowChangedLanguage();

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

References ReCreateMenuBar(), and TOOLS_HOLDER::ShowChangedLanguage().

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() [1/2]

void EDA_BASE_FRAME::ShowInfoBarError	(	const wxString &	aErrorMsg,
		bool	aShowCloseButton = false,
		WX_INFOBAR::MESSAGE_TYPE	aType = WX_INFOBAR::MESSAGE_TYPE::GENERIC
	)

Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right.

The infobar will be closed after a timeout.

Parameters

aErrorMsg	is the message to display.
aShowCloseButton	true to show a close button on the right of the WX_INFOBAR.

Definition at line 869 of file eda_base_frame.cpp.

{
 m_infoBar->RemoveAllButtons();

 if( aShowCloseButton )
 m_infoBar->AddCloseButton();

 GetInfoBar()->ShowMessageFor( aErrorMsg, 8000, wxICON_ERROR, aType );
}

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

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbol(), SCH_EDITOR_CONTROL::AssignNetclass(), MICROWAVE_TOOL::createInductorBetween(), PCB_BASE_EDIT_FRAME::createNewLibrary(), MICROWAVE_TOOL::createPolygonShape(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawVia(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), SYMBOL_EDIT_FRAME::ExportSymbol(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), PL_EDITOR_FRAME::LoadDrawingSheetFile(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), ROUTER_TOOL::prepareInteractive(), GERBVIEW_FRAME::Read_EXCELLON_File(), GERBVIEW_FRAME::Read_GERBER_File(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SYMBOL_EDIT_FRAME::saveLibrary(), SYMBOL_EDIT_FRAME::SelectLibraryFromList(), EE_INSPECTION_TOOL::ShowDatasheet(), SCH_DRAWING_TOOLS::SingleClickPlace(), and SYMBOL_EDITOR_EDIT_TOOL::UpdateSymbolFields().

ShowInfoBarError() [2/2]

void EDA_BASE_FRAME::ShowInfoBarError	(	const wxString &	aErrorMsg,
		bool	aShowCloseButton,
		std::function< void(void)>	aCallback
	)

Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right.

The infobar will be closed after a timeout.

This version accepts a callback which will be called when the infobar is dismissed (either as a result of user action or a timeout). This can be useful when the caller wants to make other decorations in the canvas to highlight the error.

Parameters

aErrorMsg	is the message to display.
aShowCloseButton	true to show a close button on the right of the WX_INFOBAR.
aCallback	a callback to be called when the infobar is dismissed.

Definition at line 881 of file eda_base_frame.cpp.

{
 m_infoBar->RemoveAllButtons();

 if( aShowCloseButton )
 m_infoBar->AddCloseButton();

 if( aCallback )
 m_infoBar->SetCallback( aCallback );

 GetInfoBar()->ShowMessageFor( aErrorMsg, 6000, wxICON_ERROR );
}

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

ShowInfoBarMsg()

void EDA_BASE_FRAME::ShowInfoBarMsg	(	const wxString &	aMsg,
		bool	aShowCloseButton = false
	)

Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar.

The infobar will be closed after a timeout.

Parameters

aErrorMsg	is the message to display.
aShowCloseButton	true to show a close button on the right of the WX_INFOBAR.

Definition at line 907 of file eda_base_frame.cpp.

{
 m_infoBar->RemoveAllButtons();

 if( aShowCloseButton )
 m_infoBar->AddCloseButton();

 GetInfoBar()->ShowMessageFor( aMsg, 8000, wxICON_INFORMATION );
}

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

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_DRAWING_TOOLS::DrawSheet(), EDIT_TOOL::FilletTracks(), PL_EDIT_TOOL::Main(), SCH_MOVE_TOOL::Main(), LENGTH_TUNER_TOOL::performTuning(), SCH_DRAWING_TOOLS::PlaceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DIALOG_FIND::search(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

ShowInfoBarWarning()

void EDA_BASE_FRAME::ShowInfoBarWarning	(	const wxString &	aWarningMsg,
		bool	aShowCloseButton = false
	)

Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar.

The infobar will be closed after a timeout.

Parameters

aErrorMsg	is the message to display.
aShowCloseButton	true to show a close button on the right of the WX_INFOBAR.

Definition at line 896 of file eda_base_frame.cpp.

{
 m_infoBar->RemoveAllButtons();

 if( aShowCloseButton )
 m_infoBar->AddCloseButton();

 GetInfoBar()->ShowMessageFor( aWarningMsg, 6000, wxICON_WARNING );
}

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

Referenced by PL_EDITOR_FRAME::LoadDrawingSheetFile(), and SCH_EDIT_TOOL::RepeatDrawItem().

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

{
 return Kiface().KifaceSearch();
}

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

ThemeChanged()

void EDA_BASE_FRAME::ThemeChanged ( )

virtual

Process light/dark theme change.

Reimplemented in PCB_EDIT_FRAME.

Definition at line 516 of file eda_base_frame.cpp.

{
 ClearScaledBitmapCache();

 // Update all the toolbars to have new icons
 wxAuiPaneInfoArray panes = m_auimgr.GetAllPanes();

 for( size_t i = 0; i < panes.GetCount(); ++i )
 {
 if( ACTION_TOOLBAR* toolbar = dynamic_cast<ACTION_TOOLBAR*>( panes[i].window ) )
 toolbar->RefreshBitmaps();
 }
}

References ClearScaledBitmapCache(), and m_auimgr.

Referenced by CommonSettingsChanged(), HandleSystemColorChange(), and PCB_EDIT_FRAME::ThemeChanged().

ToggleUserUnits()

virtual void EDA_BASE_FRAME::ToggleUserUnits ( )

inlinevirtual

Reimplemented in EDA_DRAW_FRAME.

Definition at line 138 of file eda_base_frame.h.

{ }

Referenced by DIALOG_SHIM::OnCharHook().

ToolStackIsEmpty()

bool TOOLS_HOLDER::ToolStackIsEmpty ( )

inlineinherited

Definition at line 116 of file tools_holder.h.

{ return m_toolStack.empty(); }

References TOOLS_HOLDER::m_toolStack.

Referenced by PCB_VIEWER_TOOLS::Init(), BOARD_EDITOR_CONTROL::Init(), PCB_SELECTION_TOOL::Init(), EDIT_TOOL::Init(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), PL_SELECTION_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), PCB_SELECTION_TOOL::Main(), EDITOR_CONDITIONS::noToolFunc(), EE_SELECTION_TOOL::OnIdle(), PCB_SELECTION_TOOL::OnIdle(), PL_POINT_EDITOR::setEditedPoint(), EE_POINT_EDITOR::setEditedPoint(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), BOARD_EDITOR_CONTROL::ViaSizeDec(), and BOARD_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 GERBVIEW_FRAME, EDA_DRAW_FRAME, PCB_BASE_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 638 of file eda_base_frame.h.

{ }

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 83 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 365 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 918 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(), PL_EDITOR_FRAME::LoadDrawingSheetFile(), GERBVIEW_FRAME::LoadExcellonFiles(), GERBVIEW_FRAME::LoadGerberJobFile(), GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles(), KICAD_MANAGER_FRAME::LoadProject(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_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, SCH_BASE_FRAME, PL_EDITOR_FRAME, and GERBVIEW_FRAME.

Definition at line 491 of file eda_base_frame.h.

{ }

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 196 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 commonInit().

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

Referenced by GERBVIEW_FRAME::ReCreateAuxiliaryToolbar(), PCB_EDIT_FRAME::ReCreateAuxiliaryToolbar(), KICAD_MANAGER_FRAME::RecreateBaseHToolbar(), DISPLAY_FOOTPRINTS_FRAME::ReCreateHToolbar(), GERBVIEW_FRAME::ReCreateHToolbar(), SYMBOL_VIEWER_FRAME::ReCreateHToolbar(), PL_EDITOR_FRAME::ReCreateHToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateHToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateHToolbar(), FOOTPRINT_WIZARD_FRAME::ReCreateHToolbar(), CVPCB_MAINFRAME::ReCreateHToolbar(), SCH_EDIT_FRAME::ReCreateHToolbar(), SYMBOL_EDIT_FRAME::ReCreateHToolbar(), PCB_EDIT_FRAME::ReCreateHToolbar(), EDA_3D_VIEWER_FRAME::ReCreateMainToolbar(), DISPLAY_FOOTPRINTS_FRAME::ReCreateOptToolbar(), GERBVIEW_FRAME::ReCreateOptToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateOptToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateOptToolbar(), PL_EDITOR_FRAME::ReCreateOptToolbar(), SCH_EDIT_FRAME::ReCreateOptToolbar(), SYMBOL_EDIT_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 704 of file eda_base_frame.h.

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

m_actions

ACTIONS* TOOLS_HOLDER::m_actions

protectedinherited

Definition at line 159 of file tools_holder.h.

Referenced by FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PL_EDITOR_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), KICAD_MANAGER_FRAME::setupTools(), CVPCB_MAINFRAME::setupTools(), SYMBOL_EDIT_FRAME::setupTools(), GERBVIEW_FRAME::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 706 of file eda_base_frame.h.

Referenced by CreateInfoBar(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), FinishAUIInitialization(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), FOOTPRINT_EDIT_FRAME::IsSearchTreeShown(), SYMBOL_EDIT_FRAME::IsSymbolTreeShown(), KICAD_MANAGER_FRAME::OnSize(), SYMBOL_VIEWER_FRAME::OnSize(), FOOTPRINT_WIZARD_FRAME::OnSize(), FOOTPRINT_VIEWER_FRAME::OnSize(), SYMBOL_EDIT_FRAME::OnToggleSymbolTree(), GERBVIEW_FRAME::ReCreateAuxiliaryToolbar(), PCB_EDIT_FRAME::ReCreateAuxiliaryToolbar(), KICAD_MANAGER_FRAME::RecreateBaseHToolbar(), DISPLAY_FOOTPRINTS_FRAME::ReCreateHToolbar(), GERBVIEW_FRAME::ReCreateHToolbar(), SYMBOL_VIEWER_FRAME::ReCreateHToolbar(), PL_EDITOR_FRAME::ReCreateHToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateHToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateHToolbar(), FOOTPRINT_WIZARD_FRAME::ReCreateHToolbar(), CVPCB_MAINFRAME::ReCreateHToolbar(), SCH_EDIT_FRAME::ReCreateHToolbar(), SYMBOL_EDIT_FRAME::ReCreateHToolbar(), PCB_EDIT_FRAME::ReCreateHToolbar(), EDA_3D_VIEWER_FRAME::ReCreateMainToolbar(), DISPLAY_FOOTPRINTS_FRAME::ReCreateOptToolbar(), GERBVIEW_FRAME::ReCreateOptToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateOptToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateOptToolbar(), PL_EDITOR_FRAME::ReCreateOptToolbar(), SCH_EDIT_FRAME::ReCreateOptToolbar(), SYMBOL_EDIT_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::refreshAfterSymbolSearch(), FOOTPRINT_WIZARD_FRAME::SaveSettings(), SaveWindowSettings(), PCB_BASE_FRAME::SetDrawBgColor(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), GERBVIEW_FRAME::ShowChangedLanguage(), FOOTPRINT_EDIT_FRAME::ShowChangedLanguage(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), ThemeChanged(), GERBVIEW_FRAME::ToggleLayerManager(), FOOTPRINT_EDIT_FRAME::ToggleLayersManager(), PCB_EDIT_FRAME::ToggleLayersManager(), FOOTPRINT_EDIT_FRAME::ToggleSearchTree(), GERBVIEW_FRAME::updateDCodeSelectBox(), GERBVIEW_FRAME::UpdateTitleAndInfo(), CVPCB_MAINFRAME::~CVPCB_MAINFRAME(), EDA_3D_VIEWER_FRAME::~EDA_3D_VIEWER_FRAME(), 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 720 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 719 of file eda_base_frame.h.

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

m_autoSaveTimer

wxTimer* EDA_BASE_FRAME::m_autoSaveTimer

protected

Definition at line 721 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 711 of file eda_base_frame.h.

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

m_displayIndex

int EDA_BASE_FRAME::m_displayIndex

protected

Definition at line 698 of file eda_base_frame.h.

Referenced by LoadWindowState(), and OnSize().

m_dragAction

MOUSE_DRAG_ACTION TOOLS_HOLDER::m_dragAction

protectedinherited

Definition at line 175 of file tools_holder.h.

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

m_dummySelection

SELECTION TOOLS_HOLDER::m_dummySelection

protectedinherited

Definition at line 162 of file tools_holder.h.

Referenced by TOOLS_HOLDER::GetCurrentSelection().

m_fileHistory

FILE_HISTORY* EDA_BASE_FRAME::m_fileHistory

protected

Definition at line 716 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 695 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 696 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(), SYMBOL_VIEWER_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 718 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 694 of file eda_base_frame.h.

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

m_immediateActions

bool TOOLS_HOLDER::m_immediateActions

protectedinherited

Definition at line 171 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 709 of file eda_base_frame.h.

Referenced by SCH_EDIT_FRAME::ClearFindReplaceStatus(), CreateInfoBar(), GetInfoBar(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), PL_EDITOR_FRAME::LoadDrawingSheetFile(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), SYMBOL_EDIT_FRAME::saveAllLibraries(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::ShowFindReplaceStatus(), ShowInfoBarError(), ShowInfoBarMsg(), and ShowInfoBarWarning().

m_isClosing

bool EDA_BASE_FRAME::m_isClosing

protected

Set by NonUserClose() to indicate that the user did not request the current close.

Definition at line 737 of file eda_base_frame.h.

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

m_isNonUserClose

bool EDA_BASE_FRAME::m_isNonUserClose

protected

Definition at line 740 of file eda_base_frame.h.

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

m_maximizeByDefault

bool EDA_BASE_FRAME::m_maximizeByDefault

protected

Definition at line 697 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 177 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 728 of file eda_base_frame.h.

Referenced by FOOTPRINT_EDIT_FRAME::ExportFootprint(), BM2CMP_FRAME::exportPcbnewFormat(), SYMBOL_EDIT_FRAME::ExportSymbol(), GetMruPath(), FOOTPRINT_EDIT_FRAME::ImportFootprint(), SYMBOL_EDIT_FRAME::ImportSymbol(), 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 701 of file eda_base_frame.h.

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

m_normalFrameSize

wxSize EDA_BASE_FRAME::m_normalFrameSize

protected

Definition at line 702 of file eda_base_frame.h.

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

m_perspective

wxString EDA_BASE_FRAME::m_perspective

protected

Definition at line 707 of file eda_base_frame.h.

Referenced by LoadWindowSettings().

m_redoList

UNDO_REDO_CONTAINER EDA_BASE_FRAME::m_redoList

protected

Definition at line 726 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 714 of file eda_base_frame.h.

Referenced by GetSettingsManager().

m_toolDispatcher

TOOL_DISPATCHER* TOOLS_HOLDER::m_toolDispatcher

protectedinherited

Definition at line 160 of file tools_holder.h.

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), PANEL_PREVIEW_3D_MODEL::OnMenuEvent(), OnMenuEvent(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PL_EDITOR_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), KICAD_MANAGER_FRAME::setupTools(), SYMBOL_EDIT_FRAME::setupTools(), GERBVIEW_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 158 of file tools_holder.h.

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), SCH_EDIT_FRAME::AddJunction(), AddStandardHelpMenu(), EDA_DRAW_FRAME::AddStandardSubMenus(), SCH_EDIT_FRAME::AnnotateSymbols(), SCH_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::CheckAnnotate(), GERBVIEW_FRAME::Clear_DrawLayers(), EDA_DRAW_FRAME::CommonSettingsChanged(), SCH_EDIT_FRAME::ConvertPart(), EDA_3D_VIEWER_FRAME::CreateMenuBar(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), SYMBOL_VIEWER_FRAME::DClickOnCmpList(), SCH_EDIT_FRAME::DeleteAnnotation(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_FRAME::DisplayCurrentSheet(), GERBVIEW_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), SYMBOL_EDIT_FRAME::emptyScreen(), GERBVIEW_FRAME::Erase_Current_DrawLayer(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDIT_FRAME::FixupJunctions(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), FOOTPRINT_EDIT_FRAME::GetCurrentSelection(), FOOTPRINT_VIEWER_FRAME::GetCurrentSelection(), PL_EDITOR_FRAME::GetCurrentSelection(), DISPLAY_FOOTPRINTS_FRAME::GetCurrentSelection(), SYMBOL_EDIT_FRAME::GetCurrentSelection(), SCH_EDIT_FRAME::GetCurrentSelection(), SYMBOL_VIEWER_FRAME::GetCurrentSelection(), GERBVIEW_FRAME::GetCurrentSelection(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), TOOLS_HOLDER::GetToolManager(), EDA_DRAW_FRAME::GetUnitPair(), PL_EDITOR_FRAME::HardRedraw(), SYMBOL_EDIT_FRAME::HardRedraw(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::initScreenZoom(), PCB_EDIT_FRAME::KiwayMailIn(), SCH_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), PCB_EDIT_FRAME::OnEditItemRequest(), SCH_EDIT_FRAME::OnFindDialogClose(), SCH_EDIT_FRAME::OnImportProject(), PL_EDITOR_FRAME::OnNewDrawingSheet(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), EDA_DRAW_FRAME::OnSelectGrid(), SYMBOL_EDIT_FRAME::OnSelectUnit(), EDA_DRAW_FRAME::OnSelectZoom(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), TOOLS_HOLDER::PopTool(), TOOLS_HOLDER::PushTool(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), SYMBOL_VIEWER_FRAME::ReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::ReCreateMenuBar(), SYMBOL_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), CVPCB_MAINFRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateOptToolbar(), SCH_EDIT_FRAME::ReCreateOptToolbar(), SYMBOL_EDIT_FRAME::ReCreateOptToolbar(), PCB_EDIT_FRAME::ReCreateOptToolbar(), PCB_EDIT_FRAME::ReCreateVToolbar(), CVPCB_MAINFRAME::refreshAfterSymbolSearch(), SCH_BASE_FRAME::RefreshSelection(), FOOTPRINT_WIZARD_FRAME::ReloadFootprint(), SCH_EDIT_FRAME::RollbackSchematicFromUndo(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SYMBOL_EDIT_FRAME::saveLibrary(), EDA_DRAW_FRAME::SaveSettings(), SCH_BASE_FRAME::SCH_BASE_FRAME(), SCH_EDIT_FRAME::SchematicCleanUp(), GERBVIEW_FRAME::SetActiveLayer(), PCB_BASE_EDIT_FRAME::SetBoard(), SYMBOL_EDIT_FRAME::SetCurSymbol(), SCH_EDIT_FRAME::SetScreen(), PL_EDITOR_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), KICAD_MANAGER_FRAME::setupTools(), CVPCB_MAINFRAME::setupTools(), SYMBOL_EDIT_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), FOOTPRINT_VIEWER_FRAME::setupUIConditions(), DISPLAY_FOOTPRINTS_FRAME::setupUIConditions(), EDA_3D_VIEWER_FRAME::setupUIConditions(), SYMBOL_VIEWER_FRAME::setupUIConditions(), KICAD_MANAGER_FRAME::setupUIConditions(), SCH_EDIT_FRAME::setupUIConditions(), PL_EDITOR_FRAME::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), CVPCB_MAINFRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), GERBVIEW_FRAME::setupUIConditions(), EDA_DRAW_FRAME::setupUnits(), TOOLS_HOLDER::ShowChangedLanguage(), EDA_DRAW_FRAME::ToggleUserUnits(), PCB_EDIT_FRAME::Tracks_and_Vias_Size_Event(), EDA_DRAW_FRAME::unitsChangeRefresh(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), FOOTPRINT_VIEWER_FRAME::updateView(), FOOTPRINT_EDIT_FRAME::UpdateView(), EDA_DRAW_FRAME::Zoom_Automatique(), CVPCB_MAINFRAME::~CVPCB_MAINFRAME(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), EDA_DRAW_FRAME::~EDA_DRAW_FRAME(), FOOTPRINT_EDIT_FRAME::~FOOTPRINT_EDIT_FRAME(), FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME(), FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME(), GERBVIEW_FRAME::~GERBVIEW_FRAME(), KICAD_MANAGER_FRAME::~KICAD_MANAGER_FRAME(), PL_EDITOR_FRAME::~PL_EDITOR_FRAME(), SCH_EDIT_FRAME::~SCH_EDIT_FRAME(), SYMBOL_EDIT_FRAME::~SYMBOL_EDIT_FRAME(), and SYMBOL_VIEWER_FRAME::~SYMBOL_VIEWER_FRAME().

m_toolStack

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

protectedinherited

Definition at line 164 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

Set by the close window event handler after frames are asked if they can close.

Allows other functions when called to know our state is cleanup.

Definition at line 733 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 725 of file eda_base_frame.h.

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

m_undoRedoCountMax

int EDA_BASE_FRAME::m_undoRedoCountMax

protected

Definition at line 723 of file eda_base_frame.h.

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

m_userUnits

EDA_UNITS EDA_BASE_FRAME::m_userUnits

protected

Map containing the UI update handlers registered with wx for each action.

Definition at line 730 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:

• eda_base_frame.h
• eda_base_frame.cpp