![]() |
KiCad Pcbnew Python Scripting
|

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=) | |
| def pcbnew.EDA_ITEM.__init__ | ( | self, | |
| * | args, | ||
| ** | kwargs | ||
| ) |
Reimplemented in pcbnew.DELETED_BOARD_ITEM, pcbnew.PCB_VIA, pcbnew.PCB_DIM_ORTHOGONAL, pcbnew.PCB_DIM_LEADER, pcbnew.PCB_DIM_CENTER, pcbnew.PCB_GROUP, pcbnew.PCB_DIM_ALIGNED, pcbnew.PCB_TRACK, pcbnew.PCB_TEXT, pcbnew.PCB_MARKER, pcbnew.PAD, pcbnew.PCB_ARC, pcbnew.ZONE, pcbnew.FP_ZONE, pcbnew.PCB_SHAPE, pcbnew.PCB_TARGET, pcbnew.FP_SHAPE, pcbnew.FP_TEXT, pcbnew.NETINFO_ITEM, pcbnew.BOARD, pcbnew.FOOTPRINT, pcbnew.BOARD_ITEM, pcbnew.BOARD_ITEM_CONTAINER, pcbnew.BOARD_CONNECTED_ITEM, pcbnew.PCB_DIMENSION_BASE, and pcbnew.BOARD.
| "bool" pcbnew.EDA_ITEM.__lt__ | ( | self, | |
| "EDA_ITEM" | aItem | ||
| ) |
| "void" pcbnew.EDA_ITEM.ClearBrightened | ( | self | ) |
| "void" pcbnew.EDA_ITEM.ClearEditFlags | ( | self | ) |
| "void" pcbnew.EDA_ITEM.ClearFlags | ( | self, | |
| * | args | ||
| ) |
| "void" pcbnew.EDA_ITEM.ClearSelected | ( | self | ) |
| "void" pcbnew.EDA_ITEM.ClearTempFlags | ( | self | ) |
| "EDA_ITEM *" pcbnew.EDA_ITEM.Clone | ( | self | ) |
Clone(EDA_ITEM self) -> EDA_ITEM
Reimplemented in pcbnew.PAD, pcbnew.PCB_TRACK, pcbnew.PCB_ARC, pcbnew.PCB_VIA, pcbnew.ZONE, pcbnew.FP_ZONE, pcbnew.PCB_SHAPE, pcbnew.PCB_TEXT, pcbnew.PCB_DIM_ALIGNED, pcbnew.PCB_DIM_ORTHOGONAL, pcbnew.PCB_DIM_LEADER, pcbnew.PCB_DIM_CENTER, pcbnew.PCB_MARKER, pcbnew.PCB_TARGET, pcbnew.FP_SHAPE, pcbnew.FP_TEXT, pcbnew.NETINFO_ITEM, pcbnew.PCB_GROUP, and pcbnew.FOOTPRINT.
Definition at line 1570 of file pcbnew.py.

| "EDA_RECT const" pcbnew.EDA_ITEM.GetBoundingBox | ( | self | ) |
GetBoundingBox(EDA_ITEM self) -> EDA_RECT
Reimplemented in pcbnew.PAD, pcbnew.PCB_TRACK, pcbnew.ZONE, pcbnew.PCB_SHAPE, pcbnew.PCB_TEXT, pcbnew.PCB_DIMENSION_BASE, pcbnew.PCB_DIM_CENTER, pcbnew.PCB_MARKER, pcbnew.PCB_TARGET, pcbnew.FP_TEXT, pcbnew.PCB_GROUP, pcbnew.BOARD, and pcbnew.FOOTPRINT.
| "wxString" pcbnew.EDA_ITEM.GetClass | ( | self | ) |
GetClass(EDA_ITEM self) -> wxString
Reimplemented in pcbnew.DELETED_BOARD_ITEM, pcbnew.PAD, pcbnew.PCB_TRACK, pcbnew.PCB_ARC, pcbnew.PCB_VIA, pcbnew.ZONE, pcbnew.PCB_SHAPE, pcbnew.PCB_TEXT, pcbnew.PCB_DIM_ALIGNED, pcbnew.PCB_DIM_ORTHOGONAL, pcbnew.PCB_DIM_LEADER, pcbnew.PCB_DIM_CENTER, 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 1578 of file pcbnew.py.

