pcbnew.BOARD_ITEM_CONTAINER Class Reference

Inheritance diagram for pcbnew.BOARD_ITEM_CONTAINER:

Public Member Functions
def	__init__ (self, *args, **kwargs)
def	AddNative (self, *args)
def	RemoveNative (self, *args)
def	DeleteNative (self, aItem)
def	GetZoneSettings (self)
def	SetZoneSettings (self, aSettings)
def	Add (self, item)
def	Remove (self, item)
def	Delete (self, item)
Public Member Functions inherited from pcbnew.BOARD_ITEM
def	__init__ (self, *args, **kwargs)
def	SetParentGroup (self, aGroup)
def	GetParentGroup (self)
def	GetX (self)
def	GetY (self)
def	GetCenter (self)
def	SetX (self, aX)
def	SetY (self, aY)
def	IsConnected (self)
def	IsOnCopperLayer (self)
def	HasHole (self)
def	IsTented (self)
def	GetEffectiveShape (self, *args)
def	GetEffectiveHoleShape (self)
def	GetParent (self)
def	GetParentFootprint (self)
def	HasLineStroke (self)
def	GetStroke (self)
def	SetStroke (self, aStroke)
def	GetLayer (self)
def	GetLayerSet (self)
def	SetLayerSet (self, aLayers)
def	SetLayer (self, aLayer)
def	Duplicate (self)
def	SwapItemData (self, aImage)
def	IsOnLayer (self, aLayer)
def	IsKnockout (self)
def	SetIsKnockout (self, aKnockout)
def	IsLocked (self)
def	SetLocked (self, aLocked)
def	DeleteStructure (self)
def	Move (self, aMoveVector)
def	Rotate (self, aRotCentre, aAngle)
def	Flip (self, aCentre, aFlipLeftRight)
def	GetBoard (self, *args)
def	GetLayerName (self)
def	TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
def	Cast (self)
def	Duplicate (self)
def	SetPos (self, p)
def	SetStartEnd (self, start, end)
Public Member Functions inherited from pcbnew.EDA_ITEM
def	__init__ (self, *args, **kwargs)
def	Type (self)
def	GetParent (self)
def	SetParent (self, aParent)
def	IsModified (self)
def	IsNew (self)
def	IsMoving (self)
def	IsSelected (self)
def	IsEntered (self)
def	IsBrightened (self)
def	IsRollover (self)
def	SetSelected (self)
def	SetBrightened (self)
def	ClearSelected (self)
def	ClearBrightened (self)
def	SetModified (self)
def	GetState (self, type)
def	SetState (self, type, state)
def	GetStatus (self)
def	SetStatus (self, aStatus)
def	SetFlags (self, aMask)
def	XorFlags (self, aMask)
def	ClearFlags (self, *args)
def	GetFlags (self)
def	HasFlag (self, aFlag)
def	GetEditFlags (self)
def	ClearTempFlags (self)
def	ClearEditFlags (self)
def	RenderAsBitmap (self, aWorldScale)
def	SetIsShownAsBitmap (self, aBitmap)
def	IsShownAsBitmap (self)
def	IsType (self, aScanTypes)
def	SetForceVisible (self, aEnable)
def	IsForceVisible (self)
def	GetMsgPanelInfo (self, aFrame, aList)
def	GetFriendlyName (self)
def	HitTest (self, *args)
def	GetBoundingBox (self)
def	GetPosition (self)
def	SetPosition (self, aPos)
def	GetFocusPosition (self)
def	GetSortPosition (self)
def	Clone (self)
def	Visit (self, inspector, testData, aScanTypes)
def	GetClass (self)
def	GetTypeDesc (self)
def	GetItemDescription (self, aUnitsProvider)
def	GetMenuImage (self)
def	Matches (self, aSearchData, aAuxData)
def	Replace (self, *args)
def	IsReplaceable (self)
def	__lt__ (self, aItem)
def	ViewBBox (self)
def	ViewGetLayers (self, aLayers, aCount)

