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 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, ASOC_COMPONENTS }
 Criteria to use to identify sets of components. More...
 
enum  HOLDER_TYPE { DIALOG, FRAME, PANEL, SCREEN }
 

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...
 
DISPLAY_FOOTPRINTS_FRAMEGetFootprintViewerFrame ()
 
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...
 
void OnCloseWindow (wxCloseEvent &Event)
 OnCloseWindow. More...
 
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...
 
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 LoadProjectFile ()
 Function LoadProjectFile reads the CvPcb configuration parameter from the project (.pro) file aFileName. More...
 
void SaveProjectFile ()
 Function SaveProjectFile Saves the CvPcb configuration parameter from the project (.pro) file aFileName. More...
 
void LoadSettings (wxConfigBase *aCfg) override
 Load common frame parameters from a configuration file. More...
 
void SaveSettings (wxConfigBase *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...
 
PARAM_CFG_ARRAYGetProjectFileParameters (void)
 Function GetProjectFileParameters return project file parameter list for CvPcb. 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
 
void SyncToolbars () override
 Syncronize the toolbar state with the current tool state. 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 ()
 
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_T GetUserUnits () const
 Return the user units currently in use. More...
 
void SetUserUnits (EDA_UNITS_T aUnits)
 
void ChangeUserUnits (EDA_UNITS_T aUnits)
 
TOOL_MANAGERGetToolManager () const
 Return the MVC controller. 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...
 
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 OnMenuOpen (wxMenuEvent &event)
 Workaround some issues in wxWidgets where the menu events aren't captured by the menus themselves. More...
 
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)
 
virtual wxConfigBase * config ()
 Returns the wxConfigBase 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...
 
wxString ConfigBaseName ()
 
virtual void SaveProjectSettings (bool aAskForSave)
 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, wxFileHistory *aFileHistory=NULL)
 Fetches the file name from the file history list. More...
 
void UpdateFileHistory (const wxString &FullFileName, wxFileHistory *aFileHistory=NULL)
 Update the list of recently opened files. More...
 
void SetMruPath (const wxString &aPath)
 
wxString GetMruPath () const
 
void AddStandardHelpMenu (wxMenuBar *aMenuBar)
 Adds the standard KiCad help menu to the menubar. More...
 
bool IsWritable (const wxFileName &aFileName)
 Checks if aFileName can be written. More...
 
void CheckForAutoSaveFile (const wxFileName &aFileName)
 Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input. More...
 
virtual void UpdateStatusBar ()
 Update the status bar information. More...
 
virtual void CommonSettingsChanged (bool aEnvVarsChanged)
 Notification event that some of the common (suite-wide) settings have changed. More...
 
virtual void RefreshCanvas ()
 Notification to refresh the drawing canvas (if any). More...
 
const wxString & GetAboutTitle () const
 
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...
 

Public Attributes

wxArrayString m_ModuleLibNames
 
wxArrayString m_EquFilesNames
 
FOOTPRINT_LISTm_FootprintsList
 

Protected Member Functions

 CVPCB_MAINFRAME (KIWAY *aKiway, wxWindow *aParent)
 
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
 
PARAM_CFG_ARRAY m_projectFileParams
 
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
 
wxString m_AboutTitle
 
wxAuiManager m_auimgr
 
wxString m_configName
 
TOOL_MANAGERm_toolManager
 
ACTIONSm_actions
 
std::vector< std::string > m_toolStack
 
bool m_immediateActions
 
bool m_dragSelects
 
bool m_moveWarpsCursor
 
bool m_hasAutoSave
 
bool m_autoSaveState
 
int m_autoSaveInterval
 
wxTimer * m_autoSaveTimer
 
wxString m_perspective
 
wxString m_mruPath
 
EDA_UNITS_T m_userUnits
 

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

wxString m_currentSearchPattern
 
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 113 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.

ASOC_COMPONENTS 

Associated components.

Definition at line 359 of file cvpcb_mainframe.h.

360  {
363  NA_COMPONENTS,
365  };
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 103 of file cvpcb_mainframe.h.

104  {
106  FILTER_ENABLE,
108  };
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 124 of file cvpcb_mainframe.h.

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 
SCREEN 

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

134  {
135  ITEM_NEXT,
136  ITEM_PREV
137  };

Constructor & Destructor Documentation

◆ CVPCB_MAINFRAME()

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

Definition at line 63 of file cvpcb_mainframe.cpp.

63  :
64  KIWAY_PLAYER( aKiway, aParent, FRAME_CVPCB, _( "Assign Footprints" ), wxDefaultPosition,
66 {
67  m_compListBox = NULL;
68  m_footprintListBox = NULL;
69  m_libListBox = NULL;
70  m_mainToolBar = NULL;
71  m_modified = false;
72  m_skipComponentSelect = false;
74  m_tcFilterString = NULL;
76  m_initialized = false;
77 
78  // Give an icon
79  wxIcon icon;
80  icon.CopyFromBitmap( KiBitmap( icon_cvpcb_xpm ) );
81  SetIcon( icon );
82 
83  SetAutoLayout( true );
84 
85  LoadSettings( config() );
86 
87  wxSize const frame_min( ConvertDialogToPixels( FRAME_MIN_SIZE_DU ) );
88 
89  SetSizeHints( frame_min );
90 
91  // Frame size and position
92  SetSize( m_FramePos.x, m_FramePos.y, m_FrameSize.x, m_FrameSize.y );
93 
94  setupTools();
97 
98  // Create list of available modules and components of the schematic
102 
103  m_auimgr.SetManagedWindow( this );
104 
105  m_auimgr.AddPane( m_mainToolBar, EDA_PANE().HToolbar().Name( "MainToolbar" ).Top().Layer(6) );
106 
107  m_auimgr.AddPane( m_libListBox, EDA_PANE().Palette().Name( "Libraries" ).Left().Layer(1)
108  .Caption( _( "Footprint Libraries" ) )
109  .BestSize( (int) ( m_FrameSize.x * 0.20 ), m_FrameSize.y ) );
110 
111  m_auimgr.AddPane( m_compListBox, EDA_PANE().Palette().Name( "Components" ).Center().Layer(0)
112  .Caption( _( "Symbol : Footprint Assignments" ) ) );
113 
114  m_auimgr.AddPane( m_footprintListBox, EDA_PANE().Palette().Name( "Footprints" ).Right().Layer(1)
115  .Caption( _( "Filtered Footprints" ) )
116  .BestSize( (int) ( m_FrameSize.x * 0.30 ), m_FrameSize.y ) );
117 
118  // Build the bottom panel, to display 2 status texts and the buttons:
119  auto bottomPanel = new wxPanel( this );
120  auto panelSizer = new wxBoxSizer( wxVERTICAL );
121 
122  wxFlexGridSizer* fgSizerStatus = new wxFlexGridSizer( 3, 1, 0, 0 );
123  fgSizerStatus->SetFlexibleDirection( wxBOTH );
124  fgSizerStatus->SetNonFlexibleGrowMode( wxFLEX_GROWMODE_SPECIFIED );
125 
126  m_statusLine1 = new wxStaticText( bottomPanel, wxID_ANY, wxEmptyString );
127  fgSizerStatus->Add( m_statusLine1, 0, 0, 5 );
128 
129  m_statusLine2 = new wxStaticText( bottomPanel, wxID_ANY, wxEmptyString );
130  fgSizerStatus->Add( m_statusLine2, 0, 0, 5 );
131 
132  m_statusLine3 = new wxStaticText( bottomPanel, wxID_ANY, wxEmptyString );
133  fgSizerStatus->Add( m_statusLine3, 0, wxBOTTOM, 3 );
134 
135  panelSizer->Add( fgSizerStatus, 1, wxEXPAND|wxLEFT, 2 );
136 
137  wxStaticLine* staticline1 = new wxStaticLine( bottomPanel );
138  panelSizer->Add( staticline1, 0, wxEXPAND, 5 );
139 
140  wxFont statusFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
141  statusFont.SetSymbolicSize( wxFONTSIZE_SMALL );
142  m_statusLine1->SetFont( statusFont );
143  m_statusLine2->SetFont( statusFont );
144  m_statusLine3->SetFont( statusFont );
145 
146  // Add buttons:
147  auto buttonsSizer = new wxBoxSizer( wxHORIZONTAL );
148  auto sdbSizer = new wxStdDialogButtonSizer();
149 
150  m_saveAndContinue = new wxButton( bottomPanel, ID_SAVE_PROJECT,
151  _( "Apply, Save Schematic && Continue" ) );
152  buttonsSizer->Add( m_saveAndContinue, 0, wxALIGN_CENTER_VERTICAL|wxRIGHT, 20 );
153 
154  auto sdbSizerOK = new wxButton( bottomPanel, wxID_OK );
155  sdbSizer->AddButton( sdbSizerOK );
156  auto sdbSizerCancel = new wxButton( bottomPanel, wxID_CANCEL );
157  sdbSizer->AddButton( sdbSizerCancel );
158  sdbSizer->Realize();
159 
160  buttonsSizer->Add( sdbSizer, 0, 0, 5 );
161  panelSizer->Add( buttonsSizer, 0, wxALIGN_RIGHT|wxALL, 5 );
162 
163  bottomPanel->SetSizer( panelSizer );
164  bottomPanel->Fit();
165 
166  sdbSizerOK->SetDefault();
167 
168  m_auimgr.AddPane( bottomPanel, EDA_PANE().HToolbar().Name( "Buttons" ).Bottom().Layer(6) );
169 
170  m_auimgr.Update();
171  m_initialized = true;
172 
173  // Connect Events
175 
176  // Start the main processing loop
177  m_toolManager->InvokeTool( "cvpcb.Control" );
178 
179  // Ensure the toolbars are sync'd properly so the filtering options display correct
180  SyncToolbars();
181 }
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
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.
virtual wxConfigBase * config()
Returns the wxConfigBase used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
wxAuiManager m_auimgr
wxStaticText * m_statusLine3
wxSize const FRAME_MIN_SIZE_DU(350, 250)
void SyncToolbars() override
Syncronize the toolbar state with the current tool state.
bool InvokeTool(TOOL_ID aToolId)
Function InvokeTool() Calls a tool by sending a tool activation event to tool of given ID.
void LoadSettings(wxConfigBase *aCfg) override
Load common frame parameters from a configuration file.
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:79
wxTextCtrl * m_tcFilterString
static FOOTPRINT_LIST * GetInstance(KIWAY &aKiway)
Factory function to return a FOOTPRINT_LIST via Kiway.
ACTION_TOOLBAR * m_mainToolBar
#define KICAD_DEFAULT_DRAWFRAME_STYLE
void ReCreateMenuBar() override
Recreates the menu bar.
void BuildFOOTPRINTS_LISTBOX()
#define _(s)
Specialization of the wxAuiPaneInfo class for KiCad panels.
LIBRARY_LISTBOX * m_libListBox
wxStaticText * m_statusLine2
FOOTPRINTS_LISTBOX * m_footprintListBox
TOOL_MANAGER * m_toolManager
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(), FRAME_MIN_SIZE_DU(), FOOTPRINT_LIST::GetInstance(), ID_SAVE_PROJECT, TOOL_MANAGER::InvokeTool(), KiBitmap(), KIWAY_HOLDER::Kiway(), PCAD2KICAD::Left, LoadSettings(), EDA_BASE_FRAME::m_auimgr, m_compListBox, m_filteringOptions, m_footprintListBox, m_FootprintsList, EDA_BASE_FRAME::m_FramePos, 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, EDA_BASE_FRAME::m_toolManager, ReCreateHToolbar(), ReCreateMenuBar(), PCAD2KICAD::Right, setupEventHandlers(), setupTools(), SyncToolbars(), and FOOTPRINTS_LISTBOX::UNFILTERED_FP_LIST.

◆ ~CVPCB_MAINFRAME()

CVPCB_MAINFRAME::~CVPCB_MAINFRAME ( )

Definition at line 184 of file cvpcb_mainframe.cpp.

185 {
186  // Be sure a active tool (if exists) is deactivated:
187  if( m_toolManager )
189 
190  // Clean up the tool infrastructure
191  delete m_actions;
192  delete m_toolManager;
193  delete m_toolDispatcher;
194 
195  m_auimgr.UnInit();
196 }
ACTIONS * m_actions
wxAuiManager m_auimgr
void DeactivateTool()
Function DeactivateTool() Deactivates the currently active tool.
TOOL_DISPATCHER * m_toolDispatcher
TOOL_MANAGER * m_toolManager

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

Member Function Documentation

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar *  aMenuBar)
inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 364 of file eda_base_frame.cpp.

365 {
366  COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
367  ACTION_MENU* helpMenu = new ACTION_MENU( false );
368 
369  helpMenu->SetTool( commonControl );
370 
371  helpMenu->Add( ACTIONS::help );
372  helpMenu->Add( ACTIONS::gettingStarted );
373  helpMenu->Add( ACTIONS::listHotKeys );
374  helpMenu->Add( ACTIONS::getInvolved );
375 
376  helpMenu->AppendSeparator();
377  helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, about_xpm );
378 
379  aMenuBar->Append( helpMenu, _( "&Help" ) );
380 }
static TOOL_ACTION listHotKeys
Definition: actions.h:166
Class ACTION_MENU.
Definition: action_menu.h:43
Class COMMON_CONTROL.
#define _(s)
static TOOL_ACTION help
Definition: actions.h:165
TOOL_MANAGER * m_toolManager
static TOOL_ACTION getInvolved
Definition: actions.h:167
static TOOL_ACTION gettingStarted
Definition: actions.h:164

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

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

◆ AssociateFootprint()

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

Associate a footprint with a specific component in the list.

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

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

425 {
426  // Ensure there is data to work with
427  COMPONENT* component;
428 
429  if( m_netlist.IsEmpty() )
430  return;
431 
432  component = m_netlist.GetComponent( aAssociation.GetComponentIndex() );
433 
434  if( component == NULL )
435  return;
436 
437  LIB_ID fpid = aAssociation.GetNewFootprint();
438  LIB_ID oldFpid = component->GetFPID();
439 
440  // Test for validity of the requested footprint
441  if( !fpid.empty() && !fpid.IsValid() )
442  {
443  wxString msg =
444  wxString::Format( _( "\"%s\" is not a valid footprint." ), fpid.Format().wx_str() );
445  DisplayErrorMessage( this, msg );
446  }
447 
448  // Set the new footprint
449  component->SetFPID( fpid );
450 
451  // create the new component description and set it
452  wxString description = wxString::Format( CMP_FORMAT, aAssociation.GetComponentIndex() + 1,
453  GetChars( component->GetReference() ), GetChars( component->GetValue() ),
454  GetChars( FROM_UTF8( component->GetFPID().Format().c_str() ) ) );
455  m_compListBox->SetString( aAssociation.GetComponentIndex(), description );
456 
457  // Mark the data as being modified
458  m_modified = true;
459 
460  // Update the statusbar and refresh the list
461  DisplayStatus();
462  m_compListBox->Refresh();
463 
464  if( !aAddUndoItem )
465  return;
466 
467  // Update the undo list
468  if ( aNewEntry )
469  {
470  // Create a new entry for this association
471  CVPCB_UNDO_REDO_ENTRIES newEntry;
472  newEntry.emplace_back( CVPCB_ASSOCIATION( aAssociation.GetComponentIndex(), oldFpid,
473  aAssociation.GetNewFootprint() ) );
474  m_undoList.emplace_back( newEntry );
475 
476  // Clear the redo list
477  m_redoList.clear();
478  }
479  else
480  m_undoList.back().emplace_back( CVPCB_ASSOCIATION( aAssociation.GetComponentIndex(),
481  oldFpid, aAssociation.GetNewFootprint() ) );
482 
483 }
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:62
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:258
#define CMP_FORMAT
The print format to display a schematic component line.
void SetFPID(const LIB_ID &aFPID)
Definition: pcb_netlist.h:155
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 char * c_str() const
Definition: utf8.h:107
const LIB_ID & GetFPID() const
Definition: pcb_netlist.h:166
unsigned int GetComponentIndex() const
Get the index of the component to modify the association of.
const wxString & GetReference() const
Definition: pcb_netlist.h:151
CVPCB_UNDO_REDO_LIST m_undoList
#define _(s)
UTF8 Format() const
Definition: lib_id.cpp:237
Class COMPONENT is used to store components and all of their related information found in a netlist.
Definition: pcb_netlist.h:83
COMPONENT * GetComponent(unsigned aIndex)
Function GetComponent returns the COMPONENT at aIndex.
Definition: pcb_netlist.h:265
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:101
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:205
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:244
const wxString & GetValue() const
Definition: pcb_netlist.h:153
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 _, UTF8::c_str(), CMP_FORMAT, DisplayErrorMessage(), DisplayStatus(), LIB_ID::empty(), LIB_ID::Format(), Format(), FROM_UTF8(), GetChars(), NETLIST::GetComponent(), CVPCB_ASSOCIATION::GetComponentIndex(), COMPONENT::GetFPID(), CVPCB_ASSOCIATION::GetNewFootprint(), COMPONENT::GetReference(), COMPONENT::GetValue(), NETLIST::IsEmpty(), LIB_ID::IsValid(), m_compListBox, m_modified, m_netlist, m_redoList, m_undoList, 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 165 of file auto_associate.cpp.

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

