KiCad PCB EDA Suite
CVPCB_MAINFRAME Class Reference

The CvPcb application main window. More...

#include <cvpcb_mainframe.h>

Inheritance diagram for CVPCB_MAINFRAME:
KIWAY_PLAYER EDA_BASE_FRAME TOOLS_HOLDER KIWAY_HOLDER

Public Types

enum  CVPCB_FILTER_ACTION { FILTER_DISABLE, FILTER_ENABLE, FILTER_TOGGLE }
 The action to apply to a footprint filter when it is modified. More...
 
enum  CONTROL_TYPE { CONTROL_NONE, CONTROL_LIBRARY, CONTROL_COMPONENT, CONTROL_FOOTPRINT }
 The type of the controls present in the application. More...
 
enum  FOCUS_DIR { CHANGE_FOCUS_RIGHT, CHANGE_FOCUS_LEFT }
 Directions to rotate the focus through the listboxes is. More...
 
enum  ITEM_DIR { ITEM_NEXT, ITEM_PREV }
 Directions to move when selecting items. More...
 
enum  CRITERIA { ALL_COMPONENTS, SEL_COMPONENTS, NA_COMPONENTS, ASSOC_COMPONENTS }
 Criteria to use to identify sets of components. More...
 
enum  UNDO_REDO_LIST { UNDO_LIST, REDO_LIST }
 Function ClearUndoORRedoList (virtual). More...
 
enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

 ~CVPCB_MAINFRAME ()
 
bool OpenProjectFiles (const std::vector< wxString > &aFileSet, int aCtl=0) override
 Function OpenProjectFiles is abstract, and opens a project or set of files given by aFileList. More...
 
void KiwayMailIn (KIWAY_EXPRESS &aEvent) override
 Function KiwayMailIn receives KIWAY_EXPRESS messages from other players. More...
 
bool IsContentModified () override
 Get if the current associations have been modified but not saved. More...
 
DISPLAY_FOOTPRINTS_FRAMEGetFootprintViewerFrame () const
 
wxWindow * GetToolCanvas () const override
 Canvas access. More...
 
CVPCB_MAINFRAME::CONTROL_TYPE GetFocusedControl ()
 Find out which control currently has focus. More...
 
wxControl * GetFocusedControlObject ()
 Get a pointer to the currently focused control. More...
 
void SetFocusedControl (CVPCB_MAINFRAME::CONTROL_TYPE aControl)
 Set the focus to a specific control. More...
 
void OnSelectComponent (wxListEvent &event)
 Function OnSelectComponent Called when clicking on a component in component list window. More...
 
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 LoadSettings (APP_SETTINGS_BASE *aCfg) override
 Load common frame parameters from a configuration file. More...
 
void SaveSettings (APP_SETTINGS_BASE *aCfg) override
 Saves common frame parameters to a configuration data file. More...
 
void DisplayStatus ()
 Function DisplayStatus updates the information displayed on the status bar at bottom of the main frame. More...
 
bool LoadFootprintFiles ()
 Function LoadFootprintFiles reads the list of footprint (*.mod files) and generate the list of footprints. More...
 
void SendMessageToEESCHEMA (bool aClearHighligntOnly=false)
 Function SendMessageToEESCHEMA Send a remote command to Eeschema via a socket, Commands are $PART: "reference" put cursor on component anchor. More...
 
COMPONENTGetSelectedComponent ()
 Get the selected component from the component listbox. More...
 
void SetSelectedComponent (int aIndex, bool aSkipUpdate=false)
 Set the currently selected component in the components listbox. More...
 
std::vector< unsigned int > GetComponentIndices (CVPCB_MAINFRAME::CRITERIA aCriteria=CVPCB_MAINFRAME::ALL_COMPONENTS)
 Get the indices for all the components meeting the specified criteria in the components listbox. More...
 
wxString GetSelectedFootprint ()
 
void SetStatusText (const wxString &aText, int aNumber=0) override
 
void SyncToolbars () override
 Syncronize the toolbar state with the current tool state. More...
 
virtual void ParseArgs (wxCmdLineParser &aParser)
 Handles command-line arguments in a frame-specific way. More...
 
virtual bool ShowModal (wxString *aResult=NULL, wxWindow *aResultantFocusWindow=NULL)
 Function ShowModal puts up this wxFrame as if it were a modal dialog, with all other instantiated wxFrames disabled until this KIWAY_PLAYER derivative calls DismissModal(). More...
 
bool Destroy () override
 Our version of Destroy() which is virtual from wxWidgets. More...
 
bool IsModal () const
 
void SetModal (bool aIsModal)
 
bool IsDismissed ()
 Function IsDismissed returns false only if both the frame is acting in modal mode and it has not been dismissed yet with DismissModal(). More...
 
void DismissModal (bool aRetVal, const wxString &aResult=wxEmptyString)
 
EDA_UNITS GetUserUnits () const
 Return the user units currently in use. More...
 
void SetUserUnits (EDA_UNITS aUnits)
 
void ChangeUserUnits (EDA_UNITS aUnits)
 
virtual void ToggleUserUnits ()
 
SETTINGS_MANAGERGetSettingsManager () const
 
virtual int GetSeverity (int aErrorCode) const
 
bool ProcessEvent (wxEvent &aEvent) override
 Override the default process event handler to implement the auto save feature. More...
 
virtual void OnCharHook (wxKeyEvent &event)
 Capture the key event before it is sent to the GUI. More...
 
void OnMenuEvent (wxMenuEvent &event)
 The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves. More...
 
virtual void OnMove (wxMoveEvent &aEvent)
 
void OnMaximize (wxMaximizeEvent &aEvent)
 
void SetAutoSaveInterval (int aInterval)
 
int GetAutoSaveInterval () const
 
bool IsType (FRAME_T aType) const
 
virtual const SEARCH_STACKsys_search ()
 Return a SEARCH_STACK pertaining to entire program. More...
 
virtual wxString help_name ()
 
void OnKicadAbout (wxCommandEvent &event)
 
void OnPreferences (wxCommandEvent &event)
 
void PrintMsg (const wxString &text)
 
WX_INFOBARGetInfoBar ()
 
virtual APP_SETTINGS_BASEconfig () const
 Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME. More...
 
virtual void InstallPreferences (PAGED_DIALOG *, PANEL_HOTKEYS_EDITOR *)
 Function InstallPreferences Allow a frame to load its preference panels (if any) into the preferences dialog. More...
 
void LoadWindowSettings (WINDOW_SETTINGS *aCfg)
 Loads window settings from the given settings object Normally called by LoadSettings unless the window in question is a child window that stores its settings somewhere other than APP_SETTINGS_BASE::m_Window. More...
 
void SaveWindowSettings (WINDOW_SETTINGS *aCfg)
 Saves window settings to the given settings object Normally called by SaveSettings unless the window in question is a child window that stores its settings somewhere other than APP_SETTINGS_BASE::m_Window. More...
 
virtual WINDOW_SETTINGSGetWindowSettings (APP_SETTINGS_BASE *aCfg)
 Returns a pointer to the window settings for this frame. More...
 
wxString ConfigBaseName () override
 
virtual void SaveProjectSettings ()
 Save changes to the project settings to the project (.pro) file. More...
 
void ImportHotkeyConfigFromFile (std::map< std::string, TOOL_ACTION * > aActionMap, const wxString &aDefaultShortname)
 Prompt the user for a hotkey file to read, and read it. More...
 
wxString GetFileFromHistory (int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr)
 Fetches the file name from the file history list. More...
 
void ClearFileHistory (FILE_HISTORY *aFileHistory=nullptr)
 Removes all files from the file history. More...
 
