KiCad PCB EDA Suite
CVPCB_MAINFRAME Class Reference

The CvPcb application main window. More...

#include <cvpcb_mainframe.h>

Inheritance diagram for CVPCB_MAINFRAME:
KIWAY_PLAYER EDA_BASE_FRAME TOOLS_HOLDER KIWAY_HOLDER

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 }
 Function ClearUndoORRedoList (virtual). More...
 
enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

 ~CVPCB_MAINFRAME ()
 
bool OpenProjectFiles (const std::vector< wxString > &aFileSet, int aCtl=0) override
 Function OpenProjectFiles is abstract, and opens a project or set of files given by aFileList. More...
 
void KiwayMailIn (KIWAY_EXPRESS &aEvent) override
 Function KiwayMailIn receives KIWAY_EXPRESS messages from other players. More...
 
bool IsContentModified () override
 Get if the current associations have been modified but not saved. More...
 
DISPLAY_FOOTPRINTS_FRAMEGetFootprintViewerFrame () const
 
wxWindow * GetToolCanvas () const override
 Canvas access. More...
 
CVPCB_MAINFRAME::CONTROL_TYPE GetFocusedControl ()
 Find out which control currently has focus. More...
 
wxControl * GetFocusedControlObject ()
 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)
 Function OnSelectComponent 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
 Redraw the menus and what not in current language. More...
 
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)
 Function SetFootprintFilter Set a filter criteria to either on/off or toggle the criteria. More...
 
void OnEnterFilteringText (wxCommandEvent &event)
 Function OnEnterFilteringText Is 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 BuildCmpListBox ()
 
void BuildFOOTPRINTS_LISTBOX ()
 
void BuildLIBRARY_LISTBOX ()
 
bool SaveFootprintAssociation (bool doSaveSchematic)
 Function SaveFootprintAssociation saves the edits that the user has done by sending them back to eeschema via the kiway. More...
 
bool ReadNetListAndFpFiles (const std::string &aNetlist)
 Function ReadNetListAndFpFiles loads the netlist file built on the fly by Eeschema and loads footprint libraries from fp lib tables. More...
 
int ReadSchematicNetlist (const std::string &aNetlist)
 Function ReadSchematicNetlist 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
 Saves common frame parameters to a configuration data file. More...
 
void DisplayStatus ()
 Function DisplayStatus updates the information displayed on the status bar at bottom of the main frame. More...
 
bool LoadFootprintFiles ()
 Function LoadFootprintFiles reads the list of footprint (*.mod files) and generate the list of footprints. More...
 
void SendMessageToEESCHEMA (bool aClearHighligntOnly=false)
 Function SendMessageToEESCHEMA Send a remote command to Eeschema via a socket, Commands are $PART: "reference" put cursor on component anchor. More...
 
COMPONENTGetSelectedComponent ()
 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)
 Handles command-line arguments in a frame-specific way. More...
 
virtual bool ShowModal (wxString *aResult=NULL, wxWindow *aResultantFocusWindow=NULL)
 Function ShowModal puts up 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 In modal mode, the caller that created the frame is responsible to Destroy() this frame after closing. More...
 
void SetModal (bool aIsModal)
 
bool IsDismissed ()
 Function IsDismissed returns false only if both the frame is acting in modal mode and it has not been dismissed yet with DismissModal(). More...
 
void DismissModal (bool aRetVal, const wxString &aResult=wxEmptyString)
 
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_MANAGERGetSettingsManager () const
 
virtual int GetSeverity (int aErrorCode) const
 
bool ProcessEvent (wxEvent &aEvent) override
 Override the default process event handler to implement the auto save feature. More...
 
virtual void OnCharHook (wxKeyEvent &event)
 Capture the key event before it is sent to the GUI. More...
 
void OnMenuEvent (wxMenuEvent &event)
 The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves. More...
 
virtual void RegisterUIUpdateHandler (int aID, const ACTION_CONDITIONS &aConditions) override
 Register a UI update handler for the control with ID aID. More...
 
virtual void 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)
 
void OnMaximize (wxMaximizeEvent &aEvent)
 
void SetAutoSaveInterval (int aInterval)
 
int GetAutoSaveInterval () const
 
bool IsType (FRAME_T aType) const
 
virtual const SEARCH_STACKsys_search ()
 Return a SEARCH_STACK pertaining to entire program. More...
 
virtual wxString help_name ()
 
void OnKicadAbout (wxCommandEvent &event)
 
void OnPreferences (wxCommandEvent &event)
 
void PrintMsg (const wxString &text)
 
WX_INFOBARGetInfoBar ()
 
void ShowInfoBarError (const wxString &aErrorMsg)
 
void ShowInfoBarWarning (const wxString &aWarningMsg)
 
void ShowInfoBarMsg (const wxString &aMsg)
 
virtual APP_SETTINGS_BASEconfig () const
 Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME. More...
 
virtual void InstallPreferences (PAGED_DIALOG *, PANEL_HOTKEYS_EDITOR *)
 Function InstallPreferences Allow a frame to load its preference panels (if any) into the preferences dialog. More...
 
void LoadWindowState (const wxString &aFileName)
 
virtual void LoadWindowState (const WINDOW_STATE &aState)
 Load frame state info from a configuration file. More...
 
void LoadWindowSettings (const WINDOW_SETTINGS *aCfg)
 Loads window settings from the given settings object Normally called by LoadSettings unless the window in question is a child window that stores its settings somewhere other than APP_SETTINGS_BASE::m_Window. More...
 
void SaveWindowSettings (WINDOW_SETTINGS *aCfg)
 Saves window settings to the given settings object Normally called by SaveSettings unless the window in question is a child window that stores its settings somewhere other than APP_SETTINGS_BASE::m_Window. More...
 
virtual WINDOW_SETTINGSGetWindowSettings (APP_SETTINGS_BASE *aCfg)
 Returns a pointer to the window settings for this frame. More...
 
wxString ConfigBaseName () override
 
virtual void SaveProjectSettings ()
 Save changes to the project settings to the project (.pro) file. More...
 
void ImportHotkeyConfigFromFile (std::map< std::string, TOOL_ACTION * > aActionMap, const wxString &aDefaultShortname)
 Prompt the user for a hotkey file to read, and read it. More...
 
wxString GetFileFromHistory (int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr)
 Fetches the file name from the file history list. More...
 
void ClearFileHistory (FILE_HISTORY *aFileHistory=nullptr)
 Removes all files from the file history. More...
 
void UpdateFileHistory (const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
 Update the list of recently opened files. More...
 
FILE_HISTORYGetFileHistory ()
 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)
 Checks if aFileName can be written. More...
 
void CheckForAutoSaveFile (const wxFileName &aFileName)
 Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input. More...
 
virtual void UpdateStatusBar ()
 Update the status bar information. More...
 
void CommonSettingsChanged (bool aEnvVarsChanged, bool aTextVarsChanged) override
 Notification event that some of the common (suite-wide) settings have changed. More...
 
virtual void ProjectChanged ()
 Notification event that the project has changed. More...
 
const wxString & GetAboutTitle () const
 
wxSize GetWindowSize ()
 Get the undecorated window size that can be used for restoring the window size. More...
 
virtual void ClearUndoORRedoList (UNDO_REDO_LIST aList, int aItemCount=-1)
 
virtual void ClearUndoRedoList ()
 Function ClearUndoRedoList clear undo and redo list, using ClearUndoORRedoList() picked items are deleted by ClearUndoORRedoList() according to their status. More...
 
virtual void PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
 Function PushCommandToUndoList add a command to undo in undo list delete the very old commands when the max count of undo commands is reached ( using ClearUndoORRedoList) More...
 
virtual void PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
 Function PushCommandToRedoList add a command to redo in redo list delete the very old commands when the max count of redo commands is reached ( using ClearUndoORRedoList) More...
 
virtual PICKED_ITEMS_LISTPopCommandFromUndoList ()
 PopCommandFromUndoList return the last command to undo and remove it from list nothing is deleted. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromRedoList ()
 PopCommandFromRedoList return the last command to undo and remove it from list nothing is deleted. More...
 
int GetMaxUndoItems () const
 
bool NonUserClose (bool aForce)
 
TOOL_MANAGERGetToolManager () const
 Return the MVC controller. More...
 
virtual SELECTIONGetCurrentSelection ()
 Get the current selection from the canvas area. More...
 
virtual void PushTool (const std::string &actionName)
 NB: the definition of "tool" is different at the user level. More...
 
virtual void PopTool (const std::string &actionName)
 
bool ToolStackIsEmpty ()
 
std::string CurrentToolName () const
 
bool IsCurrentTool (const TOOL_ACTION &aAction) const
 
virtual void DisplayToolMsg (const wxString &msg)
 
bool GetDoImmediateActions () const
 Indicates that hotkeys should perform an immediate action even if another tool is currently active. More...
 
bool GetDragSelects () const
 Indicates that a drag should draw a selection rectangle, even when started over an item. More...
 
bool GetMoveWarpsCursor () const
 Indicates that a move operation should warp the mouse pointer to the origin of the move object. More...
 
virtual void RefreshCanvas ()
 
HOLDER_TYPE GetType ()
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Static Public Member Functions

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

Public Attributes

FOOTPRINT_LISTm_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)
 Function language_change is 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...
 
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...
 

Static Protected Member Functions

static wxString GetBackupSuffix ()
 
static wxString GetAutoSaveFilePrefix ()
 

Protected Attributes

bool m_modified
 
bool m_skipComponentSelect
 
bool m_initialized
 
bool m_modal
 
WX_EVENT_LOOPm_modal_loop
 
wxWindow * m_modal_resultant_parent
 
wxString m_modal_string
 
bool m_modal_ret_val
 
FRAME_T m_Ident
 
wxPoint m_FramePos
 
wxSize m_FrameSize
 
bool m_maximizeByDefault
 
wxPoint m_NormalFramePos
 
wxSize m_NormalFrameSize
 
wxString m_AboutTitle
 
wxAuiManager m_auimgr
 
wxString m_perspective
 
WX_INFOBARm_infoBar
 
wxString m_configName
 
SETTINGS_MANAGERm_settingsManager
 
FILE_HISTORYm_fileHistory
 
bool m_hasAutoSave
 
bool m_autoSaveState
 
int m_autoSaveInterval
 
wxTimer * m_autoSaveTimer
 
int m_UndoRedoCountMax
 
wxString m_mruPath
 
EDA_UNITS m_userUnits
 
std::map< int, UIUpdateHandlerm_uiUpdateMap
 
bool m_isClosing
 
bool m_isNonUserClose
 
TOOL_MANAGERm_toolManager
 
ACTIONSm_actions
 
SELECTION m_dummySelection
 
std::vector< std::string > m_toolStack
 
bool m_immediateActions
 
bool m_dragSelects
 
bool m_moveWarpsCursor
 

Static Protected Attributes

static constexpr int KICAD_AUI_TB_STYLE = wxAUI_TB_DEFAULT_STYLE | wxAUI_TB_PLAIN_BACKGROUND
 

Default style flags used for wxAUI toolbars

More...
 

Private Member Functions

void 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=NULL)
 read the .equ files and populate the list of equvalents More...
 
void refreshAfterComponentSearch (COMPONENT *component)
 

Private Attributes

NETLIST m_netlist
 
int m_filteringOptions
 
ACTION_TOOLBARm_mainToolBar
 
FOOTPRINTS_LISTBOXm_footprintListBox
 
LIBRARY_LISTBOXm_libListBox
 
COMPONENTS_LISTBOXm_compListBox
 
wxTextCtrl * m_tcFilterString
 
wxStaticText * m_statusLine1
 
wxStaticText * m_statusLine2
 
wxStaticText * m_statusLine3
 
wxButton * m_saveAndContinue
 
TOOL_DISPATCHERm_toolDispatcher
 
ACTION_MENUm_footprintContextMenu
 
ACTION_MENUm_componentContextMenu
 
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 60 of file cvpcb_mainframe.h.

Member Enumeration Documentation

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

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

349  {
352  NA_COMPONENTS,
354  };
Not associated components.

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

102  {
104  FILTER_ENABLE,
106  };
Toggle the filter state.

◆ FOCUS_DIR

Directions to rotate the focus through the listboxes is.

Enumerator
CHANGE_FOCUS_RIGHT 
CHANGE_FOCUS_LEFT 

Definition at line 122 of file cvpcb_mainframe.h.

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 42 of file kiway_holder.h.

◆ ITEM_DIR

Directions to move when selecting items.

Enumerator
ITEM_NEXT 

The next item.

ITEM_PREV 

The previous item.

Definition at line 131 of file cvpcb_mainframe.h.

132  {
133  ITEM_NEXT,
134  ITEM_PREV
135  };

◆ UNDO_REDO_LIST

Function ClearUndoORRedoList (virtual).

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

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

Definition at line 588 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ CVPCB_MAINFRAME()

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

Definition at line 59 of file cvpcb_mainframe.cpp.

