KiCAD pcbnew 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 SetForceVisible (self, aEnable)
 
def GetMsgPanelInfo (self, aList)
 
def HitTest (self, aPosition)
 
def GetBoundingBox (self)
 
def Clone (self)
 
def IterateForward (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 (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 1414 of file pcbnew.py.

Constructor & Destructor Documentation

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

Definition at line 1422 of file pcbnew.py.

Member Function Documentation

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

Definition at line 1668 of file pcbnew.py.

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

Definition at line 1448 of file pcbnew.py.

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

Definition at line 1548 of file pcbnew.py.

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

Definition at line 1583 of file pcbnew.py.

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

Definition at line 1543 of file pcbnew.py.

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

Definition at line 1538 of file pcbnew.py.

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

Definition at line 1616 of file pcbnew.py.

Here is the caller graph for this function:

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

Definition at line 1611 of file pcbnew.py.

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

Definition at line 1634 of file pcbnew.py.

Here is the caller graph for this function:

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

Definition at line 1591 of file pcbnew.py.

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

Definition at line 1458 of file pcbnew.py.

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

Definition at line 1644 of file pcbnew.py.

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

Definition at line 1601 of file pcbnew.py.

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

Definition at line 1453 of file pcbnew.py.

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

Definition at line 1639 of file pcbnew.py.

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

Definition at line 1558 of file pcbnew.py.

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

Definition at line 1568 of file pcbnew.py.

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

Definition at line 1438 of file pcbnew.py.

def pcbnew.EDA_ITEM.HitTest (   self,
  aPosition 
)
HitTest(EDA_ITEM self, wxPoint aPosition) -> bool

Definition at line 1606 of file pcbnew.py.

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

Definition at line 1513 of file pcbnew.py.

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

Definition at line 1488 of file pcbnew.py.

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

Definition at line 1508 of file pcbnew.py.

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

Definition at line 1478 of file pcbnew.py.

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

Definition at line 1483 of file pcbnew.py.

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

Definition at line 1473 of file pcbnew.py.

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

Definition at line 1663 of file pcbnew.py.

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

Definition at line 1503 of file pcbnew.py.

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

Definition at line 1498 of file pcbnew.py.

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

Definition at line 1493 of file pcbnew.py.

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

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

Definition at line 1649 of file pcbnew.py.

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

Definition at line 1443 of file pcbnew.py.

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

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

Definition at line 1533 of file pcbnew.py.

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

Definition at line 1578 of file pcbnew.py.

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

Definition at line 1596 of file pcbnew.py.

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

Definition at line 1528 of file pcbnew.py.

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

Definition at line 1468 of file pcbnew.py.

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

Definition at line 1553 of file pcbnew.py.

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

Definition at line 1463 of file pcbnew.py.

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

Definition at line 1523 of file pcbnew.py.

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

Definition at line 1563 of file pcbnew.py.

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

Definition at line 1573 of file pcbnew.py.

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

Definition at line 1433 of file pcbnew.py.

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

Definition at line 1518 of file pcbnew.py.

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

Definition at line 1673 of file pcbnew.py.

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

Definition at line 1428 of file pcbnew.py.

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

Definition at line 1681 of file pcbnew.py.

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

Definition at line 1686 of file pcbnew.py.

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

Definition at line 1629 of file pcbnew.py.

Member Data Documentation

pcbnew.EDA_ITEM.IterateForward = staticmethod(IterateForward)
static

Definition at line 1626 of file pcbnew.py.

pcbnew.EDA_ITEM.Sort = staticmethod(Sort)
static

Definition at line 1678 of file pcbnew.py.


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