KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Properties | List of all members
pcbnew.PCB_TEXTBOX Class Reference
Inheritance diagram for pcbnew.PCB_TEXTBOX:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, aParent, aType=PCB_TEXTBOX_T)
 
def GetLegacyTextMargin (self)
 
def SetMarginLeft (self, aLeft)
 
def SetMarginTop (self, aTop)
 
def SetMarginRight (self, aRight)
 
def SetMarginBottom (self, aBottom)
 
def GetMarginLeft (self)
 
def GetMarginTop (self)
 
def GetMarginRight (self)
 
def GetMarginBottom (self)
 
def GetShownText (self, aAllowExtraText, aDepth=0)
 
def GetAnchorAndOppositeCorner (self)
 
def HitTest (self, *args)
 
def TransformTextToPolySet (self, aBuffer, aClearance, aMaxError, aErrorLoc)
 
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aMaxError, aErrorLoc, aIgnoreLineWidth=False)
 
def GetEffectiveShape (self, *args)
 
def ViewGetLOD (self, aLayer, aView)
 
def IsBorderEnabled (self)
 
def SetBorderEnabled (self, enabled)
 
def SetBorderWidth (self, aSize)
 
def GetBorderWidth (self)
 
- Public Member Functions inherited from pcbnew.PCB_SHAPE
def __init__ (self, *args)
 
def Serialize (self, aContainer)
 
def Deserialize (self, aContainer)
 
def GetConnectionPoints (self)
 
def GetCorners (self)
 
def GetEffectiveShape (self, *args)
 
def SetIsProxyItem (self, aIsProxy=True)
 
def HitTest (self, *args)
 
def Mirror (self, aCentre, aMirrorAroundXAxis)
 
def Scale (self, aScale)
 
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
def ViewGetLOD (self, aLayer, aView)
 
def GetArcAngleStart (self)
 
def GetShapeStr (self)
 
- Public Member Functions inherited from pcbnew.BOARD_CONNECTED_ITEM
def __init__ (self, *args, **kwargs)
 
def GetNet (self)
 
def SetNet (self, aNetInfo)
 
def GetNetCode (self)
 
def SetNetCode (self, *args)
 
def GetNetname (self)
 
def GetNetnameMsg (self)
 
def GetShortNetname (self)
 
def GetUnescapedShortNetname (self)
 
def GetOwnClearance (self, aLayer, aSource=None)
 
def GetClearanceOverrides (self, aSource)
 
def GetLocalClearance (self, *args)
 
def GetEffectiveNetClass (self)
 
def GetNetClassName (self)
 
def SetLocalRatsnestVisible (self, aVisible)
 
def GetLocalRatsnestVisible (self)
 
def GetTeardropParams (self, *args)
 
def SetTeardropsEnabled (self, aEnable)
 
def GetTeardropsEnabled (self)
 
def SetTeardropBestLengthRatio (self, aRatio)
 
def GetTeardropBestLengthRatio (self)
 
def SetTeardropMaxLength (self, aMaxLength)
 
def GetTeardropMaxLength (self)
 
def SetTeardropBestWidthRatio (self, aRatio)
 
def GetTeardropBestWidthRatio (self)
 
def SetTeardropMaxWidth (self, aMaxWidth)
 
def GetTeardropMaxWidth (self)
 
def SetTeardropCurvePts (self, aPointCount)
 
def GetTeardropCurvePts (self)
 
def SetTeardropPreferZoneConnections (self, aPrefer)
 
def GetTeardropPreferZoneConnections (self)
 
def SetTeardropAllowSpanTwoTracks (self, aAllow)
 
def GetTeardropAllowSpanTwoTracks (self)
 
def SetTeardropMaxTrackWidth (self, aRatio)
 
def GetTeardropMaxTrackWidth (self)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
def __init__ (self, *args, **kwargs)
 
def SetParentGroup (self, aGroup)
 