59  :
60  KIWAY_PLAYER( aKiway, aParent, FRAME_CVPCB, _( "Assign Footprints" ), wxDefaultPosition,
62 {
67  m_modified = false;
68  m_skipComponentSelect = false;
72  m_initialized = false;
73  m_AboutTitle = "CvPcb";
74 
75  // Give an icon
76  wxIcon icon;
77  icon.CopyFromBitmap( KiBitmap( icon_cvpcb_xpm ) );
78  SetIcon( icon );
79 
80  SetAutoLayout( true );
81 
82  LoadSettings( config() );
83 
84  setupTools();
88 
89  // Create list of available footprints and components of the schematic
93 
94  m_auimgr.SetManagedWindow( this );
95 
96  m_auimgr.AddPane( m_mainToolBar, EDA_PANE().HToolbar().Name( "MainToolbar" ).Top().Layer(6) );
97 
98  m_auimgr.AddPane( m_libListBox, EDA_PANE().Palette().Name( "Libraries" ).Left().Layer(1)
99  .Caption( _( "Footprint Libraries" ) )
100  .BestSize( (int) ( m_FrameSize.x * 0.20 ), m_FrameSize.y ) );
101 
102  m_auimgr.AddPane( m_compListBox, EDA_PANE().Palette().Name( "Components" ).Center().Layer(0)
103  .Caption( _( "Symbol : Footprint Assignments" ) ) );
104 
105  m_auimgr.AddPane( m_footprintListBox, EDA_PANE().Palette().Name( "Footprints" ).Right().Layer(1)
106  .Caption( _( "Filtered Footprints" ) )
107  .BestSize( (int) ( m_FrameSize.x * 0.30 ), m_FrameSize.y ) );
108 
109  // Build the bottom panel, to display 2 status texts and the buttons:
110  auto bottomPanel = new wxPanel( this );
111  auto panelSizer = new wxBoxSizer( wxVERTICAL );
112 
113  wxFlexGridSizer* fgSizerStatus = new wxFlexGridSizer( 3, 1, 0, 0 );
114  fgSizerStatus->SetFlexibleDirection( wxBOTH );
115  fgSizerStatus->SetNonFlexibleGrowMode( wxFLEX_GROWMODE_SPECIFIED );
116 
117  m_statusLine1 = new wxStaticText( bottomPanel, wxID_ANY, wxEmptyString );
118  fgSizerStatus->Add( m_statusLine1, 0, 0, 5 );
119 
120  m_statusLine2 = new wxStaticText( bottomPanel, wxID_ANY, wxEmptyString );
121  fgSizerStatus->Add( m_statusLine2, 0, 0, 5 );
122 
123  m_statusLine3 = new wxStaticText( bottomPanel, wxID_ANY, wxEmptyString );
124  fgSizerStatus->Add( m_statusLine3, 0, wxBOTTOM, 3 );
125 
126  panelSizer->Add( fgSizerStatus, 1, wxEXPAND|wxLEFT, 2 );
127 
128  wxStaticLine* staticline1 = new wxStaticLine( bottomPanel );
129  panelSizer->Add( staticline1, 0, wxEXPAND, 5 );
130 
131  wxFont statusFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
132  statusFont.SetSymbolicSize( wxFONTSIZE_SMALL );
133  m_statusLine1->SetFont( statusFont );
134  m_statusLine2->SetFont( statusFont );
135  m_statusLine3->SetFont( statusFont );
136 
137  // Add buttons:
138  auto buttonsSizer = new wxBoxSizer( wxHORIZONTAL );
139  auto sdbSizer = new wxStdDialogButtonSizer();
140 
141  m_saveAndContinue = new wxButton( bottomPanel, ID_SAVE_PROJECT,
142  _( "Apply, Save Schematic && Continue" ) );
143  buttonsSizer->Add( m_saveAndContinue, 0, wxALIGN_CENTER_VERTICAL|wxRIGHT, 20 );
144 
145  auto sdbSizerOK = new wxButton( bottomPanel, wxID_OK );
146  sdbSizer->AddButton( sdbSizerOK );
147  auto sdbSizerCancel = new wxButton( bottomPanel, wxID_CANCEL );
148  sdbSizer->AddButton( sdbSizerCancel );
149  sdbSizer->Realize();
150 
151  buttonsSizer->Add( sdbSizer, 0, 0, 5 );
152  panelSizer->Add( buttonsSizer, 0, wxALIGN_RIGHT|wxALL, 5 );
153 
154  bottomPanel->SetSizer( panelSizer );
155  bottomPanel->Fit();
156 
157  sdbSizerOK->SetDefault();
159 
160  m_auimgr.AddPane( bottomPanel, EDA_PANE().HToolbar().Name( "Buttons" ).Bottom().Layer(6) );
161 
162  m_auimgr.Update();
163  m_initialized = true;
164 
165  if( CVPCB_SETTINGS* cfg = dynamic_cast<CVPCB_SETTINGS*>( config() ) )
166  {
167  if( cfg->m_LibrariesWidth > 0 )
168  {
169  wxAuiPaneInfo& librariesPane = m_auimgr.GetPane( "Libraries" );
170 
171  // wxAUI hack: force width by setting MinSize() and then Fixed()
172  // thanks to ZenJu http://trac.wxwidgets.org/ticket/13180
173  librariesPane.MinSize( cfg->m_LibrariesWidth, -1 );
174  librariesPane.BestSize( cfg->m_LibrariesWidth, -1 );
175  librariesPane.MaxSize( cfg->m_LibrariesWidth, -1 );
176  librariesPane.Fixed();
177  m_auimgr.Update();
178 
179  // now make it resizable again
180  librariesPane.MinSize( 20, -1 );
181  librariesPane.Resizable();
182  m_auimgr.Update();
183  }
184 
185  if( cfg->m_FootprintsWidth > 0 )
186  {
187  wxAuiPaneInfo& footprintsPane = m_auimgr.GetPane( "Footprints" );
188 
189  // wxAUI hack: force width by setting MinSize() and then Fixed()
190  // thanks to ZenJu http://trac.wxwidgets.org/ticket/13180
191  footprintsPane.MinSize( cfg->m_FootprintsWidth, -1 );
192  footprintsPane.BestSize( cfg->m_FootprintsWidth, -1 );
193  footprintsPane.MaxSize( cfg->m_FootprintsWidth, -1 );
194  footprintsPane.Fixed();
195  m_auimgr.Update();
196 
197  // now make it resizable again
198  footprintsPane.MinSize( 20, -1 );
199  footprintsPane.Resizable();
200  m_auimgr.Update();
201  }
202  }
203 
204  // Connect Events
206 
207  // Start the main processing loop
208  m_toolManager->InvokeTool( "cvpcb.Control" );
209 
210  KIPLATFORM::APP::SetShutdownBlockReason( this, _( "Symbol to footprint changes are unsaved" ) );
211 }
const BITMAP_OPAQUE icon_cvpcb_xpm[1]
Definition: icon_cvpcb.cpp:170
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
FOOTPRINT_LIST * m_FootprintsList
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
COMPONENTS_LISTBOX * m_compListBox
KIWAY_PLAYER(KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aWdoName=wxFrameNameStr)
#define CVPCB_MAINFRAME_NAME
void setupEventHandlers()
Setup event handlers.
wxString m_AboutTitle
wxAuiManager m_auimgr
wxStaticText * m_statusLine3
bool InvokeTool(TOOL_ID aToolId)
Function InvokeTool() Calls a tool by sending a tool activation event to tool of given ID.
void SetShutdownBlockReason(wxWindow *aWindow, const wxString &aReason)
Sets the block reason why the window/application is preventing OS shutdown.
Definition: gtk/app.cpp:51
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:82
wxTextCtrl * m_tcFilterString
static FOOTPRINT_LIST * GetInstance(KIWAY &aKiway)
Factory function to return a FOOTPRINT_LIST via Kiway.
#define NULL
ACTION_TOOLBAR * m_mainToolBar
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
#define KICAD_DEFAULT_DRAWFRAME_STYLE
void ReCreateMenuBar() override
Recreates the menu bar.
void BuildFOOTPRINTS_LISTBOX()
Specialization of the wxAuiPaneInfo class for KiCad panels.
LIBRARY_LISTBOX * m_libListBox
wxStaticText * m_statusLine2
void setupUIConditions() override
Setup the UI conditions for the various actions and their controls in this frame.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition: gtk/ui.cpp:56
#define _(s)
Definition: 3d_actions.cpp:33
FOOTPRINTS_LISTBOX * m_footprintListBox
wxButton * m_saveAndContinue
void setupTools()
Setup the tool system for the CVPCB main frame.
wxStaticText * m_statusLine1

References _, BuildCmpListBox(), BuildFOOTPRINTS_LISTBOX(), BuildLIBRARY_LISTBOX(), PCAD2KICAD::Center, EDA_BASE_FRAME::config(), KIPLATFORM::UI::FixupCancelButtonCmdKeyCollision(), FOOTPRINT_LIST::GetInstance(), icon_cvpcb_xpm, ID_SAVE_PROJECT, TOOL_MANAGER::InvokeTool(), KiBitmap(), KIWAY_HOLDER::Kiway(), PCAD2KICAD::Left, LoadSettings(), EDA_BASE_FRAME::m_AboutTitle, EDA_BASE_FRAME::m_auimgr, m_compListBox, m_filteringOptions, m_footprintListBox, m_FootprintsList, EDA_BASE_FRAME::m_FrameSize, m_initialized, m_libListBox, m_mainToolBar, m_modified, m_saveAndContinue, m_skipComponentSelect, m_statusLine1, m_statusLine2, m_statusLine3, m_tcFilterString, TOOLS_HOLDER::m_toolManager, NULL, ReCreateHToolbar(), ReCreateMenuBar(), PCAD2KICAD::Right, KIPLATFORM::APP::SetShutdownBlockReason(), setupEventHandlers(), setupTools(), setupUIConditions(), and FOOTPRINTS_LISTBOX::UNFILTERED_FP_LIST.

◆ ~CVPCB_MAINFRAME()

CVPCB_MAINFRAME::~CVPCB_MAINFRAME ( )

Definition at line 214 of file cvpcb_mainframe.cpp.

215 {
216  // Shutdown all running tools
217  if( m_toolManager )
219 
220  // Clean up the tool infrastructure
221  delete m_actions;
222  delete m_toolManager;
223  delete m_toolDispatcher;
224 
225  m_auimgr.UnInit();
226 }
void ShutdownAllTools()
Shutdown all tools with a currently registered event loop in this tool manager by waking them up with...
wxAuiManager m_auimgr
ACTIONS * m_actions
Definition: tools_holder.h:49
TOOL_DISPATCHER * m_toolDispatcher
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48

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

Member Function Documentation

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar *  aMenuBar)
inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 379 of file eda_base_frame.cpp.

380 {
381  COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
382  ACTION_MENU* helpMenu = new ACTION_MENU( false, commonControl );
383 
384  helpMenu->Add( ACTIONS::help );
385  helpMenu->Add( ACTIONS::gettingStarted );
386  helpMenu->Add( ACTIONS::listHotKeys );
387  helpMenu->Add( ACTIONS::getInvolved );
388  helpMenu->Add( ACTIONS::reportBug );
389 
390  helpMenu->AppendSeparator();
391  helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, about_xpm );
392 
393  aMenuBar->Append( helpMenu, _( "&Help" ) );
394 }
static TOOL_ACTION listHotKeys
Definition: actions.h:177
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:43
static TOOL_ACTION reportBug
Definition: actions.h:179
const BITMAP_OPAQUE about_xpm[1]
Definition: about.cpp:84
COMMON_CONTROL.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
#define _(s)
Definition: 3d_actions.cpp:33
static TOOL_ACTION help
Definition: actions.h:176
static TOOL_ACTION getInvolved
Definition: actions.h:178
static TOOL_ACTION gettingStarted
Definition: actions.h:175

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

Referenced by EDA_3D_VIEWER::CreateMenuBar(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), LIB_VIEW_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::ReCreateMenuBar(), LIB_EDIT_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), GERBVIEW_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
aAssociationis the association to perform
aNewEntryspecifies if this association should be a new entry in the undo list
aAddUndoItemspecifies if an undo item should be created for this association

Definition at line 507 of file cvpcb_mainframe.cpp.

509 {
510  if( m_netlist.IsEmpty() )
511  return;
512 
513  COMPONENT* component = m_netlist.GetComponent( aAssociation.GetComponentIndex() );
514 
515  if( component == NULL )
516  return;
517 
518  LIB_ID fpid = aAssociation.GetNewFootprint();
519  LIB_ID oldFpid = component->GetFPID();
520 
521  // Test for validity of the requested footprint
522  if( !fpid.empty() && !fpid.IsValid() )
523  {
524  wxString msg = wxString::Format( _( "\"%s\" is not a valid footprint." ),
525  fpid.Format().wx_str() );
526  DisplayErrorMessage( this, msg );
527  return;
528  }
529 
530  const KIID& id = component->GetPath().back();
531 
532  // Set new footprint to all instances of the selected component
533  for( unsigned int idx : GetComponentIndices() )
534  {
535  COMPONENT* candidate = m_netlist.GetComponent( idx );
536 
537  if( candidate->GetPath().back() == id )
538  {
539  // Set the new footprint
540  candidate->SetFPID( fpid );
541 
542  // create the new component description and set it
543  wxString description = wxString::Format( CMP_FORMAT,
544  idx + 1,
545  candidate->GetReference(),
546  candidate->GetValue(),
547  candidate->GetFPID().Format().wx_str() );
548  m_compListBox->SetString( idx, description );
549  }
550  }
551 
552  // Mark the data as being modified
553  m_modified = true;
554 
555  // Update the statusbar and refresh the list
556  DisplayStatus();
557  m_compListBox->Refresh();
558 
559  if( !aAddUndoItem )
560  return;
561 
562  // Update the undo list
563  if ( aNewEntry )
564  {
565  // Create a new entry for this association
566  CVPCB_UNDO_REDO_ENTRIES newEntry;
567  newEntry.emplace_back( CVPCB_ASSOCIATION( aAssociation.GetComponentIndex(), oldFpid,
568  aAssociation.GetNewFootprint() ) );
569  m_undoList.emplace_back( newEntry );
570 
571  // Clear the redo list
572  m_redoList.clear();
573  }
574  else
575  m_undoList.back().emplace_back( CVPCB_ASSOCIATION( aAssociation.GetComponentIndex(),
576  oldFpid, aAssociation.GetNewFootprint() ) );
577 
578 }
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:253
#define CMP_FORMAT
The print format to display a schematic component line.
void SetFPID(const LIB_ID &aFPID)
Definition: pcb_netlist.h:156
COMPONENTS_LISTBOX * m_compListBox
LIB_ID GetNewFootprint() const
Get the new footprint to associate to the component.
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
bool IsValid() const
Definition: lib_id.h:171
bool empty() const
Definition: lib_id.h:186
const LIB_ID & GetFPID() const
Definition: pcb_netlist.h:157
unsigned int GetComponentIndex() const
Get the index of the component to modify the association of.
Definition: kiid.h:44
#define NULL
const wxString & GetReference() const
Definition: pcb_netlist.h:147
CVPCB_UNDO_REDO_LIST m_undoList
UTF8 Format() const
Definition: lib_id.cpp:237
COMPONENT is used to store components and all of their related information found in a netlist.
Definition: pcb_netlist.h:80
COMPONENT * GetComponent(unsigned aIndex)
Function GetComponent returns the COMPONENT at aIndex.
Definition: pcb_netlist.h:233
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#define _(s)
Definition: 3d_actions.cpp:33
CVPCB_UNDO_REDO_LIST m_redoList
void SetString(unsigned linecount, const wxString &text)
wxString wx_str() const
Definition: utf8.cpp:51
A class to define a footprint association to be made in cvpcb.
bool IsEmpty() const
Function IsEmpty()
Definition: pcb_netlist.h:212
const wxString & GetValue() const
Definition: pcb_netlist.h:148
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.
const KIID_PATH & GetPath() const
Definition: pcb_netlist.h:162
void DisplayStatus()
Function DisplayStatus updates the information displayed on the status bar at bottom of the main fram...
std::vector< CVPCB_ASSOCIATION > CVPCB_UNDO_REDO_ENTRIES

References _, CMP_FORMAT, DisplayErrorMessage(), DisplayStatus(), LIB_ID::empty(), LIB_ID::Format(), Format(), NETLIST::GetComponent(), CVPCB_ASSOCIATION::GetComponentIndex(), GetComponentIndices(), COMPONENT::GetFPID(), CVPCB_ASSOCIATION::GetNewFootprint(), COMPONENT::GetPath(), COMPONENT::GetReference(), COMPONENT::GetValue(), NETLIST::IsEmpty(), LIB_ID::IsValid(), m_compListBox, m_modified, m_netlist, m_redoList, m_undoList, NULL, COMPONENT::SetFPID(), COMPONENTS_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 167 of file auto_associate.cpp.

168 {
169  FOOTPRINT_EQUIVALENCE_LIST equiv_List;
170  wxString msg, error_msg;
171 
172  if( m_netlist.IsEmpty() )
173  return;
174 
175  if( buildEquivalenceList( equiv_List, &error_msg ) )
176  wxMessageBox( error_msg, _( "Equivalence File Load Error" ), wxOK | wxICON_WARNING, this );
177 
178  // Sort the association list by component value.
179  // When sorted, find duplicate definitions (i.e. 2 or more items
180  // having the same component value) is more easy.
181  std::sort( equiv_List.begin(), equiv_List.end(), sortListbyCmpValue );
182 
183  // Display the number of footprint/component equivalences.
184  msg.Printf( _( "%lu footprint/cmp equivalences found." ), (unsigned long)equiv_List.size() );
185  SetStatusText( msg, 0 );
186 
187  // Now, associate each free component with a footprint, when the association
188  // is found in list
189  m_skipComponentSelect = true;
190  error_msg.Empty();
191 
192  bool firstAssoc = true;
193  for( unsigned kk = 0; kk < m_netlist.GetCount(); kk++ )
194  {
195  COMPONENT* component = m_netlist.GetComponent( kk );
196 
197  bool found = false;
198 
199  if( !component->GetFPID().empty() ) // the component has already a footprint
200  continue;
201 
202  // Here a first attempt is made. We can have multiple equivItem of the same value.
203  // When happens, using the footprint filter of components can remove the ambiguity by
204  // filtering equivItem so one can use multiple equiv_List (for polar and
205  // non-polar caps for example)
206  wxString fpid_candidate;
207 
208  for( unsigned idx = 0; idx < equiv_List.size(); idx++ )
209  {
210  FOOTPRINT_EQUIVALENCE& equivItem = equiv_List[idx];
211 
212  if( equivItem.m_ComponentValue.CmpNoCase( component->GetValue() ) != 0 )
213  continue;
214 
215  const FOOTPRINT_INFO *module = m_FootprintsList->GetModuleInfo( equivItem.m_FootprintFPID );
216 
217  bool equ_is_unique = true;
218  unsigned next = idx+1;
219  int previous = idx-1;
220 
221  if( next < equiv_List.size() &&
222  equivItem.m_ComponentValue == equiv_List[next].m_ComponentValue )
223  equ_is_unique = false;
224 
225  if( previous >= 0 &&
226  equivItem.m_ComponentValue == equiv_List[previous].m_ComponentValue )
227  equ_is_unique = false;
228 
229  // If the equivalence is unique, no ambiguity: use the association
230  if( module && equ_is_unique )
231  {
233  firstAssoc );
234  firstAssoc = false;
235  found = true;
236  break;
237  }
238 
239  // Store the first candidate found in list, when equivalence is not unique
240  // We use it later.
241  if( module && fpid_candidate.IsEmpty() )
242  fpid_candidate = equivItem.m_FootprintFPID;
243 
244  // The equivalence is not unique: use the footprint filter to try to remove
245  // ambiguity
246  // if the footprint filter does not remove ambiguity, we will use fpid_candidate
247  if( module )
248  {
249  size_t filtercount = component->GetFootprintFilters().GetCount();
250  found = ( 0 == filtercount ); // if no entries, do not filter
251 
252  for( size_t jj = 0; jj < filtercount && !found; jj++ )
253  {
254  found = module->GetFootprintName().Matches( component->GetFootprintFilters()[jj] );
255  }
256  }
257  else
258  {
259  msg.Printf( _( "Component %s: footprint %s not found in any of the project "
260  "footprint libraries." ),
261  component->GetReference(), equivItem.m_FootprintFPID );
262 
263  if( ! error_msg.IsEmpty() )
264  error_msg << wxT("\n\n");
265 
266  error_msg += msg;
267  }
268 
269  if( found )
270  {
271  AssociateFootprint( CVPCB_ASSOCIATION( kk, equivItem.m_FootprintFPID ), firstAssoc );
272  firstAssoc = false;
273  break;
274  }
275  }
276 
277  if( found )
278  continue;
279  else if( !fpid_candidate.IsEmpty() )
280  {
281  AssociateFootprint( CVPCB_ASSOCIATION( kk, fpid_candidate ), firstAssoc );
282  firstAssoc = false;
283  continue;
284  }
285 
286  // obviously the last chance: there's only one filter matching one footprint
287  if( 1 == component->GetFootprintFilters().GetCount() )
288  {
289  // we do not need to analyze wildcards: single footprint do not
290  // contain them and if there are wildcards it just will not match any
291  const FOOTPRINT_INFO* module = m_FootprintsList->GetModuleInfo( component->GetFootprintFilters()[0] );
292 
293  if( module )
294  {
296  firstAssoc );
297  firstAssoc = false;
298  }
299  }
300  }
301 
302  if( !error_msg.IsEmpty() )
303  wxMessageBox( error_msg, _( "CvPcb Warning" ), wxOK | wxICON_WARNING, this );
304 
305  m_skipComponentSelect = false;
306  m_compListBox->Refresh();
307 }
CITER next(CITER it)
Definition: ptree.cpp:126
FOOTPRINT_LIST * m_FootprintsList
FOOTPRINT_INFO * GetModuleInfo(const wxString &aFootprintId)
Get info for a module by id.
COMPONENTS_LISTBOX * m_compListBox
void AssociateFootprint(const CVPCB_ASSOCIATION &aAssociation, bool aNewEntry=true, bool aAddUndoItem=true)
Associate a footprint with a specific component in the list.
bool sortListbyCmpValue(const FOOTPRINT_EQUIVALENCE &ref, const FOOTPRINT_EQUIVALENCE &test)
unsigned GetCount() const
Function GetCount.
Definition: pcb_netlist.h:224
bool empty() const
Definition: lib_id.h:186
const LIB_ID & GetFPID() const
Definition: pcb_netlist.h:157
boost::ptr_vector< FOOTPRINT_EQUIVALENCE > FOOTPRINT_EQUIVALENCE_LIST
const wxString & GetReference() const
Definition: pcb_netlist.h:147
void SetStatusText(const wxString &aText, int aNumber=0) override
COMPONENT is used to store components and all of their related information found in a netlist.
Definition: pcb_netlist.h:80
int buildEquivalenceList(FOOTPRINT_EQUIVALENCE_LIST &aList, wxString *aErrorMessages=NULL)
read the .equ files and populate the list of equvalents
COMPONENT * GetComponent(unsigned aIndex)
Function GetComponent returns the COMPONENT at aIndex.
Definition: pcb_netlist.h:233
#define _(s)
Definition: 3d_actions.cpp:33
A class to define a footprint association to be made in cvpcb.
bool IsEmpty() const
Function IsEmpty()
Definition: pcb_netlist.h:212
const wxString & GetValue() const
Definition: pcb_netlist.h:148
const wxArrayString & GetFootprintFilters() const
Definition: pcb_netlist.h:165
const wxString & GetFootprintName() const

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