References _, AssociateFootprint(), buildEquivalenceList(), LIB_ID::empty(), GetChars(), 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 810 of file cvpcb_mainframe.cpp.

811 {
812  wxString msg;
813  COMPONENT* component;
814  wxFont guiFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
815 
816  if( m_compListBox == NULL )
817  {
819  wxDefaultPosition, wxDefaultSize );
820  m_compListBox->SetFont( wxFont( guiFont.GetPointSize(),
821  wxFONTFAMILY_MODERN,
822  wxFONTSTYLE_NORMAL,
823  wxFONTWEIGHT_NORMAL ) );
824  }
825 
827 
828  for( unsigned i = 0; i < m_netlist.GetCount(); i++ )
829  {
830  component = m_netlist.GetComponent( i );
831 
832  msg.Printf( CMP_FORMAT, m_compListBox->GetCount() + 1,
833  GetChars( component->GetReference() ),
834  GetChars( component->GetValue() ),
835  GetChars( FROM_UTF8( component->GetFPID().Format().c_str() ) ) );
836  m_compListBox->m_ComponentList.Add( msg );
837  }
838 
839  if( m_compListBox->m_ComponentList.Count() )
840  {
841  m_compListBox->SetItemCount( m_compListBox->m_ComponentList.Count() );
842  m_compListBox->SetSelection( 0, true );
843  m_compListBox->RefreshItems( 0L, m_compListBox->m_ComponentList.Count()-1 );
845  }
846 }
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:62
#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:256
const char * c_str() const
Definition: utf8.h:107
const LIB_ID & GetFPID() const
Definition: pcb_netlist.h:166
void UpdateWidth(int aLine=-1)
const wxString & GetReference() const
Definition: pcb_netlist.h:151
UTF8 Format() const
Definition: lib_id.cpp:237
Class COMPONENT is used to store components and all of their related information found in a netlist.
Definition: pcb_netlist.h:83
COMPONENT * GetComponent(unsigned aIndex)
Function GetComponent returns the COMPONENT at aIndex.
Definition: pcb_netlist.h:265
wxArrayString m_ComponentList
Definition: listboxes.h:200
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:101
size_t i
Definition: json11.cpp:597
const wxString & GetValue() const
Definition: pcb_netlist.h:153

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

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 78 of file auto_associate.cpp.

79 {
80  char line[1024];
81  int error_count = 0;
82  FILE* file;
83  wxFileName fn;
84  wxString tmp, error_msg;
85 
86  SEARCH_STACK& search = Kiface().KifaceSearch();
87 
88  // Find equivalences in all available files, and populates the
89  // equiv_List with all equivalences found in .equ files
90  for( unsigned ii = 0; ii < m_EquFilesNames.GetCount(); ii++ )
91  {
92  fn = wxExpandEnvVars( m_EquFilesNames[ii] );
93 
94  tmp = search.FindValidPath( fn.GetFullPath() );
95 
96  if( !tmp )
97  {
98  error_count++;
99 
100  if( aErrorMessages )
101  {
102  error_msg.Printf( _( "Equivalence file \"%s\" could not be found in the "
103  "default search paths." ),
104  GetChars( fn.GetFullName() ) );
105 
106  if( ! aErrorMessages->IsEmpty() )
107  *aErrorMessages << wxT("\n\n");
108 
109  *aErrorMessages += error_msg;
110  }
111 
112  continue;
113  }
114 
115  file = wxFopen( tmp, wxT( "rt" ) );
116 
117  if( file == NULL )
118  {
119  error_count++;
120 
121  if( aErrorMessages )
122  {
123  error_msg.Printf( _( "Error opening equivalence file \"%s\"." ), GetChars( tmp ) );
124 
125  if( ! aErrorMessages->IsEmpty() )
126  *aErrorMessages << wxT("\n\n");
127 
128  *aErrorMessages += error_msg;
129  }
130 
131  continue;
132  }
133 
134  while( GetLine( file, line, NULL, sizeof( line ) ) != NULL )
135  {
136  if( *line == 0 )
137  continue;
138 
139  wxString wtext = FROM_UTF8( line );
140  wxString value = GetQuotedText( wtext );
141 
142  if( value.IsEmpty() )
143  continue;
144 
145  wxString footprint = GetQuotedText( wtext );
146 
147  if( footprint.IsEmpty() )
148  continue;
149 
150  value.Replace( wxT( " " ), wxT( "_" ) );
151 
152  FOOTPRINT_EQUIVALENCE* equivItem = new FOOTPRINT_EQUIVALENCE();
153  equivItem->m_ComponentValue = value;
154  equivItem->m_FootprintFPID = footprint;
155  aList.push_back( equivItem );
156  }
157 
158  fclose( file );
159  }
160 
161  return error_count;
162 }
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:62
wxString GetQuotedText(wxString &text)
wxArrayString m_EquFilesNames
Class SEARCH_STACK looks for files in a number of places.
Definition: search_stack.h:41
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:51
SEARCH_STACK & KifaceSearch()
Only for DSO specific 'non-library' files.
Definition: kiface_i.h:127
#define _(s)
char * GetLine(FILE *File, char *Line, int *LineNum, int SizeLine)
Read one line line from aFile.
Definition: string.cpp:317
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:101

References _, SEARCH_STACK::FindValidPath(), FROM_UTF8(), GetChars(), GetLine(), GetQuotedText(), Kiface(), KIFACE_I::KifaceSearch(), FOOTPRINT_EQUIVALENCE::m_ComponentValue, m_EquFilesNames, and FOOTPRINT_EQUIVALENCE::m_FootprintFPID.

Referenced by AutomaticFootprintMatching().

◆ BuildFOOTPRINTS_LISTBOX()

void CVPCB_MAINFRAME::BuildFOOTPRINTS_LISTBOX ( )

Definition at line 790 of file cvpcb_mainframe.cpp.

791 {
792  wxFont guiFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
793 
794  if( m_footprintListBox == NULL )
795  {
797  wxDefaultPosition, wxDefaultSize );
798  m_footprintListBox->SetFont( wxFont( guiFont.GetPointSize(),
799  wxFONTFAMILY_MODERN,
800  wxFONTSTYLE_NORMAL,
801  wxFONTWEIGHT_NORMAL ) );
802  }
803 
804  m_footprintListBox->SetFootprints( *m_FootprintsList, wxEmptyString, NULL,
806  DisplayStatus();
807 }
FOOTPRINT_LIST * m_FootprintsList
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, 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 849 of file cvpcb_mainframe.cpp.

850 {
851  wxFont guiFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
852 
853  if( m_libListBox == NULL )
854  {
856  wxDefaultPosition, wxDefaultSize );
857  m_libListBox->SetFont( wxFont( guiFont.GetPointSize(),
858  wxFONTFAMILY_MODERN,
859  wxFONTSTYLE_NORMAL,
860  wxFONTWEIGHT_NORMAL ) );
861  }
862 
863  FP_LIB_TABLE* tbl = Prj().PcbFootprintLibs( Kiway() );
864 
865  if( tbl )
866  {
867  wxArrayString libNames;
868 
869  std::vector< wxString > libNickNames = tbl->GetLogicalLibs();
870 
871  for( unsigned ii = 0; ii < libNickNames.size(); ii++ )
872  libNames.Add( libNickNames[ii] );
873 
874  m_libListBox->SetLibraryList( libNames );
875  }
876 }
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
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.
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, PROJECT::PcbFootprintLibs(), KIWAY_HOLDER::Prj(), and LIBRARY_LISTBOX::SetLibraryList().

Referenced by CVPCB_MAINFRAME(), and ReadNetListAndFpFiles().

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS_T  aUnits)
inlineinherited

Definition at line 213 of file eda_base_frame.h.

214  {
215  SetUserUnits( aUnits );
217  }
void SetUserUnits(EDA_UNITS_T aUnits)
virtual void unitsChangeRefresh()
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...

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

Referenced by COMMON_TOOLS::ImperialUnits(), COMMON_TOOLS::MetricUnits(), 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 687 of file eda_base_frame.cpp.

688 {
689  wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
690 
691  wxFileName autoSaveFileName = aFileName;
692 
693  // Check for auto save file.
694  autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
695 
696  wxLogTrace( traceAutoSave,
697  wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
698 
699  if( !autoSaveFileName.FileExists() )
700  return;
701 
702  wxString msg = wxString::Format( _(
703  "Well this is potentially embarrassing!\n"
704  "It appears that the last time you were editing the file\n"
705  "\"%s\"\n"
706  "it was not saved properly. Do you wish to restore the last saved edits you made?" ),
707  GetChars( aFileName.GetFullName() )
708  );
709 
710  int response = wxMessageBox( msg, Pgm().App().GetAppName(), wxYES_NO | wxICON_QUESTION, this );
711 
712  // Make a backup of the current file, delete the file, and rename the auto save file to
713  // the file name.
714  if( response == wxYES )
715  {
716  // Get the backup file name.
717  wxFileName backupFileName = aFileName;
718  backupFileName.SetExt( aFileName.GetExt() + GetBackupSuffix() );
719 
720  // If an old backup file exists, delete it. If an old copy of the file exists, rename
721  // it to the backup file name
722  if( aFileName.FileExists() )
723  {
724  // Rename the old file to the backup file name.
725  if( !wxRenameFile( aFileName.GetFullPath(), backupFileName.GetFullPath(), true ) )
726  {
727  msg.Printf( _( "Could not create backup file \"%s\"" ),
728  GetChars( backupFileName.GetFullPath() ) );
729  wxMessageBox( msg );
730  }
731  }
732 
733  if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
734  {
735  wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
736  Pgm().App().GetAppName(), wxOK | wxICON_EXCLAMATION, this );
737  }
738  }
739  else
740  {
741  wxLogTrace( traceAutoSave,
742  wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
743 
744  // Remove the auto save file when using the previous file as is.
745  wxRemoveFile( autoSaveFileName.GetFullPath() );
746  }
747 }
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: kicad.cpp:65
static wxString GetBackupSuffix()
#define _(s)
static wxString GetAutoSaveFilePrefix()
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:101
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:205

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

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

◆ CommonSettingsChanged()

void EDA_BASE_FRAME::CommonSettingsChanged ( bool  aEnvVarsChanged)
virtualinherited

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

Update menus, toolbars, local variables, etc.

Reimplemented in SCH_EDIT_FRAME, PCB_EDIT_FRAME, GERBVIEW_FRAME, LIB_EDIT_FRAME, PCB_BASE_FRAME, FOOTPRINT_EDIT_FRAME, EDA_3D_VIEWER, EDA_DRAW_FRAME, KICAD_MANAGER_FRAME, FOOTPRINT_VIEWER_FRAME, and LIB_VIEW_FRAME.

Definition at line 393 of file eda_base_frame.cpp.

394 {
396 
397  if( GetMenuBar() )
398  {
399  // For icons in menus, icon scaling & hotkeys
400  ReCreateMenuBar();
401  GetMenuBar()->Refresh();
402  }
403 
404  wxConfigBase* settings = Pgm().CommonSettings();
405 
406  settings->Read( WARP_MOUSE_ON_MOVE_KEY, &m_moveWarpsCursor );
407  settings->Read( PREFER_SELECT_TO_DRAG_KEY, &m_dragSelects );
408  settings->Read( IMMEDIATE_ACTIONS_KEY, &m_immediateActions );
409 }
#define IMMEDIATE_ACTIONS_KEY
Definition: pgm_base.h:59
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
#define PREFER_SELECT_TO_DRAG_KEY
Definition: pgm_base.h:60
void UpdateHotKeys(bool aFullUpdate)
Function UpdateHotKeys() Optionally reads the hotkey config files and then rebuilds the internal hotk...
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: kicad.cpp:65
VTBL_ENTRY wxConfigBase * CommonSettings() const
Definition: pgm_base.h:204
ACTION_MANAGER * GetActionManager()
Definition: tool_manager.h:154
#define WARP_MOUSE_ON_MOVE_KEY
Definition: pgm_base.h:58
virtual void ReCreateMenuBar()
Recreates the menu bar.

References PGM_BASE::CommonSettings(), TOOL_MANAGER::GetActionManager(), EDA_BASE_FRAME::GetToolManager(), IMMEDIATE_ACTIONS_KEY, EDA_BASE_FRAME::m_dragSelects, EDA_BASE_FRAME::m_immediateActions, EDA_BASE_FRAME::m_moveWarpsCursor, Pgm(), PREFER_SELECT_TO_DRAG_KEY, EDA_BASE_FRAME::ReCreateMenuBar(), ACTION_MANAGER::UpdateHotKeys(), and WARP_MOUSE_ON_MOVE_KEY.

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

◆ config()

wxConfigBase * EDA_BASE_FRAME::config ( )
virtualinherited

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

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 535 of file eda_base_frame.cpp.

536 {
537  // KICAD_MANAGER_FRAME overrides this
538  wxConfigBase* ret = Kiface().KifaceSettings();
539  //wxASSERT( ret );
540  return ret;
541 }
wxConfigBase * KifaceSettings() const
Definition: kiface_i.h:103
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:51

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

Referenced by CVPCB_MAINFRAME(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), PCB_EDIT_FRAME::GetSettings(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), SIM_PLOT_FRAME::onClose(), FOOTPRINT_WIZARD_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OpenProjectFiles(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), and EDA_BASE_FRAME::windowClosing().

◆ ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )
inlineinherited
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.

Definition at line 337 of file eda_base_frame.h.

338  {
339  wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
340  return baseCfgName;
341  }
wxString m_configName

References EDA_BASE_FRAME::m_configName.

Referenced by DISPLAY_FOOTPRINTS_FRAME::LoadSettings(), FOOTPRINT_VIEWER_FRAME::LoadSettings(), EDA_BASE_FRAME::LoadSettings(), EDA_DRAW_FRAME::LoadSettings(), DISPLAY_FOOTPRINTS_FRAME::SaveSettings(), FOOTPRINT_VIEWER_FRAME::SaveSettings(), EDA_BASE_FRAME::SaveSettings(), EDA_DRAW_FRAME::SaveSettings(), and ACTION_MANAGER::UpdateHotKeys().

◆ CurrentToolName()

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

Definition at line 219 of file eda_base_frame.cpp.

220 {
221  if( m_toolStack.empty() )
222  return ACTIONS::selectionTool.GetName();
223  else
224  return m_toolStack.back();
225 }
std::vector< std::string > m_toolStack
static TOOL_ACTION selectionTool
Definition: actions.h:142

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

◆ Destroy()

◆ DismissModal()

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

Definition at line 160 of file kiway_player.cpp.

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

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_WIZARD_FRAME::ExportSelectedFootprint(), LIB_VIEW_FRAME::FinishModal(), LIB_VIEW_FRAME::OnCloseWindow(), FOOTPRINT_VIEWER_FRAME::OnCloseWindow(), and FOOTPRINT_WIZARD_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 580 of file cvpcb_mainframe.cpp.