void UpdateFileHistory (const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
 Update the list of recently opened files. More...
 
FILE_HISTORYGetFileHistory ()
 Get the frame's main file history. More...
 
void SetMruPath (const wxString &aPath)
 
wxString GetMruPath () const
 
virtual wxString GetCurrentFileName () const
 Get the full filename + path of the currently opened file in the frame. More...
 
void AddStandardHelpMenu (wxMenuBar *aMenuBar)
 Adds the standard KiCad help menu to the menubar. More...
 
bool IsWritable (const wxFileName &aFileName)
 Checks if aFileName can be written. More...
 
void CheckForAutoSaveFile (const wxFileName &aFileName)
 Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input. More...
 
virtual void UpdateStatusBar ()
 Update the status bar information. More...
 
void CommonSettingsChanged (bool aEnvVarsChanged) override
 Notification event that some of the common (suite-wide) settings have changed. More...
 
const wxString & GetAboutTitle () const
 
void SetShutdownBlockReason (const wxString &reason)
 Sets the block reason why the window/application is preventing OS shutdown. More...
 
void RemoveShutdownBlockReason ()
 Removes any shutdown block reason set. More...
 
bool SupportsShutdownBlockReason ()
 Whether or not the window supports setting a shutdown block reason. More...
 
wxSize GetWindowSize ()
 Get the undecorated window size that can be used for restoring the window size. More...
 
virtual void ClearUndoORRedoList (UNDO_REDO_LIST aList, int aItemCount=-1)
 
virtual void ClearUndoRedoList ()
 Function ClearUndoRedoList clear undo and redo list, using ClearUndoORRedoList() picked items are deleted by ClearUndoORRedoList() according to their status. More...
 
virtual void PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
 Function PushCommandToUndoList add a command to undo in undo list delete the very old commands when the max count of undo commands is reached ( using ClearUndoORRedoList) More...
 
virtual void PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
 Function PushCommandToRedoList add a command to redo in redo list delete the very old commands when the max count of redo commands is reached ( using ClearUndoORRedoList) More...
 
virtual PICKED_ITEMS_LISTPopCommandFromUndoList ()
 PopCommandFromUndoList return the last command to undo and remove it from list nothing is deleted. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromRedoList ()
 PopCommandFromRedoList return the last command to undo and remove it from list nothing is deleted. More...
 
int GetUndoCommandCount () const
 
int GetRedoCommandCount () const
 
int GetMaxUndoItems () const
 
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...
 
virtual void RefreshCanvas ()
 
HOLDER_TYPE GetType ()
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Public Attributes

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
 
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
 
wxPoint m_NormalFramePos
 
wxSize m_NormalFrameSize
 
wxString m_AboutTitle
 
wxAuiManager m_auimgr
 
wxString m_perspective
 
WX_INFOBARm_infoBar
 
wxString m_configName
 
SETTINGS_MANAGERm_settingsManager
 
FILE_HISTORYm_fileHistory
 
bool m_hasAutoSave
 
bool m_autoSaveState
 
int m_autoSaveInterval
 
wxTimer * m_autoSaveTimer
 
bool m_FlagModified
 
bool m_FlagSave
 
int m_UndoRedoCountMax
 
wxString m_mruPath
 
EDA_UNITS m_userUnits
 
TOOL_MANAGERm_toolManager
 
ACTIONSm_actions
 
std::vector< std::string > m_toolStack
 
bool m_immediateActions
 
bool m_dragSelects
 
bool m_moveWarpsCursor
 

Static Protected Attributes

static constexpr int KICAD_AUI_TB_STYLE = wxAUI_TB_DEFAULT_STYLE | wxAUI_TB_PLAIN_BACKGROUND
 

Default style flags used for wxAUI toolbars

More...
 

Private Member Functions

void setupTools ()
 Setup the tool system for the CVPCB main frame. More...
 
void setupEventHandlers ()
 Setup event handlers. More...
 
int buildEquivalenceList (FOOTPRINT_EQUIVALENCE_LIST &aList, wxString *aErrorMessages=NULL)
 read the .equ files and populate the list of equvalents More...
 
void refreshAfterComponentSearch (COMPONENT *component)
 

Private Attributes

NETLIST m_netlist
 
int m_filteringOptions
 
ACTION_TOOLBARm_mainToolBar
 
FOOTPRINTS_LISTBOXm_footprintListBox
 
LIBRARY_LISTBOXm_libListBox
 
COMPONENTS_LISTBOXm_compListBox
 
wxTextCtrl * m_tcFilterString
 
wxStaticText * m_statusLine1
 
wxStaticText * m_statusLine2
 
wxStaticText * m_statusLine3
 
wxButton * m_saveAndContinue
 
TOOL_DISPATCHERm_toolDispatcher
 
ACTION_MENUm_footprintContextMenu
 
ACTION_MENUm_componentContextMenu
 
CVPCB_UNDO_REDO_LIST m_undoList
 
CVPCB_UNDO_REDO_LIST m_redoList
 

Friends

struct CV::IFACE
 

Detailed Description

The CvPcb application main window.

Definition at line 60 of file cvpcb_mainframe.h.

Member Enumeration Documentation

◆ CONTROL_TYPE

The type of the controls present in the application.

Enumerator
CONTROL_NONE 

No controls have focus.

CONTROL_LIBRARY 

Library listbox.

CONTROL_COMPONENT 

Component listbox.

CONTROL_FOOTPRINT 

Footprint listbox.

Definition at line 109 of file cvpcb_mainframe.h.

◆ CRITERIA

Criteria to use to identify sets of components.

Enumerator
ALL_COMPONENTS 

All components.

SEL_COMPONENTS 

Selected components.

NA_COMPONENTS 

Not associated components.

ASSOC_COMPONENTS 

Associated components.

Definition at line 340 of file cvpcb_mainframe.h.

341  {
344  NA_COMPONENTS,
346  };
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 99 of file cvpcb_mainframe.h.

100  {
102  FILTER_ENABLE,
104  };
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 120 of file cvpcb_mainframe.h.

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 42 of file kiway_holder.h.

◆ ITEM_DIR

Directions to move when selecting items.

Enumerator
ITEM_NEXT 

The next item.

ITEM_PREV 

The previous item.

Definition at line 129 of file cvpcb_mainframe.h.

130  {
131  ITEM_NEXT,
132  ITEM_PREV
133  };

◆ UNDO_REDO_LIST

Function ClearUndoORRedoList (virtual).

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

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

Definition at line 551 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ CVPCB_MAINFRAME()

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

Definition at line 56 of file cvpcb_mainframe.cpp.

56  :
57  KIWAY_PLAYER( aKiway, aParent, FRAME_CVPCB, _( "Assign Footprints" ), wxDefaultPosition,
59 {
64  m_modified = false;
65  m_skipComponentSelect = false;
69  m_initialized = false;
70 
71  // Give an icon
72  wxIcon icon;
73  icon.CopyFromBitmap( KiBitmap( icon_cvpcb_xpm ) );
74  SetIcon( icon );
75 
76  SetAutoLayout( true );
77 
78  LoadSettings( config() );
79 
80  setupTools();
83 
84  // Create list of available modules and components of the schematic
88 
89  m_auimgr.SetManagedWindow( this );
90 
91  m_auimgr.AddPane( m_mainToolBar, EDA_PANE().HToolbar().Name( "MainToolbar" ).Top().Layer(6) );
92 
93  m_auimgr.AddPane( m_libListBox, EDA_PANE().Palette().Name( "Libraries" ).Left().Layer(1)
94  .Caption( _( "Footprint Libraries" ) )
95  .BestSize( (int) ( m_FrameSize.x * 0.20 ), m_FrameSize.y ) );
96 
97  m_auimgr.AddPane( m_compListBox, EDA_PANE().Palette().Name( "Components" ).Center().Layer(0)
98  .Caption( _( "Symbol : Footprint Assignments" ) ) );
99 
100  m_auimgr.AddPane( m_footprintListBox, EDA_PANE().Palette().Name( "Footprints" ).Right().Layer(1)
101  .Caption( _( "Filtered Footprints" ) )
102  .BestSize( (int) ( m_FrameSize.x * 0.30 ), m_FrameSize.y ) );
103 
104  // Build the bottom panel, to display 2 status texts and the buttons:
105  auto bottomPanel = new wxPanel( this );
106  auto panelSizer = new wxBoxSizer( wxVERTICAL );
107 
108  wxFlexGridSizer* fgSizerStatus = new wxFlexGridSizer( 3, 1, 0, 0 );
109  fgSizerStatus->SetFlexibleDirection( wxBOTH );
110  fgSizerStatus->SetNonFlexibleGrowMode( wxFLEX_GROWMODE_SPECIFIED );
111 
112  m_statusLine1 = new wxStaticText( bottomPanel, wxID_ANY, wxEmptyString );
113  fgSizerStatus->Add( m_statusLine1, 0, 0, 5 );
114 
115  m_statusLine2 = new wxStaticText( bottomPanel, wxID_ANY, wxEmptyString );
116  fgSizerStatus->Add( m_statusLine2, 0, 0, 5 );
117 
118  m_statusLine3 = new wxStaticText( bottomPanel, wxID_ANY, wxEmptyString );
119  fgSizerStatus->Add( m_statusLine3, 0, wxBOTTOM, 3 );
120 
121  panelSizer->Add( fgSizerStatus, 1, wxEXPAND|wxLEFT, 2 );
122 
123  wxStaticLine* staticline1 = new wxStaticLine( bottomPanel );
124  panelSizer->Add( staticline1, 0, wxEXPAND, 5 );
125 
126  wxFont statusFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
127  statusFont.SetSymbolicSize( wxFONTSIZE_SMALL );
128  m_statusLine1->SetFont( statusFont );
129  m_statusLine2->SetFont( statusFont );
130  m_statusLine3->SetFont( statusFont );
131 
132  // Add buttons:
133  auto buttonsSizer = new wxBoxSizer( wxHORIZONTAL );
134  auto sdbSizer = new wxStdDialogButtonSizer();
135 
136  m_saveAndContinue = new wxButton( bottomPanel, ID_SAVE_PROJECT,
137  _( "Apply, Save Schematic && Continue" ) );
138  buttonsSizer->Add( m_saveAndContinue, 0, wxALIGN_CENTER_VERTICAL|wxRIGHT, 20 );
139 
140  auto sdbSizerOK = new wxButton( bottomPanel, wxID_OK );
141  sdbSizer->AddButton( sdbSizerOK );
142  auto sdbSizerCancel = new wxButton( bottomPanel, wxID_CANCEL );
143  sdbSizer->AddButton( sdbSizerCancel );
144  sdbSizer->Realize();
145 
146  buttonsSizer->Add( sdbSizer, 0, 0, 5 );
147  panelSizer->Add( buttonsSizer, 0, wxALIGN_RIGHT|wxALL, 5 );
148 
149  bottomPanel->SetSizer( panelSizer );
150  bottomPanel->Fit();
151 
152  sdbSizerOK->SetDefault();
154 
155  m_auimgr.AddPane( bottomPanel, EDA_PANE().HToolbar().Name( "Buttons" ).Bottom().Layer(6) );
156 
157  m_auimgr.Update();
158  m_initialized = true;
159 
160  // Connect Events
162 
163  // Start the main processing loop
164  m_toolManager->InvokeTool( "cvpcb.Control" );
165 
166  // Ensure the toolbars are sync'd properly so the filtering options display correct
167  SyncToolbars();
168 
169  SetShutdownBlockReason( _( "Symbol to footprint changes are unsaved" ) );
170 }
const BITMAP_OPAQUE icon_cvpcb_xpm[1]
Definition: icon_cvpcb.cpp:158
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 SetShutdownBlockReason(const wxString &reason)
Sets the block reason why the window/application is preventing OS shutdown.
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
COMPONENTS_LISTBOX * m_compListBox
KIWAY_PLAYER(KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aWdoName=wxFrameNameStr)
#define CVPCB_MAINFRAME_NAME
void setupEventHandlers()
Setup event handlers.
wxAuiManager m_auimgr
wxStaticText * m_statusLine3
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.
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:80
wxTextCtrl * m_tcFilterString
static FOOTPRINT_LIST * GetInstance(KIWAY &aKiway)
Factory function to return a FOOTPRINT_LIST via Kiway.
#define NULL
ACTION_TOOLBAR * m_mainToolBar
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
#define KICAD_DEFAULT_DRAWFRAME_STYLE
void ReCreateMenuBar() override
Recreates the menu bar.
void BuildFOOTPRINTS_LISTBOX()
Specialization of the wxAuiPaneInfo class for KiCad panels.
LIBRARY_LISTBOX * m_libListBox
wxStaticText * m_statusLine2
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition: gtk/ui.cpp:38
#define _(s)
Definition: 3d_actions.cpp:33
FOOTPRINTS_LISTBOX * m_footprintListBox
wxButton * m_saveAndContinue
void setupTools()
Setup the tool system for the CVPCB main frame.
wxStaticText * m_statusLine1

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

◆ ~CVPCB_MAINFRAME()

CVPCB_MAINFRAME::~CVPCB_MAINFRAME ( )

Definition at line 173 of file cvpcb_mainframe.cpp.

174 {
175  // Shutdown all running tools
176  if( m_toolManager )
178 
179  // Clean up the tool infrastructure
180  delete m_actions;
181  delete m_toolManager;
182  delete m_toolDispatcher;
183 
184  m_auimgr.UnInit();
185 }
void ShutdownAllTools()
Shutdown all tools with a currently registered event loop in this tool manager by waking them up with...
wxAuiManager m_auimgr
ACTIONS * m_actions
Definition: tools_holder.h:49
TOOL_DISPATCHER * m_toolDispatcher
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48

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

Member Function Documentation

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar *  aMenuBar)
inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 298 of file eda_base_frame.cpp.

299 {
300  COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
301  ACTION_MENU* helpMenu = new ACTION_MENU( false );
302 
303  helpMenu->SetTool( commonControl );
304 
305  helpMenu->Add( ACTIONS::help );
306  helpMenu->Add( ACTIONS::gettingStarted );
307  helpMenu->Add( ACTIONS::listHotKeys );
308  helpMenu->Add( ACTIONS::getInvolved );
309  helpMenu->Add( ACTIONS::reportBug );
310 
311  helpMenu->AppendSeparator();
312  helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, about_xpm );
313 
314  aMenuBar->Append( helpMenu, _( "&Help" ) );
315 }
static TOOL_ACTION listHotKeys
Definition: actions.h:172
ACTION_MENU.
Definition: action_menu.h:44
static TOOL_ACTION reportBug
Definition: actions.h:174
const BITMAP_OPAQUE about_xpm[1]
Definition: about.cpp:84
COMMON_CONTROL.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
#define _(s)
Definition: 3d_actions.cpp:33
static TOOL_ACTION help
Definition: actions.h:171
static TOOL_ACTION getInvolved
Definition: actions.h:173
static TOOL_ACTION gettingStarted
Definition: actions.h:170

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

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

◆ AssociateFootprint()

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

Associate a footprint with a specific component in the list.

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

Parameters
aAssociationis the association to perform
aNewEntryspecifies if this association should be a new entry in the undo list
aAddUndoItemspecifies if an undo item should be created for this association

Definition at line 417 of file cvpcb_mainframe.cpp.

419 {
420  if( m_netlist.IsEmpty() )
421  return;
422 
423  COMPONENT* component = m_netlist.GetComponent( aAssociation.GetComponentIndex() );
424 
425  if( component == NULL )
426  return;
427 
428  LIB_ID fpid = aAssociation.GetNewFootprint();
429  LIB_ID oldFpid = component->GetFPID();
430 
431  // Test for validity of the requested footprint
432  if( !fpid.empty() && !fpid.IsValid() )
433  {
434  wxString msg =
435  wxString::Format( _( "\"%s\" is not a valid footprint." ), fpid.Format().wx_str() );
436  DisplayErrorMessage( this, msg );
437  return;
438  }
439 
440  // Set the new footprint
441  component->SetFPID( fpid );
442 
443  // create the new component description and set it
444  wxString description = wxString::Format( CMP_FORMAT,
445  aAssociation.GetComponentIndex() + 1,
446  component->GetReference(),
447  component->GetValue(),
448  component->GetFPID().Format().wx_str() );
449  m_compListBox->SetString( aAssociation.GetComponentIndex(), description );
450 
451  // Mark the data as being modified
452  m_modified = true;
453 
454  // Update the statusbar and refresh the list
455  DisplayStatus();
456  m_compListBox->Refresh();
457 
458  if( !aAddUndoItem )
459  return;
460 
461  // Update the undo list
462  if ( aNewEntry )
463  {
464  // Create a new entry for this association
465  CVPCB_UNDO_REDO_ENTRIES newEntry;
466  newEntry.emplace_back( CVPCB_ASSOCIATION( aAssociation.GetComponentIndex(), oldFpid,
467  aAssociation.GetNewFootprint() ) );
468  m_undoList.emplace_back( newEntry );
469 
470  // Clear the redo list
471  m_redoList.clear();
472  }
473  else
474  m_undoList.back().emplace_back( CVPCB_ASSOCIATION( aAssociation.GetComponentIndex(),
475  oldFpid, aAssociation.GetNewFootprint() ) );
476 
477 }
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:252
#define CMP_FORMAT
The print format to display a schematic component line.
void SetFPID(const LIB_ID &aFPID)
Definition: pcb_netlist.h:148
COMPONENTS_LISTBOX * m_compListBox
LIB_ID GetNewFootprint() const
Get the new footprint to associate to the component.
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
bool IsValid() const
Definition: lib_id.h:171
bool empty() const
Definition: lib_id.h:186
const LIB_ID & GetFPID() const
Definition: pcb_netlist.h:149
unsigned int GetComponentIndex() const
Get the index of the component to modify the association of.
#define NULL
const wxString & GetReference() const
Definition: pcb_netlist.h:144
CVPCB_UNDO_REDO_LIST m_undoList
UTF8 Format() const
Definition: lib_id.cpp:237
COMPONENT is used to store components and all of their related information found in a netlist.
Definition: pcb_netlist.h:80
COMPONENT * GetComponent(unsigned aIndex)
Function GetComponent returns the COMPONENT at aIndex.
Definition: pcb_netlist.h:237
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
#define _(s)
Definition: 3d_actions.cpp:33
CVPCB_UNDO_REDO_LIST m_redoList
void SetString(unsigned linecount, const wxString &text)
wxString wx_str() const
Definition: utf8.cpp:51
A class to define a footprint association to be made in cvpcb.
bool IsEmpty() const
Function IsEmpty()
Definition: pcb_netlist.h:216
const wxString & GetValue() const
Definition: pcb_netlist.h:146
void DisplayStatus()
Function DisplayStatus updates the information displayed on the status bar at bottom of the main fram...
std::vector< CVPCB_ASSOCIATION > CVPCB_UNDO_REDO_ENTRIES

