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, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre)
 
def GetBoard (self)
 
def GetLayerName (self)
 
def HitTest (self, args)
 
def FormatInternalUnits (self, args)
 
def FormatAngle (self, aAngle)
 
def ViewGetLayers (self, aLayers, aCount)
 
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
 
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

tuple ret = self.last.Get()
 
 ret = self.last
 

Detailed Description

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

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

Member Function Documentation

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

Definition at line 15586 of file pcbnew.py.

def pcbnew.BOARD_ITEM_List.__iter__ (   self)

Definition at line 15681 of file pcbnew.py.

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

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

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

BOARD_ITEM*
BOARD_ITEM::Back() const 

Definition at line 15759 of file pcbnew.py.

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

Definition at line 15619 of file pcbnew.py.

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

void
EDA_ITEM::ClearBrightened() 

Definition at line 16321 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)

void
EDA_ITEM::ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS) 

Definition at line 16391 of file pcbnew.py.

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

void
EDA_ITEM::ClearHighlighted() 

Definition at line 16311 of file pcbnew.py.

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

void
EDA_ITEM::ClearSelected() 

Definition at line 16301 of file pcbnew.py.

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

EDA_ITEM * EDA_ITEM::Clone()
const

Function Clone creates a duplicate of this item with linked list
members set to NULL.

The default version will return NULL in release builds and likely
crash the program. In debug builds, a warning message indicating the
derived class has not implemented cloning. This really should be a
pure virtual function. Due to the fact that there are so many objects
derived from EDA_ITEM, the decision was made to return NULL until all
the objects derived from EDA_ITEM implement cloning. Once that
happens, this function should be made pure.

A clone of the item. 

Definition at line 16471 of file pcbnew.py.

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

void
BOARD_ITEM::DeleteStructure()

Function DeleteStructure deletes this object after UnLink()ing it from
its owner if it has one. 

Definition at line 15937 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)

virtual void
BOARD_ITEM::Draw(EDA_DRAW_PANEL *panel, wxDC *DC, GR_DRAWMODE
aDrawMode, const wxPoint &offset=ZeroOffset)=0

Function Draw BOARD_ITEMs have their own color information. 

Definition at line 15824 of file pcbnew.py.

Here is the caller graph for this function:

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

Definition at line 15624 of file pcbnew.py.

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

virtual void
BOARD_ITEM::Flip(const wxPoint &aCentre)

Function Flip Flip this object, i.e.

change the board side for this object

Parameters:
-----------

aCentre:  - the rotation point. 

Definition at line 15991 of file pcbnew.py.

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

Definition at line 16076 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, wxSize aSize) -> string

Definition at line 16067 of file pcbnew.py.

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

Definition at line 15581 of file pcbnew.py.

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

BOARD *
BOARD_ITEM::GetBoard() const

Function GetBoard returns the BOARD in which this BOARD_ITEM resides,
or NULL if none. 

Definition at line 16010 of file pcbnew.py.

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

const EDA_RECT
EDA_ITEM::GetBoundingBox() const

Function GetBoundingBox returns the orthogonal, bounding box of this
object for display purposes.

This box should be an enclosing perimeter for visible components of
this object, and the units should be in the pcb or schematic
coordinate system. It is OK to overestimate the size by a few counts.

Definition at line 16453 of file pcbnew.py.

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

virtual const wxPoint
BOARD_ITEM::GetCenter() const

Function GetCenter()

This defaults to the same point as returned by GetPosition(), unless
overridden

centre point of the item 

Definition at line 15706 of file pcbnew.py.

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

virtual wxString
EDA_ITEM::GetClass() const =0

Function GetClass returns the class name.

wxString 

Definition at line 16530 of file pcbnew.py.

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

Definition at line 15591 of file pcbnew.py.

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

STATUS_FLAGS
EDA_ITEM::GetFlags() const 

Definition at line 16402 of file pcbnew.py.

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

Definition at line 15596 of file pcbnew.py.

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

PCB_LAYER_ID
BOARD_ITEM::GetLayer() const

Function GetLayer returns the primary layer this item is on. 

Definition at line 15779 of file pcbnew.py.

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

