KiCad PCB EDA Suite
CV::IFACE Struct Reference
Inheritance diagram for CV::IFACE:
KIFACE_BASE KIFACE

Public Member Functions

 IFACE (const char *aName, KIWAY::FACE_T aType)
 
bool OnKifaceStart (PGM_BASE *aProgram, int aCtlBits) override
 !!!!!!!!!!!!!! This code is obsolete because of the merge into Pcbnew, don't bother with it. More...
 
void OnKifaceEnd () override
 Called just once just before the DSO is to be unloaded. More...
 
wxWindow * CreateKiWindow (wxWindow *aParent, int aClassId, KIWAY *aKiway, int aCtlBits=0) override
 Create a wxWindow for the current project. More...
 
void * IfaceOrAddress (int aDataId) override
 Return a pointer to the requested object. More...
 
const wxString Name ()
 
APP_SETTINGS_BASEKifaceSettings () const
 
void InitSettings (APP_SETTINGS_BASE *aSettings)
 
int StartFlags () const
 Return whatever was passed as aCtlBits to OnKifaceStart(). More...
 
bool IsSingle () const
 Is this KIFACE running under single_top? More...
 
const wxString & GetHelpFileName () const
 Return just the basename portion of the current help file. More...
 
SEARCH_STACKKifaceSearch ()
 Only for DSO specific 'non-library' files. More...
 
void GetActions (std::vector< TOOL_ACTION * > &aActions) const override
 Append this Kiface's registered actions to the given list. More...
 
virtual void SaveFileAs (const wxString &srcProjectBasePath, const wxString &srcProjectName, const wxString &newProjectBasePath, const wxString &newProjectName, const wxString &srcFilePath, wxString &aErrors)
 Saving a file under a different name is delegated to the various KIFACEs because the project doesn't know the internal format of the various files (which may have paths in them that need updating). More...
 
virtual int HandleJob (JOB *aJob)
 

Protected Member Functions

bool start_common (int aCtlBits)
 Common things to do for a top program module, during OnKifaceStart(). More...
 
void end_common ()
 Common things to do for a top program module, during OnKifaceEnd();. More...
 

Private Attributes

KIWAY::FACE_T m_id
 
BIN_MOD m_bm
 
int m_start_flags
 flags provided in OnKifaceStart() More...
 

Detailed Description

Definition at line 40 of file cvpcb.cpp.

Constructor & Destructor Documentation

◆ IFACE()

CV::IFACE::IFACE ( const char *  aName,
KIWAY::FACE_T  aType 
)
inline

Definition at line 44 of file cvpcb.cpp.

44 :
45 KIFACE_BASE( aName, aType )
46 {}
KIFACE_BASE(const char *aKifaceName, KIWAY::FACE_T aId)
Definition: kiface_base.h:65

Member Function Documentation

◆ CreateKiWindow()

wxWindow * CV::IFACE::CreateKiWindow ( wxWindow *  aParent,
int  aClassId,
KIWAY aKIWAY,
int  aCtlBits = 0 
)
inlineoverridevirtual

Create a wxWindow for the current project.

The caller must cast the return value into the known type.

Parameters
aParentmay be NULL or is otherwise the parent to connect under. If NULL then caller may want to connect the returned wxWindow into some hierarchy after this function returns.
aClassIdidentifies which wxFrame or wxDialog to retrieve, using a value known to the implementing KIFACE.
aKIWAYtells the window which KIWAY (and PROJECT) it is a participant in.
aCtlBitsconsists of bit flags from the set of KFCTL_* #defines above.
Returns
the window created and if not NULL, should be cast into the known type using and old school cast. dynamic_cast is problematic since it needs typeinfo probably not contained in the caller's link image.

Implements KIFACE_BASE.

Definition at line 52 of file cvpcb.cpp.

54 {
55 switch( aClassId )
56 {
57 case FRAME_CVPCB: return new CVPCB_MAINFRAME( aKiway, aParent );
58 case FRAME_CVPCB_DISPLAY: return new DISPLAY_FOOTPRINTS_FRAME( aKiway, aParent );
59 default: return nullptr;
60 }
61 }
The CvPcb application main window.
@ FRAME_CVPCB_DISPLAY
Definition: frame_type.h:49
@ FRAME_CVPCB
Definition: frame_type.h:48