References _, CMP_FORMAT, DisplayErrorMessage(), DisplayStatus(), LIB_ID::empty(), LIB_ID::Format(), Format(), NETLIST::GetComponent(), CVPCB_ASSOCIATION::GetComponentIndex(), COMPONENT::GetFPID(), CVPCB_ASSOCIATION::GetNewFootprint(), COMPONENT::GetReference(), COMPONENT::GetValue(), NETLIST::IsEmpty(), LIB_ID::IsValid(), m_compListBox, m_modified, m_netlist, m_redoList, m_undoList, NULL, COMPONENT::SetFPID(), COMPONENTS_LISTBOX::SetString(), and UTF8::wx_str().

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

◆ AutomaticFootprintMatching()

void CVPCB_MAINFRAME::AutomaticFootprintMatching ( )

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

Definition at line 167 of file auto_associate.cpp.

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

799 {
800  wxString msg;
801  COMPONENT* component;
802  wxFont guiFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
803 
804  if( m_compListBox == NULL )
805  {
807  m_compListBox->SetFont( wxFont( guiFont.GetPointSize(), wxFONTFAMILY_MODERN,
808  wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL ) );
809  }
810 
812 
813  for( unsigned i = 0; i < m_netlist.GetCount(); i++ )
814  {
815  component = m_netlist.GetComponent( i );
816 
817  msg.Printf( CMP_FORMAT,
818  m_compListBox->GetCount() + 1,
819  component->GetReference(),
820  component->GetValue(),
821  component->GetFPID().Format().wx_str() );
822  m_compListBox->m_ComponentList.Add( msg );
823  }
824 
825  if( m_compListBox->m_ComponentList.Count() )
826  {
827  m_compListBox->SetItemCount( m_compListBox->m_ComponentList.Count() );
828  m_compListBox->SetSelection( 0, true );
829  m_compListBox->RefreshItems( 0L, m_compListBox->m_ComponentList.Count()-1 );
831  }
832 }
#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:228
const LIB_ID & GetFPID() const
Definition: pcb_netlist.h:149
#define NULL
void UpdateWidth(int aLine=-1)
const wxString & GetReference() const
Definition: pcb_netlist.h:144
UTF8 Format() const
Definition: lib_id.cpp:237
COMPONENT is used to store components and all of their related information found in a netlist.
Definition: pcb_netlist.h:80
COMPONENT * GetComponent(unsigned aIndex)
Function GetComponent returns the COMPONENT at aIndex.
Definition: pcb_netlist.h:237
wxArrayString m_ComponentList
Definition: listboxes.h:193
wxString wx_str() const
Definition: utf8.cpp:51
const wxString & GetValue() const
Definition: pcb_netlist.h:146

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

Referenced by CVPCB_MAINFRAME().

◆ buildEquivalenceList()

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

read the .equ files and populate the list of equvalents

Parameters
aListthe list to populate
aErrorMessagesis a pointer to a wxString to store error messages (can be NULL)
Returns
the error count ( 0 = no error)

Definition at line 79 of file auto_associate.cpp.

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

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

Referenced by AutomaticFootprintMatching().

◆ BuildFOOTPRINTS_LISTBOX()

void CVPCB_MAINFRAME::BuildFOOTPRINTS_LISTBOX ( )

Definition at line 781 of file cvpcb_mainframe.cpp.

782 {
783  wxFont guiFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
784 
785  if( m_footprintListBox == NULL )
786  {
788  m_footprintListBox->SetFont( wxFont( guiFont.GetPointSize(), wxFONTFAMILY_MODERN,
789  wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL ) );
790  }
791 
794  DisplayStatus();
795 }
FOOTPRINT_LIST * m_FootprintsList
#define NULL
FOOTPRINTS_LISTBOX * m_footprintListBox
void SetFootprints(FOOTPRINT_LIST &aList, const wxString &aLibName, COMPONENT *aComponent, const wxString &aFootPrintFilterPattern, int aFilterType)
Function SetFootprints populates the wxListCtrl with the footprints from aList that meet the filter c...
void DisplayStatus()
Function DisplayStatus updates the information displayed on the status bar at bottom of the main fram...

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

Referenced by CVPCB_MAINFRAME(), and ReadNetListAndFpFiles().

◆ BuildLIBRARY_LISTBOX()

void CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX ( )

Definition at line 835 of file cvpcb_mainframe.cpp.

836 {
837  wxFont guiFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
838 
839  if( m_libListBox == NULL )
840  {
842  m_libListBox->SetFont( wxFont( guiFont.GetPointSize(), wxFONTFAMILY_MODERN,
843  wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL ) );
844  }
845 
846  FP_LIB_TABLE* tbl = Prj().PcbFootprintLibs( Kiway() );
847 
848  if( tbl )
849  {
850  wxArrayString libNames;
851 
852  std::vector< wxString > libNickNames = tbl->GetLogicalLibs();
853 
854  for( const wxString& libNickName : libNickNames )
855  libNames.Add( libNickName );
856 
857  m_libListBox->SetLibraryList( libNames );
858  }
859 }
void SetLibraryList(const wxArrayString &aList)
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
#define NULL
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
LIBRARY_LISTBOX * m_libListBox
VTBL_ENTRY FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
Definition: project.cpp:284
std::vector< wxString > GetLogicalLibs()
Return the logical library names, all of them that are pertinent to a look up done on this LIB_TABLE.

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

Referenced by CVPCB_MAINFRAME(), and ReadNetListAndFpFiles().

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS  aUnits)
inherited

Definition at line 846 of file eda_base_frame.cpp.

847 {
848  SetUserUnits( aUnits );
850 
851  wxCommandEvent e( UNITS_CHANGED );
852  ProcessEventLocally( e );
853 }
virtual void unitsChangeRefresh()
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
void SetUserUnits(EDA_UNITS aUnits)

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

Referenced by COMMON_TOOLS::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 744 of file eda_base_frame.cpp.