wxString
BOARD_ITEM::GetLayerName() const

Function GetLayerName returns the name of the PCB layer on which the
item resides.

wxString containing the layer name associated with this item. 

Definition at line 16023 of file pcbnew.py.

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

virtual LSET
BOARD_ITEM::GetLayerSet() const

Function GetLayerSet returns a "layer mask", which is a bitmap of
all layers on which the TRACK segment or VIA physically resides.

int - a layer mask, see layers_id_colors_visibility.h. 

Definition at line 15791 of file pcbnew.py.

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

DHEAD* EDA_ITEM::GetList()
const 

Definition at line 16141 of file pcbnew.py.

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

BITMAP_DEF
EDA_ITEM::GetMenuImage() const

Function GetMenuImage returns a pointer to an image to be used in
menus.

The default version returns the right arrow image. Override this
function to provide object specific menu images. The menu image
associated with the item. 

Definition at line 16564 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)

virtual void
EDA_ITEM::GetMsgPanelInfo(std::vector< MSG_PANEL_ITEM > &aList)

Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects
with it's internal state for display purposes.

This method replaces DisplayInfo() so that KiCad objects no longer
have any knowledge of wxWidgets UI objects.

Parameters:
-----------

aList:  is the list to populate. 

Definition at line 16432 of file pcbnew.py.

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

BOARD_ITEM_CONTAINER*
BOARD_ITEM::GetParent() const 

Definition at line 15769 of file pcbnew.py.

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

virtual const
wxPoint& BOARD_ITEM::GetPosition() const =0 

Definition at line 15696 of file pcbnew.py.

Here is the caller graph for this function:

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

wxString
EDA_ITEM::GetSelectMenuText() const

Function GetSelectMenuText returns the text to display to be used in
the selection clarification context menu when multiple items are found
at the current cursor position.

The default version of this function raises an assertion in the debug
mode and returns a string to indicate that it was not overridden to
provide the object specific text.

The menu text string. 

Definition at line 16544 of file pcbnew.py.

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

int EDA_ITEM::GetState(int
type) const 

Definition at line 16341 of file pcbnew.py.

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

STATUS_FLAGS
EDA_ITEM::GetStatus() const 

Definition at line 16361 of file pcbnew.py.

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

time_t
EDA_ITEM::GetTimeStamp() const 

Definition at line 16131 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

virtual bool
BOARD_ITEM::HitTest(const EDA_RECT &aRect, bool aContained=true, int
aAccuracy=0) const

Function HitTest tests if the aRect intersects or contains this object
(depending on aContained).

Parameters:
-----------

aRect:  A reference to an EDA_RECT object containg the area to test.

aContained:  Test if aRect contains this object completly.

aAccuracy:  Increase the item bounding box by this amount.

bool - True if aRect contains this object completly or if aRect
intersects the object and aContained is False, otherwise false. 

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

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

bool
EDA_ITEM::IsBrightened() const 

Definition at line 16251 of file pcbnew.py.

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

virtual bool
BOARD_ITEM::IsConnected() const

Function IsConnected() Returns information if the object is derived
from BOARD_CONNECTED_ITEM.

True if the object is of BOARD_CONNECTED_ITEM type, false otherwise.

Definition at line 15733 of file pcbnew.py.

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

bool
EDA_ITEM::IsDragging() const 

Definition at line 16201 of file pcbnew.py.

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

bool
EDA_ITEM::IsHighlighted() const 

Definition at line 16241 of file pcbnew.py.

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

virtual bool
BOARD_ITEM::IsLocked() const

Function IsLocked.

bool - true if the object is locked, else false 

Definition at line 15897 of file pcbnew.py.

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

bool
EDA_ITEM::IsModified() const 

Definition at line 16181 of file pcbnew.py.

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

bool EDA_ITEM::IsMoving()
const 

Definition at line 16191 of file pcbnew.py.

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

bool EDA_ITEM::IsNew() const

Definition at line 16171 of file pcbnew.py.

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

virtual bool
BOARD_ITEM::IsOnLayer(PCB_LAYER_ID aLayer) const

Function IsOnLayer tests to see if this object is on the given layer.

Is virtual so objects like D_PAD, which reside on multiple layers can
do their own form of testing.

Parameters:
-----------

aLayer:  The layer to test for.

bool - true if on given layer, else false. 

Definition at line 15860 of file pcbnew.py.

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

virtual bool
EDA_ITEM::IsReplaceable() const

Function IsReplaceable.

Override this method in any derived object that supports test find and
replace.

True if the item has replaceable text that can be modified using the
find and replace dialog. 

Definition at line 16640 of file pcbnew.py.

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

bool
EDA_ITEM::IsResized() const 

Definition at line 16231 of file pcbnew.py.

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

bool
EDA_ITEM::IsSelected() const 

Definition at line 16221 of file pcbnew.py.

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

bool
BOARD_ITEM::IsTrack() const

Function IsTrack tests to see if this object is a track or via (or
microvia).

form of testing. bool - true if a track or via, else false. 

Definition at line 15882 of file pcbnew.py.

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

bool
EDA_ITEM::IsWireImage() const 

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

Here is the caller graph for this function:

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

virtual bool
EDA_ITEM::Matches(wxFindReplaceData &aSearchData, void *aAuxData,
wxPoint *aFindLocation)

Function Matches compares the item against the search criteria in
aSearchData.

The base class returns false since many of the objects derived from
EDA_ITEM do not have any text to search.

Parameters:
-----------

aSearchData:  A reference to a wxFindReplaceData object containing the
search criteria.

aAuxData:  A pointer to optional data required for the search or NULL
if not used.

aFindLocation:  A pointer to a wxPoint object to store the location of
matched item. The pointer can be NULL if it is not used.

True if the item's text matches the search criteria in aSearchData. 

Definition at line 16581 of file pcbnew.py.

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

virtual void
BOARD_ITEM::Move(const wxPoint &aMoveVector)

Function Move move this object.

Parameters:
-----------

aMoveVector:  - the move vector for this object. 

Definition at line 15955 of file pcbnew.py.

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

BOARD_ITEM*
BOARD_ITEM::Next() const 

Definition at line 15749 of file pcbnew.py.

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

Definition at line 15634 of file pcbnew.py.

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

Definition at line 15629 of file pcbnew.py.

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

Definition at line 15644 of file pcbnew.py.

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

Definition at line 15639 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 15614 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

virtual bool
EDA_ITEM::Replace(wxFindReplaceData &aSearchData, void *aAuxData=NULL)

Function Replace performs a text replace using the find and replace
criteria in aSearchData on items that support text find and replace.

This function must be overridden for items that support text replace.

Parameters:
-----------

aSearchData:  A reference to a wxFindReplaceData object containing the
search and replace criteria.

aAuxData:  A pointer to optional data required for the search or NULL
if not used.

True if the item text was modified, otherwise false. 

Definition at line 16612 of file pcbnew.py.

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

virtual void
BOARD_ITEM::Rotate(const wxPoint &aRotCentre, double aAngle)

Function Rotate Rotate this object.

Parameters:
-----------

aRotCentre:  - the rotation point.

aAngle:  - the rotation angle in 0.1 degree. 

Definition at line 15972 of file pcbnew.py.

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

void
EDA_ITEM::SetBrightened() 

Definition at line 16291 of file pcbnew.py.

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

void
EDA_ITEM::SetFlags(STATUS_FLAGS aMask) 

Definition at line 16381 of file pcbnew.py.

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

void
EDA_ITEM::SetForceVisible(bool aEnable)

Function SetForceVisible is used to set and cleag force visible flag
used to force the item to be drawn even if it's draw attribute is set
to not visible.

Parameters:
-----------

aEnable:  True forces the item to be drawn. False uses the item's
visibility setting to determine if the item is to be drawn. 

Definition at line 16412 of file pcbnew.py.

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

void
EDA_ITEM::SetHighlighted() 

Definition at line 16281 of file pcbnew.py.

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

virtual void
BOARD_ITEM::SetLayer(PCB_LAYER_ID aLayer)

Function SetLayer sets the layer this item is on.

Parameters:
-----------

aLayer:  The layer number. is virtual because some items (in fact:
class DIMENSION) have a slightly different initialization 