References FRAME_CVPCB, and FRAME_CVPCB_DISPLAY.

◆ end_common()

void KIFACE_BASE::end_common ( )
protectedinherited

Common things to do for a top program module, during OnKifaceEnd();.

Definition at line 42 of file kiface_base.cpp.

43{
44 m_bm.End();
45}
BIN_MOD m_bm
Definition: kiface_base.h:125
void End()
Definition: bin_mod.cpp:50

References BIN_MOD::End(), and KIFACE_BASE::m_bm.

Referenced by OnKifaceEnd(), SCH::IFACE::OnKifaceEnd(), GERBV::IFACE::OnKifaceEnd(), KIFACE_BASE::OnKifaceEnd(), PGE::IFACE::OnKifaceEnd(), PCBCALC::IFACE::OnKifaceEnd(), and PCB::IFACE::OnKifaceEnd().

◆ GetActions()

void KIFACE_BASE::GetActions ( std::vector< TOOL_ACTION * > &  aActions) const
inlineoverridevirtualinherited

Append this Kiface's registered actions to the given list.

Implements KIFACE.

Definition at line 116 of file kiface_base.h.

117 {
119 aActions.push_back( action );
120 }
static std::list< TOOL_ACTION * > & GetActionList()
Return list of TOOL_ACTIONs.
Represent a single user action.
Definition: tool_action.h:68

References ACTION_MANAGER::GetActionList().

◆ GetHelpFileName()

const wxString & KIFACE_BASE::GetHelpFileName ( ) const
inlineinherited

Return just the basename portion of the current help file.

Definition at line 110 of file kiface_base.h.

110{ return m_bm.m_help_file; }
wxString m_help_file
Definition: bin_mod.h:58

References KIFACE_BASE::m_bm, and BIN_MOD::m_help_file.

Referenced by EDA_BASE_FRAME::help_name().

◆ HandleJob()

virtual int KIFACE::HandleJob ( JOB aJob)
inlinevirtualinherited

Reimplemented in SCH::IFACE, and PCB::IFACE.

Definition at line 239 of file kiway.h.

240 {
241 return 0;
242 }

◆ IfaceOrAddress()

void * CV::IFACE::IfaceOrAddress ( int  aDataId)
inlineoverridevirtual

Return a pointer to the requested object.

The safest way to use this is to retrieve a pointer to a static instance of an interface, similar to how the KIFACE interface is exported. But if you know what you are doing use it to retrieve anything you want.

Parameters
aDataIdidentifies which object you want the address of.
Returns
the object requested and must be cast into the known type.

Implements KIFACE_BASE.

Definition at line 73 of file cvpcb.cpp.

74 {
75 switch( aDataId )
76 {
77 // Return a pointer to the global instance of the footprint list.
79 return (void*) &GFootprintList;
80
81 // Return a new FP_LIB_TABLE with the global table installed as a fallback.
83 return (void*) new FP_LIB_TABLE( &GFootprintTable );
84
85 // Return a pointer to the global instance of the global footprint table.
87 return (void*) &GFootprintTable;
88
89 default:
90 return nullptr;
91 }
92 }
FP_LIB_TABLE GFootprintTable
The global footprint library table.
Definition: cvpcb.cpp:134
FOOTPRINT_LIST_IMPL GFootprintList
The global footprint info table.
Definition: cvpcb.cpp:140
@ KIFACE_FOOTPRINT_LIST
Return a pointer to the global instance of FOOTPRINT_LIST from pcbnew.
Definition: kiface_ids.h:39
@ KIFACE_GLOBAL_FOOTPRINT_TABLE
Return the global FP_LIB_TABLE.
Definition: kiface_ids.h:53
@ KIFACE_NEW_FOOTPRINT_TABLE
Return a new FP_LIB_TABLE with the global table installed as a fallback.
Definition: kiface_ids.h:46

References GFootprintList, GFootprintTable, KIFACE_FOOTPRINT_LIST, KIFACE_GLOBAL_FOOTPRINT_TABLE, and KIFACE_NEW_FOOTPRINT_TABLE.

◆ InitSettings()

void KIFACE_BASE::InitSettings ( APP_SETTINGS_BASE aSettings)
inlineinherited