745 {
746  wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
747 
748  wxFileName autoSaveFileName = aFileName;
749 
750  // Check for auto save file.
751  autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
752 
753  wxLogTrace( traceAutoSave,
754  wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
755 
756  if( !autoSaveFileName.FileExists() )
757  return;
758 
759  wxString msg = wxString::Format( _(
760  "Well this is potentially embarrassing!\n"
761  "It appears that the last time you were editing the file\n"
762  "\"%s\"\n"
763  "it was not saved properly. Do you wish to restore the last saved edits you made?" ),
764  GetChars( aFileName.GetFullName() )
765  );
766 
767  int response = wxMessageBox( msg, Pgm().App().GetAppName(), wxYES_NO | wxICON_QUESTION, this );
768 
769  // Make a backup of the current file, delete the file, and rename the auto save file to
770  // the file name.
771  if( response == wxYES )
772  {
773  if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
774  {
775  wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
776  Pgm().App().GetAppName(), wxOK | wxICON_EXCLAMATION, this );
777  }
778  }
779  else
780  {
781  wxLogTrace( traceAutoSave,
782  wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
783 
784  // Remove the auto save file when using the previous file as is.
785  wxRemoveFile( autoSaveFileName.GetFullPath() );
786  }
787 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
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:153
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
#define _(s)
Definition: 3d_actions.cpp:33

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

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

◆ ClearFileHistory()

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

Removes all files from the file history.

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

Definition at line 641 of file eda_base_frame.cpp.

642 {
643  if( !aFileHistory )
644  aFileHistory = m_fileHistory;
645 
646  wxASSERT( aFileHistory );
647 
648  aFileHistory->ClearFileHistory();
649 
650  // Update the menubar to update the file history menu
651  if( GetMenuBar() )
652  {
653  ReCreateMenuBar();
654  GetMenuBar()->Refresh();
655  }
656 }
void ClearFileHistory()
Clear all entries from the file history.
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.

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

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

◆ ClearUndoORRedoList()

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

◆ ClearUndoRedoList()

◆ CommonSettingsChanged()

void EDA_BASE_FRAME::CommonSettingsChanged ( bool  aEnvVarsChanged)
overridevirtualinherited

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

Update menus, toolbars, local variables, etc.

Reimplemented from TOOLS_HOLDER.

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

Definition at line 328 of file eda_base_frame.cpp.

329 {
330  TOOLS_HOLDER::CommonSettingsChanged( aEnvVarsChanged );
331 
332  COMMON_SETTINGS* settings = Pgm().GetCommonSettings();
333 
334  if( m_fileHistory )
335  {
336  int historySize = settings->m_System.file_history_size;
337  m_fileHistory->SetMaxFiles( (unsigned) std::max( 0, historySize ) );
338  }
339 
340  if( GetMenuBar() )
341  {
342  // For icons in menus, icon scaling & hotkeys
343  ReCreateMenuBar();
344  GetMenuBar()->Refresh();
345  }
346 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
virtual void CommonSettingsChanged(bool aEnvVarsChanged)
Notification event that some of the common (suite-wide) settings have changed.
void SetMaxFiles(size_t aMaxFiles)
Update the number of files that will be contained inside the file history.
Definition: filehistory.cpp:83
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.

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

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

◆ config()

APP_SETTINGS_BASE * EDA_BASE_FRAME::config ( ) const
virtualinherited

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

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 558 of file eda_base_frame.cpp.

559 {
560  // KICAD_MANAGER_FRAME overrides this
561  return Kiface().KifaceSettings();
562 }
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_i.h:103
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.

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

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::ActivateGalCanvas(), BM2CMP_FRAME::BM2CMP_FRAME(), CVPCB_MAINFRAME(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), SCH_BASE_FRAME::eeconfig(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), DISPLAY_FOOTPRINTS_FRAME::GetAutoZoom(), GRID_MENU::GRID_MENU(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), EDA_DRAW_FRAME::IsGridVisible(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), SCH_BASE_FRAME::libeditconfig(), SIM_PLOT_FRAME::onClose(), FOOTPRINT_WIZARD_FRAME::OnCloseWindow(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), DISPLAY_FOOTPRINTS_FRAME::SetAutoZoom(), PCB_BASE_EDIT_FRAME::SetBoard(), EDA_DRAW_FRAME::SetGridVisibility(), PL_EDITOR_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupTools(), LIB_VIEW_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), LIB_EDIT_FRAME::setupTools(), setupTools(), SCH_EDIT_FRAME::setupTools(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), ZOOM_MENU::update(), GRID_MENU::update(), EDA_DRAW_FRAME::UpdateGridSelectBox(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), EDA_BASE_FRAME::windowClosing(), ZOOM_MENU::ZOOM_MENU(), and BM2CMP_FRAME::~BM2CMP_FRAME().

◆ ConfigBaseName()

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

Reimplemented from TOOLS_HOLDER.

Definition at line 348 of file eda_base_frame.h.

349  {
350  wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
351  return baseCfgName;
352  }
wxString m_configName

References EDA_BASE_FRAME::m_configName.

Referenced by EDA_BASE_FRAME::SaveWindowSettings().

◆ CurrentToolName()

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

Definition at line 99 of file tools_holder.cpp.

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

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

Referenced by TOOL_MANAGER::processEvent().

◆ Destroy()

◆ DismissModal()

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

Definition at line 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:205
wxString m_modal_string
Definition: kiway_player.h:204
WX_EVENT_LOOP * m_modal_loop
Definition: kiway_player.h:202

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

561 {
562  if( !m_initialized )
563  return;
564 
565  wxString filters, msg;
566  COMPONENT* component = GetSelectedComponent();
567 
569  {
570  msg.Empty();
571 
572  if( component )
573  {
574  for( unsigned ii = 0; ii < component->GetFootprintFilters().GetCount(); ii++ )
575  {
576  if( msg.IsEmpty() )
577  msg += component->GetFootprintFilters()[ii];
578  else
579  msg += wxT( ", " ) + component->GetFootprintFilters()[ii];
580  }
581  }
582 
583  filters += _( "key words" );
584 
585  if( !msg.IsEmpty() )
586  filters += wxString::Format( wxT( " (%s)" ), msg );
587  }
588 
590  {
591  msg.Empty();
592 
593  if( component )
594  msg = wxString::Format( wxT( "%i" ), component->GetPinCount() );
595 
596  if( !filters.IsEmpty() )
597  filters += wxT( ", " );
598 
599  filters += _( "pin count" );
600 
601  if( !msg.IsEmpty() )
602  filters += wxString::Format( wxT( " (%s)" ), msg );
603  }
604 
606  {
608 
609  if( !filters.IsEmpty() )
610  filters += wxT( ", " );
611 
612  filters += _( "library" );
613 
614  if( !msg.IsEmpty() )
615  filters += wxString::Format( wxT( " (%s)" ), msg );
616  }
617 
618  wxString textFilter = m_tcFilterString->GetValue();
619 
620  if( !textFilter.IsEmpty() )
621  {
622  if( !filters.IsEmpty() )
623  filters += wxT( ", " );
624 
625  filters += _( "search text" ) + wxString::Format( wxT( " (%s)" ), textFilter );
626  }
627 
628  if( filters.IsEmpty() )
629  msg = _( "No filtering" );
630  else
631  msg.Printf( _( "Filtered by %s" ), GetChars( filters ) );
632 
633  msg << wxT( ": " ) << m_footprintListBox->GetCount();
634 
635  SetStatusText( msg );
636 
637 
638  msg.Empty();
639  wxString footprintName = GetSelectedFootprint();
640 
641  FOOTPRINT_INFO* module = m_FootprintsList->GetModuleInfo( footprintName );
642 
643  if( module ) // can be NULL if no netlist loaded
644  {
645  msg = wxString::Format( _( "Description: %s; Key words: %s" ),
646  module->GetDescription(),
647  module->GetKeywords() );
648  }
649 
650  SetStatusText( msg, 1 );
651 
652  msg.Empty();
653  wxString lib;
654 
655  // Choose the footprint to get the information on
656  if( module )
657  {
658  // Use the footprint in the footprint viewer
659  lib = module->GetLibNickname();
660  }
662  {
663  // Use the footprint of the selected component
664  if( component )
665  lib = component->GetFPID().GetLibNickname();
666  }
668  {
669  // Use the library that is selected
671  }
672 
673  // Extract the library information
674  FP_LIB_TABLE* fptbl = Prj().PcbFootprintLibs( Kiway() );
675 
676  if( fptbl->HasLibrary( lib ) )
677  msg = wxString::Format( _( "Library location: %s" ), fptbl->GetFullURI( lib ) );
678  else
679  msg = wxString::Format( _( "Library location: unknown" ) );
680 
681  SetStatusText( msg, 2 );
682 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
bool HasLibrary(const wxString &aNickname, bool aCheckEnabled=false) const
Test for the existence of aNickname in the library table.
FOOTPRINT_LIST * m_FootprintsList
FOOTPRINT_INFO * GetModuleInfo(const wxString &aFootprintId)
Get info for a module by id.
wxString GetLibNickname() const override
wxString GetDescription() override
const LIB_ID & GetFPID() const
Definition: pcb_netlist.h:149
wxTextCtrl * m_tcFilterString
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
wxString GetFullURI(const wxString &aLibNickname, bool aExpandEnvVars=true) const
Return the full URI of the library mapped to aLibNickname.
wxString GetSelectedLibrary()
void SetStatusText(const wxString &aText, int aNumber=0) override
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
LIBRARY_LISTBOX * m_libListBox
COMPONENT is used to store components and all of their related information found in a netlist.
Definition: pcb_netlist.h:80
VTBL_ENTRY FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
Definition: project.cpp:284
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:153
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
#define _(s)
Definition: 3d_actions.cpp:33
COMPONENT * GetSelectedComponent()
Get the selected component from the component listbox.
FOOTPRINTS_LISTBOX * m_footprintListBox
int GetPinCount() const
Definition: pcb_netlist.h:160
wxString GetKeywords()
const wxArrayString & GetFootprintFilters() const
Definition: pcb_netlist.h:157
CVPCB_MAINFRAME::CONTROL_TYPE GetFocusedControl()
Find out which control currently has focus.

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

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

◆ DisplayToolMsg()

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

Reimplemented in EDA_DRAW_FRAME.

Definition at line 89 of file tools_holder.h.

89 {};

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

◆ doAutoSave()

bool EDA_BASE_FRAME::doAutoSave ( )
protectedvirtualinherited

This should be overridden by the derived class to handle the auto save feature.

Returns
true if the auto save was successful otherwise false.

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 269 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const
inlineinherited

Definition at line 499 of file eda_base_frame.h.

499 { return m_AboutTitle; }
wxString m_AboutTitle

References EDA_BASE_FRAME::m_AboutTitle.

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

◆ GetAutoSaveFilePrefix()

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

Definition at line 176 of file eda_base_frame.h.

177  {
178  return wxT( "_autosave-" );
179  }

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

270 { 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 168 of file eda_base_frame.h.

169  {
170  return wxT( "-bak" );
171  }

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

894 {
895  std::vector<unsigned int> idx;
896 
897  // Make sure a netlist has been loaded and the box has contents
898  if( m_netlist.IsEmpty() || m_compListBox->GetCount() == 0 )
899  return idx;
900 
901  switch( aCriteria )
902  {
904  idx.resize( m_netlist.GetCount() );
905  std::iota( idx.begin(), idx.end(), 0 );
906  break;
907 
909  {
910  // Check to see if anything is selected
911  if( m_compListBox->GetSelectedItemCount() < 1 )
912  break;
913 
914  // Get the components
915  int lastIdx = m_compListBox->GetFirstSelected();
916  idx.emplace_back( lastIdx );
917 
918  lastIdx = m_compListBox->GetNextSelected( lastIdx );
919  while( lastIdx > 0 )
920  {
921  idx.emplace_back( lastIdx );
922  lastIdx = m_compListBox->GetNextSelected( lastIdx );
923  }
924  break;
925  }
927  for( unsigned int i = 0; i < m_netlist.GetCount(); i++ )
928  {
929  if( m_netlist.GetComponent( i )->GetFPID().empty() )
930  idx.emplace_back( i );
931  }
932  break;
933 
935  for( unsigned int i = 0; i < m_netlist.GetCount(); i++ )
936  {
937  if( !m_netlist.GetComponent( i )->GetFPID().empty() )
938  idx.emplace_back( i );
939  }
940  break;
941 
942  default:
943  wxASSERT_MSG( false, "Invalid component selection criteria" );
944  }
945 
946  return idx;
947 }
COMPONENTS_LISTBOX * m_compListBox
unsigned GetCount() const
Function GetCount.
Definition: pcb_netlist.h:228
bool empty() const
Definition: lib_id.h:186
const LIB_ID & GetFPID() const
Definition: pcb_netlist.h:149
COMPONENT * GetComponent(unsigned aIndex)
Function GetComponent returns the COMPONENT at aIndex.
Definition: pcb_netlist.h:237
bool IsEmpty() const
Function IsEmpty()
Definition: pcb_netlist.h:216
Not associated components.

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

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

◆ GetCurrentFileName()

virtual wxString EDA_BASE_FRAME::GetCurrentFileName ( ) const
inlinevirtualinherited

Get the full filename + path of the currently opened file in the frame.

If no file is open, an empty string is returned.

Returns
the filename and full path to the open file

Reimplemented in PCB_EDIT_FRAME, SCH_EDIT_FRAME, PL_EDITOR_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 429 of file eda_base_frame.h.

429 { return wxEmptyString; }

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const
inlineinherited

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

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

Definition at line 95 of file tools_holder.h.

95 { return m_immediateActions; }
bool m_immediateActions
Definition: tools_holder.h:59

References TOOLS_HOLDER::m_immediateActions.

◆ GetDragSelects()

bool TOOLS_HOLDER::GetDragSelects ( ) const
inlineinherited

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

Definition at line 101 of file tools_holder.h.

101 { return m_dragSelects; }
bool m_dragSelects
Definition: tools_holder.h:63

References TOOLS_HOLDER::m_dragSelects.

Referenced by EE_SELECTION_TOOL::Main().

◆ GetFileFromHistory()

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

Fetches the file name from the file history list.

This removes the selected file, if this file does not exist. The menu is also updated, if FILE_HISTORY::UseMenu was called at init time

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

Definition at line 601 of file eda_base_frame.cpp.

603 {
604  if( !aFileHistory )
605  aFileHistory = m_fileHistory;
606 
607  wxASSERT( aFileHistory );
608 
609  int baseId = aFileHistory->GetBaseId();
610 
611  wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );
612 
613  unsigned i = cmdId - baseId;
614 
615  if( i < aFileHistory->GetCount() )
616  {
617  wxString fn = aFileHistory->GetHistoryFile( i );
618 
619  if( wxFileName::FileExists( fn ) )
620  return fn;
621  else
622  {
623  wxString msg = wxString::Format( _( "File \"%s\" was not found." ), fn );
624  wxMessageBox( msg );
625 
626  aFileHistory->RemoveFileFromHistory( i );
627  }
628  }
629 
630  // Update the menubar to update the file history menu
631  if( GetMenuBar() )
632  {
633  ReCreateMenuBar();
634  GetMenuBar()->Refresh();
635  }
636 
637  return wxEmptyString;
638 }
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
#define _(s)
Definition: 3d_actions.cpp:33
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.

References _, Format(), EDA_BASE_FRAME::m_fileHistory, and EDA_BASE_FRAME::ReCreateMenuBar().

Referenced by GERBVIEW_FRAME::OnDrlFileHistory(), KICAD_MANAGER_FRAME::OnFileHistory(), PL_EDITOR_FRAME::OnFileHistory(), PCB_EDIT_FRAME::OnFileHistory(), GERBVIEW_FRAME::OnGbrFileHistory(), GERBVIEW_FRAME::OnJobFileHistory(), SCH_EDIT_FRAME::OnLoadFile(), and GERBVIEW_FRAME::OnZipFileHistory().

◆ GetFileHistory()

FILE_HISTORY& EDA_BASE_FRAME::GetFileHistory ( )
inlineinherited

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

965 {
966  if( m_libListBox->HasFocus() )
968  else if( m_compListBox->HasFocus() )
970  else if( m_footprintListBox->HasFocus() )
972 
974 }
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 977 of file cvpcb_mainframe.cpp.

978 {
979  if( m_libListBox->HasFocus() )
980  return m_libListBox;
981  else if( m_compListBox->HasFocus() )
982  return m_compListBox;
983  else if( m_footprintListBox->HasFocus() )
984  return m_footprintListBox;
985 
986  return nullptr;
987 }
COMPONENTS_LISTBOX * m_compListBox
LIBRARY_LISTBOX * m_libListBox
FOOTPRINTS_LISTBOX * m_footprintListBox

References m_compListBox, m_footprintListBox, and m_libListBox.

◆ GetFootprintViewerFrame()

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

Definition at line 950 of file cvpcb_mainframe.cpp.

951 {
952  // returns the Footprint Viewer frame, if exists, or NULL
953  return dynamic_cast<DISPLAY_FOOTPRINTS_FRAME*>
954  ( wxWindow::FindWindowByName( FOOTPRINTVIEWER_FRAME_NAME ) );
955 }
#define FOOTPRINTVIEWER_FRAME_NAME

References FOOTPRINTVIEWER_FRAME_NAME.

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

◆ GetInfoBar()

WX_INFOBAR* EDA_BASE_FRAME::GetInfoBar ( )
inlineinherited

Definition at line 288 of file eda_base_frame.h.

288 { return m_infoBar; }
WX_INFOBAR * m_infoBar

References EDA_BASE_FRAME::m_infoBar.

Referenced by PAD_TOOL::EditPad(), and SCH_EDIT_TOOL::RefreshSymbolFromLibrary().

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const
inlineinherited

Definition at line 596 of file eda_base_frame.h.

596 { return m_UndoRedoCountMax; }

References EDA_BASE_FRAME::m_UndoRedoCountMax.

Referenced by EDA_DRAW_FRAME::SaveSettings().

◆ GetMoveWarpsCursor()

bool TOOLS_HOLDER::GetMoveWarpsCursor ( ) const
inlineinherited

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

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

Definition at line 107 of file tools_holder.h.

107 { return m_moveWarpsCursor; }
bool m_moveWarpsCursor
Definition: tools_holder.h:64

References TOOLS_HOLDER::m_moveWarpsCursor.

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

◆ GetMruPath()

◆ GetRedoCommandCount()

◆ GetSelectedComponent()

COMPONENT * CVPCB_MAINFRAME::GetSelectedComponent ( )

Get the selected component from the component listbox.

Returns
the selected component

Definition at line 862 of file cvpcb_mainframe.cpp.

863 {
864  int selection = m_compListBox->GetSelection();
865 
866  if( selection >= 0 && selection < (int) m_netlist.GetCount() )
867  return m_netlist.GetComponent( selection );
868 
869  return NULL;
870 }
COMPONENTS_LISTBOX * m_compListBox
unsigned GetCount() const
Function GetCount.
Definition: pcb_netlist.h:228
#define NULL
COMPONENT * GetComponent(unsigned aIndex)
Function GetComponent returns the COMPONENT at aIndex.
Definition: pcb_netlist.h:237

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

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

◆ GetSelectedFootprint()

wxString CVPCB_MAINFRAME::GetSelectedFootprint ( )
Returns
the LIB_ID of the selected footprint in footprint listview or a empty string if no selection

Definition at line 1002 of file cvpcb_mainframe.cpp.

1003 {
1004  // returns the LIB_ID of the selected footprint in footprint listview
1005  // or a empty string
1007 }
FOOTPRINTS_LISTBOX * m_footprintListBox

References FOOTPRINTS_LISTBOX::GetSelectedFootprint(), and m_footprintListBox.

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

◆ GetSettingsManager()

◆ GetSeverity()

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

Reimplemented in PCB_BASE_FRAME.

Definition at line 236 of file eda_base_frame.h.

References RPT_SEVERITY_UNDEFINED.

Referenced by RC_TREE_MODEL::GetValue().

◆ GetToolCanvas()

wxWindow * CVPCB_MAINFRAME::GetToolCanvas ( ) const
overridevirtual

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 958 of file cvpcb_mainframe.cpp.

959 {
960  return GetFootprintViewerFrame();
961 }
DISPLAY_FOOTPRINTS_FRAME * GetFootprintViewerFrame() const

References GetFootprintViewerFrame().

◆ GetToolManager()

TOOL_MANAGER* TOOLS_HOLDER::GetToolManager ( ) const
inlineinherited

Return the MVC controller.

Definition at line 74 of file tools_holder.h.

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

References TOOLS_HOLDER::m_toolManager.

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

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( )
inlineinherited

Definition at line 49 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUndoCommandCount()

◆ GetUserUnits()

EDA_UNITS EDA_BASE_FRAME::GetUserUnits ( ) const
inlineinherited

Return the user units currently in use.

Definition at line 220 of file eda_base_frame.h.

221  {
222  return m_userUnits;
223  }
EDA_UNITS 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(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), GERBER_FILE_IMAGE::DisplayImageInfo(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::drawSegment(), EVT_GRID_CMD_CELL_CHANGED(), PCB_EDIT_FRAME::GenFootprintsReport(), PANEL_MODEDIT_DEFAULTS::getGridValue(), PANEL_SETUP_TEXT_AND_GRAPHICS::getGridValue(), LIB_CIRCLE::GetMsgPanelInfo(), LIB_RECTANGLE::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), LIB_ARC::GetMsgPanelInfo(), LIB_POLYLINE::GetMsgPanelInfo(), MARKER_PCB::GetMsgPanelInfo(), LIB_BEZIER::GetMsgPanelInfo(), TEXTE_PCB::GetMsgPanelInfo(), ZONE_CONTAINER::GetMsgPanelInfo(), WS_DRAW_ITEM_BASE::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), SCH_BITMAP::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), TRACK::GetMsgPanelInfo(), TEXTE_MODULE::GetMsgPanelInfo(), DRAWSEGMENT::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), VIA::GetMsgPanelInfo(), D_PAD::GetMsgPanelInfo(), LIB_PIN::getMsgPanelInfoBase(), GetUserUnits(), RC_TREE_MODEL::GetValue(), GRID_MENU::GRID_MENU(), GERBVIEW_FRAME::Liste_D_Codes(), PCB_VIEWER_TOOLS::MeasureTool(), GERBVIEW_SELECTION_TOOL::MeasureTool(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), DIALOG_SELECT_NET_FROM_LIST::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), PANEL_SETUP_BOARD_STACKUP::onUpdateThicknessValue(), PANEL_PREV_3D::PANEL_PREV_3D(), PANEL_SETUP_BOARD_STACKUP::PANEL_SETUP_BOARD_STACKUP(), POSITION_RELATIVE_TOOL::PositionRelative(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), LIB_EDIT_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), DRC_ITEM::ShowHtml(), DISPLAY_FOOTPRINTS_FRAME::SyncToolbars(), FOOTPRINT_VIEWER_FRAME::SyncToolbars(), FOOTPRINT_EDIT_FRAME::SyncToolbars(), LIB_EDIT_FRAME::SyncToolbars(), GERBVIEW_FRAME::SyncToolbars(), PCB_EDIT_FRAME::SyncToolbars(), SCH_EDIT_FRAME::SyncToolbars(), COMMON_TOOLS::ToggleUnits(), PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataFromWindow(), PANEL_EESCHEMA_SETTINGS::TransferDataToWindow(), PANEL_GERBVIEW_SETTINGS::TransferDataToWindow(), PANEL_EDIT_OPTIONS::TransferDataToWindow(), UNIT_BINDER::UNIT_BINDER(), GRID_MENU::update(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), GERBVIEW_FRAME::updateDCodeSelectBox(), EDA_DRAW_FRAME::UpdateGridSelectBox(), 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(), DRC::userUnits(), userUnits(), and PANEL_SETUP_TRACKS_AND_VIAS::validateData().

