IFACE Struct Reference

Inheritance diagram for IFACE:

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...

Detailed Description

Definition at line 45 of file common_mocks.cpp.

Constructor & Destructor Documentation

IFACE() [1/4]

IFACE::IFACE ( const char *  aDSOname, KIWAY::FACE_T  aType  )

inline

Definition at line 62 of file common_mocks.cpp.

 :
 KIFACE_BASE( aDSOname, aType )
 {}

IFACE() [2/4]

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

inline

Definition at line 42 of file mocks_eeschema.cpp.

 : KIFACE_BASE( aName, aType )
 {
 }

IFACE() [3/4]

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

inline

Definition at line 36 of file mock_pgm.cpp.

 :
 KIFACE_BASE( aName, aType )
 {}

IFACE() [4/4]

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

inline

Definition at line 56 of file test_app_main.cpp.

 :
 KIFACE_BASE( aName, aType )
 {}

Member Function Documentation

CreateWindow() [1/4]

wxWindow* IFACE::CreateWindow ( 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

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.

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 47 of file mock_pgm.cpp.

 {
 assert( false );
 return nullptr;
 }

CreateWindow() [2/4]

wxWindow* IFACE::CreateWindow ( 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

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.

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 common_mocks.cpp.

 {
 return nullptr;
 }

CreateWindow() [3/4]

wxWindow* IFACE::CreateWindow ( 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

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.

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 55 of file mocks_eeschema.cpp.

 {
 assert( false );
 return nullptr;
 }

CreateWindow() [4/4]

wxWindow* IFACE::CreateWindow ( 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

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.

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 67 of file test_app_main.cpp.

 {
 assert( false );
 return nullptr;
 }

end_common()

void KIFACE_BASE::end_common ( )

protectedinherited

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

Definition at line 107 of file kiface_base.cpp.

{
 m_bm.End();
}

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().

GetHelpFileName()

const wxString& KIFACE_BASE::GetHelpFileName ( ) const

inlineinherited

Return just the basename portion of the current help file.

Definition at line 109 of file kiface_base.h.

{ return m_bm.m_help_file; }

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

Referenced by EDA_BASE_FRAME::help_name().

IfaceOrAddress() [1/4]

void* IFACE::IfaceOrAddress ( int  aDataId )

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.

Parameters

aDataId

identifies which object you want the address of, and consists of choices known in advance by the implementing KIFACE.

Returns

the requested object which must be cast into the known type.

Implements KIFACE_BASE.

Definition at line 57 of file common_mocks.cpp.

 {
 return nullptr;
 }

IfaceOrAddress() [2/4]

void* IFACE::IfaceOrAddress ( int  aDataId )

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.

Parameters

aDataId

identifies which object you want the address of.

Returns

void* - and must be cast into the know type.

Implements KIFACE_BASE.

Definition at line 64 of file mock_pgm.cpp.

 {
 return NULL;
 }

IfaceOrAddress() [3/4]

void* 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

aDataId

identifies which object you want the address of.

Returns

requested object which must be cast into the know type.

Implements KIFACE_BASE.

Definition at line 72 of file mocks_eeschema.cpp.

 {
 return nullptr;
 }

IfaceOrAddress() [4/4]

void* 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

aDataId

identifies which object you want the address of.

Returns

the requested object which must be cast into the know type.

Implements KIFACE_BASE.

Definition at line 84 of file test_app_main.cpp.

 {
 return nullptr;
 }

InitSettings()

void KIFACE_BASE::InitSettings ( APP_SETTINGS_BASE *  aSettings )

inlineinherited

Definition at line 94 of file kiface_base.h.

{ m_bm.InitSettings( aSettings ); }

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().

IsSingle()

bool KIFACE_BASE::IsSingle ( ) const

inlineinherited

Is this KIFACE running under single_top?

Definition at line 104 of file kiface_base.h.

{ return m_start_flags & KFCTL_STANDALONE; }

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().

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 113 of file kiface_base.h.

{ return m_bm.m_search; }

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 92 of file kiface_base.h.

{ return m_bm.m_config; }

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().

Name()

const wxString KIFACE_BASE::Name ( )

inlineinherited

Definition at line 87 of file kiface_base.h.

 {
 return wxString::FromUTF8( m_bm.m_name );
 }

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

OnKifaceEnd() [1/3]

void IFACE::OnKifaceEnd ( )

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.

{}

OnKifaceEnd() [2/3]

void IFACE::OnKifaceEnd ( )

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.

 {
 }

OnKifaceEnd() [3/3]

void IFACE::OnKifaceEnd ( )

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.

{}

OnKifaceStart() [1/4]

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

inlineoverridevirtual

Typically start_common() is called from here.

Implements KIFACE_BASE.

Definition at line 40 of file mock_pgm.cpp.

 {
 return true;
 }

OnKifaceStart() [2/4]

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

inlineoverridevirtual

Typically start_common() is called from here.

Implements KIFACE_BASE.

Definition at line 46 of file mocks_eeschema.cpp.

 {
 return true;
 }

OnKifaceStart() [3/4]

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

inlineoverridevirtual

Typically start_common() is called from here.

Implements KIFACE_BASE.

Definition at line 47 of file common_mocks.cpp.

 {
 return start_common( aCtlBits );
 }

References KIFACE_BASE::start_common().

OnKifaceStart() [4/4]

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

inlineoverridevirtual

Typically start_common() is called from here.

Implements KIFACE_BASE.

Definition at line 60 of file test_app_main.cpp.

 {
 return true;
 }

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, PCB::IFACE, GERBV::IFACE, and PGE::IFACE.

Definition at line 208 of file kiway.h.

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

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 97 of file kiface_base.cpp.

{
 m_start_flags = aCtlBits;
 m_bm.Init();
 setSearchPaths( &m_bm.m_search, m_id );

 return true;
}

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().

StartFlags()

int KIFACE_BASE::StartFlags ( ) const

inlineinherited

Return whatever was passed as aCtlBits to OnKifaceStart().

Definition at line 99 of file kiface_base.h.

{ return m_start_flags; }

References KIFACE_BASE::m_start_flags.

---

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

• common_mocks.cpp
• mocks_eeschema.cpp
• mock_pgm.cpp
• test_app_main.cpp