KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
pcbnew.PCB_TABLE Class Reference
Inheritance diagram for pcbnew.PCB_TABLE:

Public Member Functions

 __init__ (self, *args)
 
 GetClass (self)
 
 SetStrokeExternal (self, aDoStroke)
 
 StrokeExternal (self)
 
 SetStrokeHeaderSeparator (self, aDoStroke)
 
 StrokeHeaderSeparator (self)
 
 SetBorderStroke (self, aParams)
 
 GetBorderStroke (self)
 
 SetBorderWidth (self, aWidth)
 
 GetBorderWidth (self)
 
 SetBorderStyle (self, aStyle)
 
 GetBorderStyle (self)
 
 SetBorderColor (self, aColor)
 
 GetBorderColor (self)
 
 SetSeparatorsStroke (self, aParams)
 
 GetSeparatorsStroke (self)
 
 SetSeparatorsWidth (self, aWidth)
 
 GetSeparatorsWidth (self)
 
 SetSeparatorsStyle (self, aStyle)
 
 GetSeparatorsStyle (self)
 
 SetSeparatorsColor (self, aColor)
 
 GetSeparatorsColor (self)
 
 SetStrokeColumns (self, aDoStroke)
 
 StrokeColumns (self)
 
 SetStrokeRows (self, aDoStroke)
 
 StrokeRows (self)
 
 GetEnd (self)
 
 SetPositionX (self, x)
 
 SetPositionY (self, y)
 
 GetPositionX (self)
 
 GetPositionY (self)
 
 SetColCount (self, aCount)
 
 GetColCount (self)
 
 GetRowCount (self)
 
 SetColWidth (self, aCol, aWidth)
 
 GetColWidth (self, aCol)
 
 SetRowHeight (self, aRow, aHeight)
 
 GetRowHeight (self, aRow)
 
 GetCell (self, aRow, aCol)
 
 GetCells (self)
 
 AddCell (self, aCell)
 
 InsertCell (self, aIdx, aCell)
 
 ClearCells (self)
 
 DeleteMarkedCells (self)
 
 AddNative (self, *args)
 
 RemoveNative (self, *args)
 
 Autosize (self)
 
 DrawBorders (self, aCallback)
 
 GetEffectiveShape (self, *args)
 
 TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aMaxError, aErrorLoc, aIgnoreLineWidth=False)
 
 TransformGraphicItemsToPolySet (self, aBuffer, aMaxError, aErrorLoc, aRenderSettings)
 
 HitTest (self, *args)
 
 __eq__ (self, *args)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM_CONTAINER
 __init__ (self, *args, **kwargs)
 
 DeleteNative (self, aItem)
 
 Add (self, item)
 
 Remove (self, item)
 
 Delete (self, item)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
 __init__ (self, *args, **kwargs)
 
 CopyFrom (self, aOther)
 
 IsGroupableType (self)
 
 GetX (self)
 
 GetY (self)
 
 GetCenter (self)
 
 SetX (self, aX)
 
 SetY (self, aY)
 
 IsConnected (self)
 
 Similarity (self, aItem)
 
 __eq__ (self, aItem)
 
 IsOnCopperLayer (self)
 
 HasHole (self)
 
 HasDrilledHole (self)
 
 IsTented (self, aLayer)
 
 GetEffectiveHoleShape (self)
 
 RunOnChildren (self, aFunction, aMode)
 
 GetParent (self)
 
 GetParentFootprint (self)
 
 GetFPRelativePosition (self)
 
 SetFPRelativePosition (self, aPos)
 
 HasLineStroke (self)
 
 GetStroke (self)
 
 SetStroke (self, aStroke)
 
 GetFontMetrics (self)
 
 GetLayer (self)
 
 BoardLayerCount (self)
 
 BoardCopperLayerCount (self)
 
 BoardLayerSet (self)
 
 GetLayerSet (self)
 
 SetLayerSet (self, aLayers)
 
 IsSideSpecific (self)
 
 SetLayer (self, aLayer)
 
 Duplicate (self, addToParentGroup, aCommit=None)
 
 SwapItemData (self, aImage)
 
 IsOnLayer (self, aLayer)
 
 IsKnockout (self)
 
 SetIsKnockout (self, aKnockout)
 
 GetMaxError (self)
 
 StyleFromSettings (self, settings, aCheckSide)
 
 DeleteStructure (self)
 
 Move (self, aMoveVector)
 
 Rotate (self, aRotCentre, aAngle)
 
 Flip (self, aCentre, aFlipDirection)
 
 Mirror (self, aCentre, aFlipDirection)
 
 Normalize (self)
 
 NormalizeForCompare (self)
 
 GetBoard (self, *args)
 
 GetParentAsString (self)
 
 GetLayerName (self)
 
 TransformShapeToPolySet (self, aBuffer, aLayer, aClearance, aError, aErrorLoc)
 
 LayerMaskDescribe (self)
 
 Cast (self)
 
 Duplicate (self)
 
 SetPos (self, p)
 
 SetStartEnd (self, start, end)
 