| "EDA_ITEM_FLAGS" pcbnew.EDA_ITEM.GetEditFlags | ( | self | ) |
| "EDA_ITEM_FLAGS" pcbnew.EDA_ITEM.GetFlags | ( | self | ) |
| "wxPoint const" pcbnew.EDA_ITEM.GetFocusPosition | ( | self | ) |
GetFocusPosition(EDA_ITEM self) -> wxPoint
Reimplemented in pcbnew.PCB_TRACK, pcbnew.PCB_SHAPE, and pcbnew.BOARD.
| "BITMAPS" pcbnew.EDA_ITEM.GetMenuImage | ( | self | ) |
GetMenuImage(EDA_ITEM self) -> BITMAPS
Reimplemented in pcbnew.PAD, pcbnew.PCB_TRACK, pcbnew.PCB_VIA, pcbnew.ZONE, pcbnew.PCB_SHAPE, pcbnew.PCB_TEXT, pcbnew.PCB_DIM_ALIGNED, pcbnew.PCB_DIM_ORTHOGONAL, pcbnew.PCB_DIM_LEADER, pcbnew.PCB_DIM_CENTER, pcbnew.PCB_MARKER, pcbnew.PCB_TARGET, pcbnew.FP_SHAPE, pcbnew.FP_TEXT, pcbnew.PCB_GROUP, and pcbnew.FOOTPRINT.
| "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.
| "EDA_ITEM *" pcbnew.EDA_ITEM.GetParent | ( | self | ) |
GetParent(EDA_ITEM self) -> EDA_ITEM
Reimplemented in pcbnew.BOARD_ITEM, pcbnew.PAD, and pcbnew.NETINFO_ITEM.
| "wxPoint" pcbnew.EDA_ITEM.GetPosition | ( | self | ) |
GetPosition(EDA_ITEM self) -> wxPoint
Reimplemented in pcbnew.DELETED_BOARD_ITEM, 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_MARKER, pcbnew.PCB_TARGET, pcbnew.FP_TEXT, pcbnew.NETINFO_ITEM, pcbnew.PCB_GROUP, pcbnew.BOARD, and pcbnew.FOOTPRINT.
| "wxString" pcbnew.EDA_ITEM.GetSelectMenuText | ( | self, | |
| "EDA_UNITS" | aUnits | ||
| ) |
GetSelectMenuText(EDA_ITEM self, EDA_UNITS aUnits) -> wxString
Reimplemented in pcbnew.DELETED_BOARD_ITEM, pcbnew.PAD, pcbnew.PCB_TRACK, pcbnew.PCB_VIA, pcbnew.ZONE, pcbnew.PCB_SHAPE, pcbnew.PCB_TEXT, pcbnew.PCB_DIMENSION_BASE, pcbnew.PCB_MARKER, pcbnew.PCB_TARGET, pcbnew.FP_SHAPE, pcbnew.FP_TEXT, pcbnew.PCB_GROUP, pcbnew.BOARD, and pcbnew.FOOTPRINT.
| "int" pcbnew.EDA_ITEM.GetState | ( | self, | |
| "EDA_ITEM_FLAGS" | type | ||
| ) |
| "EDA_ITEM_FLAGS" pcbnew.EDA_ITEM.GetStatus | ( | self | ) |
| "bool" pcbnew.EDA_ITEM.HasFlag | ( | self, | |
| "EDA_ITEM_FLAGS" | aFlag | ||
| ) |
| "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.

| "bool" pcbnew.EDA_ITEM.IsBrightened | ( | self | ) |
| "bool" pcbnew.EDA_ITEM.IsDragging | ( | self | ) |
| "bool" pcbnew.EDA_ITEM.IsEntered | ( | self | ) |
| "bool" pcbnew.EDA_ITEM.IsForceVisible | ( | self | ) |
| "bool" pcbnew.EDA_ITEM.IsModified | ( | self | ) |
| "bool" pcbnew.EDA_ITEM.IsMoving | ( | self | ) |
| "bool" pcbnew.EDA_ITEM.IsNew | ( | self | ) |
| "bool" pcbnew.EDA_ITEM.IsReplaceable | ( | self | ) |
| "bool" pcbnew.EDA_ITEM.IsResized | ( | self | ) |
| "bool" pcbnew.EDA_ITEM.IsSelected | ( | self | ) |
| "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.
| "bool" pcbnew.EDA_ITEM.IsWireImage | ( | self | ) |
| "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.
| "bool" pcbnew.EDA_ITEM.Replace | ( | self, | |
| * | args | ||
| ) |
| "void" pcbnew.EDA_ITEM.SetBrightened | ( | self | ) |
| "void" pcbnew.EDA_ITEM.SetFlags | ( | self, | |
| "EDA_ITEM_FLAGS" | aMask | ||
| ) |
| "void" pcbnew.EDA_ITEM.SetForceVisible | ( | self, | |
| "bool" | aEnable | ||
| ) |
| "void" pcbnew.EDA_ITEM.SetModified | ( | self | ) |
| "void" pcbnew.EDA_ITEM.SetParent | ( | self, | |
| "EDA_ITEM" | aParent | ||
| ) |
SetParent(EDA_ITEM self, EDA_ITEM aParent)
Reimplemented in pcbnew.PCB_DIMENSION_BASE.
| "void" pcbnew.EDA_ITEM.SetPosition | ( | self, | |
| "wxPoint" | aPos | ||
| ) |
SetPosition(EDA_ITEM self, wxPoint aPos)
Reimplemented in pcbnew.PCB_GROUP, pcbnew.PCB_VIA, pcbnew.PAD, pcbnew.PCB_TRACK, pcbnew.PCB_ARC, pcbnew.ZONE, pcbnew.PCB_SHAPE, pcbnew.PCB_TEXT, pcbnew.PCB_DIMENSION_BASE, pcbnew.PCB_MARKER, pcbnew.PCB_TARGET, pcbnew.FP_TEXT, pcbnew.NETINFO_ITEM, pcbnew.BOARD, pcbnew.FOOTPRINT, and pcbnew.DELETED_BOARD_ITEM.
Definition at line 1562 of file pcbnew.py.

| "void" pcbnew.EDA_ITEM.SetSelected | ( | self | ) |
| "void" pcbnew.EDA_ITEM.SetState | ( | self, | |
| "EDA_ITEM_FLAGS" | type, | ||
| "bool" | state | ||
| ) |
| "void" pcbnew.EDA_ITEM.SetStatus | ( | self, | |
| "EDA_ITEM_FLAGS" | aStatus | ||
| ) |
| "void" pcbnew.EDA_ITEM.SetWireImage | ( | self | ) |
|
static |
| "KICAD_T" pcbnew.EDA_ITEM.Type | ( | self | ) |
| "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.
| "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.
| "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.
|
static |
|
static |