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 FormatInternalUnits (self, args)
def FormatAngle (self, aAngle)
def ViewGetLayers (self, aLayers, aCount)
def TransformShapeWithClearanceToPolygon (self, aCornerBuffer, aClearanceValue, aCircleToSegmentsCount, aCorrectionFactor)
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 9624 of file

Constructor & Destructor Documentation

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

Definition at line 9742 of file

Member Function Documentation

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

Definition at line 9642 of file

def pcbnew.BOARD_ITEM_List.__iter__ (   self)

Definition at line 9737 of file

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

Definition at line 10141 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 9657 of file

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

Definition at line 9777 of file

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

Definition at line 9675 of file

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

Definition at line 10024 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 10059 of file

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

Definition at line 10019 of file

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

Definition at line 10014 of file

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

Definition at line 10092 of file

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

Definition at line 9840 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 9802 of file

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

Definition at line 9680 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 9866 of file

def pcbnew.BOARD_ITEM_List.FormatAngle (   self,
FormatAngle(BOARD_ITEM_List self, double aAngle) -> string

Definition at line 9904 of file

def pcbnew.BOARD_ITEM_List.FormatInternalUnits (   self,
FormatInternalUnits(BOARD_ITEM_List self, int aValue) -> string
FormatInternalUnits(BOARD_ITEM_List self, wxPoint aPoint) -> string
FormatInternalUnits(BOARD_ITEM_List self, VECTOR2I aPoint) -> string
FormatInternalUnits(BOARD_ITEM_List self, wxSize aSize) -> string

Definition at line 9894 of file

def pcbnew.BOARD_ITEM_List.Get (   self)

Definition at line 9637 of file

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

Definition at line 9874 of file

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

Definition at line 10087 of file

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

Definition at line 9757 of file

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

Definition at line 10107 of file

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

Definition at line 9647 of file

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

Definition at line 10067 of file

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

Definition at line 9652 of file

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

Definition at line 9787 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 9879 of file

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

Definition at line 9792 of file

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

Definition at line 9934 of file

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

Definition at line 10117 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 10082 of file

def pcbnew.BOARD_ITEM_List.GetParent (   self)

Definition at line 9782 of file

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

Definition at line 9752 of file

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

Definition at line 10112 of file

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

Definition at line 10034 of file

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

Definition at line 10044 of file

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

Definition at line 9929 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 9884 of file

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

Definition at line 9665 of file

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

Definition at line 9989 of file

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

Definition at line 9767 of file

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

Definition at line 9964 of file

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

Definition at line 9984 of file

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

Definition at line 9825 of file

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

Definition at line 9954 of file

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

Definition at line 9959 of file

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

Definition at line 9949 of file

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

Definition at line 9815 of file

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

Definition at line 10136 of file

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

Definition at line 9979 of file

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

Definition at line 9974 of file

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

Definition at line 9820 of file

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

Definition at line 10072 of file

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

Definition at line 9969 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 10097 of file

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

Definition at line 10122 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 9850 of file

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

Definition at line 9772 of file

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

Definition at line 9690 of file

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

Definition at line 9685 of file

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

Definition at line 9700 of file

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

Definition at line 9695 of file

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

Definition at line 9670 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 10127 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 9858 of file

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

Definition at line 10009 of file

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

Definition at line 10054 of file

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

Definition at line 10077 of file

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

Definition at line 10004 of file

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

Definition at line 9797 of file

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

Definition at line 9944 of file

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

Definition at line 9830 of file

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

Definition at line 10029 of file

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

Definition at line 9939 of file

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

Definition at line 9762 of file

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

Definition at line 9999 of file

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

Definition at line 10039 of file

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

Definition at line 10049 of file

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

Definition at line 9924 of file

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

Definition at line 9994 of file

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

Definition at line 9845 of file

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

Definition at line 10146 of file

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

Definition at line 9810 of file

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

Definition at line 9914 of file

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

Definition at line 9919 of file

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

Definition at line 9835 of file

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

Definition at line 10151 of file

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

Definition at line 9909 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 10102 of file

Member Data Documentation


Definition at line 9728 of file

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

Definition at line 9724 of file


Definition at line 9748 of file

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