- Public Member Functions inherited from pcbnew.EDA_ITEM
 __init__ (self, *args, **kwargs)
 
 Type (self)
 
 SetParent (self, aParent)
 
 SetParentGroup (self, aGroup)
 
 GetParentGroup (self)
 
 GetParentGroupId (self)
 
 IsLocked (self)
 
 SetLocked (self, aLocked)
 
 IsModified (self)
 
 IsNew (self)
 
 IsMoving (self)
 
 IsSelected (self)
 
 IsEntered (self)
 
 IsBrightened (self)
 
 IsRollover (self)
 
 SetIsRollover (self, aIsRollover)
 
 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)
 
 GetBoundingBox (self)
 
 GetPosition (self)
 
 SetPosition (self, aPos)
 
 GetFocusPosition (self)
 
 GetSortPosition (self)
 
 Clone (self)
 
 Visit (self, inspector, testData, aScanTypes)
 
 GetTypeDesc (self)
 
 GetItemDescription (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)
 

Static Public Member Functions

 ClassOf (aItem)
 
 Compare (aTable, aOther)
 
- Static Public Member Functions inherited from pcbnew.EDA_ITEM
 Sort (aLeft, aRight)
 

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.BOARD_ITEM_CONTAINER
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.BOARD_ITEM
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.EDA_ITEM
 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=)
 

Additional Inherited Members

- Static Public Attributes inherited from pcbnew.BOARD_ITEM
 DRC = _pcbnew.BOARD_ITEM_DRC
 
 INSTANCE_TO_INSTANCE = _pcbnew.BOARD_ITEM_INSTANCE_TO_INSTANCE
 

Detailed Description

Proxy of C++ PCB_TABLE class.

Definition at line 18384 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

pcbnew.PCB_TABLE.__init__ ( self,
* args )
    __init__(PCB_TABLE self, BOARD_ITEM aParent, int aLineWidth) -> PCB_TABLE
    __init__(PCB_TABLE self, PCB_TABLE aTable) -> PCB_TABLE

Definition at line 18390 of file pcbnew.py.

Member Function Documentation

◆ __eq__()

pcbnew.PCB_TABLE.__eq__ ( self,
* args )
    __eq__(PCB_TABLE self, PCB_TABLE aOther) -> bool
    __eq__(PCB_TABLE self, BOARD_ITEM aBoardItem) -> bool

Definition at line 18611 of file pcbnew.py.

◆ AddCell()

pcbnew.PCB_TABLE.AddCell ( self,
aCell )
AddCell(PCB_TABLE self, PCB_TABLECELL * aCell)

Definition at line 18559 of file pcbnew.py.

◆ AddNative()

pcbnew.PCB_TABLE.AddNative ( self,
* args )
AddNative(PCB_TABLE self, BOARD_ITEM aItem, ADD_MODE aMode=INSERT, bool aSkipConnectivity=False)

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 18575 of file pcbnew.py.

◆ Autosize()

pcbnew.PCB_TABLE.Autosize ( self)
Autosize(PCB_TABLE self)

Definition at line 18583 of file pcbnew.py.

◆ ClassOf()

pcbnew.PCB_TABLE.ClassOf ( aItem)
static
ClassOf(EDA_ITEM aItem) -> bool

