KiCad PCB EDA Suite
pl_editor.cpp File Reference

page layout editor main file. More...

#include <fctsys.h>
#include <kiface_i.h>
#include <confirm.h>
#include <gestfich.h>
#include <ws_draw_item.h>
#include <pl_editor_frame.h>
#include <build_version.h>
#include <wx/file.h>
#include <wx/snglinst.h>

Go to the source code of this file.

Classes

struct  PGE::IFACE
 

Namespaces

 PGE
 

Functions

PGE::IFACE KIFACE_I 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 * CreateWindow (wxWindow *aParent, int aClassId, KIWAY *aKiway, int aCtlBits=0) override
 
void * IfaceOrAddress (int aDataId) override
 Function IfaceOrAddress return a pointer to the requested object. More...
 
KIFACE_IKiface ()
 Global KIFACE_I "get" accessor. More...
 
 MY_API (KIFACE *) KIFACE_GETTER(int *aKIFACEversion
 
PGM_BASEPgm ()
 The global Program "get" accessor. More...
 

Variables

static PGM_BASEprocess
 
int aKiwayVersion
 
int PGM_BASEaProgram
 
return & kiface
 

Detailed Description

page layout editor main file.

Definition in file pl_editor.cpp.

Function Documentation

◆ CreateWindow()

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

Definition at line 134 of file pl_editor.cpp.

◆ IFACE()

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

Definition at line 126 of file pl_editor.cpp.

◆ IfaceOrAddress()

void* kiface::IfaceOrAddress ( int  aDataId)
override

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
aDataIdidentifies which object you want the address of.
Returns
void* - and must be cast into the know type.

Definition at line 163 of file pl_editor.cpp.

◆ Kiface()

KIFACE_I& Kiface ( )

Global KIFACE_I "get" accessor.

Definition at line 97 of file pl_editor.cpp.

97 { return kiface; }
return & kiface
Definition: pl_editor.cpp:105

References PGE::kiface().

◆ MY_API()

MY_API ( KIFACE )

◆ OnKifaceEnd()

void kiface::OnKifaceEnd ( )
override

◆ OnKifaceStart()

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

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

110 {
111  wxASSERT( process ); // KIFACE_GETTER has already been called.
112  return *process;
113 }
static PGM_BASE * process
Definition: pl_editor.cpp:95

References process, and program.

Variable Documentation

◆ aKiwayVersion

int aKiwayVersion

Definition at line 102 of file pl_editor.cpp.

◆ aProgram

int PGM_BASE* aProgram
Initial value:
{
Class PGM_BASE keeps program (whole process) data for KiCad programs.
Definition: pgm_base.h:166
int PGM_BASE * aProgram
Definition: pl_editor.cpp:103
static PGM_BASE * process
Definition: pl_editor.cpp:95

Definition at line 103 of file pl_editor.cpp.

◆ kiface

return& kiface

Definition at line 105 of file pl_editor.cpp.

◆ process

PGM_BASE* process
static

Definition at line 95 of file pl_editor.cpp.

Referenced by Pgm().