![]() |
KiCad PCB EDA Suite
|
Public Member Functions | |
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... | |
void | SaveFileAs (const wxString &aProjectBasePath, const wxString &aProjectName, const wxString &aNewProjectBasePath, const wxString &aNewProjectName, const wxString &aSrcFilePath, wxString &aErrors) override |
Function SaveFileAs 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... | |
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_I 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... | |
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 gerbview.cpp.
|
inline |
Definition at line 49 of file gerbview.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_I.
Definition at line 57 of file gerbview.cpp.
References FRAME_GERBER, and NULL.
|
protectedinherited |
Common things to do for a top program module, during OnKifaceEnd();.
Definition at line 98 of file kiface_i.cpp.
References BIN_MOD::End(), and KIFACE_I::m_bm.
Referenced by KIFACE_I::OnKifaceEnd(), PCBCALC::IFACE::OnKifaceEnd(), CV::IFACE::OnKifaceEnd(), PGE::IFACE::OnKifaceEnd(), 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_i.h.
References KIFACE_I::m_bm, and BIN_MOD::m_help_file.
Referenced by EDA_BASE_FRAME::help_name().
|
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_I.
Definition at line 83 of file gerbview.cpp.
References NULL.
|
inlineinherited |
Definition at line 94 of file kiface_i.h.
References BIN_MOD::InitSettings(), and KIFACE_I::m_bm.
Referenced by BMP2CMP::IFACE::CreateWindow(), PCBCALC::IFACE::OnKifaceStart(), CV::IFACE::OnKifaceStart(), OnKifaceStart(), PGE::IFACE::OnKifaceStart(), PCB::IFACE::OnKifaceStart(), and SCH::IFACE::OnKifaceStart().
|
inlineinherited |
Is this KIFACE_I running under single_top?
Definition at line 104 of file kiface_i.h.
References KFCTL_STANDALONE, and KIFACE_I::m_start_flags.
Referenced by ACTION_MENU::AddQuitOrClose(), AskSaveBoardFileName(), SCH_EDIT_FRAME::canCloseWindow(), PCB::IFACE::CreateWindow(), SCH::IFACE::CreateWindow(), SCH_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), SCH_EDIT_FRAME::OnOpenPcbnew(), PCB_EDIT_FRAME::OnQuit(), DRC_TOOL::RunTests(), 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_i.h.
References KIFACE_I::m_bm, and BIN_MOD::m_search.
Referenced by CVPCB_MAINFRAME::buildEquivalenceList(), WS_DATA_MODEL::MakeFullFileName(), WS_DATA_MODEL::MakeShortFileName(), and EDA_BASE_FRAME::sys_search().
|
inlineinherited |
Definition at line 92 of file kiface_i.h.
References KIFACE_I::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(), 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_i.h.
References KIFACE_I::m_bm, and BIN_MOD::m_name.
|
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_I.
Definition at line 140 of file gerbview.cpp.
References KIFACE_I::end_common().
|
overridevirtual |
Typically start_common() is called from here.
Implements KIFACE_I.
Definition at line 131 of file gerbview.cpp.
References aProgram, PGM_BASE::GetSettingsManager(), KIFACE_I::InitSettings(), KIFACE_I::KifaceSettings(), SETTINGS_MANAGER::RegisterSettings(), and KIFACE_I::start_common().
|
overridevirtual |
Function SaveFileAs 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 from KIFACE.
Definition at line 146 of file gerbview.cpp.
|
protectedinherited |
Common things to do for a top program module, during OnKifaceStart().
Definition at line 88 of file kiface_i.cpp.
References BIN_MOD::Init(), KIFACE_I::m_bm, KIFACE_I::m_id, BIN_MOD::m_search, KIFACE_I::m_start_flags, and setSearchPaths().
Referenced by BMP2CMP::IFACE::OnKifaceStart(), PCBCALC::IFACE::OnKifaceStart(), IFACE::OnKifaceStart(), CV::IFACE::OnKifaceStart(), OnKifaceStart(), PGE::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_i.h.
References KIFACE_I::m_start_flags.