The CvPcb application main window. More...

#include <cvpcb_mainframe.h>

Inheritance diagram for CVPCB_MAINFRAME:

Public Types
enum	CVPCB_FILTER_ACTION { FILTER_DISABLE , FILTER_ENABLE , FILTER_TOGGLE }
	The action to apply to a footprint filter when it is modified. More...

enum	CONTROL_TYPE { CONTROL_NONE , CONTROL_LIBRARY , CONTROL_COMPONENT , CONTROL_FOOTPRINT }
	The type of the controls present in the application. More...

enum	FOCUS_DIR { CHANGE_FOCUS_RIGHT , CHANGE_FOCUS_LEFT }
	Directions to rotate the focus through the listboxes is. More...

enum	ITEM_DIR { ITEM_NEXT , ITEM_PREV }
	Directions to move when selecting items. More...

enum	CRITERIA { ALL_COMPONENTS , SEL_COMPONENTS , NA_COMPONENTS , ASSOC_COMPONENTS }
	Criteria to use to identify sets of components. More...

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

bool	OpenProjectFiles (const std::vector< wxString > &aFileSet, int aCtl=0) override
	Open a project or set of files given by aFileList. More...

void	KiwayMailIn (KIWAY_EXPRESS &aEvent) override
	Receive KIWAY_EXPRESS messages from other players. More...

bool	IsContentModified () const override
	Get if the current associations have been modified but not saved. More...

DISPLAY_FOOTPRINTS_FRAME *	GetFootprintViewerFrame () const

wxWindow *	GetToolCanvas () const override
	Canvas access. More...

CVPCB_MAINFRAME::CONTROL_TYPE	GetFocusedControl () const
	Find out which control currently has focus. More...

void	SetFocusedControl (CVPCB_MAINFRAME::CONTROL_TYPE aControl)
	Set the focus to a specific control. More...

void	OnSelectComponent (wxListEvent &event)
	Called when clicking on a component in component list window: More...

void	ReCreateHToolbar ()

void	ShowChangedLanguage () override

void	AutomaticFootprintMatching ()
	Called by the automatic association button Read *.equ files to try to find corresponding footprint for each component that is not already linked to a footprint ( a "free" component ) format of a line: 'cmp_ref' 'footprint_name'. More...

void	SetFootprintFilter (FOOTPRINTS_LISTBOX::FP_FILTER_T aFilter, CVPCB_MAINFRAME::CVPCB_FILTER_ACTION aAction)
	Set a filter criteria to either on/off or toggle the criteria. More...

void	UndoAssociation ()
	Undo the most recent associations that were performed. More...

void	RedoAssociation ()
	Redo the most recently undone association. More...

int	GetUndoCommandCount () const override

int	GetRedoCommandCount () const override

void	AssociateFootprint (const CVPCB_ASSOCIATION &aAssociation, bool aNewEntry=true, bool aAddUndoItem=true)
	Associate a footprint with a specific component in the list. More...

void	BuildSymbolsListBox ()

void	BuildFootprintsListBox ()

void	BuildLibrariesListBox ()

bool	SaveFootprintAssociation (bool doSaveSchematic)
	Save the edits that the user has done by sending them back to Eeschema via the kiway. More...

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

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

void	DisplayStatus ()
	Update the information displayed on the status bar at bottom of the main frame. More...

bool	LoadFootprintFiles ()
	Read the list of footprint (*.mod files) and generate the list of footprints. More...

void	SendComponentSelectionToSch (bool aClearSelectionOnly=false)
	Send a remote command to Eeschema via a socket,. More...

COMPONENT *	GetSelectedComponent ()
	Get the selected component from the component listbox. More...

void	SetSelectedComponent (int aIndex, bool aSkipUpdate=false)
	Set the currently selected component in the components listbox. More...

std::vector< unsigned int >	GetComponentIndices (CVPCB_MAINFRAME::CRITERIA aCriteria=CVPCB_MAINFRAME::ALL_COMPONENTS)
	Get the indices for all the components meeting the specified criteria in the components listbox. More...

wxString	GetSelectedFootprint ()

void	RefreshFootprintViewer ()

void	SetStatusText (const wxString &aText, int aNumber=0) override

virtual bool	ShowModal (wxString aResult=nullptr, wxWindow aResultantFocusWindow=nullptr)
	Show this wxFrame as if it were a modal dialog, with all other instantiated wxFrames disabled until this KIWAY_PLAYER derivative calls DismissModal(). More...

bool	Destroy () override
	Our version of Destroy() which is virtual from wxWidgets. More...

bool	IsModal () const override
	Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame. More...

void	SetModal (bool aIsModal)

bool	IsDismissed ()

void	DismissModal (bool aRetVal, const wxString &aResult=wxEmptyString)

void	CreateServer (int service, bool local=true)

void	OnSockRequest (wxSocketEvent &evt)

void	OnSockRequestServer (wxSocketEvent &evt)

virtual void	ExecuteRemoteCommand (const char *cmdline)
	Execute a remote command sent via socket (to port KICAD_PCB_PORT_SERVICE_NUMBER, currently 4242). More...

void	ChangeUserUnits (EDA_UNITS aUnits)

virtual void	ToggleUserUnits ()

ORIGIN_TRANSFORMS &	GetOriginTransforms () override
	Return a reference to the default ORIGIN_TRANSFORMS object. More...

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	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 (int aID) override
	Unregister a UI handler for a given ID that was registered using `RegisterUIUpdateHandler`. More...

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

virtual void	OnMove (wxMoveEvent &aEvent)

virtual void	OnSize (wxSizeEvent &aEvent)

void	OnMaximize (wxMaximizeEvent &aEvent)

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	ShowPreferences (wxString aStartPage, wxString aStartParentPage)
	Displays the preferences and settings of all opened editors paged dialog, starting with a particular page. 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...

void	LoadWindowState (const wxString &aFileName)

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

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 WINDOW_SETTINGS *	GetWindowSettings (APP_SETTINGS_BASE *aCfg)
	Return a pointer to the window settings for this frame. 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...

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

const wxString &	GetUntranslatedAboutTitle () const

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

int	GetMaxUndoItems () const

virtual void	OnModify ()
	Must be called after a model change in order to set the "modify" flag and do other frame-specific processing. More...

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 SELECTION &	GetCurrentSelection ()
	Get the current selection from the canvas area. More...

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

virtual void	PopTool (const TOOL_EVENT &aEvent)
	Pops a tool from the stack. More...

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

bool	HasKiway () const
	Safety check before asking for the Kiway reference. 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...

EDA_UNITS	GetUserUnits () const

void	SetUserUnits (EDA_UNITS aUnits)

const EDA_IU_SCALE &	GetIuScale () const

wxString	StringFromValue (double aValue, bool aAddUnitLabel=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
	Converts aValue in internal units into a united string. More...

wxString	StringFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=false)

wxString	MessageTextFromValue (double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
	A lower-precision version of StringFromValue(). More...

wxString	MessageTextFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=true)

int	ValueFromString (const wxString &aTextValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
	Converts aTextValue in aUnits to internal units used by the frame. More...

EDA_ANGLE	AngleValueFromString (const wxString &aTextValue)

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

Public Attributes
FOOTPRINT_LIST *	m_FootprintsList

Protected Member Functions
	CVPCB_MAINFRAME (KIWAY aKiway, wxWindow aParent)

void	doReCreateMenuBar () override

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

bool	canCloseWindow (wxCloseEvent &aCloseEvent) override

void	doCloseWindow () override

bool	readNetListAndFpFiles (const std::string &aNetlist)
	Load the netlist file built on the fly by Eeschema and loads footprint libraries from fp lib tables. More...

int	readSchematicNetlist (const std::string &aNetlist)
	Read the netlist (.net) file built on the fly by Eeschema. More...

void	kiway_express (KIWAY_EXPRESS &aEvent)
	event handler, routes to derivative specific virtual KiwayMailIn() More...

void	language_change (wxCommandEvent &event)
	An event handler called on a language menu selection. More...

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

virtual void	handleIconizeEvent (wxIconizeEvent &aEvent)
	Handle a window iconize event. More...

void	onIconize (wxIconizeEvent &aEvent)

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

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

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

virtual void	OnDropFiles (wxDropFilesEvent &aEvent)
	Handles event fired when a file is dropped to the window. More...

virtual void	DoWithAcceptedFiles ()
	Execute action on accepted dropped file. More...

Static Protected Member Functions
static wxString	GetAutoSaveFilePrefix ()

Protected Attributes
bool	m_modified

bool	m_skipComponentSelect

bool	m_initialized

bool	m_cannotClose

bool	m_modal

WX_EVENT_LOOP *	m_modal_loop
	< Points to nested event_loop. NULL means not modal and dismissed. More...

wxWindow *	m_modal_resultant_parent

wxString	m_modal_string

bool	m_modal_ret_val

wxSocketServer *	m_socketServer

std::vector< wxSocketBase * >	m_sockets
	interprocess communication More...

std::vector< wxFileName >	m_AcceptedFiles

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_supportsAutoSave

bool	m_autoSavePending

bool	m_autoSaveRequired

wxTimer *	m_autoSaveTimer

int	m_undoRedoCountMax

wxString	m_mruPath

ORIGIN_TRANSFORMS	m_originTransforms

std::map< int, UIUpdateHandler >	m_uiUpdateMap
	< Map containing the UI update handlers registered with wx for each action. More...

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

bool	m_isNonUserClose

std::map< const wxString, TOOL_ACTION * >	m_acceptedExts
	Associates files extensions with action to execute. More...

TOOL_MANAGER *	m_toolManager

ACTIONS *	m_actions

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
wxString	formatSymbolDesc (int idx, const wxString &aReference, const wxString &aValue, const wxString &aFootprint)

void	setupTools ()
	Setup the tool system for the CVPCB main frame. More...

void	setupEventHandlers ()
	Setup event handlers. More...

void	onTextFilterChanged (wxCommandEvent &event)

void	updateFootprintViewerOnIdle (wxIdleEvent &aEvent)

void	onTextFilterChangedTimer (wxTimerEvent &aEvent)

int	buildEquivalenceList (FOOTPRINT_EQUIVALENCE_LIST &aList, wxString *aErrorMessages=nullptr)
	Read the .equ files and populate the list of equivalents. More...

void	refreshAfterSymbolSearch (COMPONENT *aSymbol)

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

Private Attributes
NETLIST	m_netlist

int	m_filteringOptions

ACTION_TOOLBAR *	m_mainToolBar

FOOTPRINTS_LISTBOX *	m_footprintListBox

LIBRARY_LISTBOX *	m_librariesListBox

SYMBOLS_LISTBOX *	m_symbolsListBox

wxTextCtrl *	m_tcFilterString

wxStaticText *	m_statusLine1

wxStaticText *	m_statusLine2

wxStaticText *	m_statusLine3

wxButton *	m_saveAndContinue

TOOL_DISPATCHER *	m_toolDispatcher

ACTION_MENU *	m_footprintContextMenu

ACTION_MENU *	m_symbolsContextMenu

CVPCB_UNDO_REDO_LIST	m_undoList

CVPCB_UNDO_REDO_LIST	m_redoList

wxTimer *	m_filterTimer

bool	m_viewerPendingUpdate

KIWAY *	m_kiway

HOLDER_TYPE	m_type

const EDA_IU_SCALE &	m_iuScale

EDA_UNITS	m_userUnits

Friends
struct	CV::IFACE

Detailed Description

The CvPcb application main window.

Definition at line 56 of file cvpcb_mainframe.h.

Member Enumeration Documentation

◆ CONTROL_TYPE

enum CVPCB_MAINFRAME::CONTROL_TYPE

The type of the controls present in the application.

Enumerator
CONTROL_NONE	No controls have focus.
CONTROL_LIBRARY	Library listbox.
CONTROL_COMPONENT	Component listbox.
CONTROL_FOOTPRINT	Footprint listbox.

Definition at line 78 of file cvpcb_mainframe.h.

 {
 CONTROL_NONE, 
 CONTROL_LIBRARY, 
 CONTROL_COMPONENT, 
 CONTROL_FOOTPRINT 
 };

◆ CRITERIA

enum CVPCB_MAINFRAME::CRITERIA

Criteria to use to identify sets of components.

Enumerator
ALL_COMPONENTS	All components.
SEL_COMPONENTS	Selected components.
NA_COMPONENTS	Not associated components.
ASSOC_COMPONENTS	Associated components.

Definition at line 275 of file cvpcb_mainframe.h.

 {
 ALL_COMPONENTS, 
 SEL_COMPONENTS, 
 NA_COMPONENTS, 
 ASSOC_COMPONENTS 
 };

◆ CVPCB_FILTER_ACTION

enum CVPCB_MAINFRAME::CVPCB_FILTER_ACTION

The action to apply to a footprint filter when it is modified.

Enumerator
FILTER_DISABLE	Turn off the filter.
FILTER_ENABLE	Turn on the filter.
FILTER_TOGGLE	Toggle the filter state.

Definition at line 68 of file cvpcb_mainframe.h.

 {
 FILTER_DISABLE, 
 FILTER_ENABLE, 
 FILTER_TOGGLE 
 };

◆ FOCUS_DIR

enum CVPCB_MAINFRAME::FOCUS_DIR

Directions to rotate the focus through the listboxes is.

Enumerator
CHANGE_FOCUS_RIGHT
CHANGE_FOCUS_LEFT

Definition at line 89 of file cvpcb_mainframe.h.

 {
 CHANGE_FOCUS_RIGHT,
 CHANGE_FOCUS_LEFT
 };

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE

inherited

Enumerator
DIALOG
FRAME
PANEL

Definition at line 39 of file kiway_holder.h.

39{ DIALOG, FRAME, PANEL };

KIWAY_HOLDER::PANEL

@ PANEL

Definition: kiway_holder.h:39

KIWAY_HOLDER::DIALOG

@ DIALOG

Definition: kiway_holder.h:39

KIWAY_HOLDER::FRAME

@ FRAME

Definition: kiway_holder.h:39

◆ ITEM_DIR

enum CVPCB_MAINFRAME::ITEM_DIR

Directions to move when selecting items.

Enumerator
ITEM_NEXT	The next item.
ITEM_PREV	The previous item.

Definition at line 98 of file cvpcb_mainframe.h.

 {
 ITEM_NEXT, 
 ITEM_PREV 
 };

◆ UNDO_REDO_LIST

enum EDA_BASE_FRAME::UNDO_REDO_LIST

inherited

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

Enumerator
UNDO_LIST
REDO_LIST

Definition at line 111 of file eda_base_frame.h.

 {
 UNDO_LIST,
 REDO_LIST
 };

Constructor & Destructor Documentation

◆ ~CVPCB_MAINFRAME()

CVPCB_MAINFRAME::~CVPCB_MAINFRAME ( )

Definition at line 225 of file cvpcb_mainframe.cpp.

{
 // Stop the timer during destruction early to avoid potential race conditions (that do happen)
 m_filterTimer->Stop();
 
 // Shutdown all running tools
 if( m_toolManager )
 m_toolManager->ShutdownAllTools();
 
 // Clean up the tool infrastructure
 delete m_actions;
 delete m_toolManager;
 delete m_toolDispatcher;
 
 m_auimgr.UnInit();
}

References TOOLS_HOLDER::m_actions, EDA_BASE_FRAME::m_auimgr, m_filterTimer, m_toolDispatcher, TOOLS_HOLDER::m_toolManager, and TOOL_MANAGER::ShutdownAllTools().

◆ CVPCB_MAINFRAME()

CVPCB_MAINFRAME::CVPCB_MAINFRAME	(	KIWAY *	aKiway,
		wxWindow *	aParent
	)

protected

Definition at line 66 of file cvpcb_mainframe.cpp.

 :
 KIWAY_PLAYER( aKiway, aParent, FRAME_CVPCB, _( "Assign Footprints" ), wxDefaultPosition,
 wxDefaultSize, KICAD_DEFAULT_DRAWFRAME_STYLE, CVPCB_MAINFRAME_NAME,
 unityScale ),
 m_viewerPendingUpdate( false )
{
 m_symbolsListBox = nullptr;
 m_footprintListBox = nullptr;
 m_librariesListBox = nullptr;
 m_mainToolBar = nullptr;
 m_modified = false;
 m_cannotClose = false;
 m_skipComponentSelect = false;
 m_filteringOptions = FOOTPRINTS_LISTBOX::UNFILTERED_FP_LIST;
 m_tcFilterString = nullptr;
 m_FootprintsList = FOOTPRINT_LIST::GetInstance( Kiway() );
 m_initialized = false;
 m_aboutTitle = wxS( "CvPcb" );
 
 // Give an icon
 wxIcon icon;
 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_cvpcb ) );
 SetIcon( icon );
 
 SetAutoLayout( true );
 
 LoadSettings( config() );
 
 setupTools();
 setupUIConditions();
 ReCreateMenuBar();
 ReCreateHToolbar();
 
 // Create list of available footprints and symbols of the schematic
 BuildSymbolsListBox();
 BuildFootprintsListBox();
 
 m_librariesListBox = new LIBRARY_LISTBOX( this, ID_CVPCB_LIBRARY_LIST );
 m_librariesListBox->SetFont( KIUI::GetMonospacedUIFont() );
 
 m_auimgr.SetManagedWindow( this );
 
 m_auimgr.AddPane( m_mainToolBar, EDA_PANE().HToolbar().Name( "MainToolbar" ).Top().Layer(6) );
 
 m_auimgr.AddPane( m_librariesListBox, EDA_PANE().Palette().Name( "Libraries" ).Left().Layer(1)
 .Caption( _( "Footprint Libraries" ) )
 .BestSize((int) ( m_frameSize.x * 0.20 ), m_frameSize.y ) );
 
 m_auimgr.AddPane( m_symbolsListBox, EDA_PANE().Palette().Name( "Symbols" ).Center().Layer(0)
 .Caption( _( "Symbol : Footprint Assignments" ) ) );
 
 m_auimgr.AddPane( m_footprintListBox, EDA_PANE().Palette().Name( "Footprints" ).Right().Layer(1)
 .Caption( _( "Filtered Footprints" ) )
 .BestSize((int) ( m_frameSize.x * 0.30 ), m_frameSize.y ) );
 
 // Build the bottom panel, to display 2 status texts and the buttons:
 auto bottomPanel = new wxPanel( this );
 auto panelSizer = new wxBoxSizer( wxVERTICAL );
 
 wxFlexGridSizer* fgSizerStatus = new wxFlexGridSizer( 3, 1, 0, 0 );
 fgSizerStatus->SetFlexibleDirection( wxBOTH );
 fgSizerStatus->SetNonFlexibleGrowMode( wxFLEX_GROWMODE_SPECIFIED );
 
 m_statusLine1 = new wxStaticText( bottomPanel, wxID_ANY, wxEmptyString );
 fgSizerStatus->Add( m_statusLine1, 0, 0, 5 );
 
 m_statusLine2 = new wxStaticText( bottomPanel, wxID_ANY, wxEmptyString );
 fgSizerStatus->Add( m_statusLine2, 0, 0, 5 );
 
 m_statusLine3 = new wxStaticText( bottomPanel, wxID_ANY, wxEmptyString );
 fgSizerStatus->Add( m_statusLine3, 0, wxBOTTOM, 3 );
 
 panelSizer->Add( fgSizerStatus, 1, wxEXPAND|wxLEFT, 2 );
 
 m_statusLine1->SetFont( KIUI::GetStatusFont( this ) );
 m_statusLine2->SetFont( KIUI::GetStatusFont( this ) );
 m_statusLine3->SetFont( KIUI::GetStatusFont( this ) );
 
 // Add buttons:
 auto buttonsSizer = new wxBoxSizer( wxHORIZONTAL );
 auto sdbSizer = new wxStdDialogButtonSizer();
 
 m_saveAndContinue = new wxButton( bottomPanel, wxID_ANY,
 _( "Apply, Save Schematic && Continue" ) );
 buttonsSizer->Add( m_saveAndContinue, 0, wxALIGN_CENTER_VERTICAL|wxRIGHT, 20 );
 
 auto sdbSizerOK = new wxButton( bottomPanel, wxID_OK );
 sdbSizer->AddButton( sdbSizerOK );
 auto sdbSizerCancel = new wxButton( bottomPanel, wxID_CANCEL );
 sdbSizer->AddButton( sdbSizerCancel );
 sdbSizer->Realize();
 
 buttonsSizer->Add( sdbSizer, 0, 0, 5 );
 panelSizer->Add( buttonsSizer, 0, wxALIGN_RIGHT|wxALL, 5 );
 
 bottomPanel->SetSizer( panelSizer );
 bottomPanel->Fit();
 
 sdbSizerOK->SetDefault();
 KIPLATFORM::UI::FixupCancelButtonCmdKeyCollision( this );
 
 m_auimgr.AddPane( bottomPanel, EDA_PANE().HToolbar().Name( "Buttons" ).Bottom().Layer(6) );
 
 m_auimgr.Update();
 m_initialized = true;
 
 if( CVPCB_SETTINGS* cfg = dynamic_cast<CVPCB_SETTINGS*>( config() ) )
 {
 m_tcFilterString->ChangeValue( cfg->m_FilterString );
 
 if( cfg->m_LibrariesWidth > 0 )
 {
 wxAuiPaneInfo& librariesPane = m_auimgr.GetPane( "Libraries" );
 
 // wxAUI hack: force width by setting MinSize() and then Fixed()
 // thanks to ZenJu http://trac.wxwidgets.org/ticket/13180
 librariesPane.MinSize( cfg->m_LibrariesWidth, -1 );
 librariesPane.BestSize( cfg->m_LibrariesWidth, -1 );
 librariesPane.MaxSize( cfg->m_LibrariesWidth, -1 );
 librariesPane.Fixed();
 m_auimgr.Update();
 
 // now make it resizable again
 librariesPane.MinSize( 20, -1 );
 librariesPane.Resizable();
 m_auimgr.Update();
 }
 
 if( cfg->m_FootprintsWidth > 0 )
 {
 wxAuiPaneInfo& footprintsPane = m_auimgr.GetPane( "Footprints" );
 
 // wxAUI hack: force width by setting MinSize() and then Fixed()
 // thanks to ZenJu http://trac.wxwidgets.org/ticket/13180
 footprintsPane.MinSize( cfg->m_FootprintsWidth, -1 );
 footprintsPane.BestSize( cfg->m_FootprintsWidth, -1 );
 footprintsPane.MaxSize( cfg->m_FootprintsWidth, -1 );
 footprintsPane.Fixed();
 m_auimgr.Update();
 
 // now make it resizable again
 footprintsPane.MinSize( 20, -1 );
 footprintsPane.Resizable();
 m_auimgr.Update();
 }
 }
 
 // Connect Events
 setupEventHandlers();
 
 // Start the main processing loop
 m_toolManager->InvokeTool( "cvpcb.Control" );
 
 m_filterTimer->StartOnce( 100 );
 
 KIPLATFORM::APP::SetShutdownBlockReason( this, _( "Symbol to footprint changes are unsaved" ) );
}

