KiCad Pcbnew Python Scripting
Classes | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
pcbnew.BOARD_ITEM_List Class Reference
Inheritance diagram for pcbnew.BOARD_ITEM_List:
Inheritance graph


class  DLISTIter

Public Member Functions

def Get (self)
def __deref__ (self)
def GetFirst (self)
def GetLast (self)
def Append (self, args)
def Insert (self, aNewElement, aElementAfterMe)
def Remove (self, aElement)
def begin (self)
def end (self)
def PopFront (self)
def PopBack (self)
def PushFront (self, aNewElement)
def PushBack (self, aNewElement)
def __iter__ (self)
def __init__ (self)
def GetPosition (self)
def GetCenter (self)
def SetPosition (self, aPos)
def IsConnected (self)
def Next (self)
def Back (self)
def GetParent (self)
def GetLayer (self)
def GetLayerSet (self)
def SetLayer (self, aLayer)
def Draw (self, args)
def SwapData (self, aImage)
def IsOnLayer (self, aLayer)
def IsTrack (self)
def IsLocked (self)
def SetLocked (self, aLocked)
def UnLink (self)
def DeleteStructure (self)
def ShowShape (self, aShape)
def Move (self, args)
def Rotate (self, args)
def Flip (self, args)
def GetBoard (self)
def GetLayerName (self)
def HitTest (self, args)
def ViewGetLayers (self, aLayers, aCount)
def TransformShapeWithClearanceToPolygon (self, aCornerBuffer, aClearanceValue, aCircleToSegmentsCount, aCorrectionFactor, ignoreLineWidth=False)
def Type (self)
def SetTimeStamp (self, aNewTimeStamp)
def GetTimeStamp (self)
def GetList (self)
def SetParent (self, aParent)
def SetList (self, aList)
def IsNew (self)
def IsModified (self)
def IsMoving (self)
def IsDragging (self)
def IsWireImage (self)
def IsSelected (self)
def IsResized (self)
def IsHighlighted (self)
def IsBrightened (self)
def SetWireImage (self)
def SetSelected (self)
def SetHighlighted (self)
def SetBrightened (self)
def ClearSelected (self)
def ClearHighlighted (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 ClearFlags (self, aMask=-1)
def GetFlags (self)
def IsType (self, aScanTypes)
def SetForceVisible (self, aEnable)
def GetMsgPanelInfo (self, aUnits, aList)
def GetBoundingBox (self)
def Clone (self)
def IterateForward (self, listStart, inspector, testData, scanTypes)
def Visit (self, inspector, testData, scanTypes)
def GetClass (self)
def GetSelectMenuText (self, aUnits)
def GetMenuImage (self)
def Matches (self, aSearchData, aAuxData, aFindLocation)
def Replace (self, args)
def IsReplaceable (self)
def __lt__ (self, aItem)
def Sort (self, aLeft, aRight)
def ViewBBox (self)
- Public Member Functions inherited from pcbnew.DHEAD
def __init__ (self, args, kwargs)
def DeleteAll (self)
def SetOwnership (self, Iown)
def GetCount (self)

Public Attributes


Static Public Attributes

 ret = self.last.Get()

Detailed Description

Proxy of C++ DLIST<(BOARD_ITEM)> class.

Definition at line 9315 of file

Constructor & Destructor Documentation

def pcbnew.BOARD_ITEM_List.__init__ (   self)
__init__(DLIST<(BOARD_ITEM)> self) -> BOARD_ITEM_List

Definition at line 9436 of file

Member Function Documentation

def pcbnew.BOARD_ITEM_List.__deref__ (   self)
__deref__(BOARD_ITEM_List self) -> BOARD_ITEM

Definition at line 9333 of file

def pcbnew.BOARD_ITEM_List.__iter__ (   self)

Definition at line 9431 of file

def pcbnew.BOARD_ITEM_List.__lt__ (   self,
__lt__(BOARD_ITEM_List self, EDA_ITEM aItem) -> bool

Definition at line 9823 of file

def pcbnew.BOARD_ITEM_List.Append (   self,
Append(BOARD_ITEM_List self, BOARD_ITEM aNewElement)
Append(BOARD_ITEM_List self, BOARD_ITEM_List aList)

Definition at line 9348 of file

def pcbnew.BOARD_ITEM_List.Back (   self)
Back(BOARD_ITEM_List self) -> BOARD_ITEM

Definition at line 9471 of file

def pcbnew.BOARD_ITEM_List.begin (   self)
begin(BOARD_ITEM_List self) -> BOARD_ITEM

Definition at line 9366 of file

def pcbnew.BOARD_ITEM_List.ClearBrightened (   self)
ClearBrightened(BOARD_ITEM_List self)

Definition at line 9706 of file

def pcbnew.BOARD_ITEM_List.ClearFlags (   self,
  aMask = -1 
ClearFlags(BOARD_ITEM_List self, STATUS_FLAGS aMask=-1)
ClearFlags(BOARD_ITEM_List self)

Definition at line 9741 of file

def pcbnew.BOARD_ITEM_List.ClearHighlighted (   self)
ClearHighlighted(BOARD_ITEM_List self)

Definition at line 9701 of file

def pcbnew.BOARD_ITEM_List.ClearSelected (   self)
ClearSelected(BOARD_ITEM_List self)

Definition at line 9696 of file

def pcbnew.BOARD_ITEM_List.Clone (   self)
Clone(BOARD_ITEM_List self) -> EDA_ITEM

Definition at line 9774 of file

def pcbnew.BOARD_ITEM_List.DeleteStructure (   self)
DeleteStructure(BOARD_ITEM_List self)

Definition at line 9534 of file

def pcbnew.BOARD_ITEM_List.Draw (   self,
Draw(BOARD_ITEM_List self, EDA_DRAW_PANEL * panel, wxDC * DC, GR_DRAWMODE aDrawMode, wxPoint offset)
Draw(BOARD_ITEM_List self, EDA_DRAW_PANEL * panel, wxDC * DC, GR_DRAWMODE aDrawMode)

Definition at line 9496 of file

def pcbnew.BOARD_ITEM_List.end (   self)
end(BOARD_ITEM_List self) -> BOARD_ITEM

Definition at line 9371 of file

def pcbnew.BOARD_ITEM_List.Flip (   self,
Flip(BOARD_ITEM_List self, wxPoint aCentre)
Flip(BOARD_ITEM_List self, VECTOR2I aCentre)

Definition at line 9560 of file

def pcbnew.BOARD_ITEM_List.Get (   self)

Definition at line 9328 of file

def pcbnew.BOARD_ITEM_List.GetBoard (   self)
GetBoard(BOARD_ITEM_List self) -> BOARD

Definition at line 9568 of file

def pcbnew.BOARD_ITEM_List.GetBoundingBox (   self)
GetBoundingBox(BOARD_ITEM_List self) -> EDA_RECT

Definition at line 9769 of file

def pcbnew.BOARD_ITEM_List.GetCenter (   self)
GetCenter(BOARD_ITEM_List self) -> wxPoint

Definition at line 9451 of file

def pcbnew.BOARD_ITEM_List.GetClass (   self)
GetClass(BOARD_ITEM_List self) -> wxString

Definition at line 9789 of file

def pcbnew.BOARD_ITEM_List.GetFirst (   self)
GetFirst(BOARD_ITEM_List self) -> BOARD_ITEM

Definition at line 9338 of file

def pcbnew.BOARD_ITEM_List.GetFlags (   self)
GetFlags(BOARD_ITEM_List self) -> STATUS_FLAGS

Definition at line 9749 of file

def pcbnew.BOARD_ITEM_List.GetLast (   self)
GetLast(BOARD_ITEM_List self) -> BOARD_ITEM

Definition at line 9343 of file

def pcbnew.BOARD_ITEM_List.GetLayer (   self)
GetLayer(BOARD_ITEM_List self) -> PCB_LAYER_ID

Definition at line 9481 of file

Here is the caller graph for this function:

def pcbnew.BOARD_ITEM_List.GetLayerName (   self)
GetLayerName(BOARD_ITEM_List self) -> wxString

Definition at line 9573 of file

def pcbnew.BOARD_ITEM_List.GetLayerSet (   self)
GetLayerSet(BOARD_ITEM_List self) -> LSET

Definition at line 9486 of file

def pcbnew.BOARD_ITEM_List.GetList (   self)
GetList(BOARD_ITEM_List self) -> DHEAD

Definition at line 9616 of file

def pcbnew.BOARD_ITEM_List.GetMenuImage (   self)
GetMenuImage(BOARD_ITEM_List self) -> BITMAP_DEF

Definition at line 9799 of file

def pcbnew.BOARD_ITEM_List.GetMsgPanelInfo (   self,
GetMsgPanelInfo(BOARD_ITEM_List self, EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > & aList)

Definition at line 9764 of file

def pcbnew.BOARD_ITEM_List.GetParent (   self)

Definition at line 9476 of file

def pcbnew.BOARD_ITEM_List.GetPosition (   self)
GetPosition(BOARD_ITEM_List self) -> wxPoint

Definition at line 9446 of file

def pcbnew.BOARD_ITEM_List.GetSelectMenuText (   self,
GetSelectMenuText(BOARD_ITEM_List self, EDA_UNITS_T aUnits) -> wxString

Definition at line 9794 of file

def pcbnew.BOARD_ITEM_List.GetState (   self,
GetState(BOARD_ITEM_List self, int type) -> int

Definition at line 9716 of file

def pcbnew.BOARD_ITEM_List.GetStatus (   self)
GetStatus(BOARD_ITEM_List self) -> STATUS_FLAGS

Definition at line 9726 of file

def pcbnew.BOARD_ITEM_List.GetTimeStamp (   self)
GetTimeStamp(BOARD_ITEM_List self) -> timestamp_t

Definition at line 9611 of file

def pcbnew.BOARD_ITEM_List.HitTest (   self,
HitTest(BOARD_ITEM_List self, wxPoint aPosition) -> bool
HitTest(BOARD_ITEM_List self, EDA_RECT aRect, bool aContained=True, int aAccuracy=0) -> bool
HitTest(BOARD_ITEM_List self, EDA_RECT aRect, bool aContained=True) -> bool
HitTest(BOARD_ITEM_List self, EDA_RECT aRect) -> bool

Definition at line 9578 of file

def pcbnew.BOARD_ITEM_List.Insert (   self,
Insert(BOARD_ITEM_List self, BOARD_ITEM aNewElement, BOARD_ITEM aElementAfterMe)

Definition at line 9356 of file

def pcbnew.BOARD_ITEM_List.IsBrightened (   self)
IsBrightened(BOARD_ITEM_List self) -> bool

Definition at line 9671 of file

def pcbnew.BOARD_ITEM_List.IsConnected (   self)
IsConnected(BOARD_ITEM_List self) -> bool

Definition at line 9461 of file

def pcbnew.BOARD_ITEM_List.IsDragging (   self)
IsDragging(BOARD_ITEM_List self) -> bool

Definition at line 9646 of file

def pcbnew.BOARD_ITEM_List.IsHighlighted (   self)
IsHighlighted(BOARD_ITEM_List self) -> bool

Definition at line 9666 of file

def pcbnew.BOARD_ITEM_List.IsLocked (   self)
IsLocked(BOARD_ITEM_List self) -> bool

Definition at line 9519 of file

def pcbnew.BOARD_ITEM_List.IsModified (   self)
IsModified(BOARD_ITEM_List self) -> bool

Definition at line 9636 of file

def pcbnew.BOARD_ITEM_List.IsMoving (   self)
IsMoving(BOARD_ITEM_List self) -> bool

Definition at line 9641 of file

def pcbnew.BOARD_ITEM_List.IsNew (   self)
IsNew(BOARD_ITEM_List self) -> bool

Definition at line 9631 of file

def pcbnew.BOARD_ITEM_List.IsOnLayer (   self,
IsOnLayer(BOARD_ITEM_List self, PCB_LAYER_ID aLayer) -> bool

Definition at line 9509 of file

def pcbnew.BOARD_ITEM_List.IsReplaceable (   self)
IsReplaceable(BOARD_ITEM_List self) -> bool

Definition at line 9818 of file

def pcbnew.BOARD_ITEM_List.IsResized (   self)
IsResized(BOARD_ITEM_List self) -> bool

Definition at line 9661 of file

def pcbnew.BOARD_ITEM_List.IsSelected (   self)
IsSelected(BOARD_ITEM_List self) -> bool

Definition at line 9656 of file

def pcbnew.BOARD_ITEM_List.IsTrack (   self)
IsTrack(BOARD_ITEM_List self) -> bool

Definition at line 9514 of file

def pcbnew.BOARD_ITEM_List.IsType (   self,
IsType(BOARD_ITEM_List self, KICAD_T const [] aScanTypes) -> bool

Definition at line 9754 of file

def pcbnew.BOARD_ITEM_List.IsWireImage (   self)
IsWireImage(BOARD_ITEM_List self) -> bool

Definition at line 9651 of file

def pcbnew.BOARD_ITEM_List.IterateForward (   self,
IterateForward(BOARD_ITEM_List self, EDA_ITEM listStart, INSPECTOR inspector, void * testData, KICAD_T const [] scanTypes) -> SEARCH_RESULT

Definition at line 9779 of file

def pcbnew.BOARD_ITEM_List.Matches (   self,
Matches(BOARD_ITEM_List self, wxFindReplaceData & aSearchData, void * aAuxData, wxPoint aFindLocation) -> bool

Definition at line 9804 of file

def pcbnew.BOARD_ITEM_List.Move (   self,
Move(BOARD_ITEM_List self, wxPoint aMoveVector)
Move(BOARD_ITEM_List self, VECTOR2I aMoveVector)

Definition at line 9544 of file

def pcbnew.BOARD_ITEM_List.Next (   self)
Next(BOARD_ITEM_List self) -> BOARD_ITEM

Definition at line 9466 of file

def pcbnew.BOARD_ITEM_List.PopBack (   self)
PopBack(BOARD_ITEM_List self) -> BOARD_ITEM

Definition at line 9381 of file

def pcbnew.BOARD_ITEM_List.PopFront (   self)
PopFront(BOARD_ITEM_List self) -> BOARD_ITEM

Definition at line 9376 of file

def pcbnew.BOARD_ITEM_List.PushBack (   self,
PushBack(BOARD_ITEM_List self, BOARD_ITEM aNewElement)

Definition at line 9391 of file

def pcbnew.BOARD_ITEM_List.PushFront (   self,
PushFront(BOARD_ITEM_List self, BOARD_ITEM aNewElement)

Definition at line 9386 of file

def pcbnew.BOARD_ITEM_List.Remove (   self,
Remove(BOARD_ITEM_List self, BOARD_ITEM aElement) -> BOARD_ITEM

Definition at line 9361 of file

def pcbnew.BOARD_ITEM_List.Replace (   self,
Replace(BOARD_ITEM_List self, wxFindReplaceData & aSearchData, wxString aText) -> bool
Replace(BOARD_ITEM_List self, wxFindReplaceData & aSearchData, void * aAuxData=None) -> bool
Replace(BOARD_ITEM_List self, wxFindReplaceData & aSearchData) -> bool

Definition at line 9809 of file

def pcbnew.BOARD_ITEM_List.Rotate (   self,
Rotate(BOARD_ITEM_List self, wxPoint aRotCentre, double aAngle)
Rotate(BOARD_ITEM_List self, VECTOR2I aRotCentre, double aAngle)

Definition at line 9552 of file

def pcbnew.BOARD_ITEM_List.SetBrightened (   self)
SetBrightened(BOARD_ITEM_List self)

Definition at line 9691 of file

def pcbnew.BOARD_ITEM_List.SetFlags (   self,
SetFlags(BOARD_ITEM_List self, STATUS_FLAGS aMask)

Definition at line 9736 of file

def pcbnew.BOARD_ITEM_List.SetForceVisible (   self,
SetForceVisible(BOARD_ITEM_List self, bool aEnable)

Definition at line 9759 of file

def pcbnew.BOARD_ITEM_List.SetHighlighted (   self)
SetHighlighted(BOARD_ITEM_List self)

Definition at line 9686 of file

def pcbnew.BOARD_ITEM_List.SetLayer (   self,
SetLayer(BOARD_ITEM_List self, PCB_LAYER_ID aLayer)

Definition at line 9491 of file

def pcbnew.BOARD_ITEM_List.SetList (   self,
SetList(BOARD_ITEM_List self, DHEAD aList)

Definition at line 9626 of file

def pcbnew.BOARD_ITEM_List.SetLocked (   self,
SetLocked(BOARD_ITEM_List self, bool aLocked)

Definition at line 9524 of file

def pcbnew.BOARD_ITEM_List.SetModified (   self)
SetModified(BOARD_ITEM_List self)

Definition at line 9711 of file

def pcbnew.BOARD_ITEM_List.SetParent (   self,
SetParent(BOARD_ITEM_List self, EDA_ITEM aParent)

Definition at line 9621 of file

def pcbnew.BOARD_ITEM_List.SetPosition (   self,
SetPosition(BOARD_ITEM_List self, wxPoint aPos)

Definition at line 9456 of file

def pcbnew.BOARD_ITEM_List.SetSelected (   self)
SetSelected(BOARD_ITEM_List self)

Definition at line 9681 of file

def pcbnew.BOARD_ITEM_List.SetState (   self,
SetState(BOARD_ITEM_List self, int type, int state)

Definition at line 9721 of file

def pcbnew.BOARD_ITEM_List.SetStatus (   self,
SetStatus(BOARD_ITEM_List self, STATUS_FLAGS aStatus)

Definition at line 9731 of file

def pcbnew.BOARD_ITEM_List.SetTimeStamp (   self,
SetTimeStamp(BOARD_ITEM_List self, timestamp_t aNewTimeStamp)

Definition at line 9606 of file

def pcbnew.BOARD_ITEM_List.SetWireImage (   self)
SetWireImage(BOARD_ITEM_List self)

Definition at line 9676 of file

def pcbnew.BOARD_ITEM_List.ShowShape (   self,
ShowShape(BOARD_ITEM_List self, STROKE_T aShape) -> wxString

Definition at line 9539 of file

def pcbnew.BOARD_ITEM_List.Sort (   self,
Sort(BOARD_ITEM_List self, EDA_ITEM aLeft, EDA_ITEM aRight) -> bool

Definition at line 9828 of file

def pcbnew.BOARD_ITEM_List.SwapData (   self,
SwapData(BOARD_ITEM_List self, BOARD_ITEM aImage)

Definition at line 9504 of file

def pcbnew.BOARD_ITEM_List.TransformShapeWithClearanceToPolygon (   self,
  ignoreLineWidth = False 
TransformShapeWithClearanceToPolygon(BOARD_ITEM_List self, SHAPE_POLY_SET aCornerBuffer, int aClearanceValue, int aCircleToSegmentsCount, double aCorrectionFactor, bool ignoreLineWidth=False)
TransformShapeWithClearanceToPolygon(BOARD_ITEM_List self, SHAPE_POLY_SET aCornerBuffer, int aClearanceValue, int aCircleToSegmentsCount, double aCorrectionFactor)

Definition at line 9593 of file

def pcbnew.BOARD_ITEM_List.Type (   self)
Type(BOARD_ITEM_List self) -> KICAD_T

Definition at line 9601 of file

def pcbnew.BOARD_ITEM_List.UnLink (   self)
UnLink(BOARD_ITEM_List self)

Definition at line 9529 of file

def pcbnew.BOARD_ITEM_List.ViewBBox (   self)
ViewBBox(BOARD_ITEM_List self) -> BOX2I const

Definition at line 9833 of file

def pcbnew.BOARD_ITEM_List.ViewGetLayers (   self,
ViewGetLayers(BOARD_ITEM_List self, int [] aLayers, int & aCount)

Definition at line 9588 of file

def pcbnew.BOARD_ITEM_List.Visit (   self,
Visit(BOARD_ITEM_List self, INSPECTOR inspector, void * testData, KICAD_T const [] scanTypes) -> SEARCH_RESULT

Definition at line 9784 of file

Member Data Documentation


Definition at line 9422 of file

pcbnew.BOARD_ITEM_List.ret = self.last.Get()

Definition at line 9418 of file


Definition at line 9442 of file

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