KiCad PCB EDA Suite
pl_editor.cpp File Reference
#include <wx/file.h>
#include <wx/snglinst.h>
#include <kiface_i.h>
#include <confirm.h>
#include <gestfich.h>
#include <pgm_base.h>
#include <settings/settings_manager.h>
#include "pl_editor_frame.h"
#include "pl_editor_settings.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...
 
void SaveFileAs (const wxString &aProjectBasePath, const wxString &aSrcProjectName, const wxString &aNewProjectBasePath, const wxString &aNewProjectName, const wxString &aSrcFilePath, wxString &aErrors) override
 Function SaveFileAs 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_IKiface ()
 Global KIFACE_I "get" accessor. More...
 
 MY_API (KIFACE *) KIFACE_GETTER(int *aKIFACEversion
 
PGM_BASEPgm ()
 The global Program "get" accessor. More...
 
PGM_BASEPgmOrNull ()
 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_BASEprocess
 
int aKiwayVersion
 
int PGM_BASEaProgram
 
return & kiface
 

Function Documentation

◆ CreateWindow()

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

Definition at line 155 of file pl_editor.cpp.

160  {
161  if( destFile.GetName() == aSrcProjectName )
162  destFile.SetName( aNewProjectName );
163 
164  KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
165  }
166  else
167  {
168  wxFAIL_MSG( "Unexpected filetype for Pcbnew::SaveFileAs()" );
169  }
170 }
171 
void KiCopyFile(const wxString &aSrcPath, const wxString &aDestPath, wxString &aErrors)
Definition: gestfich.cpp:363

◆ IFACE()

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

Definition at line 147 of file pl_editor.cpp.

147 {
148  wxFileName destFile( aSrcFilePath );
149  wxString destPath = destFile.GetPathWithSep();

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

◆ Kiface()

KIFACE_I& Kiface ( )

Global KIFACE_I "get" accessor.

Definition at line 104 of file pl_editor.cpp.

104 { return kiface; }
return & kiface
Definition: pl_editor.cpp:112

References PGE::kiface().

◆ MY_API()

MY_API ( KIFACE )

◆ OnKifaceEnd()

void kiface::OnKifaceEnd ( )
override

Definition at line 47 of file mocks_eeschema.cpp.

51  {

◆ OnKifaceStart()

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

Definition at line 40 of file common_mocks.cpp.

40 {
41  static PGM_TEST_FRAME program;
42  return program;
43 }
PGM_SINGLE_TOP program

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

117 {
118  wxASSERT( process ); // KIFACE_GETTER has already been called.
119  return *process;
120 }
static PGM_BASE * process
Definition: pl_editor.cpp:102

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

125 {
126  return process;
127 }
static PGM_BASE * process
Definition: pl_editor.cpp:102

References process.

◆ SaveFileAs()

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

Function SaveFileAs 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).

Variable Documentation

◆ aKiwayVersion

int aKiwayVersion

Definition at line 109 of file pl_editor.cpp.

◆ aProgram

int PGM_BASE* aProgram
Initial value:
{
Container for data for KiCad programs.
Definition: pgm_base.h:91
int PGM_BASE * aProgram
Definition: pl_editor.cpp:110
static PGM_BASE * process
Definition: pl_editor.cpp:102

Definition at line 110 of file pl_editor.cpp.

Referenced by PGE::IFACE::OnKifaceStart().

◆ kiface

return& kiface

Definition at line 112 of file pl_editor.cpp.

◆ process

PGM_BASE* process
static

Definition at line 102 of file pl_editor.cpp.

Referenced by Pgm(), and PgmOrNull().