def GetParentGroup (self)
 
def GetX (self)
 
def GetY (self)
 
def GetCenter (self)
 
def SetX (self, aX)
 
def SetY (self, aY)
 
def IsConnected (self)
 
def Similarity (self, aItem)
 
def __eq__ (self, aItem)
 
def IsOnCopperLayer (self)
 
def HasHole (self)
 
def IsTented (self)
 
def GetEffectiveShape (self, *args)
 
def GetEffectiveHoleShape (self)
 
def RunOnChildren (self, aFunction)
 
def RunOnDescendants (self, aFunction, aDepth=0)
 
def GetParent (self)
 
def GetParentFootprint (self)
 
def GetFPRelativePosition (self)
 
def SetFPRelativePosition (self, aPos)
 
def HasLineStroke (self)
 
def GetStroke (self)
 
def SetStroke (self, aStroke)
 
def GetFontMetrics (self)
 
def GetLayer (self)
 
def GetLayerSet (self)
 
def SetLayerSet (self, aLayers)
 
def SetLayer (self, aLayer)
 
def Duplicate (self)
 
def SwapItemData (self, aImage)
 
def IsOnLayer (self, aLayer)
 
def IsKnockout (self)
 
def SetIsKnockout (self, aKnockout)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
def StyleFromSettings (self, settings)
 
def DeleteStructure (self)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre, aFlipLeftRight)
 
def Normalize (self)
 
def GetBoard (self, *args)
 
def GetParentAsString (self)
 
def GetLayerName (self)
 
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
def Cast (self)
 
def Duplicate (self)
 
def SetPos (self, p)
 
def SetStartEnd (self, start, end)
 
- Public Member Functions inherited from pcbnew.EDA_ITEM
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)
 
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, aLayers, aCount)
 
- Public Member Functions inherited from pcbnew.EDA_SHAPE
def __init__ (self, aType, aLineWidth, aFill)
 
def SwapShape (self, aImage)
 
def ShowShape (self)
 
def SHAPE_T_asString (self)
 
def IsProxyItem (self)
 
def SetIsProxyItem (self, aIsProxy=True)
 
def IsFilled (self)
 
def SetFilled (self, aFlag)
 
def SetFillMode (self, aFill)
 
def GetFillMode (self)
 
def IsClosed (self)
 
def GetFillColor (self)
 
def SetFillColor (self, aColor)
 
def SetWidth (self, aWidth)
 
def GetWidth (self)
 
def GetEffectiveWidth (self)
 
def SetLineStyle (self, aStyle)
 
def GetLineStyle (self)
 
def SetLineColor (self, aColor)
 
def GetLineColor (self)
 
def SetShape (self, aShape)
 
def GetShape (self)
 
def GetStart (self)
 
def GetStartY (self)
 
def GetStartX (self)
 
def SetStart (self, aStart)
 
def SetStartY (self, y)
 
def SetStartX (self, x)
 
def GetEnd (self)
 
def GetEndY (self)
 
def GetEndX (self)
 
def SetEnd (self, aEnd)
 
def SetEndY (self, aY)
 
def SetEndX (self, aX)
 
def SetRadius (self, aX)
 
def GetTopLeft (self)
 
def GetBotRight (self)
 
def SetTop (self, val)
 
def SetLeft (self, val)
 
def SetRight (self, val)
 
def SetBottom (self, val)
 
def SetBezierC1 (self, aPt)
 
def GetBezierC1 (self)
 
def SetBezierC2 (self, aPt)
 
def GetBezierC2 (self)
 
def SetCenter (self, aCenter)
 
def SetArcAngleAndEnd (self, aAngle, aCheckNegativeAngle=False)
 
def GetArcAngle (self)
 
def GetSegmentAngle (self)
 
def EndsSwapped (self)
 
def GetArcMid (self)
 
def GetRectCorners (self)
 
def CalcArcAngles (self, aStartAngle, aEndAngle)
 
