KiCad Pcbnew Python Scripting
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

Public Member Functions

def __init__ (self, *args, **kwargs)
def Type (self)
def GetParent (self)
def SetParent (self, aParent)
def IsModified (self)
def IsNew (self)
def IsMoving (self)
def IsSelected (self)
def IsEntered (self)
def IsBrightened (self)
def IsRollover (self)
def SetSelected (self)
def SetBrightened (self)
def ClearSelected (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 XorFlags (self, aMask)
def ClearFlags (self, *args)
def GetFlags (self)
def HasFlag (self, aFlag)
def GetEditFlags (self)
def ClearTempFlags (self)
def ClearEditFlags (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)
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, aLayers, aCount)

Static Public Member Functions

def Sort (aLeft, aRight)


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

Detailed Description

Proxy of C++ EDA_ITEM class.

Definition at line 1616 of file

Constructor & Destructor Documentation

◆ __init__()

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

Member Function Documentation

◆ __lt__()

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

Definition at line 1832 of file

◆ ClearBrightened()

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

Definition at line 1678 of file

◆ ClearEditFlags()

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

Definition at line 1730 of file

◆ ClearFlags()

def pcbnew.EDA_ITEM.ClearFlags (   self,

Definition at line 1710 of file

◆ ClearSelected()

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

Definition at line 1674 of file

◆ ClearTempFlags()

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

Definition at line 1726 of file

◆ Clone()

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

Definition at line 1793 of file

◆ GetBoundingBox()

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

Reimplemented in pcbnew.FOOTPRINT.

Definition at line 1773 of file

◆ GetClass()

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

Definition at line 1801 of file

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 1722 of file

◆ GetFlags()

def pcbnew.EDA_ITEM.GetFlags (   self)

Definition at line 1714 of file

◆ GetFocusPosition()

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

Definition at line 1785 of file

◆ GetFriendlyName()

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

Reimplemented in pcbnew.PCB_SHAPE.

Definition at line 1762 of file

◆ GetItemDescription()

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

Definition at line 1809 of file

◆ GetMenuImage()

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

Definition at line 1813 of file

◆ GetMsgPanelInfo()

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

Definition at line 1758 of file

◆ GetParent()

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

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

Definition at line 1630 of file

◆ GetPosition()

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

Definition at line 1777 of file

◆ GetSortPosition()

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

Definition at line 1789 of file

◆ GetState()

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

Definition at line 1686 of file

◆ GetStatus()

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

Definition at line 1694 of file

◆ GetTypeDesc()

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

Definition at line 1805 of file

◆ HasFlag()

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

Definition at line 1718 of file

◆ HitTest()

def pcbnew.EDA_ITEM.HitTest (   self,
    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_TARGET, pcbnew.FP_TEXT, pcbnew.FP_TEXTBOX, pcbnew.PCB_GROUP, pcbnew.PCB_BITMAP, pcbnew.FOOTPRINT, and pcbnew.PCB_MARKER.

Definition at line 1766 of file

Here is the caller graph for this function:

◆ IsBrightened()

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

Definition at line 1658 of file

◆ IsEntered()

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

Definition at line 1654 of file

◆ IsForceVisible()

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

Definition at line 1754 of file

◆ IsModified()

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

Definition at line 1638 of file

◆ IsMoving()

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

Definition at line 1646 of file

◆ IsNew()

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

Definition at line 1642 of file

◆ IsReplaceable()

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

Definition at line 1828 of file

◆ IsRollover()

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

Definition at line 1662 of file

◆ IsSelected()

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

Definition at line 1650 of file

◆ IsShownAsBitmap()

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

Definition at line 1742 of file

◆ IsType()

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

Definition at line 1746 of file

◆ Matches()

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

Definition at line 1817 of file

◆ RenderAsBitmap()

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

Definition at line 1734 of file

◆ Replace()

def pcbnew.EDA_ITEM.Replace (   self,
    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 1821 of file

Here is the caller graph for this function:

◆ SetBrightened()

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

Definition at line 1670 of file

◆ SetFlags()

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

Definition at line 1702 of file

◆ SetForceVisible()

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

Definition at line 1750 of file

◆ SetIsShownAsBitmap()

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

Definition at line 1738 of file

◆ SetModified()

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

Definition at line 1682 of file

◆ SetParent()

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

Definition at line 1634 of file

◆ SetPosition()

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

Definition at line 1781 of file

Here is the caller graph for this function:

◆ SetSelected()

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

Definition at line 1666 of file

◆ SetState()

def pcbnew.EDA_ITEM.SetState (   self,
SetState(EDA_ITEM self, EDA_ITEM_FLAGS type, bool state)

Definition at line 1690 of file

◆ SetStatus()

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

Definition at line 1698 of file

◆ Sort()

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

Definition at line 1837 of file

◆ Type()

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

Definition at line 1626 of file

Here is the caller graph for this function:

◆ ViewBBox()

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

Definition at line 1841 of file

◆ ViewGetLayers()

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

Definition at line 1845 of file

◆ Visit()

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

Definition at line 1797 of file

◆ XorFlags()

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

Definition at line 1706 of file

Property Documentation

◆ m_Uuid

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

Definition at line 1848 of file

◆ thisown

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

Definition at line 1619 of file

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