◆ GetWindowSettings()

WINDOW_SETTINGS * EDA_BASE_FRAME::GetWindowSettings ( APP_SETTINGS_BASE aCfg)
virtualinherited

Returns a pointer to the window settings for this frame.

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

Parameters
aCfgis this frame's config object

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

Definition at line 552 of file eda_base_frame.cpp.

553 {
554  return &aCfg->m_Window;
555 }
WINDOW_SETTINGS m_Window
Definition: app_settings.h:153

References APP_SETTINGS_BASE::m_Window.

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

◆ GetWindowSize()

wxSize EDA_BASE_FRAME::GetWindowSize ( )
inherited

Get the undecorated window size that can be used for restoring the window size.

This is needed for GTK, since the normal wxWidgets GetSize() call will return a window size that includes the window decorations added by the window manager.

Returns
the undecorated window size

Definition at line 878 of file eda_base_frame.cpp.

879 {
880 #ifdef __WXGTK__
881  // GTK includes the window decorations in the normal GetSize call,
882  // so we have to use a GTK-specific sizing call that returns the
883  // non-decorated window size.
884  int width = 0;
885  int height = 0;
886  GTKDoGetSize( &width, &height );
887 
888  wxSize winSize( width, height );
889 #else
890  wxSize winSize = GetSize();
891 #endif
892 
893  return winSize;
894 }

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

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )
virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 571 of file eda_base_frame.cpp.

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

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

Referenced by COMMON_CONTROL::ShowHelp().

◆ ImportHotkeyConfigFromFile()

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

Prompt the user for a hotkey file to read, and read it.

Parameters
aActionMap= current hotkey map (over which the imported hotkeys will be applied)
aDefaultShortname= a default short name (extension not needed) like eechema, kicad...

◆ InstallPreferences()

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

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

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

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

Definition at line 301 of file eda_base_frame.h.

301 { }

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

191 { return false; }

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ IsContentModified()

bool CVPCB_MAINFRAME::IsContentModified ( )
inlineoverridevirtual

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

Returns
true if the any changes have not been saved

Reimplemented from EDA_BASE_FRAME.

Definition at line 140 of file cvpcb_mainframe.h.

141  {
142  return m_modified;
143  }

References m_modified.

Referenced by ReCreateMenuBar(), and SyncToolbars().

◆ IsCurrentTool()

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

Definition at line 108 of file tools_holder.cpp.

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

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

Referenced by PCB_INSPECTION_TOOL::HighlightNetTool(), SCH_EDIT_TOOL::Init(), PCB_EDITOR_CONTROL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), DISPLAY_FOOTPRINTS_FRAME::SyncToolbars(), FOOTPRINT_VIEWER_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:202

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

