gerbview.cpp File Reference

GERBVIEW main file. More...

#include <gerbview.h>
#include <gerbview_frame.h>
#include <gerbview_settings.h>
#include <gestfich.h>
#include <kiface_base.h>
#include <macros.h>
#include <nlohmann/json.hpp>
#include <pgm_base.h>
#include <settings/settings_manager.h>
#include <dialogs/panel_gerbview_display_options.h>
#include <dialogs/panel_gerbview_excellon_settings.h>
#include <dialogs/panel_gerbview_color_settings.h>
#include <wildcards_and_files_ext.h>
#include <wx/ffile.h>

Go to the source code of this file.

Classes
struct	GERBV::IFACE

Namespaces
namespace	GERBV

Typedefs
using	json = nlohmann::json

Functions
GERBV::IFACE KIFACE_BASE	GERBV::kiface ("gerbview", KIWAY::FACE_GERBVIEW)
	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 &aProjectName, 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

Detailed Description

GERBVIEW main file.

Definition in file gerbview.cpp.

Typedef Documentation

json

using json = nlohmann::json

Definition at line 44 of file gerbview.cpp.

Function Documentation

CreateKiWindow()

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

override

Definition at line 10 of file gerbview.cpp.

 :
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
#include <gerbview.h>
#include <gerbview_frame.h>
#include <gerbview_settings.h>
#include <gestfich.h>

IFACE()

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

Definition at line 2 of file gerbview.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 44 of file gerbview.cpp.

 {

Kiface()

KIFACE_BASE & Kiface

(

)

Global KIFACE_BASE "get" accessor.

Definition at line 120 of file gerbview.cpp.

{ return kiface; }

References kiface.

MY_API()

MY_API

(

KIFACE *

)

OnKifaceEnd()

void kiface::OnKifaceEnd ( )

override

Definition at line 11 of file test_app_main.cpp.

:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html

OnKifaceStart()

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

override

Definition at line 6 of file test_app_main.cpp.

 :
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html

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 132 of file gerbview.cpp.

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

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 140 of file gerbview.cpp.

{
 return process;
}

References process.

SaveFileAs()

void kiface::SaveFileAs ( const wxString &  aProjectBasePath, const wxString &  aProjectName, 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).

Variable Documentation

aKiwayVersion

int aKiwayVersion

Definition at line 125 of file gerbview.cpp.

aProgram

int PGM_BASE* aProgram

Initial value:

{
 process = aProgram

Definition at line 125 of file gerbview.cpp.

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

kiface

return& kiface

Definition at line 128 of file gerbview.cpp.

Referenced by Kiface().

process

PGM_BASE* process

static

Definition at line 117 of file gerbview.cpp.

Referenced by Pgm(), and PgmOrNull().