Referenced by CVPCB_ASSOCIATION_TOOL::AutoAssociate().

◆ BuildCmpListBox()

void CVPCB_MAINFRAME::BuildCmpListBox ( )

Definition at line 891 of file cvpcb_mainframe.cpp.

892 {
893  wxString msg;
894  COMPONENT* component;
895  wxFont guiFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
896 
897  if( m_compListBox == NULL )
898  {
900  m_compListBox->SetFont( wxFont( guiFont.GetPointSize(), wxFONTFAMILY_MODERN,
901  wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL ) );
902  }
903 
905 
906  for( unsigned i = 0; i < m_netlist.GetCount(); i++ )
907  {
908  component = m_netlist.GetComponent( i );
909 
910  msg.Printf( CMP_FORMAT,
911  m_compListBox->GetCount() + 1,
912  component->GetReference(),
913  component->GetValue(),
914  component->GetFPID().Format().wx_str() );
915  m_compListBox->m_ComponentList.Add( msg );
916  }
917 
918  if( m_compListBox->m_ComponentList.Count() )
919  {
920  m_compListBox->SetItemCount( m_compListBox->m_ComponentList.Count() );
921  m_compListBox->SetSelection( 0, true );
922  m_compListBox->RefreshItems( 0L, m_compListBox->m_ComponentList.Count()-1 );
924  }
925 }
#define CMP_FORMAT
The print format to display a schematic component line.
COMPONENTS_LISTBOX * m_compListBox
void SetSelection(int index, bool State=true)
unsigned GetCount() const
Function GetCount.
Definition: pcb_netlist.h:224
const LIB_ID & GetFPID() const
Definition: pcb_netlist.h:157
#define NULL
void UpdateWidth(int aLine=-1)
const wxString & GetReference() const
Definition: pcb_netlist.h:147
UTF8 Format() const
Definition: lib_id.cpp:237
COMPONENT is used to store components and all of their related information found in a netlist.
Definition: pcb_netlist.h:80
COMPONENT * GetComponent(unsigned aIndex)
Function GetComponent returns the COMPONENT at aIndex.
Definition: pcb_netlist.h:233
wxArrayString m_ComponentList
Definition: listboxes.h:193
wxString wx_str() const
Definition: utf8.cpp:51
const wxString & GetValue() const
Definition: pcb_netlist.h:148

References CMP_FORMAT, LIB_ID::Format(), NETLIST::GetComponent(), COMPONENTS_LISTBOX::GetCount(), NETLIST::GetCount(), COMPONENT::GetFPID(), COMPONENT::GetReference(), COMPONENT::GetValue(), ID_CVPCB_COMPONENT_LIST, m_compListBox, COMPONENTS_LISTBOX::m_ComponentList, m_netlist, NULL, COMPONENTS_LISTBOX::SetSelection(), ITEMS_LISTBOX_BASE::UpdateWidth(), and UTF8::wx_str().

Referenced by CVPCB_MAINFRAME().

◆ buildEquivalenceList()

int CVPCB_MAINFRAME::buildEquivalenceList ( FOOTPRINT_EQUIVALENCE_LIST aList,
wxString *  aErrorMessages = NULL 
)
private

read the .equ files and populate the list of equvalents

Parameters
aListthe list to populate
aErrorMessagesis 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.

80 {
81  char line[1024];
82  int error_count = 0;
83  FILE* file;
84  wxFileName fn;
85  wxString tmp, error_msg;
86 
87  SEARCH_STACK& search = Kiface().KifaceSearch();
88  PROJECT_FILE& project = Prj().GetProjectFile();
89 
90  // Find equivalences in all available files, and populates the
91  // equiv_List with all equivalences found in .equ files
92  for( const auto& equfile : project.m_EquivalenceFiles )
93  {
94  fn = wxExpandEnvVars( equfile );
95 
96  tmp = search.FindValidPath( fn.GetFullPath() );
97 
98  if( !tmp )
99  {
100  error_count++;
101 
102  if( aErrorMessages )
103  {
104  error_msg.Printf( _( "Equivalence file \"%s\" could not be found in the "
105  "default search paths." ),
106  fn.GetFullName() );
107 
108  if( ! aErrorMessages->IsEmpty() )
109  *aErrorMessages << wxT("\n\n");
110 
111  *aErrorMessages += error_msg;
112  }
113 
114  continue;
115  }
116 
117  file = wxFopen( tmp, wxT( "rt" ) );
118 
119  if( file == NULL )
120  {
121  error_count++;
122 
123  if( aErrorMessages )
124  {
125  error_msg.Printf( _( "Error opening equivalence file \"%s\"." ), tmp );
126 
127  if( ! aErrorMessages->IsEmpty() )
128  *aErrorMessages << wxT("\n\n");
129 
130  *aErrorMessages += error_msg;
131  }
132 
133  continue;
134  }
135 
136  while( GetLine( file, line, NULL, sizeof( line ) ) != NULL )
137  {
138  if( *line == 0 )
139  continue;
140 
141  wxString wtext = FROM_UTF8( line );
142  wxString value = GetQuotedText( wtext );
143 
144  if( value.IsEmpty() )
145  continue;
146 
147  wxString footprint = GetQuotedText( wtext );
148 
149  if( footprint.IsEmpty() )
150  continue;
151 
152  value.Replace( wxT( " " ), wxT( "_" ) );
153 
154  FOOTPRINT_EQUIVALENCE* equivItem = new FOOTPRINT_EQUIVALENCE();
155  equivItem->m_ComponentValue = value;
156  equivItem->m_FootprintFPID = footprint;
157  aList.push_back( equivItem );
158  }
159 
160  fclose( file );
161  }
162 
163  return error_count;
164 }
wxString FindValidPath(const wxString &aFileName) const
Definition: search_stack.h:73
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:109
wxString GetQuotedText(wxString &text)
SEARCH_STACK looks for files in a number of places.
Definition: search_stack.h:41
PROJECT_FILE is the backing store for a PROJECT, in JSON format.
Definition: project_file.h:62
SEARCH_STACK & KifaceSearch()
Only for DSO specific 'non-library' files.
Definition: kiface_i.h:127
#define NULL
VTBL_ENTRY PROJECT_FILE & GetProjectFile() const
Definition: project.h:143
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
std::vector< wxString > m_EquivalenceFiles
CvPcb params.
Definition: project_file.h:150
char * GetLine(FILE *File, char *Line, int *LineNum, int SizeLine)
Read one line line from aFile.
Definition: string.cpp:384
#define _(s)
Definition: 3d_actions.cpp:33

References _, SEARCH_STACK::FindValidPath(), FROM_UTF8(), GetLine(), PROJECT::GetProjectFile(), GetQuotedText(), Kiface(), KIFACE_I::KifaceSearch(), FOOTPRINT_EQUIVALENCE::m_ComponentValue, PROJECT_FILE::m_EquivalenceFiles, FOOTPRINT_EQUIVALENCE::m_FootprintFPID, NULL, and KIWAY_HOLDER::Prj().

Referenced by AutomaticFootprintMatching().

◆ BuildFOOTPRINTS_LISTBOX()

void CVPCB_MAINFRAME::BuildFOOTPRINTS_LISTBOX ( )

Definition at line 874 of file cvpcb_mainframe.cpp.

875 {
876  wxFont guiFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
877 
878  if( m_footprintListBox == NULL )
879  {
881  m_footprintListBox->SetFont( wxFont( guiFont.GetPointSize(), wxFONTFAMILY_MODERN,
882  wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL ) );
883  }
884 
887  DisplayStatus();
888 }
FOOTPRINT_LIST * m_FootprintsList
#define NULL
FOOTPRINTS_LISTBOX * m_footprintListBox
void SetFootprints(FOOTPRINT_LIST &aList, const wxString &aLibName, COMPONENT *aComponent, const wxString &aFootPrintFilterPattern, int aFilterType)
Function SetFootprints populates the wxListCtrl with the footprints from aList that meet the filter c...
void DisplayStatus()
Function DisplayStatus updates the information displayed on the status bar at bottom of the main fram...

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

Referenced by CVPCB_MAINFRAME(), and ReadNetListAndFpFiles().

◆ BuildLIBRARY_LISTBOX()

void CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX ( )

Definition at line 928 of file cvpcb_mainframe.cpp.

929 {
930  wxFont guiFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
931 
932  if( m_libListBox == NULL )
933  {
935  m_libListBox->SetFont( wxFont( guiFont.GetPointSize(), wxFONTFAMILY_MODERN,
936  wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL ) );
937  }
938 
939  FP_LIB_TABLE* tbl = Prj().PcbFootprintLibs( Kiway() );
940 
941  if( tbl )
942  {
943  wxArrayString libNames;
944 
945  std::vector< wxString > libNickNames = tbl->GetLogicalLibs();
946 
947  for( const wxString& libNickName : libNickNames )
948  libNames.Add( libNickName );
949 
950  m_libListBox->SetLibraryList( libNames );
951  }
952 }
void SetLibraryList(const wxArrayString &aList)
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
#define NULL
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
LIBRARY_LISTBOX * m_libListBox
VTBL_ENTRY FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
Definition: project.cpp:283
std::vector< wxString > GetLogicalLibs()
Return the logical library names, all of them that are pertinent to a look up done on this LIB_TABLE.

References LIB_TABLE::GetLogicalLibs(), ID_CVPCB_LIBRARY_LIST, KIWAY_HOLDER::Kiway(), m_libListBox, NULL, PROJECT::PcbFootprintLibs(), KIWAY_HOLDER::Prj(), and LIBRARY_LISTBOX::SetLibraryList().

Referenced by CVPCB_MAINFRAME(), and ReadNetListAndFpFiles().

◆ canCloseWindow()

bool CVPCB_MAINFRAME::canCloseWindow ( wxCloseEvent &  aCloseEvent)
overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 378 of file cvpcb_mainframe.cpp.

379 {
380  if( m_modified )
381  {
382  // Shutdown blocks must be determined and vetoed as early as possible
384  && aEvent.GetId() == wxEVT_QUERY_END_SESSION )
385  {
386  return false;
387  }
388 
389  if( !HandleUnsavedChanges( this, _( "Symbol to Footprint links have been modified. "
390  "Save changes?" ),
391  [&]()->bool { return SaveFootprintAssociation( false ); } ) )
392  {
393  return false;
394  }
395  }
396 
397  return true;
398 }
bool HandleUnsavedChanges(wxWindow *aParent, const wxString &aMessage, const std::function< bool()> &aSaveFunction)
Display a dialog with Save, Cancel and Discard Changes buttons.
Definition: confirm.cpp:202
bool SupportsShutdownBlockReason()
Whether or not the window supports setting a shutdown block reason.
Definition: gtk/app.cpp:40
#define _(s)
Definition: 3d_actions.cpp:33
bool SaveFootprintAssociation(bool doSaveSchematic)
Function SaveFootprintAssociation saves the edits that the user has done by sending them back to eesc...

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

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS  aUnits)
inherited

Definition at line 961 of file eda_base_frame.cpp.

962 {
963  SetUserUnits( aUnits );
965 
966  wxCommandEvent e( UNITS_CHANGED );
967  ProcessEventLocally( e );
968 }
virtual void unitsChangeRefresh()
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
void SetUserUnits(EDA_UNITS aUnits)

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

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
aFileNameA wxFileName object containing the file name to check.

Definition at line 859 of file eda_base_frame.cpp.

860 {
861  wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
862 
863  wxFileName autoSaveFileName = aFileName;
864 
865  // Check for auto save file.
866  autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
867 
868  wxLogTrace( traceAutoSave,
869  wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
870 
871  if( !autoSaveFileName.FileExists() )
872  return;
873 
874  wxString msg = wxString::Format( _(
875  "Well this is potentially embarrassing!\n"
876  "It appears that the last time you were editing the file\n"
877  "\"%s\"\n"
878  "it was not saved properly. Do you wish to restore the last saved edits you made?" ),
879  aFileName.GetFullName()
880  );
881 
882  int response = wxMessageBox( msg, Pgm().App().GetAppName(), wxYES_NO | wxICON_QUESTION, this );
883 
884  // Make a backup of the current file, delete the file, and rename the auto save file to
885  // the file name.
886  if( response == wxYES )
887  {
888  if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
889  {
890  wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
891  Pgm().App().GetAppName(), wxOK | wxICON_EXCLAMATION, this );
892  }
893  }
894  else
895  {
896  wxLogTrace( traceAutoSave,
897  wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
898 
899  // Remove the auto save file when using the previous file as is.
900  wxRemoveFile( autoSaveFileName.GetFullPath() );
901  }
902 }
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
static wxString GetAutoSaveFilePrefix()
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#define _(s)
Definition: 3d_actions.cpp:33

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

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

◆ ClearFileHistory()

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

Removes all files from the file history.

Parameters
aFileHistoryThe FILE_HISTORY in use. If null, the main application file history is used

Definition at line 756 of file eda_base_frame.cpp.

757 {
758  if( !aFileHistory )
759  aFileHistory = m_fileHistory;
760 
761  wxASSERT( aFileHistory );
762 
763  aFileHistory->ClearFileHistory();
764 
765  // Update the menubar to update the file history menu
766  if( GetMenuBar() )
767  {
768  ReCreateMenuBar();
769  GetMenuBar()->Refresh();
770  }
771 }
void ClearFileHistory()
Clear all entries from the file history.
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.

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

◆ ClearUndoRedoList()

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

Definition at line 407 of file eda_base_frame.cpp.

408 {
409  TOOLS_HOLDER::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
410 
411  COMMON_SETTINGS* settings = Pgm().GetCommonSettings();
412 
413  if( m_fileHistory )
414  {
415  int historySize = settings->m_System.file_history_size;
416  m_fileHistory->SetMaxFiles( (unsigned) std::max( 0, historySize ) );
417  }
418 
419  if( GetMenuBar() )
420  {
421  // For icons in menus, icon scaling & hotkeys
422  ReCreateMenuBar();
423  GetMenuBar()->Refresh();
424  }
425 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
void SetMaxFiles(size_t aMaxFiles)
Update the number of files that will be contained inside the file history.
Definition: filehistory.cpp:85
virtual void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged)
Notification event that some of the common (suite-wide) settings have changed.
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.

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

Referenced by EDA_DRAW_FRAME::CommonSettingsChanged(), KICAD_MANAGER_FRAME::CommonSettingsChanged(), EDA_3D_VIEWER::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 KICAD_MANAGER_FRAME.

Definition at line 652 of file eda_base_frame.cpp.

653 {
654  // KICAD_MANAGER_FRAME overrides this
655  return Kiface().KifaceSettings();
656 }
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_i.h:103
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.

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

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), GERBVIEW_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(), DISPLAY_FOOTPRINTS_FRAME::GetAutoZoom(), GRID_MENU::GRID_MENU(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), EDA_DRAW_FRAME::IsGridVisible(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), SCH_BASE_FRAME::libeditconfig(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), DISPLAY_FOOTPRINTS_FRAME::SetAutoZoom(), PCB_BASE_EDIT_FRAME::SetBoard(), EDA_DRAW_FRAME::SetGridVisibility(), PL_EDITOR_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupTools(), LIB_VIEW_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), LIB_EDIT_FRAME::setupTools(), setupTools(), SCH_EDIT_FRAME::setupTools(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), ZOOM_MENU::update(), GRID_MENU::update(), EDA_DRAW_FRAME::UpdateGridSelectBox(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), EDA_BASE_FRAME::windowClosing(), ZOOM_MENU::ZOOM_MENU(), and BM2CMP_FRAME::~BM2CMP_FRAME().

◆ ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )
inlineoverridevirtualinherited
Returns
a base name prefix used in Load/Save settings to build the full name of keys used in config. This is usually the name of the frame set by CTOR, except for frames shown in multiple modes in which case the m_configName must be set to the base name so that a single config can be used.

Reimplemented from TOOLS_HOLDER.

Definition at line 404 of file eda_base_frame.h.

405  {
406  wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
407  return baseCfgName;
408  }
wxString m_configName

References EDA_BASE_FRAME::m_configName.

Referenced by EDA_BASE_FRAME::SaveWindowSettings().

◆ CurrentToolName()

std::string TOOLS_HOLDER::CurrentToolName ( ) const
inherited

Definition at line 99 of file tools_holder.cpp.

100 {
101  if( m_toolStack.empty() )
102  return ACTIONS::selectionTool.GetName();
103  else
104  return m_toolStack.back();
105 }
std::vector< std::string > m_toolStack
Definition: tools_holder.h:54
static TOOL_ACTION selectionTool
Definition: actions.h:151

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

Referenced by TOOL_MANAGER::processEvent().

◆ Destroy()

◆ DismissModal()

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

Definition at line 161 of file kiway_player.cpp.

162 {
163  m_modal_ret_val = aRetVal;
164  m_modal_string = aResult;
165 
166  if( m_modal_loop )
167  {
168  m_modal_loop->Exit();
169  m_modal_loop = 0; // this marks it as dismissed.
170  }
171 
172  Show( false );
173 }
bool m_modal_ret_val
Definition: kiway_player.h:207
wxString m_modal_string
Definition: kiway_player.h:206
WX_EVENT_LOOP * m_modal_loop
Definition: kiway_player.h:204

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

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

◆ DisplayStatus()

void CVPCB_MAINFRAME::DisplayStatus ( )

Function DisplayStatus updates 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 653 of file cvpcb_mainframe.cpp.