272 { 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(), EDA_3D_VIEWER::CreateMenuBar(), LIB_CONTROL::CutCopyDelete(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_KEEPOUT_AREA_PROPERTIES::DIALOG_KEEPOUT_AREA_PROPERTIES(), 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(), MODULE::GetMsgPanelInfo(), 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(), LIB_CONTROL::PinLibrary(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), LIB_CONTROL::Revert(), EE_INSPECTION_TOOL::RunERC(), LIB_CONTROL::Save(), LIB_CONTROL::ShowComponentTree(), EE_INSPECTION_TOOL::ShowDatasheet(), LIB_CONTROL::UnpinLibrary(), 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 700 of file eda_base_frame.cpp.

701 {
702  wxString msg;
703  wxFileName fn = aFileName;
704 
705  // Check for absence of a file path with a file name. Unfortunately KiCad
706  // uses paths relative to the current project path without the ./ part which
707  // confuses wxFileName. Making the file name path absolute may be less than
708  // elegant but it solves the problem.
709  if( fn.GetPath().IsEmpty() && fn.HasName() )
710  fn.MakeAbsolute();
711 
712  wxCHECK_MSG( fn.IsOk(), false,
713  wxT( "File name object is invalid. Bad programmer!" ) );
714  wxCHECK_MSG( !fn.GetPath().IsEmpty(), false,
715  wxT( "File name object path <" ) + fn.GetFullPath() +
716  wxT( "> is not set. Bad programmer!" ) );
717 
718  if( fn.IsDir() && !fn.IsDirWritable() )
719  {
720  msg.Printf( _( "You do not have write permissions to folder \"%s\"." ),
721  GetChars( fn.GetPath() ) );
722  }
723  else if( !fn.FileExists() && !fn.IsDirWritable() )
724  {
725  msg.Printf( _( "You do not have write permissions to save file \"%s\" to folder \"%s\"." ),
726  GetChars( fn.GetFullName() ), GetChars( fn.GetPath() ) );
727  }
728  else if( fn.FileExists() && !fn.IsFileWritable() )
729  {
730  msg.Printf( _( "You do not have write permissions to save file \"%s\"." ),
731  GetChars( fn.GetFullPath() ) );
732  }
733 
734  if( !msg.IsEmpty() )
735  {
736  wxMessageBox( msg );
737  return false;
738  }
739 
740  return true;
741 }
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:153
#define _(s)
Definition: 3d_actions.cpp:33

References _, and GetChars().

Referenced by SCH_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::SaveEEFile(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProjectSettings(), and PCB_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(), CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), DisplayStatus(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), PCB_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithLibEdit(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::GetModule(), PCB_EDIT_FRAME::importFile(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), 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(), SAVE_AS_TRAVERSER::OnFile(), 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(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), KIWAY_HOLDER::Prj(), ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SetCrossProbeConnection(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), PCB_EDITOR_CONTROL::UpdateSchematicFromPCB(), 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 1030 of file cvpcb_mainframe.cpp.

1031 {
1032  const std::string& payload = mail.GetPayload();
1033 
1034  //DBG(printf( "%s: %s\n", __func__, payload.c_str() );)
1035 
1036  switch( mail.Command() )
1037  {
1038  case MAIL_EESCHEMA_NETLIST:
1039  ReadNetListAndFpFiles( payload );
1040  /* @todo
1041  Go into SCH_EDIT_FRAME::OnOpenCvpcb( wxCommandEvent& event ) and trim GNL_ALL down.
1042  */
1043  break;
1044 
1045  default:
1046  ; // ignore most
1047  }
1048 }
bool ReadNetListAndFpFiles(const std::string &aNetlist)
Function ReadNetListAndFpFiles loads the netlist file built on the fly by Eeschema and loads footprin...

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

◆ language_change()

void KIWAY_PLAYER::language_change ( wxCommandEvent &  event)
protectedinherited

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

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

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

686 {
687  FP_LIB_TABLE* fptbl = Prj().PcbFootprintLibs( Kiway() );
688 
689  // Check if there are footprint libraries in the footprint library table.
690  if( !fptbl || !fptbl->GetLogicalLibs().size() )
691  {
692  wxMessageBox( _( "No PCB footprint libraries are listed in the current footprint "
693  "library table." ), _( "Configuration Error" ), wxOK | wxICON_ERROR );
694  return false;
695  }
696 
697  WX_PROGRESS_REPORTER progressReporter( this, _( "Loading Footprint Libraries" ), 2 );
698 
699  m_FootprintsList->ReadFootprintFiles( fptbl, nullptr, &progressReporter );
700 
702  {
704  }
705 
706  return true;
707 }
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.
VTBL_ENTRY FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
Definition: project.cpp:284
#define _(s)
Definition: 3d_actions.cpp:33
unsigned GetErrorCount() const
std::vector< wxString > GetLogicalLibs()
Return the logical library names, all of them that are pertinent to a look up done on this LIB_TABLE.

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

Referenced by ReadNetListAndFpFiles().

◆ LoadSettings()

void CVPCB_MAINFRAME::LoadSettings ( APP_SETTINGS_BASE aCfg)
overridevirtual

Load common frame parameters from a configuration file.

Don't forget to call the base method or your frames won't remember their positions and sizes.

Reimplemented from EDA_BASE_FRAME.

Definition at line 359 of file cvpcb_mainframe.cpp.

360 {
362 
363  auto cfg = static_cast<CVPCB_SETTINGS*>( aCfg );
364 
365  m_filteringOptions = cfg->m_FilterFootprint;
366 }
virtual void LoadSettings(APP_SETTINGS_BASE *aCfg)
Load common frame parameters from a configuration file.

References EDA_BASE_FRAME::LoadSettings(), and m_filteringOptions.

Referenced by CVPCB_MAINFRAME().

◆ LoadWindowSettings()

void EDA_BASE_FRAME::LoadWindowSettings ( WINDOW_SETTINGS aCfg)
inherited

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

Definition at line 349 of file eda_base_frame.cpp.

350 {
351  m_FramePos.x = aCfg->pos_x;
352  m_FramePos.y = aCfg->pos_y;
353  m_FrameSize.x = aCfg->size_x;
354  m_FrameSize.y = aCfg->size_y;
355 
356  wxLogTrace( traceDisplayLocation, "Config position (%d, %d) with size (%d, %d)",
358 
359  // Ensure minimum size is set if the stored config was zero-initialized
361  {
364 
365  wxLogTrace( traceDisplayLocation, "Using minimum size (%d, %d)", m_FrameSize.x, m_FrameSize.y );
366  }
367 
368  wxPoint upperRight( m_FramePos.x + m_FrameSize.x, m_FramePos.y );
369  wxPoint upperLeft( m_FramePos.x, m_FramePos.y );
370 
371  // Check to see if the requested display is still attached to the computer
372  int leftInd = wxDisplay::GetFromPoint( upperLeft );
373  int rightInd = wxDisplay::GetFromPoint( upperRight );
374 
375  wxLogTrace( traceDisplayLocation, "Number of displays: %d", wxDisplay::GetCount() );
376  wxLogTrace( traceDisplayLocation, "Previous display indices: %d and %d", leftInd, rightInd );
377 
378  if( rightInd == wxNOT_FOUND && leftInd == wxNOT_FOUND )
379  {
380  wxLogTrace( traceDisplayLocation, "Previous display not found" );
381 
382  // If it isn't attached, use the first display
383  // Warning wxDisplay has 2 ctor variants. the parameter needs a type:
384  const unsigned int index = 0;
385  wxDisplay display( index );
386  wxRect clientSize = display.GetClientArea();
387 
388  wxLogDebug( "Client size (%d, %d)", clientSize.width, clientSize.height );
389 
390  m_FramePos = wxDefaultPosition;
391 
392  // Ensure the window fits on the display, since the other one could have been larger
393  if( m_FrameSize.x > clientSize.width )
394  m_FrameSize.x = clientSize.width;
395 
396  if( m_FrameSize.y > clientSize.height )
397  m_FrameSize.y = clientSize.height;
398  }
399  else
400  {
401  wxRect clientSize;
402 
403  if( leftInd == wxNOT_FOUND )
404  {
405  // If the top-left point is off-screen, use the display for the top-right point
406  wxDisplay display( rightInd );
407  clientSize = display.GetClientArea();
408  }
409  else
410  {
411  wxDisplay display( leftInd );
412  clientSize = display.GetClientArea();
413  }
414 
415 // The percentage size (represented in decimal) of the region around the screen's border where
416 // an upper corner is not allowed
417 #define SCREEN_BORDER_REGION 0.10
418 
419  int yLim = clientSize.y + ( clientSize.height * ( 1.0 - SCREEN_BORDER_REGION ) );
420  int xLimLeft = clientSize.x + ( clientSize.width * SCREEN_BORDER_REGION );
421  int xLimRight = clientSize.x + ( clientSize.width * ( 1.0 - SCREEN_BORDER_REGION ) );
422 
423  if( upperLeft.x > xLimRight || // Upper left corner too close to right edge of screen
424  upperRight.x < xLimLeft || // Upper right corner too close to left edge of screen
425  upperRight.y > yLim ) // Upper corner too close to the bottom of the screen
426  {
427  m_FramePos = wxDefaultPosition;
428  wxLogTrace( traceDisplayLocation, "Resetting to default position" );
429  }
430  }
431 
432  // Ensure Window title bar is visible
433 #if defined( __WXOSX__ )
434  // for macOSX, the window must be below system (macOSX) toolbar
435  int Ypos_min = 20;
436 #else
437  int Ypos_min = 0;
438 #endif
439  if( m_FramePos.y < Ypos_min )
440  m_FramePos.y = Ypos_min;
441 
442  wxLogTrace( traceDisplayLocation, "Final window position (%d, %d) with size (%d, %d)",
444 
445  SetSize( m_FramePos.x, m_FramePos.y, m_FrameSize.x, m_FrameSize.y );
446 
447  // Center the window if we reset to default
448  if( m_FramePos.x == -1 )
449  {
450  wxLogTrace( traceDisplayLocation, "Centering window" );
451  Center();
452  m_FramePos = GetPosition();
453  }
454 
455  // Record the frame sizes in an un-maximized state
458 
459  // Maximize if we were maximized before
460  if( aCfg->maximized )
461  {
462  wxLogTrace( traceDisplayLocation, "Maximizing window" );
463  Maximize();
464  }
465 
466  if( m_hasAutoSave )
467  m_autoSaveInterval = Pgm().GetCommonSettings()->m_System.autosave_interval;
468 
469  m_perspective = aCfg->perspective;
470  m_mruPath = aCfg->mru_path;
471 
473 }
wxString mru_path
Definition: app_settings.h:71
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
wxString m_mruPath
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
virtual void CommonSettingsChanged(bool aEnvVarsChanged)
Notification event that some of the common (suite-wide) settings have changed.
wxString m_perspective
wxSize m_NormalFrameSize
#define SCREEN_BORDER_REGION
wxString perspective
Definition: app_settings.h:74
static const int s_minsize_x
static const int s_minsize_y
wxPoint m_NormalFramePos

References PCAD2KICAD::Center, TOOLS_HOLDER::CommonSettingsChanged(), EDA_BASE_FRAME::m_autoSaveInterval, EDA_BASE_FRAME::m_FramePos, EDA_BASE_FRAME::m_FrameSize, EDA_BASE_FRAME::m_hasAutoSave, EDA_BASE_FRAME::m_mruPath, EDA_BASE_FRAME::m_NormalFramePos, EDA_BASE_FRAME::m_NormalFrameSize, EDA_BASE_FRAME::m_perspective, WINDOW_SETTINGS::maximized, WINDOW_SETTINGS::mru_path, WINDOW_SETTINGS::perspective, Pgm(), WINDOW_SETTINGS::pos_x, WINDOW_SETTINGS::pos_y, s_minsize_x, s_minsize_y, SCREEN_BORDER_REGION, WINDOW_SETTINGS::size_x, WINDOW_SETTINGS::size_y, traceDisplayLocation, wxPoint::x, and wxPoint::y.

Referenced by EDA_BASE_FRAME::LoadSettings().

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent &  aEvent)
protectedinherited

Handle the auto save timer event.

Definition at line 262 of file eda_base_frame.cpp.

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

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

Referenced by EDA_BASE_FRAME::EDA_BASE_FRAME().

◆ OnCharHook()

void EDA_BASE_FRAME::OnCharHook ( wxKeyEvent &  event)
virtualinherited

Capture the key event before it is sent to the GUI.

The basic frame does not capture this event. Editor frames should override this event function to capture and filter these keys when they are used as hotkeys, and skip it if the key is not used as hotkey (otherwise the key events will be not sent to menus).

Reimplemented in FOOTPRINT_VIEWER_FRAME.

Definition at line 275 of file eda_base_frame.cpp.

276 {
277  wxLogTrace( kicadTraceKeyEvent, "EDA_BASE_FRAME::OnCharHook %s", dump( event ) );
278  // Key events can be filtered here.
279  // Currently no filtering is made.
280  event.Skip();
281 }
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 292 of file cvpcb_mainframe.cpp.

293 {
294  if( m_modified )
295  {
296  // Shutdown blocks must be determined and vetoed as early as possible
297  if( SupportsShutdownBlockReason() && aEvent.GetId() == wxEVT_QUERY_END_SESSION )
298  {
299  aEvent.Veto();
300  return;
301  }
302 
303  if( !HandleUnsavedChanges( this, _( "Symbol to Footprint links have been modified. "
304  "Save changes?" ),
305  [&]()->bool { return SaveFootprintAssociation( false ); } ) )
306  {
307  aEvent.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  // Skip the close event. Looks like needed to have the close event sent to the
322  // root class EDA_BASE_FRAME, and save config
323  aEvent.Skip();
324 }
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:201
void SendMessageToEESCHEMA(bool aClearHighligntOnly=false)
Function SendMessageToEESCHEMA Send a remote command to Eeschema via a socket, Commands are $PART: "r...
bool SupportsShutdownBlockReason()
Whether or not the window supports setting a shutdown block reason.
#define _(s)
Definition: 3d_actions.cpp:33
DISPLAY_FOOTPRINTS_FRAME * GetFootprintViewerFrame() const
bool SaveFootprintAssociation(bool doSaveSchematic)
Function SaveFootprintAssociation saves the edits that the user has done by sending them back to eesc...

References _, GetFootprintViewerFrame(), HandleUnsavedChanges(), m_modified, SaveFootprintAssociation(), SendMessageToEESCHEMA(), and EDA_BASE_FRAME::SupportsShutdownBlockReason().

Referenced by setupEventHandlers().

◆ OnEnterFilteringText()

void CVPCB_MAINFRAME::OnEnterFilteringText ( wxCommandEvent &  event)

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

Definition at line 327 of file cvpcb_mainframe.cpp.

328 {
329  // Called when changing the filter string in main toolbar.
330  // If the option FOOTPRINTS_LISTBOX::FILTERING_BY_TEXT_PATTERN is set, update the list
331  // of available footprints which match the filter
332 
333  wxListEvent l_event;
334  OnSelectComponent( l_event );
335 }
void OnSelectComponent(wxListEvent &event)
Function OnSelectComponent Called when clicking on a component in component list window.

References OnSelectComponent().

Referenced by ReCreateHToolbar(), and setupEventHandlers().

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent &  event)
inherited

Definition at line 659 of file eda_base_frame.cpp.

660 {
661  void ShowAboutDialog(EDA_BASE_FRAME * aParent); // See AboutDialog_main.cpp
662  ShowAboutDialog( this );
663 }
void ShowAboutDialog(EDA_BASE_FRAME *aParent)
The base frame for deriving all KiCad main window classes.

References ShowAboutDialog().

◆ OnMaximize()

void EDA_BASE_FRAME::OnMaximize ( wxMaximizeEvent &  aEvent)
inherited

Definition at line 856 of file eda_base_frame.cpp.

857 {
858  // When we maximize the window, we want to save the old information
859  // so that we can add it to the settings on next window load.
860  // Contrary to the documentation, this event seems to be generated
861  // when the window is also being unmaximized on OSX, so we only
862  // capture the size information when we maximize the window when on OSX.
863 #ifdef __WXOSX__
864  if( !IsMaximized() )
865 #endif
866  {
868  m_NormalFramePos = GetPosition();
869  wxLogTrace( traceDisplayLocation, "Maximizing window - Saving position (%d, %d) with size (%d, %d)",
871  }
872 
873  // Skip event to actually maximize the window
874  aEvent.Skip();
875 }
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxSize m_NormalFrameSize
wxSize GetWindowSize()
Get the undecorated window size that can be used for restoring the window size.
wxPoint m_NormalFramePos

References EDA_BASE_FRAME::GetWindowSize(), EDA_BASE_FRAME::m_NormalFramePos, EDA_BASE_FRAME::m_NormalFrameSize, traceDisplayLocation, wxPoint::x, and wxPoint::y.

◆ OnMenuEvent()

void EDA_BASE_FRAME::OnMenuEvent ( wxMenuEvent &  event)
inherited

The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves.

Definition at line 284 of file eda_base_frame.cpp.

285 {
286  if( !m_toolDispatcher )
287  aEvent.Skip();
288  else
290 }
virtual void DispatchWxEvent(wxEvent &aEvent)
Function DispatchWxEvent() Processes wxEvents (mostly UI events), translates them to TOOL_EVENTs,...
TOOL_DISPATCHER * m_toolDispatcher
Definition: tools_holder.h:50

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

◆ OnMove()

virtual void EDA_BASE_FRAME::OnMove ( wxMoveEvent &  aEvent)
inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 261 of file eda_base_frame.h.

262  {
263  aEvent.Skip();
264  }

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent &  event)
inherited

Definition at line 666 of file eda_base_frame.cpp.

667 {
668  PAGED_DIALOG dlg( this, _( "Preferences" ) );
669  wxTreebook* book = dlg.GetTreebook();
670 
671  book->AddPage( new PANEL_COMMON_SETTINGS( &dlg, book ), _( "Common" ) );
672 
673  book->AddPage( new PANEL_MOUSE_SETTINGS( &dlg, book ), _( "Mouse and Touchpad" ) );
674 
675  PANEL_HOTKEYS_EDITOR* hotkeysPanel = new PANEL_HOTKEYS_EDITOR( this, book, false );
676  book->AddPage( hotkeysPanel, _( "Hotkeys" ) );
677 
678  for( unsigned i = 0; i < KIWAY_PLAYER_COUNT; ++i )
679  {
680  KIWAY_PLAYER* frame = dlg.Kiway().Player( (FRAME_T) i, false );
681 
682  if( frame )
683  frame->InstallPreferences( &dlg, hotkeysPanel );
684  }
685 
686  // The Kicad manager frame is not a player so we have to add it by hand
687  wxWindow* manager = wxFindWindowByName( KICAD_MANAGER_FRAME_NAME );
688 
689  if( manager )
690  static_cast<EDA_BASE_FRAME*>( manager )->InstallPreferences( &dlg, hotkeysPanel );
691 
692  for( size_t i = 0; i < book->GetPageCount(); ++i )
693  book->GetPage( i )->Layout();
694 
695  if( dlg.ShowModal() == wxID_OK )
696  dlg.Kiway().CommonSettingsChanged( false );
697 }
KIWAY_PLAYER is a wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of ...
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:342
#define KICAD_MANAGER_FRAME_NAME
#define _(s)
Definition: 3d_actions.cpp:33
virtual void InstallPreferences(PAGED_DIALOG *, PANEL_HOTKEYS_EDITOR *)
Function InstallPreferences Allow a frame to load its preference panels (if any) into the preferences...

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

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

339 {
341  return;
342 
343  wxString libraryName;
344  COMPONENT* component = GetSelectedComponent();
345  libraryName = m_libListBox->GetSelectedLibrary();
346 
347  m_footprintListBox->SetFootprints( *m_FootprintsList, libraryName, component,
348  m_tcFilterString->GetValue(), m_filteringOptions );
349 
350  if( component && component->GetFPID().IsValid() )
352  else
354 
355  refreshAfterComponentSearch( component );
356 }
FOOTPRINT_LIST * m_FootprintsList
void SetSelectedFootprint(const LIB_ID &aFPID)
bool IsValid() const
Definition: lib_id.h:171
const LIB_ID & GetFPID() const
Definition: pcb_netlist.h:149
wxTextCtrl * m_tcFilterString
void refreshAfterComponentSearch(COMPONENT *component)
wxString GetSelectedLibrary()
LIBRARY_LISTBOX * m_libListBox
COMPONENT is used to store components and all of their related information found in a netlist.
Definition: pcb_netlist.h:80
void SetSelection(int index, bool State=true)
COMPONENT * GetSelectedComponent()
Get the selected component from the component listbox.
FOOTPRINTS_LISTBOX * m_footprintListBox
void SetFootprints(FOOTPRINT_LIST &aList, const wxString &aLibName, COMPONENT *aComponent, const wxString &aFootPrintFilterPattern, int aFilterType)
Function SetFootprints populates the wxListCtrl with the footprints from aList that meet the filter c...

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

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

◆ OpenProjectFiles()

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

Function OpenProjectFiles is abstract, and opens a project or set of files given by aFileList.

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

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

This function does not support "appending". Use a different function for that. Any prior project data tree should be cleared before loading the new stuff.

Therefore, one of the first things an implementation should do is test for existence of the first file in the list, and if it does not exist, treat it as a new session, possibly with a UI notification to that effect.

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

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

Parameters
aFileListincludes files that this frame should open according to the knowledge in the derived wxFrame. In almost every case, the list will have only a single file in it.
aCtlis a set of bit flags ORed together from the set of KICTL_* #defined above.
Returns
bool - true if all requested files were opened OK, else false.

Reimplemented from KIWAY_PLAYER.

Definition at line 480 of file cvpcb_mainframe.cpp.

481 {
482  return true;
483 }

◆ ParseArgs()

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

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

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

Parameters
aParseris the argument parser created by the top-level launcher.

Definition at line 138 of file kiway_player.h.

139  {
140  WXUNUSED( aParser );
141  }

Referenced by PGM_SINGLE_TOP::OnPgmInit().

◆ PopCommandFromRedoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromRedoList ( )
virtualinherited

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

Definition at line 840 of file eda_base_frame.cpp.

841 {
842  return m_redoList.PopCommand();
843 }
PICKED_ITEMS_LIST * PopCommand()
UNDO_REDO_CONTAINER m_redoList

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

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

◆ PopCommandFromUndoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromUndoList ( )
virtualinherited

◆ PopTool()

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

Definition at line 61 of file tools_holder.cpp.

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

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

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

◆ PrintMsg()

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

Definition at line 577 of file eda_base_frame.cpp.

578 {
579  SetStatusText( text );
580 }

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

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

Definition at line 35 of file kiway_holder.cpp.

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

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), DIALOG_SYMBOL_REMAP::backupProject(), buildEquivalenceList(), BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::CreateScreens(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), DisplayStatus(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), PCB_EDIT_FRAME::doAutoSave(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), DIALOG_EXPORT_SVG::ExportSVGFile(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DIALOG_GENDRILL::GenDrillAndMapFiles(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), DISPLAY_FOOTPRINTS_FRAME::GetModule(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::GetSelectedSymbol(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), SCH_EDIT_FRAME::KiwayMailIn(), LIB_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), DRC::LoadRules(), SCH_EDIT_FRAME::LoadSheetFromFile(), 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(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), SCH_EDIT_FRAME::OnCloseWindow(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), DIALOG_CONFIG_EQUFILES::OnOkClick(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_BOM::OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_TOOLS::PasteFootprint(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), SCH_EDIT_FRAME::PrintPage(), EDA_DRAW_FRAME::PrintWorkSheet(), ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), SCH_EDIT_TOOL::RefreshSymbolFromLibrary(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), LIB_EDIT_FRAME::saveLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), LIB_EDIT_FRAME::savePartAs(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), 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(), GERBVIEW_FRAME::SetPageSettings(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), PANEL_SETUP_RULES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_EDIT_COMPONENTS_LIBID::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary(), DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample(), 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 204 of file eda_base_frame.cpp.

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

◆ PushCommandToRedoList()

void EDA_BASE_FRAME::PushCommandToRedoList ( PICKED_ITEMS_LIST aItem)
virtualinherited

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

Definition at line 819 of file eda_base_frame.cpp.

820 {
821  m_redoList.PushCommand( aNewitem );
822 
823  // Delete the extra items, if count max reached
824  if( m_UndoRedoCountMax > 0 )
825  {
826  int extraitems = GetRedoCommandCount() - m_UndoRedoCountMax;
827 
828  if( extraitems > 0 )
829  ClearUndoORRedoList( REDO_LIST, extraitems );
830  }
831 }
int GetRedoCommandCount() const
virtual void ClearUndoORRedoList(UNDO_REDO_LIST aList, int aItemCount=-1)
void PushCommand(PICKED_ITEMS_LIST *aCommand)
UNDO_REDO_CONTAINER m_redoList

References EDA_BASE_FRAME::ClearUndoORRedoList(), EDA_BASE_FRAME::GetRedoCommandCount(), EDA_BASE_FRAME::m_redoList, EDA_BASE_FRAME::m_UndoRedoCountMax, UNDO_REDO_CONTAINER::PushCommand(), and EDA_BASE_FRAME::REDO_LIST.

Referenced by LIB_EDIT_FRAME::GetComponentFromUndoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), and SCH_EDITOR_CONTROL::Undo().

◆ PushCommandToUndoList()

void EDA_BASE_FRAME::PushCommandToUndoList ( PICKED_ITEMS_LIST aItem)
virtualinherited

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

Definition at line 804 of file eda_base_frame.cpp.

805 {
806  m_undoList.PushCommand( aNewitem );
807 
808  // Delete the extra items, if count max reached
809  if( m_UndoRedoCountMax > 0 )
810  {
811  int extraitems = GetUndoCommandCount() - m_UndoRedoCountMax;
812 
813  if( extraitems > 0 )
814  ClearUndoORRedoList( UNDO_LIST, extraitems );
815  }
816 }
UNDO_REDO_CONTAINER m_undoList
int GetUndoCommandCount() const
virtual void ClearUndoORRedoList(UNDO_REDO_LIST aList, int aItemCount=-1)
void PushCommand(PICKED_ITEMS_LIST *aCommand)

References EDA_BASE_FRAME::ClearUndoORRedoList(), EDA_BASE_FRAME::GetUndoCommandCount(), EDA_BASE_FRAME::m_undoList, EDA_BASE_FRAME::m_UndoRedoCountMax, UNDO_REDO_CONTAINER::PushCommand(), and EDA_BASE_FRAME::UNDO_LIST.

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

◆ PushTool()

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

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

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

Definition at line 44 of file tools_holder.cpp.

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

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

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

◆ ReadNetListAndFpFiles()

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

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

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

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

References _, DIALOG_FP_CONFLICT_ASSIGNMENT_SELECTOR::Add(), NETLIST::AnyFootprintsLinked(), COMPONENTS_LISTBOX::AppendLine(), BuildFOOTPRINTS_LISTBOX(), BuildLIBRARY_LISTBOX(), UTF8::c_str(), COMPONENTS_LISTBOX::Clear(), CMP_FORMAT, 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(), NETLIST::IsEmpty(), LIB_ID::IsLegacy(), IsOK(), KIWAY_HOLDER::Kiway(), HTML_MESSAGE_BOX::ListSet(), LoadFootprintFiles(), m_compListBox, m_modified, m_netlist, HTML_MESSAGE_BOX::MessageSet(), NULL, PROJECT::PcbFootprintLibs(), KIWAY_HOLDER::Prj(), ReadSchematicNetlist(), COMPONENT::SetFPID(), COMPONENTS_LISTBOX::SetSelection(), DIALOG_SHIM::Show(), 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 747 of file cvpcb_mainframe.cpp.

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

Definition at line 35 of file toolbars_cvpcb.cpp.

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

References _, ACTION_TOOLBAR::Add(), ACTION_TOOLBAR::AddScaledSeparator(), CVPCB_ACTIONS::autoAssociate, ACTION_TOOLBAR::ClearToolbar(), CVPCB_ACTIONS::deleteAll, CVPCB_ACTIONS::FilterFPbyFPFilters, CVPCB_ACTIONS::FilterFPbyLibrary, CVPCB_ACTIONS::filterFPbyPin, CVPCB_ACTIONS::gotoNextNA, CVPCB_ACTIONS::gotoPreviousNA, ID_CVPCB_FILTER_TEXT_EDIT, ID_H_TOOLBAR, EDA_BASE_FRAME::KICAD_AUI_TB_STYLE, m_mainToolBar, m_tcFilterString, OnEnterFilteringText(), ACTIONS::redo, CVPCB_ACTIONS::saveAssociations, 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 37 of file cvpcb/menubar.cpp.

38 {
40  // wxWidgets handles the Mac Application menu behind the scenes, but that means
41  // we always have to start from scratch with a new wxMenuBar.
42  wxMenuBar* oldMenuBar = GetMenuBar();
43  WX_MENUBAR* menuBar = new WX_MENUBAR();
44 
45  //-- File menu -----------------------------------------------------------
46  //
47  CONDITIONAL_MENU* fileMenu = new CONDITIONAL_MENU( false, tool );
48 
49  auto enableSaveCondition = [ this ] ( const SELECTION& sel )
50  {
51  return IsContentModified();
52  };
53 
54  fileMenu->AddItem( CVPCB_ACTIONS::saveAssociations, enableSaveCondition );
55  fileMenu->AddSeparator();
56  fileMenu->AddClose( _( "Assign Footprints" ) );
57 
58  fileMenu->Resolve();
59 
60  //-- Preferences menu -----------------------------------------------
61  //
62  CONDITIONAL_MENU* editMenu = new CONDITIONAL_MENU( false, tool );
63 
64  auto enableUndoCondition = [ this ] ( const SELECTION& sel )
65  {
66  return m_undoList.size() > 0;
67  };
68  auto enableRedoCondition = [ this ] ( const SELECTION& sel )
69  {
70  return m_redoList.size() > 0;
71  };
72 
73  editMenu->AddItem( ACTIONS::undo, enableUndoCondition );
74  editMenu->AddItem( ACTIONS::redo, enableRedoCondition );
75  editMenu->AddSeparator();
79 
80  editMenu->Resolve();
81 
82  //-- Preferences menu -----------------------------------------------
83  //
84  CONDITIONAL_MENU* prefsMenu = new CONDITIONAL_MENU( false, tool );
85 
88  prefsMenu->AddItem( wxID_PREFERENCES,
89  _( "Preferences...\tCTRL+," ),
90  _( "Show preferences for all open tools" ),
92  prefsMenu->AddSeparator();
94 
95  prefsMenu->AddSeparator();
96  AddMenuLanguageList( prefsMenu, tool );
97 
98  prefsMenu->Resolve();
99 
100  //-- Menubar -------------------------------------------------------------
101  //
102  menuBar->Append( fileMenu, _( "&File" ) );
103  menuBar->Append( editMenu, _( "&Edit" ) );
104  menuBar->Append( prefsMenu, _( "&Preferences" ) );
105  AddStandardHelpMenu( menuBar );
106 
107  SetMenuBar( menuBar );
108  delete oldMenuBar;
109 }
static bool ShowAlways(const SELECTION &aSelection)
Function ShowAlways The default condition function (always returns true).
static TOOL_ACTION showEquFileTable
Definition: cvpcb_actions.h:60
Wrapper around a wxMenuBar object that prevents the accelerator table from being used.
Definition: wx_menubar.h:45
bool IsContentModified() override
Get if the current associations have been modified but not saved.
static TOOL_ACTION copy
Definition: actions.h:70
static TOOL_ACTION showFootprintLibTable
Definition: actions.h:169
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
COMMON_CONTROL.
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()
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
void AddMenuLanguageList(CONDITIONAL_MENU *aMasterMenu, TOOL_INTERACTIVE *aControlTool)
Function AddMenuLanguageList creates a menu list for language choice, and add it as submenu to Master...
#define _(s)
Definition: 3d_actions.cpp:33
CVPCB_UNDO_REDO_LIST m_redoList
static TOOL_ACTION undo
Definition: actions.h:67
const BITMAP_OPAQUE preference_xpm[1]
Definition: preference.cpp:66
static TOOL_ACTION configurePaths
Definition: actions.h:167
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(), IsContentModified(), m_redoList, TOOLS_HOLDER::m_toolManager, m_undoList, ACTIONS::paste, preference_xpm, 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 399 of file cvpcb_mainframe.cpp.

400 {
401  if( m_redoList.size() == 0 )
402  return;
403 
404  CVPCB_UNDO_REDO_ENTRIES curEntry = m_redoList.back();
405  m_redoList.pop_back();
406 
407  // Iterate over the entries to undo
408  bool firstAssoc = true;
409  for( const auto& assoc : curEntry )
410  {
411  AssociateFootprint( assoc, firstAssoc );
412  firstAssoc = false;
413  }
414 }
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 486 of file cvpcb_mainframe.cpp.

487 {
488  // Tell AuiMgr that objects are changed !
489  if( m_auimgr.GetManagedWindow() ) // Be sure Aui Manager is initialized
490  // (could be not the case when starting CvPcb
491  m_auimgr.Update();
492 
493  if( component == NULL )
494  {
495  DisplayStatus();
496  return;
497  }
498 
499  // Preview of the already assigned footprint.
500  // Find the footprint that was already chosen for this component and select it,
501  // but only if the selection is made from the component list or the library list.
502  // If the selection is made from the footprint list, do not change the current
503  // selected footprint.
504  if( FindFocus() == m_compListBox || FindFocus() == m_libListBox )
505  {
506  wxString module = FROM_UTF8( component->GetFPID().Format().c_str() );
507 
509 
510  for( int ii = 0; ii < m_footprintListBox->GetCount(); ii++ )
511  {
512  wxString footprintName;
513  wxString msg = m_footprintListBox->OnGetItemText( ii, 0 );
514  msg.Trim( true );
515  msg.Trim( false );
516  footprintName = msg.AfterFirst( wxChar( ' ' ) );
517 
518  if( module.Cmp( footprintName ) == 0 )
519  {
520  m_footprintListBox->SetSelection( ii, true );
521  break;
522  }
523  }
524 
527  }
528 
530  DisplayStatus();
531 }
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:114
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:140
wxAuiManager m_auimgr
const char * c_str() const
Definition: utf8.h:107
const LIB_ID & GetFPID() const
Definition: pcb_netlist.h:149
#define NULL
wxString OnGetItemText(long item, long column) const override
Function OnGetItemText this overloaded function MUST be provided for the wxLC_VIRTUAL mode because re...
LIBRARY_LISTBOX * m_libListBox
UTF8 Format() const
Definition: lib_id.cpp:237
void SetSelection(int index, bool State=true)
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
FOOTPRINTS_LISTBOX * m_footprintListBox
DISPLAY_FOOTPRINTS_FRAME * GetFootprintViewerFrame() const
void DisplayStatus()
Function DisplayStatus updates the information displayed on the status bar at bottom of the main fram...

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

Referenced by OnSelectComponent().

◆ RefreshCanvas()

virtual void TOOLS_HOLDER::RefreshCanvas ( )
inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 119 of file tools_holder.h.

119 { }

Referenced by TOOL_MANAGER::ProcessEvent().

◆ RemoveShutdownBlockReason()

void EDA_BASE_FRAME::RemoveShutdownBlockReason ( )
inherited

Removes any shutdown block reason set.

Definition at line 177 of file eda_base_frame.cpp.

178 {
179 #if defined( _WIN32 )
180  // Windows: Destroys any block reason that may have existed
181  ShutdownBlockReasonDestroy( GetHandle() );
182 #endif
183 }

Referenced by EDA_BASE_FRAME::~EDA_BASE_FRAME().

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

287 {
288  std::string payload;
289  STRING_FORMATTER sf;
290 
292 
293  payload = sf.GetString();
295 
296  if( doSaveSchematic )
297  {
298  payload = "";
299  Kiway().ExpressMail( FRAME_SCH, MAIL_SCH_SAVE, payload );
300 
301  if( payload == "success" )
302  SetStatusText( _( "Schematic saved" ), 1 );
303  }
304 
305  // Changes are saved, so reset the flag
306  m_modified = false;
307 
308  return true;
309 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
void SetStatusText(const wxString &aText, int aNumber=0) override
const std::string & GetString()
Definition: richio.h:475
void FormatBackAnnotation(OUTPUTFORMATTER *aOut)
Definition: pcb_netlist.h:302
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:432
#define _(s)
Definition: 3d_actions.cpp:33
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().

◆ SaveProjectSettings()

virtual void EDA_BASE_FRAME::SaveProjectSettings ( )
inlinevirtualinherited

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

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

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

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 361 of file eda_base_frame.h.

361 {};

Referenced by DIALOG_PAGES_SETTINGS::OnOkClick().

◆ SaveSettings()

void CVPCB_MAINFRAME::SaveSettings ( APP_SETTINGS_BASE aCfg)
overridevirtual

Saves common frame parameters to a configuration data file.

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 369 of file cvpcb_mainframe.cpp.

370 {
372 
373  auto cfg = static_cast<CVPCB_SETTINGS*>( aCfg );
374  cfg->m_FilterFootprint = m_filteringOptions;
375 }
virtual void SaveSettings(APP_SETTINGS_BASE *aCfg)
Saves common frame parameters to a configuration data file.

References m_filteringOptions, and EDA_BASE_FRAME::SaveSettings().

◆ SaveWindowSettings()

void EDA_BASE_FRAME::SaveWindowSettings ( WINDOW_SETTINGS aCfg)
inherited

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

Definition at line 476 of file eda_base_frame.cpp.

477 {
478  wxString text;
479 
480  if( IsIconized() )
481  return;
482 
483  wxString baseCfgName = ConfigBaseName();
484 
485  // If the window is maximized, we use the saved window size from before it was maximized
486  if( IsMaximized() )
487  {
490  }
491  else
492  {
494  m_FramePos = GetPosition();
495  }
496 
497  aCfg->pos_x = m_FramePos.x;
498  aCfg->pos_y = m_FramePos.y;
499  aCfg->size_x = m_FrameSize.x;
500  aCfg->size_y = m_FrameSize.y;
501  aCfg->maximized = IsMaximized();
502 
503  wxLogTrace( traceDisplayLocation, "Saving window maximized: %s", IsMaximized() ? "true" : "false" );
504  wxLogTrace( traceDisplayLocation, "Saving config position (%d, %d) with size (%d, %d)",
506 
507  // TODO(JE) should auto-save in common settings be overwritten by every app?
508  if( m_hasAutoSave )
509  Pgm().GetCommonSettings()->m_System.autosave_interval = m_autoSaveInterval;
510 
511  // Once this is fully implemented, wxAuiManager will be used to maintain
512  // the persistance of the main frame and all it's managed windows and
513  // all of the legacy frame persistence position code can be removed.
514  aCfg->perspective = m_auimgr.SavePerspective().ToStdString();
515 
516  aCfg->mru_path = m_mruPath;
517 }
wxString mru_path
Definition: app_settings.h:71
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
wxString m_mruPath
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxAuiManager m_auimgr
wxSize m_NormalFrameSize
wxString perspective
Definition: app_settings.h:74
wxSize GetWindowSize()
Get the undecorated window size that can be used for restoring the window size.
wxString ConfigBaseName() override
wxPoint m_NormalFramePos

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

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ SendMessageToEESCHEMA()

void CVPCB_MAINFRAME::SendMessageToEESCHEMA ( bool  aClearHighligntOnly = false)

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

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

Definition at line 710 of file cvpcb_mainframe.cpp.

711 {
712  if( m_netlist.IsEmpty() )
713  return;
714 
715  // clear highlight of previously selected components (if any):
716  // Selecting a non existing symbol clears any previously highlighted symbols
717  std::string packet = "$CLEAR: \"HIGHLIGHTED\"";
718 
719  if( Kiface().IsSingle() )
720  SendCommand( MSG_TO_SCH, packet.c_str() );
721  else
722  Kiway().ExpressMail( FRAME_SCH, MAIL_CROSS_PROBE, packet, this );
723 
724  if( aClearHighligntOnly )
725  return;
726 
727  int selection = m_compListBox->GetSelection();
728 
729  if ( selection < 0 ) // Nothing selected
730  return;
731 
732  if( m_netlist.GetComponent( selection ) == NULL )
733  return;
734 
735  // Now highlight the selected component:
736  COMPONENT* component = m_netlist.GetComponent( selection );
737 
738  packet = StrPrintf( "$PART: \"%s\"", TO_UTF8( component->GetReference() ) );
739 
740  if( Kiface().IsSingle() )
741  SendCommand( MSG_TO_SCH, packet.c_str() );
742  else
743  Kiway().ExpressMail( FRAME_SCH, MAIL_CROSS_PROBE, packet, this );
744 }
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
#define NULL
bool IsSingle() const
Function IsSingle is this KIFACE_I running under single_top?
Definition: kiface_i.h:117
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
const wxString & GetReference() const
Definition: pcb_netlist.h:144
COMPONENT is used to store components and all of their related information found in a netlist.
Definition: pcb_netlist.h:80
COMPONENT * GetComponent(unsigned aIndex)
Function GetComponent returns the COMPONENT at aIndex.
Definition: pcb_netlist.h:237
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:432
#define TO_UTF8(wxstring)
bool IsEmpty() const
Function IsEmpty()
Definition: pcb_netlist.h:216

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, NULL, SendCommand(), numEval::StrPrintf(), and TO_UTF8.

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

◆ SetAutoSaveInterval()

void EDA_BASE_FRAME::SetAutoSaveInterval ( int  aInterval)
inherited

Definition at line 243 of file eda_base_frame.cpp.

244 {
245  m_autoSaveInterval = aInterval;
246 
247  if( m_autoSaveTimer->IsRunning() )
248  {
249  if( m_autoSaveInterval > 0 )
250  {
251  m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
252  }
253  else
254  {
255  m_autoSaveTimer->Stop();
256  m_autoSaveState = false;
257  }
258  }
259 }
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 990 of file cvpcb_mainframe.cpp.

991 {
992  switch( aLB )
993  {
994  case CVPCB_MAINFRAME::CONTROL_LIBRARY: m_libListBox->SetFocus(); break;
995  case CVPCB_MAINFRAME::CONTROL_COMPONENT: m_compListBox->SetFocus(); break;
997  default: break;
998  }
999 }
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 534 of file cvpcb_mainframe.cpp.

536 {
537  int option = aFilter;
538 
539  // Apply the filter accordingly
540  switch( aAction )
541  {
543  m_filteringOptions &= ~option;
544  break;
545 
547  m_filteringOptions |= option;
548  break;
549 
551  m_filteringOptions ^= option;
552  break;
553  }
554 
555  wxListEvent l_event;
556  OnSelectComponent( l_event );
557 }
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, m_filteringOptions, and OnSelectComponent().

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 42 of file kiway_holder.cpp.

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

References KIWAY_HOLDER::m_kiway, and name.

Referenced by BM2CMP_FRAME::BM2CMP_FRAME(), PCB::IFACE::CreateWindow(), InvokePcbLibTableEditor(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

◆ SetModal()

void KIWAY_PLAYER::SetModal ( bool  aIsModal)
inlineinherited

Definition at line 177 of file kiway_player.h.

177 { 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 419 of file eda_base_frame.h.

419 { 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 873 of file cvpcb_mainframe.cpp.

874 {
875