Inheritance diagram for pcbnew.PCB_PLUGIN:

Public Member Functions
"wxString const"	PluginName (self)

"wxString const"	GetFileExtension (self)

"void"	Save (self, "wxString" aFileName, "BOARD" aBoard, "PROPERTIES const *" aProperties=None)

"BOARD *"	Load (self, "wxString" aFileName, "BOARD" aAppendToMe, "PROPERTIES const " aProperties=None, "PROJECT " aProject=None, "PROGRESS_REPORTER *" aProgressReporter=None)

"BOARD *"	DoLoad (self, "LINE_READER" aReader, "BOARD" aAppendToMe, "PROPERTIES const " aProperties, "PROGRESS_REPORTER " aProgressReporter, "unsigned int" aLineCount)

"void"	FootprintEnumerate (self, "wxArrayString &" aFootprintNames, "wxString" aLibraryPath, "bool" aBestEfforts, "PROPERTIES const *" aProperties=None)

"FOOTPRINT const *"	GetEnumeratedFootprint (self, "wxString" aLibraryPath, "wxString" aFootprintName, "PROPERTIES const *" aProperties=None)

"bool"	FootprintExists (self, "wxString" aLibraryPath, "wxString" aFootprintName, "PROPERTIES const *" aProperties=None)

"FOOTPRINT *"	FootprintLoad (self, "wxString" aLibraryPath, "wxString" aFootprintName, "bool" aKeepUUID=False, "PROPERTIES const *" aProperties=None)

"void"	FootprintSave (self, "wxString" aLibraryPath, "FOOTPRINT" aFootprint, "PROPERTIES const *" aProperties=None)

"void"	FootprintDelete (self, "wxString" aLibraryPath, "wxString" aFootprintName, "PROPERTIES const *" aProperties=None)

"long long"	GetLibraryTimestamp (self, "wxString" aLibraryPath)

"void"	FootprintLibCreate (self, "wxString" aLibraryPath, "PROPERTIES const *" aProperties=None)

"bool"	FootprintLibDelete (self, "wxString" aLibraryPath, "PROPERTIES const *" aProperties=None)

"bool"	IsFootprintLibWritable (self, "wxString" aLibraryPath)

def	__init__ (self, *args)

"void"	Format (self, "BOARD_ITEM" aItem, "int" aNestLevel=0)

"std::string"	GetStringOutput (self, "bool" doClear)

"void"	SetOutputFormatter (self, "OUTPUTFORMATTER" aFormatter)

"BOARD_ITEM *"	Parse (self, "wxString" aClipboardSourceInput)

Public Member Functions inherited from pcbnew.PLUGIN
def	__init__ (self, args, *kwargs)

"wxString const"	PluginName (self)

"wxString const"	GetFileExtension (self)

"BOARD *"	Load (self, "wxString" aFileName, "BOARD" aAppendToMe, "PROPERTIES const " aProperties=None, "PROJECT " aProject=None, "PROGRESS_REPORTER *" aProgressReporter=None)

"std::vector< FOOTPRINT ,std::allocator< FOOTPRINT > >"	GetImportedCachedLibraryFootprints (self)

"void"	Save (self, "wxString" aFileName, "BOARD" aBoard, "PROPERTIES const *" aProperties=None)

"void"	FootprintEnumerate (self, "wxArrayString &" aFootprintNames, "wxString" aLibraryPath, "bool" aBestEfforts, "PROPERTIES const *" aProperties=None)

"long long"	GetLibraryTimestamp (self, "wxString" aLibraryPath)

"void"	PrefetchLib (self, "wxString" aLibraryPath, "PROPERTIES const *" aProperties=None)

"FOOTPRINT *"	FootprintLoad (self, "wxString" aLibraryPath, "wxString" aFootprintName, "bool" aKeepUUID=False, "PROPERTIES const *" aProperties=None)

"FOOTPRINT const *"	GetEnumeratedFootprint (self, "wxString" aLibraryPath, "wxString" aFootprintName, "PROPERTIES const *" aProperties=None)

"bool"	FootprintExists (self, "wxString" aLibraryPath, "wxString" aFootprintName, "PROPERTIES const *" aProperties=None)

"void"	FootprintSave (self, "wxString" aLibraryPath, "FOOTPRINT" aFootprint, "PROPERTIES const *" aProperties=None)

"void"	FootprintDelete (self, "wxString" aLibraryPath, "wxString" aFootprintName, "PROPERTIES const *" aProperties=None)

"void"	FootprintLibCreate (self, "wxString" aLibraryPath, "PROPERTIES const *" aProperties=None)

"bool"	FootprintLibDelete (self, "wxString" aLibraryPath, "PROPERTIES const *" aProperties=None)

"bool"	IsFootprintLibWritable (self, "wxString" aLibraryPath)

"void"	FootprintLibOptions (self, "PROPERTIES *" aListToAppendTo)

"wxArrayString"	footprintPyEnumerate (self, "wxString" aLibraryPath, "bool" aExitOnError)

def	FootprintEnumerate (self, libname)

