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
[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, 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

 this
 

Static Public Attributes

 ret = self.last.Get()
 
 last
 

Detailed Description

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

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

Member Function Documentation

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

Definition at line 8974 of file pcbnew.py.

def pcbnew.BOARD_ITEM_List.__iter__ (   self)

Definition at line 9069 of file pcbnew.py.

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

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

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

Definition at line 9109 of file pcbnew.py.

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

Definition at line 9007 of file pcbnew.py.

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

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

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

Definition at line 9351 of file pcbnew.py.

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

Definition at line 9346 of file pcbnew.py.

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

Definition at line 9419 of file pcbnew.py.

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

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

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

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

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

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

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

Definition at line 8969 of file pcbnew.py.

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

Definition at line 9206 of file pcbnew.py.

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

Definition at line 9414 of file pcbnew.py.

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

Definition at line 9089 of file pcbnew.py.

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

Definition at line 9434 of file pcbnew.py.

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

Definition at line 8979 of file pcbnew.py.

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

Definition at line 9399 of file pcbnew.py.

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

Definition at line 8984 of file pcbnew.py.

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

Definition at line 9119 of file pcbnew.py.

Here is the caller graph for this function:

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

Definition at line 9211 of file pcbnew.py.

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

Definition at line 9124 of file pcbnew.py.

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

Definition at line 9266 of file pcbnew.py.

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

Definition at line 9444 of file pcbnew.py.

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

Definition at line 9409 of file pcbnew.py.

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

Definition at line 9114 of file pcbnew.py.

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

Definition at line 9084 of file pcbnew.py.

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

Definition at line 9439 of file pcbnew.py.

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

Definition at line 9366 of file pcbnew.py.

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

Definition at line 9376 of file pcbnew.py.

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

Definition at line 9261 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 9216 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 8997 of file pcbnew.py.

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

Definition at line 9321 of file pcbnew.py.

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

Definition at line 9099 of file pcbnew.py.

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

Definition at line 9296 of file pcbnew.py.

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

Definition at line 9316 of file pcbnew.py.

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

Definition at line 9157 of file pcbnew.py.

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

Definition at line 9286 of file pcbnew.py.

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

Definition at line 9291 of file pcbnew.py.

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

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

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

Definition at line 9463 of file pcbnew.py.

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

Definition at line 9311 of file pcbnew.py.

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

Definition at line 9306 of file pcbnew.py.

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

Definition at line 9152 of file pcbnew.py.

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

Definition at line 9301 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 9424 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 9449 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 9182 of file pcbnew.py.

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

Definition at line 9104 of file pcbnew.py.

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

Definition at line 9022 of file pcbnew.py.

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

Definition at line 9017 of file pcbnew.py.

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

Definition at line 9032 of file pcbnew.py.

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

Definition at line 9027 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 9002 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 9454 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 9190 of file pcbnew.py.

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

Definition at line 9341 of file pcbnew.py.

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

Definition at line 9386 of file pcbnew.py.

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

Definition at line 9404 of file pcbnew.py.

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

Definition at line 9336 of file pcbnew.py.

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

Definition at line 9129 of file pcbnew.py.

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

Definition at line 9276 of file pcbnew.py.

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

Definition at line 9162 of file pcbnew.py.

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

Definition at line 9361 of file pcbnew.py.

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

Definition at line 9271 of file pcbnew.py.

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

Definition at line 9094 of file pcbnew.py.

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

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

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

Definition at line 9381 of file pcbnew.py.

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

Definition at line 9256 of file pcbnew.py.

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

Definition at line 9326 of file pcbnew.py.

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

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

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

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

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

Definition at line 9251 of file pcbnew.py.

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

Definition at line 9167 of file pcbnew.py.

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

Definition at line 9478 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 9241 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 9429 of file pcbnew.py.

Member Data Documentation

pcbnew.BOARD_ITEM_List.last
static

Definition at line 9060 of file pcbnew.py.

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

Definition at line 9056 of file pcbnew.py.

pcbnew.BOARD_ITEM_List.this

Definition at line 9080 of file pcbnew.py.


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