pcbnew.PLUGIN Class Reference

Inheritance diagram for pcbnew.PLUGIN:

Public Member Functions
def	__init__ (self, args, kwargs)
def	PluginName (self)
def	GetFileExtension (self)
def	Load (self, aFileName, aAppendToMe, aProperties=None)
def	Save (self, aFileName, aBoard, aProperties=None)
def	FootprintEnumerate (self, aFootprintNames, aLibraryPath, aProperties=None)
def	GetLibraryTimestamp (self, aLibraryPath)
def	PrefetchLib (self, aLibraryPath, aProperties=None)
def	FootprintLoad (self, aLibraryPath, aFootprintName, aProperties=None)
def	LoadEnumeratedFootprint (self, aLibraryPath, aFootprintName, aProperties=None)
def	FootprintSave (self, aLibraryPath, aFootprint, aProperties=None)
def	FootprintDelete (self, aLibraryPath, aFootprintName, aProperties=None)
def	FootprintLibCreate (self, aLibraryPath, aProperties=None)
def	FootprintLibDelete (self, aLibraryPath, aProperties=None)
def	IsFootprintLibWritable (self, aLibraryPath)
def	FootprintLibOptions (self, aListToAppendTo)
def	footprintPyEnumerate (self, aLibraryPath, aExitOnError)
def	FootprintEnumerate (self, libname)

Detailed Description

Proxy of C++ PLUGIN class.

Definition at line 5566 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.PLUGIN.__init__	(		self,
			args,
			kwargs
	)

Definition at line 5574 of file pcbnew.py.

Member Function Documentation

def pcbnew.PLUGIN.FootprintDelete	(		self,
			aLibraryPath,
			aFootprintName,
			aProperties = None
	)

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

Definition at line 5649 of file pcbnew.py.

def pcbnew.PLUGIN.FootprintEnumerate	(		self,
			aFootprintNames,
			aLibraryPath,
			aProperties = None
	)

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

Definition at line 5604 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.PLUGIN.FootprintEnumerate	(		self,
			libname
	)

Definition at line 5690 of file pcbnew.py.

def pcbnew.PLUGIN.FootprintLibCreate	(		self,
			aLibraryPath,
			aProperties = None
	)

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

Definition at line 5657 of file pcbnew.py.

def pcbnew.PLUGIN.FootprintLibDelete	(		self,
			aLibraryPath,
			aProperties = None
	)

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

Definition at line 5665 of file pcbnew.py.

def pcbnew.PLUGIN.FootprintLibOptions	(		self,
			aListToAppendTo
	)

FootprintLibOptions(PLUGIN self, PROPERTIES * aListToAppendTo)

Definition at line 5678 of file pcbnew.py.

def pcbnew.PLUGIN.FootprintLoad	(		self,
			aLibraryPath,
			aFootprintName,
			aProperties = None
	)

FootprintLoad(PLUGIN self, wxString aLibraryPath, wxString aFootprintName, PROPERTIES const * aProperties=None) -> MODULE
FootprintLoad(PLUGIN self, wxString aLibraryPath, wxString aFootprintName) -> MODULE

Definition at line 5625 of file pcbnew.py.

def pcbnew.PLUGIN.footprintPyEnumerate	(		self,
			aLibraryPath,
			aExitOnError
	)

footprintPyEnumerate(PLUGIN self, wxString aLibraryPath, bool aExitOnError) -> wxArrayString

Definition at line 5685 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.PLUGIN.FootprintSave	(		self,
			aLibraryPath,
			aFootprint,
			aProperties = None
	)

FootprintSave(PLUGIN self, wxString aLibraryPath, MODULE aFootprint, PROPERTIES const * aProperties=None)
FootprintSave(PLUGIN self, wxString aLibraryPath, MODULE aFootprint)

Definition at line 5641 of file pcbnew.py.

def pcbnew.PLUGIN.GetFileExtension

(

self

)

GetFileExtension(PLUGIN self) -> wxString

Definition at line 5583 of file pcbnew.py.

def pcbnew.PLUGIN.GetLibraryTimestamp	(		self,
			aLibraryPath
	)

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

Definition at line 5612 of file pcbnew.py.

def pcbnew.PLUGIN.IsFootprintLibWritable	(		self,
			aLibraryPath
	)

IsFootprintLibWritable(PLUGIN self, wxString aLibraryPath) -> bool

Definition at line 5673 of file pcbnew.py.

def pcbnew.PLUGIN.Load	(		self,
			aFileName,
			aAppendToMe,
			aProperties = None
	)

Load(PLUGIN self, wxString aFileName, BOARD aAppendToMe, PROPERTIES const * aProperties=None) -> BOARD
Load(PLUGIN self, wxString aFileName, BOARD aAppendToMe) -> BOARD

Definition at line 5588 of file pcbnew.py.

def pcbnew.PLUGIN.LoadEnumeratedFootprint	(		self,
			aLibraryPath,
			aFootprintName,
			aProperties = None
	)

LoadEnumeratedFootprint(PLUGIN self, wxString aLibraryPath, wxString aFootprintName, PROPERTIES const * aProperties=None) -> MODULE
LoadEnumeratedFootprint(PLUGIN self, wxString aLibraryPath, wxString aFootprintName) -> MODULE

Definition at line 5633 of file pcbnew.py.

def pcbnew.PLUGIN.PluginName

(

self

)

PluginName(PLUGIN self) -> wxString

Definition at line 5578 of file pcbnew.py.

def pcbnew.PLUGIN.PrefetchLib	(		self,
			aLibraryPath,
			aProperties = None
	)

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

Definition at line 5617 of file pcbnew.py.

def pcbnew.PLUGIN.Save	(		self,
			aFileName,
			aBoard,
			aProperties = None
	)

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

Definition at line 5596 of file pcbnew.py.

---

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

• pcbnew.py