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

 __init__ (self, *args, **kwargs)
 
 Type (self)
 
 GetParent (self)
 
 SetParent (self, aParent)
 
 SetParentGroup (self, aGroup)
 
 GetParentGroup (self)
 
 GetParentGroupId (self)
 
 HasSelectedAncestorGroup (self)
 
 IsLocked (self)
 
 SetLocked (self, aLocked)
 
 IsModified (self)
 
 IsNew (self)
 
 IsMoving (self)
 
 IsSelected (self)
 
 IsEntered (self)
 
 IsBrightened (self)
 
 IsRollover (self)
 
 GetRolloverPos (self)
 
 SetIsRollover (self, aIsRollover, aMousePos)
 
 SetSelected (self)
 
 SetBrightened (self)
 
 ClearSelected (self)
 
 ClearBrightened (self)
 
 SetModified (self)
 
 SetFlags (self, aMask)
 
 XorFlags (self, aMask)
 
 ClearFlags (self, *args)
 
 GetFlags (self)
 
 HasFlag (self, aFlag)
 
 GetEditFlags (self)
 
 ClearEditFlags (self)
 
 GetTempFlags (self)
 
 ClearTempFlags (self)
 
 RenderAsBitmap (self, aWorldScale)
 
 SetIsShownAsBitmap (self, aBitmap)
 
 IsShownAsBitmap (self)
 
 IsType (self, aScanTypes)
 
 SetForceVisible (self, aEnable)
 
 IsForceVisible (self)
 
 GetMsgPanelInfo (self, aFrame, aList)
 
 GetFriendlyName (self)
 
 HitTest (self, *args)
 
 GetBoundingBox (self)
 
 GetPosition (self)
 
 SetPosition (self, aPos)
 
 GetFocusPosition (self)
 
 GetSortPosition (self)
 
 Clone (self)
 
 Visit (self, inspector, testData, aScanTypes)
 
 GetTypeDesc (self)
 
 GetItemDescription (self, aUnitsProvider, aFull)
 
 DisambiguateItemDescription (self, aUnitsProvider, aFull)
 
 GetMenuImage (self)
 
 Matches (self, aSearchData, aAuxData)
 
 Replace (self, *args)
 
 IsReplaceable (self)
 
 __lt__ (self, aItem)
 
 ViewBBox (self)
 
 ViewGetLayers (self)
 
 GetEmbeddedFiles (self)
 
 GetEmbeddedFonts (self)
 
 PyGetClass (self)
 
 GetClass (self)
 

Static Public Member Functions

 Sort (aLeft, aRight)
 

Properties

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

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 1462 of file pcbnew.py.

Member Function Documentation

◆ __lt__()

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

Definition at line 1694 of file pcbnew.py.

◆ ClearBrightened()

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

Definition at line 1551 of file pcbnew.py.

◆ ClearEditFlags()

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

Definition at line 1583 of file pcbnew.py.

◆ ClearFlags()

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

Definition at line 1567 of file pcbnew.py.

◆ ClearSelected()

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

Definition at line 1547 of file pcbnew.py.

◆ ClearTempFlags()

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

Definition at line 1591 of file pcbnew.py.

◆ Clone()

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

Reimplemented in pcbnew.ZONE.

Definition at line 1655 of file pcbnew.py.

◆ DisambiguateItemDescription()

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

Definition at line 1671 of file pcbnew.py.

◆ GetBoundingBox()

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

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

Definition at line 1635 of file pcbnew.py.

◆ GetClass()

pcbnew.EDA_ITEM.GetClass ( self)

Reimplemented in pcbnew.BOARD, pcbnew.DELETED_BOARD_ITEM, pcbnew.FOOTPRINT, pcbnew.NETINFO_ITEM, pcbnew.PAD, pcbnew.PCB_ARC, pcbnew.PCB_BARCODE, pcbnew.PCB_DIM_ALIGNED, pcbnew.PCB_DIM_CENTER, pcbnew.PCB_DIM_LEADER, pcbnew.PCB_DIM_ORTHOGONAL, pcbnew.PCB_DIM_RADIAL, pcbnew.PCB_FIELD, pcbnew.PCB_GROUP, pcbnew.PCB_MARKER, pcbnew.PCB_REFERENCE_IMAGE, pcbnew.PCB_SHAPE, pcbnew.PCB_TABLE, pcbnew.PCB_TARGET, pcbnew.PCB_TEXT, pcbnew.PCB_TEXTBOX, pcbnew.PCB_TRACK, pcbnew.PCB_VIA, and pcbnew.ZONE.

Definition at line 1724 of file pcbnew.py.

◆ GetEditFlags()

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

Definition at line 1579 of file pcbnew.py.

◆ GetEmbeddedFiles()

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

Reimplemented in pcbnew.BOARD, and pcbnew.FOOTPRINT.

Definition at line 1711 of file pcbnew.py.

◆ GetEmbeddedFonts()

pcbnew.EDA_ITEM.GetEmbeddedFonts ( self) 
GetEmbeddedFonts(EDA_ITEM self) -> std::vector< wxString,std::allocator< wxString > > const *

Definition at line 1715 of file pcbnew.py.

◆ GetFlags()

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

Definition at line 1571 of file pcbnew.py.