Definition at line 95 of file kiface_base.h.

95{ m_bm.InitSettings( aSettings ); }
void InitSettings(APP_SETTINGS_BASE *aPtr)
Takes ownership of a new application settings object.
Definition: bin_mod.h:53

References BIN_MOD::InitSettings(), and KIFACE_BASE::m_bm.

Referenced by BMP2CMP::IFACE::CreateKiWindow(), OnKifaceStart(), SCH::IFACE::OnKifaceStart(), GERBV::IFACE::OnKifaceStart(), PGE::IFACE::OnKifaceStart(), PCBCALC::IFACE::OnKifaceStart(), and PCB::IFACE::OnKifaceStart().

◆ IsSingle()

bool KIFACE_BASE::IsSingle ( ) const
inlineinherited

Is this KIFACE running under single_top?

Definition at line 105 of file kiface_base.h.

int m_start_flags
flags provided in OnKifaceStart()
Definition: kiface_base.h:127
#define KFCTL_STANDALONE
Running as a standalone Top.
Definition: kiway.h:158

References KFCTL_STANDALONE, and KIFACE_BASE::m_start_flags.

Referenced by ACTION_MENU::AddQuitOrClose(), SCH::IFACE::CreateKiWindow(), PCB::IFACE::CreateKiWindow(), DIALOG_DRC::DIALOG_DRC(), SCH_EDIT_FRAME::OnImportProject(), SCH_EDIT_FRAME::SaveProject(), and SCH_EDIT_FRAME::SendSelectItemsToPcb().

◆ KifaceSearch()

SEARCH_STACK & KIFACE_BASE::KifaceSearch ( )
inlineinherited

Only for DSO specific 'non-library' files.

(The library search path is in the PROJECT class.)

Definition at line 114 of file kiface_base.h.

114{ return m_bm.m_search; }
SEARCH_STACK m_search
Definition: bin_mod.h:60

References KIFACE_BASE::m_bm, and BIN_MOD::m_search.

Referenced by CVPCB_MAINFRAME::buildEquivalenceList(), DS_DATA_MODEL::ResolvePath(), and EDA_BASE_FRAME::sys_search().

◆ KifaceSettings()

APP_SETTINGS_BASE * KIFACE_BASE::KifaceSettings ( ) const
inlineinherited

Definition at line 93 of file kiface_base.h.

93{ return m_bm.m_config; }
APP_SETTINGS_BASE * m_config
maybe from $HOME/.${m_name}
Definition: bin_mod.h:57

