KiCad Pcbnew Python Scripting
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, parent)
 
def GetTextMargin (self)
 
def GetShownText (self, aAllowExtraText, aDepth=0)
 
def GetAnchorAndOppositeCorner (self)
 
def HitTest (self, *args)
 
def TransformTextToPolySet (self, aBuffer, aClearance, aError, aErrorLoc)
 
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, aIgnoreLineWidth=False)
 
def GetEffectiveShape (self, *args)
 
def ViewGetLOD (self, aLayer, aView)
 
def IsBorderEnabled (self)
 
def DisableBorder (self)
 
def GetShownText (self)
 
- Public Member Functions inherited from pcbnew.PCB_SHAPE
def __init__ (self, *args)
 
def GetFriendlyName (self)
 
def GetCorners (self)
 
def GetParentFootprint (self)
 
def GetEffectiveShape (self, *args)
 
def HitTest (self, *args)
 
def NormalizeRect (self)
 
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_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 IsOnCopperLayer (self)
 
def HasHole (self)
 
def IsTented (self)
 
def GetEffectiveShape (self, *args)
 
def GetEffectiveHoleShape (self)
 
def GetParent (self)
 
def GetParentFootprint (self)
 
def HasLineStroke (self)
 
def GetStroke (self)
 
def SetStroke (self, aStroke)
 
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 DeleteStructure (self)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre, aFlipLeftRight)
 
def GetBoard (self, *args)
 
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 GetState (self, type)
 
def SetState (self, type, state)
 
def GetStatus (self)
 
def SetStatus (self, aStatus)
 
def SetFlags (self, aMask)
 
def XorFlags (self, aMask)
 
def ClearFlags (self, *args)
 
def GetFlags (self)
 
def HasFlag (self, aFlag)
 
def GetEditFlags (self)
 
def ClearTempFlags (self)
 
def ClearEditFlags (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, *args, **kwargs)
 
def SwapShape (self, aImage)
 
def ShowShape (self)
 
def SHAPE_T_asString (self)
 
def IsAnnotationProxy (self)
 
def SetIsAnnotationProxy (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 SetShape (self, aShape)
 
def GetShape (self)
 
def GetFriendlyName (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, y)
 
def SetEndX (self, x)
 
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 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 GetLength (self)
 
def TransformShapeToPolygon (self, aBuffer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
def Compare (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 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 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 SetLineSpacing (self, aLineSpacing)
 
def GetLineSpacing (self)
 
def SetTextSize (self, aNewSize)
 
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 GetEffectiveTextShapeNative (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 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 HasHyperlink (self)
 
def GetHyperlink (self)
 
def SetHyperlink (self, aLink)
 
def RemoveHyperlink (self)
 
def GetEffectiveTextShape (self, aTriangulate=True, aUseTextRotation=True)
 
def GetShownText (self)
 

Static Public Member Functions

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

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

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.PCB_TEXTBOX.__init__ (   self,
  parent 
)
__init__(PCB_TEXTBOX self, BOARD_ITEM parent) -> PCB_TEXTBOX

Reimplemented from pcbnew.EDA_TEXT.

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

◆ DisableBorder()

def pcbnew.PCB_TEXTBOX.DisableBorder (   self)
DisableBorder(PCB_TEXTBOX self)

Definition at line 15015 of file pcbnew.py.

◆ GetAnchorAndOppositeCorner()

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

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

◆ GetShownText() [1/2]

def pcbnew.PCB_TEXTBOX.GetShownText (   self)
GetShownText(PCB_TEXTBOX self) -> wxString

Reimplemented from pcbnew.EDA_TEXT.

Definition at line 15020 of file pcbnew.py.

◆ GetShownText() [2/2]

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

◆ GetTextMargin()

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

Definition at line 14976 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 14988 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 15011 of file pcbnew.py.

◆ TransformShapeToPolygon()

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

Reimplemented from pcbnew.PCB_SHAPE.

Definition at line 14999 of file pcbnew.py.

◆ TransformTextToPolySet()

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

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

Property Documentation

◆ thisown

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


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