◆ GetFocusPosition()

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

Definition at line 1647 of file pcbnew.py.

◆ GetFriendlyName()

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

Definition at line 1623 of file pcbnew.py.

◆ GetItemDescription()

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

Definition at line 1667 of file pcbnew.py.

◆ GetMenuImage()

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

Definition at line 1675 of file pcbnew.py.

◆ GetMsgPanelInfo()

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

◆ GetParent()

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

Reimplemented in pcbnew.BOARD_ITEM, and pcbnew.NETINFO_ITEM.

Definition at line 1471 of file pcbnew.py.

◆ GetParentGroup()

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

Definition at line 1483 of file pcbnew.py.

◆ GetParentGroupId()

pcbnew.EDA_ITEM.GetParentGroupId ( self) 
GetParentGroupId(EDA_ITEM self) -> KIID

Definition at line 1487 of file pcbnew.py.

◆ GetPosition()

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

Definition at line 1639 of file pcbnew.py.

◆ GetRolloverPos()

pcbnew.EDA_ITEM.GetRolloverPos ( self) 
GetRolloverPos(EDA_ITEM self) -> VECTOR2I

Definition at line 1531 of file pcbnew.py.

◆ GetSortPosition()

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

Definition at line 1651 of file pcbnew.py.

◆ GetTempFlags()

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

Definition at line 1587 of file pcbnew.py.

◆ GetTypeDesc()

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

Definition at line 1663 of file pcbnew.py.

◆ HasFlag()

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

Definition at line 1575 of file pcbnew.py.

◆ HasSelectedAncestorGroup()

pcbnew.EDA_ITEM.HasSelectedAncestorGroup ( self) 
HasSelectedAncestorGroup(EDA_ITEM self) -> bool

Definition at line 1491 of file pcbnew.py.

◆ HitTest()

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
    HitTest(EDA_ITEM self, SHAPE_LINE_CHAIN aPoly, bool aContained) -> bool

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

Definition at line 1627 of file pcbnew.py.

◆ IsBrightened()

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

Definition at line 1523 of file pcbnew.py.

◆ IsEntered()

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

Definition at line 1519 of file pcbnew.py.

◆ IsForceVisible()

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

Definition at line 1615 of file pcbnew.py.

◆ IsLocked()

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

Definition at line 1495 of file pcbnew.py.

◆ IsModified()

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

Definition at line 1503 of file pcbnew.py.

◆ IsMoving()

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

Definition at line 1511 of file pcbnew.py.

◆ IsNew()

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

Definition at line 1507 of file pcbnew.py.

◆ IsReplaceable()

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

Definition at line 1690 of file pcbnew.py.

◆ IsRollover()

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

Definition at line 1527 of file pcbnew.py.

◆ IsSelected()

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

Definition at line 1515 of file pcbnew.py.

◆ IsShownAsBitmap()

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

Definition at line 1603 of file pcbnew.py.

◆ IsType()

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

Definition at line 1607 of file pcbnew.py.

◆ Matches()

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

Definition at line 1679 of file pcbnew.py.

◆ PyGetClass()

pcbnew.EDA_ITEM.PyGetClass ( self) 
PyGetClass(EDA_ITEM self) -> wxString

Definition at line 1720 of file pcbnew.py.

◆ RenderAsBitmap()

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

Definition at line 1595 of file pcbnew.py.

◆ Replace()

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

◆ SetBrightened()

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

Definition at line 1543 of file pcbnew.py.

◆ SetFlags()

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

Definition at line 1559 of file pcbnew.py.

◆ SetForceVisible()

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

Definition at line 1611 of file pcbnew.py.

◆ SetIsRollover()

pcbnew.EDA_ITEM.SetIsRollover ( self,
aIsRollover,
aMousePos ) 
SetIsRollover(EDA_ITEM self, bool aIsRollover, VECTOR2I aMousePos)

Definition at line 1535 of file pcbnew.py.

◆ SetIsShownAsBitmap()

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

Definition at line 1599 of file pcbnew.py.

◆ SetLocked()

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

Definition at line 1499 of file pcbnew.py.

◆ SetModified()

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

Definition at line 1555 of file pcbnew.py.

◆ SetParent()

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

Reimplemented in pcbnew.NETINFO_ITEM.

Definition at line 1475 of file pcbnew.py.

◆ SetParentGroup()

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

Definition at line 1479 of file pcbnew.py.

◆ SetPosition()

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

Definition at line 1643 of file pcbnew.py.

◆ SetSelected()

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

Definition at line 1539 of file pcbnew.py.

◆ Sort()

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

Definition at line 1699 of file pcbnew.py.

◆ Type()

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

Definition at line 1467 of file pcbnew.py.

◆ ViewBBox()

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

Definition at line 1703 of file pcbnew.py.

◆ ViewGetLayers()

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

Definition at line 1707 of file pcbnew.py.

◆ Visit()

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

◆ XorFlags()

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

Definition at line 1563 of file pcbnew.py.

Property Documentation

◆ m_Uuid

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

Definition at line 1718 of file pcbnew.py.

◆ thisown

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

The documentation for this class was generated from the following file:
Generated on Thu Jul 30 2026 20:49:32 for KiCad Pcbnew Python Scripting by doxygen 1.13.2