References KIFACE_BASE::m_bm, and BIN_MOD::m_config.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::AddField(), AUTOPLACER::AUTOPLACER(), EDA_BASE_FRAME::config(), BMP2CMP::IFACE::CreateKiWindow(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_COLOR_PICKER::DIALOG_COLOR_PICKER(), DIALOG_ERC::DIALOG_ERC(), DIALOG_LABEL_PROPERTIES::DIALOG_LABEL_PROPERTIES(), DIALOG_PRINT_GERBVIEW::DIALOG_PRINT_GERBVIEW(), DIALOG_PRINT_PCBNEW::DIALOG_PRINT_PCBNEW(), DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), KIGFX::eeconfig(), PCB_PLUGIN::FootprintSave(), DIALOG_PLOT_SCHEMATIC::getPlotOptions(), LAYERS_MAP_DIALOG::initDialog(), DIALOG_PLOT_SCHEMATIC::initDlg(), DIALOG_ANNOTATE::InitValues(), DIALOG_EXPORT_NETLIST::InstallCustomPages(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), EDA_DRAW_FRAME::loadCanvasTypeSetting(), DIALOG_SYMBOL_FIELDS_TABLE::LoadFieldNames(), DIALOG_SYMBOL_FIELDS_TABLE::OnAddField(), DIALOG_SYMBOL_FIELDS_TABLE::OnColumnItemToggled(), LAYERS_MAP_DIALOG::OnGetSetup(), DIALOG_SHEET_PROPERTIES::OnInitDlg(), DIALOG_SYMBOL_PROPERTIES::OnInitDlg(), OnKifaceStart(), SCH::IFACE::OnKifaceStart(), GERBV::IFACE::OnKifaceStart(), PGE::IFACE::OnKifaceStart(), PCBCALC::IFACE::OnKifaceStart(), PCB::IFACE::OnKifaceStart(), DIALOG_RESCUE_EACH::OnNeverShowClick(), SCH_EDIT_FRAME::OnResizeHierarchyNavigator(), LAYERS_MAP_DIALOG::OnStoreSetup(), DIALOG_SYMBOL_FIELDS_TABLE::OnTableColSize(), DIALOG_EESCHEMA_PAGE_SETTINGS::onTransferDataToWindow(), SCH_EDIT_FRAME::OpenProjectFiles(), pcbconfig(), TRANSLINE_IDENT::ReadConfig(), PCB_EDIT_FRAME::redrawNetnames(), EDA_DRAW_FRAME::saveCanvasTypeSetting(), LIB_TREE_MODEL_ADAPTER::SaveSettings(), PCB_CALCULATOR_FRAME::SaveSettings(), PANEL_PCBNEW_ACTION_PLUGINS::TransferDataFromWindow(), RATSNEST_VIEW_ITEM::ViewDraw(), TRANSLINE_IDENT::WriteConfig(), DIALOG_EXPORT_NETLIST::WriteCurrentNetlistSetup(), DIALOG_ANNOTATE::~DIALOG_ANNOTATE(), DIALOG_COLOR_PICKER::~DIALOG_COLOR_PICKER(), DIALOG_EESCHEMA_PAGE_SETTINGS::~DIALOG_EESCHEMA_PAGE_SETTINGS(), DIALOG_ERC::~DIALOG_ERC(), DIALOG_LABEL_PROPERTIES::~DIALOG_LABEL_PROPERTIES(), DIALOG_SHEET_PROPERTIES::~DIALOG_SHEET_PROPERTIES(), and DIALOG_SYMBOL_PROPERTIES::~DIALOG_SYMBOL_PROPERTIES().

◆ Name()

const wxString KIFACE_BASE::Name ( )
inlineinherited

Definition at line 88 of file kiface_base.h.

89 {
90 return wxString::FromUTF8( m_bm.m_name );
91 }
const char * m_name
name of this binary module, static C string.
Definition: bin_mod.h:55

References KIFACE_BASE::m_bm, and BIN_MOD::m_name.

◆ OnKifaceEnd()

void IFACE::OnKifaceEnd ( )
overridevirtual

Called just once just before the DSO is to be unloaded.

It is called before static C++ destructors are called. A default implementation is supplied.

Reimplemented from KIFACE_BASE.

Definition at line 197 of file cvpcb.cpp.

198{
199 end_common();
200}
void end_common()
Common things to do for a top program module, during OnKifaceEnd();.
Definition: kiface_base.cpp:42

References KIFACE_BASE::end_common().

◆ OnKifaceStart()

bool IFACE::OnKifaceStart ( PGM_BASE aProgram,
int  aCtlBits 
)
overridevirtual

!!!!!!!!!!!!!! This code is obsolete because of the merge into Pcbnew, don't bother with it.

Implements KIFACE_BASE.

Definition at line 148 of file cvpcb.cpp.

149{
150 // This is process level, not project level, initialization of the DSO.
151
152 // Do nothing in here pertinent to a project!
153
156
157 start_common( aCtlBits );
158
159 /* Now that there are no *.mod files in the standard library, this function
160 has no utility. User should simply set the variable manually.
161 Looking for *.mod files which do not exist is fruitless.
162
163 // SetFootprintLibTablePath();
164 */
165
166 try
167 {
168 // The global table is not related to a specific project. All projects
169 // will use the same global table. So the KIFACE::OnKifaceStart() contract
170 // of avoiding anything project specific is not violated here.
171
173 {
174 DisplayInfoMessage( nullptr, _( "You have run CvPcb for the first time using the "
175 "new footprint library table method for finding "
176 "footprints.\nCvPcb has either copied the default "
177 "table or created an empty table in your home "
178 "folder.\nYou must first configure the library "
179 "table to include all footprint libraries not "
180 "included with KiCad.\nSee the \"Footprint Library "
181 "Table\" section of the CvPcb documentation for "
182 "more information." ) );
183 }
184 }
185 catch( const IO_ERROR& ioe )
186 {
187 DisplayErrorMessage( nullptr, _( "An error occurred attempting to load the global "
188 "footprint library table." ),
189 ioe.What() );
190 return false;
191 }
192
193 return true;
194}
static bool LoadGlobalTable(FP_LIB_TABLE &aTable)
Load the global footprint library table into aTable.
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:76
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:30
void InitSettings(APP_SETTINGS_BASE *aSettings)
Definition: kiface_base.h:95
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_base.h:93
bool start_common(int aCtlBits)
Common things to do for a top program module, during OnKifaceStart().
Definition: kiface_base.cpp:32
virtual SETTINGS_MANAGER & GetSettingsManager() const
Definition: pgm_base.h:135
T * RegisterSettings(T *aSettings, bool aLoadNow=true)
Takes ownership of the pointer passed in.
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:352
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:325
int PGM_BASE * aProgram
Definition: cvpcb.cpp:110
#define _(s)