581 {
582  if( !m_initialized )
583  return;
584 
585  wxString filters, msg;
586  COMPONENT* component = GetSelectedComponent();
587 
589  {
590  msg.Empty();
591 
592  if( component )
593  {
594  for( unsigned ii = 0; ii < component->GetFootprintFilters().GetCount(); ii++ )
595  {
596  if( msg.IsEmpty() )
597  msg += component->GetFootprintFilters()[ii];
598  else
599  msg += wxT( ", " ) + component->GetFootprintFilters()[ii];
600  }
601  }
602 
603  filters += _( "key words" ) + wxString::Format( wxT( " (%s)" ), msg );
604  }
605 
607  {
608  msg.Empty();
609 
610  if( component )
611  msg = wxString::Format( wxT( "%i" ), component->GetPinCount() );
612 
613  if( !filters.IsEmpty() )
614  filters += wxT( ", " );
615 
616  filters += _( "pin count" ) + wxString::Format( wxT( " (%s)" ), msg );
617  }
618 
620  {
622 
623  if( !filters.IsEmpty() )
624  filters += wxT( ", " );
625 
626  filters += _( "library" ) + wxString::Format( wxT( " (%s)" ), msg );
627  }
628 
630  {
631  if( !filters.IsEmpty() )
632  filters += wxT( ", " );
633 
634  filters += _( "search text" );
635  }
636 
637  if( filters.IsEmpty() )
638  msg = _( "No filtering" );
639  else
640  msg.Printf( _( "Filtered by %s" ), GetChars( filters ) );
641 
642  msg << wxT( ": " ) << m_footprintListBox->GetCount();
643 
644  SetStatusText( msg );
645 
646 
647  msg.Empty();
648  wxString footprintName = GetSelectedFootprint();
649 
650  FOOTPRINT_INFO* module = m_FootprintsList->GetModuleInfo( footprintName );
651 
652  if( module ) // can be NULL if no netlist loaded
653  {
654  msg = wxString::Format( _( "Description: %s; Key words: %s" ),
655  module->GetDescription(),
656  module->GetKeywords() );
657  }
658 
659  SetStatusText( msg, 1 );
660 
661  msg.Empty();
662  wxString lib;
663 
664  // Choose the footprint to get the information on
665  if( module )
666  {
667  // Use the footprint in the footprint viewer
668  lib = module->GetLibNickname();
669  }
671  {
672  // Use the footprint of the selected component
673  if( component )
674  lib = component->GetFPID().GetLibNickname();
675  }
677  {
678  // Use the library that is selected
680  }
681 
682  // Extract the library information
683  FP_LIB_TABLE* fptbl = Prj().PcbFootprintLibs( Kiway() );
684 
685  if( fptbl->HasLibrary( lib ) )
686  msg = wxString::Format( _( "Library location: %s" ), fptbl->GetFullURI( lib ) );
687  else
688  msg = wxString::Format( _( "Library location: unknown" ) );
689 
690  SetStatusText( msg, 2 );
691 }
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
const wxString & GetDescription() override
const LIB_ID & GetFPID() const
Definition: pcb_netlist.h:166
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
const wxString & GetKeywords()
#define _(s)
LIBRARY_LISTBOX * m_libListBox
Class COMPONENT is used to store components and all of their related information found in a netlist.
Definition: pcb_netlist.h:83
VTBL_ENTRY FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
wxString GetSelectedFootprint()
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:101
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:205
COMPONENT * GetSelectedComponent()
Get the selected component from the component listbox.
FOOTPRINTS_LISTBOX * m_footprintListBox
int GetPinCount() const
Definition: pcb_netlist.h:184
const wxArrayString & GetFootprintFilters() const
Definition: pcb_netlist.h:177
CVPCB_MAINFRAME::CONTROL_TYPE GetFocusedControl()
Find out which control currently has focus.

References _, CONTROL_COMPONENT, CONTROL_LIBRARY, FOOTPRINTS_LISTBOX::FILTERING_BY_COMPONENT_KEYWORD, FOOTPRINTS_LISTBOX::FILTERING_BY_LIBRARY, FOOTPRINTS_LISTBOX::FILTERING_BY_NAME, FOOTPRINTS_LISTBOX::FILTERING_BY_PIN_COUNT, Format(), GetChars(), 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, PROJECT::PcbFootprintLibs(), KIWAY_HOLDER::Prj(), and SetStatusText().

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

◆ DisplayToolMsg()

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

Reimplemented in EDA_DRAW_FRAME.

Definition at line 237 of file eda_base_frame.h.

237 {};

Referenced by EDA_BASE_FRAME::PopTool(), and EDA_BASE_FRAME::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 302 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const
inlineinherited

Definition at line 467 of file eda_base_frame.h.

467 { return m_AboutTitle; }
wxString m_AboutTitle

References EDA_BASE_FRAME::m_AboutTitle.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT().

◆ GetAutoSaveFilePrefix()

static wxString EDA_BASE_FRAME::GetAutoSaveFilePrefix ( )
inlinestaticprotectedinherited
Returns
the string to prepend to a file name for automatic save.

Definition at line 166 of file eda_base_frame.h.

167  {
168  return wxT( "_autosave-" );
169  }

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

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const
inlineinherited

Definition at line 282 of file eda_base_frame.h.

282 { 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 158 of file eda_base_frame.h.

159  {
160  return wxT( "-bak" );
161  }

Referenced by EDA_BASE_FRAME::CheckForAutoSaveFile(), PCB_EDIT_FRAME::createBackupFile(), PCB_EDIT_FRAME::Files_io_from_id(), and SCH_EDIT_FRAME::SaveEEFile().

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

911 {
912  std::vector<unsigned int> idx;
913 
914  // Make sure a netlist has been loaded and the box has contents
915  if( m_netlist.IsEmpty() || m_compListBox->GetCount() == 0 )
916  return idx;
917 
918  switch( aCriteria )
919  {
921  idx.resize( m_netlist.GetCount() );
922  std::iota( idx.begin(), idx.end(), 0 );
923  break;
924 
926  {
927  // Check to see if anything is selected
928  if( m_compListBox->GetSelectedItemCount() < 1 )
929  break;
930 
931  // Get the components
932  int lastIdx = m_compListBox->GetFirstSelected();
933  idx.emplace_back( lastIdx );
934 
935  lastIdx = m_compListBox->GetNextSelected( lastIdx );
936  while( lastIdx > 0 )
937  {
938  idx.emplace_back( lastIdx );
939  lastIdx = m_compListBox->GetNextSelected( lastIdx );
940  }
941  break;
942  }
944  for( unsigned int i = 0; i < m_netlist.GetCount(); i++ )
945  {
946  if( m_netlist.GetComponent( i )->GetFPID().empty() )
947  idx.emplace_back( i );
948  }
949  break;
950 
952  for( unsigned int i = 0; i < m_netlist.GetCount(); i++ )
953  {
954  if( !m_netlist.GetComponent( i )->GetFPID().empty() )
955  idx.emplace_back( i );
956  }
957  break;
958 
959  default:
960  wxASSERT_MSG( false, "Invalid component selection criteria" );
961  }
962 
963  return idx;
964 }
COMPONENTS_LISTBOX * m_compListBox
unsigned GetCount() const
Function GetCount.
Definition: pcb_netlist.h:256
bool empty() const
Definition: lib_id.h:186
const LIB_ID & GetFPID() const
Definition: pcb_netlist.h:166
COMPONENT * GetComponent(unsigned aIndex)
Function GetComponent returns the COMPONENT at aIndex.
Definition: pcb_netlist.h:265
size_t i
Definition: json11.cpp:597
bool IsEmpty() const
Function IsEmpty()
Definition: pcb_netlist.h:244
Not associated components.

References ALL_COMPONENTS, ASOC_COMPONENTS, LIB_ID::empty(), NETLIST::GetComponent(), COMPONENTS_LISTBOX::GetCount(), NETLIST::GetCount(), COMPONENT::GetFPID(), i, NETLIST::IsEmpty(), m_compListBox, m_netlist, NA_COMPONENTS, and SEL_COMPONENTS.

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

◆ GetDoImmediateActions()

bool EDA_BASE_FRAME::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 243 of file eda_base_frame.h.

243 { return m_immediateActions; }

References EDA_BASE_FRAME::m_immediateActions.

◆ GetDragSelects()

bool EDA_BASE_FRAME::GetDragSelects ( ) const
inlineinherited

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

Definition at line 249 of file eda_base_frame.h.

249 { return m_dragSelects; }

References EDA_BASE_FRAME::m_dragSelects.

Referenced by EE_SELECTION_TOOL::Main().

◆ GetFileFromHistory()

wxString EDA_BASE_FRAME::GetFileFromHistory ( int  cmdId,
const wxString &  type,
wxFileHistory *  aFileHistory = NULL 
)
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 wxFileHistory::UseMenu was called at init time

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

Definition at line 574 of file eda_base_frame.cpp.

576 {
577  wxFileHistory* fileHistory = aFileHistory;
578 
579  if( !fileHistory )
580  fileHistory = &Kiface().GetFileHistory();
581 
582  int baseId = fileHistory->GetBaseId();
583 
584  wxASSERT( cmdId >= baseId && cmdId < baseId + (int) fileHistory->GetCount() );
585 
586  unsigned i = cmdId - baseId;
587 
588  if( i < fileHistory->GetCount() )
589  {
590  wxString fn = fileHistory->GetHistoryFile( i );
591 
592  if( wxFileName::FileExists( fn ) )
593  return fn;
594  else
595  {
596  wxString msg = wxString::Format( _( "File \"%s\" was not found." ), fn );
597  wxMessageBox( msg );
598 
599  fileHistory->RemoveFileFromHistory( i );
600  }
601  }
602 
603  return wxEmptyString;
604 }
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:51
#define _(s)
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:205
FILE_HISTORY & GetFileHistory()
Definition: kiface_i.h:123
size_t i
Definition: json11.cpp:597

References _, Format(), KIFACE_I::GetFileHistory(), i, and Kiface().

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

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

976 {
977  if( m_libListBox->HasFocus() )
979  else if( m_compListBox->HasFocus() )
981  else if( m_footprintListBox->HasFocus() )
983 
985 }
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 988 of file cvpcb_mainframe.cpp.

989 {
990  if( m_libListBox->HasFocus() )
991  return m_libListBox;
992  else if( m_compListBox->HasFocus() )
993  return m_compListBox;
994  else if( m_footprintListBox->HasFocus() )
995  return m_footprintListBox;
996 
997  return nullptr;
998 }
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 ( )
Returns
a pointer on the Footprint Viewer frame, if exists, or NULL

Definition at line 967 of file cvpcb_mainframe.cpp.

968 {
969  // returns the Footprint Viewer frame, if exists, or NULL
970  return dynamic_cast<DISPLAY_FOOTPRINTS_FRAME*>
971  ( wxWindow::FindWindowByName( FOOTPRINTVIEWER_FRAME_NAME ) );
972 }
#define FOOTPRINTVIEWER_FRAME_NAME

References FOOTPRINTVIEWER_FRAME_NAME.

Referenced by OnCloseWindow(), refreshAfterComponentSearch(), and CVPCB_CONTROL::ShowFootprintViewer().

◆ GetMoveWarpsCursor()

bool EDA_BASE_FRAME::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 255 of file eda_base_frame.h.

255 { return m_moveWarpsCursor; }

References EDA_BASE_FRAME::m_moveWarpsCursor.

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

◆ GetMruPath()

wxString EDA_BASE_FRAME::GetMruPath ( ) const
inlineinherited

◆ GetProjectFileParameters()

PARAM_CFG_ARRAY & CVPCB_MAINFRAME::GetProjectFileParameters ( void  )

Function GetProjectFileParameters return project file parameter list for CvPcb.

Populate the project file parameter array specific to CvPcb if it hasn't already been populated and return a reference to the array to the caller. Creating the parameter list at run time has the advantage of being able to define local variables. The old method of statically building the array at compile time requiring global variable definitions.

Returns
A reference to a PARAM_CFG_ARRAY contain the project settings for CvPcb.

Definition at line 36 of file cfg.cpp.

37 {
38  if( !m_projectFileParams.empty() )
39  return m_projectFileParams;
40 
42 
44  wxT( "EquName" ), &m_EquFilesNames, GROUP_CVP_EQU ) );
45 
46  return m_projectFileParams;
47 }
wxArrayString m_EquFilesNames
Class PARAM_CFG_BASE is a base class which establishes the interface functions ReadParam and SavePara...
Definition: config_params.h:99
PARAM_CFG_ARRAY m_projectFileParams
#define GROUP_CVP_EQU
Definition: config_params.h:53
#define GROUP_PCB_LIBS
(and few for component editor).
Definition: config_params.h:48

References GROUP_CVP_EQU, GROUP_PCB_LIBS, m_EquFilesNames, m_projectFileParams, and PARAM_COMMAND_ERASE.

Referenced by LoadProjectFile(), and SaveProjectFile().

◆ GetSelectedComponent()

COMPONENT * CVPCB_MAINFRAME::GetSelectedComponent ( )

Get the selected component from the component listbox.

Returns
the selected component

Definition at line 879 of file cvpcb_mainframe.cpp.

880 {
881  int selection = m_compListBox->GetSelection();
882 
883  if( selection >= 0 && selection < (int) m_netlist.GetCount() )
884  return m_netlist.GetComponent( selection );
885 
886  return NULL;
887 }
COMPONENTS_LISTBOX * m_compListBox
unsigned GetCount() const
Function GetCount.
Definition: pcb_netlist.h:256
COMPONENT * GetComponent(unsigned aIndex)
Function GetComponent returns the COMPONENT at aIndex.
Definition: pcb_netlist.h:265

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

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

1024 {
1025  // returns the LIB_ID of the selected footprint in footprint listview
1026  // or a empty string
1028 }
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().

◆ GetToolManager()

TOOL_MANAGER* EDA_BASE_FRAME::GetToolManager ( ) const
inlineinherited

Return the MVC controller.

Definition at line 222 of file eda_base_frame.h.

222 { return m_toolManager; }
TOOL_MANAGER * m_toolManager

References EDA_BASE_FRAME::m_toolManager.

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), LIB_CONTROL::AddSymbolToSchematic(), BOARD_COMMIT::BOARD_COMMIT(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), EDA_BASE_FRAME::CommonSettingsChanged(), DIALOG_DRC_CONTROL::DelDRCMarkers(), DIALOG_MIGRATE_BUSES::DIALOG_MIGRATE_BUSES(), SCH_EDIT_FRAME::DisplayCurrentSheet(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), DIALOG_DRC_CONTROL::doSelectionMenu(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), DIALOG_DRC_CONTROL::focusOnItem(), GERBVIEW_FRAME::GERBVIEW_FRAME(), FP_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), KICAD_MANAGER_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(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_FIND::onButtonFindItemClick(), DIALOG_FIND::onButtonFindMarkerClick(), DIALOG_INSPECTOR::onCellClicked(), SIM_PLOT_FRAME::onClose(), SYMBOL_TREE_PANE::onComponentSelected(), DIALOG_DRC_CONTROL::OnDeleteOneClick(), DIALOG_ERC::OnLeftClickMarkersList(), FOOTPRINTS_LISTBOX::OnLeftDClick(), SIM_PLOT_FRAME::onProbe(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnRightUpItem(), DIALOG_PLOT::onRunDRC(), HIERARCHY_NAVIG_DLG::onSelectSheetPath(), DIALOG_FIELDS_EDITOR_GLOBAL::OnTableCellClick(), SIM_PLOT_FRAME::onTune(), DIALOG_PLOT::Plot(), EDA_BASE_FRAME::PopTool(), BOARD_COMMIT::Push(), SCH_EDIT_FRAME::PutDataInPreviousState(), PL_EDITOR_FRAME::RollbackFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), PCB_BASE_FRAME::SetFastGrid1(), PCB_BASE_FRAME::SetFastGrid2(), setupEventHandlers(), PCB_LAYER_WIDGET::SyncLayerAlphaIndicators(), DIALOG_SET_GRID::TransferDataFromWindow(), PANEL_SETUP_NETCLASSES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), EDA_DRAW_FRAME::UpdateMsgPanel(), 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(), PL_EDITOR_FRAME::SaveSettings(), and GERBVIEW_FRAME::SaveSettings().

◆ GetUserUnits()

EDA_UNITS_T EDA_BASE_FRAME::GetUserUnits ( ) const
inlineinherited

