pl_editor.cpp File Reference

#include <wx/file.h>
#include <wx/snglinst.h>
#include <kiface_base.h>
#include <confirm.h>
#include <gestfich.h>
#include <pgm_base.h>
#include <settings/settings_manager.h>
#include <dialogs/panel_pl_editor_display_options.h>
#include <dialogs/panel_pl_editor_color_settings.h>
#include "pl_editor_frame.h"
#include "pl_editor_settings.h"

Go to the source code of this file.

Classes
struct	PGE::IFACE

Namespaces
namespace	PGE

Functions
PGE::IFACE KIFACE_BASE	PGE::kiface ("pl_editor", KIWAY::FACE_PL_EDITOR)
	IFACE (const char *aName, KIWAY::FACE_T aType)
bool	OnKifaceStart (PGM_BASE *aProgram, int aCtlBits) override
void	OnKifaceEnd () override
wxWindow *	CreateKiWindow (wxWindow *aParent, int aClassId, KIWAY *aKiway, int aCtlBits=0) override
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...
KIFACE_BASE &	Kiface ()
	Global KIFACE_BASE "get" accessor. More...
	MY_API (KIFACE *) KIFACE_GETTER(int *aKIFACEversion
PGM_BASE &	Pgm ()
	The global Program "get" accessor. More...
PGM_BASE *	PgmOrNull ()
	similar to PGM_BASE& Pgm(), but return a reference that can be nullptr when running a shared lib from a script, not from a kicad appl More...

Variables
static PGM_BASE *	process
int	aKiwayVersion
int PGM_BASE *	aProgram
return &	kiface

Function Documentation

CreateKiWindow()

wxWindow * kiface::CreateKiWindow ( wxWindow *  aParent, int  aClassId, KIWAY *  aKiway, int  aCtlBits = 0  )

override

Definition at line 10 of file pl_editor.cpp.

IFACE()

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

Definition at line 2 of file pl_editor.cpp.

IfaceOrAddress()

void * kiface::IfaceOrAddress ( int  aDataId )

override

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.

Definition at line 46 of file pl_editor.cpp.

Kiface()

KIFACE_BASE & Kiface

(

)

Global KIFACE_BASE "get" accessor.

Definition at line 116 of file pl_editor.cpp.

References kiface.

MY_API()

MY_API

(

KIFACE *

)

OnKifaceEnd()

void kiface::OnKifaceEnd ( )

override

Definition at line 11 of file test_app_main.cpp.

OnKifaceStart()

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

override

Definition at line 6 of file test_app_main.cpp.

Pgm()

PGM_BASE & Pgm

(

)

The global Program "get" accessor.

Implemented in: 1) common/single_top.cpp, 2) kicad/kicad.cpp, and 3) scripting/kiway.i

Definition at line 128 of file pl_editor.cpp.

References process.

PgmOrNull()

PGM_BASE * PgmOrNull

(

)

similar to PGM_BASE& Pgm(), but return a reference that can be nullptr when running a shared lib from a script, not from a kicad appl

Definition at line 136 of file pl_editor.cpp.

References process.

SaveFileAs()

void kiface::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).

References FRAME_PL_EDITOR, SETTINGS_MANAGER::GetAppSettings(), PANEL_DS_COLORS, PANEL_DS_DISPLAY_OPTIONS, and Pgm().

Variable Documentation

aKiwayVersion

int aKiwayVersion

Definition at line 121 of file pl_editor.cpp.

aProgram

int PGM_BASE* aProgram

Initial value:

{
 process = (PGM_BASE*) aProgram

Definition at line 121 of file pl_editor.cpp.

kiface

return& kiface

Definition at line 124 of file pl_editor.cpp.

Referenced by Kiface().

process

PGM_BASE* process

static

Definition at line 113 of file pl_editor.cpp.

Referenced by Pgm(), and PgmOrNull().