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

wxControl *	GetFocusedControlObject () const
	Get a pointer to the currently focused control. 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...

bool	canCloseWindow (wxCloseEvent &aCloseEvent) override

void	doCloseWindow () override

void	ReCreateHToolbar ()

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

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	OnEnterFilteringText (wxCommandEvent &event)
	Called each time the text of m_tcFilterString is changed. 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...

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	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	SendMessageToEESCHEMA (bool aClearHighligntOnly=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	SetStatusText (const wxString &aText, int aNumber=0) override

virtual void	ParseArgs (wxCmdLineParser &aParser)
	Handle command-line arguments in a frame-specific way. More...

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

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

void	SetUserUnits (EDA_UNITS aUnits)

void	ChangeUserUnits (EDA_UNITS aUnits)

virtual void	ToggleUserUnits ()

SETTINGS_MANAGER *	GetSettingsManager () const

virtual SEVERITY	GetSeverity (int aErrorCode) const

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

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

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

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

virtual void	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)

void	SetAutoSaveInterval (int aInterval)

int	GetAutoSaveInterval () const

bool	IsType (FRAME_T aType) const

FRAME_T	GetFrameType () const

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

virtual wxString	help_name ()

void	OnKicadAbout (wxCommandEvent &event)

void	OnPreferences (wxCommandEvent &event)
	Displays the preferences and settings of all opened editors paged dialog. More...

void	PrintMsg (const wxString &text)

void	CreateInfoBar ()

void	FinishAUIInitialization ()

WX_INFOBAR *	GetInfoBar ()

void	ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton=false, WX_INFOBAR::MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...

void	ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton, std::function< void(void)> aCallback)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...

void	ShowInfoBarWarning (const wxString &aWarningMsg, bool aShowCloseButton=false)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar. More...

void	ShowInfoBarMsg (const wxString &aMsg, bool aShowCloseButton=false)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar. More...

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

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

void	LoadWindowState (const wxString &aFileName)

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

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

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 std::string &actionName)
	NB: the definition of "tool" is different at the user level. More...

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

bool	ToolStackIsEmpty ()

std::string	CurrentToolName () const

bool	IsCurrentTool (const TOOL_ACTION &aAction) const

virtual void	DisplayToolMsg (const wxString &msg)

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

MOUSE_DRAG_ACTION	GetDragAction () const
	Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects. More...

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

virtual void	RefreshCanvas ()

HOLDER_TYPE	GetType () const

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

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

void	SetKiway (wxWindow aDest, KIWAY aKiway)
	It is only used for debugging, since "this" is not a wxWindow*. More...

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

Public Attributes
FOOTPRINT_LIST *	m_FootprintsList

Protected Member Functions
	CVPCB_MAINFRAME (KIWAY aKiway, wxWindow aParent)

void	setupUIConditions () override
	Setup the UI conditions for the various actions and their controls in this frame. 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 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 ()

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

FRAME_T	m_ident

wxPoint	m_framePos

wxSize	m_frameSize

bool	m_maximizeByDefault

int	m_displayIndex

wxPoint	m_normalFramePos

wxSize	m_normalFrameSize

wxString	m_aboutTitle

wxAuiManager	m_auimgr

wxString	m_perspective

WX_INFOBAR *	m_infoBar

wxString	m_configName

SETTINGS_MANAGER *	m_settingsManager

FILE_HISTORY *	m_fileHistory

bool	m_hasAutoSave

bool	m_autoSaveState

int	m_autoSaveInterval

wxTimer *	m_autoSaveTimer

int	m_undoRedoCountMax

wxString	m_mruPath

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

std::map< int, UIUpdateHandler >	m_uiUpdateMap
	Set by the close window event handler after frames are asked if they can close. More...

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

bool	m_isNonUserClose

TOOL_MANAGER *	m_toolManager

ACTIONS *	m_actions

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

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

void	refreshAfterSymbolSearch (COMPONENT *aSymbol)

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

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 309 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::DIALOG

Definition: kiway_holder.h:39

KIWAY_HOLDER::PANEL

Definition: kiway_holder.h:39

KIWAY_HOLDER::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 109 of file eda_base_frame.h.

  {
  UNDO_LIST,
  REDO_LIST
  };

Constructor & Destructor Documentation

◆ ~CVPCB_MAINFRAME()

CVPCB_MAINFRAME::~CVPCB_MAINFRAME ( )

Definition at line 216 of file cvpcb_mainframe.cpp.

 {
  // 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_toolDispatcher, TOOLS_HOLDER::m_toolManager, and TOOL_MANAGER::ShutdownAllTools().

◆ CVPCB_MAINFRAME()

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

protected

Definition at line 62 of file cvpcb_mainframe.cpp.

  :
  KIWAY_PLAYER( aKiway, aParent, FRAME_CVPCB, _( "Assign Footprints" ), wxDefaultPosition,
  wxDefaultSize, KICAD_DEFAULT_DRAWFRAME_STYLE, CVPCB_MAINFRAME_NAME )
 {
  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 = "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();
  BuildLibrariesListBox();
 
  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 );
 
  wxStaticLine* staticline1 = new wxStaticLine( bottomPanel );
  panelSizer->Add( staticline1, 0, wxEXPAND, 5 );
 
  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() ) )
  {
  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" );
 
  KIPLATFORM::APP::SetShutdownBlockReason( this, _( "Symbol to footprint changes are unsaved" ) );
 }