References _, aProgram, DisplayErrorMessage(), DisplayInfoMessage(), PGM_BASE::GetSettingsManager(), GFootprintTable, KIFACE_BASE::InitSettings(), KIFACE_BASE::KifaceSettings(), FP_LIB_TABLE::LoadGlobalTable(), SETTINGS_MANAGER::RegisterSettings(), KIFACE_BASE::start_common(), and IO_ERROR::What().

◆ SaveFileAs()

virtual void KIFACE::SaveFileAs ( const wxString &  srcProjectBasePath,
const wxString &  srcProjectName,
const wxString &  newProjectBasePath,
const wxString &  newProjectName,
const wxString &  srcFilePath,
wxString &  aErrors 
)
inlinevirtualinherited

Saving a file under a different name is delegated to the various KIFACEs because the project doesn't know the internal format of the various files (which may have paths in them that need updating).

Reimplemented in SCH::IFACE, GERBV::IFACE, PGE::IFACE, and PCB::IFACE.

Definition at line 211 of file kiway.h.

217 {
218 // If a KIFACE owns files then it needs to implement this....
219 }

Referenced by SAVE_AS_TRAVERSER::OnFile().

◆ start_common()

bool KIFACE_BASE::start_common ( int  aCtlBits)
protectedinherited

Common things to do for a top program module, during OnKifaceStart().

Definition at line 32 of file kiface_base.cpp.

33{
34 m_start_flags = aCtlBits;
35 m_bm.Init();
37
38 return true;
39}
KIWAY::FACE_T m_id
Definition: kiface_base.h:123
void Init()
Definition: bin_mod.cpp:38
void GlobalPathsAppend(SEARCH_STACK *aDst, KIWAY::FACE_T aId)
Initialize aDst SEARCH_STACK with KIFACE (DSO) specific settings.

References GlobalPathsAppend(), BIN_MOD::Init(), KIFACE_BASE::m_bm, KIFACE_BASE::m_id, BIN_MOD::m_search, and KIFACE_BASE::m_start_flags.

Referenced by BMP2CMP::IFACE::OnKifaceStart(), OnKifaceStart(), SCH::IFACE::OnKifaceStart(), GERBV::IFACE::OnKifaceStart(), PGE::IFACE::OnKifaceStart(), PCBCALC::IFACE::OnKifaceStart(), and PCB::IFACE::OnKifaceStart().

◆ StartFlags()

int KIFACE_BASE::StartFlags ( ) const
inlineinherited

Return whatever was passed as aCtlBits to OnKifaceStart().

Definition at line 100 of file kiface_base.h.

100{ return m_start_flags; }

References KIFACE_BASE::m_start_flags.

Member Data Documentation

◆ m_bm

◆ m_id

KIWAY::FACE_T KIFACE_BASE::m_id
privateinherited

Definition at line 123 of file kiface_base.h.

Referenced by KIFACE_BASE::start_common().

◆ m_start_flags

int KIFACE_BASE::m_start_flags
privateinherited

flags provided in OnKifaceStart()

Definition at line 127 of file kiface_base.h.

Referenced by KIFACE_BASE::IsSingle(), KIFACE_BASE::start_common(), and KIFACE_BASE::StartFlags().


The documentation for this struct was generated from the following file: