KiCAD pcbnew 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
[legend]

Classes

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 SetForceVisible (self, aEnable)
 
def GetMsgPanelInfo (self, 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)
 
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

 this
 

Static Public Attributes

 ret = self.last.Get()
 
 last
 

Detailed Description

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

Definition at line 8925 of file pcbnew.py.

Constructor & Destructor Documentation

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

Definition at line 9043 of file pcbnew.py.

Member Function Documentation

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

Definition at line 8943 of file pcbnew.py.

def pcbnew.BOARD_ITEM_List.__iter__ (   self)

Definition at line 9038 of file pcbnew.py.

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

Definition at line 9437 of file pcbnew.py.

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

Definition at line 8958 of file pcbnew.py.

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

Definition at line 9078 of file pcbnew.py.

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

Definition at line 8976 of file pcbnew.py.

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

Definition at line 9325 of file pcbnew.py.

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 9360 of file pcbnew.py.

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

Definition at line 9320 of file pcbnew.py.

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

Definition at line 9315 of file pcbnew.py.

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

Definition at line 9388 of file pcbnew.py.

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

Definition at line 9141 of file pcbnew.py.

def pcbnew.BOARD_ITEM_List.Draw (   self,
  args 
)
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 9103 of file pcbnew.py.

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

Definition at line 8981 of file pcbnew.py.

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

Definition at line 9167 of file pcbnew.py.

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

Definition at line 9205 of file pcbnew.py.

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

Definition at line 9195 of file pcbnew.py.

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

Definition at line 8938 of file pcbnew.py.

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

Definition at line 9175 of file pcbnew.py.

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

Definition at line 9383 of file pcbnew.py.

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

Definition at line 9058 of file pcbnew.py.

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

Definition at line 9403 of file pcbnew.py.

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

Definition at line 8948 of file pcbnew.py.

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

Definition at line 9368 of file pcbnew.py.

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

Definition at line 8953 of file pcbnew.py.

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

Definition at line 9088 of file pcbnew.py.

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

Definition at line 9180 of file pcbnew.py.

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

Definition at line 9093 of file pcbnew.py.

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

Definition at line 9235 of file pcbnew.py.

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

Definition at line 9413 of file pcbnew.py.

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

Definition at line 9378 of file pcbnew.py.

def pcbnew.BOARD_ITEM_List.GetParent (   self)
GetParent(BOARD_ITEM_List self) -> BOARD_ITEM_CONTAINER

Definition at line 9083 of file pcbnew.py.

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

Definition at line 9053 of file pcbnew.py.

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

Definition at line 9408 of file pcbnew.py.

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

Definition at line 9335 of file pcbnew.py.

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

Definition at line 9345 of file pcbnew.py.

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

Definition at line 9230 of file pcbnew.py.

def pcbnew.BOARD_ITEM_List.HitTest (   self,
  args 
)
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 9185 of file pcbnew.py.

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

Definition at line 8966 of file pcbnew.py.

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

Definition at line 9290 of file pcbnew.py.

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

Definition at line 9068 of file pcbnew.py.

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

Definition at line 9265 of file pcbnew.py.

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

Definition at line 9285 of file pcbnew.py.

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

Definition at line 9126 of file pcbnew.py.

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

Definition at line 9255 of file pcbnew.py.

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

Definition at line 9260 of file pcbnew.py.

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

Definition at line 9250 of file pcbnew.py.

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

Definition at line 9116 of file pcbnew.py.

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

Definition at line 9432 of file pcbnew.py.

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

Definition at line 9280 of file pcbnew.py.

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

Definition at line 9275 of file pcbnew.py.

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

Definition at line 9121 of file pcbnew.py.

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

Definition at line 9270 of file pcbnew.py.

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

Definition at line 9393 of file pcbnew.py.

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

Definition at line 9418 of file pcbnew.py.

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

Definition at line 9151 of file pcbnew.py.

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

Definition at line 9073 of file pcbnew.py.

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

Definition at line 8991 of file pcbnew.py.

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

Definition at line 8986 of file pcbnew.py.

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

Definition at line 9001 of file pcbnew.py.

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

Definition at line 8996 of file pcbnew.py.

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

Definition at line 8971 of file pcbnew.py.

def pcbnew.BOARD_ITEM_List.Replace (   self,
  args 
)
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 9423 of file pcbnew.py.

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

Definition at line 9159 of file pcbnew.py.

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

Definition at line 9310 of file pcbnew.py.

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

Definition at line 9355 of file pcbnew.py.

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

Definition at line 9373 of file pcbnew.py.

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

Definition at line 9305 of file pcbnew.py.

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

Definition at line 9098 of file pcbnew.py.

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

Definition at line 9245 of file pcbnew.py.

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

Definition at line 9131 of file pcbnew.py.

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

Definition at line 9330 of file pcbnew.py.

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

Definition at line 9240 of file pcbnew.py.

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

Definition at line 9063 of file pcbnew.py.

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

Definition at line 9300 of file pcbnew.py.

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

Definition at line 9340 of file pcbnew.py.

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

Definition at line 9350 of file pcbnew.py.

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

Definition at line 9225 of file pcbnew.py.

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

Definition at line 9295 of file pcbnew.py.

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

Definition at line 9146 of file pcbnew.py.

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

Definition at line 9442 of file pcbnew.py.

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

Definition at line 9111 of file pcbnew.py.

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

Definition at line 9215 of file pcbnew.py.

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

Definition at line 9220 of file pcbnew.py.

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

Definition at line 9136 of file pcbnew.py.

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

Definition at line 9447 of file pcbnew.py.

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

Definition at line 9210 of file pcbnew.py.

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

Definition at line 9398 of file pcbnew.py.

Member Data Documentation

pcbnew.BOARD_ITEM_List.last
static

Definition at line 9029 of file pcbnew.py.

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

Definition at line 9025 of file pcbnew.py.

pcbnew.BOARD_ITEM_List.this

Definition at line 9049 of file pcbnew.py.


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