References _, BuildFootprintsListBox(), BuildLibrariesListBox(), BuildSymbolsListBox(), PCAD2KICAD::Center, EDA_BASE_FRAME::config(), KIPLATFORM::UI::FixupCancelButtonCmdKeyCollision(), FOOTPRINT_LIST::GetInstance(), KIUI::GetStatusFont(), icon_cvpcb, 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_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(), 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 460 of file eda_base_frame.cpp.

 {
  COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
  ACTION_MENU* helpMenu = new ACTION_MENU( false, commonControl );
 
  helpMenu->Add( ACTIONS::help );
  helpMenu->Add( ACTIONS::gettingStarted );
  helpMenu->Add( ACTIONS::listHotKeys );
  helpMenu->Add( ACTIONS::getInvolved );
  helpMenu->Add( ACTIONS::donate );
  helpMenu->Add( ACTIONS::reportBug );
 
  helpMenu->AppendSeparator();
  helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, BITMAPS::about );
 
  // Trailing space keeps OSX from hijacking our menu (and disabling everything in it).
  aMenuBar->Append( helpMenu, _( "&Help" ) + wxS( " " ) );
 }

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

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

◆ 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 534 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 );
  }
  }
 
  // 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 _, DisplayErrorMessage(), DisplayStatus(), LIB_ID::empty(), LIB_ID::Format(), Format(), formatSymbolDesc(), NETLIST::GetComponent(), CVPCB_ASSOCIATION::GetComponentIndex(), GetComponentIndices(), COMPONENT::GetFPID(), COMPONENT::GetKIIDs(), CVPCB_ASSOCIATION::GetNewFootprint(), COMPONENT::GetReference(), COMPONENT::GetValue(), NETLIST::IsEmpty(), LIB_ID::IsValid(), m_modified, m_netlist, m_redoList, m_symbolsListBox, m_undoList, 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 168 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 );
 
  tmp = search.FindValidPath( fn.GetFullPath() );
 
  if( !tmp )
  {
  error_count++;
 
  if( aErrorMessages )
  {
  error_msg.Printf( _( "Equivalence file '%s' could not be found in the "
  "default search paths." ),
   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 903 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(), and ReadNetListAndFpFiles().

◆ BuildLibrariesListBox()

void CVPCB_MAINFRAME::BuildLibrariesListBox ( )

Definition at line 954 of file cvpcb_mainframe.cpp.

 {
  wxFont guiFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
 
  if( m_librariesListBox == nullptr )
  {
  m_librariesListBox = new LIBRARY_LISTBOX( this, ID_CVPCB_LIBRARY_LIST );
  m_librariesListBox->SetFont( KIUI::GetMonospacedUIFont() );
  }
 
  FP_LIB_TABLE* tbl = Prj().PcbFootprintLibs();
 
  if( tbl )
  {
  wxArrayString libNames;
 
  std::vector< wxString > libNickNames = tbl->GetLogicalLibs();
 
  for( const wxString& libNickName : libNickNames )
  libNames.Add( libNickName );
 
  m_librariesListBox->SetLibraryList( libNames );
  }
 }

References LIB_TABLE::GetLogicalLibs(), KIUI::GetMonospacedUIFont(), ID_CVPCB_LIBRARY_LIST, m_librariesListBox, PROJECT::PcbFootprintLibs(), KIWAY_HOLDER::Prj(), and LIBRARY_LISTBOX::SetLibraryList().

Referenced by CVPCB_MAINFRAME(), and ReadNetListAndFpFiles().

◆ BuildSymbolsListBox()

void CVPCB_MAINFRAME::BuildSymbolsListBox ( )

Definition at line 919 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 );
  }
 
  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 LIB_ID::Format(), formatSymbolDesc(), NETLIST::GetComponent(), SYMBOLS_LISTBOX::GetCount(), NETLIST::GetCount(), COMPONENT::GetFPID(), KIUI::GetMonospacedUIFont(), COMPONENT::GetReference(), COMPONENT::GetValue(), ID_CVPCB_COMPONENT_LIST, 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 )

overridevirtual

Reimplemented from EDA_BASE_FRAME.

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

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

References EDA_BASE_FRAME::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 1091 of file eda_base_frame.cpp.

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

References _, Format(), EDA_BASE_FRAME::GetAutoSaveFilePrefix(), 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 976 of file eda_base_frame.cpp.

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

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

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

◆ ClearUndoORRedoList()

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

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

546 { }

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 1154 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(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), 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().

◆ 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 PCB_EDIT_FRAME, PCB_BASE_FRAME, FOOTPRINT_EDIT_FRAME, EDA_DRAW_FRAME, FOOTPRINT_VIEWER_FRAME, KICAD_MANAGER_FRAME, and PL_EDITOR_FRAME.

Definition at line 492 of file eda_base_frame.cpp.

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

