KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Properties | 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 GetParent (self)
 
def SetParent (self, aParent)
 
def SetParentGroup (self, aGroup)
 
def GetParentGroup (self)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
def IsModified (self)
 
def IsNew (self)
 
def IsMoving (self)
 
def IsSelected (self)
 
def IsEntered (self)
 
def IsBrightened (self)
 
def IsRollover (self)
 
def SetIsRollover (self, aIsRollover)
 
def SetSelected (self)
 
def SetBrightened (self)
 
def ClearSelected (self)
 
def ClearBrightened (self)
 
def SetModified (self)
 
def SetFlags (self, aMask)
 
def XorFlags (self, aMask)
 
def ClearFlags (self, *args)
 
def GetFlags (self)
 
def HasFlag (self, aFlag)
 
def GetEditFlags (self)
 
def ClearEditFlags (self)
 
def GetTempFlags (self)
 
def ClearTempFlags (self)
 
def RenderAsBitmap (self, aWorldScale)
 
def SetIsShownAsBitmap (self, aBitmap)
 
def IsShownAsBitmap (self)
 
def IsType (self, aScanTypes)
 
def SetForceVisible (self, aEnable)
 
def IsForceVisible (self)
 
def GetMsgPanelInfo (self, aFrame, aList)
 
def GetFriendlyName (self)
 
def HitTest (self, *args)
 
def GetBoundingBox (self)
 
def GetPosition (self)
 
def SetPosition (self, aPos)
 
def GetFocusPosition (self)
 
def GetSortPosition (self)
 
def Clone (self)
 
def Visit (self, inspector, testData, aScanTypes)
 
def GetClass (self)
 
def GetTypeDesc (self)
 
def GetItemDescription (self, aUnitsProvider, aFull)
 
def GetMenuImage (self)
 
def Matches (self, aSearchData, aAuxData)
 
def Replace (self, *args)
 
def IsReplaceable (self)
 
def __lt__ (self, aItem)
 
def ViewBBox (self)
 
def ViewGetLayers (self)
 
def GetEmbeddedFiles (self)
 

Static Public Member Functions

def Sort (aLeft, aRight)
 

Properties

property thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
property m_Uuid = property(_pcbnew.EDA_ITEM_m_Uuid_get, doc=)
 

Detailed Description

Proxy of C++ EDA_ITEM class.

Definition at line 1433 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

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

Member Function Documentation

◆ __lt__()

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

Definition at line 1657 of file pcbnew.py.

◆ ClearBrightened()

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

Definition at line 1515 of file pcbnew.py.

◆ ClearEditFlags()

def pcbnew.EDA_ITEM.ClearEditFlags (   self)
ClearEditFlags(EDA_ITEM self)

Definition at line 1547 of file pcbnew.py.

◆ ClearFlags()