Definition at line 15806 of file pcbnew.py.

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

void
EDA_ITEM::SetList(DHEAD *aList) 

Definition at line 16161 of file pcbnew.py.

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

virtual void
BOARD_ITEM::SetLocked(bool aLocked)

Function SetLocked modifies 'lock' status for of the item. 

Definition at line 15911 of file pcbnew.py.

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

void
EDA_ITEM::SetModified() 

Definition at line 16331 of file pcbnew.py.

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

void
EDA_ITEM::SetParent(EDA_ITEM *aParent) 

Definition at line 16151 of file pcbnew.py.

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

virtual void
BOARD_ITEM::SetPosition(const wxPoint &aPos)=0 

Definition at line 15723 of file pcbnew.py.

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

void
EDA_ITEM::SetSelected() 

Definition at line 16271 of file pcbnew.py.

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

void
EDA_ITEM::SetState(int type, int state) 

Definition at line 16351 of file pcbnew.py.

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

void
EDA_ITEM::SetStatus(STATUS_FLAGS aStatus) 

Definition at line 16371 of file pcbnew.py.

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

void
EDA_ITEM::SetTimeStamp(time_t aNewTimeStamp) 

Definition at line 16121 of file pcbnew.py.

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

void
EDA_ITEM::SetWireImage() 

Definition at line 16261 of file pcbnew.py.

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

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

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

void
BOARD_ITEM::SwapData(BOARD_ITEM *aImage)

Swap data between aItem and aImage.

aItem and aImage should have the same type Used in undo redo command
to swap values between an item and its copy Only values like layer,
size .. which are modified by edition are swapped, not the pointers
like Pnext and Pback because aItem is not changed in the linked list

Parameters:
-----------

aImage:  = the item image which contains data to swap 

Definition at line 15838 of file pcbnew.py.

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

KICAD_T EDA_ITEM::Type() const

Function Type()

returns the type of object. This attribute should never be changed
after a constructor sets it, so there is no public "setter" method.
KICAD_T - the type of object. 

Definition at line 16106 of file pcbnew.py.

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

void BOARD_ITEM::UnLink()

Function UnLink detaches this object from its owner.

This base class implementation should work for all derived classes
which are held in a DLIST<>. 

Definition at line 15923 of file pcbnew.py.

Here is the caller graph for this function:

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

const BOX2I
EDA_ITEM::ViewBBox() const override

Function ViewBBox() returns the bounding box of the item covering all
its layers.

BOX2I - the current bounding box 

Definition at line 16668 of file pcbnew.py.

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

void
BOARD_ITEM::ViewGetLayers(int aLayers[], int &aCount) const override

Function ViewGetLayers() Returns the all the layers within the VIEW
the object is painted on.

For instance, a D_PAD spans zero or more copper layers and a few
technical layers. ViewDraw() or PAINTER::Draw() is repeatedly called
for each of the layers returned by ViewGetLayers(), depending on the
rendering order.

Parameters:
-----------

aLayers[]:  output layer index array

aCount:  number of layer indices in aLayers[] 

Definition at line 16081 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

SEARCH_RESULT
EDA_ITEM::Visit(INSPECTOR inspector, void *testData, const KICAD_T
scanTypes[])

Function Visit may be re-implemented for each derived class in order
to handle all the types given by its member data.

Implementations should call inspector->Inspect() on types in
scanTypes[], and may use IterateForward() to do so on lists of such
data.

Parameters:
-----------

inspector:  An INSPECTOR instance to use in the inspection.

testData:  Arbitrary data used by the inspector.

scanTypes:  Which KICAD_T types are of interest and the order is
significant too, terminated by EOT.

SEARCH_RESULT SEARCH_QUIT if the Iterator is to stop the scan, else
SCAN_CONTINUE, and determined by the inspector. 

Definition at line 16499 of file pcbnew.py.

Member Data Documentation

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

Definition at line 15668 of file pcbnew.py.

pcbnew.BOARD_ITEM_List.ret = self.last
static

Definition at line 15670 of file pcbnew.py.

pcbnew.BOARD_ITEM_List.this

Definition at line 15692 of file pcbnew.py.


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