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...
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_I &	Kiface ()
	Global KIFACE_I "get" accessor. More...
	MY_API (KIFACE *) KIFACE_GETTER(int *aKIFACEversion
PGM_BASE &	Pgm ()
	The global Program "get" accessor. More...

Variables
static PGM_BASE *	process
int	aKiwayVersion
int PGM_BASE *	aProgram
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 150 of file pl_editor.cpp.

    {
        if( destFile.GetName() == aSrcProjectName )
            destFile.SetName( aNewProjectName );

        CopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
    }
    else
    {
        wxFAIL_MSG( "Unexpected filetype for Pcbnew::SaveFileAs()" );
    }
}

IFACE()

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

Definition at line 142 of file pl_editor.cpp.

{
    wxFileName destFile( aSrcFilePath );
    wxString   destPath = destFile.GetPath();

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

aDataId

identifies which object you want the address of.

Returns

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

Definition at line 179 of file pl_editor.cpp.

Kiface()

KIFACE_I& Kiface

(

)

Global KIFACE_I "get" accessor.

Definition at line 107 of file pl_editor.cpp.

{ return kiface; }

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

{
    wxASSERT( process );    // KIFACE_GETTER has already been called.
    return *process;
}

References process, and program.

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

aProgram

int PGM_BASE* aProgram

Initial value:

{
    process = (PGM_BASE*) aProgram

Definition at line 113 of file pl_editor.cpp.

kiface

return& kiface

Definition at line 115 of file pl_editor.cpp.

process

PGM_BASE* process

static

Definition at line 105 of file pl_editor.cpp.

Referenced by Pgm().