Return the user units currently in use.

Definition at line 210 of file eda_base_frame.h.

210 { return m_userUnits; }
EDA_UNITS_T m_userUnits

References EDA_BASE_FRAME::m_userUnits.

Referenced by PANEL_SETUP_TRACKS_AND_VIAS::AppendDiffPairs(), PANEL_SETUP_TRACKS_AND_VIAS::AppendTrackWidth(), PANEL_SETUP_TRACKS_AND_VIAS::AppendViaSize(), PCB_EDIT_FRAME::Create_MuWaveComponent(), MWAVE::CreateMicrowaveInductor(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), GERBER_FILE_IMAGE::DisplayImageInfo(), MARKER_BASE::DisplayMarkerInfo(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), LIB_EDIT_TOOL::editGraphicProperties(), LIB_PIN_TOOL::EditPinProperties(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), EVT_GRID_CMD_CELL_CHANGED(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::GenFootprintsReport(), PANEL_MODEDIT_DEFAULTS::getGridValue(), PANEL_SETUP_TEXT_AND_GRAPHICS::getGridValue(), PANEL_SETUP_NETCLASSES::getNetclassValue(), GetUserUnits(), GRID_MENU::GRID_MENU(), PCB_INSPECTION_TOOL::highlightNet(), GERBVIEW_FRAME::Liste_D_Codes(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::MeasureTool(), GERBVIEW_SELECTION_TOOL::MeasureTool(), EDIT_TOOL::MeasureTool(), PANEL_PREV_3D::PANEL_PREV_3D(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), LIB_EDIT_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), DRC::Reset(), CONNECTION_SUBGRAPH::ResolveDrivers(), DIALOG_BOARD_STATISTICS::saveReportClicked(), DISPLAY_FOOTPRINTS_FRAME::SyncToolbars(), FOOTPRINT_EDIT_FRAME::SyncToolbars(), LIB_EDIT_FRAME::SyncToolbars(), GERBVIEW_FRAME::SyncToolbars(), PCB_EDIT_FRAME::SyncToolbars(), SCH_EDIT_FRAME::SyncToolbars(), DRC::testDrilledHoles(), DRC::testUnconnected(), COMMON_TOOLS::ToggleUnits(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataFromWindow(), PANEL_SETUP_NETCLASSES::TransferDataFromWindow(), PANEL_EESCHEMA_SETTINGS::TransferDataToWindow(), PANEL_MODEDIT_SETTINGS::TransferDataToWindow(), PANEL_GERBVIEW_SETTINGS::TransferDataToWindow(), PANEL_PCBNEW_SETTINGS::TransferDataToWindow(), PANEL_SETUP_NETCLASSES::TransferDataToWindow(), UNIT_BINDER::UNIT_BINDER(), GRID_MENU::update(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), GERBVIEW_FRAME::updateDCodeSelectBox(), GERBVIEW_FRAME::updateGridSelectBox(), PCB_BASE_FRAME::UpdateGridSelectBox(), EE_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), PCBNEW_CONTROL::UpdateMessagePanel(), DRC::updatePointers(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), PL_EDITOR_FRAME::UpdateStatusBar(), SCH_BASE_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), GERBVIEW_FRAME::UpdateStatusBar(), PCB_EDIT_FRAME::UpdateTrackWidthSelectBox(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), DIALOG_BOARD_STATISTICS::updateWidets(), PANEL_SETUP_TRACKS_AND_VIAS::validateData(), and PANEL_SETUP_NETCLASSES::validateData().

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )
virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 550 of file eda_base_frame.cpp.

551 {
552  return Kiface().GetHelpFileName();
553 }
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:51
const wxString & GetHelpFileName() const
Function GetHelpFileName returns just the basename portion of the current help file.
Definition: kiface_i.h:121

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

Definition at line 311 of file eda_base_frame.h.

311 { }

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

181 { return false; }

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ IsCurrentTool()

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

Definition at line 228 of file eda_base_frame.cpp.

229 {
230  if( m_toolStack.empty() )
231  return &aAction == &ACTIONS::selectionTool;
232  else
233  return m_toolStack.back() == aAction.GetName();
234 }
std::vector< std::string > m_toolStack
static TOOL_ACTION selectionTool
Definition: actions.h:142
const std::string & GetName() const
Function GetName() Returns name of the action.
Definition: tool_action.h:78

References TOOL_ACTION::GetName(), EDA_BASE_FRAME::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(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), DISPLAY_FOOTPRINTS_FRAME::SyncToolbars(), and LIB_EDIT_FRAME::SyncToolbars().

◆ 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 154 of file kiway_player.cpp.

155 {
156  return !m_modal_loop;
157 }
WX_EVENT_LOOP * m_modal_loop
Definition: kiway_player.h:189

References KIWAY_PLAYER::m_modal_loop.

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

◆ IsModal()

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T  aType) const
inlineinherited

Definition at line 284 of file eda_base_frame.h.

284 { return m_Ident == aType; }

References EDA_BASE_FRAME::m_Ident.

Referenced by LIB_CONTROL::AddLibrary(), PCBNEW_CONTROL::AddLibrary(), LIB_CONTROL::AddSymbol(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), BOARD_COMMIT::BOARD_COMMIT(), LIB_CONTROL::CutCopyDelete(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_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(), LIB_CONTROL::DuplicateSymbol(), LIB_CONTROL::EditSymbol(), LIB_CONTROL::ExportSymbol(), LIB_CONTROL::Init(), DIALOG_EDIT_ONE_FIELD::init(), SELECTION_TOOL::Init(), DIALOG_PAD_PROPERTIES::initValues(), PICKER_TOOL::Main(), LIB_CONTROL::OnDeMorgan(), PCB_LAYER_WIDGET::OnRenderEnable(), PCBNEW_CONTROL::Paste(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), LIB_CONTROL::Revert(), EE_INSPECTION_TOOL::RunERC(), LIB_CONTROL::Save(), PCBNEW_CONTROL::Show3DViewer(), LIB_CONTROL::ShowComponentTree(), EE_INSPECTION_TOOL::ShowDatasheet(), and COMMON_TOOLS::ZoomFitScreen().

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

644 {
645  wxString msg;
646  wxFileName fn = aFileName;
647 
648  // Check for absence of a file path with a file name. Unfortunately KiCad
649  // uses paths relative to the current project path without the ./ part which
650  // confuses wxFileName. Making the file name path absolute may be less than
651  // elegant but it solves the problem.
652  if( fn.GetPath().IsEmpty() && fn.HasName() )
653  fn.MakeAbsolute();
654 
655  wxCHECK_MSG( fn.IsOk(), false,
656  wxT( "File name object is invalid. Bad programmer!" ) );
657  wxCHECK_MSG( !fn.GetPath().IsEmpty(), false,
658  wxT( "File name object path <" ) + fn.GetFullPath() +
659  wxT( "> is not set. Bad programmer!" ) );
660 
661  if( fn.IsDir() && !fn.IsDirWritable() )
662  {
663  msg.Printf( _( "You do not have write permissions to folder \"%s\"." ),
664  GetChars( fn.GetPath() ) );
665  }
666  else if( !fn.FileExists() && !fn.IsDirWritable() )
667  {
668  msg.Printf( _( "You do not have write permissions to save file \"%s\" to folder \"%s\"." ),
669  GetChars( fn.GetFullName() ), GetChars( fn.GetPath() ) );
670  }
671  else if( fn.FileExists() && !fn.IsFileWritable() )
672  {
673  msg.Printf( _( "You do not have write permissions to save file \"%s\"." ),
674  GetChars( fn.GetFullPath() ) );
675  }
676 
677  if( !msg.IsEmpty() )
678  {
679  wxMessageBox( msg );
680  return false;
681  }
682 
683  return true;
684 }
#define _(s)
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:101

References _, and GetChars().

Referenced by SCH_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::SaveEEFile(), LIB_EDIT_FRAME::saveLibrary(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SaveProjectFile(), 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(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), SCH_EDIT_FRAME::CreateScreens(), CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), DisplayStatus(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), EDIT_TOOL::EditFpInFpEditor(), SCH_EDIT_FRAME::EditSheet(), SCH_EDITOR_CONTROL::EditWithLibEdit(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_MANAGER::GetBufferedPart(), LIB_MANAGER::getLibraryBuffer(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::InitSheet(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadSheetFromFile(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), KICAD_MANAGER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnCloseWindow(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), LIB_EDIT_FRAME::OnExitKiCad(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), 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(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), KIWAY_HOLDER::Prj(), ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SCH_EDIT_FRAME::SaveEEFile(), SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), 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(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::UpdatePart(), 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 175 of file kiway_player.cpp.

176 {
177  // logging support
178  KiwayMailIn( aEvent ); // call the virtual, override in derived.
179 }
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 1061 of file cvpcb_mainframe.cpp.

1062 {
1063  const std::string& payload = mail.GetPayload();
1064 
1065  //DBG(printf( "%s: %s\n", __func__, payload.c_str() );)
1066 
1067  switch( mail.Command() )
1068  {
1069  case MAIL_EESCHEMA_NETLIST:
1070  ReadNetListAndFpFiles( payload );
1071  /* @todo
1072  Go into SCH_EDIT_FRAME::OnOpenCvpcb( wxCommandEvent& event ) and trim GNL_ALL down.
1073  */
1074  break;
1075 
1076  default:
1077  ; // ignore most
1078  }
1079 }
bool ReadNetListAndFpFiles(const std::string &aNetlist)
Function ReadNetListAndFpFiles loads the netlist file built on the fly by Eeschema and loads footprin...
SCH->CVPCB netlist immediately after launching CVPCB.
Definition: mail_type.h:42

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 182 of file kiway_player.cpp.

183 {
184  int id = event.GetId();
185 
186  // tell all the KIWAY_PLAYERs about the language change.
187  Kiway().SetLanguage( id );
188 }
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:415

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

695 {
696  FP_LIB_TABLE* fptbl = Prj().PcbFootprintLibs( Kiway() );
697 
698  // Check if there are footprint libraries in the footprint library table.
699  if( !fptbl || !fptbl->GetLogicalLibs().size() )
700  {
701  wxMessageBox( _( "No PCB footprint libraries are listed in the current footprint "
702  "library table." ), _( "Configuration Error" ), wxOK | wxICON_ERROR );
703  return false;
704  }
705 
706  WX_PROGRESS_REPORTER progressReporter( this, _( "Loading Footprint Libraries" ), 2 );
707 
708  m_FootprintsList->ReadFootprintFiles( fptbl, nullptr, &progressReporter );
709 
711  {
713  }
714 
715  return true;
716 }
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)
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.
#define _(s)
VTBL_ENTRY FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
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().

◆ LoadProjectFile()

void CVPCB_MAINFRAME::LoadProjectFile ( )

Function LoadProjectFile reads the CvPcb configuration parameter from the project (.pro) file aFileName.

Definition at line 50 of file cfg.cpp.

51 {
52  PROJECT& prj = Prj();
53 
54  m_ModuleLibNames.Clear();
55  m_EquFilesNames.Clear();
56 
57  prj.ConfigLoad( Kiface().KifaceSearch(), GROUP_CVP, GetProjectFileParameters() );
58 }
Class PROJECT holds project specific data.
Definition: project.h:58
wxArrayString m_EquFilesNames
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:51
wxArrayString m_ModuleLibNames
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
#define GROUP_CVP
Definition: config_params.h:52
VTBL_ENTRY bool ConfigLoad(const SEARCH_STACK &aSearchS, const wxString &aGroupName, const PARAM_CFG_ARRAY &aParams, const wxString &aForeignConfigFileName=wxEmptyString)
Function ConfigLoad reads a subset of parameters from the "project" file.
Definition: project.cpp:358
PARAM_CFG_ARRAY & GetProjectFileParameters(void)
Function GetProjectFileParameters return project file parameter list for CvPcb.
Definition: cfg.cpp:36

References PROJECT::ConfigLoad(), GetProjectFileParameters(), GROUP_CVP, Kiface(), m_EquFilesNames, m_ModuleLibNames, and KIWAY_HOLDER::Prj().

Referenced by ReadNetListAndFpFiles().

◆ LoadSettings()

void CVPCB_MAINFRAME::LoadSettings ( wxConfigBase *  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 363 of file cvpcb_mainframe.cpp.

364 {
366 
367  wxSize const frame_default( ConvertDialogToPixels( FRAME_DEFAULT_SIZE_DU ) );
368 
369  if( m_FrameSize == wxDefaultSize )
370  m_FrameSize = frame_default;
371 
373 }
static const wxString FilterFootprintEntry
wxSize const FRAME_DEFAULT_SIZE_DU(450, 300)
virtual void LoadSettings(wxConfigBase *aCfg)
Load common frame parameters from a configuration file.

References FilterFootprintEntry, FRAME_DEFAULT_SIZE_DU(), EDA_BASE_FRAME::LoadSettings(), m_filteringOptions, EDA_BASE_FRAME::m_FrameSize, and FOOTPRINTS_LISTBOX::UNFILTERED_FP_LIST.

Referenced by CVPCB_MAINFRAME().

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent &  aEvent)
protectedinherited

Handle the auto save timer event.

Definition at line 295 of file eda_base_frame.cpp.

296 {
297  if( !doAutoSave() )
298  m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
299 }
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).

Definition at line 308 of file eda_base_frame.cpp.

309 {
310  wxLogTrace( kicadTraceKeyEvent, "EDA_BASE_FRAME::OnCharHook %s", dump( event ) );
311  // Key events can be filtered here.
312  // Currently no filtering is made.
313  event.Skip();
314 }
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.

◆ OnCloseWindow()

void CVPCB_MAINFRAME::OnCloseWindow ( wxCloseEvent &  Event)

OnCloseWindow.

Called by a close event to close the window

Definition at line 299 of file cvpcb_mainframe.cpp.

300 {
301  if( m_modified )
302  {
303  if( !HandleUnsavedChanges( this, _( "Symbol to Footprint links have been modified. "
304  "Save changes?" ),
305  [&]()->bool { return SaveFootprintAssociation( false ); } ) )
306  {
307  Event.Veto();
308  return;
309  }
310  }
311 
312  // Close module display frame
314  GetFootprintViewerFrame()->Close( true );
315 
316  m_modified = false;
317 
318  // clear highlight symbol in schematic:
319  SendMessageToEESCHEMA( true );
320 
321  // Delete window
322  Destroy();
323 }
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:208
void SendMessageToEESCHEMA(bool aClearHighligntOnly=false)
Function SendMessageToEESCHEMA Send a remote command to Eeschema via a socket, Commands are $PART: "r...
#define _(s)
DISPLAY_FOOTPRINTS_FRAME * GetFootprintViewerFrame()
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.
bool SaveFootprintAssociation(bool doSaveSchematic)
Function SaveFootprintAssociation saves the edits that the user has done by sending them back to eesc...

References _, KIWAY_PLAYER::Destroy(), GetFootprintViewerFrame(), HandleUnsavedChanges(), m_modified, SaveFootprintAssociation(), and SendMessageToEESCHEMA().

Referenced by CVPCB_CONTROL::Main(), and setupEventHandlers().

◆ OnEnterFilteringText()

void CVPCB_MAINFRAME::OnEnterFilteringText ( wxCommandEvent &  event)

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

Definition at line 326 of file cvpcb_mainframe.cpp.

327 {
328  // Called when changing the filter string in main toolbar.
329  // If the option FOOTPRINTS_LISTBOX::FILTERING_BY_NAME is set, update the list of
330  // available footprints which match the filter
331 
333 
335  return;
336 
337  wxListEvent l_event;
338  OnSelectComponent( l_event );
339 }
wxString m_currentSearchPattern
wxTextCtrl * m_tcFilterString
void OnSelectComponent(wxListEvent &event)
Function OnSelectComponent Called when clicking on a component in component list window.

References FOOTPRINTS_LISTBOX::FILTERING_BY_NAME, m_currentSearchPattern, m_filteringOptions, m_tcFilterString, and OnSelectComponent().

Referenced by setupEventHandlers().

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent &  event)
inherited

Definition at line 607 of file eda_base_frame.cpp.

608 {
609  void ShowAboutDialog(EDA_BASE_FRAME * aParent); // See AboutDialog_main.cpp
610  ShowAboutDialog( this );
611 }
void ShowAboutDialog(EDA_BASE_FRAME *aParent)
The base frame for deriving all KiCad main window classes.

References ShowAboutDialog().

◆ OnMenuOpen()

void EDA_BASE_FRAME::OnMenuOpen ( wxMenuEvent &  event)
inherited

Workaround some issues in wxWidgets where the menu events aren't captured by the menus themselves.

Definition at line 317 of file eda_base_frame.cpp.

318 {
319  //
320  // wxWidgets has several issues that we have to work around:
321  //
322  // 1) wxWidgets 3.0.x Windows has a bug where wxEVT_MENU_OPEN and wxEVT_MENU_HIGHLIGHT
323  // events are not captured by the ACTON_MENU menus. So we forward them here.
324  // (FWIW, this one is fixed in wxWidgets 3.1.x.)
325  //
326  // 2) wxWidgets doesn't pass the menu pointer for wxEVT_MENU_HIGHLIGHT events. So we
327  // store the menu pointer from the wxEVT_MENU_OPEN call.
328  //
329  // 3) wxWidgets has no way to tell whether a command is from a menu selection or a
330  // hotkey. So we keep track of menu highlighting so we can differentiate.
331  //
332 
333  static ACTION_MENU* currentMenu;
334 
335  if( event.GetEventType() == wxEVT_MENU_OPEN )
336  {
337  currentMenu = dynamic_cast<ACTION_MENU*>( event.GetMenu() );
338 
339  if( currentMenu )
340  currentMenu->OnMenuEvent( event );
341  }
342  else if( event.GetEventType() == wxEVT_MENU_HIGHLIGHT )
343  {
344  if( currentMenu )
345  currentMenu->OnMenuEvent( event );
346  }
347  else if( event.GetEventType() == wxEVT_MENU_CLOSE )
348  {
349  if( currentMenu )
350  currentMenu->OnMenuEvent( event );
351 
352  currentMenu = nullptr;
353  }
354 
355  event.Skip();
356 }
Class ACTION_MENU.
Definition: action_menu.h:43
void OnMenuEvent(wxMenuEvent &aEvent)

References ACTION_MENU::OnMenuEvent().

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent &  event)
inherited