654 {
655  if( !m_initialized )
656  return;
657 
658  wxString filters, msg;
659  COMPONENT* component = GetSelectedComponent();
660 
662  {
663  msg.Empty();
664 
665  if( component )
666  {
667  for( unsigned ii = 0; ii < component->GetFootprintFilters().GetCount(); ii++ )
668  {
669  if( msg.IsEmpty() )
670  msg += component->GetFootprintFilters()[ii];
671  else
672  msg += wxT( ", " ) + component->GetFootprintFilters()[ii];
673  }
674  }
675 
676  filters += _( "Keywords" );
677 
678  if( !msg.IsEmpty() )
679  filters += wxString::Format( wxT( " (%s)" ), msg );
680  }
681 
683  {
684  msg.Empty();
685 
686  if( component )
687  msg = wxString::Format( wxT( "%i" ), component->GetPinCount() );
688 
689  if( !filters.IsEmpty() )
690  filters += wxT( ", " );
691 
692  filters += _( "Pin Count" );
693 
694  if( !msg.IsEmpty() )
695  filters += wxString::Format( wxT( " (%s)" ), msg );
696  }
697 
699  {
701 
702  if( !filters.IsEmpty() )
703  filters += wxT( ", " );
704 
705  filters += _( "Library" );
706 
707  if( !msg.IsEmpty() )
708  filters += wxString::Format( wxT( " (%s)" ), msg );
709  }
710 
711  wxString textFilter = m_tcFilterString->GetValue();
712 
713  if( !textFilter.IsEmpty() )
714  {
715  if( !filters.IsEmpty() )
716  filters += wxT( ", " );
717 
718  filters += _( "Search Text" ) + wxString::Format( wxT( " (%s)" ), textFilter );
719  }
720 
721  if( filters.IsEmpty() )
722  msg = _( "No Filtering" );
723  else
724  msg.Printf( _( "Filtered by %s" ), filters );
725 
726  msg << wxT( ": " ) << m_footprintListBox->GetCount();
727 
728  SetStatusText( msg );
729 
730 
731  msg.Empty();
732  wxString footprintName = GetSelectedFootprint();
733 
734  FOOTPRINT_INFO* module = m_FootprintsList->GetModuleInfo( footprintName );
735 
736  if( module ) // can be NULL if no netlist loaded
737  {
738  msg = wxString::Format( _( "Description: %s; Keywords: %s" ),
739  module->GetDescription(),
740  module->GetKeywords() );
741  }
742 
743  SetStatusText( msg, 1 );
744 
745  msg.Empty();
746  wxString lib;
747 
748  // Choose the footprint to get the information on
749  if( module )
750  {
751  // Use the footprint in the footprint viewer
752  lib = module->GetLibNickname();
753  }
755  {
756  // Use the footprint of the selected component
757  if( component )
758  lib = component->GetFPID().GetLibNickname();
759  }
761  {
762  // Use the library that is selected
764  }
765 
766  // Extract the library information
767  FP_LIB_TABLE* fptbl = Prj().PcbFootprintLibs( Kiway() );
768 
769  if( fptbl->HasLibrary( lib ) )
770  msg = wxString::Format( _( "Library location: %s" ), fptbl->GetFullURI( lib ) );
771  else
772  msg = wxString::Format( _( "Library location: unknown" ) );
773 
774  SetStatusText( msg, 2 );
775 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
bool HasLibrary(const wxString &aNickname, bool aCheckEnabled=false) const
Test for the existence of aNickname in the library table.
FOOTPRINT_LIST * m_FootprintsList
FOOTPRINT_INFO * GetModuleInfo(const wxString &aFootprintId)
Get info for a module by id.
wxString GetLibNickname() const override
wxString GetDescription() override
const LIB_ID & GetFPID() const
Definition: pcb_netlist.h:157
wxTextCtrl * m_tcFilterString
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
wxString GetFullURI(const wxString &aLibNickname, bool aExpandEnvVars=true) const
Return the full URI of the library mapped to aLibNickname.
wxString GetSelectedLibrary()
void SetStatusText(const wxString &aText, int aNumber=0) override
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
LIBRARY_LISTBOX * m_libListBox
COMPONENT is used to store components and all of their related information found in a netlist.
Definition: pcb_netlist.h:80
VTBL_ENTRY FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
Definition: project.cpp:283
wxString GetSelectedFootprint()
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#define _(s)
Definition: 3d_actions.cpp:33
COMPONENT * GetSelectedComponent()
Get the selected component from the component listbox.
FOOTPRINTS_LISTBOX * m_footprintListBox
int GetPinCount() const
Definition: pcb_netlist.h:168
wxString GetKeywords()
const wxArrayString & GetFootprintFilters() const
Definition: pcb_netlist.h:165
CVPCB_MAINFRAME::CONTROL_TYPE GetFocusedControl()
Find out which control currently has focus.

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(), COMPONENT::GetFPID(), LIB_TABLE::GetFullURI(), FOOTPRINT_INFO::GetKeywords(), FOOTPRINT_INFO::GetLibNickname(), LIB_ID::GetLibNickname(), FOOTPRINT_LIST::GetModuleInfo(), COMPONENT::GetPinCount(), GetSelectedComponent(), GetSelectedFootprint(), LIBRARY_LISTBOX::GetSelectedLibrary(), LIB_TABLE::HasLibrary(), KIWAY_HOLDER::Kiway(), m_filteringOptions, m_footprintListBox, m_FootprintsList, m_initialized, m_libListBox, m_tcFilterString, PROJECT::PcbFootprintLibs(), KIWAY_HOLDER::Prj(), and SetStatusText().

Referenced by AssociateFootprint(), BuildFOOTPRINTS_LISTBOX(), CVPCB_ASSOCIATION_TOOL::DeleteAll(), ReadNetListAndFpFiles(), refreshAfterComponentSearch(), and ShowChangedLanguage().

◆ DisplayToolMsg()

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

Reimplemented in EDA_DRAW_FRAME.

Definition at line 141 of file tools_holder.h.

141 {};

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

◆ doAutoSave()

bool EDA_BASE_FRAME::doAutoSave ( )
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 PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 270 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

void CVPCB_MAINFRAME::doCloseWindow ( )
overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 401 of file cvpcb_mainframe.cpp.

402 {
403  // Close module display frame
405  GetFootprintViewerFrame()->Close( true );
406 
407  m_modified = false;
408 
409  // clear highlight symbol in schematic:
410  SendMessageToEESCHEMA( true );
411 }
void SendMessageToEESCHEMA(bool aClearHighligntOnly=false)
Function SendMessageToEESCHEMA Send a remote command to Eeschema via a socket, Commands are $PART: "r...
DISPLAY_FOOTPRINTS_FRAME * GetFootprintViewerFrame() const

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

◆ GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const
inlineinherited

Definition at line 554 of file eda_base_frame.h.

554 { return m_AboutTitle; }
wxString m_AboutTitle

References EDA_BASE_FRAME::m_AboutTitle.

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

188  {
189  return wxT( "_autosave-" );
190  }

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

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const
inlineinherited

Definition at line 315 of file eda_base_frame.h.

315 { return m_autoSaveInterval; }

References EDA_BASE_FRAME::m_autoSaveInterval.

◆ GetBackupSuffix()

static wxString EDA_BASE_FRAME::GetBackupSuffix ( )
inlinestaticprotectedinherited
Returns
the suffix to be appended to the file extension on backup

Definition at line 179 of file eda_base_frame.h.

180  {
181  return wxT( "-bak" );
182  }

◆ 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
aCriteriais the criteria to use for finding the indices
Returns
a vector containing all the indices

Definition at line 985 of file cvpcb_mainframe.cpp.

987 {
988  std::vector<unsigned int> idx;
989 
990  // Make sure a netlist has been loaded and the box has contents
991  if( m_netlist.IsEmpty() || m_compListBox->GetCount() == 0 )
992  return idx;
993 
994  switch( aCriteria )
995  {
997  idx.resize( m_netlist.GetCount() );
998  std::iota( idx.begin(), idx.end(), 0 );
999  break;
1000 
1002  {
1003  // Check to see if anything is selected
1004  if( m_compListBox->GetSelectedItemCount() < 1 )
1005  break;
1006 
1007  // Get the components
1008  int lastIdx = m_compListBox->GetFirstSelected();
1009  idx.emplace_back( lastIdx );
1010 
1011  lastIdx = m_compListBox->GetNextSelected( lastIdx );
1012  while( lastIdx > 0 )
1013  {
1014  idx.emplace_back( lastIdx );
1015  lastIdx = m_compListBox->GetNextSelected( lastIdx );
1016  }
1017  break;
1018  }
1020  for( unsigned int i = 0; i < m_netlist.GetCount(); i++ )
1021  {
1022  if( m_netlist.GetComponent( i )->GetFPID().empty() )
1023  idx.emplace_back( i );
1024  }
1025  break;
1026 
1028  for( unsigned int i = 0; i < m_netlist.GetCount(); i++ )
1029  {
1030  if( !m_netlist.GetComponent( i )->GetFPID().empty() )
1031  idx.emplace_back( i );
1032  }
1033  break;
1034 
1035  default:
1036  wxASSERT_MSG( false, "Invalid component selection criteria" );
1037  }
1038 
1039  return idx;
1040 }
COMPONENTS_LISTBOX * m_compListBox
unsigned GetCount() const
Function GetCount.
Definition: pcb_netlist.h:224
bool empty() const
Definition: lib_id.h:186
const LIB_ID & GetFPID() const
Definition: pcb_netlist.h:157
COMPONENT * GetComponent(unsigned aIndex)
Function GetComponent returns the COMPONENT at aIndex.
Definition: pcb_netlist.h:233
bool IsEmpty() const
Function IsEmpty()
Definition: pcb_netlist.h:212
Not associated components.

References ALL_COMPONENTS, ASSOC_COMPONENTS, LIB_ID::empty(), NETLIST::GetComponent(), COMPONENTS_LISTBOX::GetCount(), NETLIST::GetCount(), COMPONENT::GetFPID(), NETLIST::IsEmpty(), m_compListBox, m_netlist, 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 485 of file eda_base_frame.h.

485 { 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, SCH_EDIT_FRAME, LIB_EDIT_FRAME, LIB_VIEW_FRAME, DISPLAY_FOOTPRINTS_FRAME, PL_EDITOR_FRAME, FOOTPRINT_EDIT_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 123 of file tools_holder.h.

124  {
125  return m_dummySelection;
126  }
SELECTION m_dummySelection
Definition: tools_holder.h:52

References TOOLS_HOLDER::m_dummySelection.

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

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const
inlineinherited

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

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

Definition at line 147 of file tools_holder.h.

147 { return m_immediateActions; }
bool m_immediateActions
Definition: tools_holder.h:61

References TOOLS_HOLDER::m_immediateActions.

◆ GetDragSelects()

bool TOOLS_HOLDER::GetDragSelects ( ) const
inlineinherited

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

Definition at line 153 of file tools_holder.h.

153 { return m_dragSelects; }
bool m_dragSelects
Definition: tools_holder.h:65

References TOOLS_HOLDER::m_dragSelects.

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

◆ GetFileFromHistory()

wxString EDA_BASE_FRAME::GetFileFromHistory ( int  cmdId,
const wxString &  type,
FILE_HISTORY aFileHistory = nullptr 
)
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 init time

Parameters
cmdIdThe command ID associated with the aFileHistory object.
typePlease document me!
aFileHistoryThe FILE_HISTORY in use. If null, the main application file history is used
Returns
a wxString containing the selected filename

Definition at line 716 of file eda_base_frame.cpp.

718 {
719  if( !aFileHistory )
720  aFileHistory = m_fileHistory;
721 
722  wxASSERT( aFileHistory );
723 
724  int baseId = aFileHistory->GetBaseId();
725 
726  wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );
727 
728  unsigned i = cmdId - baseId;
729 
730  if( i < aFileHistory->GetCount() )
731  {
732  wxString fn = aFileHistory->GetHistoryFile( i );
733 
734  if( wxFileName::FileExists( fn ) )
735  return fn;
736  else
737  {
738  wxString msg = wxString::Format( _( "File \"%s\" was not found." ), fn );
739  wxMessageBox( msg );
740 
741  aFileHistory->RemoveFileFromHistory( i );
742  }
743  }
744 
745  // Update the menubar to update the file history menu
746  if( GetMenuBar() )
747  {
748  ReCreateMenuBar();
749  GetMenuBar()->Refresh();
750  }
751 
752  return wxEmptyString;
753 }
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#define _(s)
Definition: 3d_actions.cpp:33
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.

References _, 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 470 of file eda_base_frame.h.

471  {
472  return *m_fileHistory;
473  }
FILE_HISTORY * m_fileHistory

References EDA_BASE_FRAME::m_fileHistory.

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

◆ GetFocusedControl()

CVPCB_MAINFRAME::CONTROL_TYPE CVPCB_MAINFRAME::GetFocusedControl ( )

Find out which control currently has focus.

Returns
the contorl that currently has focus

Definition at line 1057 of file cvpcb_mainframe.cpp.

1058 {
1059  if( m_libListBox->HasFocus() )
1061  else if( m_compListBox->HasFocus() )
1063  else if( m_footprintListBox->HasFocus() )
1065 
1067 }
COMPONENTS_LISTBOX * m_compListBox
No controls have focus.
LIBRARY_LISTBOX * m_libListBox
FOOTPRINTS_LISTBOX * m_footprintListBox

References CONTROL_COMPONENT, CONTROL_FOOTPRINT, CONTROL_LIBRARY, CONTROL_NONE, m_compListBox, m_footprintListBox, and m_libListBox.

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

◆ GetFocusedControlObject()

wxControl * CVPCB_MAINFRAME::GetFocusedControlObject ( )

Get a pointer to the currently focused control.

Returns
the control that currently has focus

Definition at line 1070 of file cvpcb_mainframe.cpp.

1071 {
1072  if( m_libListBox->HasFocus() )
1073  return m_libListBox;
1074  else if( m_compListBox->HasFocus() )
1075  return m_compListBox;
1076  else if( m_footprintListBox->HasFocus() )
1077  return m_footprintListBox;
1078 
1079  return nullptr;
1080 }
COMPONENTS_LISTBOX * m_compListBox
LIBRARY_LISTBOX * m_libListBox
FOOTPRINTS_LISTBOX * m_footprintListBox

References m_compListBox, m_footprintListBox, and m_libListBox.

◆ GetFootprintViewerFrame()

DISPLAY_FOOTPRINTS_FRAME * CVPCB_MAINFRAME::GetFootprintViewerFrame ( ) const
Returns
a pointer on the Footprint Viewer frame, if exists, or NULL

Definition at line 1043 of file cvpcb_mainframe.cpp.

1044 {
1045  // returns the Footprint Viewer frame, if exists, or NULL
1046  return dynamic_cast<DISPLAY_FOOTPRINTS_FRAME*>
1047  ( wxWindow::FindWindowByName( FOOTPRINTVIEWER_FRAME_NAME ) );
1048 }
#define FOOTPRINTVIEWER_FRAME_NAME

References FOOTPRINTVIEWER_FRAME_NAME.

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

◆ GetInfoBar()

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const
inlineinherited

Definition at line 633 of file eda_base_frame.h.

633 { return m_UndoRedoCountMax; }

References EDA_BASE_FRAME::m_UndoRedoCountMax.

Referenced by EDA_DRAW_FRAME::SaveSettings().

◆ GetMoveWarpsCursor()

bool TOOLS_HOLDER::GetMoveWarpsCursor ( ) const
inlineinherited

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

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

Definition at line 159 of file tools_holder.h.

159 { return m_moveWarpsCursor; }
bool m_moveWarpsCursor
Definition: tools_holder.h:66

References TOOLS_HOLDER::m_moveWarpsCursor.

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

◆ GetMruPath()

◆ GetRedoCommandCount()

int CVPCB_MAINFRAME::GetRedoCommandCount ( ) const
inlineoverridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 237 of file cvpcb_mainframe.h.

238  {
239  return m_redoList.size();
240  }
CVPCB_UNDO_REDO_LIST m_redoList

References m_redoList.

◆ GetSelectedComponent()

COMPONENT * CVPCB_MAINFRAME::GetSelectedComponent ( )

Get the selected component from the component listbox.

Returns
the selected component

Definition at line 955 of file cvpcb_mainframe.cpp.

956 {
957  int selection = m_compListBox->GetSelection();
958 
959  if( selection >= 0 && selection < (int) m_netlist.GetCount() )
960  return m_netlist.GetComponent( selection );
961 
962  return NULL;
963 }
COMPONENTS_LISTBOX * m_compListBox
unsigned GetCount() const
Function GetCount.
Definition: pcb_netlist.h:224
#define NULL
COMPONENT * GetComponent(unsigned aIndex)
Function GetComponent returns the COMPONENT at aIndex.
Definition: pcb_netlist.h:233

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

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

1096 {
1097  // returns the LIB_ID of the selected footprint in footprint listview
1098  // or a empty string
1100 }
FOOTPRINTS_LISTBOX * m_footprintListBox

References FOOTPRINTS_LISTBOX::GetSelectedFootprint(), and m_footprintListBox.

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

◆ GetSettingsManager()

◆ GetSeverity()

virtual int EDA_BASE_FRAME::GetSeverity ( int  aErrorCode) const
inlinevirtualinherited

Reimplemented in PCB_BASE_FRAME.

Definition at line 255 of file eda_base_frame.h.

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

1052 {
1053  return GetFootprintViewerFrame();
1054 }
DISPLAY_FOOTPRINTS_FRAME * GetFootprintViewerFrame() const

References GetFootprintViewerFrame().

◆ GetToolManager()

TOOL_MANAGER* TOOLS_HOLDER::GetToolManager ( ) const
inlineinherited

Return the MVC controller.

Definition at line 76 of file tools_holder.h.

76 { return m_toolManager; }
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48

References TOOLS_HOLDER::m_toolManager.

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

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( )
inlineinherited

Definition at line 49 of file kiway_holder.h.

49 { return m_type; }
HOLDER_TYPE m_type
Definition: kiway_holder.h:82

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

233  {
234  return m_undoList.size();
235  }
CVPCB_UNDO_REDO_LIST m_undoList

References m_undoList.

◆ GetUserUnits()

EDA_UNITS EDA_BASE_FRAME::GetUserUnits ( ) const
inlineinherited

Return the user units currently in use.

Definition at line 239 of file eda_base_frame.h.

240  {
241  return m_userUnits;
242  }
EDA_UNITS m_userUnits

References EDA_BASE_FRAME::m_userUnits.

Referenced by DIALOG_CONSTRAINTS_REPORTER::AddPage(), PANEL_SETUP_TRACKS_AND_VIAS::AppendDiffPairs(), PANEL_SETUP_TRACKS_AND_VIAS::AppendTrackWidth(), PANEL_SETUP_TRACKS_AND_VIAS::AppendViaSize(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), EDA_DRAW_FRAME::DisplayGridMsg(), GERBER_FILE_IMAGE::DisplayImageInfo(), DIALOG_GROUP_PROPERTIES::DoAddMember(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), EVT_GRID_CMD_CELL_CHANGED(), PCB_EDIT_FRAME::GenFootprintsReport(), PANEL_MODEDIT_DEFAULTS::getGridValue(), PANEL_SETUP_TEXT_AND_GRAPHICS::getGridValue(), LIB_CIRCLE::GetMsgPanelInfo(), LIB_RECTANGLE::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), LIB_ARC::GetMsgPanelInfo(), LIB_POLYLINE::GetMsgPanelInfo(), MARKER_PCB::GetMsgPanelInfo(), LIB_BEZIER::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), ZONE_CONTAINER::GetMsgPanelInfo(), WS_DRAW_ITEM_BASE::GetMsgPanelInfo(), SCH_BITMAP::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), TRACK::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), DIMENSION::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), VIA::GetMsgPanelInfo(), LEADER::GetMsgPanelInfo(), D_PAD::GetMsgPanelInfo(), EDA_DRAW_FRAME::GetUnitPair(), GetUserUnits(), RC_TREE_MODEL::GetValue(), PCB_INSPECTION_TOOL::InspectClearance(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), DIALOG_SELECT_NET_FROM_LIST::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), PANEL_SETUP_BOARD_STACKUP::onUpdateThicknessValue(), PANEL_PREV_3D::PANEL_PREV_3D(), PANEL_SETUP_BOARD_STACKUP::PANEL_SETUP_BOARD_STACKUP(), POSITION_RELATIVE_TOOL::PositionRelative(), DRC_TOOL::RunTests(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), COMMON_TOOLS::ToggleUnits(), PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataFromWindow(), PANEL_SETUP_FEATURE_CONSTRAINTS::TransferDataToWindow(), UNIT_BINDER::UNIT_BINDER(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), EDITOR_CONDITIONS::unitsFunc(), VIA_SIZE_MENU::update(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), GERBVIEW_FRAME::updateDCodeSelectBox(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), PL_EDITOR_FRAME::UpdateStatusBar(), SCH_BASE_FRAME::UpdateStatusBar(), GERBVIEW_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), DRC_TOOL::userUnits(), and PANEL_SETUP_TRACKS_AND_VIAS::validateData().