References _, BuildFootprintsListBox(), BuildSymbolsListBox(), PCAD2KICAD::Center, EDA_BASE_FRAME::config(), KIPLATFORM::UI::FixupCancelButtonCmdKeyCollision(), FOOTPRINT_LIST::GetInstance(), KIUI::GetMonospacedUIFont(), KIUI::GetStatusFont(), icon_cvpcb, ID_CVPCB_LIBRARY_LIST, TOOL_MANAGER::InvokeTool(), KiBitmap(), KIWAY_HOLDER::Kiway(), PCAD2KICAD::Left, LoadSettings(), EDA_BASE_FRAME::m_aboutTitle, EDA_BASE_FRAME::m_auimgr, m_cannotClose, m_filteringOptions, m_filterTimer, m_footprintListBox, m_FootprintsList, EDA_BASE_FRAME::m_frameSize, m_initialized, m_librariesListBox, m_mainToolBar, m_modified, m_saveAndContinue, m_skipComponentSelect, m_statusLine1, m_statusLine2, m_statusLine3, m_symbolsListBox, m_tcFilterString, TOOLS_HOLDER::m_toolManager, ReCreateHToolbar(), EDA_BASE_FRAME::ReCreateMenuBar(), PCAD2KICAD::Right, KIPLATFORM::APP::SetShutdownBlockReason(), setupEventHandlers(), setupTools(), setupUIConditions(), and FOOTPRINTS_LISTBOX::UNFILTERED_FP_LIST.

Member Function Documentation

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar * aMenuBar )

inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 462 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(), doReCreateMenuBar(), SCH_EDIT_FRAME::doReCreateMenuBar(), SYMBOL_EDIT_FRAME::doReCreateMenuBar(), SYMBOL_VIEWER_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::doReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::doReCreateMenuBar(), and PCB_EDIT_FRAME::doReCreateMenuBar().

◆ AngleValueFromString()

EDA_ANGLE UNITS_PROVIDER::AngleValueFromString ( const wxString & aTextValue )

inlineinherited

Definition at line 116 of file units_provider.h.

 {
 double angle = EDA_UNIT_UTILS::UI::DoubleValueFromString( GetIuScale(), EDA_UNITS::DEGREES,
 aTextValue );
 
 return EDA_ANGLE( angle, DEGREES_T );
 }

References PNS::angle(), DEGREES, DEGREES_T, EDA_UNIT_UTILS::UI::DoubleValueFromString(), and UNITS_PROVIDER::GetIuScale().

Referenced by FP_TEXT_GRID_TABLE::SetValue().

◆ AssociateFootprint()

void CVPCB_MAINFRAME::AssociateFootprint	(	const CVPCB_ASSOCIATION &	aAssociation,
		bool	aNewEntry = `true`,
		bool	aAddUndoItem = `true`
	)

Associate a footprint with a specific component in the list.

Associations can be chained into a single undo/redo step by setting aNewEntry to false for every association other than the first one. This will create a new list entry for the first association, and add the subsequent associations to that list.

Parameters

aAssociation	is the association to perform
aNewEntry	specifies if this association should be a new entry in the undo list
aAddUndoItem	specifies if an undo item should be created for this association

Definition at line 613 of file cvpcb_mainframe.cpp.

{
 if( m_netlist.IsEmpty() )
 return;
 
 COMPONENT* symbol = m_netlist.GetComponent( aAssociation.GetComponentIndex() );
 
 if( symbol == nullptr )
 return;
 
 LIB_ID fpid = aAssociation.GetNewFootprint();
  LIB_ID oldFpid = symbol->GetFPID();
 
 // Test for validity of the requested footprint
 if( !fpid.empty() && !fpid.IsValid() )
 {
 wxString msg = wxString::Format( _( "'%s' is not a valid footprint." ),
 fpid.Format().wx_str() );
 DisplayErrorMessage( this, msg );
 return;
 }
 
 const KIID& id = symbol->GetKIIDs().front();
 
 // Set new footprint to all instances of the selected symbol
 for( unsigned int idx : GetComponentIndices() )
 {
 COMPONENT* candidate = m_netlist.GetComponent( idx );
 const std::vector<KIID>& kiids = candidate->GetKIIDs();
 
 if( std::find( kiids.begin(), kiids.end(), id ) != kiids.end() )
 {
 // Set the new footprint
 candidate->SetFPID( fpid );
 
 // create the new symbol description and set it
 wxString description = formatSymbolDesc( idx + 1,
 candidate->GetReference(),
 candidate->GetValue(),
 candidate->GetFPID().Format().wx_str() );
 m_symbolsListBox->SetString( idx, description );
 
 FOOTPRINT_INFO* fp =
 m_FootprintsList->GetFootprintInfo( symbol->GetFPID().Format().wx_str() );
 
 if( !fp )
 {
 m_symbolsListBox->AppendWarning( idx );
 }
 else
 {
 m_symbolsListBox->RemoveWarning( idx );
 }
 }
 }
 
 // Mark the data as being modified
 m_modified = true;
 
 // Update the statusbar and refresh the list
 DisplayStatus();
 m_symbolsListBox->Refresh();
 
 if( !aAddUndoItem )
 return;
 
 // Update the undo list
 if ( aNewEntry )
 {
 // Create a new entry for this association
 CVPCB_UNDO_REDO_ENTRIES newEntry;
 newEntry.emplace_back( CVPCB_ASSOCIATION( aAssociation.GetComponentIndex(), oldFpid,
  aAssociation.GetNewFootprint() ) );
 m_undoList.emplace_back( newEntry );
 
 // Clear the redo list
 m_redoList.clear();
 }
 else
 {
 m_undoList.back().emplace_back( CVPCB_ASSOCIATION( aAssociation.GetComponentIndex(),
 oldFpid,
 aAssociation.GetNewFootprint() ) );
 }
 
}

References _, SYMBOLS_LISTBOX::AppendWarning(), DisplayErrorMessage(), DisplayStatus(), LIB_ID::empty(), LIB_ID::Format(), Format(), formatSymbolDesc(), NETLIST::GetComponent(), CVPCB_ASSOCIATION::GetComponentIndex(), GetComponentIndices(), FOOTPRINT_LIST::GetFootprintInfo(), COMPONENT::GetFPID(), COMPONENT::GetKIIDs(), CVPCB_ASSOCIATION::GetNewFootprint(), COMPONENT::GetReference(), COMPONENT::GetValue(), NETLIST::IsEmpty(), LIB_ID::IsValid(), m_FootprintsList, m_modified, m_netlist, m_redoList, m_symbolsListBox, m_undoList, SYMBOLS_LISTBOX::RemoveWarning(), COMPONENT::SetFPID(), SYMBOLS_LISTBOX::SetString(), and UTF8::wx_str().

Referenced by CVPCB_ASSOCIATION_TOOL::Associate(), AutomaticFootprintMatching(), CVPCB_ASSOCIATION_TOOL::CutAssoc(), CVPCB_ASSOCIATION_TOOL::DeleteAll(), CVPCB_ASSOCIATION_TOOL::DeleteAssoc(), CVPCB_ASSOCIATION_TOOL::PasteAssoc(), RedoAssociation(), and UndoAssociation().

◆ AutomaticFootprintMatching()

void CVPCB_MAINFRAME::AutomaticFootprintMatching ( )

Called by the automatic association button Read *.equ files to try to find corresponding footprint for each component that is not already linked to a footprint ( a "free" component ) format of a line: 'cmp_ref' 'footprint_name'.

Definition at line 170 of file auto_associate.cpp.

{
 FOOTPRINT_EQUIVALENCE_LIST equivList;
 wxString msg;
 wxString error_msg;
 
 if( m_netlist.IsEmpty() )
 return;
 
 if( buildEquivalenceList( equivList, &error_msg ) )
 wxMessageBox( error_msg, _( "Equivalence File Load Error" ), wxOK | wxICON_WARNING, this );
 
 // Sort the association list by symbol value. When sorted, finding duplicate definitions
 // (i.e. 2 or more items having the same symbol value) is easier.
 std::sort( equivList.begin(), equivList.end(), sortListbyCmpValue );
 
 // Display the number of footprint/symbol equivalences.
 msg.Printf( _( "%lu footprint/symbol equivalences found." ), (unsigned long)equivList.size() );
 SetStatusText( msg, 0 );
 
 // Now, associate each free component with a footprint
 m_skipComponentSelect = true;
 error_msg.Empty();
 
 bool firstAssoc = true;
 for( unsigned kk = 0; kk < m_netlist.GetCount(); kk++ )
 {
 COMPONENT* component = m_netlist.GetComponent( kk );
 
 bool found = false;
 
 if( !component->GetFPID().empty() ) // the component has already a footprint
 continue;
 
 // Here a first attempt is made. We can have multiple equivItem of the same value.
 // When happens, using the footprint filter of components can remove the ambiguity by
 // filtering equivItem so one can use multiple equivList (for polar and non-polar caps
 // for example)
 wxString fpid_candidate;
 
 for( unsigned idx = 0; idx < equivList.size(); idx++ )
 {
 FOOTPRINT_EQUIVALENCE& equivItem = equivList[idx];
 
 if( equivItem.m_ComponentValue.CmpNoCase( component->GetValue() ) != 0 )
 continue;
 
 const FOOTPRINT_INFO *fp = m_FootprintsList->GetFootprintInfo( equivItem.m_FootprintFPID );
 
 bool equ_is_unique = true;
 unsigned next = idx+1;
 int previous = idx-1;
 
 if( next < equivList.size()
 && equivItem.m_ComponentValue == equivList[next].m_ComponentValue )
 {
 equ_is_unique = false;
 }
 
 if( previous >= 0
 && equivItem.m_ComponentValue == equivList[previous].m_ComponentValue )
 {
 equ_is_unique = false;
 }
 
 // If the equivalence is unique, no ambiguity: use the association
 if( fp && equ_is_unique )
 {
 AssociateFootprint( CVPCB_ASSOCIATION( kk, equivItem.m_FootprintFPID ),
 firstAssoc );
 firstAssoc = false;
 found = true;
 break;
 }
 
 // Store the first candidate found in list, when equivalence is not unique
 // We use it later.
 if( fp && fpid_candidate.IsEmpty() )
 fpid_candidate = equivItem.m_FootprintFPID;
 
 // The equivalence is not unique: use the footprint filter to try to remove
 // ambiguity
 // if the footprint filter does not remove ambiguity, we will use fpid_candidate
 if( fp )
 {
 size_t filtercount = component->GetFootprintFilters().GetCount();
 found = ( 0 == filtercount ); // if no entries, do not filter
 
 for( size_t jj = 0; jj < filtercount && !found; jj++ )
 found = fp->GetFootprintName().Matches( component->GetFootprintFilters()[jj] );
 }
 else
 {
 msg.Printf( _( "Component %s: footprint %s not found in any of the project "
 "footprint libraries." ),
 component->GetReference(), equivItem.m_FootprintFPID );
 
 if( ! error_msg.IsEmpty() )
 error_msg << wxT("\n\n");
 
 error_msg += msg;
 }
 
 if( found )
 {
 AssociateFootprint( CVPCB_ASSOCIATION( kk, equivItem.m_FootprintFPID ),
 firstAssoc );
 firstAssoc = false;
 break;
 }
 }
 
 if( found )
 {
 continue;
 }
 else if( !fpid_candidate.IsEmpty() )
 {
 AssociateFootprint( CVPCB_ASSOCIATION( kk, fpid_candidate ), firstAssoc );
 firstAssoc = false;
 continue;
 }
 
 // obviously the last chance: there's only one filter matching one footprint
 if( 1 == component->GetFootprintFilters().GetCount() )
 {
 // we do not need to analyze wildcards: single footprint do not
 // contain them and if there are wildcards it just will not match any
 if( m_FootprintsList->GetFootprintInfo( component->GetFootprintFilters()[0] ) )
 {
 AssociateFootprint( CVPCB_ASSOCIATION( kk, component->GetFootprintFilters()[0] ),
 firstAssoc );
 firstAssoc = false;
 }
 }
 }
 
 if( !error_msg.IsEmpty() )
 wxMessageBox( error_msg, _( "CvPcb Warning" ), wxOK | wxICON_WARNING, this );
 
 m_skipComponentSelect = false;
 m_symbolsListBox->Refresh();
}

