pcbnew.PLUGIN Class Reference

Inheritance diagram for pcbnew.PLUGIN:

Public Member Functions
def	__init__ (self, *args, **kwargs)
def	PluginName (self)
def	GetFileExtension (self)
def	SetQueryUserCallback (self, aCallback)
def	Load (self, aFileName, aAppendToMe, aProperties=None, aProject=None, aProgressReporter=None)
def	GetImportedCachedLibraryFootprints (self)
def	Save (self, aFileName, aBoard, aProperties=None)
def	FootprintEnumerate (self, aFootprintNames, aLibraryPath, aBestEfforts, aProperties=None)
def	GetLibraryTimestamp (self, aLibraryPath)
def	PrefetchLib (self, aLibraryPath, aProperties=None)
def	FootprintLoad (self, aLibraryPath, aFootprintName, aKeepUUID=False, aProperties=None)
def	GetEnumeratedFootprint (self, aLibraryPath, aFootprintName, aProperties=None)
def	FootprintExists (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)

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

Detailed Description

Proxy of C++ PLUGIN class.

Definition at line 7796 of file pcbnew.py.

Constructor & Destructor Documentation

__init__()

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

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 7801 of file pcbnew.py.

Member Function Documentation

FootprintDelete()

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

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

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 7857 of file pcbnew.py.

FootprintEnumerate() [1/2]

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

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

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 7829 of file pcbnew.py.

FootprintEnumerate() [2/2]

def pcbnew.PLUGIN.FootprintEnumerate	(		self,
			libname
	)

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 7882 of file pcbnew.py.

FootprintExists()

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

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

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 7849 of file pcbnew.py.

FootprintLibCreate()

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

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

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 7861 of file pcbnew.py.

FootprintLibDelete()

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

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

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 7865 of file pcbnew.py.

FootprintLibOptions()

def pcbnew.PLUGIN.FootprintLibOptions	(		self,
			aListToAppendTo
	)

FootprintLibOptions(PLUGIN self, STRING_UTF8_MAP * aListToAppendTo)

Definition at line 7873 of file pcbnew.py.

FootprintLoad()

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

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

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 7841 of file pcbnew.py.

footprintPyEnumerate()

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

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

Definition at line 7878 of file pcbnew.py.

Here is the caller graph for this function:

FootprintSave()

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

FootprintSave(PLUGIN self, wxString aLibraryPath, FOOTPRINT aFootprint, STRING_UTF8_MAP const * aProperties=None)

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 7853 of file pcbnew.py.

GetEnumeratedFootprint()

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

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

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 7845 of file pcbnew.py.

GetFileExtension()

def pcbnew.PLUGIN.GetFileExtension

(

self

)

GetFileExtension(PLUGIN self) -> wxString

Definition at line 7809 of file pcbnew.py.

GetImportedCachedLibraryFootprints()

def pcbnew.PLUGIN.GetImportedCachedLibraryFootprints

(

self

)

GetImportedCachedLibraryFootprints(PLUGIN self) -> std::vector< FOOTPRINT *,std::allocator< FOOTPRINT * > >

Definition at line 7821 of file pcbnew.py.

GetLibraryTimestamp()

def pcbnew.PLUGIN.GetLibraryTimestamp	(		self,
			aLibraryPath
	)

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

Definition at line 7833 of file pcbnew.py.

IsFootprintLibWritable()

def pcbnew.PLUGIN.IsFootprintLibWritable	(		self,
			aLibraryPath
	)

IsFootprintLibWritable(PLUGIN self, wxString aLibraryPath) -> bool

Definition at line 7869 of file pcbnew.py.

Load()

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

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

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 7817 of file pcbnew.py.

PluginName()

def pcbnew.PLUGIN.PluginName

(

self

)

PluginName(PLUGIN self) -> wxString

Definition at line 7805 of file pcbnew.py.

PrefetchLib()

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

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

Definition at line 7837 of file pcbnew.py.

Save()

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

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

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 7825 of file pcbnew.py.

SetQueryUserCallback()

def pcbnew.PLUGIN.SetQueryUserCallback	(		self,
			aCallback
	)

SetQueryUserCallback(PLUGIN self, std::function< bool (wxString,int,wxString,wxString) > aCallback)

Definition at line 7813 of file pcbnew.py.

Property Documentation

thisown

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

static

Definition at line 7799 of file pcbnew.py.

---

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

• pcbnew.py