◆ GetWindowSettings()

WINDOW_SETTINGS * EDA_BASE_FRAME::GetWindowSettings ( APP_SETTINGS_BASE aCfg)
virtualinherited

Returns a pointer to the window settings for this frame.

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

Parameters
aCfgis this frame's config object

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

Definition at line 646 of file eda_base_frame.cpp.

647 {
648  return &aCfg->m_Window;
649 }
WINDOW_SETTINGS m_Window
Definition: app_settings.h:173

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

994 {
995 #ifdef __WXGTK__
996  // GTK includes the window decorations in the normal GetSize call,
997  // so we have to use a GTK-specific sizing call that returns the
998  // non-decorated window size.
999  int width = 0;
1000  int height = 0;
1001  GTKDoGetSize( &width, &height );
1002 
1003  wxSize winSize( width, height );
1004 #else
1005  wxSize winSize = GetSize();
1006 #endif
1007 
1008  return winSize;
1009 }

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

◆ HandleUpdateUIEvent()

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

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

enabled, checked, etc.).

Parameters
aEventis the wxUpdateUIEvent to be processed.
aFrameis the frame to get the selection from
aCondare the UI SELECTION_CONDITIONS used

Definition at line 318 of file eda_base_frame.cpp.

320 {
321  bool checkRes = false;
322  bool enableRes = true;
323  bool showRes = true;
324  SELECTION& selection = aFrame->GetCurrentSelection();
325 
326  try
327  {
328  checkRes = aCond.checkCondition( selection );
329  enableRes = aCond.enableCondition( selection );
330  showRes = aCond.showCondition( selection );
331  }
332  catch( std::exception& )
333  {
334  // Something broke with the conditions, just skip the event.
335  aEvent.Skip();
336  return;
337  }
338 
339  aEvent.Enable( enableRes );
340  aEvent.Show( showRes );
341 
342  bool canCheck = true;
343 
344  // wxMenuItems don't want to be checked unless they actually are checkable, so we have to check to
345  // see if they can be and can't just universally apply a check in this event.
346  if( auto menu = dynamic_cast<wxMenu*>( aEvent.GetEventObject() ) )
347  canCheck = menu->FindItem( aEvent.GetId() )->IsCheckable();
348 
349  if( canCheck )
350  aEvent.Check( checkRes );
351 }
SELECTION_CONDITION showCondition
Returns true if the UI control should be shown.
SELECTION_CONDITION enableCondition
Returns true if the UI control should be enabled.
SELECTION_CONDITION checkCondition
Returns true if the UI control should be checked.
virtual SELECTION & GetCurrentSelection()
Get the current selection from the canvas area.
Definition: tools_holder.h:123

References ACTION_CONDITIONS::checkCondition, ACTION_CONDITIONS::enableCondition, TOOLS_HOLDER::GetCurrentSelection(), 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 665 of file eda_base_frame.cpp.

666 {
667  return Kiface().GetHelpFileName();
668 }
const wxString & GetHelpFileName() const
Function GetHelpFileName returns just the basename portion of the current help file.
Definition: kiface_i.h:123
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.

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

Referenced by COMMON_CONTROL::ShowHelp().

◆ ImportHotkeyConfigFromFile()

void EDA_BASE_FRAME::ImportHotkeyConfigFromFile ( std::map< std::string, TOOL_ACTION * >  aActionMap,
const wxString &  aDefaultShortname 
)
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 eechema, kicad...

◆ InstallPreferences()

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

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

Parameters
aParenta paged dialog into which the preference panels should be installed

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

Definition at line 350 of file eda_base_frame.h.

350 { }

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

Definition at line 202 of file eda_base_frame.h.

202 { return false; }

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ IsContentModified()

bool CVPCB_MAINFRAME::IsContentModified ( )
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 142 of file cvpcb_mainframe.h.

143  {
144  return m_modified;
145  }

References m_modified.

◆ IsCurrentTool()

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

Definition at line 108 of file tools_holder.cpp.

109 {
110  if( m_toolStack.empty() )
111  return &aAction == &ACTIONS::selectionTool;
112  else
113  return m_toolStack.back() == aAction.GetName();
114 }
std::vector< std::string > m_toolStack
Definition: tools_holder.h:54
static TOOL_ACTION selectionTool
Definition: actions.h:151
const std::string & GetName() const
Returns name of the action.
Definition: tool_action.h:75

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

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

◆ IsDismissed()

bool KIWAY_PLAYER::IsDismissed ( )
inherited

Function IsDismissed returns false only if both the frame is acting in modal mode and it has not been dismissed yet with DismissModal().

IOW, it will return true if the dialog is not modal or if it is modal and has been dismissed.

Definition at line 155 of file kiway_player.cpp.

156 {
157  return !m_modal_loop;
158 }
WX_EVENT_LOOP * m_modal_loop
Definition: kiway_player.h:204

References KIWAY_PLAYER::m_modal_loop.

Referenced by FOOTPRINT_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), and LIB_VIEW_FRAME::OnCloseWindow().

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

178 { return m_modal; }

References KIWAY_PLAYER::m_modal.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), LIB_CONTROL::AddSymbolToSchematic(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), LIB_VIEW_FRAME::OnCloseWindow(), and KIWAY_PLAYER::ShowModal().

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T  aType) const
inlineinherited

Definition at line 317 of file eda_base_frame.h.

317 { return m_Ident == aType; }

References EDA_BASE_FRAME::m_Ident.

Referenced by LIB_CONTROL::AddLibrary(), PCBNEW_CONTROL::AddLibrary(), EDA_DRAW_FRAME::AddStandardSubMenus(), LIB_CONTROL::AddSymbol(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), BOARD_COMMIT::BOARD_COMMIT(), EDA_3D_VIEWER::CreateMenuBar(), LIB_CONTROL::CutCopyDelete(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), KIGFX::SCH_VIEW::DisplaySheet(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), COMMON_TOOLS::doZoomFit(), LIB_CONTROL::DuplicateSymbol(), LIB_CONTROL::EditSymbol(), LIB_CONTROL::ExportSymbol(), MODULE::GetMsgPanelInfo(), CONVERT_TOOL::Init(), LIB_CONTROL::Init(), DIALOG_EDIT_ONE_FIELD::init(), SELECTION_TOOL::Init(), DIALOG_PAD_PROPERTIES::initValues(), CONVERT_TOOL::LinesToPoly(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), LIB_CONTROL::OnDeMorgan(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), PCBNEW_CONTROL::Paste(), LIB_CONTROL::PinLibrary(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), LIB_CONTROL::Revert(), EE_INSPECTION_TOOL::RunERC(), LIB_CONTROL::Save(), LIB_CONTROL::ShowComponentTree(), EE_INSPECTION_TOOL::ShowDatasheet(), and LIB_CONTROL::UnpinLibrary().

◆ IsWritable()

bool EDA_BASE_FRAME::IsWritable ( const wxFileName &  aFileName)
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
aFileNameThe full path and/or file name of the file to test.
Returns
False if aFileName cannot be written.

Definition at line 815 of file eda_base_frame.cpp.

816 {
817  wxString msg;
818  wxFileName fn = aFileName;
819 
820  // Check for absence of a file path with a file name. Unfortunately KiCad
821  // uses paths relative to the current project path without the ./ part which
822  // confuses wxFileName. Making the file name path absolute may be less than
823  // elegant but it solves the problem.
824  if( fn.GetPath().IsEmpty() && fn.HasName() )
825  fn.MakeAbsolute();
826 
827  wxCHECK_MSG( fn.IsOk(), false,
828  wxT( "File name object is invalid. Bad programmer!" ) );
829  wxCHECK_MSG( !fn.GetPath().IsEmpty(), false,
830  wxT( "File name object path <" ) + fn.GetFullPath() +
831  wxT( "> is not set. Bad programmer!" ) );
832 
833  if( fn.IsDir() && !fn.IsDirWritable() )
834  {
835  msg.Printf( _( "You do not have write permissions to folder \"%s\"." ),
836  fn.GetPath() );
837  }
838  else if( !fn.FileExists() && !fn.IsDirWritable() )
839  {
840  msg.Printf( _( "You do not have write permissions to save file \"%s\" to folder \"%s\"." ),
841  fn.GetFullName(), fn.GetPath() );
842  }
843  else if( fn.FileExists() && !fn.IsFileWritable() )
844  {
845  msg.Printf( _( "You do not have write permissions to save file \"%s\"." ),
846  fn.GetFullPath() );
847  }
848 
849  if( !msg.IsEmpty() )
850  {
851  wxMessageBox( msg );
852  return false;
853  }
854 
855  return true;
856 }
#define _(s)
Definition: 3d_actions.cpp:33

References _.

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

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 56 of file kiway_holder.h.

57  {
58  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
59  return *m_kiway;
60  }
KIWAY * m_kiway
Definition: kiway_holder.h:81

References KIWAY_HOLDER::m_kiway.

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

◆ kiway_express()

void KIWAY_PLAYER::kiway_express ( KIWAY_EXPRESS aEvent)
protectedinherited

event handler, routes to derivative specific virtual KiwayMailIn()

Definition at line 176 of file kiway_player.cpp.

177 {
178  // logging support
179  KiwayMailIn( aEvent ); // call the virtual, override in derived.
180 }
virtual void KiwayMailIn(KIWAY_EXPRESS &aEvent)
Function KiwayMailIn receives KIWAY_EXPRESS messages from other players.

References KIWAY_PLAYER::KiwayMailIn().

◆ KiwayMailIn()

void CVPCB_MAINFRAME::KiwayMailIn ( KIWAY_EXPRESS aEvent)
overridevirtual

Function KiwayMailIn receives KIWAY_EXPRESS messages from other players.

Merely override it in derived classes.

Reimplemented from KIWAY_PLAYER.

Definition at line 1123 of file cvpcb_mainframe.cpp.

1124 {
1125  const std::string& payload = mail.GetPayload();
1126 
1127  switch( mail.Command() )
1128  {
1129  case MAIL_EESCHEMA_NETLIST:
1130  ReadNetListAndFpFiles( payload );
1131  /* @todo
1132  Go into SCH_EDIT_FRAME::OnOpenCvpcb( wxCommandEvent& event ) and trim GNL_ALL down.
1133  */
1134  break;
1135 
1136  default:
1137  ; // ignore most
1138  }
1139 }
bool ReadNetListAndFpFiles(const std::string &aNetlist)
Function ReadNetListAndFpFiles loads the netlist file built on the fly by Eeschema and loads footprin...

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

◆ language_change()

void KIWAY_PLAYER::language_change ( wxCommandEvent &  event)
protectedinherited

Function language_change is an event handler called on a language menu selection.

Definition at line 183 of file kiway_player.cpp.