References _, AssociateFootprint(), buildEquivalenceList(), LIB_ID::empty(), NETLIST::GetComponent(), NETLIST::GetCount(), COMPONENT::GetFootprintFilters(), FOOTPRINT_LIST::GetFootprintInfo(), FOOTPRINT_INFO::GetFootprintName(), COMPONENT::GetFPID(), COMPONENT::GetReference(), COMPONENT::GetValue(), NETLIST::IsEmpty(), FOOTPRINT_EQUIVALENCE::m_ComponentValue, FOOTPRINT_EQUIVALENCE::m_FootprintFPID, m_FootprintsList, m_netlist, m_skipComponentSelect, m_symbolsListBox, next(), SetStatusText(), and sortListbyCmpValue().

Referenced by CVPCB_ASSOCIATION_TOOL::AutoAssociate().

◆ buildEquivalenceList()

int CVPCB_MAINFRAME::buildEquivalenceList	(	FOOTPRINT_EQUIVALENCE_LIST &	aList,
		wxString *	aErrorMessages = `nullptr`
	)

private

Read the .equ files and populate the list of equivalents.

Parameters

aList	the list to populate
aErrorMessages	is a pointer to a wxString to store error messages (can be NULL)

Returns: the error count ( 0 = no error)

Definition at line 79 of file auto_associate.cpp.

{
 char line[1024];
 int error_count = 0;
 FILE* file;
 wxFileName fn;
 wxString tmp, error_msg;
 
 SEARCH_STACK& search = Kiface().KifaceSearch();
 PROJECT_FILE& project = Prj().GetProjectFile();
 
 // Find equivalences in all available files, and populates the
 // equiv_List with all equivalences found in .equ files
 for( const wxString& equfile : project.m_EquivalenceFiles )
 {
 fn = wxExpandEnvVars( equfile );
 
 if( fn.IsAbsolute() || fn.FileExists() )
 tmp = fn.GetFullPath();
 else
 tmp = search.FindValidPath( fn.GetFullPath() );
 
 if( !tmp )
 {
 error_count++;
 
 if( aErrorMessages )
 {
 error_msg.Printf( _( "Equivalence file '%s' could not be found." ),
 fn.GetFullName() );
 
 if( ! aErrorMessages->IsEmpty() )
 *aErrorMessages << wxT("\n\n");
 
 *aErrorMessages += error_msg;
 }
 
 continue;
 }
 
 file = wxFopen( tmp, wxT( "rt" ) );
 
 if( file == nullptr )
 {
 error_count++;
 
 if( aErrorMessages )
 {
 error_msg.Printf( _( "Error opening equivalence file '%s'." ), tmp );
 
 if( ! aErrorMessages->IsEmpty() )
 *aErrorMessages << wxT("\n\n");
 
 *aErrorMessages += error_msg;
 }
 
 continue;
 }
 
 while( GetLine( file, line, nullptr, sizeof( line ) ) != nullptr )
 {
 if( *line == 0 )
 continue;
 
 wxString wtext = FROM_UTF8( line );
 wxString value = GetQuotedText( wtext );
 
 if( value.IsEmpty() )
 continue;
 
 wxString footprint = GetQuotedText( wtext );
 
 if( footprint.IsEmpty() )
 continue;
 
 value.Replace( wxT( " " ), wxT( "_" ) );
 
 FOOTPRINT_EQUIVALENCE* equivItem = new FOOTPRINT_EQUIVALENCE();
 equivItem->m_ComponentValue = value;
 equivItem->m_FootprintFPID = footprint;
 aList.push_back( equivItem );
 }
 
 fclose( file );
 }
 
 return error_count;
}

References _, FROM_UTF8(), GetLine(), PROJECT::GetProjectFile(), GetQuotedText(), Kiface(), KIFACE_BASE::KifaceSearch(), FOOTPRINT_EQUIVALENCE::m_ComponentValue, FOOTPRINT_EQUIVALENCE::m_FootprintFPID, KIWAY_HOLDER::Prj(), and project.

Referenced by AutomaticFootprintMatching().

◆ BuildFootprintsListBox()

void CVPCB_MAINFRAME::BuildFootprintsListBox ( )

Definition at line 994 of file cvpcb_mainframe.cpp.

{
 wxFont guiFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
 
 if( m_footprintListBox == nullptr )
 {
 m_footprintListBox = new FOOTPRINTS_LISTBOX( this, ID_CVPCB_FOOTPRINT_LIST );
 m_footprintListBox->SetFont( KIUI::GetMonospacedUIFont() );
 }
 
 m_footprintListBox->SetFootprints( *m_FootprintsList, wxEmptyString, nullptr, wxEmptyString,
 FOOTPRINTS_LISTBOX::UNFILTERED_FP_LIST );
 DisplayStatus();
}

References DisplayStatus(), KIUI::GetMonospacedUIFont(), ID_CVPCB_FOOTPRINT_LIST, m_footprintListBox, m_FootprintsList, FOOTPRINTS_LISTBOX::SetFootprints(), and FOOTPRINTS_LISTBOX::UNFILTERED_FP_LIST.

Referenced by CVPCB_MAINFRAME(), KiwayMailIn(), and readNetListAndFpFiles().

◆ BuildLibrariesListBox()

void CVPCB_MAINFRAME::BuildLibrariesListBox ( )

Definition at line 1053 of file cvpcb_mainframe.cpp.

{
 COMMON_SETTINGS* cfg = Pgm().GetCommonSettings();
 PROJECT_FILE& project = Kiway().Prj().GetProjectFile();
 FP_LIB_TABLE* tbl = Prj().PcbFootprintLibs();
 std::set<wxString> pinnedMatches;
 std::set<wxString> otherMatches;
 m_librariesListBox->ClearList();
 
 auto process =
 [&]( const wxString& aNickname )
 {
 if( alg::contains( project.m_PinnedFootprintLibs, aNickname )
 || alg::contains( cfg->m_Session.pinned_fp_libs, aNickname ) )
 {
 pinnedMatches.insert( aNickname );
 }
 else
 {
 otherMatches.insert( aNickname );
 }
 };
 
 
 if( tbl )
 {
 wxArrayString libNames;
 
 std::vector< wxString > libNickNames = tbl->GetLogicalLibs();
 
 for( const wxString& libNickName : libNickNames )
 process( libNickName );
 }
 
 for( const wxString& nickname : pinnedMatches )
 m_librariesListBox->AppendLine( LIB_TREE_MODEL_ADAPTER::GetPinningSymbol() + nickname );
 
 for( const wxString& nickname : otherMatches )
 m_librariesListBox->AppendLine( nickname );
 
 m_librariesListBox->Finish();
}

References LIBRARY_LISTBOX::AppendLine(), LIBRARY_LISTBOX::ClearList(), alg::contains(), LIBRARY_LISTBOX::Finish(), LIB_TABLE::GetLogicalLibs(), LIB_TREE_MODEL_ADAPTER::GetPinningSymbol(), PROJECT::GetProjectFile(), KIWAY_HOLDER::Kiway(), m_librariesListBox, COMMON_SETTINGS::m_Session, PROJECT::PcbFootprintLibs(), Pgm(), COMMON_SETTINGS::SESSION::pinned_fp_libs, KIWAY::Prj(), KIWAY_HOLDER::Prj(), process(), and project.

Referenced by KiwayMailIn(), and readNetListAndFpFiles().

◆ BuildSymbolsListBox()

void CVPCB_MAINFRAME::BuildSymbolsListBox ( )

Definition at line 1010 of file cvpcb_mainframe.cpp.

{
 wxString msg;
 COMPONENT* symbol;
 wxFont guiFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
 
 if( m_symbolsListBox == nullptr )
 {
 m_symbolsListBox = new SYMBOLS_LISTBOX( this, ID_CVPCB_COMPONENT_LIST );
 m_symbolsListBox->SetFont( KIUI::GetMonospacedUIFont() );
 }
 
 m_symbolsListBox->m_SymbolList.Clear();
 
 for( unsigned i = 0; i < m_netlist.GetCount(); i++ )
 {
 symbol = m_netlist.GetComponent( i );
 
 msg = formatSymbolDesc( m_symbolsListBox->GetCount() + 1,
 symbol->GetReference(),
 symbol->GetValue(),
 symbol->GetFPID().Format().wx_str() );
 m_symbolsListBox->m_SymbolList.Add( msg );
 
 FOOTPRINT_INFO* fp =
 m_FootprintsList->GetFootprintInfo( symbol->GetFPID().Format().wx_str() );
 
 if( !fp )
 {
 m_symbolsListBox->AppendWarning( i );
 }
 }
 
 if( m_symbolsListBox->m_SymbolList.Count() )
 {
 m_symbolsListBox->SetItemCount( m_symbolsListBox->m_SymbolList.Count() );
 m_symbolsListBox->SetSelection( 0, true );
 m_symbolsListBox->RefreshItems( 0L, m_symbolsListBox->m_SymbolList.Count() - 1 );
 m_symbolsListBox->UpdateWidth();
 }
}

References SYMBOLS_LISTBOX::AppendWarning(), LIB_ID::Format(), formatSymbolDesc(), NETLIST::GetComponent(), SYMBOLS_LISTBOX::GetCount(), NETLIST::GetCount(), FOOTPRINT_LIST::GetFootprintInfo(), COMPONENT::GetFPID(), KIUI::GetMonospacedUIFont(), COMPONENT::GetReference(), COMPONENT::GetValue(), ID_CVPCB_COMPONENT_LIST, m_FootprintsList, m_netlist, SYMBOLS_LISTBOX::m_SymbolList, m_symbolsListBox, SYMBOLS_LISTBOX::SetSelection(), ITEMS_LISTBOX_BASE::UpdateWidth(), and UTF8::wx_str().

Referenced by CVPCB_MAINFRAME().

◆ canCloseWindow()

bool CVPCB_MAINFRAME::canCloseWindow ( wxCloseEvent & aCloseEvent )

overrideprotectedvirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 391 of file cvpcb_mainframe.cpp.

{
 if( m_modified )
 {
 // Shutdown blocks must be determined and vetoed as early as possible
 if( KIPLATFORM::APP::SupportsShutdownBlockReason()
 && aEvent.GetId() == wxEVT_QUERY_END_SESSION )
 {
 return false;
 }
 
 if( !HandleUnsavedChanges( this, _( "Symbol to Footprint links have been modified. "
 "Save changes?" ),
 [&]() -> bool
 {
 return SaveFootprintAssociation( false );
 } ) )
 {
 return false;
 }
 }
 
 if( m_cannotClose )
 return false;
 
 return true;
}

References _, HandleUnsavedChanges(), m_cannotClose, m_modified, SaveFootprintAssociation(), and KIPLATFORM::APP::SupportsShutdownBlockReason().

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS aUnits )

inherited

Definition at line 1352 of file eda_base_frame.cpp.

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

References UNITS_PROVIDER::SetUserUnits(), and EDA_BASE_FRAME::unitsChangeRefresh().

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

◆ CheckForAutoSaveFile()

void EDA_BASE_FRAME::CheckForAutoSaveFile ( const wxFileName & aFileName )

virtualinherited

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

{
 if( !IsGUI() )
 return;
 
 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\n"
 "%s\n"
 "KiCad exited before saving.\n"
 "\n"
 "Do you wish to open the auto-saved file instead?" ),
 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(), EDA_BASE_FRAME::GetAutoSaveFilePrefix(), IsGUI(), Pgm(), and traceAutoSave.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ ClearFileHistory()

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

inherited

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 969 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(), EDA_BASE_FRAME::m_fileHistory, and EDA_BASE_FRAME::ReCreateMenuBar().

