KiCad Pcbnew Python Scripting
Public Member Functions | Static Public Member Functions | Static Public Attributes | Properties | List of all members
pcbnew.FP_TEXT Class Reference
Inheritance diagram for pcbnew.FP_TEXT:
Inheritance graph

Public Member Functions

def __init__ (self, *args)
def GetParentAsString (self)
def KeepUpright (self, aOldOrientation, aNewOrientation)
def IsParentFlipped (self)
def Mirror (self, aCentre, aMirrorAroundXAxis)
def SetType (self, aType)
def GetType (self)
def SetPos0 (self, aPos)
def GetPos0 (self)
def GetLength (self)
def SetDrawCoord (self)
def SetLocalCoord (self)
def TextHitTest (self, *args)
def HitTest (self, *args)
def TransformTextToPolySet (self, aBuffer, aClearance, aError, aErrorLoc)
def GetEffectiveShape (self, *args)
def GetShownText (self, aAllowExtraText, aDepth=0)
def ViewGetLOD (self, aLayer, aView)
def GetShownText (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_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)
- 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)

Static Public Attributes



 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_TEXT
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Detailed Description

Proxy of C++ FP_TEXT class.

Definition at line 15762 of file

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.FP_TEXT.__init__ (   self,
__init__(FP_TEXT self, FOOTPRINT aParentFootprint, FP_TEXT::TEXT_TYPE text_type=TEXT_is_DIVERS) -> FP_TEXT

Reimplemented from pcbnew.EDA_TEXT.

Definition at line 15774 of file

Member Function Documentation

◆ ClassOf()

def pcbnew.FP_TEXT.ClassOf (   aItem)
ClassOf(EDA_ITEM aItem) -> bool

Definition at line 15780 of file

◆ GetEffectiveShape()

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

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 15846 of file

◆ GetLength()

def pcbnew.FP_TEXT.GetLength (   self)
GetLength(FP_TEXT self) -> int

Definition at line 15816 of file

◆ GetParentAsString()

def pcbnew.FP_TEXT.GetParentAsString (   self)
GetParentAsString(FP_TEXT self) -> wxString

Definition at line 15784 of file

◆ GetPos0()

def pcbnew.FP_TEXT.GetPos0 (   self)
GetPos0(FP_TEXT self) -> VECTOR2I

Definition at line 15812 of file

◆ GetShownText() [1/2]

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

Reimplemented from pcbnew.EDA_TEXT.

Definition at line 15859 of file

◆ GetShownText() [2/2]

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

Reimplemented from pcbnew.EDA_TEXT.

Definition at line 15850 of file

◆ GetType()

def pcbnew.FP_TEXT.GetType (   self)

Definition at line 15804 of file

◆ HitTest()

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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 15835 of file

Here is the caller graph for this function:

◆ IsParentFlipped()

def pcbnew.FP_TEXT.IsParentFlipped (   self)
IsParentFlipped(FP_TEXT self) -> bool

Definition at line 15792 of file

◆ KeepUpright()

def pcbnew.FP_TEXT.KeepUpright (   self,
KeepUpright(FP_TEXT self, EDA_ANGLE aOldOrientation, EDA_ANGLE aNewOrientation)

Definition at line 15788 of file

◆ Mirror()

def pcbnew.FP_TEXT.Mirror (   self,
Mirror(FP_TEXT self, VECTOR2I aCentre, bool aMirrorAroundXAxis)

Definition at line 15796 of file

◆ SetDrawCoord()

def pcbnew.FP_TEXT.SetDrawCoord (   self)
SetDrawCoord(FP_TEXT self)

Definition at line 15820 of file

◆ SetLocalCoord()

def pcbnew.FP_TEXT.SetLocalCoord (   self)
SetLocalCoord(FP_TEXT self)

Definition at line 15824 of file

◆ SetPos0()

def pcbnew.FP_TEXT.SetPos0 (   self,
SetPos0(FP_TEXT self, VECTOR2I aPos)

Definition at line 15808 of file

Here is the caller graph for this function:

◆ SetType()

def pcbnew.FP_TEXT.SetType (   self,
SetType(FP_TEXT self, FP_TEXT::TEXT_TYPE aType)

Definition at line 15800 of file

◆ TextHitTest()

def pcbnew.FP_TEXT.TextHitTest (   self,
    TextHitTest(FP_TEXT self, VECTOR2I aPoint, int aAccuracy=0) -> bool
    TextHitTest(FP_TEXT self, BOX2I aRect, bool aContains, int aAccuracy=0) -> bool

Reimplemented from pcbnew.EDA_TEXT.

Definition at line 15828 of file

Here is the caller graph for this function:

◆ TransformTextToPolySet()

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

Definition at line 15842 of file

◆ ViewGetLOD()

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

Definition at line 15854 of file

Member Data Documentation



Definition at line 15771 of file



Definition at line 15767 of file


pcbnew.FP_TEXT.TEXT_is_VALUE = _pcbnew.FP_TEXT_TEXT_is_VALUE

Definition at line 15769 of file

Property Documentation

◆ thisown

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

Definition at line 15765 of file

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