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

◆ ClearBrightened()

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

Definition at line 1493 of file pcbnew.py.

◆ ClearEditFlags()

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

Definition at line 1525 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 1509 of file pcbnew.py.

◆ ClearSelected()

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

Definition at line 1489 of file pcbnew.py.

◆ ClearTempFlags()

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

Definition at line 1533 of file pcbnew.py.

◆ Clone()

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

Definition at line 1596 of file pcbnew.py.

◆ GetBoundingBox()

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

Reimplemented in pcbnew.FOOTPRINT.

Definition at line 1576 of file pcbnew.py.

◆ GetClass()

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

Definition at line 1604 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 1521 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 1652 of file pcbnew.py.

◆ GetFlags()

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

Definition at line 1513 of file pcbnew.py.

◆ GetFocusPosition()

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

Definition at line 1588 of file pcbnew.py.

◆ GetFriendlyName()

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

Definition at line 1565 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 1612 of file pcbnew.py.

◆ GetMenuImage()

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

Definition at line 1616 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 1561 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 1445 of file pcbnew.py.

◆ GetPosition()

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

Definition at line 1580 of file pcbnew.py.

◆ GetSortPosition()

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

Definition at line 1592 of file pcbnew.py.

◆ GetTempFlags()

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

Definition at line 1529 of file pcbnew.py.

◆ GetTypeDesc()

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

Definition at line 1608 of file pcbnew.py.

◆ HasFlag()

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

Definition at line 1517 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 1569 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 1473 of file pcbnew.py.

◆ IsEntered()

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

Definition at line 1469 of file pcbnew.py.

◆ IsForceVisible()

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

Definition at line 1557 of file pcbnew.py.

◆ IsModified()

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

Definition at line 1453 of file pcbnew.py.

◆ IsMoving()

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

Definition at line 1461 of file pcbnew.py.

◆ IsNew()

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

Definition at line 1457 of file pcbnew.py.

◆ IsReplaceable()

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

Definition at line 1631 of file pcbnew.py.

◆ IsRollover()

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

Definition at line 1477 of file pcbnew.py.

◆ IsSelected()

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

Definition at line 1465 of file pcbnew.py.

◆ IsShownAsBitmap()

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

Definition at line 1545 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 1549 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 1620 of file pcbnew.py.

◆ RenderAsBitmap()

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

Definition at line 1537 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 1624 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 1485 of file pcbnew.py.

◆ SetFlags()

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

Definition at line 1501 of file pcbnew.py.

◆ SetForceVisible()

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

Definition at line 1553 of file pcbnew.py.

◆ SetIsShownAsBitmap()

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

Definition at line 1541 of file pcbnew.py.

◆ SetModified()

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

Definition at line 1497 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 1449 of file pcbnew.py.

◆ SetPosition()

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

Definition at line 1584 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 1481 of file pcbnew.py.

◆ Sort()

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

Definition at line 1640 of file pcbnew.py.

◆ Type()

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

Definition at line 1441 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 1644 of file pcbnew.py.

◆ ViewGetLayers()

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

Definition at line 1648 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 1600 of file pcbnew.py.

◆ XorFlags()

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

Definition at line 1505 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 1655 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 1434 of file pcbnew.py.


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