PGE::IFACE Struct Reference

Inheritance diagram for PGE::IFACE:

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 *	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...
void	SaveFileAs (const wxString &aProjectBasePath, const wxString &aSrcProjectName, const wxString &aNewProjectBasePath, const wxString &aNewProjectName, const wxString &aSrcFilePath, wxString &aErrors) override
	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 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...
void	GetActions (std::vector< TOOL_ACTION * > &aActions) const override
	Append this Kiface's registered actions to the given list. 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 43 of file pl_editor.cpp.

Constructor & Destructor Documentation

IFACE()

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

inline

Definition at line 47 of file pl_editor.cpp.

 :
 KIFACE_BASE( aName, aType )
 {}

Member Function Documentation

CreateKiWindow()

wxWindow * PGE::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

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

 {
 switch( aClassId )
 {
 case FRAME_PL_EDITOR:
 return new PL_EDITOR_FRAME( aKiway, aParent );
 
 case PANEL_DS_DISPLAY_OPTIONS:
 {
 SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
 APP_SETTINGS_BASE* cfg = mgr.GetAppSettings<PL_EDITOR_SETTINGS>();
 
 return new PANEL_PL_EDITOR_DISPLAY_OPTIONS( aParent, cfg );
 }
 
 case PANEL_DS_COLORS:
 return new PANEL_PL_EDITOR_COLOR_SETTINGS( aParent );
 
 default:
 ;
 }
 
 return nullptr;
 }

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.

{
 m_bm.End();
}

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

Referenced by CV::IFACE::OnKifaceEnd(), SCH::IFACE::OnKifaceEnd(), GERBV::IFACE::OnKifaceEnd(), KIFACE_BASE::OnKifaceEnd(), 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.

 {
 for( TOOL_ACTION* action : ACTION_MANAGER::GetActionList() )
 aActions.push_back( action );
 }

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.

{ return m_bm.m_help_file; }

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.

 {
 return 0;
 }

IfaceOrAddress()

void * PGE::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 object requested and must be cast into the know type.

Implements KIFACE_BASE.

Definition at line 91 of file pl_editor.cpp.

 {
 return nullptr;
 }

InitSettings()

void KIFACE_BASE::InitSettings ( APP_SETTINGS_BASE *  aSettings )

inlineinherited

Definition at line 95 of file kiface_base.h.

{ m_bm.InitSettings( aSettings ); }

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

Referenced by BMP2CMP::IFACE::CreateKiWindow(), CV::IFACE::OnKifaceStart(), SCH::IFACE::OnKifaceStart(), GERBV::IFACE::OnKifaceStart(), 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.

{ return m_start_flags & KFCTL_STANDALONE; }

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.

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

{ return m_bm.m_config; }

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(), CV::IFACE::OnKifaceStart(), SCH::IFACE::OnKifaceStart(), GERBV::IFACE::OnKifaceStart(), 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.

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

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 150 of file pl_editor.cpp.

{
 end_common();
}

References KIFACE_BASE::end_common().

OnKifaceStart()

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

overridevirtual

Typically start_common() is called from here.

Implements KIFACE_BASE.

Definition at line 141 of file pl_editor.cpp.

{
 InitSettings( new PL_EDITOR_SETTINGS );
 aProgram->GetSettingsManager().RegisterSettings( KifaceSettings() );
 start_common( aCtlBits );
 return true;
}

References aProgram, PGM_BASE::GetSettingsManager(), KIFACE_BASE::InitSettings(), KIFACE_BASE::KifaceSettings(), SETTINGS_MANAGER::RegisterSettings(), and KIFACE_BASE::start_common().

SaveFileAs()

void IFACE::SaveFileAs ( const wxString &  aProjectBasePath, const wxString &  aSrcProjectName, const wxString &  aNewProjectBasePath, const wxString &  aNewProjectName, const wxString &  aSrcFilePath, wxString &  aErrors  )

overridevirtual

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 156 of file pl_editor.cpp.

{
 wxFileName destFile( aSrcFilePath );
 wxString destPath = destFile.GetPathWithSep();
 wxUniChar pathSep = wxFileName::GetPathSeparator();
 wxString ext = destFile.GetExt();
 
 if( destPath.StartsWith( aProjectBasePath + pathSep ) )
 {
 destPath.Replace( aProjectBasePath, aNewProjectBasePath, false );
 destFile.SetPath( destPath );
 }
 
 if( ext == "kicad_wks" )
 {
 if( destFile.GetName() == aSrcProjectName )
 destFile.SetName( aNewProjectName );
 
  KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
 }
 else
 {
 wxFAIL_MSG( "Unexpected filetype for Pcbnew::SaveFileAs()" );
 }
}

References KiCopyFile().

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.

{
 m_start_flags = aCtlBits;
 m_bm.Init();
 GlobalPathsAppend( &m_bm.m_search, m_id );
 
 return true;
}

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

{ return m_start_flags; }

References KIFACE_BASE::m_start_flags.

Member Data Documentation

m_bm

BIN_MOD KIFACE_BASE::m_bm

privateinherited

Definition at line 125 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().

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:

• pl_editor.cpp