pcbnew.BOARD_ITEM_CONTAINER Class Reference

Inheritance diagram for pcbnew.BOARD_ITEM_CONTAINER:

Public Member Functions
def	__init__ (self, *args, **kwargs)
"void"	AddNative (self, *args)
"void"	RemoveNative (self, *args)
"void"	DeleteNative (self, "BOARD_ITEM" aItem)
"ZONE_SETTINGS const &"	GetZoneSettings (self)
"void"	SetZoneSettings (self, "ZONE_SETTINGS" 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)
"void"	SetParentGroup (self, "PCB_GROUP" aGroup)
"PCB_GROUP *"	GetParentGroup (self)
"int"	GetX (self)
"int"	GetY (self)
"wxPoint"	GetCenter (self)
"void"	SetX (self, "int" aX)
"void"	SetY (self, "int" aY)
"bool"	IsConnected (self)
"bool"	IsOnCopperLayer (self)
"std::shared_ptr< SHAPE >"	GetEffectiveShape (self, *args)
"BOARD_ITEM_CONTAINER *"	GetParent (self)
"BOARD_ITEM_CONTAINER *"	GetParentFootprint (self)
"PCB_LAYER_ID"	GetLayer (self)
"LSET"	GetLayerSet (self)
"void"	SetLayerSet (self, "LSET" aLayers)
"void"	SetLayer (self, "PCB_LAYER_ID" aLayer)
"BOARD_ITEM *"	Duplicate (self)
"void"	SwapData (self, "BOARD_ITEM" aImage)
"bool"	IsOnLayer (self, "PCB_LAYER_ID" aLayer)
"bool"	IsTrack (self)
"bool"	IsLocked (self)
"void"	SetLocked (self, "bool" aLocked)
"void"	DeleteStructure (self)
"void"	Move (self, *args)
"void"	Rotate (self, *args)
"void"	Flip (self, *args)
"BOARD *"	GetBoard (self, *args)
"wxString"	GetLayerName (self)
"void"	ViewGetLayers (self, "int []" aLayers, "int &" aCount)
"void"	TransformShapeWithClearanceToPolygon (self, "SHAPE_POLY_SET" aCornerBuffer, "PCB_LAYER_ID" aLayer, "int" aClearanceValue, "int" aError, "ERROR_LOC" aErrorLoc, "bool" 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)
"KICAD_T"	Type (self)
"EDA_ITEM *"	GetParent (self)
"void"	SetParent (self, "EDA_ITEM" aParent)
"bool"	IsModified (self)
"bool"	IsNew (self)
"bool"	IsMoving (self)
"bool"	IsDragging (self)
"bool"	IsWireImage (self)
"bool"	IsSelected (self)
"bool"	IsEntered (self)
"bool"	IsResized (self)
"bool"	IsBrightened (self)
"void"	SetWireImage (self)
"void"	SetSelected (self)
"void"	SetBrightened (self)
"void"	ClearSelected (self)
"void"	ClearBrightened (self)
"void"	SetModified (self)
"int"	GetState (self, "EDA_ITEM_FLAGS" type)
"void"	SetState (self, "EDA_ITEM_FLAGS" type, "bool" state)
"EDA_ITEM_FLAGS"	GetStatus (self)
"void"	SetStatus (self, "EDA_ITEM_FLAGS" aStatus)
"void"	SetFlags (self, "EDA_ITEM_FLAGS" aMask)
"void"	ClearFlags (self, *args)
"EDA_ITEM_FLAGS"	GetFlags (self)
"bool"	HasFlag (self, "EDA_ITEM_FLAGS" aFlag)
"EDA_ITEM_FLAGS"	GetEditFlags (self)
"void"	ClearTempFlags (self)
"void"	ClearEditFlags (self)
"bool"	IsType (self, "KICAD_T const []" aScanTypes)
"void"	SetForceVisible (self, "bool" aEnable)
"bool"	IsForceVisible (self)
"void"	GetMsgPanelInfo (self, "EDA_DRAW_FRAME *" aFrame, "std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &" aList)
"bool"	HitTest (self, *args)
"EDA_RECT const"	GetBoundingBox (self)
"wxPoint"	GetPosition (self)
"void"	SetPosition (self, "wxPoint" aPos)
"wxPoint const"	GetFocusPosition (self)
"EDA_ITEM *"	Clone (self)
"SEARCH_RESULT"	Visit (self, "INSPECTOR" inspector, "void *" testData, "KICAD_T const []" scanTypes)
"wxString"	GetClass (self)
"wxString"	GetSelectMenuText (self, "EDA_UNITS" aUnits)
"BITMAPS"	GetMenuImage (self)
"bool"	Matches (self, "wxFindReplaceData const &" aSearchData, "void *" aAuxData)
"bool"	Replace (self, *args)
"bool"	IsReplaceable (self)
"bool"	__lt__ (self, "EDA_ITEM" aItem)
"BOX2I const"	ViewBBox (self)
"void"	ViewGetLayers (self, "int []" aLayers, "int &" 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
"bool"	Sort ("EDA_ITEM" aLeft, "EDA_ITEM" aRight)

Detailed Description

Proxy of C++ BOARD_ITEM_CONTAINER class.

Definition at line 8582 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 8587 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 8611 of file pcbnew.py.

Here is the caller graph for this function:

AddNative()

"void" pcbnew.BOARD_ITEM_CONTAINER.AddNative	(		self,
		*	args
	)

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

Reimplemented in pcbnew.BOARD, and pcbnew.FOOTPRINT.

Definition at line 8591 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 8631 of file pcbnew.py.

Here is the caller graph for this function:

DeleteNative()

"void" pcbnew.BOARD_ITEM_CONTAINER.DeleteNative	(		self,
		"BOARD_ITEM"	aItem
	)

DeleteNative(BOARD_ITEM_CONTAINER self, BOARD_ITEM aItem)

Definition at line 8599 of file pcbnew.py.

Here is the caller graph for this function:

GetZoneSettings()

"ZONE_SETTINGS const &" pcbnew.BOARD_ITEM_CONTAINER.GetZoneSettings

(

self

)

GetZoneSettings(BOARD_ITEM_CONTAINER self) -> ZONE_SETTINGS

Reimplemented in pcbnew.BOARD.

Definition at line 8603 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 8621 of file pcbnew.py.

Here is the caller graph for this function:

RemoveNative()

"void" 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 8595 of file pcbnew.py.

Here is the caller graph for this function:

SetZoneSettings()

"void" pcbnew.BOARD_ITEM_CONTAINER.SetZoneSettings	(		self,
		"ZONE_SETTINGS"	aSettings
	)

SetZoneSettings(BOARD_ITEM_CONTAINER self, ZONE_SETTINGS aSettings)

Reimplemented in pcbnew.BOARD.

Definition at line 8607 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 8585 of file pcbnew.py.

---

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

• pcbnew.py