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
[legend]

Public Member Functions

def __init__ (self, *args, **kwargs)
 
"KICAD_T" Type (self)
 
"EDA_ITEM *" GetParent (self)
 
"void" SetParent (self, "EDA_ITEM" aParent)
 
"bool" IsModified (self)
 
"bool" IsNew (self)
 
"bool" IsMoving (self)
 
"bool" IsDragging (self)
 
"bool" IsWireImage (self)
 
"bool" IsSelected (self)
 
"bool" IsEntered (self)
 
"bool" IsResized (self)
 
"bool" IsBrightened (self)
 
"void" SetWireImage (self)
 
"void" SetSelected (self)
 
"void" SetBrightened (self)
 
"void" ClearSelected (self)
 
"void" ClearBrightened (self)
 
"void" SetModified (self)
 
"int" GetState (self, "EDA_ITEM_FLAGS" type)
 
"void" SetState (self, "EDA_ITEM_FLAGS" type, "bool" state)
 
"EDA_ITEM_FLAGS" GetStatus (self)
 
"void" SetStatus (self, "EDA_ITEM_FLAGS" aStatus)
 
"void" SetFlags (self, "EDA_ITEM_FLAGS" aMask)
 
"void" ClearFlags (self, *args)
 
"EDA_ITEM_FLAGS" GetFlags (self)
 
"bool" HasFlag (self, "EDA_ITEM_FLAGS" aFlag)
 
"EDA_ITEM_FLAGS" GetEditFlags (self)
 
"void" ClearTempFlags (self)
 
"void" ClearEditFlags (self)
 
"bool" IsType (self, "KICAD_T const []" aScanTypes)
 
"void" SetForceVisible (self, "bool" aEnable)
 
"bool" IsForceVisible (self)
 
"void" GetMsgPanelInfo (self, "EDA_DRAW_FRAME *" aFrame, "std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &" aList)
 
"bool" HitTest (self, *args)
 
"EDA_RECT const" GetBoundingBox (self)
 
"wxPoint" GetPosition (self)
 
"void" SetPosition (self, "wxPoint" aPos)
 
"wxPoint const" GetFocusPosition (self)
 
"EDA_ITEM *" Clone (self)
 
"SEARCH_RESULT" Visit (self, "INSPECTOR" inspector, "void *" testData, "KICAD_T const []" scanTypes)
 
"wxString" GetClass (self)
 
"wxString" GetSelectMenuText (self, "EDA_UNITS" aUnits)
 
"BITMAPS" GetMenuImage (self)
 
"bool" Matches (self, "wxFindReplaceData const &" aSearchData, "void *" aAuxData)
 
"bool" Replace (self, *args)
 
"bool" IsReplaceable (self)
 
"bool" __lt__ (self, "EDA_ITEM" aItem)
 
"BOX2I const" ViewBBox (self)
 
"void" ViewGetLayers (self, "int []" aLayers, "int &" aCount)
 

Static Public Member Functions