184 {
185  int id = event.GetId();
186 
187  // tell all the KIWAY_PLAYERs about the language change.
188  Kiway().SetLanguage( id );
189 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
VTBL_ENTRY void SetLanguage(int aLanguage)
Function SetLanguage changes the language and then calls ShowChangedLanguage() on all KIWAY_PLAYERs.
Definition: kiway.cpp:445

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

◆ LoadFootprintFiles()

bool CVPCB_MAINFRAME::LoadFootprintFiles ( )

Function LoadFootprintFiles reads the list of footprint (*.mod files) and generate the list of footprints.

for each module are stored the module name documentation string associated keywords m_ModuleLibNames is the list of library that must be read (loaded) fills m_footprints

Returns
true if libraries are found, false otherwise.

Definition at line 778 of file cvpcb_mainframe.cpp.

779 {
780  FP_LIB_TABLE* fptbl = Prj().PcbFootprintLibs( Kiway() );
781 
782  // Check if there are footprint libraries in the footprint library table.
783  if( !fptbl || !fptbl->GetLogicalLibs().size() )
784  {
785  wxMessageBox( _( "No PCB footprint libraries are listed in the current footprint "
786  "library table." ), _( "Configuration Error" ), wxOK | wxICON_ERROR );
787  return false;
788  }
789 
790  WX_PROGRESS_REPORTER progressReporter( this, _( "Loading Footprint Libraries" ), 2 );
791 
792  m_FootprintsList->ReadFootprintFiles( fptbl, nullptr, &progressReporter );
793 
795  {
797  }
798 
799  return true;
800 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
FOOTPRINT_LIST * m_FootprintsList
void DisplayErrors(wxTopLevelWindow *aCaller=NULL)
Multi-thread safe progress reporter dialog, intended for use of tasks that paralleize reporting back ...
virtual bool ReadFootprintFiles(FP_LIB_TABLE *aTable, const wxString *aNickname=nullptr, PROGRESS_REPORTER *aProgressReporter=nullptr)=0
Read all the footprints provided by the combination of aTable and aNickname.
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
VTBL_ENTRY FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
Definition: project.cpp:283
#define _(s)
Definition: 3d_actions.cpp:33
unsigned GetErrorCount() const
std::vector< wxString > GetLogicalLibs()
Return the logical library names, all of them that are pertinent to a look up done on this LIB_TABLE.

References _, FOOTPRINT_LIST::DisplayErrors(), FOOTPRINT_LIST::GetErrorCount(), LIB_TABLE::GetLogicalLibs(), KIWAY_HOLDER::Kiway(), 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 446 of file cvpcb_mainframe.cpp.

447 {
449 
450  auto cfg = static_cast<CVPCB_SETTINGS*>( aCfg );
451 
452  m_filteringOptions = cfg->m_FilterFootprint;
453 }
virtual void LoadSettings(APP_SETTINGS_BASE *aCfg)
Load common frame parameters from a configuration file.

References EDA_BASE_FRAME::LoadSettings(), and m_filteringOptions.

Referenced by CVPCB_MAINFRAME().

◆ LoadWindowSettings()

void EDA_BASE_FRAME::LoadWindowSettings ( const WINDOW_SETTINGS aCfg)
inherited

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

Definition at line 546 of file eda_base_frame.cpp.

547 {
548  LoadWindowState( aCfg->state );
549 
550  if( m_hasAutoSave )
551  m_autoSaveInterval = Pgm().GetCommonSettings()->m_System.autosave_interval;
552 
553  m_perspective = aCfg->perspective;
554  m_mruPath = aCfg->mru_path;
555 
556  TOOLS_HOLDER::CommonSettingsChanged( false, false );
557 }
wxString mru_path
Definition: app_settings.h:84
wxString m_mruPath
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
void LoadWindowState(const wxString &aFileName)
wxString m_perspective
wxString perspective
Definition: app_settings.h:85
WINDOW_STATE state
Definition: app_settings.h:83
virtual void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged)
Notification event that some of the common (suite-wide) settings have changed.

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

429 {
430  if( !Pgm().GetCommonSettings()->m_Session.remember_open_files )
431  return;
432 
433  const PROJECT_FILE_STATE* state = Prj().GetLocalSettings().GetFileState( aFileName );
434 
435  if( state != nullptr )
436  {
437  LoadWindowState( state->window );
438  }
439 }
VTBL_ENTRY PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
Definition: project.h:149
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
void LoadWindowState(const wxString &aFileName)
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
struct WINDOW_STATE window
const PROJECT_FILE_STATE * GetFileState(const wxString &aFileName)

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

443 {
444  bool wasDefault = false;
445 
446  m_FramePos.x = aState.pos_x;
447  m_FramePos.y = aState.pos_y;
448  m_FrameSize.x = aState.size_x;
449  m_FrameSize.y = aState.size_y;
450 
451  wxLogTrace( traceDisplayLocation, "Config position (%d, %d) with size (%d, %d)",
453 
454  // Ensure minimum size is set if the stored config was zero-initialized
456  {
459  wasDefault = true;
460 
461  wxLogTrace( traceDisplayLocation, "Using minimum size (%d, %d)", m_FrameSize.x, m_FrameSize.y );
462  }
463 
464  wxLogTrace( traceDisplayLocation, "Number of displays: %d", wxDisplay::GetCount() );
465 
466  if( aState.display >= wxDisplay::GetCount() )
467  {
468  wxLogTrace( traceDisplayLocation, "Previous display not found" );
469 
470  // If it isn't attached, use the first display
471  // Warning wxDisplay has 2 ctor variants. the parameter needs a type:
472  const unsigned int index = 0;
473  wxDisplay display( index );
474  wxRect clientSize = display.GetGeometry();
475 
476  m_FramePos = wxDefaultPosition;
477 
478  // Ensure the window fits on the display, since the other one could have been larger
479  if( m_FrameSize.x > clientSize.width )
480  m_FrameSize.x = clientSize.width;
481 
482  if( m_FrameSize.y > clientSize.height )
483  m_FrameSize.y = clientSize.height;
484  }
485  else
486  {
487  wxPoint upperRight( m_FramePos.x + m_FrameSize.x, m_FramePos.y );
488  wxPoint upperLeft( m_FramePos.x, m_FramePos.y );
489 
490  wxDisplay display( aState.display );
491  wxRect clientSize = display.GetClientArea();
492 
493  // The percentage size (represented in decimal) of the region around the screen's border where
494  // an upper corner is not allowed
495 #define SCREEN_BORDER_REGION 0.10
496 
497  int yLim = clientSize.y + ( clientSize.height * ( 1.0 - SCREEN_BORDER_REGION ) );
498  int xLimLeft = clientSize.x + ( clientSize.width * SCREEN_BORDER_REGION );
499  int xLimRight = clientSize.x + ( clientSize.width * ( 1.0 - SCREEN_BORDER_REGION ) );
500 
501  if( upperLeft.x > xLimRight || // Upper left corner too close to right edge of screen
502  upperRight.x < xLimLeft || // Upper right corner too close to left edge of screen
503  upperRight.y > yLim ) // Upper corner too close to the bottom of the screen
504  {
505  m_FramePos = wxDefaultPosition;
506  wxLogTrace( traceDisplayLocation, "Resetting to default position" );
507  }
508  }
509 
510  // Ensure Window title bar is visible
511 #if defined( __WXOSX__ )
512  // for macOSX, the window must be below system (macOSX) toolbar
513  int Ypos_min = 20;
514 #else
515  int Ypos_min = 0;
516 #endif
517  if( m_FramePos.y < Ypos_min )
518  m_FramePos.y = Ypos_min;
519 
520  wxLogTrace( traceDisplayLocation, "Final window position (%d, %d) with size (%d, %d)",
522 
523  SetSize( m_FramePos.x, m_FramePos.y, m_FrameSize.x, m_FrameSize.y );
524 
525  // Center the window if we reset to default
526  if( m_FramePos.x == -1 )
527  {
528  wxLogTrace( traceDisplayLocation, "Centering window" );
529  Center();
530  m_FramePos = GetPosition();
531  }
532 
533  // Record the frame sizes in an un-maximized state
536 
537  // Maximize if we were maximized before
538  if( aState.maximized || ( wasDefault && m_maximizeByDefault ) )
539  {
540  wxLogTrace( traceDisplayLocation, "Maximizing window" );
541  Maximize();
542  }
543 }
static const int s_defaultSize_x
static const int s_defaultSize_y
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxSize m_NormalFrameSize
#define SCREEN_BORDER_REGION
static const int s_minsize_x
static const int s_minsize_y
unsigned int display
Definition: app_settings.h:75
wxPoint m_NormalFramePos

References PCAD2KICAD::Center, WINDOW_STATE::display, EDA_BASE_FRAME::m_FramePos, EDA_BASE_FRAME::m_FrameSize, EDA_BASE_FRAME::m_maximizeByDefault, EDA_BASE_FRAME::m_NormalFramePos, EDA_BASE_FRAME::m_NormalFrameSize, WINDOW_STATE::maximized, WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, s_defaultSize_x, s_defaultSize_y, s_minsize_x, s_minsize_y, SCREEN_BORDER_REGION, WINDOW_STATE::size_x, WINDOW_STATE::size_y, and traceDisplayLocation.

◆ NonUserClose()

bool EDA_BASE_FRAME::NonUserClose ( bool  aForce)
inlineinherited

Definition at line 635 of file eda_base_frame.h.

636  {
637  m_isNonUserClose = true;
638  return Close( aForce );
639  }

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

264 {
265  if( !doAutoSave() )
266  m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
267 }
virtual bool doAutoSave()
This should be overridden by the derived class to handle the auto save feature.
wxTimer * m_autoSaveTimer

References EDA_BASE_FRAME::doAutoSave(), EDA_BASE_FRAME::m_autoSaveInterval, and EDA_BASE_FRAME::m_autoSaveTimer.

Referenced by EDA_BASE_FRAME::EDA_BASE_FRAME().

◆ OnCharHook()

void EDA_BASE_FRAME::OnCharHook ( wxKeyEvent &  event)
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 276 of file eda_base_frame.cpp.

277 {
278  wxLogTrace( kicadTraceKeyEvent, "EDA_BASE_FRAME::OnCharHook %s", dump( event ) );
279  // Key events can be filtered here.
280  // Currently no filtering is made.
281  event.Skip();
282 }
wxString dump(const wxArrayString &aArray)
Debug helper for printing wxArrayString contents.
const wxChar *const kicadTraceKeyEvent
Flag to enable wxKeyEvent debug tracing.

References dump(), and kicadTraceKeyEvent.

◆ OnEnterFilteringText()

void CVPCB_MAINFRAME::OnEnterFilteringText ( wxCommandEvent &  event)

Function OnEnterFilteringText Is called each time the text of m_tcFilterString is changed.

Definition at line 414 of file cvpcb_mainframe.cpp.

415 {
416  // Called when changing the filter string in main toolbar.
417  // If the option FOOTPRINTS_LISTBOX::FILTERING_BY_TEXT_PATTERN is set, update the list
418  // of available footprints which match the filter
419 
420  wxListEvent l_event;
421  OnSelectComponent( l_event );
422 }
void OnSelectComponent(wxListEvent &event)
Function OnSelectComponent Called when clicking on a component in component list window.

References OnSelectComponent().

Referenced by ReCreateHToolbar(), and setupEventHandlers().

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent &  event)
inherited

Definition at line 774 of file eda_base_frame.cpp.

775 {
776  void ShowAboutDialog(EDA_BASE_FRAME * aParent); // See AboutDialog_main.cpp
777  ShowAboutDialog( this );
778 }
void ShowAboutDialog(EDA_BASE_FRAME *aParent)
The base frame for deriving all KiCad main window classes.

References ShowAboutDialog().

◆ OnMaximize()

void EDA_BASE_FRAME::OnMaximize ( wxMaximizeEvent &  aEvent)
inherited

Definition at line 971 of file eda_base_frame.cpp.

972 {
973  // When we maximize the window, we want to save the old information
974  // so that we can add it to the settings on next window load.
975  // Contrary to the documentation, this event seems to be generated
976  // when the window is also being unmaximized on OSX, so we only
977  // capture the size information when we maximize the window when on OSX.
978 #ifdef __WXOSX__
979  if( !IsMaximized() )
980 #endif
981  {
983  m_NormalFramePos = GetPosition();
984  wxLogTrace( traceDisplayLocation, "Maximizing window - Saving position (%d, %d) with size (%d, %d)",
986  }
987 
988  // Skip event to actually maximize the window
989  aEvent.Skip();
990 }
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxSize m_NormalFrameSize
wxSize GetWindowSize()
Get the undecorated window size that can be used for restoring the window size.
wxPoint m_NormalFramePos

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

286 {
287  if( !m_toolDispatcher )
288  aEvent.Skip();
289  else
291 }
virtual void DispatchWxEvent(wxEvent &aEvent)
Processes wxEvents (mostly UI events), translates them to TOOL_EVENTs, and makes tools handle those.
TOOL_DISPATCHER * m_toolDispatcher
Definition: tools_holder.h:50

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

307  {
308  aEvent.Skip();
309  }

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent &  event)
inherited

Definition at line 781 of file eda_base_frame.cpp.

782 {
783  PAGED_DIALOG dlg( this, _( "Preferences" ), true );
784  wxTreebook* book = dlg.GetTreebook();
785 
786  book->AddPage( new PANEL_COMMON_SETTINGS( &dlg, book ), _( "Common" ) );
787 
788  book->AddPage( new PANEL_MOUSE_SETTINGS( &dlg, book ), _( "Mouse and Touchpad" ) );
789 
790  PANEL_HOTKEYS_EDITOR* hotkeysPanel = new PANEL_HOTKEYS_EDITOR( this, book, false );
791  book->AddPage( hotkeysPanel, _( "Hotkeys" ) );
792 
793  for( unsigned i = 0; i < KIWAY_PLAYER_COUNT; ++i )
794  {
795  KIWAY_PLAYER* frame = dlg.Kiway().Player( (FRAME_T) i, false );
796 
797  if( frame )
798  frame->InstallPreferences( &dlg, hotkeysPanel );
799  }
800 
801  // The Kicad manager frame is not a player so we have to add it by hand
802  wxWindow* manager = wxFindWindowByName( KICAD_MANAGER_FRAME_NAME );
803 
804  if( manager )
805  static_cast<EDA_BASE_FRAME*>( manager )->InstallPreferences( &dlg, hotkeysPanel );
806 
807  for( size_t i = 0; i < book->GetPageCount(); ++i )
808  book->GetPage( i )->Layout();
809 
810  if( dlg.ShowModal() == wxID_OK )
811  dlg.Kiway().CommonSettingsChanged( false, false );
812 }
KIWAY_PLAYER is a wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of ...
Definition: kiway_player.h:61
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
FRAME_T
Enum FRAME_T is the set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition: frame_type.h:34
VTBL_ENTRY KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=NULL)
Function Player returns the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:343
#define KICAD_MANAGER_FRAME_NAME
#define _(s)
Definition: 3d_actions.cpp:33
virtual void InstallPreferences(PAGED_DIALOG *, PANEL_HOTKEYS_EDITOR *)
Function InstallPreferences Allow a frame to load its preference panels (if any) into the preferences...

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

Referenced by APPEARANCE_CONTROLS::onReadOnlySwatch().

◆ OnSelectComponent()

void CVPCB_MAINFRAME::OnSelectComponent ( wxListEvent &  event)

Function OnSelectComponent 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 425 of file cvpcb_mainframe.cpp.

426 {
428  return;
429 
430  wxString libraryName;
431  COMPONENT* component = GetSelectedComponent();
432  libraryName = m_libListBox->GetSelectedLibrary();
433 
434  m_footprintListBox->SetFootprints( *m_FootprintsList, libraryName, component,
435  m_tcFilterString->GetValue(), m_filteringOptions );
436 
437  if( component && component->GetFPID().IsValid() )
439  else
441 
442  refreshAfterComponentSearch( component );
443 }
FOOTPRINT_LIST * m_FootprintsList
void SetSelectedFootprint(const LIB_ID &aFPID)
bool IsValid() const
Definition: lib_id.h:171
const LIB_ID & GetFPID() const
Definition: pcb_netlist.h:157
wxTextCtrl * m_tcFilterString
void refreshAfterComponentSearch(COMPONENT *component)
wxString GetSelectedLibrary()
LIBRARY_LISTBOX * m_libListBox
COMPONENT is used to store components and all of their related information found in a netlist.
Definition: pcb_netlist.h:80
void SetSelection(int index, bool State=true)
COMPONENT * GetSelectedComponent()
Get the selected component from the component listbox.
FOOTPRINTS_LISTBOX * m_footprintListBox
void SetFootprints(FOOTPRINT_LIST &aList, const wxString &aLibName, COMPONENT *aComponent, const wxString &aFootPrintFilterPattern, int aFilterType)
Function SetFootprints populates the wxListCtrl with the footprints from aList that meet the filter c...

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

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

◆ OpenProjectFiles()

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

Function OpenProjectFiles is abstract, and opens 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 implementor 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
aFileListincludes 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.
aCtlis a set of bit flags ORed together from the set of KICTL_* #defined above.
Returns
bool - true if all requested files were opened OK, else false.

Reimplemented from KIWAY_PLAYER.

Definition at line 581 of file cvpcb_mainframe.cpp.

582 {
583  return true;
584 }

◆ ParseArgs()

virtual void KIWAY_PLAYER::ParseArgs ( wxCmdLineParser &  aParser)
inlinevirtualinherited

Handles 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
aParseris the argument parser created by the top-level launcher.

Definition at line 140 of file kiway_player.h.

141  {
142  WXUNUSED( aParser );
143  }

Referenced by PGM_SINGLE_TOP::OnPgmInit().

◆ PopCommandFromRedoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromRedoList ( )
virtualinherited

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

Definition at line 955 of file eda_base_frame.cpp.

956 {
957  return m_redoList.PopCommand();
958 }
PICKED_ITEMS_LIST * PopCommand()
UNDO_REDO_CONTAINER m_redoList

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

Referenced by LIB_EDIT_FRAME::GetComponentFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), and SCH_EDITOR_CONTROL::Redo().

◆ PopCommandFromUndoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromUndoList ( )
virtualinherited

◆ PopTool()

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

Definition at line 61 of file tools_holder.cpp.

62 {
63  // Push/pop events can get out of order (such as when they're generated by the Simulator
64  // frame but not processed until the mouse is back in the Schematic frame), so make sure
65  // we're popping the right stack frame.
66 
67  for( int i = (int) m_toolStack.size() - 1; i >= 0; --i )
68  {
69  if( m_toolStack[ i ] == actionName )
70  {
71  m_toolStack.erase( m_toolStack.begin() + i );
72 
73  // If there's something underneath us, and it's now the top of the stack, then
74  // re-activate it
75  if( ( --i ) >= 0 && i == (int)m_toolStack.size() - 1 )
76  {
77  std::string back = m_toolStack[ i ];
79 
80  if( action )
81  {
82  // Pop the action as running it will push it back onto the stack
83  m_toolStack.pop_back();
84 
85  TOOL_EVENT evt = action->MakeEvent();
86  evt.SetHasPosition( false );
87  GetToolManager()->PostEvent( evt );
88  }
89  }
90  else
92 
93  return;
94  }
95  }
96 }
virtual void DisplayToolMsg(const wxString &msg)
Definition: tools_holder.h:141
TOOL_ACTION * FindAction(const std::string &aActionName) const
Finds an action with a given name (if there is one available).
TOOL_EVENT.
Definition: tool_event.h:171
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
std::vector< std::string > m_toolStack
Definition: tools_holder.h:54
ACTION_MANAGER * GetActionManager()
Definition: tool_manager.h:200
Represents a single user action.
Definition: tool_action.h:44
TOOL_EVENT MakeEvent() const
Returns the event associated with the action (i.e.
Definition: tool_action.h:113
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:76
void PostEvent(const TOOL_EVENT &aEvent)
Puts an event to the event queue to be processed at the end of event processing cycle.
Definition: tool_manager.h:274
static TOOL_ACTION selectionTool
Definition: actions.h:151
void SetHasPosition(bool aHasPosition)
Definition: tool_event.h:261

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

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

◆ PrintMsg()

void EDA_BASE_FRAME::PrintMsg ( const wxString &  text)
inherited

Definition at line 671 of file eda_base_frame.cpp.

672 {
673  SetStatusText( text );
674 }

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

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

Definition at line 35 of file kiway_holder.cpp.

36 {
37  return Kiway().Prj();
38 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:173

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), SCH_EDIT_FRAME::AppendSchematic(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), buildEquivalenceList(), BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_PROPERTIES::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::CreateScreens(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), DisplayStatus(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), PCB_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), DIALOG_EXPORT_SVG::ExportSVGFile(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DIALOG_GENDRILL::GenDrillAndMapFiles(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), DISPLAY_FOOTPRINTS_FRAME::GetModule(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::GetSelectedSymbol(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::HarvestFootprintsToLibrary(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), SCH_EDIT_FRAME::KiwayMailIn(), LIB_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), EDA_BASE_FRAME::LoadWindowState(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_PROPERTIES::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_PROPERTIES::OnAdd3DModel(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), DIALOG_GENDRILL::OnGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), DIALOG_CONFIG_EQUFILES::OnOkClick(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_BOM::OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_TOOLS::PasteFootprint(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), SCH_EDIT_FRAME::PrintPage(), EDA_DRAW_FRAME::PrintWorkSheet(), ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::Save_File(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), LIB_EDIT_FRAME::saveLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), LIB_EDIT_FRAME::savePartAs(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), EDA_BASE_FRAME::SaveSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectCompFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), LIB_EDIT_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), GERBVIEW_FRAME::SetPageSettings(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), PANEL_SETUP_RULES::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_EDIT_COMPONENTS_LIBID::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

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