def pcbnew.EDA_ITEM.ClearFlags (   self,
args 
)
ClearFlags(EDA_ITEM self, EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition at line 1531 of file pcbnew.py.

◆ ClearSelected()

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

Definition at line 1511 of file pcbnew.py.

◆ ClearTempFlags()

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

Definition at line 1555 of file pcbnew.py.

◆ Clone()

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

Definition at line 1618 of file pcbnew.py.

◆ GetBoundingBox()

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

Reimplemented in pcbnew.PAD, pcbnew.PCB_VIA, and pcbnew.FOOTPRINT.

Definition at line 1598 of file pcbnew.py.

◆ GetClass()

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

Definition at line 1626 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetEditFlags()

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

Definition at line 1543 of file pcbnew.py.

◆ GetEmbeddedFiles()

def pcbnew.EDA_ITEM.GetEmbeddedFiles (   self)
GetEmbeddedFiles(EDA_ITEM self) -> EMBEDDED_FILES *

Reimplemented in pcbnew.BOARD, and pcbnew.FOOTPRINT.

Definition at line 1674 of file pcbnew.py.

◆ GetFlags()

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

Definition at line 1535 of file pcbnew.py.

◆ GetFocusPosition()

def pcbnew.EDA_ITEM.GetFocusPosition (   self)
GetFocusPosition(EDA_ITEM self) -> VECTOR2I

Definition at line 1610 of file pcbnew.py.

◆ GetFriendlyName()

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

Definition at line 1587 of file pcbnew.py.

◆ GetItemDescription()

def pcbnew.EDA_ITEM.GetItemDescription (   self,
  aUnitsProvider,
  aFull 
)
GetItemDescription(EDA_ITEM self, UNITS_PROVIDER aUnitsProvider, bool aFull) -> wxString

Definition at line 1634 of file pcbnew.py.

◆ GetMenuImage()

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

Definition at line 1638 of file pcbnew.py.

◆ GetMsgPanelInfo()

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

Definition at line 1583 of file pcbnew.py.

◆ GetParent()

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

Reimplemented in pcbnew.BOARD_ITEM, and pcbnew.NETINFO_ITEM.

Definition at line 1447 of file pcbnew.py.

◆ GetParentGroup()

def pcbnew.EDA_ITEM.GetParentGroup (   self)
GetParentGroup(EDA_ITEM self) -> EDA_GROUP

Definition at line 1459 of file pcbnew.py.

◆ GetPosition()

def pcbnew.EDA_ITEM.GetPosition (   self)
GetPosition(EDA_ITEM self) -> VECTOR2I

Definition at line 1602 of file pcbnew.py.

◆ GetSortPosition()

def pcbnew.EDA_ITEM.GetSortPosition (   self)
GetSortPosition(EDA_ITEM self) -> VECTOR2I

Definition at line 1614 of file pcbnew.py.

◆ GetTempFlags()

def pcbnew.EDA_ITEM.GetTempFlags (   self)
GetTempFlags(EDA_ITEM self) -> EDA_ITEM_FLAGS

Definition at line 1551 of file pcbnew.py.

◆ GetTypeDesc()

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

Definition at line 1630 of file pcbnew.py.

◆ HasFlag()

def pcbnew.EDA_ITEM.HasFlag (   self,
  aFlag 
)
HasFlag(EDA_ITEM self, EDA_ITEM_FLAGS aFlag) -> bool

Definition at line 1539 of file pcbnew.py.

◆ HitTest()

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

Reimplemented in pcbnew.PAD, pcbnew.PCB_TRACK, pcbnew.PCB_ARC, pcbnew.PCB_VIA, pcbnew.ZONE, pcbnew.PCB_SHAPE, pcbnew.PCB_TEXT, pcbnew.PCB_TEXTBOX, pcbnew.PCB_DIMENSION_BASE, pcbnew.PCB_MARKER, pcbnew.PCB_TARGET, pcbnew.PCB_TABLE, pcbnew.PCB_GROUP, pcbnew.PCB_REFERENCE_IMAGE, and pcbnew.FOOTPRINT.

Definition at line 1591 of file pcbnew.py.

Here is the caller graph for this function:

◆ IsBrightened()

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

Definition at line 1491 of file pcbnew.py.

◆ IsEntered()

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

Definition at line 1487 of file pcbnew.py.

◆ IsForceVisible()

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

Definition at line 1579 of file pcbnew.py.

◆ IsLocked()

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

Definition at line 1463 of file pcbnew.py.

◆ IsModified()

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

Definition at line 1471 of file pcbnew.py.

◆ IsMoving()

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

Definition at line 1479 of file pcbnew.py.

◆ IsNew()

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

Definition at line 1475 of file pcbnew.py.

◆ IsReplaceable()

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

Definition at line 1653 of file pcbnew.py.

◆ IsRollover()

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

Definition at line 1495 of file pcbnew.py.

◆ IsSelected()

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

Definition at line 1483 of file pcbnew.py.

◆ IsShownAsBitmap()

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

Definition at line 1567 of file pcbnew.py.

◆ IsType()

def pcbnew.EDA_ITEM.IsType (   self,
  aScanTypes 
)
IsType(EDA_ITEM self, std::vector< KICAD_T,std::allocator< KICAD_T > > const & aScanTypes) -> bool

Definition at line 1571 of file pcbnew.py.

◆ Matches()

def pcbnew.EDA_ITEM.Matches (   self,
  aSearchData,
  aAuxData 
)
Matches(EDA_ITEM self, EDA_SEARCH_DATA const & aSearchData, void * aAuxData) -> bool

Definition at line 1642 of file pcbnew.py.

◆ RenderAsBitmap()

def pcbnew.EDA_ITEM.RenderAsBitmap (   self,
  aWorldScale 
)
RenderAsBitmap(EDA_ITEM self, double aWorldScale) -> bool

Definition at line 1559 of file pcbnew.py.

◆ Replace()

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

Definition at line 1646 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetBrightened()

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

Definition at line 1507 of file pcbnew.py.

◆ SetFlags()

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

Definition at line 1523 of file pcbnew.py.

◆ SetForceVisible()

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

Definition at line 1575 of file pcbnew.py.

◆ SetIsRollover()

def pcbnew.EDA_ITEM.SetIsRollover (   self,
  aIsRollover 
)
SetIsRollover(EDA_ITEM self, bool aIsRollover)

Definition at line 1499 of file pcbnew.py.

◆ SetIsShownAsBitmap()

def pcbnew.EDA_ITEM.SetIsShownAsBitmap (   self,
  aBitmap 
)
SetIsShownAsBitmap(EDA_ITEM self, bool aBitmap)

Definition at line 1563 of file pcbnew.py.

◆ SetLocked()

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

Definition at line 1467 of file pcbnew.py.

◆ SetModified()

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

Definition at line 1519 of file pcbnew.py.

◆ SetParent()

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

Reimplemented in pcbnew.NETINFO_ITEM.

Definition at line 1451 of file pcbnew.py.

◆ SetParentGroup()

def pcbnew.EDA_ITEM.SetParentGroup (   self,
  aGroup 
)
SetParentGroup(EDA_ITEM self, EDA_GROUP aGroup)

Definition at line 1455 of file pcbnew.py.

◆ SetPosition()

def pcbnew.EDA_ITEM.SetPosition (   self,
  aPos 
)
SetPosition(EDA_ITEM self, VECTOR2I aPos)

Definition at line 1606 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetSelected()

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

Definition at line 1503 of file pcbnew.py.

◆ Sort()

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

Definition at line 1662 of file pcbnew.py.

◆ Type()

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

Definition at line 1443 of file pcbnew.py.

Here is the caller graph for this function:

◆ ViewBBox()

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

Definition at line 1666 of file pcbnew.py.

◆ ViewGetLayers()

def pcbnew.EDA_ITEM.ViewGetLayers (   self)
ViewGetLayers(EDA_ITEM self) -> intVector

Definition at line 1670 of file pcbnew.py.

◆ Visit()

def pcbnew.EDA_ITEM.Visit (   self,
  inspector,
  testData,
  aScanTypes 
)
Visit(EDA_ITEM self, INSPECTOR inspector, void * testData, std::vector< KICAD_T,std::allocator< KICAD_T > > const & aScanTypes) -> INSPECT_RESULT

Definition at line 1622 of file pcbnew.py.

◆ XorFlags()

def pcbnew.EDA_ITEM.XorFlags (   self,
  aMask 
)
XorFlags(EDA_ITEM self, EDA_ITEM_FLAGS aMask)

Definition at line 1527 of file pcbnew.py.

Property Documentation

◆ m_Uuid

property pcbnew.EDA_ITEM.m_Uuid = property(_pcbnew.EDA_ITEM_m_Uuid_get, doc=)
static

Definition at line 1677 of file pcbnew.py.

◆ thisown

property pcbnew.EDA_ITEM.thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
static

Definition at line 1436 of file pcbnew.py.


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