| 
    KiCad Pcbnew Python Scripting
    
   | 
 

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 | SetItalicFlag (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, aFont, aAngle, aOffset) | 
| 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) | 
Properties | |
| thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag") | |
| def pcbnew.EDA_TEXT.__init__ | ( | self, | |
| * | args | ||
| ) | 
    __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 2675 of file pcbnew.py.

| def pcbnew.EDA_TEXT.__eq__ | ( | self, | |
| aRhs | |||
| ) | 
| def pcbnew.EDA_TEXT.__gt__ | ( | self, | |
| aRhs | |||
| ) | 
| def pcbnew.EDA_TEXT.__lt__ | ( | self, | |
| aRhs | |||
| ) | 
| def pcbnew.EDA_TEXT.AddRenderCacheGlyph | ( | self, | |
| aPoly | |||
| ) | 
| def pcbnew.EDA_TEXT.ClearBoundingBoxCache | ( | self | ) | 
| def pcbnew.EDA_TEXT.ClearRenderCache | ( | self | ) | 
| def pcbnew.EDA_TEXT.Compare | ( | self, | |
| aOther | |||
| ) | 
| def pcbnew.EDA_TEXT.CopyText | ( | self, | |
| aSrc | |||
| ) | 
| def pcbnew.EDA_TEXT.FlipHJustify | ( | self | ) | 
| def pcbnew.EDA_TEXT.Format | ( | self, | |
| aFormatter, | |||
| aNestLevel, | |||
| aControlBits | |||
| ) | 
| def pcbnew.EDA_TEXT.GetAttributes | ( | self | ) | 
| def pcbnew.EDA_TEXT.GetDrawPos | ( | self | ) | 
GetDrawPos(EDA_TEXT self) -> VECTOR2I
Reimplemented in pcbnew.PCB_TEXTBOX.
| def pcbnew.EDA_TEXT.GetDrawRotation | ( | self | ) | 
| def pcbnew.EDA_TEXT.GetEffectiveTextPenWidth | ( | self, | |
aDefaultPenWidth = 0  | 
        |||
| ) | 
| def pcbnew.EDA_TEXT.GetEffectiveTextShape | ( | self, | |
| * | args | ||
| ) | 
| def pcbnew.EDA_TEXT.GetFont | ( | self | ) | 
| def pcbnew.EDA_TEXT.GetFontIndex | ( | self | ) | 
| def pcbnew.EDA_TEXT.GetFontName | ( | self | ) | 
| def pcbnew.EDA_TEXT.GetHorizJustify | ( | self | ) | 
| def pcbnew.EDA_TEXT.GetHyperlink | ( | self | ) | 
| def pcbnew.EDA_TEXT.GetInterline | ( | self | ) | 
| def pcbnew.EDA_TEXT.GetLinePositions | ( | self, | |
| aPositions, | |||
| aLineCount | |||
| ) | 
| def pcbnew.EDA_TEXT.GetLineSpacing | ( | self | ) | 
| def pcbnew.EDA_TEXT.GetRenderCache | ( | self, | |
| * | args | ||
| ) | 
| def pcbnew.EDA_TEXT.GetShownText | ( | self, | |
| aAllowExtraText, | |||
aDepth = 0  | 
        |||
| ) | 
GetShownText(EDA_TEXT self, bool aAllowExtraText, int aDepth=0) -> wxString
Reimplemented in pcbnew.PCB_TEXT, and pcbnew.PCB_TEXTBOX.
| def pcbnew.EDA_TEXT.GetText | ( | self | ) | 
| def pcbnew.EDA_TEXT.GetTextAngle | ( | self | ) | 
| def pcbnew.EDA_TEXT.GetTextAngleDegrees | ( | self | ) | 
| def pcbnew.EDA_TEXT.GetTextBox | ( | self, | |
aLine = -1,  | 
        |||
aInvertY = False  | 
        |||
| ) | 
| def pcbnew.EDA_TEXT.GetTextColor | ( | self | ) | 
| def pcbnew.EDA_TEXT.GetTextHeight | ( | self | ) | 
| def pcbnew.EDA_TEXT.GetTextPos | ( | self | ) | 
| def pcbnew.EDA_TEXT.GetTextSize | ( | self | ) | 
| def pcbnew.EDA_TEXT.GetTextStyleName | ( | self | ) | 
| def pcbnew.EDA_TEXT.GetTextThickness | ( | self | ) | 
| def pcbnew.EDA_TEXT.GetTextWidth | ( | self | ) | 
| def pcbnew.EDA_TEXT.GetVertJustify | ( | self | ) | 
      
  | 
  static | 
| def pcbnew.EDA_TEXT.HasHyperlink | ( | self | ) | 
| def pcbnew.EDA_TEXT.HasTextVars | ( | self | ) | 
| def pcbnew.EDA_TEXT.IsBold | ( | self | ) | 
| def pcbnew.EDA_TEXT.IsDefaultFormatting | ( | self | ) | 
      
  | 
  static | 
