KiCad PCB EDA Suite
|
Public Member Functions | |
IFACE (const char *aName, KIWAY::FACE_T aType) | |
bool | OnKifaceStart (PGM_BASE *aProgram, int aCtlBits, KIWAY *aKiway) override |
Typically start_common() is called from here. | |
void | OnKifaceEnd () override |
Called just once just before the DSO is to be unloaded. | |
wxWindow * | CreateKiWindow (wxWindow *aParent, int aClassId, KIWAY *aKiway, int aCtlBits=0) override |
Create a wxWindow for the current project. | |
void * | IfaceOrAddress (int aDataId) override |
Return a pointer to the requested object. | |
virtual void | Reset () override |
Reloads global state. | |
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(). | |
bool | IsSingle () const |
Is this KIFACE running under single_top? | |
const wxString & | GetHelpFileName () const |
Return just the basename portion of the current help file. | |
SEARCH_STACK & | KifaceSearch () |
Only for DSO specific 'non-library' files. | |
void | GetActions (std::vector< TOOL_ACTION * > &aActions) const override |
Append this Kiface's registered actions to the given list. | |
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). | |
virtual int | HandleJob (JOB *aJob) |
virtual bool | HandleJobConfig (JOB *aJob, wxWindow *aParent) |
Protected Member Functions | |
bool | start_common (int aCtlBits) |
Common things to do for a top program module, during OnKifaceStart(). | |
void | end_common () |
Common things to do for a top program module, during OnKifaceEnd();. | |
Protected Attributes | |
int | m_start_flags |
flags provided in OnKifaceStart() | |
Private Attributes | |
KIWAY::FACE_T | m_id |
BIN_MOD | m_bm |
Definition at line 34 of file pcb_calculator.cpp.
|
inline |
Definition at line 38 of file pcb_calculator.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 46 of file pcb_calculator.cpp.
|
protectedinherited |
Common things to do for a top program module, during OnKifaceEnd();.
Definition at line 42 of file kiface_base.cpp.
References BIN_MOD::End(), and KIFACE_BASE::m_bm.
Referenced by CV::IFACE::OnKifaceEnd(), SCH::IFACE::OnKifaceEnd(), GERBV::IFACE::OnKifaceEnd(), KIFACE_BASE::OnKifaceEnd(), PGE::IFACE::OnKifaceEnd(), OnKifaceEnd(), and PCB::IFACE::OnKifaceEnd().
|
inlineoverridevirtualinherited |
Append this Kiface's registered actions to the given list.
Implements KIFACE.
Definition at line 118 of file kiface_base.h.
References ACTION_MANAGER::GetActionList().
Referenced by DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), and EDA_BASE_FRAME::ShowPreferences().
|
inlineinherited |
Return just the basename portion of the current help file.
Definition at line 112 of file kiface_base.h.
References KIFACE_BASE::m_bm, and BIN_MOD::m_help_file.
Referenced by EDA_BASE_FRAME::help_name().
|
inlinevirtualinherited |
Reimplemented in SCH::IFACE, and PCB::IFACE.
Definition at line 244 of file kiway.h.
Referenced by KIWAY::ProcessJob().
|
inlinevirtualinherited |
Reimplemented in SCH::IFACE, and PCB::IFACE.
Definition at line 249 of file kiway.h.
Referenced by KIWAY::ProcessJobConfigDialog().
|
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 62 of file pcb_calculator.cpp.
|
inlineinherited |
Definition at line 97 of file kiface_base.h.
References BIN_MOD::InitSettings(), and KIFACE_BASE::m_bm.
Referenced by BMP2CMP::IFACE::CreateKiWindow(), CV::IFACE::OnKifaceStart(), SCH::IFACE::OnKifaceStart(), GERBV::IFACE::OnKifaceStart(), PGE::IFACE::OnKifaceStart(), OnKifaceStart(), and PCB::IFACE::OnKifaceStart().
|
inlineinherited |
Is this KIFACE running under single_top?
Definition at line 107 of file kiface_base.h.
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(), SCH_EDIT_FRAME::SendSelectItemsToPcb(), and DIALOG_FOOTPRINT_ASSOCIATIONS::TransferDataToWindow().
|
inlineinherited |
Only for DSO specific 'non-library' files.
(The library search path is in the PROJECT class.)
Definition at line 116 of file kiface_base.h.
References KIFACE_BASE::m_bm, and BIN_MOD::m_search.
Referenced by CVPCB_MAINFRAME::buildEquivalenceList(), and EDA_BASE_FRAME::sys_search().
|
inlineinherited |
Definition at line 95 of file kiface_base.h.
References KIFACE_BASE::m_bm, and BIN_MOD::m_config.
Referenced by AUTOPLACER::AUTOPLACER(), SCH_EDIT_FRAME::CaptureHierarchyPaneSize(), 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(), KIGFX::eeconfig(), PCB_IO_KICAD_SEXPR::FootprintSave(), DIALOG_PLOT_SCHEMATIC::getPlotOptions(), SCH_RENDER_SETTINGS::GetShowPageLimits(), 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(), LAYERS_MAP_DIALOG::OnGetSetup(), DIALOG_SHEET_PROPERTIES::OnInitDlg(), DIALOG_SYMBOL_PROPERTIES::OnInitDlg(), CV::IFACE::OnKifaceStart(), SCH::IFACE::OnKifaceStart(), GERBV::IFACE::OnKifaceStart(), PGE::IFACE::OnKifaceStart(), OnKifaceStart(), PCB::IFACE::OnKifaceStart(), DIALOG_RESCUE_EACH::OnNeverShowClick(), SCH_EDIT_FRAME::onResizeNetNavigator(), LAYERS_MAP_DIALOG::OnStoreSetup(), DIALOG_EESCHEMA_PAGE_SETTINGS::onTransferDataToWindow(), SCH_EDIT_FRAME::OpenProjectFiles(), pcbconfig(), TRANSLINE_IDENT::ReadConfig(), PCB_EDIT_FRAME::redrawNetnames(), 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(), and DIALOG_ERC::~DIALOG_ERC().
|
inlineinherited |
Definition at line 90 of file kiface_base.h.
References KIFACE_BASE::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_BASE.
Definition at line 97 of file pcb_calculator.cpp.
References KIFACE_BASE::end_common().
Typically start_common() is called from here.
Implements KIFACE_BASE.
Definition at line 87 of file pcb_calculator.cpp.
References PGM_BASE::GetSettingsManager(), KIFACE_BASE::InitSettings(), KIFACE_BASE::KifaceSettings(), SETTINGS_MANAGER::RegisterSettings(), and KIFACE_BASE::start_common().
|
inlineoverridevirtualinherited |
Reloads global state.
Implements KIFACE.
Reimplemented in SCH::IFACE, and PCB::IFACE.
Definition at line 55 of file kiface_base.h.
Referenced by KICAD_MANAGER_CONTROL::ShowPluginManager().
|
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 216 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 32 of file kiface_base.cpp.
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(), CV::IFACE::OnKifaceStart(), SCH::IFACE::OnKifaceStart(), GERBV::IFACE::OnKifaceStart(), PGE::IFACE::OnKifaceStart(), OnKifaceStart(), and PCB::IFACE::OnKifaceStart().
|
inlineinherited |
Return whatever was passed as aCtlBits to OnKifaceStart().
Definition at line 102 of file kiface_base.h.
References KIFACE_BASE::m_start_flags.
|
privateinherited |
Definition at line 129 of file kiface_base.h.
Referenced by KIFACE_BASE::end_common(), KIFACE_BASE::GetHelpFileName(), KIFACE_BASE::InitSettings(), KIFACE_BASE::KifaceSearch(), KIFACE_BASE::KifaceSettings(), KIFACE_BASE::Name(), and KIFACE_BASE::start_common().
|
privateinherited |
Definition at line 128 of file kiface_base.h.
Referenced by KIFACE_BASE::start_common().
|
protectedinherited |
flags provided in OnKifaceStart()
Definition at line 125 of file kiface_base.h.
Referenced by KIFACE_BASE::IsSingle(), SCH::IFACE::loadGlobalDesignBlockLibTable(), SCH::IFACE::loadGlobalLibTable(), PCB::IFACE::loadGlobalLibTable(), SCH::IFACE::OnKifaceStart(), PCB::IFACE::OnKifaceStart(), KIFACE_BASE::start_common(), and KIFACE_BASE::StartFlags().