References TOOLS_HOLDER::CommonSettingsChanged(), COMMON_SETTINGS::SYSTEM::file_history_size, GetBitmapStore(), 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 EDA_3D_VIEWER_FRAME::CommonSettingsChanged(), KICAD_MANAGER_FRAME::CommonSettingsChanged(), EDA_DRAW_FRAME::CommonSettingsChanged(), and KIWAY::CommonSettingsChanged().

◆ config()

APP_SETTINGS_BASE * EDA_BASE_FRAME::config ( ) const

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

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

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

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), BM2CMP_FRAME::BM2CMP_FRAME(), CVPCB_MAINFRAME(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), SIM_PLOT_FRAME::doCloseWindow(), SCH_BASE_FRAME::eeconfig(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), GRID_MENU::GRID_MENU(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), EDA_DRAW_FRAME::IsGridVisible(), SCH_BASE_FRAME::libeditconfig(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), GERBVIEW_FRAME::Read_EXCELLON_File(), DIALOG_GRID_SETTINGS::RebuildGridSizes(), EDA_DRAW_FRAME::resolveCanvasType(), PCB_BASE_EDIT_FRAME::SetBoard(), EDA_DRAW_FRAME::SetGridVisibility(), PL_EDITOR_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), setupTools(), GERBVIEW_FRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), PANEL_GERBVIEW_EXCELLON_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), PANEL_GERBVIEW_EXCELLON_SETTINGS::TransferDataToWindow(), ZOOM_MENU::update(), GRID_MENU::update(), EDA_DRAW_FRAME::UpdateGridSelectBox(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), EDA_BASE_FRAME::windowClosing(), ZOOM_MENU::ZOOM_MENU(), 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 358 of file eda_base_frame.h.

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

References EDA_BASE_FRAME::m_configName.

Referenced by EDA_BASE_FRAME::SaveWindowSettings().

◆ CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )

inherited

Definition at line 841 of file eda_base_frame.cpp.

 {
 #if defined( __WXOSX_MAC__ )
  m_infoBar = new WX_INFOBAR( GetToolCanvas() );
 #else
  m_infoBar = new WX_INFOBAR( this, &m_auimgr );
 
  m_auimgr.AddPane( m_infoBar, EDA_PANE().InfoBar().Name( "InfoBar" ).Top().Layer(1) );
 #endif
 }

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

◆ 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 );
 
  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 SCH::IFACE::CreateWindow().

◆ CurrentToolName()

std::string TOOLS_HOLDER::CurrentToolName ( ) const

inherited

Definition at line 100 of file tools_holder.cpp.

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

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

Referenced by TOOL_MANAGER::processEvent(), and TOOLS_HOLDER::ShowChangedLanguage().

◆ Destroy()

bool KIWAY_PLAYER::Destroy ( )

overrideinherited

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

Definition at line 154 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 166 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 682 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(), FOOTPRINT_INFO::GetLibNickname(), LIB_ID::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(), ReadNetListAndFpFiles(), refreshAfterSymbolSearch(), and ShowChangedLanguage().

◆ DisplayToolMsg()

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

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 121 of file tools_holder.h.

121 {};

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

overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 404 of file cvpcb_mainframe.cpp.

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

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

◆ ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )

protectedinherited

Definition at line 657 of file eda_base_frame.cpp.

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

196 {}

Referenced by KIWAY_PLAYER::OnSockRequest().

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )

inherited

Definition at line 853 of file eda_base_frame.cpp.

 {
 #if defined( __WXOSX_MAC__ )
  m_auimgr.Update();
 #else
  // Call Update() to fix all pane default sizes, especially the "InfoBar" pane before
  // hiding it.
  m_auimgr.Update();
 
  // We don't want the infobar displayed right away
  m_auimgr.GetPane( "InfoBar" ).Hide();
  m_auimgr.Update();
 #endif
 }

References EDA_BASE_FRAME::m_auimgr.

◆ formatSymbolDesc()

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

private

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

514 { return m_aboutTitle; }

EDA_BASE_FRAME::m_aboutTitle

wxString m_aboutTitle

Definition: eda_base_frame.h:704

References EDA_BASE_FRAME::m_aboutTitle.

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