Referenced by GERBVIEW_FRAME::OnClearDrlFileHistory(), SCH_EDIT_FRAME::OnClearFileHistory(), KICAD_MANAGER_FRAME::OnClearFileHistory(), PL_EDITOR_FRAME::OnClearFileHistory(), PCB_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`
	)

inlinevirtualinherited

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

540 { }

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

◆ ClearUndoRedoList()

void EDA_BASE_FRAME::ClearUndoRedoList ( )

virtualinherited

Clear the undo and redo list using ClearUndoORRedoList()

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

Definition at line 1297 of file eda_base_frame.cpp.

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

References EDA_BASE_FRAME::ClearUndoORRedoList(), EDA_BASE_FRAME::REDO_LIST, and EDA_BASE_FRAME::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(), PCB_EDIT_FRAME::ImportSpecctraSession(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), 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::~EDA_BASE_FRAME().

◆ commonInit()

void EDA_BASE_FRAME::commonInit ( FRAME_T aFrameType )

privateinherited

Collect common initialization functions used in all CTORs.

Definition at line 117 of file eda_base_frame.cpp.

{
 m_ident = aFrameType;
 m_maximizeByDefault = false;
 m_infoBar = nullptr;
 m_settingsManager = nullptr;
 m_fileHistory = nullptr;
 m_supportsAutoSave = false;
 m_autoSavePending = false;
 m_undoRedoCountMax = DEFAULT_MAX_UNDO_ITEMS;
 m_isClosing = false;
 m_isNonUserClose = false;
 m_autoSaveTimer = new wxTimer( this, ID_AUTO_SAVE_TIMER );
 m_autoSaveRequired = false;
 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, minSize(), EDA_BASE_FRAME::onAutoSaveTimer(), Pgm(), and EDA_BASE_FRAME::windowClosing().

Referenced by EDA_BASE_FRAME::EDA_BASE_FRAME().

◆ CommonSettingsChanged()

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

overridevirtualinherited

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

Update menus, toolbars, local variables, etc.

Reimplemented from TOOLS_HOLDER.

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

Definition at line 494 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(), EDA_BASE_FRAME::m_fileHistory, COMMON_SETTINGS::m_System, Pgm(), EDA_BASE_FRAME::ReCreateMenuBar(), FILE_HISTORY::SetMaxFiles(), BITMAP_STORE::ThemeChanged(), and EDA_BASE_FRAME::ThemeChanged().

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

◆ config()

APP_SETTINGS_BASE * EDA_BASE_FRAME::config ( ) const

virtualinherited

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 809 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(), CVPCB_MAINFRAME(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), SIM_PLOT_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), SCH_BASE_FRAME::eeconfig(), GERBVIEW_FRAME::GERBVIEW_FRAME(), PCB_EDIT_FRAME::GetRotationAngle(), GRID_MENU::GRID_MENU(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), GERBVIEW_FRAME::gvconfig(), EDA_DRAW_FRAME::IsGridVisible(), SCH_BASE_FRAME::libeditconfig(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), GERBVIEW_FRAME::Read_EXCELLON_File(), DIALOG_GRID_SETTINGS::RebuildGridSizes(), EDA_BASE_FRAME::SaveSettings(), PCB_BASE_EDIT_FRAME::SetBoard(), EDA_DRAW_FRAME::SetGridVisibility(), setupTools(), SCH_EDIT_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), PL_EDITOR_FRAME::setupTools(), PCB_EDIT_FRAME::setupTools(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), GRID_MENU::update(), ZOOM_MENU::update(), EDA_DRAW_FRAME::UpdateGridSelectBox(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), EDA_BASE_FRAME::windowClosing(), and BM2CMP_FRAME::~BM2CMP_FRAME().

◆ ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )

inlineoverridevirtualinherited

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

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

References EDA_BASE_FRAME::m_configName.

◆ CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )

inherited

Definition at line 834 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( wxS( "InfoBar" ) ).Top().Layer(1) );
#endif
}

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

Referenced by SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ CreateServer()

void KIWAY_PLAYER::CreateServer	(	int	service,
		bool	local = `true`
	)

inherited

Definition at line 43 of file eda_dde.cpp.

{
 wxIPV4address addr;
 
 // Set the port number
 addr.Service( service );
 
 // Listen on localhost only if requested
 if( local )
 addr.Hostname( HOSTNAME );
 
 if( m_socketServer )
 {
 // this helps prevent any events that could come in during deletion
 m_socketServer->Notify( false );
 delete m_socketServer;
 }
 
 m_socketServer = new wxSocketServer( addr );
 
 m_socketServer->SetNotify( wxSOCKET_CONNECTION_FLAG );
 m_socketServer->SetEventHandler( *this, ID_EDA_SOCKET_EVENT_SERV );
 m_socketServer->Notify( true );
}

References HOSTNAME(), ID_EDA_SOCKET_EVENT_SERV, and KIWAY_PLAYER::m_socketServer.

Referenced by SaveFileAs().

◆ CurrentToolName()

std::string TOOLS_HOLDER::CurrentToolName ( ) const

inherited

Definition at line 110 of file tools_holder.cpp.

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

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

Referenced by TOOLS_HOLDER::ShowChangedLanguage().

◆ Destroy()

bool KIWAY_PLAYER::Destroy ( )

overrideinherited

Our version of Destroy() which is virtual from wxWidgets.

Definition at line 170 of file kiway_player.cpp.

{
 return EDA_BASE_FRAME::Destroy();
}

◆ DismissModal()

void KIWAY_PLAYER::DismissModal	(	bool	aRetVal,
		const wxString &	aResult = `wxEmptyString`
	)

inherited

Definition at line 182 of file kiway_player.cpp.

{
 m_modal_ret_val = aRetVal;
 m_modal_string = aResult;
 
 if( m_modal_loop )
 {
 m_modal_loop->Exit();
 m_modal_loop = nullptr; // this marks it as dismissed.
 }
 
 Show( false );
}

References KIWAY_PLAYER::m_modal_loop, KIWAY_PLAYER::m_modal_ret_val, and KIWAY_PLAYER::m_modal_string.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::ExportSelectedFootprint(), and SYMBOL_VIEWER_FRAME::FinishModal().

◆ DisplayStatus()

void CVPCB_MAINFRAME::DisplayStatus ( )

Update the information displayed on the status bar at bottom of the main frame.

When the library or component list controls have the focus, the footprint assignment status of the components is displayed in the first status bar pane and the list of filters for the selected component is displayed in the second status bar pane. When the footprint list control has the focus, the description of the selected footprint is displayed in the first status bar pane and the key words for the selected footprint are displayed in the second status bar pane. The third status bar pane always displays the current footprint list filtering.

Definition at line 770 of file cvpcb_mainframe.cpp.

{
 if( !m_initialized )
 return;
 
 wxString filters, msg;
 COMPONENT* symbol = GetSelectedComponent();
 
 if( ( m_filteringOptions & FOOTPRINTS_LISTBOX::FILTERING_BY_COMPONENT_FP_FILTERS ) )
 {
 msg.Empty();
 
 if( symbol )
 {
 for( unsigned ii = 0; ii < symbol->GetFootprintFilters().GetCount(); ii++ )
 {
 if( msg.IsEmpty() )
 msg += symbol->GetFootprintFilters()[ii];
 else
 msg += wxT( ", " ) + symbol->GetFootprintFilters()[ii];
 }
 }
 
 filters += _( "Keywords" );
 
 if( !msg.IsEmpty() )
 filters += wxString::Format( wxT( " (%s)" ), msg );
 }
 
 if( ( m_filteringOptions & FOOTPRINTS_LISTBOX::FILTERING_BY_PIN_COUNT ) )
 {
 msg.Empty();
 
 if( symbol )
 msg = wxString::Format( wxT( "%i" ), symbol->GetPinCount() );
 
 if( !filters.IsEmpty() )
 filters += wxT( ", " );
 
 filters += _( "Pin Count" );
 
 if( !msg.IsEmpty() )
 filters += wxString::Format( wxT( " (%s)" ), msg );
 }
 
 if( ( m_filteringOptions & FOOTPRINTS_LISTBOX::FILTERING_BY_LIBRARY ) )
 {
 msg = m_librariesListBox->GetSelectedLibrary();
 
 if( !filters.IsEmpty() )
 filters += wxT( ", " );
 
 filters += _( "Library" );
 
 if( !msg.IsEmpty() )
 filters += wxString::Format( wxT( " (%s)" ), msg );
 }
 
 wxString textFilter = m_tcFilterString->GetValue();
 
 if( !textFilter.IsEmpty() )
 {
 if( !filters.IsEmpty() )
 filters += wxT( ", " );
 
 filters += _( "Search Text" ) + wxString::Format( wxT( " (%s)" ), textFilter );
 }
 
 if( filters.IsEmpty() )
 msg = _( "No Filtering" );
 else
 msg.Printf( _( "Filtered by %s" ), filters );
 
 msg << wxT( ": " ) << m_footprintListBox->GetCount();
 
 SetStatusText( msg );
 
 
 msg.Empty();
 wxString footprintName = GetSelectedFootprint();
 
 FOOTPRINT_INFO* fp = m_FootprintsList->GetFootprintInfo( footprintName );
 
 if( fp ) // can be NULL if no netlist loaded
 {
 msg = wxString::Format( _( "Description: %s; Keywords: %s" ),
 fp->GetDescription(),
 fp->GetKeywords() );
 }
 
 SetStatusText( msg, 1 );
 
 msg.Empty();
 wxString lib;
 
 // Choose the footprint to get the information on
 if( fp )
 {
 // Use the footprint in the footprint viewer
 lib = fp->GetLibNickname();
 }
 else if( GetFocusedControl() == CVPCB_MAINFRAME::CONTROL_COMPONENT )
 {
 // Use the footprint of the selected symbol
 if( symbol )
 lib = symbol->GetFPID().GetLibNickname();
 }
 else if( GetFocusedControl() == CVPCB_MAINFRAME::CONTROL_LIBRARY )
 {
 // Use the library that is selected
 lib = m_librariesListBox->GetSelectedLibrary();
 }
 
 // Extract the library information
 FP_LIB_TABLE* fptbl = Prj().PcbFootprintLibs();
 
 if( fptbl->HasLibrary( lib ) )
 msg = wxString::Format( _( "Library location: %s" ), fptbl->GetFullURI( lib ) );
 else
 msg = wxString::Format( _( "Library location: unknown" ) );
 
 SetStatusText( msg, 2 );
}

References _, CONTROL_COMPONENT, CONTROL_LIBRARY, FOOTPRINTS_LISTBOX::FILTERING_BY_COMPONENT_FP_FILTERS, FOOTPRINTS_LISTBOX::FILTERING_BY_LIBRARY, FOOTPRINTS_LISTBOX::FILTERING_BY_PIN_COUNT, Format(), FOOTPRINTS_LISTBOX::GetCount(), FOOTPRINT_INFO::GetDescription(), GetFocusedControl(), COMPONENT::GetFootprintFilters(), FOOTPRINT_LIST::GetFootprintInfo(), COMPONENT::GetFPID(), LIB_TABLE::GetFullURI(), FOOTPRINT_INFO::GetKeywords(), LIB_ID::GetLibNickname(), FOOTPRINT_INFO::GetLibNickname(), COMPONENT::GetPinCount(), GetSelectedComponent(), GetSelectedFootprint(), LIBRARY_LISTBOX::GetSelectedLibrary(), LIB_TABLE::HasLibrary(), m_filteringOptions, m_footprintListBox, m_FootprintsList, m_initialized, m_librariesListBox, m_tcFilterString, PROJECT::PcbFootprintLibs(), KIWAY_HOLDER::Prj(), and SetStatusText().

Referenced by AssociateFootprint(), BuildFootprintsListBox(), CVPCB_ASSOCIATION_TOOL::DeleteAll(), onTextFilterChangedTimer(), readNetListAndFpFiles(), refreshAfterSymbolSearch(), ShowChangedLanguage(), and updateFootprintViewerOnIdle().

◆ DisplayToolMsg()

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

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 133 of file tools_holder.h.

133{};

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

◆ doAutoSave()

bool EDA_BASE_FRAME::doAutoSave ( )

protectedvirtualinherited

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

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

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

void CVPCB_MAINFRAME::doCloseWindow ( )

overrideprotectedvirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 420 of file cvpcb_mainframe.cpp.

{
 if( GetFootprintViewerFrame() )
 GetFootprintViewerFrame()->Close( true );
 
 m_modified = false;
 
 // clear symbol selection in schematic:
 SendComponentSelectionToSch( true );
}

References GetFootprintViewerFrame(), m_modified, and SendComponentSelectionToSch().

◆ doReCreateMenuBar()

void CVPCB_MAINFRAME::doReCreateMenuBar ( )

overrideprotectedvirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 37 of file cvpcb/menubar.cpp.

{
 COMMON_CONTROL* tool = m_toolManager->GetTool<COMMON_CONTROL>();
 // wxWidgets handles the Mac Application menu behind the scenes, but that means
 // we always have to start from scratch with a new wxMenuBar.
 wxMenuBar* oldMenuBar = GetMenuBar();
 WX_MENUBAR* menuBar = new WX_MENUBAR();
 
 //-- File menu -----------------------------------------------------------
 //
 ACTION_MENU* fileMenu = new ACTION_MENU( false, tool );
 
 fileMenu->Add( CVPCB_ACTIONS::saveAssociationsToSchematic );
 fileMenu->AppendSeparator();
 fileMenu->AddClose( _( "Assign Footprints" ) );
 
 //-- Edit menu -----------------------------------------------------------
 //
 ACTION_MENU* editMenu = new ACTION_MENU( false, tool );
 
 editMenu->Add( ACTIONS::undo );
 editMenu->Add( ACTIONS::redo );
 
 editMenu->AppendSeparator();
 editMenu->Add( ACTIONS::cut );
 editMenu->Add( ACTIONS::copy );
 editMenu->Add( ACTIONS::paste );
 
 //-- Preferences menu ----------------------------------------------------
 //
 ACTION_MENU* prefsMenu = new ACTION_MENU( false, tool );
 
 prefsMenu->Add( ACTIONS::configurePaths );
 prefsMenu->Add( ACTIONS::showFootprintLibTable );
 
 // We can't use ACTIONS::showPreferences yet because wxWidgets moves this on
 // Mac, and it needs the wxID_PREFERENCES id to find it.
 prefsMenu->Add( _( "Preferences..." ) + wxS( "\tCtrl+," ),
 _( "Show preferences for all open tools" ),
 wxID_PREFERENCES,
 BITMAPS::preference );
 
 prefsMenu->AppendSeparator();
 prefsMenu->Add( CVPCB_ACTIONS::showEquFileTable);
 
 prefsMenu->AppendSeparator();
 AddMenuLanguageList( prefsMenu, tool );
 
 //-- Menubar -------------------------------------------------------------
 //
 menuBar->Append( fileMenu, _( "&File" ) );
 menuBar->Append( editMenu, _( "&Edit" ) );
 menuBar->Append( prefsMenu, _( "&Preferences" ) );
 AddStandardHelpMenu( menuBar );
 
 SetMenuBar( menuBar );
 delete oldMenuBar;
}

References _, ACTION_MENU::Add(), ACTION_MENU::AddClose(), AddMenuLanguageList(), EDA_BASE_FRAME::AddStandardHelpMenu(), ACTIONS::configurePaths, ACTIONS::copy, ACTIONS::cut, TOOL_MANAGER::GetTool(), TOOLS_HOLDER::m_toolManager, ACTIONS::paste, preference, ACTIONS::redo, CVPCB_ACTIONS::saveAssociationsToSchematic, CVPCB_ACTIONS::showEquFileTable, ACTIONS::showFootprintLibTable, and ACTIONS::undo.

◆ DoWithAcceptedFiles()

void EDA_BASE_FRAME::DoWithAcceptedFiles ( )

protectedvirtualinherited

Execute action on accepted dropped file.

Called in OnDropFiles and should be populated with the action to execute in inherited classes.

Reimplemented in GERBVIEW_FRAME, KICAD_MANAGER_FRAME, and PL_EDITOR_FRAME.

Definition at line 1178 of file eda_base_frame.cpp.

{
 for( const wxFileName& file : m_AcceptedFiles )
 {
 wxString fn = file.GetFullPath();
 m_toolManager->RunAction( *m_acceptedExts.at( file.GetExt() ), true, &fn );
 }
}

References EDA_BASE_FRAME::m_acceptedExts, EDA_BASE_FRAME::m_AcceptedFiles, TOOLS_HOLDER::m_toolManager, and TOOL_MANAGER::RunAction().

Referenced by EDA_BASE_FRAME::OnDropFiles().

◆ ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )

protectedinherited

Definition at line 659 of file eda_base_frame.cpp.

{
 wxDisplay display( wxDisplay::GetFromWindow( this ) );
 wxRect clientSize = display.GetClientArea();
 wxPoint pos = GetPosition();
 wxSize size = GetWindowSize();
 
 wxLogTrace( traceDisplayLocation,
 wxS( "ensureWindowIsOnScreen: clientArea (%d, %d) w %d h %d" ), clientSize.x, clientSize.y,
 clientSize.width, clientSize.height );
 
 if( pos.y < clientSize.y )
 {
 wxLogTrace( traceDisplayLocation,
 wxS( "ensureWindowIsOnScreen: y pos %d below minimum, setting to %d" ), pos.y,
 clientSize.y );
 pos.y = clientSize.y;
 }
 
 if( pos.x < clientSize.x )
 {
 wxLogTrace( traceDisplayLocation,
 wxS( "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,
 wxS( "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,
 wxS( "ensureWindowIsOnScreen: effective height %d above available %d, setting to %d" ),
 pos.y + size.y, clientSize.height, newHeight );
 size.y = newHeight;
 }
 
 wxLogTrace( traceDisplayLocation, wxS( "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 EDA_BASE_FRAME::GetWindowSize(), and traceDisplayLocation.

Referenced by EDA_BASE_FRAME::OnSize().

◆ ExecuteRemoteCommand()

virtual void KIWAY_PLAYER::ExecuteRemoteCommand ( const char * cmdline )

inlinevirtualinherited

Execute a remote command sent via socket (to port KICAD_PCB_PORT_SERVICE_NUMBER, currently 4242).

Subclasses should override to implement actual command handlers.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 182 of file kiway_player.h.

182{}

Referenced by KIWAY_PLAYER::OnSockRequest().

◆ findQuasiModalDialog()

wxWindow * EDA_BASE_FRAME::findQuasiModalDialog ( )

privateinherited

Definition at line 169 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( wxS( "CvpcbFrame" ) );
 
 if( cvpcb )
 return cvpcb;
 }
 
 return nullptr;
}

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

Referenced by EDA_BASE_FRAME::ProcessEvent(), and EDA_BASE_FRAME::windowClosing().

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )

inherited

Definition at line 846 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( wxS( "InfoBar" ) ).Hide();
 m_auimgr.Update();
#endif
}

References EDA_BASE_FRAME::m_auimgr.

Referenced by SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ formatSymbolDesc()

wxString CVPCB_MAINFRAME::formatSymbolDesc	(	int	idx,
		const wxString &	aReference,
		const wxString &	aValue,
		const wxString &	aFootprint
	)

private

Definition at line 592 of file cvpcb_mainframe.cpp.

{
 // Work around a bug in wxString::Format with double-byte chars (and double-quote, for some
 // reason).
 wxString desc = wxString::Format( wxT( "%3d " ), idx );
 
 for( int ii = aReference.Length(); ii < 8; ++ii )
 desc += wxS( " " );
 
 desc += aReference + wxT( " - " );
 
 for( int ii = aValue.Length(); ii < 16; ++ii )
 desc += wxS( " " );
 
 desc += aValue + wxT( " : " ) + aFootprint;
 
 return desc;
}

References Format().

Referenced by AssociateFootprint(), BuildSymbolsListBox(), and readNetListAndFpFiles().

◆ GetAboutTitle()

const wxString & EDA_BASE_FRAME::GetAboutTitle ( ) const

inlineinherited

Definition at line 506 of file eda_base_frame.h.

506{ return wxGetTranslation( m_aboutTitle ); }

References EDA_BASE_FRAME::m_aboutTitle.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT(), PGM_SINGLE_TOP::OnPgmInit(), and PGM_KICAD::OnPgmInit().

◆ GetAutoSaveFilePrefix()

static wxString EDA_BASE_FRAME::GetAutoSaveFilePrefix ( )

inlinestaticprotectedinherited

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 EDA_BASE_FRAME::CheckForAutoSaveFile(), SCH_EDIT_FRAME::CheckForAutoSaveFile(), SCH_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doCloseWindow(), PCB_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

inherited

Definition at line 298 of file eda_base_frame.cpp.

{
 return Pgm().GetCommonSettings()->m_System.autosave_interval;
}

References Pgm().

Referenced by EDA_DRAW_FRAME::CommonSettingsChanged(), EDA_BASE_FRAME::onAutoSaveTimer(), and EDA_BASE_FRAME::ProcessEvent().

◆ GetComponentIndices()

std::vector< unsigned int > CVPCB_MAINFRAME::GetComponentIndices ( CVPCB_MAINFRAME::CRITERIA aCriteria = CVPCB_MAINFRAME::ALL_COMPONENTS )

Get the indices for all the components meeting the specified criteria in the components listbox.

Parameters

aCriteria is the criteria to use for finding the indices

Returns: a vector containing all the indices

Definition at line 1127 of file cvpcb_mainframe.cpp.

{
 std::vector<unsigned int> idx;
 int lastIdx;
 
 // Make sure a netlist has been loaded and the box has contents
 if( m_netlist.IsEmpty() || m_symbolsListBox->GetCount() == 0 )
 return idx;
 
 switch( aCriteria )
 {
 case CVPCB_MAINFRAME::ALL_COMPONENTS:
 idx.resize( m_netlist.GetCount() );
 std::iota( idx.begin(), idx.end(), 0 );
 break;
 
 case CVPCB_MAINFRAME::SEL_COMPONENTS:
 // Check to see if anything is selected
 if( m_symbolsListBox->GetSelectedItemCount() < 1 )
 break;
 
 // Get the symbols
 lastIdx = m_symbolsListBox->GetFirstSelected();
 idx.emplace_back( lastIdx );
 
 lastIdx = m_symbolsListBox->GetNextSelected( lastIdx );
 while( lastIdx > 0 )
 {
 idx.emplace_back( lastIdx );
 lastIdx = m_symbolsListBox->GetNextSelected( lastIdx );
 }
 break;
 
 case CVPCB_MAINFRAME::NA_COMPONENTS:
 for( unsigned int i = 0; i < m_netlist.GetCount(); i++ )
 {
 if( m_netlist.GetComponent( i )->GetFPID().empty() )
 idx.emplace_back( i );
 }
 break;
 
 case CVPCB_MAINFRAME::ASSOC_COMPONENTS:
 for( unsigned int i = 0; i < m_netlist.GetCount(); i++ )
 {
 if( !m_netlist.GetComponent( i )->GetFPID().empty() )
 idx.emplace_back( i );
 }
 break;
 
 default:
 wxASSERT_MSG( false, "Invalid symbol selection criteria" );
 }
 
 return idx;
}

References ALL_COMPONENTS, ASSOC_COMPONENTS, LIB_ID::empty(), NETLIST::GetComponent(), SYMBOLS_LISTBOX::GetCount(), NETLIST::GetCount(), COMPONENT::GetFPID(), NETLIST::IsEmpty(), m_netlist, m_symbolsListBox, NA_COMPONENTS, and SEL_COMPONENTS.

Referenced by CVPCB_ASSOCIATION_TOOL::Associate(), AssociateFootprint(), CVPCB_ASSOCIATION_TOOL::CutAssoc(), CVPCB_ASSOCIATION_TOOL::DeleteAll(), CVPCB_ASSOCIATION_TOOL::DeleteAssoc(), CVPCB_ASSOCIATION_TOOL::PasteAssoc(), and CVPCB_CONTROL::ToNA().

◆ GetCurrentFileName()

virtual wxString EDA_BASE_FRAME::GetCurrentFileName ( ) const

inlinevirtualinherited

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

Definition at line 431 of file eda_base_frame.h.

431{ return wxEmptyString; }

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ GetCurrentSelection()

virtual SELECTION & TOOLS_HOLDER::GetCurrentSelection ( )

inlinevirtualinherited

Get the current selection from the canvas area.

Returns: the current selection.

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

Definition at line 101 of file tools_holder.h.

 {
 return m_dummySelection;
 }

References TOOLS_HOLDER::m_dummySelection.

Referenced by EDA_BASE_FRAME::HandleUpdateUIEvent(), ACTION_MANAGER::RunHotKey(), NL_3D_VIEWER_PLUGIN_IMPL::SetActiveCommand(), NL_SCHEMATIC_PLUGIN_IMPL::SetActiveCommand(), and NL_PCBNEW_PLUGIN_IMPL::SetActiveCommand().

◆ 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 141 of file tools_holder.h.

141{ return m_immediateActions; }

TOOLS_HOLDER::m_immediateActions

bool m_immediateActions

Definition: tools_holder.h:183

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

147{ return m_dragAction; }

TOOLS_HOLDER::m_dragAction

MOUSE_DRAG_ACTION m_dragAction

Definition: tools_holder.h:187

References TOOLS_HOLDER::m_dragAction.

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

◆ GetFileFromHistory()

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

inherited

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 929 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(), EDA_BASE_FRAME::m_fileHistory, and EDA_BASE_FRAME::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 ( )

inlineinherited

Get the frame's main file history.

Returns: the main file history

Definition at line 415 of file eda_base_frame.h.

 {
 return *m_fileHistory;
 }

References EDA_BASE_FRAME::m_fileHistory.

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

◆ GetFocusedControl()

CVPCB_MAINFRAME::CONTROL_TYPE CVPCB_MAINFRAME::GetFocusedControl ( ) const

Find out which control currently has focus.

Returns: the control that currently has focus

Definition at line 1199 of file cvpcb_mainframe.cpp.

{
 if( m_librariesListBox->HasFocus() )
 return CVPCB_MAINFRAME::CONTROL_LIBRARY;
 else if( m_symbolsListBox->HasFocus() )
 return CVPCB_MAINFRAME::CONTROL_COMPONENT;
 else if( m_footprintListBox->HasFocus() )
 return CVPCB_MAINFRAME::CONTROL_FOOTPRINT;
 
 return CVPCB_MAINFRAME::CONTROL_NONE;
}

References CONTROL_COMPONENT, CONTROL_FOOTPRINT, CONTROL_LIBRARY, CONTROL_NONE, m_footprintListBox, m_librariesListBox, and m_symbolsListBox.

Referenced by CVPCB_CONTROL::ChangeFocus(), CVPCB_ASSOCIATION_TOOL::CopyAssoc(), CVPCB_ASSOCIATION_TOOL::CutAssoc(), and DisplayStatus().

◆ GetFootprintViewerFrame()

DISPLAY_FOOTPRINTS_FRAME * CVPCB_MAINFRAME::GetFootprintViewerFrame ( ) const

Returns: a pointer on the Footprint Viewer frame, if exists, or NULL

Definition at line 1185 of file cvpcb_mainframe.cpp.

{
 // returns the Footprint Viewer frame, if exists, or NULL
 wxWindow* window = wxWindow::FindWindowByName( FOOTPRINTVIEWER_FRAME_NAME );
 return dynamic_cast<DISPLAY_FOOTPRINTS_FRAME*>( window );
}

References FOOTPRINTVIEWER_FRAME_NAME.

Referenced by doCloseWindow(), GetToolCanvas(), RefreshFootprintViewer(), CVPCB_CONTROL::ShowFootprintViewer(), and updateFootprintViewerOnIdle().

◆ GetFrameType()

FRAME_T EDA_BASE_FRAME::GetFrameType ( ) const

inlineinherited

Definition at line 201 of file eda_base_frame.h.

201{ return m_ident; }

References EDA_BASE_FRAME::m_ident.

Referenced by PCB_BASE_FRAME::GetViewerSettingsBase(), and EDA_BASE_FRAME::ShowPreferences().

◆ GetInfoBar()

WX_INFOBAR * EDA_BASE_FRAME::GetInfoBar ( )

inlineinherited

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

Definition at line 234 of file eda_base_frame.h.

234{ return m_infoBar; }

References EDA_BASE_FRAME::m_infoBar.

Referenced by FOOTPRINT_EDIT_FRAME::AddFootprintToBoard(), AUTOPLACE_TOOL::autoplace(), FOOTPRINT_EDIT_FRAME::CanCloseFPFromBoard(), PCB_EDIT_FRAME::CommonSettingsChanged(), 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(), SCH_MOVE_TOOL::Main(), PL_EDIT_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(), EDA_BASE_FRAME::ShowInfoBarError(), EDA_BASE_FRAME::ShowInfoBarMsg(), EDA_BASE_FRAME::ShowInfoBarWarning(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), PCB_CONTROL::unfilledZoneCheck(), and ZONE_FILLER_TOOL::ZoneFillDirty().

◆ GetIuScale()

const EDA_IU_SCALE & UNITS_PROVIDER::GetIuScale ( ) const

inlineinherited

Definition at line 45 of file units_provider.h.

45{ return m_iuScale; }

UNITS_PROVIDER::m_iuScale

const EDA_IU_SCALE & m_iuScale

Definition: units_provider.h:125

References UNITS_PROVIDER::m_iuScale.

Referenced by UNITS_PROVIDER::AngleValueFromString(), GRID_MENU::BuildChoiceList(), UNITS_PROVIDER::MessageTextFromValue(), UNIT_BINDER::onUnitsChanged(), COMMON_TOOLS::Reset(), UNITS_PROVIDER::StringFromValue(), and UNITS_PROVIDER::ValueFromString().

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const

inlineinherited

Definition at line 576 of file eda_base_frame.h.

576{ return m_undoRedoCountMax; }

References EDA_BASE_FRAME::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 153 of file tools_holder.h.

153{ return m_moveWarpsCursor; }

TOOLS_HOLDER::m_moveWarpsCursor

bool m_moveWarpsCursor

Definition: tools_holder.h:189

References TOOLS_HOLDER::m_moveWarpsCursor.

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

◆ GetMruPath()

wxString EDA_BASE_FRAME::GetMruPath ( ) const

inlineinherited

Definition at line 422 of file eda_base_frame.h.

422{ return m_mruPath; }

References EDA_BASE_FRAME::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().

◆ GetOriginTransforms()

ORIGIN_TRANSFORMS & EDA_BASE_FRAME::GetOriginTransforms ( )

inlineoverridevirtualinherited

Return a reference to the default ORIGIN_TRANSFORMS object.

Reimplemented from UNITS_PROVIDER.

Reimplemented in PCB_BASE_FRAME.

Definition at line 130 of file eda_base_frame.h.

 {
 return m_originTransforms;
 }

References EDA_BASE_FRAME::m_originTransforms.

Referenced by PROPERTIES_PANEL::extractValueAndWritability(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PROPERTIES_PANEL::rebuildProperties(), and EDA_SHAPE::ShapeGetMsgPanelInfo().

◆ GetRedoCommandCount()

int CVPCB_MAINFRAME::GetRedoCommandCount ( ) const

inlineoverridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 184 of file cvpcb_mainframe.h.

 {
 return m_redoList.size();
 }

References m_redoList.

◆ GetSelectedComponent()

COMPONENT * CVPCB_MAINFRAME::GetSelectedComponent ( )

Get the selected component from the component listbox.

Returns: the selected component

Definition at line 1097 of file cvpcb_mainframe.cpp.

{
 int selection = m_symbolsListBox->GetSelection();
 
 if( selection >= 0 && selection < (int) m_netlist.GetCount() )
 return m_netlist.GetComponent( selection );
 
 return nullptr;
}

References NETLIST::GetComponent(), NETLIST::GetCount(), ITEMS_LISTBOX_BASE::GetSelection(), m_netlist, and m_symbolsListBox.

Referenced by CVPCB_ASSOCIATION_TOOL::CopyAssoc(), CVPCB_ASSOCIATION_TOOL::CutAssoc(), DisplayStatus(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), OnSelectComponent(), and onTextFilterChangedTimer().

◆ GetSelectedFootprint()

wxString CVPCB_MAINFRAME::GetSelectedFootprint ( )

Returns: the LIB_ID of the selected footprint in footprint listview or a empty string if no selection

Definition at line 1224 of file cvpcb_mainframe.cpp.

{
 // returns the LIB_ID of the selected footprint in footprint listview
 // or a empty string
 return m_footprintListBox->GetSelectedFootprint();
}

References FOOTPRINTS_LISTBOX::GetSelectedFootprint(), and m_footprintListBox.

Referenced by CVPCB_ASSOCIATION_TOOL::Associate(), CVPCB_ASSOCIATION_TOOL::CopyAssoc(), DisplayStatus(), and DISPLAY_FOOTPRINTS_FRAME::InitDisplay().

◆ GetSettingsManager()

SETTINGS_MANAGER * EDA_BASE_FRAME::GetSettingsManager ( ) const

inlineinherited

Definition at line 136 of file eda_base_frame.h.

136{ return m_settingsManager; }

References EDA_BASE_FRAME::m_settingsManager.

Referenced by KICAD_MANAGER_FRAME::canCloseWindow(), EDA_3D_VIEWER_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), KICAD_MANAGER_FRAME::CreateNewProject(), SCH_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::doAutoSave(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), PCB_BASE_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::Files_io_from_id(), DIALOG_PLOT_SCHEMATIC::getColorSettings(), EESCHEMA_HELPERS::GetSettingsManager(), GetSettingsManager(), DIALOG_PLOT_SCHEMATIC::initDlg(), DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), SCH_EDIT_FRAME::OnImportProject(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ GetSeverity()

virtual SEVERITY EDA_BASE_FRAME::GetSeverity ( int aErrorCode ) const

inlinevirtualinherited

Reimplemented in SCH_EDIT_FRAME, and PCB_BASE_FRAME.

Definition at line 138 of file eda_base_frame.h.

138{ return RPT_SEVERITY_UNDEFINED; }

RPT_SEVERITY_UNDEFINED

@ RPT_SEVERITY_UNDEFINED

Definition: report_severity.h:27

References RPT_SEVERITY_UNDEFINED.

Referenced by ERC_TREE_MODEL::GetValue(), and RC_TREE_MODEL::GetValue().

◆ GetToolCanvas()

wxWindow * CVPCB_MAINFRAME::GetToolCanvas ( ) const

overridevirtual

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 1193 of file cvpcb_mainframe.cpp.

{
 return GetFootprintViewerFrame();
}

References GetFootprintViewerFrame().

◆ GetToolManager()

TOOL_MANAGER * TOOLS_HOLDER::GetToolManager ( ) const

inlineinherited

Return the MVC controller.

Definition at line 54 of file tools_holder.h.

54{ return m_toolManager; }

References TOOLS_HOLDER::m_toolManager.

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const

inlineinherited

Definition at line 46 of file kiway_holder.h.

46{ return m_type; }

KIWAY_HOLDER::m_type

HOLDER_TYPE m_type

Definition: kiway_holder.h:85

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUndoCommandCount()

int CVPCB_MAINFRAME::GetUndoCommandCount ( ) const

inlineoverridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 179 of file cvpcb_mainframe.h.

 {
 return m_undoList.size();
 }

References m_undoList.

◆ GetUntranslatedAboutTitle()

const wxString & EDA_BASE_FRAME::GetUntranslatedAboutTitle ( ) const

inlineinherited

Definition at line 508 of file eda_base_frame.h.

508{ return m_aboutTitle; }

References EDA_BASE_FRAME::m_aboutTitle.

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

◆ GetUserUnits()

EDA_UNITS UNITS_PROVIDER::GetUserUnits ( ) const

inlineinherited

Definition at line 42 of file units_provider.h.

42{ return m_userUnits; }

UNITS_PROVIDER::m_userUnits

EDA_UNITS m_userUnits

Definition: units_provider.h:126

References UNITS_PROVIDER::m_userUnits.

Referenced by DIALOG_CONSTRAINTS_REPORTER::AddPage(), PG_UNIT_EDITOR::CreateControls(), DIALOG_SHIM::DIALOG_SHIM(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PL_EDITOR_FRAME::DisplayGridMsg(), EDA_DRAW_FRAME::DisplayUnitsMsg(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawSpecificationStackup(), EVT_GRID_CMD_CELL_CHANGED(), PROPERTIES_PANEL::extractValueAndWritability(), FP_TEXT_GRID_TABLE::FP_TEXT_GRID_TABLE(), PCB_EDIT_FRAME::GenFootprintsReport(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), EDA_DRAW_FRAME::GetUnitPair(), WX_GRID::GetUnitValue(), GetUserUnits(), UNIT_BINDER::init(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), UNITS_PROVIDER::MessageTextFromValue(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), WX_GRID::onCellEditorHidden(), PANEL_SETUP_BOARD_STACKUP::onExportToClipboard(), PANEL_SETUP_NETCLASSES::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), DIALOG_NET_INSPECTOR::onUnitsChanged(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PANEL_SETUP_NETCLASSES::PANEL_SETUP_NETCLASSES(), PG_UNIT_EDITOR::PG_UNIT_EDITOR(), PIN_TABLE_DATA_MODEL::PIN_TABLE_DATA_MODEL(), PCB_CONTROL::placeBoardItems(), POSITION_RELATIVE_TOOL::PositionRelative(), PROPERTIES_PANEL::rebuildProperties(), DRC_TOOL::RunTests(), SCH_EDIT_FRAME::SaveSettings(), EDA_DRAW_FRAME::SaveSettings(), WX_GRID::SetUnitsProvider(), PIN_TABLE_DATA_MODEL::SetValue(), FP_TEXT_GRID_TABLE::SetValue(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), UNITS_PROVIDER::StringFromValue(), COMMON_TOOLS::ToggleUnits(), EDA_DRAW_FRAME::ToggleUserUnits(), EDITOR_CONDITIONS::unitsFunc(), GERBVIEW_FRAME::updateDCodeSelectBox(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), PG_UNIT_EDITOR::UpdateFrame(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), PL_EDITOR_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateUserUnits(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), DRC_TOOL::userUnits(), and UNITS_PROVIDER::ValueFromString().

◆ GetWindowSettings()

WINDOW_SETTINGS * EDA_BASE_FRAME::GetWindowSettings ( APP_SETTINGS_BASE * aCfg )

virtualinherited

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

Definition at line 803 of file eda_base_frame.cpp.

{
 return &aCfg->m_Window;
}

References APP_SETTINGS_BASE::m_Window.

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

◆ GetWindowSize()

wxSize EDA_BASE_FRAME::GetWindowSize ( )

inherited

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 1387 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 EDA_BASE_FRAME::m_ident.

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

◆ handleIconizeEvent()

virtual void EDA_BASE_FRAME::handleIconizeEvent ( wxIconizeEvent & aEvent )

inlineprotectedvirtualinherited

Handle a window iconize event.

Parameters

aEvent is the data for the event.

Reimplemented in EDA_3D_VIEWER_FRAME, SCH_BASE_FRAME, and PCB_BASE_FRAME.

Definition at line 620 of file eda_base_frame.h.

620{}

Referenced by EDA_3D_VIEWER_FRAME::handleIconizeEvent(), SCH_BASE_FRAME::handleIconizeEvent(), PCB_BASE_FRAME::handleIconizeEvent(), and EDA_BASE_FRAME::onIconize().

◆ HandleSystemColorChange()

void EDA_BASE_FRAME::HandleSystemColorChange ( )

virtualinherited

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

Definition at line 1411 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(), EDA_BASE_FRAME::ReCreateMenuBar(), BITMAP_STORE::ThemeChanged(), and EDA_BASE_FRAME::ThemeChanged().

Referenced by EDA_BASE_FRAME::onSystemColorChange().

◆ HandleUpdateUIEvent()

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

staticinherited

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 367 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( wxMenu* 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 EDA_BASE_FRAME::RegisterUIUpdateHandler().

◆ HasKiway()

bool KIWAY_HOLDER::HasKiway ( ) const

inlineinherited

Safety check before asking for the Kiway reference.

Returns: true if kiway is non-null

Definition at line 63 of file kiway_holder.h.

 {
 return m_kiway != nullptr;
 }

References KIWAY_HOLDER::m_kiway.

Referenced by DIALOG_SHIM::~DIALOG_SHIM().

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )

virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

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

inherited

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

protectedinherited

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

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

◆ isAutoSaveRequired()

virtual bool EDA_BASE_FRAME::isAutoSaveRequired ( ) const

inlineprotectedvirtualinherited

Return the auto save status of the application.

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

Definition at line 628 of file eda_base_frame.h.

628{ return m_autoSaveRequired; }

References EDA_BASE_FRAME::m_autoSaveRequired.

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ IsContentModified()

bool CVPCB_MAINFRAME::IsContentModified ( ) const

inlineoverridevirtual

Get if the current associations have been modified but not saved.

Returns: true if the any changes have not been saved

Reimplemented from EDA_BASE_FRAME.

Definition at line 109 of file cvpcb_mainframe.h.

 {
 return m_modified;
 }

References m_modified.

◆ IsCurrentTool()

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

inherited

Definition at line 119 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(), SCH_LINE_WIRE_BUS_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), EDIT_TOOL::Init(), and EDITOR_CONDITIONS::toolFunc().

◆ IsDismissed()

bool KIWAY_PLAYER::IsDismissed ( )

inherited

Returns: false only if both the frame is acting in modal mode and it has not been dismissed yet with DismissModal(). True if the dialog is not modal or if it is modal and has been dismissed.

Definition at line 176 of file kiway_player.cpp.

{
 return !m_modal_loop;
}

References KIWAY_PLAYER::m_modal_loop.

Referenced by SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), and FOOTPRINT_WIZARD_FRAME::doCloseWindow().

◆ IsModal()

bool KIWAY_PLAYER::IsModal ( ) const

inlineoverridevirtualinherited

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 from EDA_BASE_FRAME.

Definition at line 159 of file kiway_player.h.

159{ return m_modal; }

KIWAY_PLAYER::m_modal

bool m_modal

Definition: kiway_player.h:196

References KIWAY_PLAYER::m_modal.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), KIWAY_PLAYER::ShowModal(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T aType ) const

inlineinherited

Definition at line 200 of file eda_base_frame.h.

200{ return m_ident == aType; }

References EDA_BASE_FRAME::m_ident.

◆ IsWritable()

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

inherited

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 1188 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.GetFullPath() );
 }
 else if( fn.FileExists() && !fn.IsFileWritable() )
 {
 msg.Printf( _( "Insufficient permissions to save file '%s'." ), fn.GetFullPath() );
 }
 
 if( !msg.IsEmpty() )
 {
 if( aVerbose )
 DisplayErrorMessage( this, msg );
 
 return false;
 }
 
 return true;
}

References _, and DisplayErrorMessage().

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.

◆ kiway_express()

void KIWAY_PLAYER::kiway_express ( KIWAY_EXPRESS & aEvent )

protectedinherited

event handler, routes to derivative specific virtual KiwayMailIn()

Definition at line 197 of file kiway_player.cpp.

{
 // logging support
 KiwayMailIn( aEvent ); // call the virtual, override in derived.
}

References KIWAY_PLAYER::KiwayMailIn().

◆ KiwayMailIn()

void CVPCB_MAINFRAME::KiwayMailIn ( KIWAY_EXPRESS & aEvent )

overridevirtual

Receive KIWAY_EXPRESS messages from other players.

Override it in derived classes.

Reimplemented from KIWAY_PLAYER.

Definition at line 1252 of file cvpcb_mainframe.cpp.

{
 const std::string& payload = mail.GetPayload();
 
 switch( mail.Command() )
 {
 case MAIL_EESCHEMA_NETLIST:
 // Disable Close events during readNetListAndFpFiles() to avoid crash when updating
 // widgets:
 m_cannotClose = true;
 readNetListAndFpFiles( payload );
 m_cannotClose = false;
 /* @todo
 Go into SCH_EDIT_FRAME::OnOpenCvpcb( wxCommandEvent& event ) and trim GNL_ALL down.
 */
 break;
 case MAIL_RELOAD_LIB:
 m_cannotClose = true;
 LoadFootprintFiles();
 BuildFootprintsListBox();
 BuildLibrariesListBox();
 m_cannotClose = false;
 break;
 default:
 ; // ignore most
 }
}

References BuildFootprintsListBox(), BuildLibrariesListBox(), KIWAY_EXPRESS::Command(), KIWAY_EXPRESS::GetPayload(), LoadFootprintFiles(), m_cannotClose, MAIL_EESCHEMA_NETLIST, MAIL_RELOAD_LIB, and readNetListAndFpFiles().

◆ language_change()

void KIWAY_PLAYER::language_change ( wxCommandEvent & event )

protectedinherited

An event handler called on a language menu selection.

Definition at line 204 of file kiway_player.cpp.

{
 int id = event.GetId();
 
 // tell all the KIWAY_PLAYERs about the language change.
 Kiway().SetLanguage( id );
}

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

◆ LoadFootprintFiles()

bool CVPCB_MAINFRAME::LoadFootprintFiles ( )

Read the list of footprint (*.mod files) and generate the list of footprints.

For each footprint the following items are stored:

the footprint name
documentation string
associated keywords

Returns: true if libraries are found, false otherwise.

Definition at line 895 of file cvpcb_mainframe.cpp.

{
 FP_LIB_TABLE* fptbl = Prj().PcbFootprintLibs();
 
 // Check if there are footprint libraries in the footprint library table.
 if( !fptbl || !fptbl->GetLogicalLibs().size() )
 {
 wxMessageBox( _( "No PCB footprint libraries are listed in the current footprint "
 "library table." ), _( "Configuration Error" ), wxOK | wxICON_ERROR );
 return false;
 }
 
 WX_PROGRESS_REPORTER progressReporter( this, _( "Loading Footprint Libraries" ), 2 );
 
 m_FootprintsList->ReadFootprintFiles( fptbl, nullptr, &progressReporter );
 
 if( m_FootprintsList->GetErrorCount() )
 {
 m_FootprintsList->DisplayErrors( this );
 }
 
 return true;
}

References _, FOOTPRINT_LIST::DisplayErrors(), FOOTPRINT_LIST::GetErrorCount(), LIB_TABLE::GetLogicalLibs(), m_FootprintsList, PROJECT::PcbFootprintLibs(), KIWAY_HOLDER::Prj(), and FOOTPRINT_LIST::ReadFootprintFiles().

Referenced by KiwayMailIn(), and readNetListAndFpFiles().

◆ LoadSettings()

void CVPCB_MAINFRAME::LoadSettings ( APP_SETTINGS_BASE * aCfg )

overridevirtual

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 from EDA_BASE_FRAME.

Definition at line 529 of file cvpcb_mainframe.cpp.

{
 EDA_BASE_FRAME::LoadSettings( aCfg );
 
 CVPCB_SETTINGS* cfg = static_cast<CVPCB_SETTINGS*>( aCfg );
 
 m_filteringOptions = cfg->m_FilterFlags;
}

References EDA_BASE_FRAME::LoadSettings(), CVPCB_SETTINGS::m_FilterFlags, and m_filteringOptions.

Referenced by CVPCB_MAINFRAME().

◆ LoadWindowSettings()

void EDA_BASE_FRAME::LoadWindowSettings ( const WINDOW_SETTINGS * aCfg )

inherited

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

{
 LoadWindowState( aCfg->state );
 
 m_perspective = aCfg->perspective;
 m_mruPath = aCfg->mru_path;
 
 TOOLS_HOLDER::CommonSettingsChanged( false, false );
}

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

Referenced by EDA_BASE_FRAME::LoadSettings().

◆ LoadWindowState() [1/2]

void EDA_BASE_FRAME::LoadWindowState ( const WINDOW_STATE & aState )

virtualinherited

Load frame state info from a configuration file.

Definition at line 565 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, wxS( "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, wxS( "Using minimum size (%d, %d)" ),
 m_frameSize.x, m_frameSize.y );
 }
 
 wxLogTrace( traceDisplayLocation, wxS( "Number of displays: %d" ), wxDisplay::GetCount() );
 
 if( aState.display >= wxDisplay::GetCount() )
 {
 wxLogTrace( traceDisplayLocation, wxS( "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, wxS( "Resetting to default position" ) );
 }
 }
 
 wxLogTrace( traceDisplayLocation, wxS( "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, wxS( "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, wxS( "Maximizing window" ) );
 Maximize();
 }
 
 m_displayIndex = wxDisplay::GetFromWindow( this );
}

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

◆ LoadWindowState() [2/2]

void EDA_BASE_FRAME::LoadWindowState ( const wxString & aFileName )

inherited

Definition at line 551 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(), EDA_BASE_FRAME::LoadWindowState(), Pgm(), KIWAY_HOLDER::Prj(), and PROJECT_FILE_STATE::window.

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

◆ MessageTextFromValue() [1/2]

wxString UNITS_PROVIDER::MessageTextFromValue	(	const EDA_ANGLE &	aValue,
		bool	aAddUnitLabel = `true`
	)

inlineinherited

Definition at line 94 of file units_provider.h.

 {
 return EDA_UNIT_UTILS::UI::MessageTextFromValue( unityScale, EDA_UNITS::DEGREES,
 aValue.AsDegrees(), aAddUnitLabel,
 EDA_DATA_TYPE::DISTANCE );
 }

References EDA_ANGLE::AsDegrees(), DEGREES, DISTANCE, EDA_UNIT_UTILS::UI::MessageTextFromValue(), and unityScale.

◆ MessageTextFromValue() [2/2]

wxString UNITS_PROVIDER::MessageTextFromValue	(	double	aValue,
		bool	aAddUnitLabel = `true`,
		EDA_DATA_TYPE	aType = `EDA_DATA_TYPE::DISTANCE`
	)

inlineinherited

A lower-precision version of StringFromValue().

Should ONLY be used for status text and messages. Not suitable for dialogs, files, etc. where the loss of precision matters.

Definition at line 87 of file units_provider.h.

 {
 return EDA_UNIT_UTILS::UI::MessageTextFromValue( GetIuScale(), GetUserUnits(), aValue,
 aAddUnitLabel, aType );
 }

References UNITS_PROVIDER::GetIuScale(), UNITS_PROVIDER::GetUserUnits(), and EDA_UNIT_UTILS::UI::MessageTextFromValue().

◆ NonUserClose()

bool EDA_BASE_FRAME::NonUserClose ( bool aForce )

inlineinherited

Definition at line 584 of file eda_base_frame.h.

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

References EDA_BASE_FRAME::m_isNonUserClose.

Referenced by KIWAY::PlayerClose().

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent & aEvent )

protectedinherited

Handle the auto save timer event.

Definition at line 304 of file eda_base_frame.cpp.

{
 // Don't stomp on someone else's timer event.
 if( aEvent.GetId() != ID_AUTO_SAVE_TIMER )
 {
 aEvent.Skip();
 return;
 }
 
 if( !doAutoSave() )
 m_autoSaveTimer->Start( GetAutoSaveInterval() * 1000, wxTIMER_ONE_SHOT );
}

References EDA_BASE_FRAME::doAutoSave(), EDA_BASE_FRAME::GetAutoSaveInterval(), ID_AUTO_SAVE_TIMER, and EDA_BASE_FRAME::m_autoSaveTimer.

Referenced by EDA_BASE_FRAME::commonInit().

◆ OnCharHook()

void EDA_BASE_FRAME::OnCharHook ( wxKeyEvent & aKeyEvent )

virtualinherited

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 SYMBOL_VIEWER_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 324 of file eda_base_frame.cpp.

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

References dump(), and kicadTraceKeyEvent.

◆ OnDropFiles()

void EDA_BASE_FRAME::OnDropFiles ( wxDropFilesEvent & aEvent )

protectedvirtualinherited

Handles event fired when a file is dropped to the window.

In this base class, stores the path of files accepted. Calls DoWithAcceptedFiles() to execute actions on files.

Definition at line 1156 of file eda_base_frame.cpp.

{
 wxString* files = aEvent.GetFiles();
 
 for( int nb = 0; nb < aEvent.GetNumberOfFiles(); nb++ )
 {
 const wxFileName fn = wxFileName( files[nb] );
 wxString ext = fn.GetExt();
 
 // Alias all gerber files as GerberFileExtension
 if( IsGerberFileExtension( ext ) )
 ext = GerberFileExtension;
 
 if( m_acceptedExts.find( ext.ToStdString() ) != m_acceptedExts.end() )
 m_AcceptedFiles.emplace_back( fn );
 }
 
 DoWithAcceptedFiles();
 m_AcceptedFiles.clear();
}

References EDA_BASE_FRAME::DoWithAcceptedFiles(), GerberFileExtension, IsGerberFileExtension(), EDA_BASE_FRAME::m_acceptedExts, and EDA_BASE_FRAME::m_AcceptedFiles.

◆ onIconize()

void EDA_BASE_FRAME::onIconize ( wxIconizeEvent & aEvent )

protectedinherited

Definition at line 1437 of file eda_base_frame.cpp.

{
 // Call the handler
 handleIconizeEvent( aEvent );
 
 // Skip the event.
 aEvent.Skip();
}

References EDA_BASE_FRAME::handleIconizeEvent().

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent & event )

inherited

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

inherited

Definition at line 1363 of file eda_base_frame.cpp.

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

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

◆ OnMenuEvent()

void EDA_BASE_FRAME::OnMenuEvent ( wxMenuEvent & event )

inherited

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

◆ OnModify()

void EDA_BASE_FRAME::OnModify ( )

virtualinherited

Must be called after a model change in order to set the "modify" flag and do other frame-specific processing.

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

Definition at line 1346 of file eda_base_frame.cpp.

{
 m_autoSaveRequired = true;
}

References EDA_BASE_FRAME::m_autoSaveRequired.

Referenced by EE_POINT_EDITOR::addCorner(), EE_INSPECTION_TOOL::ExcludeMarker(), EE_POINT_EDITOR::Main(), SCH_EDIT_FRAME::OnModify(), SYMBOL_EDIT_FRAME::OnModify(), PCB_BASE_FRAME::OnModify(), PL_EDITOR_FRAME::OnModify(), and EE_POINT_EDITOR::removeCorner().

◆ OnMove()

virtual void EDA_BASE_FRAME::OnMove ( wxMoveEvent & aEvent )

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 189 of file eda_base_frame.h.

 {
 aEvent.Skip();
 }

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent & event )

inherited

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

Definition at line 994 of file eda_base_frame.cpp.

{
 ShowPreferences( wxEmptyString, wxEmptyString );
}

References EDA_BASE_FRAME::ShowPreferences().

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

◆ OnSelectComponent()

void CVPCB_MAINFRAME::OnSelectComponent ( wxListEvent & event )

Called when clicking on a component in component list window:

Updates the filtered footprint list, if the filtered list option is selected
Updates the current selected footprint in footprint list
Updates the footprint shown in footprint display window (if opened)

Definition at line 472 of file cvpcb_mainframe.cpp.

{
 if( m_skipComponentSelect )
 return;
 
 COMPONENT* symbol = GetSelectedComponent();
 wxString libraryName = m_librariesListBox->GetSelectedLibrary();
 
 m_footprintListBox->SetFootprints( *m_FootprintsList, libraryName, symbol,
 m_tcFilterString->GetValue(), m_filteringOptions );
 
 if( symbol && symbol->GetFPID().IsValid() )
 m_footprintListBox->SetSelectedFootprint( symbol->GetFPID() );
 else if( m_footprintListBox->GetSelection() >= 0 )
 m_footprintListBox->SetSelection( m_footprintListBox->GetSelection(), false );
 
 RefreshFootprintViewer();
 
 refreshAfterSymbolSearch( symbol );
}

References COMPONENT::GetFPID(), GetSelectedComponent(), LIBRARY_LISTBOX::GetSelectedLibrary(), ITEMS_LISTBOX_BASE::GetSelection(), LIB_ID::IsValid(), m_filteringOptions, m_footprintListBox, m_FootprintsList, m_librariesListBox, m_skipComponentSelect, m_tcFilterString, refreshAfterSymbolSearch(), RefreshFootprintViewer(), FOOTPRINTS_LISTBOX::SetFootprints(), FOOTPRINTS_LISTBOX::SetSelectedFootprint(), and FOOTPRINTS_LISTBOX::SetSelection().

Referenced by SYMBOLS_LISTBOX::OnSelectComponent(), LIBRARY_LISTBOX::OnSelectLibrary(), and SetFootprintFilter().

◆ OnSize()

void EDA_BASE_FRAME::OnSize ( wxSizeEvent & aEvent )

virtualinherited

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

Definition at line 533 of file eda_base_frame.cpp.

{
#ifdef __WXMAC__
 int currentDisplay = wxDisplay::GetFromWindow( this );
 
 if( m_displayIndex >= 0 && currentDisplay >= 0 && currentDisplay != m_displayIndex )
 {
 wxLogTrace( traceDisplayLocation, wxS( "OnSize: current display changed %d to %d" ),
 m_displayIndex, currentDisplay );
 m_displayIndex = currentDisplay;
 ensureWindowIsOnScreen();
 }
#endif
 
 aEvent.Skip();
}

References EDA_BASE_FRAME::ensureWindowIsOnScreen(), EDA_BASE_FRAME::m_displayIndex, and traceDisplayLocation.

Referenced by EDA_DRAW_FRAME::OnSize().

◆ OnSockRequest()

void KIWAY_PLAYER::OnSockRequest ( wxSocketEvent & evt )

inherited

Definition at line 69 of file eda_dde.cpp.

{
 size_t len;
 wxSocketBase* sock = evt.GetSocket();
 
 switch( evt.GetSocketEvent() )
 {
 case wxSOCKET_INPUT:
 sock->Read( client_ipc_buffer, 1 );
 
 if( sock->LastCount() == 0 )
 break; // No data, occurs on opening connection
 
 sock->Read( client_ipc_buffer + 1, IPC_BUF_SIZE - 2 );
 len = 1 + sock->LastCount();
 client_ipc_buffer[len] = 0;
 ExecuteRemoteCommand( client_ipc_buffer );
 break;
 
 case wxSOCKET_LOST:
 return;
 break;
 
 default:
 wxPrintf( wxT( "EDA_DRAW_FRAME::OnSockRequest() error: Invalid event !" ) );
 break;
 }
}

References client_ipc_buffer, KIWAY_PLAYER::ExecuteRemoteCommand(), and IPC_BUF_SIZE.

◆ OnSockRequestServer()

void KIWAY_PLAYER::OnSockRequestServer ( wxSocketEvent & evt )

inherited

Definition at line 99 of file eda_dde.cpp.

{
 wxSocketBase* socket;
 wxSocketServer* server = (wxSocketServer*) evt.GetSocket();
 
 socket = server->Accept();
 
 if( socket == nullptr )
 return;
 
 m_sockets.push_back( socket );
 
 socket->Notify( true );
 socket->SetEventHandler( *this, ID_EDA_SOCKET_EVENT );
 socket->SetNotify( wxSOCKET_INPUT_FLAG | wxSOCKET_LOST_FLAG );
}

References ID_EDA_SOCKET_EVENT, and KIWAY_PLAYER::m_sockets.

◆ onSystemColorChange()

void EDA_BASE_FRAME::onSystemColorChange ( wxSysColourChangedEvent & aEvent )

protectedinherited

Definition at line 1427 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 EDA_BASE_FRAME::HandleSystemColorChange().

◆ onTextFilterChanged()

void CVPCB_MAINFRAME::onTextFilterChanged ( wxCommandEvent & event )

private

Definition at line 432 of file cvpcb_mainframe.cpp.

{
 // Called when changing the filter string in main toolbar.
 // If the option FOOTPRINTS_LISTBOX::FILTERING_BY_TEXT_PATTERN is set, update the list
 // of available footprints which match the filter
 
 m_filterTimer->StartOnce( 200 );
}

References m_filterTimer.

Referenced by ReCreateHToolbar(), and setupEventHandlers().

◆ onTextFilterChangedTimer()

void CVPCB_MAINFRAME::onTextFilterChangedTimer ( wxTimerEvent & aEvent )

private

Definition at line 442 of file cvpcb_mainframe.cpp.

{
 // GTK loses the search-control's focus on a Refresh event, so we record the focus and
 // insertion point here and then restore them at the end.
 bool searchCtrlHasFocus = m_tcFilterString->HasFocus();
 long pos = m_tcFilterString->GetInsertionPoint();
 
 COMPONENT* symbol = GetSelectedComponent();
 wxString libraryName = m_librariesListBox->GetSelectedLibrary();
 
 m_footprintListBox->SetFootprints( *m_FootprintsList, libraryName, symbol,
 m_tcFilterString->GetValue(), m_filteringOptions );
 
 if( symbol && symbol->GetFPID().IsValid() )
 m_footprintListBox->SetSelectedFootprint( symbol->GetFPID() );
 else if( m_footprintListBox->GetSelection() >= 0 )
 m_footprintListBox->SetSelection( m_footprintListBox->GetSelection(), false );
 
 RefreshFootprintViewer();
 
 DisplayStatus();
 
 if( searchCtrlHasFocus && !m_tcFilterString->HasFocus() )
 {
 m_tcFilterString->SetFocus();
 m_tcFilterString->SetInsertionPoint( pos );
 }
}

References DisplayStatus(), COMPONENT::GetFPID(), GetSelectedComponent(), LIBRARY_LISTBOX::GetSelectedLibrary(), ITEMS_LISTBOX_BASE::GetSelection(), LIB_ID::IsValid(), m_filteringOptions, m_footprintListBox, m_FootprintsList, m_librariesListBox, m_tcFilterString, RefreshFootprintViewer(), FOOTPRINTS_LISTBOX::SetFootprints(), FOOTPRINTS_LISTBOX::SetSelectedFootprint(), and FOOTPRINTS_LISTBOX::SetSelection().

Referenced by setupEventHandlers().

◆ OpenProjectFiles()

bool CVPCB_MAINFRAME::OpenProjectFiles	(	const std::vector< wxString > &	aFileList,
		int	aCtl = `0`
	)

overridevirtual

Open a project or set of files given by aFileList.

This is generalized in the direction of worst case. In a typical case aFileList will only hold a single file, like "myboard.kicad_pcb" because any KIWAY_PLAYER is only in one KIWAY and the KIWAY owns the PROJECT. Therefore opening files from multiple projects into the same KIWAY_PLAYER is precluded.

Each derived class should handle this in a way specific to its needs. No filename prompting is done inside here for any file or project. There should be no need to call this with aFileList which is empty. However, calling it with a single filename which does not exist should indicate to the implementer that a new session is being started and that the given name is the desired name for the data file at time of save.

This function does not support "appending". Use a different function for that. Any prior project data tree should be cleared before loading the new stuff. Therefore, one of the first things an implementation should do is test for existence of the first file in the list, and if it does not exist, treat it as a new session, possibly with a UI notification to that effect.

After loading the window should update its Title as part of this operation. If the KIWAY_PLAYER needs to, it can load the *.pro file as part of this operation.

If the KIWAY_PLAYER cannot load any of the file(s) in the list, then it should say why through some GUI interface, and return false.

Parameters

aFileList	includes files that this frame should open according to the knowledge in the derived wxFrame. In almost every case, the list will have only a single file in it.
aCtl	is a set of bit flags ORed together from the set of KICTL_* #defined above.

Returns: true if all requested files were opened OK, else false.

Reimplemented from KIWAY_PLAYER.

Definition at line 702 of file cvpcb_mainframe.cpp.

{
 return true;
}

◆ PopCommandFromRedoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromRedoList ( )

virtualinherited

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

Definition at line 1340 of file eda_base_frame.cpp.

{
 return m_redoList.PopCommand();
}

References EDA_BASE_FRAME::m_redoList, and UNDO_REDO_CONTAINER::PopCommand().

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

◆ PopCommandFromUndoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromUndoList ( )

virtualinherited

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

Definition at line 1334 of file eda_base_frame.cpp.

{
 return m_undoList.PopCommand();
}

References EDA_BASE_FRAME::m_undoList, and UNDO_REDO_CONTAINER::PopCommand().

Referenced by PCB_BASE_EDIT_FRAME::AppendCopyToUndoList(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList(), PL_EDITOR_FRAME::RollbackFromUndo(), PCB_BASE_EDIT_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 TOOL_EVENT & aEvent )

virtualinherited

Pops a tool from the stack.

Parameters

aEvent The event that started the tool that was pushed to the stack.

Definition at line 65 of file tools_holder.cpp.

{
 const std::string& actionName = aEvent.getCommandStr();
 
 wxASSERT_MSG( !aEvent.getCommandStr().empty(), wxS( "Popped Empty Tool Name!" ) );
 
 // 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;
 }
 }
 
 wxASSERT_MSG( false, wxS( "Popped a Tool Not on the Tool Stack!" ) );
}

References TOOLS_HOLDER::DisplayToolMsg(), ACTION_MANAGER::FindAction(), TOOL_MANAGER::GetActionManager(), TOOL_EVENT::getCommandStr(), EDA_UNIT_UTILS::GetLabel(), 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(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), DRAWING_TOOL::InteractivePlaceWithPreview(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), PCB_PICKER_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_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::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), EDIT_TOOL::Remove(), ROUTER_TOOL::RouteSelected(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ PrintMsg()

void EDA_BASE_FRAME::PrintMsg ( const wxString & text )

inherited

Definition at line 828 of file eda_base_frame.cpp.

{
 SetStatusText( text );
}

References text.

Referenced by 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().

◆ ProcessEvent()

bool EDA_BASE_FRAME::ProcessEvent ( wxEvent & aEvent )

overrideinherited

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 255 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_supportsAutoSave && IsShown() && IsActive()
 && m_autoSavePending != isAutoSaveRequired()
 && GetAutoSaveInterval() > 0 )
 {
 if( !m_autoSavePending )
 {
 wxLogTrace( traceAutoSave, wxT( "Starting auto save timer." ) );
 m_autoSaveTimer->Start( GetAutoSaveInterval() * 1000, wxTIMER_ONE_SHOT );
 m_autoSavePending = true;
 }
 else if( m_autoSaveTimer->IsRunning() )
 {
 wxLogTrace( traceAutoSave, wxT( "Stopping auto save timer." ) );
 m_autoSaveTimer->Stop();
 m_autoSavePending = false;
 }
 }
 
 return true;
}

References EDA_BASE_FRAME::findQuasiModalDialog(), EDA_BASE_FRAME::GetAutoSaveInterval(), EDA_BASE_FRAME::isAutoSaveRequired(), EDA_BASE_FRAME::m_autoSavePending, EDA_BASE_FRAME::m_autoSaveTimer, EDA_BASE_FRAME::m_isClosing, EDA_BASE_FRAME::m_supportsAutoSave, Pgm(), and traceAutoSave.

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

◆ ProjectChanged()

virtual void EDA_BASE_FRAME::ProjectChanged ( )

inlinevirtualinherited

Notification event that the project has changed.

Reimplemented in KICAD_MANAGER_FRAME, and PCB_EDIT_FRAME.

Definition at line 504 of file eda_base_frame.h.

504{}

Referenced by KIWAY::ProjectChanged().

◆ PushCommandToRedoList()

void EDA_BASE_FRAME::PushCommandToRedoList ( PICKED_ITEMS_LIST * aItem )

virtualinherited

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 1319 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 EDA_BASE_FRAME::ClearUndoORRedoList(), EDA_BASE_FRAME::GetRedoCommandCount(), EDA_BASE_FRAME::m_redoList, EDA_BASE_FRAME::m_undoRedoCountMax, UNDO_REDO_CONTAINER::PushCommand(), and EDA_BASE_FRAME::REDO_LIST.

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

◆ PushCommandToUndoList()

void EDA_BASE_FRAME::PushCommandToUndoList ( PICKED_ITEMS_LIST * aItem )

virtualinherited

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 1304 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 EDA_BASE_FRAME::ClearUndoORRedoList(), EDA_BASE_FRAME::GetUndoCommandCount(), EDA_BASE_FRAME::m_undoList, EDA_BASE_FRAME::m_undoRedoCountMax, UNDO_REDO_CONTAINER::PushCommand(), and EDA_BASE_FRAME::UNDO_LIST.

Referenced by PL_EDITOR_FRAME::GetLayoutFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SCH_EDITOR_CONTROL::Redo(), PCB_BASE_EDIT_FRAME::RestoreCopyFromRedoList(), PCB_EDIT_FRAME::RunActionPlugin(), PL_EDITOR_FRAME::SaveCopyInUndoList(), SYMBOL_EDIT_FRAME::SaveCopyInUndoList(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::StartNewUndo(), and SCH_EDITOR_CONTROL::Undo().

◆ PushTool()

void TOOLS_HOLDER::PushTool ( const TOOL_EVENT & aEvent )

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.

Pushes a tool to the stack.

Parameters

aEvent The event that is starting the tool to be pushed to the stack.

Definition at line 44 of file tools_holder.cpp.

{
 const std::string& actionName = aEvent.getCommandStr();
 
 wxASSERT_MSG( !actionName.empty(), wxS( "Pushed Empty Tool Name!" ) );
 
 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_EVENT::getCommandStr(), 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(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), DRAWING_TOOL::InteractivePlaceWithPreview(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), PCB_PICKER_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_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::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), EDIT_TOOL::Remove(), ROUTER_TOOL::RouteSelected(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ readNetListAndFpFiles()

bool CVPCB_MAINFRAME::readNetListAndFpFiles ( const std::string & aNetlist )

protected

Load the netlist file built on the fly by Eeschema and loads footprint libraries from fp lib tables.

Parameters

aNetlist is the netlist from Eeschema in KiCad s-expr format. (see CVPCB_MAINFRAME::KiwayMailIn() to know how to get this netlist)

Definition at line 83 of file readwrite_dlgs.cpp.

{
 wxString msg;
 bool hasMissingNicks = false;
 
 readSchematicNetlist( aNetlist );
 
 if( m_symbolsListBox == nullptr )
 return false;
 
 wxSafeYield();
 
 LoadFootprintFiles();
 
 BuildFootprintsListBox();
 BuildLibrariesListBox();
 
 m_symbolsListBox->Clear();
 
 if( m_netlist.AnyFootprintsLinked() )
 {
 for( unsigned i = 0; i < m_netlist.GetCount(); i++ )
 {
 COMPONENT* component = m_netlist.GetComponent( i );
 
 if( component->GetFPID().empty() )
 continue;
 
 if( component->GetFPID().IsLegacy() )
 hasMissingNicks = true;
 }
 }
 
 // Check if footprint links were generated before the footprint library table was implemented.
 if( hasMissingNicks )
 {
 msg = _( "Some of the assigned footprints are legacy entries with no library names. Would "
 "you like KiCad to attempt to convert them to the new required LIB_ID format? "
 "(If you answer no, then these assignments will be cleared and you will need to "
 "re-assign them manually.)" );
 
 if( IsOK( this, msg ) )
 {
 msg.Clear();
 
 try
 {
 for( unsigned i = 0; i < m_netlist.GetCount(); i++ )
 {
 COMPONENT* component = m_netlist.GetComponent( i );
 
 if( component->GetFPID().IsLegacy() )
 {
 // get this first here, it's possibly obsoleted if we get it too soon.
 FP_LIB_TABLE* tbl = Prj().PcbFootprintLibs();
 
 int guess = guessNickname( tbl, (LIB_ID*) &component->GetFPID() );
 
 switch( guess )
 {
 case 0:
 m_modified = true;
 break;
 
 case 1:
 msg += wxString::Format( _( "Component '%s' footprint '%s' <b>not "
 "found</b> in any library.\n" ),
 component->GetReference(),
 component->GetFPID().GetLibItemName().wx_str() );
 break;
 
 case 2:
 msg += wxString::Format( _( "Component '%s' footprint '%s' was found "
 "in <b>multiple</b> libraries.\n" ),
 component->GetReference(),
 component->GetFPID().GetLibItemName().wx_str() );
 break;
 }
 }
 }
 }
 catch( const IO_ERROR& ioe )
 {
 msg = ioe.What();
 msg += wxT( "\n\n" );
 msg += _( "First check your footprint library table entries." );
 
 wxMessageBox( msg, _( "Problematic Footprint Library Tables" ) );
 return false;
 }
 
 if( msg.size() )
 {
 HTML_MESSAGE_BOX dlg( this, wxEmptyString );
 
 dlg.MessageSet( _( "The following errors occurred attempting to convert the "
 "footprint assignments:\n\n" ) );
 dlg.ListSet( msg );
 dlg.MessageSet( _( "\nYou will need to reassign them manually if you want them "
 "to be updated correctly the next time you import the "
 "netlist in Pcbnew." ) );
 
#if 1
 dlg.ShowModal();
#else
 dlg.Fit();
 
 // Modeless lets user watch while fixing the problems, but its not working.
 dlg.Show( true );
#endif
 }
 }
 else
 {
 // Clear the legacy footprint assignments.
 for( unsigned i = 0; i < m_netlist.GetCount(); i++ )
 {
 COMPONENT* component = m_netlist.GetComponent( i );
 
 if( component->GetFPID().IsLegacy() )
 {
 component->SetFPID( LIB_ID() );
 m_modified = true;
 }
 }
 }
 }
 
 
 // Display a dialog to select footprint selection, if the netlist
 // and the .cmp file give 2 different valid footprints
 std::vector <int > m_indexes; // indexes of footprints in netlist
 
 for( unsigned ii = 0; ii < m_netlist.GetCount(); ii++ )
 {
 COMPONENT* component = m_netlist.GetComponent( ii );
 
 if( component->GetAltFPID().empty() )
 continue;
 
 if( component->GetFPID().IsLegacy() || component->GetAltFPID().IsLegacy() )
 continue;
 
 m_indexes.push_back( ii );
 }
 
 // If a n assignment conflict is found,
 // open a dialog to chose between schematic assignment
 // and .cmp file assignment:
 if( m_indexes.size() > 0 )
 {
 DIALOG_FP_CONFLICT_ASSIGNMENT_SELECTOR dlg( this );
 
 for( unsigned ii = 0; ii < m_indexes.size(); ii++ )
 {
 COMPONENT* component = m_netlist.GetComponent( m_indexes[ii] );
 
 wxString cmpfpid = component->GetFPID().Format();
 wxString schfpid = component->GetAltFPID().Format();
 
 dlg.Add( component->GetReference(), schfpid, cmpfpid );
 }
 
 if( dlg.ShowModal() == wxID_OK )
 {
 // Update the fp selection:
  for( unsigned ii = 0; ii < m_indexes.size(); ii++ )
 {
 COMPONENT* component = m_netlist.GetComponent( m_indexes[ii] );
 
 int choice = dlg.GetSelection( component->GetReference() );
 
 if( choice == 0 ) // the schematic (alt fpid) is chosen:
 component->SetFPID( component->GetAltFPID() );
 }
 }
 }
 
 // Populates the component list box:
 for( unsigned i = 0; i < m_netlist.GetCount(); i++ )
 {
 COMPONENT* component = m_netlist.GetComponent( i );
 
 msg = formatSymbolDesc( m_symbolsListBox->GetCount() + 1,
 component->GetReference(),
 component->GetValue(),
 FROM_UTF8( component->GetFPID().Format().c_str() ) );
 
 m_symbolsListBox->AppendLine( msg );
 
 FOOTPRINT_INFO* fp =
 m_FootprintsList->GetFootprintInfo( component->GetFPID().Format().wx_str() );
 
 if( !fp )
 {
 m_symbolsListBox->AppendWarning( i );
 }
 }
 
 if( !m_netlist.IsEmpty() )
 m_symbolsListBox->SetSelection( 0, true );
 
 DisplayStatus();
 
 return true;
}

References _, DIALOG_FP_CONFLICT_ASSIGNMENT_SELECTOR::Add(), NETLIST::AnyFootprintsLinked(), SYMBOLS_LISTBOX::AppendLine(), SYMBOLS_LISTBOX::AppendWarning(), BuildFootprintsListBox(), BuildLibrariesListBox(), UTF8::c_str(), SYMBOLS_LISTBOX::Clear(), DisplayStatus(), LIB_ID::empty(), LIB_ID::Format(), Format(), formatSymbolDesc(), FROM_UTF8(), COMPONENT::GetAltFPID(), NETLIST::GetComponent(), SYMBOLS_LISTBOX::GetCount(), NETLIST::GetCount(), FOOTPRINT_LIST::GetFootprintInfo(), COMPONENT::GetFPID(), LIB_ID::GetLibItemName(), COMPONENT::GetReference(), DIALOG_FP_CONFLICT_ASSIGNMENT_SELECTOR::GetSelection(), COMPONENT::GetValue(), guessNickname(), NETLIST::IsEmpty(), LIB_ID::IsLegacy(), IsOK(), HTML_MESSAGE_BOX::ListSet(), LoadFootprintFiles(), m_FootprintsList, m_modified, m_netlist, m_symbolsListBox, HTML_MESSAGE_BOX::MessageSet(), PROJECT::PcbFootprintLibs(), KIWAY_HOLDER::Prj(), readSchematicNetlist(), COMPONENT::SetFPID(), SYMBOLS_LISTBOX::SetSelection(), DIALOG_SHIM::Show(), IO_ERROR::What(), and UTF8::wx_str().

Referenced by KiwayMailIn().

◆ readSchematicNetlist()

int CVPCB_MAINFRAME::readSchematicNetlist ( const std::string & aNetlist )

protected

Read the netlist (.net) file built on the fly by Eeschema.

Parameters

aNetlist is the netlist buffer filled by Eeschema, in KiCad s-expr format. It is the same netlist as the .net file created by Eeschema. (This method is called by readNetListAndFpFiles)

Definition at line 960 of file cvpcb_mainframe.cpp.

{
 STRING_LINE_READER* stringReader = new STRING_LINE_READER( aNetlist, "Eeschema via Kiway" );
 KICAD_NETLIST_READER netlistReader( stringReader, &m_netlist );
 
 m_netlist.Clear();
 
 try
 {
 netlistReader.LoadNetlist();
 }
 catch( const IO_ERROR& ioe )
 {
 wxString msg = wxString::Format( _( "Error loading schematic.\n%s" ),
 ioe.What().GetData() );
 wxMessageBox( msg, _( "Load Error" ), wxOK | wxICON_ERROR );
 return 1;
 }
 
 // We also remove footprint name if it is "$noname" because this is a dummy name,
 // not the actual name of the footprint.
 for( unsigned ii = 0; ii < m_netlist.GetCount(); ii++ )
 {
 if( m_netlist.GetComponent( ii )->GetFPID().GetLibItemName() == std::string( "$noname" ) )
 m_netlist.GetComponent( ii )->SetFPID( LIB_ID() );
 }
 
 // Sort symbols by reference:
 m_netlist.SortByReference();
 
 return 0;
}

References _, NETLIST::Clear(), Format(), NETLIST::GetComponent(), NETLIST::GetCount(), COMPONENT::GetFPID(), LIB_ID::GetLibItemName(), KICAD_NETLIST_READER::LoadNetlist(), m_netlist, COMPONENT::SetFPID(), NETLIST::SortByReference(), and IO_ERROR::What().

Referenced by readNetListAndFpFiles().

◆ ReCreateHToolbar()

void CVPCB_MAINFRAME::ReCreateHToolbar ( )

Definition at line 31 of file toolbars_cvpcb.cpp.

{
 if( m_mainToolBar )
 {
 m_mainToolBar->ClearToolbar();
 }
 else
 {
 m_mainToolBar = new ACTION_TOOLBAR( this, ID_H_TOOLBAR, wxDefaultPosition, wxDefaultSize,
 KICAD_AUI_TB_STYLE | wxAUI_TB_HORZ_LAYOUT );
 m_mainToolBar->SetAuiManager( &m_auimgr );
 }
 
 m_mainToolBar->Add( CVPCB_ACTIONS::saveAssociationsToSchematic );
 
 m_mainToolBar->AddScaledSeparator( this );
 m_mainToolBar->Add( ACTIONS::showFootprintLibTable );
 
 m_mainToolBar->AddScaledSeparator( this );
 m_mainToolBar->Add( CVPCB_ACTIONS::showFootprintViewer );
 
 
 m_mainToolBar->AddScaledSeparator( this );
 m_mainToolBar->Add( CVPCB_ACTIONS::gotoPreviousNA );
 m_mainToolBar->Add( CVPCB_ACTIONS::gotoNextNA );
 
 m_mainToolBar->AddScaledSeparator( this );
 m_mainToolBar->Add( ACTIONS::undo );
 m_mainToolBar->Add( ACTIONS::redo );
 m_mainToolBar->Add( CVPCB_ACTIONS::autoAssociate );
 m_mainToolBar->Add( CVPCB_ACTIONS::deleteAll );
 
 // Add tools for footprint names filtering:
 m_mainToolBar->AddScaledSeparator( this );
 
 // wxGTK with GTK3 has a serious issue with bold texts: strings are incorrectly sized
 // and truncated after the first space.
 // so use SetLabelMarkup is a trick to fix this issue.
 m_mainToolBar->AddSpacer( 15 );
 wxString msg_bold = _( "Footprint Filters:" );
 wxStaticText* text = new wxStaticText( m_mainToolBar, wxID_ANY, msg_bold );
 text->SetFont( m_mainToolBar->GetFont().Bold() );
#ifdef __WXGTK3__
 text->SetLabelMarkup( "<b>" + msg_bold + "</b>" );
#endif
 m_mainToolBar->AddControl( text );
 
 m_mainToolBar->Add( CVPCB_ACTIONS::FilterFPbyFPFilters, ACTION_TOOLBAR::TOGGLE );
 m_mainToolBar->Add( CVPCB_ACTIONS::filterFPbyPin, ACTION_TOOLBAR::TOGGLE );
 m_mainToolBar->Add( CVPCB_ACTIONS::FilterFPbyLibrary, ACTION_TOOLBAR::TOGGLE );
 
 m_mainToolBar->AddScaledSeparator( this );
 
 m_tcFilterString = new wxTextCtrl( m_mainToolBar, wxID_ANY, wxEmptyString, wxDefaultPosition,
 wxDefaultSize, wxTE_PROCESS_ENTER );
 
 m_tcFilterString->Bind( wxEVT_TEXT_ENTER, &CVPCB_MAINFRAME::onTextFilterChanged, this );
 
 m_mainToolBar->AddControl( m_tcFilterString );
 
 // after adding the buttons to the toolbar, must call Realize() to reflect the changes
 m_mainToolBar->Realize();
}

References _, ACTION_TOOLBAR::Add(), ACTION_TOOLBAR::AddScaledSeparator(), CVPCB_ACTIONS::autoAssociate, ACTION_TOOLBAR::ClearToolbar(), CVPCB_ACTIONS::deleteAll, CVPCB_ACTIONS::FilterFPbyFPFilters, CVPCB_ACTIONS::FilterFPbyLibrary, CVPCB_ACTIONS::filterFPbyPin, CVPCB_ACTIONS::gotoNextNA, CVPCB_ACTIONS::gotoPreviousNA, ID_H_TOOLBAR, EDA_BASE_FRAME::KICAD_AUI_TB_STYLE, EDA_BASE_FRAME::m_auimgr, m_mainToolBar, m_tcFilterString, onTextFilterChanged(), ACTIONS::redo, CVPCB_ACTIONS::saveAssociationsToSchematic, ACTION_TOOLBAR::SetAuiManager(), ACTIONS::showFootprintLibTable, CVPCB_ACTIONS::showFootprintViewer, text, ACTION_TOOLBAR::TOGGLE, and ACTIONS::undo.

Referenced by CVPCB_MAINFRAME(), and ShowChangedLanguage().

◆ ReCreateMenuBar()

void EDA_BASE_FRAME::ReCreateMenuBar ( )

inherited

Recreates the menu bar.

Needed when the language or icons are changed

As of wxWidgets 3.2, recreating the menubar from within an event handler of that menubar will result in memory corruption on macOS. In order to minimize the chance of programmer error causing regressions here, we always wrap calls to ReCreateMenuBar in a CallAfter to ensure that they do not occur within the same event handling call stack.

Definition at line 446 of file eda_base_frame.cpp.

{
 CallAfter( [=]()
 {
 doReCreateMenuBar();
 } );
}

References EDA_BASE_FRAME::doReCreateMenuBar().

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), EDA_BASE_FRAME::ClearFileHistory(), EDA_BASE_FRAME::CommonSettingsChanged(), CVPCB_MAINFRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), EDA_BASE_FRAME::GetFileFromHistory(), EDA_BASE_FRAME::HandleSystemColorChange(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), SCRIPTING_TOOL::reloadPlugins(), EDA_BASE_FRAME::ShowChangedLanguage(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), and EDA_BASE_FRAME::UpdateFileHistory().

◆ RedoAssociation()

void CVPCB_MAINFRAME::RedoAssociation ( )

Redo the most recently undone association.

Definition at line 573 of file cvpcb_mainframe.cpp.

{
 if( m_redoList.size() == 0 )
 return;
 
 CVPCB_UNDO_REDO_ENTRIES curEntry = m_redoList.back();
 m_redoList.pop_back();
 
 // Iterate over the entries to undo
 bool firstAssoc = true;
 
 for( const auto& assoc : curEntry )
 {
 AssociateFootprint( assoc, firstAssoc );
 firstAssoc = false;
 }
}

References AssociateFootprint(), and m_redoList.

Referenced by CVPCB_ASSOCIATION_TOOL::Redo().

◆ refreshAfterSymbolSearch()

void CVPCB_MAINFRAME::refreshAfterSymbolSearch ( COMPONENT * aSymbol )

private

Definition at line 708 of file cvpcb_mainframe.cpp.

{
 // Tell AuiMgr that objects are changed !
 if( m_auimgr.GetManagedWindow() ) // Be sure Aui Manager is initialized
 m_auimgr.Update(); // (could be not the case when starting CvPcb)
 
 if( aSymbol == nullptr )
 {
 DisplayStatus();
 return;
 }
 
 // Preview of the already assigned footprint.
 // Find the footprint that was already chosen for this aSymbol and select it,
 // but only if the selection is made from the aSymbol list or the library list.
 // If the selection is made from the footprint list, do not change the current
 // selected footprint.
 if( FindFocus() == m_symbolsListBox || FindFocus() == m_librariesListBox )
 {
 wxString footprintName = FROM_UTF8( aSymbol->GetFPID().Format().c_str() );
 
 m_footprintListBox->SetSelection( m_footprintListBox->GetSelection(), false );
 
 for( int ii = 0; ii < m_footprintListBox->GetCount(); ii++ )
 {
 wxString candidateName;
 wxString msg = m_footprintListBox->OnGetItemText( ii, 0 );
 msg.Trim( true );
 msg.Trim( false );
 candidateName = msg.AfterFirst( wxChar( ' ' ) );
 
 if( footprintName.Cmp( candidateName ) == 0 )
 {
 m_footprintListBox->SetSelection( ii, true );
 break;
 }
 }
 }
 
 SendComponentSelectionToSch();
 DisplayStatus();
}

References UTF8::c_str(), DisplayStatus(), LIB_ID::Format(), FROM_UTF8(), FOOTPRINTS_LISTBOX::GetCount(), COMPONENT::GetFPID(), ITEMS_LISTBOX_BASE::GetSelection(), EDA_BASE_FRAME::m_auimgr, m_footprintListBox, m_librariesListBox, m_symbolsListBox, FOOTPRINTS_LISTBOX::OnGetItemText(), SendComponentSelectionToSch(), and FOOTPRINTS_LISTBOX::SetSelection().

Referenced by OnSelectComponent().

◆ RefreshCanvas()

virtual void TOOLS_HOLDER::RefreshCanvas ( )

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 165 of file tools_holder.h.

165{ }

Referenced by ACTION_TOOLBAR::onPaletteEvent(), ACTION_TOOLBAR::onToolEvent(), and TOOL_MANAGER::ProcessEvent().

◆ RefreshFootprintViewer()

void CVPCB_MAINFRAME::RefreshFootprintViewer ( )

Definition at line 494 of file cvpcb_mainframe.cpp.

{
 if( GetFootprintViewerFrame() && !m_viewerPendingUpdate )
 {
 Bind( wxEVT_IDLE, &CVPCB_MAINFRAME::updateFootprintViewerOnIdle, this );
 m_viewerPendingUpdate = true;
 }
}

References GetFootprintViewerFrame(), m_viewerPendingUpdate, and updateFootprintViewerOnIdle().

Referenced by OnSelectComponent(), and onTextFilterChangedTimer().

◆ 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(), and TOOLS_HOLDER::RegisterUIUpdateHandler().

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

◆ RegisterUIUpdateHandler() [2/2]

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

overridevirtualinherited

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 343 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 EDA_BASE_FRAME::HandleUpdateUIEvent(), and EDA_BASE_FRAME::m_uiUpdateMap.

Referenced by SCH_EDIT_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), PCB_EDIT_FRAME::doReCreateMenuBar(), EDA_BASE_FRAME::setupUIConditions(), EDA_3D_VIEWER_FRAME::setupUIConditions(), and KICAD_MANAGER_FRAME::setupUIConditions().

◆ SaveFootprintAssociation()

bool CVPCB_MAINFRAME::SaveFootprintAssociation ( bool doSaveSchematic )

Save the edits that the user has done by sending them back to Eeschema via the kiway.

Optionally saves the schematic to disk as well.

Definition at line 291 of file readwrite_dlgs.cpp.

{
 std::string payload;
 STRING_FORMATTER sf;
 
 m_netlist.FormatCvpcbNetlist( &sf );
 
 payload = sf.GetString();
 Kiway().ExpressMail( FRAME_SCH, MAIL_ASSIGN_FOOTPRINTS, payload );
 
 if( doSaveSchematic )
 {
 payload = "";
 Kiway().ExpressMail( FRAME_SCH, MAIL_SCH_SAVE, payload );
 
 if( payload == "success" )
 SetStatusText( _( "Schematic saved" ), 1 );
 }
 
 // Changes are saved, so reset the flag
 m_modified = false;
 
 return true;
}

References _, KIWAY::ExpressMail(), NETLIST::FormatCvpcbNetlist(), FRAME_SCH, STRING_FORMATTER::GetString(), KIWAY_HOLDER::Kiway(), m_modified, m_netlist, MAIL_ASSIGN_FOOTPRINTS, MAIL_SCH_SAVE, and SetStatusText().

Referenced by canCloseWindow(), CVPCB_CONTROL::SaveAssociationsToFile(), and CVPCB_CONTROL::SaveAssociationsToSchematic().

◆ SaveProjectSettings()

virtual void EDA_BASE_FRAME::SaveProjectSettings ( )

inlinevirtualinherited

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

Definition at line 364 of file eda_base_frame.h.

364{};

Referenced by DIALOG_PAGES_SETTINGS::TransferDataFromWindow().

◆ SaveSettings()

void CVPCB_MAINFRAME::SaveSettings ( APP_SETTINGS_BASE * aCfg )

overridevirtual

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 from EDA_BASE_FRAME.

Definition at line 539 of file cvpcb_mainframe.cpp.

{
 EDA_BASE_FRAME::SaveSettings( aCfg );
 
 CVPCB_SETTINGS* cfg = 

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ CONTROL_TYPE

◆ CRITERIA

◆ CVPCB_FILTER_ACTION

◆ FOCUS_DIR

◆ HOLDER_TYPE

◆ ITEM_DIR

◆ UNDO_REDO_LIST

Constructor & Destructor Documentation

◆ ~CVPCB_MAINFRAME()

◆ CVPCB_MAINFRAME()

Member Function Documentation

◆ AddStandardHelpMenu()

◆ AngleValueFromString()

◆ AssociateFootprint()

◆ AutomaticFootprintMatching()

◆ buildEquivalenceList()

◆ BuildFootprintsListBox()

◆ BuildLibrariesListBox()

◆ BuildSymbolsListBox()

◆ canCloseWindow()

◆ ChangeUserUnits()

◆ CheckForAutoSaveFile()

◆ ClearFileHistory()

◆ ClearUndoORRedoList()

◆ ClearUndoRedoList()

◆ commonInit()

◆ CommonSettingsChanged()

◆ config()

◆ ConfigBaseName()

◆ CreateInfoBar()

◆ CreateServer()

◆ CurrentToolName()

◆ Destroy()

◆ DismissModal()

◆ DisplayStatus()

◆ DisplayToolMsg()

◆ doAutoSave()

◆ doCloseWindow()

◆ doReCreateMenuBar()

◆ DoWithAcceptedFiles()

◆ ensureWindowIsOnScreen()

◆ ExecuteRemoteCommand()

◆ findQuasiModalDialog()

◆ FinishAUIInitialization()

◆ formatSymbolDesc()

◆ GetAboutTitle()

◆ GetAutoSaveFilePrefix()

◆ GetAutoSaveInterval()

◆ GetComponentIndices()

◆ GetCurrentFileName()

◆ GetCurrentSelection()

◆ GetDoImmediateActions()

◆ GetDragAction()

◆ GetFileFromHistory()

◆ GetFileHistory()

◆ GetFocusedControl()

◆ GetFootprintViewerFrame()

◆ GetFrameType()

◆ GetInfoBar()

◆ GetIuScale()

◆ GetMaxUndoItems()

◆ GetMoveWarpsCursor()

◆ GetMruPath()

◆ GetOriginTransforms()

◆ GetRedoCommandCount()

◆ GetSelectedComponent()

◆ GetSelectedFootprint()