| def pcbnew.EDA_TEXT.IsItalic | ( | self | ) | 
| def pcbnew.EDA_TEXT.IsKeepUpright | ( | self | ) | 
| def pcbnew.EDA_TEXT.IsMirrored | ( | self | ) | 
| def pcbnew.EDA_TEXT.IsMultilineAllowed | ( | self | ) | 
| def pcbnew.EDA_TEXT.IsVisible | ( | self | ) | 
| def pcbnew.EDA_TEXT.Levenshtein | ( | self, | |
| aOther | |||
| ) | 
      
  | 
  static | 
      
  | 
  static | 
| def pcbnew.EDA_TEXT.Offset | ( | self, | |
| aOffset | |||
| ) | 
| def pcbnew.EDA_TEXT.Print | ( | self, | |
| aSettings, | |||
| aOffset, | |||
| aColor, | |||
aDisplay_mode = FILLED  | 
        |||
| ) | 
| def pcbnew.EDA_TEXT.RemoveHyperlink | ( | self | ) | 
| def pcbnew.EDA_TEXT.Replace | ( | self, | |
| aSearchData | |||
| ) | 
| def pcbnew.EDA_TEXT.SetAttributes | ( | self, | |
| * | args | ||
| ) | 
| def pcbnew.EDA_TEXT.SetBold | ( | self, | |
| aBold | |||
| ) | 
| def pcbnew.EDA_TEXT.SetBoldFlag | ( | self, | |
| aBold | |||
| ) | 
| def pcbnew.EDA_TEXT.SetFont | ( | self, | |
| aFont | |||
| ) | 
| def pcbnew.EDA_TEXT.SetFontIndex | ( | self, | |
| aIdx | |||
| ) | 
| def pcbnew.EDA_TEXT.SetHorizJustify | ( | self, | |
| aType | |||
| ) | 
| def pcbnew.EDA_TEXT.SetHyperlink | ( | self, | |
| aLink | |||
| ) | 
| def pcbnew.EDA_TEXT.SetItalic | ( | self, | |
| aItalic | |||
| ) | 
| def pcbnew.EDA_TEXT.SetItalicFlag | ( | self, | |
| aItalic | |||
| ) | 
| def pcbnew.EDA_TEXT.SetKeepUpright | ( | self, | |
| aKeepUpright | |||
| ) | 
| def pcbnew.EDA_TEXT.SetLineSpacing | ( | self, | |
| aLineSpacing | |||
| ) | 
| def pcbnew.EDA_TEXT.SetMirrored | ( | self, | |
| isMirrored | |||
| ) | 
| def pcbnew.EDA_TEXT.SetMultilineAllowed | ( | self, | |
| aAllow | |||
| ) | 
| def pcbnew.EDA_TEXT.SetText | ( | self, | |
| aText | |||
| ) | 
| def pcbnew.EDA_TEXT.SetTextAngle | ( | self, | |
| aAngle | |||
| ) | 
| def pcbnew.EDA_TEXT.SetTextAngleDegrees | ( | self, | |
| aOrientation | |||
| ) | 
| def pcbnew.EDA_TEXT.SetTextColor | ( | self, | |
| aColor | |||
| ) | 
| def pcbnew.EDA_TEXT.SetTextHeight | ( | self, | |
| aHeight | |||
| ) | 
| def pcbnew.EDA_TEXT.SetTextPos | ( | self, | |
| aPoint | |||
| ) | 
| def pcbnew.EDA_TEXT.SetTextSize | ( | self, | |
| aNewSize, | |||
aEnforceMinTextSize = True  | 
        |||
| ) | 
| def pcbnew.EDA_TEXT.SetTextThickness | ( | self, | |
| aWidth | |||
| ) | 
| def pcbnew.EDA_TEXT.SetTextWidth | ( | self, | |
| aWidth | |||
| ) | 
| def pcbnew.EDA_TEXT.SetTextX | ( | self, | |
| aX | |||
| ) | 
| def pcbnew.EDA_TEXT.SetTextY | ( | self, | |
| aY | |||
| ) | 
| def pcbnew.EDA_TEXT.SetupRenderCache | ( | self, | |
| aResolvedText, | |||
| aFont, | |||
| aAngle, | |||
| aOffset | |||
| ) | 
| def pcbnew.EDA_TEXT.SetVertJustify | ( | self, | |
| aType | |||
| ) | 
| def pcbnew.EDA_TEXT.SetVisible | ( | self, | |
| aVisible | |||
| ) | 
| def pcbnew.EDA_TEXT.Similarity | ( | self, | |
| aOther | |||
| ) | 
| def pcbnew.EDA_TEXT.SwapAttributes | ( | self, | |
| aTradingPartner | |||
| ) | 
| def pcbnew.EDA_TEXT.SwapText | ( | self, | |
| aTradingPartner | |||
| ) | 
| def pcbnew.EDA_TEXT.TextHitTest | ( | self, | |
| * | args | ||
| ) | 
    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 2936 of file pcbnew.py.

      
  | 
  static | 
      
  | 
  static |