Properties
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Properties inherited from pcbnew.PLUGIN
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Detailed Description

Proxy of C++ PCB_PLUGIN class.

Definition at line 5965 of file pcbnew.py.

Constructor & Destructor Documentation

◆ init()

def pcbnew.PCB_PLUGIN.__init__	(		self,
		*	args
	)

__init__(PCB_PLUGIN self, int aControlFlags=((1 << 3)|(1 << 8))) -> PCB_PLUGIN

Reimplemented from pcbnew.PLUGIN.

Definition at line 6031 of file pcbnew.py.

Member Function Documentation

◆ DoLoad()

"BOARD *" pcbnew.PCB_PLUGIN.DoLoad	(		self,
		"LINE_READER"	aReader,
		"BOARD"	aAppendToMe,
		"PROPERTIES const *"	aProperties,
		"PROGRESS_REPORTER *"	aProgressReporter,
		"unsigned int"	aLineCount
	)

DoLoad(PCB_PLUGIN self, LINE_READER aReader, BOARD aAppendToMe, PROPERTIES const * aProperties, PROGRESS_REPORTER * aProgressReporter, unsigned int aLineCount) -> BOARD

Definition at line 5987 of file pcbnew.py.

◆ FootprintDelete()

"void" pcbnew.PCB_PLUGIN.FootprintDelete	(		self,
		"wxString"	aLibraryPath,
		"wxString"	aFootprintName,
		"PROPERTIES const *"	aProperties = `None`
	)

FootprintDelete(PCB_PLUGIN self, wxString aLibraryPath, wxString aFootprintName, PROPERTIES const * aProperties=None)

Reimplemented from pcbnew.PLUGIN.

Definition at line 6011 of file pcbnew.py.

◆ FootprintEnumerate()

"void" pcbnew.PCB_PLUGIN.FootprintEnumerate	(		self,
		"wxArrayString &"	aFootprintNames,
		"wxString"	aLibraryPath,
		"bool"	aBestEfforts,
		"PROPERTIES const *"	aProperties = `None`
	)

FootprintEnumerate(PCB_PLUGIN self, wxArrayString & aFootprintNames, wxString aLibraryPath, bool aBestEfforts, PROPERTIES const * aProperties=None)

Reimplemented from pcbnew.PLUGIN.

Definition at line 5991 of file pcbnew.py.

◆ FootprintExists()

"bool" pcbnew.PCB_PLUGIN.FootprintExists	(		self,
		"wxString"	aLibraryPath,
		"wxString"	aFootprintName,
		"PROPERTIES const *"	aProperties = `None`
	)

FootprintExists(PCB_PLUGIN self, wxString aLibraryPath, wxString aFootprintName, PROPERTIES const * aProperties=None) -> bool

Reimplemented from pcbnew.PLUGIN.

Definition at line 5999 of file pcbnew.py.

◆ FootprintLibCreate()

"void" pcbnew.PCB_PLUGIN.FootprintLibCreate	(		self,
		"wxString"	aLibraryPath,
		"PROPERTIES const *"	aProperties = `None`
	)

FootprintLibCreate(PCB_PLUGIN self, wxString aLibraryPath, PROPERTIES const * aProperties=None)

Reimplemented from pcbnew.PLUGIN.

Definition at line 6019 of file pcbnew.py.

◆ FootprintLibDelete()

"bool" pcbnew.PCB_PLUGIN.FootprintLibDelete	(		self,
		"wxString"	aLibraryPath,
		"PROPERTIES const *"	aProperties = `None`
	)

FootprintLibDelete(PCB_PLUGIN self, wxString aLibraryPath, PROPERTIES const * aProperties=None) -> bool

Reimplemented from pcbnew.PLUGIN.

Definition at line 6023 of file pcbnew.py.

◆ FootprintLoad()

"FOOTPRINT *" pcbnew.PCB_PLUGIN.FootprintLoad	(		self,
		"wxString"	aLibraryPath,
		"wxString"	aFootprintName,
		"bool"	aKeepUUID = `False`,
		"PROPERTIES const *"	aProperties = `None`
	)

FootprintLoad(PCB_PLUGIN self, wxString aLibraryPath, wxString aFootprintName, bool aKeepUUID=False, PROPERTIES const * aProperties=None) -> FOOTPRINT

Reimplemented from pcbnew.PLUGIN.

Definition at line 6003 of file pcbnew.py.

◆ FootprintSave()

"void" pcbnew.PCB_PLUGIN.FootprintSave	(		self,
		"wxString"	aLibraryPath,
		"FOOTPRINT"	aFootprint,
		"PROPERTIES const *"	aProperties = `None`
	)

FootprintSave(PCB_PLUGIN self, wxString aLibraryPath, FOOTPRINT aFootprint, PROPERTIES const * aProperties=None)

Reimplemented from pcbnew.PLUGIN.

Definition at line 6007 of file pcbnew.py.

◆ Format()

"void" pcbnew.PCB_PLUGIN.Format	(		self,
		"BOARD_ITEM"	aItem,
		"int"	aNestLevel = `0`
	)