"bool" Sort ("EDA_ITEM" aLeft, "EDA_ITEM" 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 1405 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

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

Member Function Documentation

◆ __lt__()

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

Definition at line 1605 of file pcbnew.py.

◆ ClearBrightened()

"void" pcbnew.EDA_ITEM.ClearBrightened (   self)
ClearBrightened(EDA_ITEM self)

Definition at line 1479 of file pcbnew.py.

◆ ClearEditFlags()

"void" pcbnew.EDA_ITEM.ClearEditFlags (   self)
ClearEditFlags(EDA_ITEM self)

Definition at line 1527 of file pcbnew.py.

◆ ClearFlags()

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

Definition at line 1507 of file pcbnew.py.

◆ ClearSelected()

"void" pcbnew.EDA_ITEM.ClearSelected (   self)
ClearSelected(EDA_ITEM self)

Definition at line 1475 of file pcbnew.py.

◆ ClearTempFlags()

"void" pcbnew.EDA_ITEM.ClearTempFlags (   self)
ClearTempFlags(EDA_ITEM self)

Definition at line 1523 of file pcbnew.py.

◆ Clone()

"EDA_ITEM *" pcbnew.EDA_ITEM.Clone (   self)

◆ GetBoundingBox()

"EDA_RECT const" pcbnew.EDA_ITEM.GetBoundingBox (   self)

◆ GetClass()

"wxString" pcbnew.EDA_ITEM.GetClass (   self)

◆ GetEditFlags()

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

Definition at line 1519 of file pcbnew.py.

◆ GetFlags()

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

Definition at line 1511 of file pcbnew.py.

◆ GetFocusPosition()

"wxPoint const" pcbnew.EDA_ITEM.GetFocusPosition (   self)
GetFocusPosition(EDA_ITEM self) -> wxPoint

Reimplemented in pcbnew.PCB_TRACK, pcbnew.PCB_SHAPE, and pcbnew.BOARD.

Definition at line 1566 of file pcbnew.py.

◆ GetMenuImage()

"BITMAPS" pcbnew.EDA_ITEM.GetMenuImage (   self)

◆ GetMsgPanelInfo()

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

Reimplemented in pcbnew.PAD, pcbnew.PCB_TRACK, pcbnew.PCB_VIA, pcbnew.ZONE, pcbnew.PCB_SHAPE, pcbnew.PCB_TEXT, pcbnew.PCB_DIMENSION_BASE, pcbnew.PCB_DIM_ALIGNED, pcbnew.PCB_DIM_LEADER, pcbnew.PCB_MARKER, pcbnew.PCB_TARGET, pcbnew.FP_SHAPE, pcbnew.FP_TEXT, pcbnew.NETINFO_ITEM, pcbnew.PCB_GROUP, pcbnew.BOARD, and pcbnew.FOOTPRINT.

Definition at line 1543 of file pcbnew.py.

◆ GetParent()

"EDA_ITEM *" 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 1419 of file pcbnew.py.

◆ GetPosition()

"wxPoint" pcbnew.EDA_ITEM.GetPosition (   self)

◆ GetSelectMenuText()

"wxString" pcbnew.EDA_ITEM.GetSelectMenuText (   self,
"EDA_UNITS"  aUnits 
)

◆ GetState()

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

Definition at line 1487 of file pcbnew.py.

◆ GetStatus()

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

Definition at line 1495 of file pcbnew.py.

◆ HasFlag()

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

Definition at line 1515 of file pcbnew.py.

◆ HitTest()

"bool" pcbnew.EDA_ITEM.HitTest (   self,
args 
)
    HitTest(EDA_ITEM self, wxPoint aPosition, int aAccuracy=0) -> bool
    HitTest(EDA_ITEM self, EDA_RECT aRect, bool aContained, int aAccuracy=0) -> bool

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

Definition at line 1547 of file pcbnew.py.

Here is the caller graph for this function:

◆ IsBrightened()

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

Definition at line 1459 of file pcbnew.py.

◆ IsDragging()

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

Definition at line 1439 of file pcbnew.py.

◆ IsEntered()

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

Definition at line 1451 of file pcbnew.py.

◆ IsForceVisible()

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

Definition at line 1539 of file pcbnew.py.

◆ IsModified()

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

Definition at line 1427 of file pcbnew.py.

◆ IsMoving()

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

Definition at line 1435 of file pcbnew.py.

◆ IsNew()

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

Definition at line 1431 of file pcbnew.py.

◆ IsReplaceable()

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

Definition at line 1601 of file pcbnew.py.

◆ IsResized()

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

Definition at line 1455 of file pcbnew.py.

◆ IsSelected()

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

Definition at line 1447 of file pcbnew.py.

◆ IsType()

"bool" pcbnew.EDA_ITEM.IsType (   self,
"KICAD_T const []"  aScanTypes 
)
IsType(EDA_ITEM self, KICAD_T const [] aScanTypes) -> bool

Reimplemented in pcbnew.PAD, pcbnew.PCB_VIA, pcbnew.PCB_SHAPE, pcbnew.PCB_TEXT, pcbnew.PCB_DIMENSION_BASE, pcbnew.FP_SHAPE, and pcbnew.FP_TEXT.

Definition at line 1531 of file pcbnew.py.

◆ IsWireImage()

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

Definition at line 1443 of file pcbnew.py.

◆ Matches()

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

Reimplemented in pcbnew.ZONE, pcbnew.PCB_TEXT, pcbnew.PCB_MARKER, and pcbnew.FP_TEXT.

Definition at line 1590 of file pcbnew.py.

◆ Replace()

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

Definition at line 1594 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetBrightened()

"void" pcbnew.EDA_ITEM.SetBrightened (   self)
SetBrightened(EDA_ITEM self)

Definition at line 1471 of file pcbnew.py.

◆ SetFlags()

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

Definition at line 1503 of file pcbnew.py.

◆ SetForceVisible()

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

Definition at line 1535 of file pcbnew.py.

◆ SetModified()

"void" pcbnew.EDA_ITEM.SetModified (   self)
SetModified(EDA_ITEM self)

Definition at line 1483 of file pcbnew.py.

◆ SetParent()

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

Reimplemented in pcbnew.PCB_DIMENSION_BASE.

Definition at line 1423 of file pcbnew.py.

◆ SetPosition()

"void" pcbnew.EDA_ITEM.SetPosition (   self,
"wxPoint"  aPos 
)

◆ SetSelected()

"void" pcbnew.EDA_ITEM.SetSelected (   self)
SetSelected(EDA_ITEM self)

Definition at line 1467 of file pcbnew.py.

◆ SetState()

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

Definition at line 1491 of file pcbnew.py.

◆ SetStatus()

"void" pcbnew.EDA_ITEM.SetStatus (   self,
"EDA_ITEM_FLAGS"  aStatus 
)
SetStatus(EDA_ITEM self, EDA_ITEM_FLAGS aStatus)

Definition at line 1499 of file pcbnew.py.

◆ SetWireImage()

"void" pcbnew.EDA_ITEM.SetWireImage (   self)
SetWireImage(EDA_ITEM self)

Definition at line 1463 of file pcbnew.py.

◆ Sort()

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

Definition at line 1610 of file pcbnew.py.

◆ Type()

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

Definition at line 1415 of file pcbnew.py.

◆ ViewBBox()

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

Reimplemented in pcbnew.PAD, pcbnew.PCB_TRACK, pcbnew.PCB_SHAPE, pcbnew.PCB_DIMENSION_BASE, pcbnew.PCB_DIM_CENTER, pcbnew.PCB_MARKER, pcbnew.FP_TEXT, and pcbnew.FOOTPRINT.

Definition at line 1614 of file pcbnew.py.

◆ ViewGetLayers()

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

Reimplemented in pcbnew.BOARD_ITEM, pcbnew.PAD, pcbnew.PCB_TRACK, pcbnew.PCB_VIA, pcbnew.ZONE, pcbnew.PCB_MARKER, pcbnew.FP_TEXT, pcbnew.PCB_GROUP, and pcbnew.FOOTPRINT.

Definition at line 1618 of file pcbnew.py.

◆ Visit()

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

Reimplemented in pcbnew.PCB_GROUP, pcbnew.PCB_TRACK, pcbnew.BOARD, and pcbnew.FOOTPRINT.

Definition at line 1574 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 1621 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 1408 of file pcbnew.py.


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