206 {
207 #ifdef __WXMAC__
208  // Apple in its infinite wisdom will raise a disabled window before even passing
209  // us the event, so we have no way to stop it. Instead, we have to catch an
210  // improperly ordered disabled window and quasi-modal dialog here and reorder
211  // them.
212  if( !IsEnabled() && IsActive() )
213  {
214  wxWindow* dlg = findQuasiModalDialog();
215  if( dlg )
216  dlg->Raise();
217  }
218 #endif
219 
220  if( !wxFrame::ProcessEvent( aEvent ) )
221  return false;
222 
223  if( IsShown() && m_hasAutoSave && IsActive() &&
225  {
226  if( !m_autoSaveState )
227  {
228  wxLogTrace( traceAutoSave, wxT( "Starting auto save timer." ) );
229  m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
230  m_autoSaveState = true;
231  }
232  else if( m_autoSaveTimer->IsRunning() )
233  {
234  wxLogTrace( traceAutoSave, wxT( "Stopping auto save timer." ) );
235  m_autoSaveTimer->Stop();
236  m_autoSaveState = false;
237  }
238  }
239 
240  return true;
241 }
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
virtual bool isAutoSaveRequired() const
Return the auto save status of the application.
wxTimer * m_autoSaveTimer
wxWindow * findQuasiModalDialog()

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, and traceAutoSave.

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

◆ ProjectChanged()

virtual void EDA_BASE_FRAME::ProjectChanged ( )
inlinevirtualinherited

Notification event that the project has changed.

Reimplemented in PCB_EDIT_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 552 of file eda_base_frame.h.

552 {}

Referenced by KIWAY::ProjectChanged().

◆ PushCommandToRedoList()

void EDA_BASE_FRAME::PushCommandToRedoList ( PICKED_ITEMS_LIST aItem)
virtualinherited

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

Definition at line 934 of file eda_base_frame.cpp.

935 {
936  m_redoList.PushCommand( aNewitem );
937 
938  // Delete the extra items, if count max reached
939  if( m_UndoRedoCountMax > 0 )
940  {
941  int extraitems = GetRedoCommandCount() - m_UndoRedoCountMax;
942 
943  if( extraitems > 0 )
944  ClearUndoORRedoList( REDO_LIST, extraitems );
945  }
946 }
virtual int GetRedoCommandCount() const
virtual void ClearUndoORRedoList(UNDO_REDO_LIST aList, int aItemCount=-1)
void PushCommand(PICKED_ITEMS_LIST *aCommand)
UNDO_REDO_CONTAINER m_redoList

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 LIB_EDIT_FRAME::GetComponentFromUndoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), and SCH_EDITOR_CONTROL::Undo().

◆ PushCommandToUndoList()

void EDA_BASE_FRAME::PushCommandToUndoList ( PICKED_ITEMS_LIST aItem)
virtualinherited

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

Definition at line 919 of file eda_base_frame.cpp.