Format(PCB_PLUGIN self, BOARD_ITEM aItem, int aNestLevel=0)

Definition at line 6036 of file pcbnew.py.

◆ GetEnumeratedFootprint()

"FOOTPRINT const *" pcbnew.PCB_PLUGIN.GetEnumeratedFootprint	(		self,
		"wxString"	aLibraryPath,
		"wxString"	aFootprintName,
		"PROPERTIES const *"	aProperties = `None`
	)

GetEnumeratedFootprint(PCB_PLUGIN self, wxString aLibraryPath, wxString aFootprintName, PROPERTIES const * aProperties=None) -> FOOTPRINT

Reimplemented from pcbnew.PLUGIN.

Definition at line 5995 of file pcbnew.py.

◆ GetFileExtension()

"wxString const" pcbnew.PCB_PLUGIN.GetFileExtension ( self )

GetFileExtension(PCB_PLUGIN self) -> wxString

Reimplemented from pcbnew.PLUGIN.

Definition at line 5975 of file pcbnew.py.

◆ GetLibraryTimestamp()

"long long" pcbnew.PCB_PLUGIN.GetLibraryTimestamp	(		self,
		"wxString"	aLibraryPath
	)

GetLibraryTimestamp(PCB_PLUGIN self, wxString aLibraryPath) -> long long

Reimplemented from pcbnew.PLUGIN.

Definition at line 6015 of file pcbnew.py.

◆ GetStringOutput()

"std.string" pcbnew.PCB_PLUGIN.GetStringOutput	(		self,
		"bool"	doClear
	)

GetStringOutput(PCB_PLUGIN self, bool doClear) -> string

Definition at line 6040 of file pcbnew.py.

◆ IsFootprintLibWritable()

"bool" pcbnew.PCB_PLUGIN.IsFootprintLibWritable	(		self,
		"wxString"	aLibraryPath
	)

IsFootprintLibWritable(PCB_PLUGIN self, wxString aLibraryPath) -> bool

Reimplemented from pcbnew.PLUGIN.

Definition at line 6027 of file pcbnew.py.

◆ Load()

"BOARD *" pcbnew.PCB_PLUGIN.Load	(		self,
		"wxString"	aFileName,
		"BOARD"	aAppendToMe,
		"PROPERTIES const *"	aProperties = `None`,
		"PROJECT *"	aProject = `None`,
		"PROGRESS_REPORTER *"	aProgressReporter = `None`
	)

Load(PCB_PLUGIN self, wxString aFileName, BOARD aAppendToMe, PROPERTIES const * aProperties=None, PROJECT * aProject=None, PROGRESS_REPORTER * aProgressReporter=None) -> BOARD

Reimplemented from pcbnew.PLUGIN.

Definition at line 5983 of file pcbnew.py.

◆ Parse()

"BOARD_ITEM *" pcbnew.PCB_PLUGIN.Parse	(		self,
		"wxString"	aClipboardSourceInput
	)

Parse(PCB_PLUGIN self, wxString aClipboardSourceInput) -> BOARD_ITEM

Definition at line 6048 of file pcbnew.py.

◆ PluginName()

"wxString const" pcbnew.PCB_PLUGIN.PluginName ( self )

PluginName(PCB_PLUGIN self) -> wxString

Reimplemented from pcbnew.PLUGIN.

Definition at line 5971 of file pcbnew.py.

◆ Save()

"void" pcbnew.PCB_PLUGIN.Save	(		self,
		"wxString"	aFileName,
		"BOARD"	aBoard,
		"PROPERTIES const *"	aProperties = `None`
	)

Save(PCB_PLUGIN self, wxString aFileName, BOARD aBoard, PROPERTIES const * aProperties=None)

Reimplemented from pcbnew.PLUGIN.

Definition at line 5979 of file pcbnew.py.

◆ SetOutputFormatter()

"void" pcbnew.PCB_PLUGIN.SetOutputFormatter	(		self,
		"OUTPUTFORMATTER"	aFormatter
	)

SetOutputFormatter(PCB_PLUGIN self, OUTPUTFORMATTER aFormatter)

Definition at line 6044 of file pcbnew.py.

Property Documentation

◆ thisown

pcbnew.PCB_PLUGIN.thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

static

Definition at line 5968 of file pcbnew.py.

The documentation for this class was generated from the following file:

pcbnew.py

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ DoLoad()

◆ FootprintDelete()

◆ FootprintEnumerate()

◆ FootprintExists()

◆ FootprintLibCreate()

◆ FootprintLibDelete()

◆ FootprintLoad()

◆ FootprintSave()

◆ Format()

◆ GetEnumeratedFootprint()

◆ GetFileExtension()

◆ GetLibraryTimestamp()

◆ GetStringOutput()

◆ IsFootprintLibWritable()

◆ Load()

◆ Parse()

◆ PluginName()

◆ Save()

◆ SetOutputFormatter()

Property Documentation

◆ thisown

◆ init()