◆ 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(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::OnExportSTEP(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::saveSchematicFile(), and SCH_EDIT_FRAME::updateAutoSaveFile().

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const

inlineinherited

Definition at line 204 of file eda_base_frame.h.

204 { return m_autoSaveInterval; }

EDA_BASE_FRAME::m_autoSaveInterval

int m_autoSaveInterval

Definition: eda_base_frame.h:720

References EDA_BASE_FRAME::m_autoSaveInterval.

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

Definition at line 439 of file eda_base_frame.h.

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

Definition at line 101 of file tools_holder.h.

  {
  return m_dummySelection;
  }

References TOOLS_HOLDER::m_dummySelection.

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

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const

inlineinherited

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

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

Definition at line 129 of file tools_holder.h.

129 { return m_immediateActions; }

TOOLS_HOLDER::m_immediateActions

bool m_immediateActions

Definition: tools_holder.h:171

References TOOLS_HOLDER::m_immediateActions.

◆ GetDragAction()

MOUSE_DRAG_ACTION TOOLS_HOLDER::GetDragAction ( ) const

inlineinherited

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

Definition at line 135 of file tools_holder.h.

135 { return m_dragAction; }

TOOLS_HOLDER::m_dragAction

MOUSE_DRAG_ACTION m_dragAction

Definition: tools_holder.h:175

References TOOLS_HOLDER::m_dragAction.

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

◆ GetFileFromHistory()

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

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

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

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

  {
  return *m_fileHistory;
  }

References EDA_BASE_FRAME::m_fileHistory.

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

◆ 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 1082 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().

◆ GetFocusedControlObject()

wxControl * CVPCB_MAINFRAME::GetFocusedControlObject ( ) const

Get a pointer to the currently focused control.

Returns: the control that currently has focus

Definition at line 1095 of file cvpcb_mainframe.cpp.

 {
  if( m_librariesListBox->HasFocus() )
  return m_librariesListBox;
  else if( m_symbolsListBox->HasFocus() )
  return m_symbolsListBox;
  else if( m_footprintListBox->HasFocus() )
  return m_footprintListBox;
 
  return nullptr;
 }

References m_footprintListBox, m_librariesListBox, and m_symbolsListBox.

◆ GetFootprintViewerFrame()

DISPLAY_FOOTPRINTS_FRAME * CVPCB_MAINFRAME::GetFootprintViewerFrame ( ) const

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

Definition at line 1068 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(), refreshAfterSymbolSearch(), and CVPCB_CONTROL::ShowFootprintViewer().

◆ GetFrameType()

FRAME_T EDA_BASE_FRAME::GetFrameType ( ) const

inlineinherited

Definition at line 207 of file eda_base_frame.h.

207 { return m_ident; }

EDA_BASE_FRAME::m_ident

FRAME_T m_ident

Definition: eda_base_frame.h:694

References EDA_BASE_FRAME::m_ident.

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

EDA_BASE_FRAME::m_infoBar

WX_INFOBAR * m_infoBar

Definition: eda_base_frame.h:709

References EDA_BASE_FRAME::m_infoBar.

Referenced by FOOTPRINT_EDIT_FRAME::AddFootprintToBoard(), AUTOPLACE_TOOL::autoplace(), FOOTPRINT_EDIT_FRAME::CanCloseFPFromBoard(), SYMBOL_EDIT_FRAME::CanCloseSymbolFromSchematic(), DRAWING_TOOL::DrawVia(), PAD_TOOL::EditPad(), ZONE_FILLER_TOOL::FillAllZones(), ROUTER_TOOL::handleLayerSwitch(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), APPEARANCE_CONTROLS::onReadOnlySwatch(), EDA_DRAW_PANEL_GAL::onSize(), PCB_EDIT_FRAME::OpenProjectFiles(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), SYMBOL_EDIT_FRAME::SetCurSymbol(), EDA_BASE_FRAME::ShowInfoBarError(), EDA_BASE_FRAME::ShowInfoBarMsg(), EDA_BASE_FRAME::ShowInfoBarWarning(), SCH_DRAWING_TOOLS::SingleClickPlace(), and PCB_CONTROL::unfilledZoneCheck().

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const

inlineinherited

Definition at line 582 of file eda_base_frame.h.

582 { return m_undoRedoCountMax; }

EDA_BASE_FRAME::m_undoRedoCountMax

int m_undoRedoCountMax

Definition: eda_base_frame.h:723

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

141 { return m_moveWarpsCursor; }

TOOLS_HOLDER::m_moveWarpsCursor

bool m_moveWarpsCursor

Definition: tools_holder.h:177

References TOOLS_HOLDER::m_moveWarpsCursor.

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

◆ GetMruPath()

wxString EDA_BASE_FRAME::GetMruPath ( ) const

inlineinherited

Definition at line 430 of file eda_base_frame.h.

430 { return m_mruPath; }

EDA_BASE_FRAME::m_mruPath

wxString m_mruPath

Definition: eda_base_frame.h:728

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

◆ GetRedoCommandCount()

int CVPCB_MAINFRAME::GetRedoCommandCount ( ) const

inlineoverridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 200 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 980 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(), and OnSelectComponent().

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

140 { return m_settingsManager; }

EDA_BASE_FRAME::m_settingsManager

SETTINGS_MANAGER * m_settingsManager

Definition: eda_base_frame.h:714

References EDA_BASE_FRAME::m_settingsManager.

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

◆ GetSeverity()

virtual SEVERITY EDA_BASE_FRAME::GetSeverity ( int aErrorCode ) const

inlinevirtualinherited

Reimplemented in PCB_BASE_FRAME, and SCH_EDIT_FRAME.

Definition at line 142 of file eda_base_frame.h.

142 { return RPT_SEVERITY_UNDEFINED; }

RPT_SEVERITY_UNDEFINED

Definition: report_severity.h:27

References RPT_SEVERITY_UNDEFINED.

Referenced by RC_TREE_MODEL::GetValue().

◆ GetToolCanvas()

wxWindow * CVPCB_MAINFRAME::GetToolCanvas ( ) const

overridevirtual

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 1076 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; }

TOOLS_HOLDER::m_toolManager

TOOL_MANAGER * m_toolManager

Definition: tools_holder.h:158

References TOOLS_HOLDER::m_toolManager.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), BOARD_COMMIT::BOARD_COMMIT(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), TOOLS_HOLDER::CommonSettingsChanged(), DIALOG_FOOTPRINT_CHECKER::deleteAllMarkers(), DIALOG_ERC::deleteAllMarkers(), DIALOG_DRC::deleteAllMarkers(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_MIGRATE_BUSES::DIALOG_MIGRATE_BUSES(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), SIM_PLOT_FRAME::doCloseWindow(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), SCH_FIELD::DoHypertextMenu(), DRAWING_TOOL::DrawVia(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), GERBVIEW_FRAME::GERBVIEW_FRAME(), FP_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_NAVIGATE_TOOL::HypertextCommand(), DIALOG_PAD_PROPERTIES::initValues(), ROUTER_TOOL::InlineBreakTrack(), EDA_3D_VIEWER_FRAME::InstallPreferences(), KICAD_MANAGER_FRAME::InstallPreferences(), PL_EDITOR_FRAME::InstallPreferences(), FOOTPRINT_EDIT_FRAME::InstallPreferences(), SYMBOL_EDIT_FRAME::InstallPreferences(), GERBVIEW_FRAME::InstallPreferences(), PCB_EDIT_FRAME::InstallPreferences(), SCH_EDIT_FRAME::InstallPreferences(), PCB_EDIT_FRAME::LoadProjectSettings(), FOOTPRINT_EDIT_FRAME::LoadSettings(), SYMBOL_EDIT_FRAME::LoadSymbol(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_DRC::OnActivateDlg(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_DRC::OnCancelClick(), DIALOG_INSPECTOR::onCellClicked(), DIALOG_ERC::OnCloseErcDialog(), DIALOG_FOOTPRINT_CHECKER::OnDeleteOneClick(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_ABOUT::onDonateClick(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_ERC::OnERCItemSelected(), DIALOG_CONSTRAINTS_REPORTER::OnErrorLinkClicked(), KICAD_MANAGER_FRAME::OnIdle(), FOOTPRINTS_LISTBOX::OnLeftDClick(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetContextMenu(), PANEL_PCBNEW_ACTION_PLUGINS::OnOpenDirectoryButtonClick(), SIM_PLOT_FRAME::onProbe(), PANEL_PCBNEW_ACTION_PLUGINS::OnReloadButtonClick(), DIALOG_ABOUT::onReportBug(), DIALOG_PLOT::onRunDRC(), DIALOG_DRC::OnRunDRCClick(), HIERARCHY_NAVIG_DLG::onSelectSheetPath(), SCH_EDIT_FRAME::onSize(), SYMBOL_TREE_PANE::onSymbolSelected(), DIALOG_SYMBOL_FIELDS_TABLE::OnTableCellClick(), SIM_PLOT_FRAME::onTune(), PANEL_KICAD_LAUNCHER::PANEL_KICAD_LAUNCHER(), PANEL_SELECTION_FILTER::PANEL_SELECTION_FILTER(), DIALOG_UPDATE_PCB::PerformUpdate(), DIALOG_PLOT::Plot(), TOOLS_HOLDER::PopTool(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), Refresh(), PL_EDITOR_FRAME::RollbackFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), PCB_EDIT_FRAME::SaveProjectSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), EDA_3D_VIEWER_FRAME::SaveSettings(), DIALOG_FIND::search(), setupEventHandlers(), APPEARANCE_CONTROLS::showNetclass(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), PANEL_3D_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), PANEL_3D_DISPLAY_OPTIONS::TransferDataToWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), EDA_DRAW_FRAME::UpdateMsgPanel(), NET_GRID_TABLE::updateNetVisibility(), DIALOG_NETLIST::~DIALOG_NETLIST(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().

◆ 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:76

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 195 of file cvpcb_mainframe.h.

  {
  return m_undoList.size();
  }

References m_undoList.

◆ GetUserUnits()

EDA_UNITS EDA_BASE_FRAME::GetUserUnits ( ) const

inlineinherited

Return the user units currently in use.

Definition at line 126 of file eda_base_frame.h.

  {
  return m_userUnits;
  }

References EDA_BASE_FRAME::m_userUnits.

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

Definition at line 810 of file eda_base_frame.cpp.

 {
  return &aCfg->m_Window;
 }

References APP_SETTINGS_BASE::m_Window.

Referenced by 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 1237 of file eda_base_frame.cpp.

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

References KICAD_MAIN_FRAME_T, and EDA_BASE_FRAME::m_ident.

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

◆ HandleSystemColorChange()

void EDA_BASE_FRAME::HandleSystemColorChange ( )

virtualinherited

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

Definition at line 1261 of file eda_base_frame.cpp.

 {
  // Update the icon theme when the system theme changes and update the toolbars
  GetBitmapStore()->ThemeChanged();
  ThemeChanged();
 
  // This isn't handled by ThemeChanged()
  if( GetMenuBar() )
  {
  // For icons in menus, icon scaling & hotkeys
  ReCreateMenuBar();
  GetMenuBar()->Refresh();
  }
 }

References GetBitmapStore(), 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 376 of file eda_base_frame.cpp.

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

References ACTION_CONDITIONS::checkCondition, ACTIONS::copy, ACTIONS::cut, ACTION_CONDITIONS::enableCondition, TOOLS_HOLDER::GetCurrentSelection(), TOOL_ACTION::GetUIId(), ACTIONS::paste, and ACTION_CONDITIONS::showCondition.

Referenced by EDA_BASE_FRAME::RegisterUIUpdateHandler().

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )

virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 829 of file eda_base_frame.cpp.

 {
  return Kiface().GetHelpFileName();
 }

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

Referenced by COMMON_CONTROL::ShowHelp().

◆ ImportHotkeyConfigFromFile()

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

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

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

◆ InstallPreferences()

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

inlinevirtualinherited

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

Parameters

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

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

Definition at line 298 of file eda_base_frame.h.

298 { }

Referenced by EDA_BASE_FRAME::OnPreferences().

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

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 617 of file eda_base_frame.h.

617 { return false; }

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 109 of file tools_holder.cpp.

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

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

Referenced by SCH_EDIT_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), and EDITOR_CONDITIONS::toolFunc().

◆ 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 160 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 173 of file kiway_player.h.

173 { return m_modal; }

KIWAY_PLAYER::m_modal

bool m_modal

Definition: kiway_player.h:210

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(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), KIWAY_PLAYER::ShowModal(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T aType ) const

inlineinherited

Definition at line 206 of file eda_base_frame.h.

206 { return m_ident == aType; }

EDA_BASE_FRAME::m_ident

FRAME_T m_ident

Definition: eda_base_frame.h:694

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

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

References _.

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

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const

inlineinherited

Return a reference to the KIWAY that this object has an opportunity to participate in.

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 53 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_kiway.

◆ kiway_express()

void KIWAY_PLAYER::kiway_express ( KIWAY_EXPRESS & aEvent )

protectedinherited

event handler, routes to derivative specific virtual KiwayMailIn()

Definition at line 181 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 1148 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;
 
  default:
  ; // ignore most
  }
 }