Definition at line 18399 of file pcbnew.py.

◆ ClearCells()

pcbnew.PCB_TABLE.ClearCells ( self)
ClearCells(PCB_TABLE self)

Definition at line 18567 of file pcbnew.py.

◆ Compare()

pcbnew.PCB_TABLE.Compare ( aTable,
aOther )
static
Compare(PCB_TABLE aTable, PCB_TABLE aOther) -> int

Definition at line 18619 of file pcbnew.py.

◆ DeleteMarkedCells()

pcbnew.PCB_TABLE.DeleteMarkedCells ( self)
DeleteMarkedCells(PCB_TABLE self)

Definition at line 18571 of file pcbnew.py.

◆ DrawBorders()

pcbnew.PCB_TABLE.DrawBorders ( self,
aCallback )
DrawBorders(PCB_TABLE self, std::function< void (VECTOR2I const &,VECTOR2I const &,STROKE_PARAMS const &) > const & aCallback)

Definition at line 18587 of file pcbnew.py.

◆ GetBorderColor()

pcbnew.PCB_TABLE.GetBorderColor ( self)
GetBorderColor(PCB_TABLE self) -> COLOR4D

Definition at line 18451 of file pcbnew.py.

◆ GetBorderStroke()

pcbnew.PCB_TABLE.GetBorderStroke ( self)
GetBorderStroke(PCB_TABLE self) -> STROKE_PARAMS const &

Definition at line 18427 of file pcbnew.py.

◆ GetBorderStyle()

pcbnew.PCB_TABLE.GetBorderStyle ( self)
GetBorderStyle(PCB_TABLE self) -> LINE_STYLE

Definition at line 18443 of file pcbnew.py.

◆ GetBorderWidth()

pcbnew.PCB_TABLE.GetBorderWidth ( self)
GetBorderWidth(PCB_TABLE self) -> int

Definition at line 18435 of file pcbnew.py.

◆ GetCell()

pcbnew.PCB_TABLE.GetCell ( self,
aRow,
aCol )
GetCell(PCB_TABLE self, int aRow, int aCol) -> PCB_TABLECELL *

Definition at line 18551 of file pcbnew.py.

◆ GetCells()

pcbnew.PCB_TABLE.GetCells ( self)
GetCells(PCB_TABLE self) -> std::vector< PCB_TABLECELL *,std::allocator< PCB_TABLECELL * > >

Definition at line 18555 of file pcbnew.py.

◆ GetClass()

pcbnew.PCB_TABLE.GetClass ( self)
GetClass(PCB_TABLE self) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 18403 of file pcbnew.py.

◆ GetColCount()

pcbnew.PCB_TABLE.GetColCount ( self)
GetColCount(PCB_TABLE self) -> int

Definition at line 18527 of file pcbnew.py.

◆ GetColWidth()

pcbnew.PCB_TABLE.GetColWidth ( self,
aCol )
GetColWidth(PCB_TABLE self, int aCol) -> int

Definition at line 18539 of file pcbnew.py.

◆ GetEffectiveShape()

pcbnew.PCB_TABLE.GetEffectiveShape ( self,
* args )
GetEffectiveShape(PCB_TABLE self, PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=DEFAULT) -> std::shared_ptr< SHAPE >

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 18591 of file pcbnew.py.

◆ GetEnd()

pcbnew.PCB_TABLE.GetEnd ( self)
GetEnd(PCB_TABLE self) -> VECTOR2I

Definition at line 18503 of file pcbnew.py.

◆ GetPositionX()

pcbnew.PCB_TABLE.GetPositionX ( self)
GetPositionX(PCB_TABLE self) -> int

Definition at line 18515 of file pcbnew.py.

◆ GetPositionY()

pcbnew.PCB_TABLE.GetPositionY ( self)
GetPositionY(PCB_TABLE self) -> int

Definition at line 18519 of file pcbnew.py.

◆ GetRowCount()

pcbnew.PCB_TABLE.GetRowCount ( self)
GetRowCount(PCB_TABLE self) -> int

Definition at line 18531 of file pcbnew.py.

◆ GetRowHeight()