def GetRadius (self)
 
def SetArcGeometry (self, aStart, aMid, aEnd)
 
def SetCachedArcData (self, aStart, aMid, aEnd, aCenter)
 
def GetBezierPoints (self)
 
def DupPolyPointsList (self, aBuffer)
 
def GetPointCount (self)
 
def GetPolyShape (self, *args)
 
def IsPolyShapeValid (self)
 
def SetPolyShape (self, aShape)
 
def SetPolyPoints (self, aPoints)
 
def RebuildBezierToSegmentsPointsList (self, aMinSegLen)
 
def MakeEffectiveShapes (self, aEdgeOnly=False)
 
def ShapeGetMsgPanelInfo (self, aFrame, aList)
 
def SetLength (self, aLength)
 
def SetRectangle (self, aHeight, aWidth)
 
def SetSegmentAngle (self, aAngle)
 
def IsClockwiseArc (self)
 
def GetLength (self)
 
def GetRectangleHeight (self)
 
def GetRectangleWidth (self)
 
def TransformShapeToPolygon (self, aBuffer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
def Compare (self, aOther)
 
def Similarity (self, aOther)
 
def __eq__ (self, aOther)
 
- Public Member Functions inherited from pcbnew.EDA_TEXT
def __init__ (self, *args)
 
def GetText (self)
 
def GetShownText (self, aAllowExtraText, aDepth=0)
 
def HasTextVars (self)
 
def SetText (self, aText)
 
def SetTextThickness (self, aWidth)
 
def GetTextThickness (self)
 
def GetEffectiveTextPenWidth (self, aDefaultPenWidth=0)
 
def SetTextAngle (self, aAngle)
 
def GetTextAngle (self)
 
def SetTextAngleDegrees (self, aOrientation)
 
def GetTextAngleDegrees (self)
 
def SetItalic (self, aItalic)
 
def IsItalic (self)
 
def SetBold (self, aBold)
 
def SetBoldFlag (self, aBold)
 
def IsBold (self)
 
def SetVisible (self, aVisible)
 
def IsVisible (self)
 
def SetMirrored (self, isMirrored)
 
def IsMirrored (self)
 
def SetMultilineAllowed (self, aAllow)
 
def IsMultilineAllowed (self)
 
def SetHorizJustify (self, aType)
 
def GetHorizJustify (self)
 
def SetVertJustify (self, aType)
 
def GetVertJustify (self)
 
def SetKeepUpright (self, aKeepUpright)
 
def IsKeepUpright (self)
 
def FlipHJustify (self)
 
def SwapAttributes (self, aTradingPartner)
 
def SwapText (self, aTradingPartner)
 
def CopyText (self, aSrc)
 
def SetAttributes (self, *args)
 
def GetAttributes (self)
 
def Replace (self, aSearchData)
 
def IsDefaultFormatting (self)
 
def SetFont (self, aFont)
 
def GetFont (self)
 
def GetFontName (self)
 
def SetFontIndex (self, aIdx)
 
def GetFontIndex (self)
 
def SetLineSpacing (self, aLineSpacing)
 
def GetLineSpacing (self)
 
def SetTextSize (self, aNewSize, aEnforceMinTextSize=True)
 
def GetTextSize (self)
 
def SetTextWidth (self, aWidth)
 
def GetTextWidth (self)
 
def SetTextHeight (self, aHeight)
 
def GetTextHeight (self)
 
def SetTextColor (self, aColor)
 
def GetTextColor (self)
 
def SetTextPos (self, aPoint)
 
def GetTextPos (self)
 
def SetTextX (self, aX)
 
def SetTextY (self, aY)
 
def Offset (self, aOffset)
 
def Empty (self)
 
def Print (self, aSettings, aOffset, aColor, aDisplay_mode=FILLED)
 
def GetEffectiveTextShape (self, *args)
 
def TextHitTest (self, *args)
 
def GetTextBox (self, aLine=-1, aInvertY=False)
 
def GetInterline (self)
 
def GetTextStyleName (self)
 
def GetLinePositions (self, aPositions, aLineCount)
 
def Levenshtein (self, aOther)
 
def Similarity (self, aOther)
 
def Format (self, aFormatter, aNestLevel, aControlBits)
 
def GetDrawRotation (self)
 
def GetDrawPos (self)
 
def ClearRenderCache (self)
 
def ClearBoundingBoxCache (self)
 
def GetRenderCache (self, *args)
 
def SetupRenderCache (self, aResolvedText, aAngle)
 
def AddRenderCacheGlyph (self, aPoly)
 
def Compare (self, aOther)
 
def __eq__ (self, aRhs)
 
def __lt__ (self, aRhs)
 
def __gt__ (self, aRhs)
 
def HasHyperlink (self)
 
def GetHyperlink (self)
 
def SetHyperlink (self, aLink)
 
def RemoveHyperlink (self)
 

Static Public Member Functions

def ClassOf (aItem)
 
def ClassOf (aItem)
 
def ClassOf (aItem)
 
- Static Public Member Functions inherited from pcbnew.EDA_ITEM
def Sort (aLeft, aRight)
 
- Static Public Member Functions inherited from pcbnew.EDA_TEXT
def MapHorizJustify (aHorizJustify)
 
def MapVertJustify (aVertJustify)
 
def ValidateHyperlink (aURL)
 
def IsGotoPageHref (aHref, aDestination=None)
 
def GotoPageHref (aDestination)
 

Properties

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

Detailed Description

Proxy of C++ PCB_TEXTBOX class.

Definition at line 15255 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.PCB_TEXTBOX.__init__ (   self,
  aParent,
  aType = PCB_TEXTBOX_T 
)
__init__(PCB_TEXTBOX self, BOARD_ITEM aParent, KICAD_T aType=PCB_TEXTBOX_T) -> PCB_TEXTBOX

Reimplemented from pcbnew.EDA_TEXT.

Definition at line 15261 of file pcbnew.py.

Member Function Documentation

◆ ClassOf()

def pcbnew.PCB_TEXTBOX.ClassOf (   aItem)
static
ClassOf(EDA_ITEM aItem) -> bool

Reimplemented from pcbnew.PCB_SHAPE.

Definition at line 15267 of file pcbnew.py.

◆ GetAnchorAndOppositeCorner()

def pcbnew.PCB_TEXTBOX.GetAnchorAndOppositeCorner (   self)
GetAnchorAndOppositeCorner(PCB_TEXTBOX self) -> VECTOR_VECTOR2I

Definition at line 15311 of file pcbnew.py.

◆ GetBorderWidth()

def pcbnew.PCB_TEXTBOX.GetBorderWidth (   self)
GetBorderWidth(PCB_TEXTBOX self) -> int

Definition at line 15350 of file pcbnew.py.

◆ GetEffectiveShape()

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

Reimplemented from pcbnew.PCB_SHAPE.

Definition at line 15330 of file pcbnew.py.

◆ GetLegacyTextMargin()

def pcbnew.PCB_TEXTBOX.GetLegacyTextMargin (   self)
GetLegacyTextMargin(PCB_TEXTBOX self) -> int

Definition at line 15271 of file pcbnew.py.

◆ GetMarginBottom()

def pcbnew.PCB_TEXTBOX.GetMarginBottom (   self)
GetMarginBottom(PCB_TEXTBOX self) -> int

Definition at line 15303 of file pcbnew.py.

◆ GetMarginLeft()

def pcbnew.PCB_TEXTBOX.GetMarginLeft (   self)
GetMarginLeft(PCB_TEXTBOX self) -> int

Definition at line 15291 of file pcbnew.py.

◆ GetMarginRight()

def pcbnew.PCB_TEXTBOX.GetMarginRight (   self)
GetMarginRight(PCB_TEXTBOX self) -> int

Definition at line 15299 of file pcbnew.py.

◆ GetMarginTop()

def pcbnew.PCB_TEXTBOX.GetMarginTop (   self)
GetMarginTop(PCB_TEXTBOX self) -> int

Definition at line 15295 of file pcbnew.py.

◆ GetShownText()

def pcbnew.PCB_TEXTBOX.GetShownText (   self,
  aAllowExtraText,
  aDepth = 0 
)
GetShownText(PCB_TEXTBOX self, bool aAllowExtraText, int aDepth=0) -> wxString

Reimplemented from pcbnew.EDA_TEXT.

Definition at line 15307 of file pcbnew.py.

◆ HitTest()

def pcbnew.PCB_TEXTBOX.HitTest (   self,
args 
)
    HitTest(PCB_TEXTBOX self, VECTOR2I aPosition, int aAccuracy) -> bool
    HitTest(PCB_TEXTBOX self, BOX2I aRect, bool aContained, int aAccuracy=0) -> bool

Reimplemented from pcbnew.PCB_SHAPE.

Definition at line 15315 of file pcbnew.py.

Here is the caller graph for this function:

◆ IsBorderEnabled()

def pcbnew.PCB_TEXTBOX.IsBorderEnabled (   self)
IsBorderEnabled(PCB_TEXTBOX self) -> bool

Definition at line 15338 of file pcbnew.py.

◆ SetBorderEnabled()

def pcbnew.PCB_TEXTBOX.SetBorderEnabled (   self,
  enabled 
)
SetBorderEnabled(PCB_TEXTBOX self, bool enabled)

Definition at line 15342 of file pcbnew.py.

◆ SetBorderWidth()

def pcbnew.PCB_TEXTBOX.SetBorderWidth (   self,
  aSize 
)
SetBorderWidth(PCB_TEXTBOX self, int const aSize)

Definition at line 15346 of file pcbnew.py.

◆ SetMarginBottom()

def pcbnew.PCB_TEXTBOX.SetMarginBottom (   self,
  aBottom 
)
SetMarginBottom(PCB_TEXTBOX self, int aBottom)

Definition at line 15287 of file pcbnew.py.

◆ SetMarginLeft()

def pcbnew.PCB_TEXTBOX.SetMarginLeft (   self,
  aLeft 
)
SetMarginLeft(PCB_TEXTBOX self, int aLeft)

Definition at line 15275 of file pcbnew.py.

◆ SetMarginRight()

def pcbnew.PCB_TEXTBOX.SetMarginRight (   self,
  aRight 
)
SetMarginRight(PCB_TEXTBOX self, int aRight)

Definition at line 15283 of file pcbnew.py.

◆ SetMarginTop()

def pcbnew.PCB_TEXTBOX.SetMarginTop (   self,
  aTop 
)
SetMarginTop(PCB_TEXTBOX self, int aTop)

Definition at line 15279 of file pcbnew.py.

◆ TransformShapeToPolygon()

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

Reimplemented from pcbnew.PCB_SHAPE.

Definition at line 15326 of file pcbnew.py.

◆ TransformTextToPolySet()

def pcbnew.PCB_TEXTBOX.TransformTextToPolySet (   self,
  aBuffer,
  aClearance,
  aMaxError,
  aErrorLoc 
)
TransformTextToPolySet(PCB_TEXTBOX self, SHAPE_POLY_SET aBuffer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc)

Definition at line 15322 of file pcbnew.py.

◆ ViewGetLOD()

def pcbnew.PCB_TEXTBOX.ViewGetLOD (   self,
  aLayer,
  aView 
)
ViewGetLOD(PCB_TEXTBOX self, int aLayer, KIGFX::VIEW * aView) -> double

Reimplemented from pcbnew.PCB_SHAPE.

Definition at line 15334 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 15258 of file pcbnew.py.


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