References KIWAY_EXPRESS::Command(), KIWAY_EXPRESS::GetPayload(), m_cannotClose, MAIL_EESCHEMA_NETLIST, and ReadNetListAndFpFiles().

◆ language_change()

void KIWAY_PLAYER::language_change ( wxCommandEvent & event )

protectedinherited

An event handler called on a language menu selection.

Definition at line 188 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 807 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 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 451 of file cvpcb_mainframe.cpp.

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

References EDA_BASE_FRAME::LoadSettings(), CVPCB_SETTINGS::m_FilterFootprint, 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 709 of file eda_base_frame.cpp.

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

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

Referenced by EDA_BASE_FRAME::LoadSettings().

◆ LoadWindowState() [1/2]

void EDA_BASE_FRAME::LoadWindowState ( const wxString & aFileName )

inherited

Definition at line 549 of file eda_base_frame.cpp.

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

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

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

◆ LoadWindowState() [2/2]

void EDA_BASE_FRAME::LoadWindowState ( const WINDOW_STATE & aState )

virtualinherited

Load frame state info from a configuration file.

Definition at line 563 of file eda_base_frame.cpp.

 {
  bool wasDefault = false;
 
  m_framePos.x = aState.pos_x;
  m_framePos.y = aState.pos_y;
  m_frameSize.x = aState.size_x;
  m_frameSize.y = aState.size_y;
 
  wxLogTrace( traceDisplayLocation, "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, "Using minimum size (%d, %d)",
  m_frameSize.x, m_frameSize.y );
  }
 
  wxLogTrace( traceDisplayLocation, "Number of displays: %d", wxDisplay::GetCount() );
 
  if( aState.display >= wxDisplay::GetCount() )
  {
  wxLogTrace( traceDisplayLocation, "Previous display not found" );
 
  // If it isn't attached, use the first display
  // Warning wxDisplay has 2 ctor variants. the parameter needs a type:
  const unsigned int index = 0;
  wxDisplay display( index );
  wxRect clientSize = display.GetGeometry();
 
  m_framePos = wxDefaultPosition;
 
  // Ensure the window fits on the display, since the other one could have been larger
  if( m_frameSize.x > clientSize.width )
  m_frameSize.x = clientSize.width;
 
  if( m_frameSize.y > clientSize.height )
  m_frameSize.y = clientSize.height;
  }
  else
  {
  wxPoint upperRight( m_framePos.x + m_frameSize.x, m_framePos.y );
  wxPoint upperLeft( m_framePos.x, m_framePos.y );
 
  wxDisplay display( aState.display );
  wxRect clientSize = display.GetClientArea();
 
  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, "Resetting to default position" );
  }
  }
 
  wxLogTrace( traceDisplayLocation, "Final window position (%d, %d) with size (%d, %d)",
  m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
 
  SetSize( m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
 
  // Center the window if we reset to default
  if( m_framePos.x == -1 )
  {
  wxLogTrace( traceDisplayLocation, "Centering window" );
  Center();
  m_framePos = GetPosition();
  }
 
  // Record the frame sizes in an un-maximized state
  m_normalFrameSize = m_frameSize;
  m_normalFramePos = m_framePos;
 
  // Maximize if we were maximized before
  if( aState.maximized || ( wasDefault && m_maximizeByDefault ) )
  {
  wxLogTrace( traceDisplayLocation, "Maximizing window" );
  Maximize();
  }
 
  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.

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

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

References EDA_BASE_FRAME::doAutoSave(), EDA_BASE_FRAME::m_autoSaveInterval, 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 FOOTPRINT_VIEWER_FRAME.

Definition at line 333 of file eda_base_frame.cpp.

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

References dump(), and kicadTraceKeyEvent.

◆ OnEnterFilteringText()

void CVPCB_MAINFRAME::OnEnterFilteringText ( wxCommandEvent & event )

Called each time the text of m_tcFilterString is changed.

Definition at line 416 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
 
  long pos = m_tcFilterString->GetInsertionPoint();
  wxListEvent l_event;
  OnSelectComponent( l_event );
  m_tcFilterString->SetFocus();
  m_tcFilterString->SetInsertionPoint( pos );
 }

References m_tcFilterString, and OnSelectComponent().

Referenced by ReCreateHToolbar(), and setupEventHandlers().

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent & event )

inherited

Definition at line 994 of file eda_base_frame.cpp.

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

References ShowAboutDialog().

◆ OnMaximize()

void EDA_BASE_FRAME::OnMaximize ( wxMaximizeEvent & aEvent )

inherited

Definition at line 1213 of file eda_base_frame.cpp.

 {
  // When we maximize the window, we want to save the old information
  // so that we can add it to the settings on next window load.
  // Contrary to the documentation, this event seems to be generated
  // when the window is also being unmaximized on OSX, so we only
  // capture the size information when we maximize the window when on OSX.
 #ifdef __WXOSX__
  if( !IsMaximized() )
 #endif
  {
  m_normalFrameSize = GetWindowSize();
  m_normalFramePos = GetPosition();
  wxLogTrace( traceDisplayLocation,
  "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 343 of file eda_base_frame.cpp.

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

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

◆ OnMove()

virtual void EDA_BASE_FRAME::OnMove ( wxMoveEvent & aEvent )

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 193 of file eda_base_frame.h.

  {
  aEvent.Skip();
  }

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent & event )

inherited

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

Definition at line 1001 of file eda_base_frame.cpp.

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

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

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

◆ 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 430 of file cvpcb_mainframe.cpp.

 {
  if( m_skipComponentSelect )
  return;
 
  wxString libraryName;
  COMPONENT* symbol = GetSelectedComponent();
  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
  m_footprintListBox->SetSelection( m_footprintListBox->GetSelection(), false );
 
  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(), FOOTPRINTS_LISTBOX::SetFootprints(), FOOTPRINTS_LISTBOX::SetSelectedFootprint(), and FOOTPRINTS_LISTBOX::SetSelection().

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

◆ OnSize()

void EDA_BASE_FRAME::OnSize ( wxSizeEvent & aEvent )

virtualinherited

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

Definition at line 531 of file eda_base_frame.cpp.

 {
 #ifdef __WXMAC__
  int currentDisplay = wxDisplay::GetFromWindow( this );
 
  if( m_displayIndex >= 0 && currentDisplay >= 0 && currentDisplay != m_displayIndex )
  {
  wxLogTrace( traceDisplayLocation, "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 63 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 93 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 1277 of file eda_base_frame.cpp.

 {
  // Call the handler to update the colors used in the frame
  HandleSystemColorChange();
 
  // Skip the change event to ensure the rest of the window controls get it
  aEvent.Skip();
 }

References EDA_BASE_FRAME::HandleSystemColorChange().

◆ 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 611 of file cvpcb_mainframe.cpp.

 {
  return true;
 }

◆ ParseArgs()

virtual void KIWAY_PLAYER::ParseArgs ( wxCmdLineParser & aParser )

inlinevirtualinherited

Handle command-line arguments in a frame-specific way.

The given argument parser has already been initialized with the command line and any options/switches that are handled by the top-level launcher before passing control to the child frame.

Parameters

aParser is the argument parser created by the top-level launcher.

Definition at line 139 of file kiway_player.h.

  {
  WXUNUSED( aParser );
  }

Referenced by PGM_SINGLE_TOP::OnPgmInit().

◆ 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 1197 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(), and SCH_EDITOR_CONTROL::Redo().

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

 {
  return m_undoList.PopCommand();
 }

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

Referenced by SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_FRAME::RollbackSchematicFromUndo(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), PCB_EDIT_FRAME::RunActionPlugin(), SCH_EDIT_FRAME::SaveCopyInUndoList(), and SCH_EDITOR_CONTROL::Undo().

◆ PopTool()

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

virtualinherited

Definition at line 61 of file tools_holder.cpp.

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

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

Referenced by EDIT_TOOL::copyToClipboard(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), DRAWING_TOOL::InteractivePlaceWithPreview(), ZOOM_TOOL::Main(), PCB_PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), BOARD_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ PrintMsg()

void EDA_BASE_FRAME::PrintMsg ( const wxString & text )

inherited

Definition at line 835 of file eda_base_frame.cpp.

 {
  SetStatusText( text );
 }

References text.

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

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const

inherited

Return a reference to the PROJECT associated with this KIWAY.

Definition at line 36 of file kiway_holder.cpp.

 {
  return Kiway().Prj();
 }

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

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

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

References EDA_BASE_FRAME::findQuasiModalDialog(), EDA_BASE_FRAME::isAutoSaveRequired(), EDA_BASE_FRAME::m_autoSaveInterval, EDA_BASE_FRAME::m_autoSaveState, EDA_BASE_FRAME::m_autoSaveTimer, EDA_BASE_FRAME::m_hasAutoSave, EDA_BASE_FRAME::m_isClosing, Pgm(), and traceAutoSave.

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

◆ ProjectChanged()

virtual void EDA_BASE_FRAME::ProjectChanged ( )

inlinevirtualinherited

Notification event that the project has changed.

Reimplemented in PCB_EDIT_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 512 of file eda_base_frame.h.

512 {}

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

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

References 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(), 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 1161 of file eda_base_frame.cpp.

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

References 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_EDIT_FRAME::RunActionPlugin(), PL_EDITOR_FRAME::SaveCopyInUndoList(), SYMBOL_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::StartNewUndo(), and SCH_EDITOR_CONTROL::Undo().

◆ PushTool()

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

virtualinherited

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

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

Definition at line 44 of file tools_holder.cpp.

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

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

Referenced by EDIT_TOOL::copyToClipboard(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), DRAWING_TOOL::InteractivePlaceWithPreview(), ZOOM_TOOL::Main(), PCB_PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), BOARD_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ ReadNetListAndFpFiles()

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

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 );
  }
 
  if( !m_netlist.IsEmpty() )
  m_symbolsListBox->SetSelection( 0, true );
 
  DisplayStatus();
 
  return true;
 }

References _, DIALOG_FP_CONFLICT_ASSIGNMENT_SELECTOR::Add(), NETLIST::AnyFootprintsLinked(), SYMBOLS_LISTBOX::AppendLine(), 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(), 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_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 )

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 869 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 36 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::saveAssociations );
 
  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, ID_CVPCB_FILTER_TEXT_EDIT, wxEmptyString,
  wxDefaultPosition, wxDefaultSize, wxTE_PROCESS_ENTER );
 
  m_tcFilterString->Bind( wxEVT_TEXT_ENTER, &CVPCB_MAINFRAME::OnEnterFilteringText, 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_CVPCB_FILTER_TEXT_EDIT, ID_H_TOOLBAR, EDA_BASE_FRAME::KICAD_AUI_TB_STYLE, EDA_BASE_FRAME::m_auimgr, m_mainToolBar, m_tcFilterString, OnEnterFilteringText(), ACTIONS::redo, CVPCB_ACTIONS::saveAssociations, ACTION_TOOLBAR::SetAuiManager(), ACTIONS::showFootprintLibTable, CVPCB_ACTIONS::showFootprintViewer, text, ACTION_TOOLBAR::TOGGLE, and ACTIONS::undo.

Referenced by CVPCB_MAINFRAME(), and ShowChangedLanguage().

◆ ReCreateMenuBar()

void CVPCB_MAINFRAME::ReCreateMenuBar ( )

overridevirtual

Recreates the menu bar.

Needed when the language or icons are changed

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::saveAssociations );
  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..." ) + "\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::saveAssociations, CVPCB_ACTIONS::showEquFileTable, ACTIONS::showFootprintLibTable, and ACTIONS::undo.

Referenced by CVPCB_MAINFRAME().

◆ RedoAssociation()

void CVPCB_MAINFRAME::RedoAssociation ( )

Redo the most recently undone association.

Definition at line 494 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 617 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 = 

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

◆ AssociateFootprint()

◆ AutomaticFootprintMatching()

◆ buildEquivalenceList()

◆ BuildFootprintsListBox()

◆ BuildLibrariesListBox()

◆ BuildSymbolsListBox()

◆ canCloseWindow()

◆ ChangeUserUnits()

◆ CheckForAutoSaveFile()

◆ ClearFileHistory()

◆ ClearUndoORRedoList()

◆ ClearUndoRedoList()

◆ CommonSettingsChanged()

◆ config()

◆ ConfigBaseName()

◆ CreateInfoBar()

◆ CreateServer()

◆ CurrentToolName()

◆ Destroy()

◆ DismissModal()

◆ DisplayStatus()

◆ DisplayToolMsg()

◆ doAutoSave()

◆ doCloseWindow()

◆ ensureWindowIsOnScreen()

◆ ExecuteRemoteCommand()

◆ FinishAUIInitialization()

◆ formatSymbolDesc()

◆ GetAboutTitle()

◆ GetAutoSaveFilePrefix()

◆ GetAutoSaveInterval()

◆ GetComponentIndices()

◆ GetCurrentFileName()

◆ GetCurrentSelection()

◆ GetDoImmediateActions()

◆ GetDragAction()

◆ GetFileFromHistory()

◆ GetFileHistory()

◆ GetFocusedControl()

◆ GetFocusedControlObject()

◆ GetFootprintViewerFrame()

◆ GetFrameType()

◆ GetInfoBar()

◆ GetMaxUndoItems()

◆ GetMoveWarpsCursor()

◆ GetMruPath()

◆ GetRedoCommandCount()

◆ GetSelectedComponent()

◆ GetSelectedFootprint()

◆ GetSettingsManager()

◆ GetSeverity()

◆ GetToolCanvas()

◆ GetToolManager()

◆ GetType()

◆ GetUndoCommandCount()