pcbnew.PCB_TABLE.GetRowHeight ( self,
aRow )
GetRowHeight(PCB_TABLE self, int aRow) -> int

Definition at line 18547 of file pcbnew.py.

◆ GetSeparatorsColor()

pcbnew.PCB_TABLE.GetSeparatorsColor ( self)
GetSeparatorsColor(PCB_TABLE self) -> COLOR4D

Definition at line 18483 of file pcbnew.py.

◆ GetSeparatorsStroke()

pcbnew.PCB_TABLE.GetSeparatorsStroke ( self)
GetSeparatorsStroke(PCB_TABLE self) -> STROKE_PARAMS const &

Definition at line 18459 of file pcbnew.py.

◆ GetSeparatorsStyle()

pcbnew.PCB_TABLE.GetSeparatorsStyle ( self)
GetSeparatorsStyle(PCB_TABLE self) -> LINE_STYLE

Definition at line 18475 of file pcbnew.py.

◆ GetSeparatorsWidth()

pcbnew.PCB_TABLE.GetSeparatorsWidth ( self)
GetSeparatorsWidth(PCB_TABLE self) -> int

Definition at line 18467 of file pcbnew.py.

◆ HitTest()

pcbnew.PCB_TABLE.HitTest ( self,
* args )
    HitTest(PCB_TABLE self, VECTOR2I aPosition, int aAccuracy=0) -> bool
    HitTest(PCB_TABLE self, BOX2I aRect, bool aContained, int aAccuracy=0) -> bool
    HitTest(PCB_TABLE self, SHAPE_LINE_CHAIN aPoly, bool aContained) -> bool

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 18603 of file pcbnew.py.

◆ InsertCell()

pcbnew.PCB_TABLE.InsertCell ( self,
aIdx,
aCell )
InsertCell(PCB_TABLE self, int aIdx, PCB_TABLECELL * aCell)

Definition at line 18563 of file pcbnew.py.

◆ RemoveNative()

pcbnew.PCB_TABLE.RemoveNative ( self,
* args )
RemoveNative(PCB_TABLE self, BOARD_ITEM aItem, REMOVE_MODE aMode=NORMAL)

Reimplemented from pcbnew.BOARD_ITEM_CONTAINER.

Definition at line 18579 of file pcbnew.py.

◆ SetBorderColor()

pcbnew.PCB_TABLE.SetBorderColor ( self,
aColor )
SetBorderColor(PCB_TABLE self, COLOR4D aColor)

Definition at line 18447 of file pcbnew.py.

◆ SetBorderStroke()

pcbnew.PCB_TABLE.SetBorderStroke ( self,
aParams )
SetBorderStroke(PCB_TABLE self, STROKE_PARAMS const & aParams)

Definition at line 18423 of file pcbnew.py.

◆ SetBorderStyle()

pcbnew.PCB_TABLE.SetBorderStyle ( self,
aStyle )
SetBorderStyle(PCB_TABLE self, LINE_STYLE const aStyle)

Definition at line 18439 of file pcbnew.py.

◆ SetBorderWidth()

pcbnew.PCB_TABLE.SetBorderWidth ( self,
aWidth )
SetBorderWidth(PCB_TABLE self, int aWidth)

Definition at line 18431 of file pcbnew.py.

◆ SetColCount()

pcbnew.PCB_TABLE.SetColCount ( self,
aCount )
SetColCount(PCB_TABLE self, int aCount)

Definition at line 18523 of file pcbnew.py.

◆ SetColWidth()

pcbnew.PCB_TABLE.SetColWidth ( self,
aCol,
aWidth )
SetColWidth(PCB_TABLE self, int aCol, int aWidth)

Definition at line 18535 of file pcbnew.py.

◆ SetPositionX()

pcbnew.PCB_TABLE.SetPositionX ( self,
x )
SetPositionX(PCB_TABLE self, int x)

Definition at line 18507 of file pcbnew.py.

◆ SetPositionY()

pcbnew.PCB_TABLE.SetPositionY ( self,
y )
SetPositionY(PCB_TABLE self, int y)

Definition at line 18511 of file pcbnew.py.

◆ SetRowHeight()

