![]() |
KiCad PCB EDA Suite
|
Public Member Functions | |
bool | OnKifaceStart (PGM_BASE *aProgram, int aCtlBits) override |
Typically start_common() is called from here. More... | |
wxWindow * | CreateWindow (wxWindow *aParent, int aClassId, KIWAY *aKiway, int aCtlBits=0) override |
Create a wxWindow for the current project. More... | |
void * | IfaceOrAddress (int aDataId) override |
Return pointer to the requested object. More... | |
IFACE (const char *aDSOname, KIWAY::FACE_T aType) | |
IFACE (const char *aName, KIWAY::FACE_T aType) | |
bool | OnKifaceStart (PGM_BASE *aProgram, int aCtlBits) override |
Typically start_common() is called from here. More... | |
void | OnKifaceEnd () override |
Called just once just before the DSO is to be unloaded. More... | |
wxWindow * | CreateWindow (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... | |
IFACE (const char *aName, KIWAY::FACE_T aType) | |
bool | OnKifaceStart (PGM_BASE *aProgram, int aCtlBits) override |
Typically start_common() is called from here. More... | |
void | OnKifaceEnd () override |
Called just once just before the DSO is to be unloaded. More... | |
wxWindow * | CreateWindow (wxWindow *aParent, int aClassId, KIWAY *aKiway, int aCtlBits=0) override |
Create a wxWindow for the current project. More... | |
void * | IfaceOrAddress (int aDataId) override |
Function IfaceOrAddress return a pointer to the requested object. More... | |
IFACE (const char *aName, KIWAY::FACE_T aType) | |
bool | OnKifaceStart (PGM_BASE *aProgram, int aCtlBits) override |
Typically start_common() is called from here. More... | |
void | OnKifaceEnd () override |
Called just once just before the DSO is to be unloaded. More... | |
wxWindow * | CreateWindow (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_BASE * | KifaceSettings () 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_STACK & | KifaceSearch () |
Only for DSO specific 'non-library' files. 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... | |
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... | |
Definition at line 45 of file common_mocks.cpp.
|
inline |
Definition at line 62 of file common_mocks.cpp.
|
inline |
Definition at line 42 of file mocks_eeschema.cpp.
|
inline |
Definition at line 36 of file mock_pgm.cpp.
|
inline |
Definition at line 56 of file test_app_main.cpp.
|
inlineoverridevirtual |
Create a wxWindow for the current project.
The caller must cast the return value into the known type.
aParent | may 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. |
aClassId | identifies which wxFrame or wxDialog to retrieve, using a value known to the implementing KIFACE. |
aKIWAY | tells the window which KIWAY (and PROJECT) it is a participant in. |
aCtlBits | consists of bit flags from the set of KFCTL_* #defines above. |
Implements KIFACE_BASE.
Definition at line 47 of file mock_pgm.cpp.
|
inlineoverridevirtual |
Create a wxWindow for the current project.
The caller must cast the return value into the known type.
aParent | may 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. |
aClassId | identifies which wxFrame or wxDialog to retrieve, using a value known to the implementing KIFACE. |
aKIWAY | tells the window which KIWAY (and PROJECT) it is a participant in. |
aCtlBits | consists of bit flags from the set of KFCTL_* #defines above. |
Implements KIFACE_BASE.
Definition at line 52 of file common_mocks.cpp.
|
inlineoverridevirtual |
Create a wxWindow for the current project.
The caller must cast the return value into the known type.
aParent | may 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. |
aClassId | identifies which wxFrame or wxDialog to retrieve, using a value known to the implementing KIFACE. |
aKIWAY | tells the window which KIWAY (and PROJECT) it is a participant in. |
aCtlBits | consists of bit flags from the set of KFCTL_* #defines above. |
Implements KIFACE_BASE.
Definition at line 55 of file mocks_eeschema.cpp.
|
inlineoverridevirtual |
Create a wxWindow for the current project.
The caller must cast the return value into the known type.
aParent | may 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. |
aClassId | identifies which wxFrame or wxDialog to retrieve, using a value known to the implementing KIFACE. |
aKIWAY | tells the window which KIWAY (and PROJECT) it is a participant in. |
aCtlBits | consists of bit flags from the set of KFCTL_* #defines above. |
Implements KIFACE_BASE.
Definition at line 67 of file test_app_main.cpp.
|
protectedinherited |
Common things to do for a top program module, during OnKifaceEnd();.
Definition at line 107 of file kiface_base.cpp.
References BIN_MOD::End(), and KIFACE_BASE::m_bm.
Referenced by PCBCALC::IFACE::OnKifaceEnd(), KIFACE_BASE::OnKifaceEnd(), CV::IFACE::OnKifaceEnd(), PGE::IFACE::OnKifaceEnd(), GERBV::IFACE::OnKifaceEnd(), PCB::IFACE::OnKifaceEnd(), and SCH::IFACE::OnKifaceEnd().
|
inlineinherited |
Return just the basename portion of the current help file.
Definition at line 109 of file kiface_base.h.
References KIFACE_BASE::m_bm, and BIN_MOD::m_help_file.
Referenced by EDA_BASE_FRAME::help_name().
|
inlineoverridevirtual |
Return 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. Segfaults are your fault.
aDataId | identifies which object you want the address of, and consists of choices known in advance by the implementing KIFACE. |
Implements KIFACE_BASE.
Definition at line 57 of file common_mocks.cpp.
|
inlineoverridevirtual |
Function IfaceOrAddress 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.
aDataId | identifies which object you want the address of. |
Implements KIFACE_BASE.
Definition at line 64 of file mock_pgm.cpp.
|
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.
aDataId | identifies which object you want the address of. |
Implements KIFACE_BASE.
Definition at line 72 of file mocks_eeschema.cpp.
|
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.
aDataId | identifies which object you want the address of. |
Implements KIFACE_BASE.
Definition at line 84 of file test_app_main.cpp.
|
inlineinherited |
Definition at line 94 of file kiface_base.h.
References BIN_MOD::InitSettings(), and KIFACE_BASE::m_bm.
Referenced by BMP2CMP::IFACE::CreateWindow(), PCBCALC::IFACE::OnKifaceStart(), CV::IFACE::OnKifaceStart(), PGE::IFACE::OnKifaceStart(), GERBV::IFACE::OnKifaceStart(), PCB::IFACE::OnKifaceStart(), and SCH::IFACE::OnKifaceStart().
|
inlineinherited |
Is this KIFACE running under single_top?
Definition at line 104 of file kiface_base.h.
References KFCTL_STANDALONE, and KIFACE_BASE::m_start_flags.
Referenced by ACTION_MENU::AddQuitOrClose(), AskSaveBoardFileName(), PCB_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::canCloseWindow(), PCB::IFACE::CreateWindow(), SCH::IFACE::CreateWindow(), PCB_BASE_EDIT_FRAME::doCloseWindow(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), SCH_EDIT_FRAME::OnImportProject(), SCH_EDIT_FRAME::OnOpenPcbnew(), PCB_EDIT_FRAME::OnQuit(), DRC_TOOL::RunTests(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), and SCH_EDIT_FRAME::SetCrossProbeConnection().
|
inlineinherited |
Only for DSO specific 'non-library' files.
(The library search path is in the PROJECT class.)
Definition at line 113 of file kiface_base.h.
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().
|
inlineinherited |
Definition at line 92 of file kiface_base.h.
References KIFACE_BASE::m_bm, and BIN_MOD::m_config.
Referenced by EDA_BASE_FRAME::config(), BMP2CMP::IFACE::CreateWindow(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_COLOR_PICKER::DIALOG_COLOR_PICKER(), DIALOG_PRINT_GERBVIEW::DIALOG_PRINT_GERBVIEW(), DIALOG_PRINT_PCBNEW::DIALOG_PRINT_PCBNEW(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), EDA_DRAW_FRAME::loadCanvasTypeSetting(), PCBCALC::IFACE::OnKifaceStart(), CV::IFACE::OnKifaceStart(), PGE::IFACE::OnKifaceStart(), GERBV::IFACE::OnKifaceStart(), PCB::IFACE::OnKifaceStart(), SCH::IFACE::OnKifaceStart(), EDA_DRAW_FRAME::saveCanvasTypeSetting(), LIB_TREE_MODEL_ADAPTER::SaveColWidths(), and DIALOG_COLOR_PICKER::~DIALOG_COLOR_PICKER().
|
inlineinherited |
Definition at line 87 of file kiface_base.h.
References KIFACE_BASE::m_bm, and BIN_MOD::m_name.
|
inlineoverridevirtual |
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 45 of file mock_pgm.cpp.
|
inlineoverridevirtual |
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 51 of file mocks_eeschema.cpp.
|
inlineoverridevirtual |
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 65 of file test_app_main.cpp.
|
inlineoverridevirtual |
Typically start_common() is called from here.
Implements KIFACE_BASE.
Definition at line 40 of file mock_pgm.cpp.
|
inlineoverridevirtual |
Typically start_common() is called from here.
Implements KIFACE_BASE.
Definition at line 46 of file mocks_eeschema.cpp.
|
inlineoverridevirtual |
Typically start_common() is called from here.
Implements KIFACE_BASE.
Definition at line 47 of file common_mocks.cpp.
References KIFACE_BASE::start_common().
|
inlineoverridevirtual |
Typically start_common() is called from here.
Implements KIFACE_BASE.
Definition at line 60 of file test_app_main.cpp.
|
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, PCB::IFACE, GERBV::IFACE, and PGE::IFACE.
Definition at line 208 of file kiway.h.
Referenced by SAVE_AS_TRAVERSER::OnFile().
|
protectedinherited |
Common things to do for a top program module, during OnKifaceStart().
Definition at line 97 of file kiface_base.cpp.
References BIN_MOD::Init(), KIFACE_BASE::m_bm, KIFACE_BASE::m_id, BIN_MOD::m_search, KIFACE_BASE::m_start_flags, and setSearchPaths().
Referenced by BMP2CMP::IFACE::OnKifaceStart(), PCBCALC::IFACE::OnKifaceStart(), OnKifaceStart(), CV::IFACE::OnKifaceStart(), PGE::IFACE::OnKifaceStart(), GERBV::IFACE::OnKifaceStart(), PCB::IFACE::OnKifaceStart(), and SCH::IFACE::OnKifaceStart().
|
inlineinherited |
Return whatever was passed as aCtlBits to OnKifaceStart().
Definition at line 99 of file kiface_base.h.
References KIFACE_BASE::m_start_flags.