Definition at line 614 of file eda_base_frame.cpp.

615 {
616  PAGED_DIALOG dlg( this, _( "Preferences" ) );
617  wxTreebook* book = dlg.GetTreebook();
618 
619  book->AddPage( new PANEL_COMMON_SETTINGS( &dlg, book ), _( "Common" ) );
620 
621  PANEL_HOTKEYS_EDITOR* hotkeysPanel = new PANEL_HOTKEYS_EDITOR( this, book, false );
622  book->AddPage( hotkeysPanel, _( "Hotkeys" ) );
623 
624  for( unsigned i = 0; i < KIWAY_PLAYER_COUNT; ++i )
625  {
626  KIWAY_PLAYER* frame = dlg.Kiway().Player( (FRAME_T) i, false );
627 
628  if( frame )
629  frame->InstallPreferences( &dlg, hotkeysPanel );
630  }
631 
632  // The Kicad manager frame is not a player so we have to add it by hand
633  wxWindow* manager = wxFindWindowByName( KICAD_MANAGER_FRAME_NAME );
634 
635  if( manager )
636  static_cast<EDA_BASE_FRAME*>( manager )->InstallPreferences( &dlg, hotkeysPanel );
637 
638  if( dlg.ShowModal() == wxID_OK )
639  dlg.Kiway().CommonSettingsChanged( false );
640 }
Class KIWAY_PLAYER is a wxFrame capable of the OpenProjectFiles function, meaning it can load a porti...
Definition: kiway_player.h:59
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:321
#define _(s)
#define KICAD_MANAGER_FRAME_NAME
size_t i
Definition: json11.cpp:597
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(), i, EDA_BASE_FRAME::InstallPreferences(), KICAD_MANAGER_FRAME_NAME, KIWAY_HOLDER::Kiway(), KIWAY_PLAYER_COUNT, and KIWAY::Player().

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

343 {
345  return;
346 
347  wxString libraryName;
348  COMPONENT* component = GetSelectedComponent();
349  libraryName = m_libListBox->GetSelectedLibrary();
350 
351  m_footprintListBox->SetFootprints( *m_FootprintsList, libraryName, component,
353 
354  if( component && component->GetFPID().IsValid() )
356  else
358 
359  refreshAfterComponentSearch( component );
360 }
FOOTPRINT_LIST * m_FootprintsList
void SetSelectedFootprint(const LIB_ID &aFPID)
wxString m_currentSearchPattern
bool IsValid() const
Definition: lib_id.h:171
const LIB_ID & GetFPID() const
Definition: pcb_netlist.h:166
void refreshAfterComponentSearch(COMPONENT *component)
wxString GetSelectedLibrary()
LIBRARY_LISTBOX * m_libListBox
Class COMPONENT is used to store components and all of their related information found in a netlist.
Definition: pcb_netlist.h:83
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_currentSearchPattern, m_filteringOptions, m_footprintListBox, m_FootprintsList, m_libListBox, m_skipComponentSelect, 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 486 of file cvpcb_mainframe.cpp.

487 {
488  return true;
489 }

◆ PopTool()

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

Definition at line 181 of file eda_base_frame.cpp.

182 {
183  // Push/pop events can get out of order (such as when they're generated by the Simulator
184  // frame but not processed until the mouse is back in the Schematic frame), so make sure
185  // we're popping the right stack frame.
186 
187  for( int i = m_toolStack.size() - 1; i >= 0; --i )
188  {
189  if( m_toolStack[ i ] == actionName )
190  {
191  m_toolStack.erase( m_toolStack.begin() + i );
192 
193  // If there's something underneath us, and it's now the top of the stack, then
194  // re-activate it
195  if( ( --i ) >= 0 && i == (int)m_toolStack.size() - 1 )
196  {
197  std::string back = m_toolStack[ i ];
199 
200  if( action )
201  {
202  // Pop the action as running it will push it back onto the stack
203  m_toolStack.pop_back();
204 
205  TOOL_EVENT evt = action->MakeEvent();
206  evt.SetHasPosition( false );
207  GetToolManager()->PostEvent( evt );
208  }
209  }
210  else
212 
213  return;
214  }
215  }
216 }
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
TOOL_ACTION * FindAction(const std::string &aActionName) const
Function FindAction() Finds an action with a given name (if there is one available).
virtual void DisplayToolMsg(const wxString &msg)
Class TOOL_EVENT.
Definition: tool_event.h:168
std::vector< std::string > m_toolStack
ACTION_MANAGER * GetActionManager()
Definition: tool_manager.h:154
Class TOOL_ACTION.
Definition: tool_action.h:46
size_t i
Definition: json11.cpp:597
TOOL_EVENT MakeEvent() const
Function MakeEvent() Returns the event associated with the action (i.e.
Definition: tool_action.h:107
TOOL_MANAGER * m_toolManager
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:228
static TOOL_ACTION selectionTool
Definition: actions.h:142
void SetHasPosition(bool aHasPosition)
Definition: tool_event.h:258

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

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), 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(), SCH_MOVE_TOOL::Main(), LIB_MOVE_TOOL::Main(), PCBNEW_PICKER_TOOL::Main(), PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::MeasureTool(), GERBVIEW_SELECTION_TOOL::MeasureTool(), EDIT_TOOL::MeasureTool(), EDIT_TOOL::Move(), 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 556 of file eda_base_frame.cpp.

557 {
558  SetStatusText( text );
559 }

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

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

Definition at line 34 of file kiway_holder.cpp.

35 {
36  return Kiway().Prj();
37 }
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:163

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), LIB_CONTROL::AddSymbolToSchematic(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), DIALOG_SYMBOL_REMAP::backupProject(), LIB_VIEW_FRAME::BestZoom(), BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::checkAliasName(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), KICAD_MANAGER_FRAME::CreateNewProject(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), 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_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), DisplayStatus(), PCB_EDIT_FRAME::doAutoSave(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SCH_BASE_FRAME::GetLibAlias(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::GetSelectedAlias(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), 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::LoadProjectFile(), LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), DIALOG_DRC_CONTROL::makeValidFileNameReport(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_BOARD_EDITOR::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAdd3DModel(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), SCH_EDIT_FRAME::OnCloseWindow(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_BOM::OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), 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(), MODULE_EDITOR_TOOLS::PasteFootprint(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), SCH_DRAWING_TOOLS::PlaceComponent(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDIT_FRAME::Print(), SCH_EDIT_FRAME::PrintPage(), 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_EDIT_FRAME::RescueLegacyProject(), SCH_EDIT_FRAME::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), 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(), SCH_EDIT_FRAME::SaveProject(), SaveProjectFile(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), 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(), KICAD_MANAGER_FRAME::SetProjectFileName(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary(), SIM_PLOT_FRAME::updateNetlistExporter(), SCH_SCREEN::UpdateSymbolLinks(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::UpdateTitle(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::Validate(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_BOARD_EDITOR::~DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR(), and PCB_BASE_EDIT_FRAME::~PCB_BASE_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 237 of file eda_base_frame.cpp.

238 {
239 #ifdef __WXMAC__
240  // Apple in its infinite wisdom will raise a disabled window before even passing
241  // us the event, so we have no way to stop it. Instead, we have to catch an
242  // improperly ordered disabled window and quasi-modal dialog here and reorder
243  // them.
244  if( !IsEnabled() && IsActive() )
245  {
246  wxWindow* dlg = findQuasiModalDialog();
247  if( dlg )
248  dlg->Raise();
249  }
250 #endif
251 
252  if( !wxFrame::ProcessEvent( aEvent ) )
253  return false;
254 
255  if( IsShown() && m_hasAutoSave && IsActive() &&
257  {
258  if( !m_autoSaveState )
259  {
260  wxLogTrace( traceAutoSave, wxT( "Starting auto save timer." ) );
261  m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
262  m_autoSaveState = true;
263  }
264  else if( m_autoSaveTimer->IsRunning() )
265  {
266  wxLogTrace( traceAutoSave, wxT( "Stopping auto save timer." ) );
267  m_autoSaveTimer->Stop();
268  m_autoSaveState = false;
269  }
270  }
271 
272  return true;
273 }
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().

◆ PushTool()

void EDA_BASE_FRAME::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 164 of file eda_base_frame.cpp.

165 {
166  m_toolStack.push_back( actionName );
167 
168  // Human cognitive stacking is very shallow; deeper tool stacks just get annoying
169  if( m_toolStack.size() > 3 )
170  m_toolStack.erase( m_toolStack.begin() );
171 
172  TOOL_ACTION* action = m_toolManager->GetActionManager()->FindAction( actionName );
173 
174  if( action )
175  DisplayToolMsg( action->GetLabel() );
176  else
177  DisplayToolMsg( actionName );
178 }
TOOL_ACTION * FindAction(const std::string &aActionName) const
Function FindAction() Finds an action with a given name (if there is one available).
virtual void DisplayToolMsg(const wxString &msg)
wxString GetLabel() const
Definition: tool_action.cpp:69
std::vector< std::string > m_toolStack
ACTION_MANAGER * GetActionManager()
Definition: tool_manager.h:154
Class TOOL_ACTION.
Definition: tool_action.h:46
TOOL_MANAGER * m_toolManager

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

Referenced by PCB_TOOL_BASE::doInteractiveItemPlacement(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), 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(), SCH_MOVE_TOOL::Main(), LIB_MOVE_TOOL::Main(), PCBNEW_PICKER_TOOL::Main(), PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::MeasureTool(), GERBVIEW_SELECTION_TOOL::MeasureTool(), EDIT_TOOL::MeasureTool(), EDIT_TOOL::Move(), 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 81 of file readwrite_dlgs.cpp.

82 {
83  wxString msg;
84  bool hasMissingNicks = false;
85 
86  ReadSchematicNetlist( aNetlist );
87 
88  if( m_compListBox == NULL )
89  return false;
90 
92 
93  wxSafeYield();
94 
96 
99 
100  m_compListBox->Clear();
101 
103  {
104  for( unsigned i = 0; i < m_netlist.GetCount(); i++ )
105  {
106  COMPONENT* component = m_netlist.GetComponent( i );
107 
108  if( component->GetFPID().empty() )
109  continue;
110 
111  if( component->GetFPID().IsLegacy() )
112  hasMissingNicks = true;
113  }
114  }
115 
116  // Check if footprint links were generated before the footprint library table was implemented.
117  if( hasMissingNicks )
118  {
119  msg = _(
120  "Some of the assigned footprints are legacy entries (are missing lib nicknames). "
121  "Would you like CvPcb to attempt to convert them to the new required LIB_ID format? "
122  "(If you answer no, then these assignments will be cleared out and you will "
123  "have to re-assign these footprints yourself.)"
124  );
125 
126  if( IsOK( this, msg ) )
127  {
128  msg.Clear();
129 
130  try
131  {
132  for( unsigned i = 0; i < m_netlist.GetCount(); i++ )
133  {
134  COMPONENT* component = m_netlist.GetComponent( i );
135 
136  if( component->GetFPID().IsLegacy() )
137  {
138  // get this first here, it's possibly obsoleted if we get it too soon.
139  FP_LIB_TABLE* tbl = Prj().PcbFootprintLibs( Kiway() );
140 
141  int guess = guessNickname( tbl, (LIB_ID*) &component->GetFPID() );
142 
143  switch( guess )
144  {
145  case 0:
146  DBG(printf("%s: guessed OK ref:%s fpid:%s\n", __func__,
147  TO_UTF8( component->GetReference() ), component->GetFPID().Format().c_str() );)
148  m_modified = true;
149  break;
150 
151  case 1:
152  msg += wxString::Format( _(
153  "Component \"%s\" footprint \"%s\" was <b>not found</b> in any library.\n" ),
154  GetChars( component->GetReference() ),
155  GetChars( component->GetFPID().GetLibItemName() )
156  );
157  break;
158 
159  case 2:
160  msg += wxString::Format( _(
161  "Component \"%s\" footprint \"%s\" was found in <b>multiple</b> libraries.\n" ),
162  GetChars( component->GetReference() ),
163  GetChars( component->GetFPID().GetLibItemName() )
164  );
165  break;
166  }
167  }
168  }
169  }
170  catch( const IO_ERROR& ioe )
171  {
172  msg = ioe.What();
173  msg += wxT( "\n\n" );
174  msg += _( "First check your footprint library table entries." );
175 
176  wxMessageBox( msg, _( "Problematic Footprint Library Tables" ) );
177  return false;
178  }
179 
180  if( msg.size() )
181  {
182  HTML_MESSAGE_BOX dlg( this, wxEmptyString );
183 
184  dlg.MessageSet( _( "The following errors occurred attempting to convert the "
185  "footprint assignments:\n\n" ) );
186  dlg.ListSet( msg );
187  dlg.MessageSet( _( "\nYou will need to reassign them manually if you want them "
188  "to be updated correctly the next time you import the "
189  "netlist in Pcbnew." ) );
190 
191 #if 1
192  dlg.ShowModal();
193 #else
194  dlg.Fit();
195  dlg.Show( true ); // modeless lets user watch while fixing the problems, but its not working.
196 #endif
197  }
198  }
199  else
200  {
201  // Clear the legacy footprint assignments.
202  for( unsigned i = 0; i < m_netlist.GetCount(); i++ )
203  {
204  COMPONENT* component = m_netlist.GetComponent( i );
205 
206  if( component->GetFPID().IsLegacy() )
207  {
208  component->SetFPID( LIB_ID() /* empty */ );
209  m_modified = true;
210  }
211  }
212  }
213  }
214 
215 
216  // Display a dialog to select footprint selection, if the netlist
217  // and the .cmp file give 2 different valid footprints
218  std::vector <int > m_indexes; // indexes of footprints in netlist
219 
220  for( unsigned ii = 0; ii < m_netlist.GetCount(); ii++ )
221  {
222  COMPONENT* component = m_netlist.GetComponent( ii );
223 
224  if( component->GetAltFPID().empty() )
225  continue;
226 
227  if( component->GetFPID().IsLegacy() || component->GetAltFPID().IsLegacy())
228  continue;
229 
230  m_indexes.push_back( ii );
231  }
232 
233  // If a n assignment conflict is found,
234  // open a dialog to chose between schematic assignment
235  // and .cmp file assignment:
236  if( m_indexes.size() > 0 )
237  {
239 
240  for( unsigned ii = 0; ii < m_indexes.size(); ii++ )
241  {
242  COMPONENT* component = m_netlist.GetComponent( m_indexes[ii] );
243 
244  wxString cmpfpid = component->GetFPID().Format();
245  wxString schfpid = component->GetAltFPID().Format();
246 
247  dlg.Add( component->GetReference(), schfpid, cmpfpid );
248  }
249 
250  if( dlg.ShowModal() == wxID_OK )
251  {
252 
253  // Update the fp selection:
254  for( unsigned ii = 0; ii < m_indexes.size(); ii++ )
255  {
256  COMPONENT* component = m_netlist.GetComponent( m_indexes[ii] );
257 
258  int choice = dlg.GetSelection( component->GetReference() );
259 
260  if( choice == 0 ) // the schematic (alt fpid) is chosen:
261  component->SetFPID( component->GetAltFPID() );
262  }
263  }
264  }
265 
266  // Populates the component list box:
267  for( unsigned i = 0; i < m_netlist.GetCount(); i++ )
268  {
269  COMPONENT* component = m_netlist.GetComponent( i );
270 
271  msg.Printf( CMP_FORMAT, m_compListBox->GetCount() + 1,
272  GetChars( component->GetReference() ),
273  GetChars( component->GetValue() ),
274  GetChars( FROM_UTF8( component->GetFPID().Format().c_str() ) ) );
275 
276  m_compListBox->AppendLine( msg );
277  }
278 
279  if( !m_netlist.IsEmpty() )
280  m_compListBox->SetSelection( 0, true );
281 
282  DisplayStatus();
283 
284  return true;
285 }
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:62
#define CMP_FORMAT
The print format to display a schematic component line.
void SetFPID(const LIB_ID &aFPID)
Definition: pcb_netlist.h:155
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:256
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:166
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:48
const LIB_ID & GetAltFPID() const
Definition: pcb_netlist.h:168
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
const wxString & GetReference() const
Definition: pcb_netlist.h:151
void BuildFOOTPRINTS_LISTBOX()
Class HTML_MESSAGE_BOX.
#define _(s)
UTF8 Format() const
Definition: lib_id.cpp:237
Class COMPONENT is used to store components and all of their related information found in a netlist.
Definition: pcb_netlist.h:83
VTBL_ENTRY FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
COMPONENT * GetComponent(unsigned aIndex)
Function GetComponent returns the COMPONENT at aIndex.
Definition: pcb_netlist.h:265
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:101
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:205
size_t i
Definition: json11.cpp:597
bool IsEmpty() const
Function IsEmpty()
Definition: pcb_netlist.h:244
const wxString & GetValue() const
Definition: pcb_netlist.h:153
#define DBG(x)
Definition: fctsys.h:33
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:294
void DisplayStatus()
Function DisplayStatus updates the information displayed on the status bar at bottom of the main fram...
void LoadProjectFile()
Function LoadProjectFile reads the CvPcb configuration parameter from the project (....
Definition: cfg.cpp:50

References _, DIALOG_FP_CONFLICT_ASSIGNMENT_SELECTOR::Add(), NETLIST::AnyFootprintsLinked(), COMPONENTS_LISTBOX::AppendLine(), BuildFOOTPRINTS_LISTBOX(), BuildLIBRARY_LISTBOX(), UTF8::c_str(), COMPONENTS_LISTBOX::Clear(), CMP_FORMAT, DBG, DisplayStatus(), LIB_ID::empty(), LIB_ID::Format(), Format(), FROM_UTF8(), COMPONENT::GetAltFPID(), GetChars(), NETLIST::GetComponent(), COMPONENTS_LISTBOX::GetCount(), NETLIST::GetCount(), COMPONENT::GetFPID(), LIB_ID::GetLibItemName(), COMPONENT::GetReference(), DIALOG_FP_CONFLICT_ASSIGNMENT_SELECTOR::GetSelection(), COMPONENT::GetValue(), guessNickname(), i, NETLIST::IsEmpty(), LIB_ID::IsLegacy(), IsOK(), KIWAY_HOLDER::Kiway(), HTML_MESSAGE_BOX::ListSet(), LoadFootprintFiles(), LoadProjectFile(), m_compListBox, m_modified, m_netlist, HTML_MESSAGE_BOX::MessageSet(), PROJECT::PcbFootprintLibs(), KIWAY_HOLDER::Prj(), ReadSchematicNetlist(), COMPONENT::SetFPID(), COMPONENTS_LISTBOX::SetSelection(), DIALOG_SHIM::Show(), TO_UTF8, and IO_ERROR::What().

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

757 {
758  STRING_LINE_READER* strrdr = new STRING_LINE_READER( aNetlist, "Eeschema via Kiway" );
759  KICAD_NETLIST_READER netrdr( strrdr, &m_netlist );
760 
761  m_netlist.Clear();
762 
763  try
764  {
765  netrdr.LoadNetlist();
766  }
767  catch( const IO_ERROR& ioe )
768  {
769  wxString msg = wxString::Format( _( "Error loading schematic.\n%s" ),
770  ioe.What().GetData() );
771  wxMessageBox( msg, _( "Load Error" ), wxOK | wxICON_ERROR );
772  return 1;
773  }
774 
775  // We also remove footprint name if it is "$noname" because this is a dummy name,
776  // not the actual name of the footprint.
777  for( unsigned ii = 0; ii < m_netlist.GetCount(); ii++ )
778  {
779  if( m_netlist.GetComponent( ii )->GetFPID().GetLibItemName() == std::string( "$noname" ) )
780  m_netlist.GetComponent( ii )->SetFPID( LIB_ID() );
781  }
782 
783  // Sort components by reference:
785 
786  return 0;
787 }
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
Class KICAD_NETLIST_READER read the new s-expression based KiCad netlist format.
void SetFPID(const LIB_ID &aFPID)
Definition: pcb_netlist.h:155
unsigned GetCount() const
Function GetCount.
Definition: pcb_netlist.h:256
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:166
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
#define _(s)
COMPONENT * GetComponent(unsigned aIndex)
Function GetComponent returns the COMPONENT at aIndex.
Definition: pcb_netlist.h:265
void Clear()
Function Clear removes all components from the netlist.
Definition: pcb_netlist.h:250
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:205
Class STRING_LINE_READER is a LINE_READER that reads from a multiline 8 bit wide std::string.
Definition: richio.h:254
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 ( void  )

Definition at line 35 of file toolbars_cvpcb.cpp.

36 {
37  if( m_mainToolBar )
38  m_mainToolBar->Clear();
39  else
40  m_mainToolBar = new ACTION_TOOLBAR( this, ID_H_TOOLBAR, wxDefaultPosition, wxDefaultSize,
41  KICAD_AUI_TB_STYLE | wxAUI_TB_HORZ_LAYOUT );
42 
44 
47 
48 
52 
58 
59  // Add tools for footprint names filtering:
61  m_mainToolBar->AddSpacer( 15 );
62  wxStaticText* text = new wxStaticText( m_mainToolBar, wxID_ANY,
63  _( "Footprint Filters:" ) );
64  text->SetFont( m_mainToolBar->GetFont().Bold() );
65  m_mainToolBar->AddControl( text );
66 
70 
73 
75 
76  m_mainToolBar->AddControl( m_tcFilterString );
77 
78 
79  // after adding the buttons to the toolbar, must call Realize() to reflect the changes
80  m_mainToolBar->Realize();
81 }
static TOOL_ACTION showFootprintViewer
Open the footprint viewer.
Definition: cvpcb_actions.h:52
Class ACTION_TOOLBAR.
static TOOL_ACTION gotoNextNA
Definition: cvpcb_actions.h:56
static TOOL_ACTION gotoPreviousNA
Navigate the component tree.
Definition: cvpcb_actions.h:55
void Add(const TOOL_ACTION &aAction, bool aIsToggleEntry=false)
Function Add() Adds a TOOL_ACTION-based button to the toolbar.
static TOOL_ACTION filterFPbyDisplayName
Definition: cvpcb_actions.h:72
wxTextCtrl * m_tcFilterString
static TOOL_ACTION deleteAll
Definition: cvpcb_actions.h:65
static TOOL_ACTION showFootprintLibTable
Definition: actions.h:163
ACTION_TOOLBAR * m_mainToolBar
#define _(s)
static TOOL_ACTION autoAssociate
Footprint Association actions.
Definition: cvpcb_actions.h:63
static TOOL_ACTION redo
Definition: actions.h:68
static TOOL_ACTION filterFPbyPin
Definition: cvpcb_actions.h:70
void KiScaledSeparator(wxAuiToolBar *aToolbar, EDA_BASE_FRAME *aWindow)
Add a separator to the given toolbar scaled the same way as KiScaledBitmap.
Definition: bitmap.cpp:167
static constexpr int KICAD_AUI_TB_STYLE
Default style flags used for wxAUI toolbars
static TOOL_ACTION undo
Definition: actions.h:67
static TOOL_ACTION filterFPbyLibrary
Definition: cvpcb_actions.h:71
static TOOL_ACTION filterFPbyKeywords
Footprint Filtering actions.
Definition: cvpcb_actions.h:69

References _, ACTION_TOOLBAR::Add(), CVPCB_ACTIONS::autoAssociate, CVPCB_ACTIONS::deleteAll, CVPCB_ACTIONS::filterFPbyDisplayName, CVPCB_ACTIONS::filterFPbyKeywords, 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, KiScaledSeparator(), m_mainToolBar, m_tcFilterString, ACTIONS::redo, ACTIONS::showFootprintLibTable, CVPCB_ACTIONS::showFootprintViewer, 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 36 of file cvpcb/menubar.cpp.

37 {
39  // wxWidgets handles the Mac Application menu behind the scenes, but that means
40  // we always have to start from scratch with a new wxMenuBar.
41  wxMenuBar* oldMenuBar = GetMenuBar();
42  wxMenuBar* menuBar = new wxMenuBar();
43 
44  //-- File menu -----------------------------------------------------------
45  //
46  CONDITIONAL_MENU* fileMenu = new CONDITIONAL_MENU( false, tool );
47 
49  fileMenu->AddSeparator();
50  fileMenu->AddClose( _( "Assign Footprints" ) );
51 
52  fileMenu->Resolve();
53 
54  //-- Preferences menu -----------------------------------------------
55  //
56  CONDITIONAL_MENU* editMenu = new CONDITIONAL_MENU( false, tool );
57 
58  auto enableUndoCondition = [ this ] ( const SELECTION& sel )
59  {
60  return m_undoList.size() > 0;
61  };
62  auto enableRedoCondition = [ this ] ( const SELECTION& sel )
63  {
64  return m_redoList.size() > 0;
65  };
66 
67  editMenu->AddItem( ACTIONS::undo, enableUndoCondition );
68  editMenu->AddItem( ACTIONS::redo, enableRedoCondition );
69  editMenu->AddSeparator();
73 
74  editMenu->Resolve();
75 
76  //-- Preferences menu -----------------------------------------------
77  //
78  CONDITIONAL_MENU* prefsMenu = new CONDITIONAL_MENU( false, tool );
79 
82  prefsMenu->AddItem( wxID_PREFERENCES,
83  _( "Preferences...\tCTRL+," ),
84  _( "Show preferences for all open tools" ),
85  preference_xpm, SELECTION_CONDITIONS::ShowAlways );
86  prefsMenu->AddSeparator();
88 
89  prefsMenu->AddSeparator();
90  AddMenuLanguageList( prefsMenu, tool );
91 
92  prefsMenu->Resolve();
93 
94  //-- Menubar -------------------------------------------------------------
95  //
96  menuBar->Append( fileMenu, _( "&File" ) );
97  menuBar->Append( editMenu, _( "&Edit" ) );
98  menuBar->Append( prefsMenu, _( "&Preferences" ) );
99  AddStandardHelpMenu( menuBar );
100 
101  SetMenuBar( menuBar );
102  delete oldMenuBar;
103 }
static bool ShowAlways(const SELECTION &aSelection)
Function ShowAlways The default condition function (always returns true).
static TOOL_ACTION showEquFileTable
Definition: cvpcb_actions.h:60
void AddMenuLanguageList(CONDITIONAL_MENU *aMasterMenu, TOOL_INTERACTIVE *aControlTool)
Function AddMenuLanguageList creates a menu list for language choice, and add it as submenu to Master...
static TOOL_ACTION copy
Definition: actions.h:70
static TOOL_ACTION showFootprintLibTable
Definition: actions.h:163
void AddStandardHelpMenu(wxMenuBar *aMenuBar)
Adds the standard KiCad help menu to the menubar.
static TOOL_ACTION cut
Definition: actions.h:69
CVPCB_UNDO_REDO_LIST m_undoList
static TOOL_ACTION saveAssociations
Management actions.
Definition: cvpcb_actions.h:59
Class COMMON_CONTROL.
#define _(s)
void Resolve()
Function Resolve()
void AddSeparator(int aOrder=ANY_ORDER)
Function AddSeparator()
static TOOL_ACTION redo
Definition: actions.h:68
void AddClose(wxString aAppname="")
Function AddClose()
CVPCB_UNDO_REDO_LIST m_redoList
static TOOL_ACTION undo
Definition: actions.h:67
TOOL_MANAGER * m_toolManager
static TOOL_ACTION configurePaths
Definition: actions.h:161
void AddItem(const TOOL_ACTION &aAction, const SELECTION_CONDITION &aCondition, int aOrder=ANY_ORDER)
Function AddItem()
static TOOL_ACTION paste
Definition: actions.h:71

References _, CONDITIONAL_MENU::AddClose(), CONDITIONAL_MENU::AddItem(), AddMenuLanguageList(), CONDITIONAL_MENU::AddSeparator(), EDA_BASE_FRAME::AddStandardHelpMenu(), ACTIONS::configurePaths, ACTIONS::copy, ACTIONS::cut, TOOL_MANAGER::GetTool(), m_redoList, EDA_BASE_FRAME::m_toolManager, m_undoList, ACTIONS::paste, ACTIONS::redo, CONDITIONAL_MENU::Resolve(), CVPCB_ACTIONS::saveAssociations, SELECTION_CONDITIONS::ShowAlways(), 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 405 of file cvpcb_mainframe.cpp.

406 {
407  if( m_redoList.size() == 0 )
408  return;
409 
410  CVPCB_UNDO_REDO_ENTRIES curEntry = m_redoList.back();
411  m_redoList.pop_back();
412 
413  // Iterate over the entries to undo
414  bool firstAssoc = true;
415  for( auto assoc : curEntry )
416  {
417  AssociateFootprint( assoc, firstAssoc );
418  firstAssoc = false;
419  }
420 }
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 492 of file cvpcb_mainframe.cpp.

493 {
494  // Tell AuiMgr that objects are changed !
495  if( m_auimgr.GetManagedWindow() ) // Be sure Aui Manager is initialized
496  // (could be not the case when starting CvPcb
497  m_auimgr.Update();
498 
499  if( component == NULL )
500  {
501  DisplayStatus();
502  return;
503  }
504 
505  // Preview of the already assigned footprint.
506  // Find the footprint that was already chosen for this component and select it,
507  // but only if the selection is made from the component list or the library list.
508  // If the selection is made from the footprint list, do not change the current
509  // selected footprint.
510  if( FindFocus() == m_compListBox || FindFocus() == m_libListBox )
511  {
512  wxString module = FROM_UTF8( component->GetFPID().Format().c_str() );
513 
515 
516  for( int ii = 0; ii < m_footprintListBox->GetCount(); ii++ )
517  {
518  wxString footprintName;
519  wxString msg = m_footprintListBox->OnGetItemText( ii, 0 );
520  msg.Trim( true );
521  msg.Trim( false );
522  footprintName = msg.AfterFirst( wxChar( ' ' ) );
523 
524  if( module.Cmp( footprintName ) == 0 )
525  {
526  m_footprintListBox->SetSelection( ii, true );
527  break;
528  }
529  }
530 
533  }
534 
536  DisplayStatus();
537 }
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:62
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:109
wxAuiManager m_auimgr
const char * c_str() const
Definition: utf8.h:107
const LIB_ID & GetFPID() const
Definition: pcb_netlist.h:166
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)
DISPLAY_FOOTPRINTS_FRAME * GetFootprintViewerFrame()
FOOTPRINTS_LISTBOX * m_footprintListBox
TOOL_MANAGER * m_toolManager
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, EDA_BASE_FRAME::m_toolManager, FOOTPRINTS_LISTBOX::OnGetItemText(), TOOL_MANAGER::RunAction(), SendMessageToEESCHEMA(), FOOTPRINTS_LISTBOX::SetSelection(), and CVPCB_ACTIONS::showFootprintViewer.

Referenced by OnSelectComponent().

◆ RefreshCanvas()

virtual void EDA_BASE_FRAME::RefreshCanvas ( )
inlinevirtualinherited

Notification to refresh the drawing canvas (if any).

Reimplemented in EDA_DRAW_FRAME.

Definition at line 465 of file eda_base_frame.h.

465 { };

Referenced by TOOL_MANAGER::ProcessEvent().

◆ 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 288 of file readwrite_dlgs.cpp.

289 {
290  std::string payload;
291  STRING_FORMATTER sf;
292 
294 
295  payload = sf.GetString();
297 
298  if( doSaveSchematic )
299  {
300  payload = "";
301  Kiway().ExpressMail( FRAME_SCH, MAIL_SCH_SAVE, payload );
302 
303  if( payload == "success" )
304  SetStatusText( _( "Schematic saved" ), 1 );
305  }
306 
307  // Changes are saved, so reset the flag
308  m_modified = false;
309 
310  return true;
311 }
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
CVPCB->SCH footprint stuffing.
Definition: mail_type.h:40
CVPCB->SCH save the schematic.
Definition: mail_type.h:41
void SetStatusText(const wxString &aText, int aNumber=0) override
const std::string & GetString()
Definition: richio.h:475
#define _(s)
void FormatBackAnnotation(OUTPUTFORMATTER *aOut)
Definition: pcb_netlist.h:355
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:407
Class STRING_FORMATTER implements OUTPUTFORMATTER to a memory buffer.
Definition: richio.h:445

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

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

◆ SaveProjectFile()

void CVPCB_MAINFRAME::SaveProjectFile ( )

Function SaveProjectFile Saves the CvPcb configuration parameter from the project (.pro) file aFileName.

Definition at line 61 of file cfg.cpp.

62 {
63  PROJECT& prj = Prj();
64  wxFileName fn = prj.GetProjectFullName();
65 
66  if( !IsWritable( fn ) )
67  {
68  wxMessageBox( _( "Project file \"%s\" is not writable" ), fn.GetFullPath() );
69  return;
70  }
71 
72  wxString pro_name = fn.GetFullPath();
73 
74  prj.ConfigSave( Kiface().KifaceSearch(), GROUP_CVP, GetProjectFileParameters(), pro_name );
75 }
VTBL_ENTRY void ConfigSave(const SEARCH_STACK &aSList, const wxString &aGroupName, const PARAM_CFG_ARRAY &aParams, const wxString &aFileName=wxEmptyString)
Function ConfigSave saves the current "project" parameters into the wxConfigBase* derivative.
Definition: project.cpp:323
Class PROJECT holds project specific data.
Definition: project.h:58
bool IsWritable(const wxFileName &aFileName)
Checks if aFileName can be written.
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:51
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
#define GROUP_CVP
Definition: config_params.h:52
VTBL_ENTRY const wxString GetProjectFullName() const
Function GetProjectFullName returns the full path and name of the project.
Definition: project.cpp:96
#define _(s)
PARAM_CFG_ARRAY & GetProjectFileParameters(void)
Function GetProjectFileParameters return project file parameter list for CvPcb.
Definition: cfg.cpp:36

References _, PROJECT::ConfigSave(), GetProjectFileParameters(), PROJECT::GetProjectFullName(), GROUP_CVP, EDA_BASE_FRAME::IsWritable(), Kiface(), and KIWAY_HOLDER::Prj().

Referenced by DIALOG_CONFIG_EQUFILES::OnOkClick().

◆ SaveProjectSettings()

virtual void EDA_BASE_FRAME::SaveProjectSettings ( bool  aAskForSave)
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 350 of file eda_base_frame.h.

350 {};

Referenced by DIALOG_PAGES_SETTINGS::OnOkClick().

◆ SaveSettings()

void CVPCB_MAINFRAME::SaveSettings ( wxConfigBase *  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 376 of file cvpcb_mainframe.cpp.

377 {
379 
381 }
virtual void SaveSettings(wxConfigBase *aCfg)
Saves common frame parameters to a configuration data file.
static const wxString FilterFootprintEntry

References FilterFootprintEntry, m_filteringOptions, and 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 719 of file cvpcb_mainframe.cpp.

720 {
721  if( m_netlist.IsEmpty() )
722  return;
723 
724  // clear highlight of previously selected components (if any):
725  // Selecting a non existing symbol clears any previously highlighted symbols
726  std::string packet = "$CLEAR: \"HIGHLIGHTED\"";
727 
728  if( Kiface().IsSingle() )
729  SendCommand( MSG_TO_SCH, packet.c_str() );
730  else
731  Kiway().ExpressMail( FRAME_SCH, MAIL_CROSS_PROBE, packet, this );
732 
733  if( aClearHighligntOnly )
734  return;
735 
736  int selection = m_compListBox->GetSelection();
737 
738  if ( selection < 0 ) // Nothing selected
739  return;
740 
741  if( m_netlist.GetComponent( selection ) == NULL )
742  return;
743 
744  // Now highlight the selected component:
745  COMPONENT* component = m_netlist.GetComponent( selection );
746 
747  packet = StrPrintf( "$PART: \"%s\"", TO_UTF8( component->GetReference() ) );
748 
749  if( Kiface().IsSingle() )
750  SendCommand( MSG_TO_SCH, packet.c_str() );
751  else
752  Kiway().ExpressMail( FRAME_SCH, MAIL_CROSS_PROBE, packet, this );
753 }
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
int StrPrintf(std::string *aResult, const char *aFormat,...)
Function StrPrintf is like sprintf() but the output is appended to a std::string instead of to a char...
Definition: richio.cpp:74
COMPONENTS_LISTBOX * m_compListBox
#define MSG_TO_SCH
Definition: eda_dde.h:46
bool SendCommand(int service, const char *cmdline)
Definition: eda_dde.cpp:132
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:51
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:48
bool IsSingle() const
Function IsSingle is this KIFACE_I running under single_top?
Definition: kiface_i.h:115
const wxString & GetReference() const
Definition: pcb_netlist.h:151
Class COMPONENT is used to store components and all of their related information found in a netlist.
Definition: pcb_netlist.h:83
COMPONENT * GetComponent(unsigned aIndex)
Function GetComponent returns the COMPONENT at aIndex.
Definition: pcb_netlist.h:265
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:407
bool IsEmpty() const
Function IsEmpty()
Definition: pcb_netlist.h:244
PCB<->SCH, CVPCB->SCH cross-probing.
Definition: mail_type.h:39

References KIWAY::ExpressMail(), FRAME_SCH, NETLIST::GetComponent(), COMPONENT::GetReference(), ITEMS_LISTBOX_BASE::GetSelection(), NETLIST::IsEmpty(), KIFACE_I::IsSingle(), Kiface(), KIWAY_HOLDER::Kiway(), m_compListBox, m_netlist, MAIL_CROSS_PROBE, MSG_TO_SCH, SendCommand(), numEval::StrPrintf(), and TO_UTF8.

Referenced by OnCloseWindow(), refreshAfterComponentSearch(), and SetSelectedComponent().

◆ SetAutoSaveInterval()

void EDA_BASE_FRAME::SetAutoSaveInterval ( int  aInterval)
inherited

Definition at line 276 of file eda_base_frame.cpp.

277 {
278  m_autoSaveInterval = aInterval;
279 
280  if( m_autoSaveTimer->IsRunning() )
281  {
282  if( m_autoSaveInterval > 0 )
283  {
284  m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
285  }
286  else
287  {
288  m_autoSaveTimer->Stop();
289  m_autoSaveState = false;
290  }
291  }
292 }
wxTimer * m_autoSaveTimer

References EDA_BASE_FRAME::m_autoSaveInterval, EDA_BASE_FRAME::m_autoSaveState, and EDA_BASE_FRAME::m_autoSaveTimer.

Referenced by EDA_DRAW_FRAME::CommonSettingsChanged().

◆ SetFocusedControl()

void CVPCB_MAINFRAME::SetFocusedControl ( CVPCB_MAINFRAME::CONTROL_TYPE  aControl)

Set the focus to a specific control.

Parameters
aControlthe contorl to set focus to

Definition at line 1001 of file cvpcb_mainframe.cpp.

1002 {
1003  switch( aLB )
1004  {
1006  m_libListBox->SetFocus();
1007  break;
1008 
1010  m_compListBox->SetFocus();
1011  break;
1012 
1014  m_footprintListBox->SetFocus();
1015  break;
1016 
1017  default:
1018  break;
1019  }
1020 }
COMPONENTS_LISTBOX * m_compListBox
LIBRARY_LISTBOX * m_libListBox
FOOTPRINTS_LISTBOX * m_footprintListBox

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

Referenced by CVPCB_CONTROL::ChangeFocus().

◆ SetFootprintFilter()

void CVPCB_MAINFRAME::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.

Parameters
aFilterThe filter to modify
aActionWhat action (on, off or toggle) to take

Definition at line 540 of file cvpcb_mainframe.cpp.

542 {
544 
545  // Extract the needed information about the filter
546  switch( aFilter )
547  {
549  // Extract the current search patten when needed
551 
556  option = aFilter;
557  }
558 
559  // Apply the filter accordingly
560  switch( aAction )
561  {
563  m_filteringOptions &= ~option;
564  break;
565 
567  m_filteringOptions |= option;
568  break;
569 
571  m_filteringOptions ^= option;
572  break;
573  }
574 
575  wxListEvent l_event;
576  OnSelectComponent( l_event );
577 }
wxString m_currentSearchPattern
wxTextCtrl * m_tcFilterString
void OnSelectComponent(wxListEvent &event)
Function OnSelectComponent Called when clicking on a component in component list window.
Toggle the filter state.

References FILTER_DISABLE, FILTER_ENABLE, FILTER_TOGGLE, FOOTPRINTS_LISTBOX::FILTERING_BY_COMPONENT_KEYWORD, FOOTPRINTS_LISTBOX::FILTERING_BY_LIBRARY, FOOTPRINTS_LISTBOX::FILTERING_BY_NAME, FOOTPRINTS_LISTBOX::FILTERING_BY_PIN_COUNT, m_currentSearchPattern, m_filteringOptions, m_tcFilterString, OnSelectComponent(), and FOOTPRINTS_LISTBOX::UNFILTERED_FP_LIST.

Referenced by LIBRARY_LISTBOX::OnSelectLibrary(), and CVPCB_CONTROL::ToggleFootprintFilter().

◆ SetKiway()

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

Function SetKiway.

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

Definition at line 41 of file kiway_holder.cpp.

42 {
43 #if defined(DEBUG)
44  // offer a trap point for debugging most any window
45  wxASSERT( aDest );
46  if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
47  {
48  int breakhere=1;
49  (void) breakhere;
50  }
51 #endif
52 
53  (void) aDest;
54 
55  m_kiway = aKiway;
56 }
KIWAY * m_kiway
Definition: kiway_holder.h:81
const char * name
Definition: DXF_plotter.cpp:61

References KIWAY_HOLDER::m_kiway, and name.

Referenced by InvokePcbLibTableEditor(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

◆ SetModal()

void KIWAY_PLAYER::SetModal ( bool  aIsModal)
inlineinherited

Definition at line 164 of file kiway_player.h.

164 { m_modal = aIsModal; }

References KIWAY_PLAYER::m_modal.

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

◆ SetMruPath()

void EDA_BASE_FRAME::SetMruPath ( const wxString &  aPath)
inlineinherited

Definition at line 390 of file eda_base_frame.h.

390 { m_mruPath = aPath; }
wxString m_mruPath

References EDA_BASE_FRAME::m_mruPath.

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

◆ SetSelectedComponent()

void CVPCB_MAINFRAME::SetSelectedComponent ( int  aIndex,
bool  aSkipUpdate = false 
)

Set the currently selected component in the components listbox.

Parameters
aIndexthe index of the component to select, -1 to clear selection
aSkipUpdateskips running the OnSelectComponent event to update the other windows

Definition at line 890 of file cvpcb_mainframe.cpp.

891 {
892  m_skipComponentSelect = aSkipUpdate;
893 
894  if( aIndex < 0 )
895  {
897  }
898  else if( aIndex < m_compListBox->GetCount() )
899  {
901  m_compListBox->SetSelection( aIndex );
903  }
904 
905  m_skipComponentSelect = false;
906 }
COMPONENTS_LISTBOX * m_compListBox
void SendMessageToEESCHEMA(bool aClearHighligntOnly=false)
Function SendMessageToEESCHEMA Send a remote command to Eeschema via a socket, Commands are $PART: "r...
void DeselectAll()
Removes all selection in lists which can have more than one item selected.
void SetSelection(int index, bool State=true)

References ITEMS_LISTBOX_BASE::DeselectAll(), m_compListBox, m_skipComponentSelect, SendMessageToEESCHEMA(), and COMPONENTS_LISTBOX::SetSelection().

Referenced by CVPCB_ASSOCIATION_TOOL::DeleteAll(), and CVPCB_CONTROL::ToNA().

◆ SetStatusText()

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

Definition at line 1031 of file cvpcb_mainframe.cpp.

1032 {
1033  switch( aNumber )
1034  {
1035  case 0:
1036  m_statusLine1->SetLabel( aText );
1037  break;
1038 
1039  case 1:
1040  m_statusLine2->SetLabel( aText );
1041  break;
1042 
1043  case 2:
1044  m_statusLine3->SetLabel( aText );
1045  break;
1046 
1047  default:
1048  wxASSERT_MSG( false, "Invalid status row number" );
1049  }
1050 }
wxStaticText * m_statusLine3
wxStaticText * m_statusLine2
wxStaticText * m_statusLine1

References m_statusLine1, m_statusLine2, and m_statusLine3.

Referenced by AutomaticFootprintMatching(), DisplayStatus(), and SaveFootprintAssociation().

◆ setupEventHandlers()

void CVPCB_MAINFRAME::setupEventHandlers ( )
private

Setup event handlers.

Definition at line 232 of file cvpcb_mainframe.cpp.

233 {
234  // Connect the handlers to launch the context menus in the listboxes
235  m_footprintListBox->Bind( wxEVT_RIGHT_DOWN,
236  [this]( wxMouseEvent& )
237  {
238  PopupMenu( m_footprintContextMenu );
239  } );
240 
241  m_compListBox->Bind( wxEVT_RIGHT_DOWN,
242  [this]( wxMouseEvent& )
243  {
244  PopupMenu( m_componentContextMenu );
245  } );
246 
247  // Connect the handler for the save button
248  m_saveAndContinue->Bind( wxEVT_COMMAND_BUTTON_CLICKED,
249  [this]( wxCommandEvent& )
250  {
252  } );
253 
254  // Connect the handlers for the ok/cancel buttons
255  Bind( wxEVT_BUTTON,
256  [this]( wxCommandEvent& )
257  {
259  Close( true );
260  }, wxID_OK );
261  Bind( wxEVT_BUTTON,
262  [this]( wxCommandEvent& )
263  {
264  // Throw away modifications on a Cancel
265  m_modified = false;
266  Close( false );
267  }, wxID_CANCEL );
268 
269  // Connect the handlers for the close events
270  Bind( wxEVT_CLOSE_WINDOW, &CVPCB_MAINFRAME::OnCloseWindow, this );
271  Bind( wxEVT_MENU,
272  [this]( wxCommandEvent& )
273  {
274  Close( false );
275  }, wxID_CLOSE );
276  Bind( wxEVT_MENU,
277  [this]( wxCommandEvent& )
278  {
279  Close( false );
280  }, wxID_EXIT );
281 
282  // Toolbar events
284 
285  // Just skip the resize events
286  Bind( wxEVT_SIZE,
287  []( wxSizeEvent& aEvent )
288  {
289  aEvent.Skip();
290  } );
291 
292  // Attach the events to the tool dispatcher
295  Bind( wxEVT_CHAR_HOOK, &TOOL_DISPATCHER::DispatchWxEvent, m_toolDispatcher );
296 }
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
ACTION_MENU * m_footprintContextMenu
COMPONENTS_LISTBOX * m_compListBox
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:109
virtual void DispatchWxEvent(wxEvent &aEvent)
Function DispatchWxEvent() Processes wxEvents (mostly UI events), translates them to TOOL_EVENTs,...
ACTION_MENU * m_componentContextMenu
static TOOL_ACTION saveAssociations
Management actions.
Definition: cvpcb_actions.h:59
TOOL_DISPATCHER * m_toolDispatcher
void OnCloseWindow(wxCloseEvent &Event)
OnCloseWindow.
virtual void DispatchWxCommand(wxCommandEvent &aEvent)
Function DispatchWxCommand() Processes wxCommands (mostly menu related events) and runs appropriate a...
FOOTPRINTS_LISTBOX * m_footprintListBox
void OnEnterFilteringText(wxCommandEvent &event)
Function OnEnterFilteringText Is called each time the text of m_tcFilterString is changed.
wxButton * m_saveAndContinue

References TOOL_DISPATCHER::DispatchWxCommand(), TOOL_DISPATCHER::DispatchWxEvent(), EDA_BASE_FRAME::GetToolManager(), ID_CVPCB_FILTER_TEXT_EDIT, m_compListBox, m_componentContextMenu, m_footprintContextMenu, m_footprintListBox, m_modified, m_saveAndContinue, m_toolDispatcher, OnCloseWindow(), OnEnterFilteringText(), TOOL_MANAGER::RunAction(), and CVPCB_ACTIONS::saveAssociations.

Referenced by CVPCB_MAINFRAME().

◆ setupTools()

void CVPCB_MAINFRAME::setupTools ( )
private

Setup the tool system for the CVPCB main frame.

Definition at line 199 of file cvpcb_mainframe.cpp.

200 {
201  // Create the manager
202  m_actions = new CVPCB_ACTIONS();
204  m_toolManager->SetEnvironment( nullptr, nullptr, nullptr, this );
206 
207  // Register tools
212 
214 
215  // Create the context menu for the component list box
216  m_componentContextMenu = new ACTION_MENU( true );
219  m_componentContextMenu->AppendSeparator();
223  m_componentContextMenu->AppendSeparator();
225 
226  // Create the context menu for the footprint list box
227  m_footprintContextMenu = new ACTION_MENU( true );
230 }
static TOOL_ACTION showFootprintViewer
Open the footprint viewer.
Definition: cvpcb_actions.h:52
wxMenuItem * Add(const wxString &aLabel, int aId, const BITMAP_OPAQUE *aIcon)
Function Add() Adds a wxWidgets-style entry to the menu.
ACTION_MENU * m_footprintContextMenu
Class ACTION_MENU.
Definition: action_menu.h:43
ACTIONS * m_actions
void SetTool(TOOL_INTERACTIVE *aTool)
Function SetTool() Sets a tool that is the creator of the menu.
Class TOOL_MANAGER.
Definition: tool_manager.h:50
static TOOL_ACTION copy
Definition: actions.h:70
static TOOL_ACTION cut
Definition: actions.h:69
ACTION_MENU * m_componentContextMenu
static TOOL_ACTION deleteAssoc
Definition: cvpcb_actions.h:66
Class CVPCB_ACTIONS.
Definition: cvpcb_actions.h:40
Class COMMON_CONTROL.
TOOL_DISPATCHER * m_toolDispatcher
Class TOOL_DISPATCHER.
void SetEnvironment(EDA_ITEM *aModel, KIGFX::VIEW *aView, KIGFX::VIEW_CONTROLS *aViewControls, EDA_BASE_FRAME *aFrame)
Sets the work environment (model, view, view controls and the parent window).
TOOL_MANAGER * m_toolManager
void InitTools()
Function InitTools() Initializes all registered tools.
Class CVPCB_CONTROL.
Definition: cvpcb_control.h:35
static TOOL_ACTION paste
Definition: actions.h:71
void RegisterTool(TOOL_BASE *aTool)
Function RegisterTool() Adds a tool to the manager set and sets it up.

References ACTION_MENU::Add(), ACTIONS::copy, ACTIONS::cut, CVPCB_ACTIONS::deleteAssoc, TOOL_MANAGER::GetTool(), TOOL_MANAGER::InitTools(), EDA_BASE_FRAME::m_actions, m_componentContextMenu, m_footprintContextMenu, m_toolDispatcher, EDA_BASE_FRAME::m_toolManager, ACTIONS::paste, TOOL_MANAGER::RegisterTool(), TOOL_MANAGER::SetEnvironment(), ACTION_MENU::SetTool(), and CVPCB_ACTIONS::showFootprintViewer.

Referenced by CVPCB_MAINFRAME().

◆ SetUserUnits()

◆ ShowChangedLanguage()

void CVPCB_MAINFRAME::ShowChangedLanguage ( )
overridevirtual

Redraw the menus and what not in current language.

Reimplemented from EDA_BASE_FRAME.

Definition at line 1053 of file cvpcb_mainframe.cpp.

1054 {
1056  ReCreateHToolbar();
1057  DisplayStatus();
1058 }
virtual void ShowChangedLanguage()
Redraw the menus and what not in current language.
void DisplayStatus()
Function DisplayStatus updates the information displayed on the status bar at bottom of the main fram...

References DisplayStatus(), ReCreateHToolbar(), and EDA_BASE_FRAME::ShowChangedLanguage().

◆ ShowModal()

bool KIWAY_PLAYER::ShowModal ( wxString *  aResult = NULL,
wxWindow *  aResultantFocusWindow = NULL 
)
virtualinherited

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

That is, behavior is similar to a modal dialog window. Not all KIWAY_PLAYERs use this interface, so don't call this unless the implementation knows how to call DismissModal() on a button click or double click or some special event which ends the modal behavior.

Parameters
aResultif not NULL, indicates a place to put a resultant string.
aResultantFocusWindowif not NULL, indicates what window to pass focus to on return.
Returns
bool - true if frame implementation called KIWAY_PLAYER::DismissModal() with aRetVal of true.

Reimplemented in FOOTPRINT_VIEWER_FRAME, and LIB_VIEW_FRAME.

Definition at line 75 of file kiway_player.cpp.

76 {
77  wxASSERT_MSG( IsModal(), wxT( "ShowModal() shouldn't be called on non-modal frame" ) );
78 
79  /*
80  This function has a nice interface but a necessarily unsightly implementation.
81  Now the implementation is encapsulated, localizing future changes.
82 
83  It works in tandem with DismissModal(). But only ShowModal() is in the
84  vtable and therefore cross-module capable.
85  */
86 
87  // This is an exception safe way to zero a pointer before returning.
88  // Yes, even though DismissModal() clears this first normally, this is
89  // here in case there's an exception before the dialog is dismissed.
90  struct NULLER
91  {
92  void*& m_what;
93  NULLER( void*& aPtr ) : m_what( aPtr ) {}
94  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
95  } clear_this( (void*&) m_modal_loop );
96 
97 
98  m_modal_resultant_parent = aResultantFocusWindow;
99 
100  Show( true );
101  Raise(); // Needed on some Window managers to always display the frame
102 
103  SetFocus();
104 
105  {
106  // We have to disable all frames but the the modal one.
107  // wxWindowDisabler does that, but it also disables all top level windows
108  // We do not want to disable top level windows which are child of the modal one,
109  // if they are enabled.
110  // An example is an aui toolbar which was moved
111  // or a dialog or another frame or miniframe opened by the modal one.
112  wxWindowList wlist = GetChildren();
113  std::vector<wxWindow*> enabledTopLevelWindows;
114 
115  for( unsigned ii = 0; ii < wlist.size(); ii++ )
116  if( wlist[ii]->IsTopLevel() && wlist[ii]->IsEnabled() )
117  enabledTopLevelWindows.push_back( wlist[ii] );
118 
119  // exception safe way to disable all top level windows except the modal one,
120  // re-enables only those that were disabled on exit
121  wxWindowDisabler toggle( this );
122 
123  for( unsigned ii = 0; ii < enabledTopLevelWindows.size(); ii++ )
124  enabledTopLevelWindows[ii]->Enable( true );
125 
126  WX_EVENT_LOOP event_loop;
127  m_modal_loop = &event_loop;
128  event_loop.Run();
129 
130  } // End of scope for some variables.
131  // End nesting before setting focus below.
132 
133  if( aResult )
134  *aResult = m_modal_string;
135 
136  if( aResultantFocusWindow )
137  {
138  aResultantFocusWindow->Raise();
139 
140  // have the final say, after wxWindowDisabler reenables my parent and
141  // the events settle down, set the focus
142  wxSafeYield();
143  aResultantFocusWindow->SetFocus();
144  }
145 
146  return m_modal_ret_val;
147 }
bool m_modal_ret_val
Definition: kiway_player.h:192
#define WX_EVENT_LOOP
Definition: kiway_player.h:41
wxWindow * m_modal_resultant_parent
Definition: kiway_player.h:190
wxString m_modal_string
Definition: kiway_player.h:191
bool IsModal()
Definition: kiway_player.h:163
WX_EVENT_LOOP * m_modal_loop
Definition: kiway_player.h:189

References KIWAY_PLAYER::IsModal(), KIWAY_PLAYER::m_modal_loop, KIWAY_PLAYER::m_modal_resultant_parent, KIWAY_PLAYER::m_modal_ret_val, KIWAY_PLAYER::m_modal_string, and WX_EVENT_LOOP.

Referenced by FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ SyncToolbars()

void CVPCB_MAINFRAME::SyncToolbars ( )
overridevirtual

Syncronize the toolbar state with the current tool state.

Reimplemented from EDA_BASE_FRAME.

Definition at line 84 of file toolbars_cvpcb.cpp.

85 {
86 #define filterActive( filt ) ( m_filteringOptions & filt )
87 
90 
99  m_mainToolBar->Refresh();
100 }
#define filterActive(filt)
static TOOL_ACTION filterFPbyDisplayName
Definition: cvpcb_actions.h:72
ACTION_TOOLBAR * m_mainToolBar
CVPCB_UNDO_REDO_LIST m_undoList
static TOOL_ACTION redo
Definition: actions.h:68
static TOOL_ACTION filterFPbyPin
Definition: cvpcb_actions.h:70
CVPCB_UNDO_REDO_LIST m_redoList
void Toggle(const TOOL_ACTION &aAction, bool aState)
Applies the default toggle action.
static TOOL_ACTION undo
Definition: actions.h:67
static TOOL_ACTION filterFPbyLibrary
Definition: cvpcb_actions.h:71
static TOOL_ACTION filterFPbyKeywords
Footprint Filtering actions.
Definition: cvpcb_actions.h:69

References filterActive, CVPCB_ACTIONS::filterFPbyDisplayName, CVPCB_ACTIONS::filterFPbyKeywords, CVPCB_ACTIONS::filterFPbyLibrary, CVPCB_ACTIONS::filterFPbyPin, FOOTPRINTS_LISTBOX::FILTERING_BY_COMPONENT_KEYWORD, FOOTPRINTS_LISTBOX::FILTERING_BY_LIBRARY, FOOTPRINTS_LISTBOX::FILTERING_BY_NAME, FOOTPRINTS_LISTBOX::FILTERING_BY_PIN_COUNT, m_mainToolBar, m_redoList, m_undoList, ACTIONS::redo, ACTION_TOOLBAR::Toggle(), and ACTIONS::undo.

Referenced by CVPCB_MAINFRAME().

◆ sys_search()

const SEARCH_STACK & EDA_BASE_FRAME::sys_search ( )
virtualinherited

Return a SEARCH_STACK pertaining to entire program.

This is overloaded in KICAD_MANAGER_FRAME

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 544 of file eda_base_frame.cpp.

545 {
546  return Kiface().KifaceSearch();
547 }
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:51
SEARCH_STACK & KifaceSearch()
Only for DSO specific 'non-library' files.
Definition: kiface_i.h:127

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

Referenced by COMMON_CONTROL::ShowHelp().

◆ ToolStackIsEmpty()

◆ UndoAssociation()

void CVPCB_MAINFRAME::UndoAssociation ( )

Undo the most recent associations that were performed.

Definition at line 384 of file cvpcb_mainframe.cpp.

385 {
386  if( m_undoList.size() == 0 )
387  return;
388 
389  CVPCB_UNDO_REDO_ENTRIES redoEntries;
390  CVPCB_UNDO_REDO_ENTRIES curEntry = m_undoList.back();
391  m_undoList.pop_back();
392 
393  // Iterate over the entries to undo
394  for( auto assoc : curEntry )
395  {
396  AssociateFootprint( assoc, true, false );
397  redoEntries.emplace_back( assoc.Reverse() );
398  }
399 
400  // Add the redo entries to the redo stack
401  m_redoList.emplace_back( redoEntries );
402 }
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_undoList
CVPCB_UNDO_REDO_LIST m_redoList
std::vector< CVPCB_ASSOCIATION > CVPCB_UNDO_REDO_ENTRIES

References AssociateFootprint(), m_redoList, and m_undoList.

Referenced by CVPCB_ASSOCIATION_TOOL::Undo().

◆ unitsChangeRefresh()

virtual void EDA_BASE_FRAME::unitsChangeRefresh ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PCB_BASE_EDIT_FRAME, GERBVIEW_FRAME, EDA_DRAW_FRAME, and PCB_BASE_FRAME.

Definition at line 196 of file eda_base_frame.h.

196 { }

Referenced by EDA_BASE_FRAME::ChangeUserUnits().

◆ UpdateFileHistory()

void EDA_BASE_FRAME::UpdateFileHistory ( const wxString &  FullFileName,
wxFileHistory *  aFileHistory = NULL 
)
inherited

Update the list of recently opened files.

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

Parameters
FullFileNameThe full file name including the path.
aFileHistoryThe wxFileHistory in use. If NULL, the main application file history is used.

Definition at line 562 of file eda_base_frame.cpp.

564 {
565  wxFileHistory* fileHistory = aFileHistory;
566 
567  if( !fileHistory )
568  fileHistory = &Kiface().GetFileHistory();
569 
570  fileHistory->AddFileToHistory( FullFileName );
571 }
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:51
FILE_HISTORY & GetFileHistory()
Definition: kiface_i.h:123

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

Referenced by SCH_EDIT_FRAME::importFile(), GERBVIEW_FRAME::LoadExcellonFiles(), GERBVIEW_FRAME::LoadGerberJobFile(), GERBVIEW_FRAME::loadListOfGerberAndDrillFiles(), PL_EDITOR_FRAME::LoadPageLayoutDescrFile(), KICAD_MANAGER_FRAME::LoadProject(), KICAD_MANAGER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::SavePcbFile(), and GERBVIEW_FRAME::unarchiveFiles().

◆ UpdateStatusBar()

virtual void EDA_BASE_FRAME::UpdateStatusBar ( )
inlinevirtualinherited

Update the status bar information.

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

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

Definition at line 443 of file eda_base_frame.h.

443 { }

Referenced by TOOL_MANAGER::UpdateUI().

Friends And Related Function Documentation

◆ CV::IFACE

friend struct CV::IFACE
friend

Definition at line 62 of file cvpcb_mainframe.h.

Member Data Documentation

◆ KICAD_AUI_TB_STYLE

◆ m_AboutTitle

wxString EDA_BASE_FRAME::m_AboutTitle
protectedinherited

◆ m_actions

◆ m_auimgr

◆ m_autoSaveInterval

◆ m_autoSaveState

bool EDA_BASE_FRAME::m_autoSaveState
protectedinherited

◆ m_autoSaveTimer

wxTimer* EDA_BASE_FRAME::m_autoSaveTimer
protectedinherited

◆ m_compListBox

COMPONENTS_LISTBOX* CVPCB_MAINFRAME::m_compListBox
priva