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

Public Member Functions

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 MapHorizJustify (aHorizJustify)
def MapVertJustify (aVertJustify)
def ValidateHyperlink (aURL)
def IsGotoPageHref (aHref, aDestination=None)
def GotoPageHref (aDestination)


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

Detailed Description

Proxy of C++ EDA_TEXT class.

Definition at line 2633 of file

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.EDA_TEXT.__init__ (   self,
    __init__(EDA_TEXT self, EDA_IU_SCALE aIuScale, wxString aText=wxEmptyString) -> EDA_TEXT
    __init__(EDA_TEXT self, EDA_TEXT aText) -> EDA_TEXT

Reimplemented in pcbnew.PCB_TEXT, pcbnew.PCB_FIELD, pcbnew.PCB_DIMENSION_BASE, pcbnew.PCB_DIM_ORTHOGONAL, pcbnew.PCB_DIM_RADIAL, pcbnew.PCB_DIM_LEADER, pcbnew.PCB_DIM_CENTER, pcbnew.PCB_DIM_ALIGNED, and pcbnew.PCB_TEXTBOX.

Definition at line 2639 of file

Here is the caller graph for this function:

Member Function Documentation

◆ __eq__()

def pcbnew.EDA_TEXT.__eq__ (   self,
__eq__(EDA_TEXT self, EDA_TEXT aRhs) -> bool

Reimplemented in pcbnew.PCB_FIELD.

Definition at line 2963 of file

◆ __gt__()

def pcbnew.EDA_TEXT.__gt__ (   self,
__gt__(EDA_TEXT self, EDA_TEXT aRhs) -> bool

Definition at line 2971 of file

◆ __lt__()

def pcbnew.EDA_TEXT.__lt__ (   self,
__lt__(EDA_TEXT self, EDA_TEXT aRhs) -> bool

Definition at line 2967 of file

◆ AddRenderCacheGlyph()

def pcbnew.EDA_TEXT.AddRenderCacheGlyph (   self,
AddRenderCacheGlyph(EDA_TEXT self, SHAPE_POLY_SET aPoly)

Definition at line 2955 of file

◆ ClearBoundingBoxCache()

def pcbnew.EDA_TEXT.ClearBoundingBoxCache (   self)
ClearBoundingBoxCache(EDA_TEXT self)

Definition at line 2943 of file

◆ ClearRenderCache()

def pcbnew.EDA_TEXT.ClearRenderCache (   self)
ClearRenderCache(EDA_TEXT self)

Definition at line 2939 of file

◆ Compare()

def pcbnew.EDA_TEXT.Compare (   self,
Compare(EDA_TEXT self, EDA_TEXT aOther) -> int

Definition at line 2959 of file

◆ CopyText()

def pcbnew.EDA_TEXT.CopyText (   self,
CopyText(EDA_TEXT self, EDA_TEXT aSrc)

Definition at line 2771 of file

◆ Empty()

def pcbnew.EDA_TEXT.Empty (   self)
Empty(EDA_TEXT self)

Definition at line 2874 of file

◆ FlipHJustify()

def pcbnew.EDA_TEXT.FlipHJustify (   self)
FlipHJustify(EDA_TEXT self)

Definition at line 2759 of file

◆ Format()

def pcbnew.EDA_TEXT.Format (   self,
Format(EDA_TEXT self, OUTPUTFORMATTER aFormatter, int aNestLevel, int aControlBits)

Definition at line 2927 of file

◆ GetAttributes()

def pcbnew.EDA_TEXT.GetAttributes (   self)
GetAttributes(EDA_TEXT self) -> TEXT_ATTRIBUTES

Definition at line 2782 of file

◆ GetDrawPos()

def pcbnew.EDA_TEXT.GetDrawPos (   self)
GetDrawPos(EDA_TEXT self) -> VECTOR2I

Definition at line 2935 of file

◆ GetDrawRotation()

def pcbnew.EDA_TEXT.GetDrawRotation (   self)
GetDrawRotation(EDA_TEXT self) -> EDA_ANGLE

Definition at line 2931 of file

◆ GetEffectiveTextPenWidth()

def pcbnew.EDA_TEXT.GetEffectiveTextPenWidth (   self,
  aDefaultPenWidth = 0 
GetEffectiveTextPenWidth(EDA_TEXT self, int aDefaultPenWidth=0) -> int

Definition at line 2671 of file

◆ GetEffectiveTextShape()

def pcbnew.EDA_TEXT.GetEffectiveTextShape (   self,
GetEffectiveTextShape(EDA_TEXT self, bool aTriangulate=True, BOX2I aBBox=BOX2I(), EDA_ANGLE aAngle=ANGLE_0) -> std::shared_ptr< SHAPE_COMPOUND >

Definition at line 2892 of file

◆ GetFont()

def pcbnew.EDA_TEXT.GetFont (   self)
GetFont(EDA_TEXT self) -> KIFONT::FONT *

Definition at line 2798 of file

◆ GetFontIndex()

def pcbnew.EDA_TEXT.GetFontIndex (   self)
GetFontIndex(EDA_TEXT self) -> int

Definition at line 2810 of file

◆ GetFontName()

def pcbnew.EDA_TEXT.GetFontName (   self)
GetFontName(EDA_TEXT self) -> wxString

Definition at line 2802 of file

◆ GetHorizJustify()

def pcbnew.EDA_TEXT.GetHorizJustify (   self)
GetHorizJustify(EDA_TEXT self) -> GR_TEXT_H_ALIGN_T

Definition at line 2739 of file

◆ GetHyperlink()

def pcbnew.EDA_TEXT.GetHyperlink (   self)
GetHyperlink(EDA_TEXT self) -> wxString

Definition at line 2979 of file

◆ GetInterline()

def pcbnew.EDA_TEXT.GetInterline (   self)
GetInterline(EDA_TEXT self) -> int

Definition at line 2907 of file

◆ GetLinePositions()

def pcbnew.EDA_TEXT.GetLinePositions (   self,
GetLinePositions(EDA_TEXT self, VECTOR_VECTOR2I aPositions, int aLineCount)

Definition at line 2915 of file

◆ GetLineSpacing()

def pcbnew.EDA_TEXT.GetLineSpacing (   self)
GetLineSpacing(EDA_TEXT self) -> double

Definition at line 2818 of file

◆ GetRenderCache()

def pcbnew.EDA_TEXT.GetRenderCache (   self,
GetRenderCache(EDA_TEXT self, KIFONT::FONT const * aFont, wxString forResolvedText, VECTOR2I aOffset={ 0, 0 }) -> std::vector< std::unique_ptr< KIFONT::GLYPH >,std::allocator< std::unique_ptr< KIFONT::GLYPH > > >

Definition at line 2947 of file

◆ GetShownText()

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

Reimplemented in pcbnew.PCB_TEXT, and pcbnew.PCB_TEXTBOX.

Definition at line 2651 of file

◆ GetText()

def pcbnew.EDA_TEXT.GetText (   self)
GetText(EDA_TEXT self) -> wxString

Definition at line 2647 of file

◆ GetTextAngle()

def pcbnew.EDA_TEXT.GetTextAngle (   self)
GetTextAngle(EDA_TEXT self) -> EDA_ANGLE

Definition at line 2679 of file

◆ GetTextAngleDegrees()

def pcbnew.EDA_TEXT.GetTextAngleDegrees (   self)
GetTextAngleDegrees(EDA_TEXT self) -> double

Definition at line 2687 of file

◆ GetTextBox()

def pcbnew.EDA_TEXT.GetTextBox (   self,
  aLine = -1,
  aInvertY = False 
GetTextBox(EDA_TEXT self, int aLine=-1, bool aInvertY=False) -> BOX2I

Definition at line 2903 of file

◆ GetTextColor()

def pcbnew.EDA_TEXT.GetTextColor (   self)
GetTextColor(EDA_TEXT self) -> COLOR4D

Definition at line 2850 of file

◆ GetTextHeight()

def pcbnew.EDA_TEXT.GetTextHeight (   self)
GetTextHeight(EDA_TEXT self) -> int

Definition at line 2842 of file

◆ GetTextPos()

def pcbnew.EDA_TEXT.GetTextPos (   self)
GetTextPos(EDA_TEXT self) -> VECTOR2I

Definition at line 2858 of file

◆ GetTextSize()

def pcbnew.EDA_TEXT.GetTextSize (   self)
GetTextSize(EDA_TEXT self) -> VECTOR2I

Definition at line 2826 of file

◆ GetTextStyleName()

def pcbnew.EDA_TEXT.GetTextStyleName (   self)
GetTextStyleName(EDA_TEXT self) -> wxString

Definition at line 2911 of file

◆ GetTextThickness()

def pcbnew.EDA_TEXT.GetTextThickness (   self)
GetTextThickness(EDA_TEXT self) -> int

Definition at line 2667 of file

◆ GetTextWidth()

def pcbnew.EDA_TEXT.GetTextWidth (   self)
GetTextWidth(EDA_TEXT self) -> int

Definition at line 2834 of file

◆ GetVertJustify()

def pcbnew.EDA_TEXT.GetVertJustify (   self)
GetVertJustify(EDA_TEXT self) -> GR_TEXT_V_ALIGN_T

Definition at line 2747 of file

◆ GotoPageHref()

def pcbnew.EDA_TEXT.GotoPageHref (   aDestination)
GotoPageHref(wxString aDestination) -> wxString

Definition at line 3002 of file

◆ HasHyperlink()

def pcbnew.EDA_TEXT.HasHyperlink (   self)
HasHyperlink(EDA_TEXT self) -> bool

Definition at line 2975 of file

◆ HasTextVars()

def pcbnew.EDA_TEXT.HasTextVars (   self)
HasTextVars(EDA_TEXT self) -> bool

Definition at line 2655 of file

◆ IsBold()

def pcbnew.EDA_TEXT.IsBold (   self)
IsBold(EDA_TEXT self) -> bool

Definition at line 2707 of file

◆ IsDefaultFormatting()

def pcbnew.EDA_TEXT.IsDefaultFormatting (   self)
IsDefaultFormatting(EDA_TEXT self) -> bool

Definition at line 2790 of file

◆ IsGotoPageHref()

def pcbnew.EDA_TEXT.IsGotoPageHref (   aHref,
  aDestination = None 
IsGotoPageHref(wxString aHref, wxString aDestination=None) -> bool

Definition at line 2997 of file

◆ IsItalic()

def pcbnew.EDA_TEXT.IsItalic (   self)
IsItalic(EDA_TEXT self) -> bool

Definition at line 2695 of file

◆ IsKeepUpright()

def pcbnew.EDA_TEXT.IsKeepUpright (   self)
IsKeepUpright(EDA_TEXT self) -> bool

Definition at line 2755 of file

◆ IsMirrored()

def pcbnew.EDA_TEXT.IsMirrored (   self)
IsMirrored(EDA_TEXT self) -> bool

Definition at line 2723 of file

◆ IsMultilineAllowed()

def pcbnew.EDA_TEXT.IsMultilineAllowed (   self)
IsMultilineAllowed(EDA_TEXT self) -> bool

Definition at line 2731 of file

◆ IsVisible()

def pcbnew.EDA_TEXT.IsVisible (   self)
IsVisible(EDA_TEXT self) -> bool

Definition at line 2715 of file

◆ Levenshtein()

def pcbnew.EDA_TEXT.Levenshtein (   self,
Levenshtein(EDA_TEXT self, EDA_TEXT aOther) -> double

Definition at line 2919 of file

◆ MapHorizJustify()

def pcbnew.EDA_TEXT.MapHorizJustify (   aHorizJustify)
MapHorizJustify(int aHorizJustify) -> GR_TEXT_H_ALIGN_T

Definition at line 2879 of file

◆ MapVertJustify()

def pcbnew.EDA_TEXT.MapVertJustify (   aVertJustify)
MapVertJustify(int aVertJustify) -> GR_TEXT_V_ALIGN_T

Definition at line 2884 of file

◆ Offset()

def pcbnew.EDA_TEXT.Offset (   self,
Offset(EDA_TEXT self, VECTOR2I aOffset)

Definition at line 2870 of file

◆ Print()

def pcbnew.EDA_TEXT.Print (   self,
  aDisplay_mode = FILLED 
Print(EDA_TEXT self, RENDER_SETTINGS const * aSettings, VECTOR2I aOffset, COLOR4D aColor, OUTLINE_MODE aDisplay_mode=FILLED)

Definition at line 2888 of file

◆ RemoveHyperlink()

def pcbnew.EDA_TEXT.RemoveHyperlink (   self)
RemoveHyperlink(EDA_TEXT self)

Definition at line 2987 of file

◆ Replace()

def pcbnew.EDA_TEXT.Replace (   self,
Replace(EDA_TEXT self, EDA_SEARCH_DATA const & aSearchData) -> bool

Definition at line 2786 of file

◆ SetAttributes()

def pcbnew.EDA_TEXT.SetAttributes (   self,
    SetAttributes(EDA_TEXT self, EDA_TEXT aSrc, bool aSetPosition=True)
    SetAttributes(EDA_TEXT self, TEXT_ATTRIBUTES aTextAttrs)

Definition at line 2775 of file

Here is the caller graph for this function:

◆ SetBold()

def pcbnew.EDA_TEXT.SetBold (   self,
SetBold(EDA_TEXT self, bool aBold)

Definition at line 2699 of file

◆ SetBoldFlag()

def pcbnew.EDA_TEXT.SetBoldFlag (   self,
SetBoldFlag(EDA_TEXT self, bool aBold)

Definition at line 2703 of file

◆ SetFont()

def pcbnew.EDA_TEXT.SetFont (   self,
SetFont(EDA_TEXT self, KIFONT::FONT * aFont)

Definition at line 2794 of file

◆ SetFontIndex()

def pcbnew.EDA_TEXT.SetFontIndex (   self,
SetFontIndex(EDA_TEXT self, int aIdx)

Definition at line 2806 of file

◆ SetHorizJustify()

def pcbnew.EDA_TEXT.SetHorizJustify (   self,
SetHorizJustify(EDA_TEXT self, GR_TEXT_H_ALIGN_T aType)

Definition at line 2735 of file

◆ SetHyperlink()

def pcbnew.EDA_TEXT.SetHyperlink (   self,
SetHyperlink(EDA_TEXT self, wxString aLink)

Definition at line 2983 of file

◆ SetItalic()

def pcbnew.EDA_TEXT.SetItalic (   self,
SetItalic(EDA_TEXT self, bool aItalic)

Definition at line 2691 of file

◆ SetKeepUpright()

def pcbnew.EDA_TEXT.SetKeepUpright (   self,
SetKeepUpright(EDA_TEXT self, bool aKeepUpright)

Definition at line 2751 of file

◆ SetLineSpacing()

def pcbnew.EDA_TEXT.SetLineSpacing (   self,
SetLineSpacing(EDA_TEXT self, double aLineSpacing)

Definition at line 2814 of file

◆ SetMirrored()

def pcbnew.EDA_TEXT.SetMirrored (   self,
SetMirrored(EDA_TEXT self, bool isMirrored)

Definition at line 2719 of file

◆ SetMultilineAllowed()

def pcbnew.EDA_TEXT.SetMultilineAllowed (   self,
SetMultilineAllowed(EDA_TEXT self, bool aAllow)

Definition at line 2727 of file

◆ SetText()

def pcbnew.EDA_TEXT.SetText (   self,
SetText(EDA_TEXT self, wxString aText)

Definition at line 2659 of file

◆ SetTextAngle()

def pcbnew.EDA_TEXT.SetTextAngle (   self,
SetTextAngle(EDA_TEXT self, EDA_ANGLE aAngle)

Definition at line 2675 of file

◆ SetTextAngleDegrees()

def pcbnew.EDA_TEXT.SetTextAngleDegrees (   self,
SetTextAngleDegrees(EDA_TEXT self, double aOrientation)

Definition at line 2683 of file

◆ SetTextColor()

def pcbnew.EDA_TEXT.SetTextColor (   self,
SetTextColor(EDA_TEXT self, COLOR4D aColor)

Definition at line 2846 of file

◆ SetTextHeight()

def pcbnew.EDA_TEXT.SetTextHeight (   self,
SetTextHeight(EDA_TEXT self, int aHeight)

Definition at line 2838 of file

◆ SetTextPos()

def pcbnew.EDA_TEXT.SetTextPos (   self,
SetTextPos(EDA_TEXT self, VECTOR2I aPoint)

Definition at line 2854 of file

◆ SetTextSize()

def pcbnew.EDA_TEXT.SetTextSize (   self,
  aEnforceMinTextSize = True 
SetTextSize(EDA_TEXT self, VECTOR2I aNewSize, bool aEnforceMinTextSize=True)

Definition at line 2822 of file

◆ SetTextThickness()

def pcbnew.EDA_TEXT.SetTextThickness (   self,
SetTextThickness(EDA_TEXT self, int aWidth)

Definition at line 2663 of file

◆ SetTextWidth()

def pcbnew.EDA_TEXT.SetTextWidth (   self,
SetTextWidth(EDA_TEXT self, int aWidth)

Definition at line 2830 of file

◆ SetTextX()

def pcbnew.EDA_TEXT.SetTextX (   self,
SetTextX(EDA_TEXT self, int aX)

Definition at line 2862 of file

◆ SetTextY()

def pcbnew.EDA_TEXT.SetTextY (   self,
SetTextY(EDA_TEXT self, int aY)

Definition at line 2866 of file

◆ SetupRenderCache()

def pcbnew.EDA_TEXT.SetupRenderCache (   self,
SetupRenderCache(EDA_TEXT self, wxString aResolvedText, EDA_ANGLE aAngle)

Definition at line 2951 of file

◆ SetVertJustify()

def pcbnew.EDA_TEXT.SetVertJustify (   self,
SetVertJustify(EDA_TEXT self, GR_TEXT_V_ALIGN_T aType)

Definition at line 2743 of file

◆ SetVisible()

def pcbnew.EDA_TEXT.SetVisible (   self,
SetVisible(EDA_TEXT self, bool aVisible)

Definition at line 2711 of file

◆ Similarity()

def pcbnew.EDA_TEXT.Similarity (   self,
Similarity(EDA_TEXT self, EDA_TEXT aOther) -> double

Definition at line 2923 of file

◆ SwapAttributes()

def pcbnew.EDA_TEXT.SwapAttributes (   self,
SwapAttributes(EDA_TEXT self, EDA_TEXT aTradingPartner)

Definition at line 2763 of file

◆ SwapText()

def pcbnew.EDA_TEXT.SwapText (   self,
SwapText(EDA_TEXT self, EDA_TEXT aTradingPartner)

Definition at line 2767 of file

◆ TextHitTest()

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

Reimplemented in pcbnew.PCB_TEXT.

Definition at line 2896 of file

Here is the caller graph for this function:

◆ ValidateHyperlink()

def pcbnew.EDA_TEXT.ValidateHyperlink (   aURL)
ValidateHyperlink(wxString aURL) -> bool

Definition at line 2992 of file

Property Documentation

◆ thisown

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

Definition at line 2636 of file

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