920 {
921  m_undoList.PushCommand( aNewitem );
922 
923  // Delete the extra items, if count max reached
924  if( m_UndoRedoCountMax > 0 )
925  {
926  int extraitems = GetUndoCommandCount() - m_UndoRedoCountMax;
927 
928  if( extraitems > 0 )
929  ClearUndoORRedoList( UNDO_LIST, extraitems );
930  }
931 }
UNDO_REDO_CONTAINER m_undoList
virtual void ClearUndoORRedoList(UNDO_REDO_LIST aList, int aItemCount=-1)
void PushCommand(PICKED_ITEMS_LIST *aCommand)
virtual int GetUndoCommandCount() const

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 LIB_EDIT_FRAME::GetComponentFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), SCH_EDITOR_CONTROL::Redo(), PL_EDITOR_FRAME::SaveCopyInUndoList(), LIB_EDIT_FRAME::SaveCopyInUndoList(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ PushTool()

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

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

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

Definition at line 44 of file tools_holder.cpp.

45 {
46  m_toolStack.push_back( actionName );
47 
48  // Human cognitive stacking is very shallow; deeper tool stacks just get annoying
49  if( m_toolStack.size() > 3 )
50  m_toolStack.erase( m_toolStack.begin() );
51 
52  TOOL_ACTION* action = m_toolManager->GetActionManager()->FindAction( actionName );
53 
54  if( action )
55  DisplayToolMsg( action->GetLabel() );
56  else
57  DisplayToolMsg( actionName );
58 }
virtual void DisplayToolMsg(const wxString &msg)
Definition: tools_holder.h:141
TOOL_ACTION * FindAction(const std::string &aActionName) const
Finds an action with a given name (if there is one available).
wxString GetLabel() const
Definition: tool_action.cpp:69
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
std::vector< std::string > m_toolStack
Definition: tools_holder.h:54
ACTION_MANAGER * GetActionManager()
Definition: tool_manager.h:200
Represents a single user action.
Definition: tool_action.h:44

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

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

◆ ReadNetListAndFpFiles()

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

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

Parameters
aNetlistis the netlist from eeschema in kicad s-expr format. (see CVPCB_MAINFRAME::KiwayMailIn() to know how to get this netlist)

Definition at line 79 of file readwrite_dlgs.cpp.

80 {
81  wxString msg;
82  bool hasMissingNicks = false;
83 
84  ReadSchematicNetlist( aNetlist );
85 
86  if( m_compListBox == NULL )
87  return false;
88 
89  wxSafeYield();
90 
92 
95 
97 
99  {
100  for( unsigned i = 0; i < m_netlist.GetCount(); i++ )
101  {
102  COMPONENT* component = m_netlist.GetComponent( i );
103 
104  if( component->GetFPID().empty() )
105  continue;
106 
107  if( component->GetFPID().IsLegacy() )
108  hasMissingNicks = true;
109  }
110  }
111 
112  // Check if footprint links were generated before the footprint library table was implemented.
113  if( hasMissingNicks )
114  {
115  msg = _(
116  "Some of the assigned footprints are legacy entries (are missing lib nicknames). "
117  "Would you like CvPcb to attempt to convert them to the new required LIB_ID format? "
118  "(If you answer no, then these assignments will be cleared out and you will "
119  "have to re-assign these footprints yourself.)"
120  );
121 
122  if( IsOK( this, msg ) )
123  {
124  msg.Clear();
125 
126  try
127  {
128  for( unsigned i = 0; i < m_netlist.GetCount(); i++ )
129  {
130  COMPONENT* component = m_netlist.GetComponent( i );
131 
132  if( component->GetFPID().IsLegacy() )
133  {
134  // get this first here, it's possibly obsoleted if we get it too soon.
135  FP_LIB_TABLE* tbl = Prj().PcbFootprintLibs( Kiway() );
136 
137  int guess = guessNickname( tbl, (LIB_ID*) &component->GetFPID() );
138 
139  switch( guess )
140  {
141  case 0:
142  m_modified = true;
143  break;
144 
145  case 1:
146  msg += wxString::Format( _(
147  "Component \"%s\" footprint \"%s\" was <b>not found</b> in any library.\n" ),
148  component->GetReference(),
149  component->GetFPID().GetLibItemName().wx_str()
150  );
151  break;
152 
153  case 2:
154  msg += wxString::Format( _(
155  "Component \"%s\" footprint \"%s\" was found in <b>multiple</b> libraries.\n" ),
156  component->GetReference(),
157  component->GetFPID().GetLibItemName().wx_str()
158  );
159  break;
160  }
161  }
162  }
163  }
164  catch( const IO_ERROR& ioe )
165  {
166  msg = ioe.What();
167  msg += wxT( "\n\n" );
168  msg += _( "First check your footprint library table entries." );
169 
170  wxMessageBox( msg, _( "Problematic Footprint Library Tables" ) );
171  return false;
172  }
173 
174  if( msg.size() )
175  {
176  HTML_MESSAGE_BOX dlg( this, wxEmptyString );
177 
178  dlg.MessageSet( _( "The following errors occurred attempting to convert the "
179  "footprint assignments:\n\n" ) );
180  dlg.ListSet( msg );
181  dlg.MessageSet( _( "\nYou will need to reassign them manually if you want them "
182  "to be updated correctly the next time you import the "
183  "netlist in Pcbnew." ) );
184 
185 #if 1
186  dlg.ShowModal();
187 #else
188  dlg.Fit();
189  dlg.Show( true ); // modeless lets user watch while fixing the problems, but its not working.
190 #endif
191  }
192  }
193  else
194  {
195  // Clear the legacy footprint assignments.
196  for( unsigned i = 0; i < m_netlist.GetCount(); i++ )
197  {
198  COMPONENT* component = m_netlist.GetComponent( i );
199 
200  if( component->GetFPID().IsLegacy() )
201  {
202  component->SetFPID( LIB_ID() /* empty */ );
203  m_modified = true;
204  }
205  }
206  }
207  }
208 
209 
210  // Display a dialog to select footprint selection, if the netlist
211  // and the .cmp file give 2 different valid footprints
212  std::vector <int > m_indexes; // indexes of footprints in netlist
213 
214  for( unsigned ii = 0; ii < m_netlist.GetCount(); ii++ )
215  {
216  COMPONENT* component = m_netlist.GetComponent( ii );
217 
218  if( component->GetAltFPID().empty() )
219  continue;
220 
221  if( component->GetFPID().IsLegacy() || component->GetAltFPID().IsLegacy())
222  continue;
223 
224  m_indexes.push_back( ii );
225  }
226 
227  // If a n assignment conflict is found,
228  // open a dialog to chose between schematic assignment
229  // and .cmp file assignment:
230  if( m_indexes.size() > 0 )
231  {
233 
234  for( unsigned ii = 0; ii < m_indexes.size(); ii++ )
235  {
236  COMPONENT* component = m_netlist.GetComponent( m_indexes[ii] );
237 
238  wxString cmpfpid = component->GetFPID().Format();
239  wxString schfpid = component->GetAltFPID().Format();
240 
241  dlg.Add( component->GetReference(), schfpid, cmpfpid );
242  }
243 
244  if( dlg.ShowModal() == wxID_OK )
245  {
246 
247  // Update the fp selection:
248  for( unsigned ii = 0; ii < m_indexes.size(); ii++ )
249  {
250  COMPONENT* component = m_netlist.GetComponent( m_indexes[ii] );
251 
252  int choice = dlg.GetSelection( component->GetReference() );
253 
254  if( choice == 0 ) // the schematic (alt fpid) is chosen:
255  component->SetFPID( component->GetAltFPID() );
256  }
257  }
258  }
259 
260  // Populates the component list box:
261  for( unsigned i = 0; i < m_netlist.GetCount(); i++ )
262  {
263  COMPONENT* component = m_netlist.GetComponent( i );
264 
265  msg.Printf( CMP_FORMAT, m_compListBox->GetCount() + 1,
266  component->GetReference(),
267  component->GetValue(),
268  FROM_UTF8( component->GetFPID().Format().c_str() ) );
269 
270  m_compListBox->AppendLine( msg );
271  }
272 
273  if( !m_netlist.IsEmpty() )
274  m_compListBox->SetSelection( 0, true );
275 
276  DisplayStatus();
277 
278  return true;
279 }
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:109
#define CMP_FORMAT
The print format to display a schematic component line.
void SetFPID(const LIB_ID &aFPID)
Definition: pcb_netlist.h:156
bool AnyFootprintsLinked() const
Function AnyFootprintsLinked.
COMPONENTS_LISTBOX * m_compListBox
void SetSelection(int index, bool State=true)
int ReadSchematicNetlist(const std::string &aNetlist)
Function ReadSchematicNetlist read the netlist (.net) file built on the fly by Eeschema.
unsigned GetCount() const
Function GetCount.
Definition: pcb_netlist.h:224
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
bool LoadFootprintFiles()
Function LoadFootprintFiles reads the list of footprint (*.mod files) and generate the list of footpr...
static int guessNickname(FP_LIB_TABLE *aTbl, LIB_ID *aFootprintId)
Return true if the resultant LIB_ID has a certain nickname.
bool empty() const
Definition: lib_id.h:186
void AppendLine(const wxString &text)
const char * c_str() const
Definition: utf8.h:107
const LIB_ID & GetFPID() const
Definition: pcb_netlist.h:157
#define NULL
const LIB_ID & GetAltFPID() const
Definition: pcb_netlist.h:160
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
const wxString & GetReference() const
Definition: pcb_netlist.h:147
void BuildFOOTPRINTS_LISTBOX()
HTML_MESSAGE_BOX.
UTF8 Format() const
Definition: lib_id.cpp:237
COMPONENT is used to store components and all of their related information found in a netlist.
Definition: pcb_netlist.h:80
VTBL_ENTRY FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
Definition: project.cpp:283
COMPONENT * GetComponent(unsigned aIndex)
Function GetComponent returns the COMPONENT at aIndex.
Definition: pcb_netlist.h:233
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#define _(s)
Definition: 3d_actions.cpp:33
wxString wx_str() const
Definition: utf8.cpp:51
bool IsEmpty() const
Function IsEmpty()
Definition: pcb_netlist.h:212
const wxString & GetValue() const
Definition: pcb_netlist.h:148
bool IsLegacy() const
Definition: lib_id.h:176
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:284
void DisplayStatus()
Function DisplayStatus updates the information displayed on the status bar at bottom of the main fram...

References _, DIALOG_FP_CONFLICT_ASSIGNMENT_SELECTOR::Add(), NETLIST::AnyFootprintsLinked(), COMPONENTS_LISTBOX::AppendLine(), BuildFOOTPRINTS_LISTBOX(), BuildLIBRARY_LISTBOX(), UTF8::c_str(), COMPONENTS_LISTBOX::Clear(), CMP_FORMAT, DisplayStatus(), LIB_ID::empty(), LIB_ID::Format(), Format(), FROM_UTF8(), COMPONENT::GetAltFPID(), NETLIST::GetComponent(), COMPONENTS_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(), KIWAY_HOLDER::Kiway(), HTML_MESSAGE_BOX::ListSet(), LoadFootprintFiles(), m_compListBox, m_modified, m_netlist, HTML_MESSAGE_BOX::MessageSet(), NULL, PROJECT::PcbFootprintLibs(), KIWAY_HOLDER::Prj(), ReadSchematicNetlist(), COMPONENT::SetFPID(), COMPONENTS_LISTBOX::SetSelection(), DIALOG_SHIM::Show(), IO_ERROR::What(), and UTF8::wx_str().

Referenced by KiwayMailIn().

◆ ReadSchematicNetlist()

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

Function ReadSchematicNetlist read the netlist (.net) file built on the fly by Eeschema.

Parameters
aNetlistis 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 840 of file cvpcb_mainframe.cpp.

841 {
842  STRING_LINE_READER* strrdr = new STRING_LINE_READER( aNetlist, "Eeschema via Kiway" );
843  KICAD_NETLIST_READER netrdr( strrdr, &m_netlist );
844 
845  m_netlist.Clear();
846 
847  try
848  {
849  netrdr.LoadNetlist();
850  }
851  catch( const IO_ERROR& ioe )
852  {
853  wxString msg = wxString::Format( _( "Error loading schematic.\n%s" ),
854  ioe.What().GetData() );
855  wxMessageBox( msg, _( "Load Error" ), wxOK | wxICON_ERROR );
856  return 1;
857  }
858 
859  // We also remove footprint name if it is "$noname" because this is a dummy name,
860  // not the actual name of the footprint.
861  for( unsigned ii = 0; ii < m_netlist.GetCount(); ii++ )
862  {
863  if( m_netlist.GetComponent( ii )->GetFPID().GetLibItemName() == std::string( "$noname" ) )
864  m_netlist.GetComponent( ii )->SetFPID( LIB_ID() );
865  }
866 
867  // Sort components by reference:
869 
870  return 0;
871 }
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
KICAD_NETLIST_READER read the new s-expression based KiCad netlist format.
void SetFPID(const LIB_ID &aFPID)
Definition: pcb_netlist.h:156
unsigned GetCount() const
Function GetCount.
Definition: pcb_netlist.h:224
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
void SortByReference()
const LIB_ID & GetFPID() const
Definition: pcb_netlist.h:157
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
COMPONENT * GetComponent(unsigned aIndex)
Function GetComponent returns the COMPONENT at aIndex.
Definition: pcb_netlist.h:233
void Clear()
Function Clear removes all components from the netlist.
Definition: pcb_netlist.h:218
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#define _(s)
Definition: 3d_actions.cpp:33
STRING_LINE_READER is a LINE_READER that reads from a multiline 8 bit wide std::string.
Definition: richio.h:255
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76

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 35 of file toolbars_cvpcb.cpp.

36 {
37  if( m_mainToolBar )
38  {
40  }
41  else
42  {
43  m_mainToolBar = new ACTION_TOOLBAR( this, ID_H_TOOLBAR, wxDefaultPosition, wxDefaultSize,
44  KICAD_AUI_TB_STYLE | wxAUI_TB_HORZ_LAYOUT );
46  }
47 
49 
52 
55 
56 
60 
66 
67  // Add tools for footprint names filtering:
69 
70  // wxGTK with GTK3 has a serious issue with bold texts: strings are incorrectly sized
71  // and truncated after the first space.
72  // so use SetLabelMarkup is a trick to fix this issue.
73  m_mainToolBar->AddSpacer( 15 );
74  wxString msg_bold = _( "Footprint Filters:" );
75  wxStaticText* text = new wxStaticText( m_mainToolBar, wxID_ANY, msg_bold );
76  text->SetFont( m_mainToolBar->GetFont().Bold() );
77 #ifdef __WXGTK3__
78  text->SetLabelMarkup( "<b>" + msg_bold + "</b>" );
79 #endif
80  m_mainToolBar->AddControl( text );
81 
85 
87 
88  m_tcFilterString = new wxTextCtrl( m_mainToolBar, ID_CVPCB_FILTER_TEXT_EDIT, wxEmptyString,
89  wxDefaultPosition, wxDefaultSize, wxTE_PROCESS_ENTER );
90 
91  m_tcFilterString->Bind( wxEVT_TEXT_ENTER, &CVPCB_MAINFRAME::OnEnterFilteringText, this );
92 
93  m_mainToolBar->AddControl( m_tcFilterString );
94 
95  // after adding the buttons to the toolbar, must call Realize() to reflect the changes
96  m_mainToolBar->Realize();
97 }
static TOOL_ACTION showFootprintViewer
Open the footprint viewer.
Definition: cvpcb_actions.h:52
ACTION_TOOLBAR.
static TOOL_ACTION FilterFPbyFPFilters
Footprint Filtering actions.
Definition: cvpcb_actions.h:69
static TOOL_ACTION gotoNextNA
Definition: cvpcb_actions.h:56
static constexpr bool TOGGLE
static TOOL_ACTION gotoPreviousNA
Navigate the component tree.
Definition: cvpcb_actions.h:55
void AddScaledSeparator(wxWindow *aWindow)
Add a separator that introduces space on either side to not squash the tools when scaled.
void Add(const TOOL_ACTION &aAction, bool aIsToggleEntry=false, bool aIsCancellable=false)
Adds a TOOL_ACTION-based button to the toolbar.
void SetAuiManager(wxAuiManager *aManager)
Set the AUI manager that this toolbar belongs to.
wxAuiManager m_auimgr
static TOOL_ACTION FilterFPbyLibrary
Definition: cvpcb_actions.h:71
wxTextCtrl * m_tcFilterString
static TOOL_ACTION deleteAll
Definition: cvpcb_actions.h:65
static TOOL_ACTION showFootprintLibTable
Definition: actions.h:174
ACTION_TOOLBAR * m_mainToolBar
static TOOL_ACTION saveAssociations
Management actions.
Definition: cvpcb_actions.h:59
static TOOL_ACTION autoAssociate
Footprint Association actions.
Definition: cvpcb_actions.h:63
static TOOL_ACTION redo
Definition: actions.h:68
#define _(s)
Definition: 3d_actions.cpp:33
static TOOL_ACTION filterFPbyPin
Definition: cvpcb_actions.h:70
static constexpr int KICAD_AUI_TB_STYLE
Default style flags used for wxAUI toolbars
static TOOL_ACTION undo
Definition: actions.h:67
void OnEnterFilteringText(wxCommandEvent &event)
Function OnEnterFilteringText Is called each time the text of m_tcFilterString is changed.
void ClearToolbar()
Clear the toolbar and remove all associated menus.

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, 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 is changed

Reimplemented from EDA_BASE_FRAME.

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

38 {
40  // wxWidgets handles the Mac Application menu behind the scenes, but that means
41  // we always have to start from scratch with a new wxMenuBar.
42  wxMenuBar* oldMenuBar = GetMenuBar();
43  WX_MENUBAR* menuBar = new WX_MENUBAR();
44 
45  //-- File menu -----------------------------------------------------------
46  //
47  ACTION_MENU* fileMenu = new ACTION_MENU( false, tool );
48 
50  fileMenu->AppendSeparator();
51  fileMenu->AddClose( _( "Assign Footprints" ) );
52 
53  //-- Preferences menu -----------------------------------------------
54  //
55  ACTION_MENU* editMenu = new ACTION_MENU( false, tool );
56 
57  editMenu->Add( ACTIONS::undo );
58  editMenu->Add( ACTIONS::redo );
59 
60  editMenu->AppendSeparator();
61  editMenu->Add( ACTIONS::cut );
62  editMenu->Add( ACTIONS::copy );
63  editMenu->Add( ACTIONS::paste );
64 
65  //-- Preferences menu -----------------------------------------------
66  //
67  ACTION_MENU* prefsMenu = new ACTION_MENU( false, tool );
68 
69  prefsMenu->Add( ACTIONS::configurePaths );
70  prefsMenu->Add( ACTIONS::showFootprintLibTable );
71  prefsMenu->Add( _( "Preferences...\tCTRL+," ),
72  _( "Show preferences for all open tools" ),
73  wxID_PREFERENCES,
75 
76  prefsMenu->AppendSeparator();
78 
79  prefsMenu->AppendSeparator();
80  AddMenuLanguageList( prefsMenu, tool );
81 
82  //-- Menubar -------------------------------------------------------------
83  //
84  menuBar->Append( fileMenu, _( "&File" ) );
85  menuBar->Append( editMenu, _( "&Edit" ) );
86  menuBar->Append( prefsMenu, _( "&Preferences" ) );
87  AddStandardHelpMenu( menuBar );
88 
89  SetMenuBar( menuBar );
90  delete oldMenuBar;
91 }
wxMenuItem * Add(const wxString &aLabel, int aId, const BITMAP_OPAQUE *aIcon)
Adds a wxWidgets-style entry to the menu.
static TOOL_ACTION showEquFileTable
Definition: cvpcb_actions.h:60
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:43
Wrapper around a wxMenuBar object that prevents the accelerator table from being used.
Definition: wx_menubar.h:45
static TOOL_ACTION copy
Definition: actions.h:70
static TOOL_ACTION showFootprintLibTable
Definition: actions.h:174
void AddStandardHelpMenu(wxMenuBar *aMenuBar)
Adds the standard KiCad help menu to the menubar.
static TOOL_ACTION cut
Definition: actions.h:69
void AddMenuLanguageList(ACTION_MENU *aMasterMenu, TOOL_INTERACTIVE *aControlTool)
Function AddMenuLanguageList creates a menu list for language choice, and add it as submenu to Master...
static TOOL_ACTION saveAssociations
Management actions.
Definition: cvpcb_actions.h:59
COMMON_CONTROL.
static TOOL_ACTION redo
Definition: actions.h:68
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
#define _(s)
Definition: 3d_actions.cpp:33
static TOOL_ACTION undo
Definition: actions.h:67
const BITMAP_OPAQUE preference_xpm[1]
Definition: preference.cpp:53
static TOOL_ACTION configurePaths
Definition: actions.h:172
static TOOL_ACTION paste
Definition: actions.h:71
void AddClose(wxString aAppname="")
Add a standard close item to the menu with the accelerator key CTRL-W.

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_xpm, 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 489 of file cvpcb_mainframe.cpp.

490 {
491  if( m_redoList.size() == 0 )
492  return;
493 
494  CVPCB_UNDO_REDO_ENTRIES curEntry = m_redoList.back();
495  m_redoList.pop_back();
496 
497  // Iterate over the entries to undo
498  bool firstAssoc = true;
499  for( const auto& assoc : curEntry )
500  {
501  AssociateFootprint( assoc, firstAssoc );
502  firstAssoc = false;
503  }
504 }
void AssociateFootprint(const CVPCB_ASSOCIATION &aAssociation, bool aNewEntry=true, bool aAddUndoItem=true)
Associate a footprint with a specific component in the list.
CVPCB_UNDO_REDO_LIST m_redoList
std::vector< CVPCB_ASSOCIATION > CVPCB_UNDO_REDO_ENTRIES

References AssociateFootprint(), and m_redoList.

Referenced by CVPCB_ASSOCIATION_TOOL::Redo().

◆ refreshAfterComponentSearch()

void CVPCB_MAINFRAME::refreshAfterComponentSearch ( COMPONENT component)
private

Definition at line 587 of file cvpcb_mainframe.cpp.

588 {
589  // Tell AuiMgr that objects are changed !
590  if( m_auimgr.GetManagedWindow() ) // Be sure Aui Manager is initialized
591  // (could be not the case when starting CvPcb
592  m_auimgr.Update();
593 
594  if( component == NULL )
595  {
596  DisplayStatus();
597  return;
598  }
599 
600  // Preview of the already assigned footprint.
601  // Find the footprint that was already chosen for this component and select it,
602  // but only if the selection is made from the component list or the library list.
603  // If the selection is made from the footprint list, do not change the current
604  // selected footprint.
605  if( FindFocus() == m_compListBox || FindFocus() == m_libListBox )
606  {
607  wxString module = FROM_UTF8( component->GetFPID().Format().c_str() );
608 
610 
611  for( int ii = 0; ii < m_footprintListBox->GetCount(); ii++ )
612  {
613  wxString footprintName;
614  wxString msg = m_footprintListBox->OnGetItemText( ii, 0 );
615  msg.Trim( true );
616  msg.Trim( false );
617  footprintName = msg.AfterFirst( wxChar( ' ' ) );
618 
619  if( module.Cmp( footprintName ) == 0 )
620  {
621  m_footprintListBox->SetSelection( ii, true );
622  break;
623  }
624  }
625 
628  }
629 
631  DisplayStatus();
632 }
static TOOL_ACTION showFootprintViewer
Open the footprint viewer.
Definition: cvpcb_actions.h:52
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:109
COMPONENTS_LISTBOX * m_compListBox
void SendMessageToEESCHEMA(bool aClearHighligntOnly=false)
Function SendMessageToEESCHEMA Send a remote command to Eeschema via a socket, Commands are $PART: "r...
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:141
wxAuiManager m_auimgr
const char * c_str() const
Definition: utf8.h:107
const LIB_ID & GetFPID() const
Definition: pcb_netlist.h:157
#define NULL
wxString OnGetItemText(long item, long column) const override
Function OnGetItemText this overloaded function MUST be provided for the wxLC_VIRTUAL mode because re...
LIBRARY_LISTBOX * m_libListBox
UTF8 Format() const
Definition: lib_id.cpp:237
void SetSelection(int index, bool State=true)
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
FOOTPRINTS_LISTBOX * m_footprintListBox
DISPLAY_FOOTPRINTS_FRAME * GetFootprintViewerFrame() const
void DisplayStatus()
Function DisplayStatus updates the information displayed on the status bar at bottom of the main fram...

References UTF8::c_str(), DisplayStatus(), LIB_ID::Format(), FROM_UTF8(), FOOTPRINTS_LISTBOX::GetCount(), GetFootprintViewerFrame(), COMPONENT::GetFPID(), ITEMS_LISTBOX_BASE::GetSelection(), EDA_BASE_FRAME::m_auimgr, m_compListBox, m_footprintListBox, m_libListBox, TOOLS_HOLDER::m_toolManager, NULL, FOOTPRINTS_LISTBOX::OnGetItemText(), TOOL_MANAGER::RunAction(), SendMessageToEESCHEMA(), FOOTPRINTS_LISTBOX::SetSelection(), and CVPCB_ACTIONS::showFootprintViewer.

Referenced by OnSelectComponent().

◆ RefreshCanvas()

virtual void TOOLS_HOLDER::RefreshCanvas ( )
inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 171 of file tools_holder.h.

171 { }

Referenced by TOOL_MANAGER::ProcessEvent().

◆ RegisterUIUpdateHandler() [1/2]

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

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

Parameters
aActionis the action to register
aConditionsare the UI conditions to use for the control states

Definition at line 85 of file tools_holder.h.

87  {
88  RegisterUIUpdateHandler( aAction.GetUIId(), aConditions );
89  }
int GetUIId() const
Definition: tool_action.h:102
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...
Definition: tools_holder.h:85

References TOOL_ACTION::GetUIId().

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

◆ RegisterUIUpdateHandler() [2/2]

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

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

Parameters
aIDis the control ID to register the handler for
aConditionsare the UI conditions to use for the control states

Reimplemented from TOOLS_HOLDER.

Definition at line 294 of file eda_base_frame.cpp.

295 {
297  std::placeholders::_1,
298  this,
299  aConditions );
300 
301  m_uiUpdateMap[aID] = evtFunc;
302 
303  Bind( wxEVT_UPDATE_UI, evtFunc, aID );
304 }
static void HandleUpdateUIEvent(wxUpdateUIEvent &aEvent, EDA_BASE_FRAME *aFrame, ACTION_CONDITIONS aCond)
Handles events generated when the UI is trying to figure out the current state of the UI controls rel...
std::function< void(wxUpdateUIEvent &) > UIUpdateHandler
This is the handler functor for the update UI events.
std::map< int, UIUpdateHandler > m_uiUpdateMap

References EDA_BASE_FRAME::HandleUpdateUIEvent(), and EDA_BASE_FRAME::m_uiUpdateMap.

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

◆ SaveFootprintAssociation()

bool CVPCB_MAINFRAME::SaveFootprintAssociation ( bool  doSaveSchematic)

Function SaveFootprintAssociation saves the edits that the user has done by sending them back to eeschema via the kiway.

Optionally saves the schematic to disk as well.

Definition at line 282 of file readwrite_dlgs.cpp.

283 {
284  std::string payload;
285  STRING_FORMATTER sf;
286 
288 
289  payload = sf.GetString();
291 
292  if( doSaveSchematic )
293  {
294  payload = "";
295  Kiway().ExpressMail( FRAME_SCH, MAIL_SCH_SAVE, payload );
296 
297  if( payload == "success" )
298  SetStatusText( _( "Schematic saved" ), 1 );
299  }
300 
301  // Changes are saved, so reset the flag
302  m_modified = false;
303 
304  return true;
305 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
void FormatCvpcbNetlist(OUTPUTFORMATTER *aOut)
Definition: pcb_netlist.h:287
void SetStatusText(const wxString &aText, int aNumber=0) override
const std::string & GetString()
Definition: richio.h:476
VTBL_ENTRY void ExpressMail(FRAME_T aDestination, MAIL_T aCommand, std::string &aPayload, wxWindow *aSource=NULL)
Function ExpressMail send aPayload to aDestination from aSource.
Definition: kiway.cpp:437
#define _(s)
Definition: 3d_actions.cpp:33
STRING_FORMATTER implements OUTPUTFORMATTER to a memory buffer.
Definition: richio.h:446

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

Referenced by canCloseWindow(), and CVPCB_CONTROL::SaveAssociations().

◆ SaveProjectSettings()

virtual void EDA_BASE_FRAME::SaveProjectSettings ( )
inlinevirtualinherited

Save changes to the project settings to the project (.pro) file.

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

Parameters
aAskForSave= true to open a dialog before saving the settings

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 417 of file eda_base_frame.h.

417 {};

Referenced by DIALOG_PAGES_SETTINGS::OnOkClick().

◆ SaveSettings()

void CVPCB_MAINFRAME::SaveSettings ( APP_SETTINGS_BASE aCfg)
overridevirtual

Saves common frame parameters to a configuration data file.

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 456 of file cvpcb_mainframe.cpp.

457 {
459 
460  auto cfg = static_cast<CVPCB_SETTINGS*>( aCfg );
461  cfg->m_FilterFootprint = m_filteringOptions;
462 
463  cfg->m_LibrariesWidth = m_libListBox->GetSize().x;
464  cfg->m_FootprintsWidth = m_footprintListBox->GetSize().x;
465 }
virtual void SaveSettings(APP_SETTINGS_BASE *aCfg)
Saves common frame parameters to a configuration data file.
LIBRARY_LISTBOX * m_libListBox
FOOTPRINTS_LISTBOX * m_footprintListBox

References m_filteringOptions, m_footprintListBox, m_libListBox, and EDA_BASE_FRAME::SaveSettings().

◆ SaveWindowSettings()

void EDA_BASE_FRAME::SaveWindowSettings ( WINDOW_SETTINGS aCfg)
inherited

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

Definition at line 560 of file eda_base_frame.cpp.

561 {
562  wxString text;
563 
564  if( IsIconized() )
565  return;
566 
567  wxString baseCfgName = ConfigBaseName();
568 
569  // If the window is maximized, we use the saved window size from before it was maximized
570  if( IsMaximized() )
571  {
574  }
575  else
576  {
578  m_FramePos = GetPosition();
579  }
580 
581  aCfg->state.pos_x = m_FramePos.x;
582  aCfg->state.pos_y = m_FramePos.y;
583  aCfg->state.size_x = m_FrameSize.x;
584  aCfg->state.size_y = m_FrameSize.y;
585  aCfg->state.maximized = IsMaximized();
586  aCfg->state.display = wxDisplay::GetFromWindow( this );
587 
588  wxLogTrace( traceDisplayLocation, "Saving window maximized: %s", IsMaximized() ? "true" : "false" );
589  wxLogTrace( traceDisplayLocation, "Saving config position (%d, %d) with size (%d, %d)",
591 
592  // TODO(JE) should auto-save in common settings be overwritten by every app?
593  if( m_hasAutoSave )
594  Pgm().GetCommonSettings()->m_System.autosave_interval = m_autoSaveInterval;
595 
596  // Once this is fully implemented, wxAuiManager will be used to maintain
597  // the persistance of the main frame and all it's managed windows and
598  // all of the legacy frame persistence position code can be removed.
599  aCfg->perspective = m_auimgr.SavePerspective().ToStdString();
600 
601  aCfg->mru_path = m_mruPath;
602 }
wxString mru_path
Definition: app_settings.h:84
wxString m_mruPath
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxAuiManager m_auimgr
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
wxSize m_NormalFrameSize
wxString perspective
Definition: app_settings.h:85
wxSize GetWindowSize()
Get the undecorated window size that can be used for restoring the window size.
wxString ConfigBaseName() override
WINDOW_STATE state
Definition: app_settings.h:83
unsigned int display
Definition: app_settings.h:75
wxPoint m_NormalFramePos

References EDA_BASE_FRAME::ConfigBaseName(), WINDOW_STATE::display, EDA_BASE_FRAME::GetWindowSize(), EDA_BASE_FRAME::m_auimgr, EDA_BASE_FRAME::m_autoSaveInterval, EDA_BASE_FRAME::m_FramePos, EDA_BASE_FRAME::m_FrameSize, EDA_BASE_FRAME::m_hasAutoSave, EDA_BASE_FRAME::m_mruPath, EDA_BASE_FRAME::m_NormalFramePos, EDA_BASE_FRAME::m_NormalFrameSize, WINDOW_STATE::maximized, WINDOW_SETTINGS::mru_path, WINDOW_SETTINGS::perspective, Pgm(), WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, WINDOW_STATE::size_x, WINDOW_STATE::size_y, WINDOW_SETTINGS::state, and traceDisplayLocation.

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ SendMessageToEESCHEMA()

void CVPCB_MAINFRAME::SendMessageToEESCHEMA ( bool  aClearHighligntOnly = false)

Function SendMessageToEESCHEMA Send a remote command to Eeschema via a socket, Commands are $PART: "reference" put cursor on component anchor.

Parameters
aClearHighligntOnly= true if the message to send is only "clear highlight" (used when exiting Cvpcb)

Definition at line 803 of file cvpcb_mainframe.cpp.

804 {
805  if( m_netlist.IsEmpty() )
806  return;
807 
808  // clear highlight of previously selected components (if any):
809  // Selecting a non existing symbol clears any previously highlighted symbols
810  std::string packet = "$CLEAR: \"HIGHLIGHTED\"";
811 
812  if( Kiface().IsSingle() )
813  SendCommand( MSG_TO_SCH, packet.c_str() );
814  else
815  Kiway().ExpressMail( FRAME_SCH, MAIL_CROSS_PROBE, packet, this );
816 
817  if( aClearHighligntOnly )
818  return;
819 
820  int selection = m_compListBox->GetSelection();
821<