Properties
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
Properties inherited from pcbnew.BOARD_ITEM
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
Properties inherited from pcbnew.EDA_ITEM
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
	m_Uuid = property(_pcbnew.EDA_ITEM_m_Uuid_get, doc=)

Additional Inherited Members
Static Public Member Functions inherited from pcbnew.EDA_ITEM
def	Sort (aLeft, aRight)

Detailed Description

Proxy of C++ BOARD_ITEM_CONTAINER class.

Definition at line 9897 of file pcbnew.py.

Constructor & Destructor Documentation

__init__()

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

Reimplemented from pcbnew.BOARD_ITEM.

Reimplemented in pcbnew.BOARD, pcbnew.FOOTPRINT, and pcbnew.BOARD.

Definition at line 9902 of file pcbnew.py.

Member Function Documentation

Add()

def pcbnew.BOARD_ITEM_CONTAINER.Add	(		self,
			item
	)

Add a BOARD_ITEM to this BOARD_ITEM_CONTAINER, clear the thisown to prevent
python from deleting the object in the garbage collector
Add(BOARD_ITEM_CONTAINER self, BOARD_ITEM aItem, BOARD_ADD_MODE aMode=BOARD_ADD_MODE::INSERT)
Add(BOARD_ITEM_CONTAINER self, BOARD_ITEM aItem)

Definition at line 9926 of file pcbnew.py.

Here is the caller graph for this function:

AddNative()

def pcbnew.BOARD_ITEM_CONTAINER.AddNative	(		self,
		*	args
	)

AddNative(BOARD_ITEM_CONTAINER self, BOARD_ITEM aItem, ADD_MODE aMode=INSERT, bool aSkipConnectivity=False)

Reimplemented in pcbnew.BOARD, and pcbnew.FOOTPRINT.

Definition at line 9906 of file pcbnew.py.

Here is the caller graph for this function:

Delete()

def pcbnew.BOARD_ITEM_CONTAINER.Delete	(		self,
			item
	)

Remove a BOARD_ITEM from this BOARD_ITEM_CONTAINER, set the thisdown flag so that
the python wrapper does not owns the C++ BOARD_ITEM
Delete(self, BOARD_ITEM)

Definition at line 9946 of file pcbnew.py.

Here is the caller graph for this function:

DeleteNative()

def pcbnew.BOARD_ITEM_CONTAINER.DeleteNative	(		self,
			aItem
	)

DeleteNative(BOARD_ITEM_CONTAINER self, BOARD_ITEM aItem)

Definition at line 9914 of file pcbnew.py.

Here is the caller graph for this function:

GetZoneSettings()

def pcbnew.BOARD_ITEM_CONTAINER.GetZoneSettings

(

self

)

GetZoneSettings(BOARD_ITEM_CONTAINER self) -> ZONE_SETTINGS

Definition at line 9918 of file pcbnew.py.

Remove()

def pcbnew.BOARD_ITEM_CONTAINER.Remove	(		self,
			item
	)

Remove a BOARD_ITEM from this BOARD_ITEM_CONTAINER, set the thisdown flag so that
the python wrapper owns the C++ BOARD_ITEM
Remove(self, BOARD_ITEM)

Definition at line 9936 of file pcbnew.py.

Here is the caller graph for this function:

RemoveNative()

def pcbnew.BOARD_ITEM_CONTAINER.RemoveNative	(		self,
		*	args
	)

RemoveNative(BOARD_ITEM_CONTAINER self, BOARD_ITEM aItem, REMOVE_MODE aMode=NORMAL)

Reimplemented in pcbnew.BOARD, and pcbnew.FOOTPRINT.

Definition at line 9910 of file pcbnew.py.

Here is the caller graph for this function:

SetZoneSettings()

def pcbnew.BOARD_ITEM_CONTAINER.SetZoneSettings	(		self,
			aSettings
	)

SetZoneSettings(BOARD_ITEM_CONTAINER self, ZONE_SETTINGS aSettings)

Definition at line 9922 of file pcbnew.py.

Property Documentation

thisown

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

static

Definition at line 9900 of file pcbnew.py.

---

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

• pcbnew.py