pcbnew.PCB_TABLE.SetRowHeight ( self,
aRow,
aHeight )
SetRowHeight(PCB_TABLE self, int aRow, int aHeight)

Definition at line 18543 of file pcbnew.py.

◆ SetSeparatorsColor()

pcbnew.PCB_TABLE.SetSeparatorsColor ( self,
aColor )
SetSeparatorsColor(PCB_TABLE self, COLOR4D aColor)

Definition at line 18479 of file pcbnew.py.

◆ SetSeparatorsStroke()

pcbnew.PCB_TABLE.SetSeparatorsStroke ( self,
aParams )
SetSeparatorsStroke(PCB_TABLE self, STROKE_PARAMS const & aParams)

Definition at line 18455 of file pcbnew.py.

◆ SetSeparatorsStyle()

pcbnew.PCB_TABLE.SetSeparatorsStyle ( self,
aStyle )
SetSeparatorsStyle(PCB_TABLE self, LINE_STYLE const aStyle)

Definition at line 18471 of file pcbnew.py.

◆ SetSeparatorsWidth()

pcbnew.PCB_TABLE.SetSeparatorsWidth ( self,
aWidth )
SetSeparatorsWidth(PCB_TABLE self, int aWidth)

Definition at line 18463 of file pcbnew.py.

◆ SetStrokeColumns()

pcbnew.PCB_TABLE.SetStrokeColumns ( self,
aDoStroke )
SetStrokeColumns(PCB_TABLE self, bool aDoStroke)

Definition at line 18487 of file pcbnew.py.

◆ SetStrokeExternal()

pcbnew.PCB_TABLE.SetStrokeExternal ( self,
aDoStroke )
SetStrokeExternal(PCB_TABLE self, bool aDoStroke)

Definition at line 18407 of file pcbnew.py.

◆ SetStrokeHeaderSeparator()

pcbnew.PCB_TABLE.SetStrokeHeaderSeparator ( self,
aDoStroke )
SetStrokeHeaderSeparator(PCB_TABLE self, bool aDoStroke)

Definition at line 18415 of file pcbnew.py.

◆ SetStrokeRows()

pcbnew.PCB_TABLE.SetStrokeRows ( self,
aDoStroke )
SetStrokeRows(PCB_TABLE self, bool aDoStroke)

Definition at line 18495 of file pcbnew.py.

◆ StrokeColumns()

pcbnew.PCB_TABLE.StrokeColumns ( self)
StrokeColumns(PCB_TABLE self) -> bool

Definition at line 18491 of file pcbnew.py.

◆ StrokeExternal()

pcbnew.PCB_TABLE.StrokeExternal ( self)
StrokeExternal(PCB_TABLE self) -> bool

Definition at line 18411 of file pcbnew.py.

◆ StrokeHeaderSeparator()

pcbnew.PCB_TABLE.StrokeHeaderSeparator ( self)
StrokeHeaderSeparator(PCB_TABLE self) -> bool

Definition at line 18419 of file pcbnew.py.

◆ StrokeRows()

pcbnew.PCB_TABLE.StrokeRows ( self)
StrokeRows(PCB_TABLE self) -> bool

Definition at line 18499 of file pcbnew.py.

◆ TransformGraphicItemsToPolySet()

pcbnew.PCB_TABLE.TransformGraphicItemsToPolySet ( self,
aBuffer,
aMaxError,
aErrorLoc,
aRenderSettings )
TransformGraphicItemsToPolySet(PCB_TABLE self, SHAPE_POLY_SET aBuffer, int aMaxError, ERROR_LOC aErrorLoc, KIGFX::RENDER_SETTINGS * aRenderSettings)

Definition at line 18599 of file pcbnew.py.

◆ TransformShapeToPolygon()

pcbnew.PCB_TABLE.TransformShapeToPolygon ( self,
aBuffer,
aLayer,
aClearance,
aMaxError,
aErrorLoc,
aIgnoreLineWidth = False )
TransformShapeToPolygon(PCB_TABLE self, SHAPE_POLY_SET aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc, bool aIgnoreLineWidth=False)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 18595 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 18387 of file pcbnew.py.


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