KiCad Pcbnew Python Scripting
Public Member Functions | Static Public Attributes | List of all members
pcbnew.EDA_ITEM Class Reference
Inheritance diagram for pcbnew.EDA_ITEM:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, *args, **kwargs)
 
def Type (self)
 
def SetTimeStamp (self, aNewTimeStamp)
 
def GetTimeStamp (self)
 
def Next (self)
 
def Back (self)
 
def GetParent (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 GetEditFlags (self)
 
def ClearTempFlags (self)
 
def IsType (self, aScanTypes)
 
def SetForceVisible (self, aEnable)
 
def GetMsgPanelInfo (self, aUnits, aList)
 
def HitTest (self, *args)
 
def GetBoundingBox (self)
 
def Clone (self)
 
def IterateForward (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 (aLeft, aRight)
 
def ViewBBox (self)
 
def ViewGetLayers (self, aLayers, aCount)
 

Static Public Attributes

 IterateForward = staticmethod(IterateForward)
 
 Sort = staticmethod(Sort)
 

Detailed Description

Proxy of C++ EDA_ITEM class.

Definition at line 1275 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.EDA_ITEM.__init__ (   self,
args,
**  kwargs 
)

Reimplemented in pcbnew.BOARD_CONNECTED_ITEM, pcbnew.BOARD_ITEM_CONTAINER, and pcbnew.BOARD_ITEM.

Definition at line 1283 of file pcbnew.py.

Member Function Documentation

◆ __lt__()

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

Definition at line 1547 of file pcbnew.py.

◆ Back()

def pcbnew.EDA_ITEM.Back (   self)
Back(EDA_ITEM self) -> EDA_ITEM

Reimplemented in pcbnew.MODULE, pcbnew.TRACK, and pcbnew.BOARD_ITEM.

Definition at line 1309 of file pcbnew.py.

◆ ClearBrightened()

def pcbnew.EDA_ITEM.ClearBrightened (   self)
ClearBrightened(EDA_ITEM self)

Definition at line 1409 of file pcbnew.py.

◆ ClearFlags()

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

Definition at line 1444 of file pcbnew.py.

◆ ClearHighlighted()

def pcbnew.EDA_ITEM.ClearHighlighted (   self)
ClearHighlighted(EDA_ITEM self)

Definition at line 1404 of file pcbnew.py.

◆ ClearSelected()

def pcbnew.EDA_ITEM.ClearSelected (   self)
ClearSelected(EDA_ITEM self)

Definition at line 1399 of file pcbnew.py.

◆ ClearTempFlags()

def pcbnew.EDA_ITEM.ClearTempFlags (   self)
ClearTempFlags(EDA_ITEM self)

Definition at line 1462 of file pcbnew.py.

◆ Clone()

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

Reimplemented in pcbnew.MODULE, pcbnew.EDGE_MODULE, pcbnew.TEXTE_MODULE, pcbnew.PCB_TARGET, pcbnew.DRAWSEGMENT, pcbnew.DIMENSION, pcbnew.TEXTE_PCB, pcbnew.ZONE_CONTAINER, pcbnew.VIA, pcbnew.TRACK, and pcbnew.D_PAD.

Definition at line 1497 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetBoundingBox()

def pcbnew.EDA_ITEM.GetBoundingBox (   self)

◆ GetClass()

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

Reimplemented in pcbnew.MODULE, pcbnew.BOARD, pcbnew.NETINFO_ITEM, pcbnew.EDGE_MODULE, pcbnew.TEXTE_MODULE, pcbnew.PCB_TARGET, pcbnew.MARKER_PCB, pcbnew.DRAWSEGMENT, pcbnew.DIMENSION, pcbnew.TEXTE_PCB, pcbnew.ZONE_CONTAINER, pcbnew.VIA, pcbnew.TRACK, and pcbnew.D_PAD.

Definition at line 1513 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetEditFlags()

def pcbnew.EDA_ITEM.GetEditFlags (   self)
GetEditFlags(EDA_ITEM self) -> STATUS_FLAGS

Definition at line 1457 of file pcbnew.py.

◆ GetFlags()

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

Definition at line 1452 of file pcbnew.py.

◆ GetList()

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

Definition at line 1319 of file pcbnew.py.

◆ GetMenuImage()

def pcbnew.EDA_ITEM.GetMenuImage (   self)

◆ GetMsgPanelInfo()

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

Reimplemented in pcbnew.MODULE, pcbnew.BOARD, pcbnew.NETINFO_ITEM, pcbnew.EDGE_MODULE, pcbnew.TEXTE_MODULE, pcbnew.MARKER_PCB, pcbnew.DRAWSEGMENT, pcbnew.DIMENSION, pcbnew.TEXTE_PCB, pcbnew.ZONE_CONTAINER, pcbnew.TRACK, and pcbnew.D_PAD.

Definition at line 1477 of file pcbnew.py.

◆ GetParent()

def pcbnew.EDA_ITEM.GetParent (   self)
GetParent(EDA_ITEM self) -> EDA_ITEM

Reimplemented in pcbnew.NETINFO_ITEM, pcbnew.D_PAD, and pcbnew.BOARD_ITEM.

Definition at line 1314 of file pcbnew.py.

◆ GetSelectMenuText()

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

Reimplemented in pcbnew.MODULE, pcbnew.BOARD, pcbnew.EDGE_MODULE, pcbnew.TEXTE_MODULE, pcbnew.PCB_TARGET, pcbnew.MARKER_PCB, pcbnew.DRAWSEGMENT, pcbnew.DIMENSION, pcbnew.TEXTE_PCB, pcbnew.ZONE_CONTAINER, pcbnew.VIA, pcbnew.TRACK, and pcbnew.D_PAD.

Definition at line 1518 of file pcbnew.py.

◆ GetState()

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

Definition at line 1419 of file pcbnew.py.

◆ GetStatus()

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

Definition at line 1429 of file pcbnew.py.

◆ GetTimeStamp()

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

Definition at line 1299 of file pcbnew.py.

◆ HitTest()

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

Reimplemented in pcbnew.MODULE, pcbnew.TEXTE_MODULE, pcbnew.PCB_TARGET, pcbnew.DRAWSEGMENT, pcbnew.DIMENSION, pcbnew.TEXTE_PCB, pcbnew.ZONE_CONTAINER, pcbnew.VIA, pcbnew.TRACK, and pcbnew.D_PAD.

Definition at line 1482 of file pcbnew.py.

◆ IsBrightened()

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

Definition at line 1374 of file pcbnew.py.

◆ IsDragging()

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

Definition at line 1349 of file pcbnew.py.

◆ IsHighlighted()

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

Definition at line 1369 of file pcbnew.py.

◆ IsModified()

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

Definition at line 1339 of file pcbnew.py.

◆ IsMoving()

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

Definition at line 1344 of file pcbnew.py.

◆ IsNew()

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

Definition at line 1334 of file pcbnew.py.

◆ IsReplaceable()

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

Definition at line 1542 of file pcbnew.py.

◆ IsResized()

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

Definition at line 1364 of file pcbnew.py.

◆ IsSelected()

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

Definition at line 1359 of file pcbnew.py.

◆ IsType()

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

Definition at line 1467 of file pcbnew.py.

◆ IsWireImage()

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

Definition at line 1354 of file pcbnew.py.

◆ IterateForward()

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

Definition at line 1502 of file pcbnew.py.

◆ Matches()

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

Definition at line 1528 of file pcbnew.py.

◆ Next()

def pcbnew.EDA_ITEM.Next (   self)
Next(EDA_ITEM self) -> EDA_ITEM

Reimplemented in pcbnew.MODULE, pcbnew.TRACK, pcbnew.D_PAD, and pcbnew.BOARD_ITEM.

Definition at line 1304 of file pcbnew.py.

◆ Replace()

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

Definition at line 1533 of file pcbnew.py.

◆ SetBrightened()

def pcbnew.EDA_ITEM.SetBrightened (   self)
SetBrightened(EDA_ITEM self)

Definition at line 1394 of file pcbnew.py.

◆ SetFlags()

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

Definition at line 1439 of file pcbnew.py.

◆ SetForceVisible()

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

Definition at line 1472 of file pcbnew.py.

◆ SetHighlighted()

def pcbnew.EDA_ITEM.SetHighlighted (   self)
SetHighlighted(EDA_ITEM self)

Definition at line 1389 of file pcbnew.py.

◆ SetList()

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

Definition at line 1329 of file pcbnew.py.

◆ SetModified()

def pcbnew.EDA_ITEM.SetModified (   self)
SetModified(EDA_ITEM self)

Definition at line 1414 of file pcbnew.py.

◆ SetParent()

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

Definition at line 1324 of file pcbnew.py.

◆ SetSelected()

def pcbnew.EDA_ITEM.SetSelected (   self)
SetSelected(EDA_ITEM self)

Definition at line 1384 of file pcbnew.py.

◆ SetState()

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

Definition at line 1424 of file pcbnew.py.

◆ SetStatus()

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

Definition at line 1434 of file pcbnew.py.

◆ SetTimeStamp()

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

Definition at line 1294 of file pcbnew.py.

◆ SetWireImage()

def pcbnew.EDA_ITEM.SetWireImage (   self)
SetWireImage(EDA_ITEM self)

Definition at line 1379 of file pcbnew.py.

◆ Sort()

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

Definition at line 1552 of file pcbnew.py.

◆ Type()

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

Definition at line 1289 of file pcbnew.py.

◆ ViewBBox()

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

Reimplemented in pcbnew.MODULE, pcbnew.TEXTE_MODULE, pcbnew.MARKER_PCB, pcbnew.DRAWSEGMENT, pcbnew.DIMENSION, pcbnew.TRACK, and pcbnew.D_PAD.

Definition at line 1558 of file pcbnew.py.

◆ ViewGetLayers()

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

Reimplemented in pcbnew.MODULE, pcbnew.TEXTE_MODULE, pcbnew.MARKER_PCB, pcbnew.ZONE_CONTAINER, pcbnew.VIA, pcbnew.TRACK, pcbnew.D_PAD, and pcbnew.BOARD_ITEM.

Definition at line 1563 of file pcbnew.py.

◆ Visit()

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

Reimplemented in pcbnew.MODULE, pcbnew.BOARD, and pcbnew.TRACK.

Definition at line 1508 of file pcbnew.py.

Member Data Documentation

◆ IterateForward

pcbnew.EDA_ITEM.IterateForward = staticmethod(IterateForward)
static

Definition at line 1506 of file pcbnew.py.

◆ Sort

pcbnew.EDA_ITEM.Sort = staticmethod(Sort)
static

Definition at line 1556 of file pcbnew.py.


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