| 
    KiCad Pcbnew Python Scripting
    
   | 
 

Public Member Functions | |
| __init__ (self, *args) | |
| Serialize (self, aContainer) | |
| Deserialize (self, aContainer) | |
| GetText (self) | |
| GetShownText (self, aAllowExtraText, aDepth=0) | |
| HasTextVars (self) | |
| SetText (self, aText) | |
| EvaluateText (self, aText) | |
| SetTextThickness (self, aWidth) | |
| GetTextThickness (self) | |
| GetTextThicknessProperty (self) | |
| SetAutoThickness (self, aAuto) | |
| GetAutoThickness (self) | |
| GetEffectiveTextPenWidth (self, aDefaultPenWidth=0) | |
| SetTextAngle (self, aAngle) | |
| GetTextAngle (self) | |
| SetTextAngleDegrees (self, aOrientation) | |
| GetTextAngleDegrees (self) | |
| SetItalic (self, aItalic) | |
| SetItalicFlag (self, aItalic) | |
| IsItalic (self) | |
| SetBold (self, aBold) | |
| SetBoldFlag (self, aBold) | |
| IsBold (self) | |
| SetVisible (self, aVisible) | |
| IsVisible (self) | |
| SetMirrored (self, isMirrored) | |
| IsMirrored (self) | |
| SetMultilineAllowed (self, aAllow) | |
| IsMultilineAllowed (self) | |
| SetHorizJustify (self, aType) | |
| GetHorizJustify (self) | |
| SetVertJustify (self, aType) | |
| GetVertJustify (self) | |
| SetKeepUpright (self, aKeepUpright) | |
| IsKeepUpright (self) | |
| FlipHJustify (self) | |
| SwapAttributes (self, aTradingPartner) | |
| SwapText (self, aTradingPartner) | |
| CopyText (self, aSrc) | |
| SetAttributes (self, *args) | |
| GetAttributes (self) | |
| Replace (self, aSearchData) | |
| IsDefaultFormatting (self) | |
| SetFont (self, aFont) | |
| GetFont (self) | |
| SetUnresolvedFontName (self, aFontName) | |
| ResolveFont (self, aEmbeddedFonts) | |
| GetFontName (self) | |
| SetFontProp (self, aFontName) | |
| GetFontProp (self) | |
| SetLineSpacing (self, aLineSpacing) | |
| GetLineSpacing (self) | |
| SetTextSize (self, aNewSize, aEnforceMinTextSize=True) | |
| GetTextSize (self) | |
| SetTextWidth (self, aWidth) | |
| GetTextWidth (self) | |
| SetTextHeight (self, aHeight) | |
| GetTextHeight (self) | |
| SetTextColor (self, aColor) | |
| GetTextColor (self) | |
| SetTextPos (self, aPoint) | |
| GetTextPos (self) | |
| SetTextX (self, aX) | |
| SetTextY (self, aY) | |
| Offset (self, aOffset) | |
| Empty (self) | |
| Print (self, aSettings, aOffset, aColor) | |
| GetEffectiveTextShape (self, *args) | |
| TextHitTest (self, *args) | |
| GetTextBox (self, aSettings, aLine=-1) | |
| GetInterline (self, aSettings) | |
| GetTextStyleName (self) | |
| GetLinePositions (self, aSettings, aPositions, aLineCount) | |
| Levenshtein (self, aOther) | |
| Similarity (self, aOther) | |
| Format (self, aFormatter, aControlBits) | |
| GetDrawRotation (self) | |
| GetDrawPos (self) | |
| GetDrawFont (self, aSettings) | |
| ClearRenderCache (self) | |
| ClearBoundingBoxCache (self) | |
| GetRenderCache (self, *args) | |
| SetupRenderCache (self, aResolvedText, aFont, aAngle, aOffset) | |
| AddRenderCacheGlyph (self, aPoly) | |
| Compare (self, aOther) | |
| __eq__ (self, aRhs) | |
| __lt__ (self, aRhs) | |
| __gt__ (self, aRhs) | |
| HasHyperlink (self) | |
| GetHyperlink (self) | |
| SetHyperlink (self, aLink) | |
| RemoveHyperlink (self) | |
Static Public Member Functions | |
| MapHorizJustify (aHorizJustify) | |
| MapVertJustify (aVertJustify) | |
| ValidateHyperlink (aURL) | |
| IsGotoPageHref (aHref, aDestination=None) | |
| GotoPageHref (aDestination) | |
Properties | |
| thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag") | |
| pcbnew.EDA_TEXT.__init__ | ( | self, | |
| * | args ) | 
| pcbnew.EDA_TEXT.__eq__ | ( | self, | |
| aRhs ) | 
| pcbnew.EDA_TEXT.__gt__ | ( | self, | |
| aRhs ) | 
| pcbnew.EDA_TEXT.__lt__ | ( | self, | |
| aRhs ) | 
| pcbnew.EDA_TEXT.AddRenderCacheGlyph | ( | self, | |
| aPoly ) | 
| pcbnew.EDA_TEXT.ClearBoundingBoxCache | ( | self | ) | 
| pcbnew.EDA_TEXT.ClearRenderCache | ( | self | ) | 
| pcbnew.EDA_TEXT.Compare | ( | self, | |
| aOther ) | 
| pcbnew.EDA_TEXT.CopyText | ( | self, | |
| aSrc ) | 
| pcbnew.EDA_TEXT.Deserialize | ( | self, | |
| aContainer ) | 
Deserialize(EDA_TEXT self, google::protobuf::Any const & aContainer) -> bool
Reimplemented in pcbnew.PCB_DIM_ALIGNED, pcbnew.PCB_DIM_CENTER, pcbnew.PCB_DIM_LEADER, pcbnew.PCB_DIM_ORTHOGONAL, pcbnew.PCB_DIM_RADIAL, pcbnew.PCB_DIMENSION_BASE, pcbnew.PCB_FIELD, pcbnew.PCB_TEXT, and pcbnew.PCB_TEXTBOX.
| pcbnew.EDA_TEXT.EvaluateText | ( | self, | |
| aText ) | 
| pcbnew.EDA_TEXT.FlipHJustify | ( | self | ) | 
| pcbnew.EDA_TEXT.Format | ( | self, | |
| aFormatter, | |||
| aControlBits ) | 
| pcbnew.EDA_TEXT.GetAttributes | ( | self | ) | 
| pcbnew.EDA_TEXT.GetAutoThickness | ( | self | ) | 
| pcbnew.EDA_TEXT.GetDrawFont | ( | self, | |
| aSettings ) | 
| pcbnew.EDA_TEXT.GetDrawPos | ( | self | ) | 
GetDrawPos(EDA_TEXT self) -> VECTOR2I
Reimplemented in pcbnew.PCB_TEXTBOX.
| pcbnew.EDA_TEXT.GetDrawRotation | ( | self | ) | 
| pcbnew.EDA_TEXT.GetEffectiveTextPenWidth | ( | self, | |
| aDefaultPenWidth = 0 ) | 
| pcbnew.EDA_TEXT.GetEffectiveTextShape | ( | self, | |
| * | args ) | 
| pcbnew.EDA_TEXT.GetFont | ( | self | ) | 
| pcbnew.EDA_TEXT.GetFontName | ( | self | ) | 
| pcbnew.EDA_TEXT.GetFontProp | ( | self | ) | 
| pcbnew.EDA_TEXT.GetHorizJustify | ( | self | ) | 
| pcbnew.EDA_TEXT.GetHyperlink | ( | self | ) | 
| pcbnew.EDA_TEXT.GetInterline | ( | self, | |
| aSettings ) | 
| pcbnew.EDA_TEXT.GetLinePositions | ( | self, | |
| aSettings, | |||
| aPositions, | |||
| aLineCount ) | 
| pcbnew.EDA_TEXT.GetLineSpacing | ( | self | ) | 
| pcbnew.EDA_TEXT.GetRenderCache | ( | self, | |
| * | args ) | 
| 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.
| pcbnew.EDA_TEXT.GetText | ( | self | ) | 
| pcbnew.EDA_TEXT.GetTextAngle | ( | self | ) | 
| pcbnew.EDA_TEXT.GetTextAngleDegrees | ( | self | ) | 
| pcbnew.EDA_TEXT.GetTextBox | ( | self, | |
| aSettings, | |||
| aLine = -1 ) | 
| pcbnew.EDA_TEXT.GetTextColor | ( | self | ) | 
| pcbnew.EDA_TEXT.GetTextHeight | ( | self | ) | 
| pcbnew.EDA_TEXT.GetTextPos | ( | self | ) | 
| pcbnew.EDA_TEXT.GetTextSize | ( | self | ) | 
| pcbnew.EDA_TEXT.GetTextStyleName | ( | self | ) | 
| pcbnew.EDA_TEXT.GetTextThickness | ( | self | ) | 
| pcbnew.EDA_TEXT.GetTextThicknessProperty | ( | self | ) | 
| pcbnew.EDA_TEXT.GetTextWidth | ( | self | ) | 
| pcbnew.EDA_TEXT.GetVertJustify | ( | self | ) | 
      
  | 
  static | 
| pcbnew.EDA_TEXT.HasHyperlink | ( | self | ) | 
| pcbnew.EDA_TEXT.HasTextVars | ( | self | ) | 
| pcbnew.EDA_TEXT.IsBold | ( | self | ) | 
| pcbnew.EDA_TEXT.IsDefaultFormatting | ( | self | ) | 
      
  | 
  static | 
| pcbnew.EDA_TEXT.IsItalic | ( | self | ) | 
| pcbnew.EDA_TEXT.IsKeepUpright | ( | self | ) | 
| pcbnew.EDA_TEXT.IsMirrored | ( | self | ) | 
| pcbnew.EDA_TEXT.IsMultilineAllowed | ( | self | ) | 
| pcbnew.EDA_TEXT.IsVisible | ( | self | ) | 
| pcbnew.EDA_TEXT.Levenshtein | ( | self, | |
| aOther ) | 
      
  | 
  static | 
      
  | 
  static | 
| pcbnew.EDA_TEXT.Offset | ( | self, | |
| aOffset ) | 
| pcbnew.EDA_TEXT.Print | ( | self, | |
| aSettings, | |||
| aOffset, | |||
| aColor ) | 
| pcbnew.EDA_TEXT.RemoveHyperlink | ( | self | ) | 
| pcbnew.EDA_TEXT.Replace | ( | self, | |
| aSearchData ) | 
| pcbnew.EDA_TEXT.ResolveFont | ( | self, | |
| aEmbeddedFonts ) | 
| pcbnew.EDA_TEXT.Serialize | ( | self, | |
| aContainer ) | 
Serialize(EDA_TEXT self, google::protobuf::Any & aContainer)
Reimplemented in pcbnew.PCB_DIM_ALIGNED, pcbnew.PCB_DIM_CENTER, pcbnew.PCB_DIM_LEADER, pcbnew.PCB_DIM_ORTHOGONAL, pcbnew.PCB_DIM_RADIAL, pcbnew.PCB_DIMENSION_BASE, pcbnew.PCB_FIELD, pcbnew.PCB_TEXT, and pcbnew.PCB_TEXTBOX.
| pcbnew.EDA_TEXT.SetAttributes | ( | self, | |
| * | args ) | 
| pcbnew.EDA_TEXT.SetAutoThickness | ( | self, | |
| aAuto ) | 
| pcbnew.EDA_TEXT.SetBold | ( | self, | |
| aBold ) | 
| pcbnew.EDA_TEXT.SetBoldFlag | ( | self, | |
| aBold ) | 
| pcbnew.EDA_TEXT.SetFont | ( | self, | |
| aFont ) | 
| pcbnew.EDA_TEXT.SetFontProp | ( | self, | |
| aFontName ) | 
| pcbnew.EDA_TEXT.SetHorizJustify | ( | self, | |
| aType ) | 
| pcbnew.EDA_TEXT.SetHyperlink | ( | self, | |
| aLink ) | 
| pcbnew.EDA_TEXT.SetItalic | ( | self, | |
| aItalic ) | 
| pcbnew.EDA_TEXT.SetItalicFlag | ( | self, | |
| aItalic ) | 
| pcbnew.EDA_TEXT.SetKeepUpright | ( | self, | |
| aKeepUpright ) | 
| pcbnew.EDA_TEXT.SetLineSpacing | ( | self, | |
| aLineSpacing ) | 
| pcbnew.EDA_TEXT.SetMirrored | ( | self, | |
| isMirrored ) | 
| pcbnew.EDA_TEXT.SetMultilineAllowed | ( | self, | |
| aAllow ) | 
| pcbnew.EDA_TEXT.SetText | ( | self, | |
| aText ) | 
| pcbnew.EDA_TEXT.SetTextAngle | ( | self, | |
| aAngle ) | 
| pcbnew.EDA_TEXT.SetTextAngleDegrees | ( | self, | |
| aOrientation ) | 
| pcbnew.EDA_TEXT.SetTextColor | ( | self, | |
| aColor ) | 
| pcbnew.EDA_TEXT.SetTextHeight | ( | self, | |
| aHeight ) | 
| pcbnew.EDA_TEXT.SetTextPos | ( | self, | |
| aPoint ) | 
| pcbnew.EDA_TEXT.SetTextSize | ( | self, | |
| aNewSize, | |||
| aEnforceMinTextSize = True ) | 
| pcbnew.EDA_TEXT.SetTextThickness | ( | self, | |
| aWidth ) | 
| pcbnew.EDA_TEXT.SetTextWidth | ( | self, | |
| aWidth ) | 
| pcbnew.EDA_TEXT.SetTextX | ( | self, | |
| aX ) | 
| pcbnew.EDA_TEXT.SetTextY | ( | self, | |
| aY ) | 
| pcbnew.EDA_TEXT.SetUnresolvedFontName | ( | self, | |
| aFontName ) | 
| pcbnew.EDA_TEXT.SetupRenderCache | ( | self, | |
| aResolvedText, | |||
| aFont, | |||
| aAngle, | |||
| aOffset ) | 
| pcbnew.EDA_TEXT.SetVertJustify | ( | self, | |
| aType ) | 
| pcbnew.EDA_TEXT.SetVisible | ( | self, | |
| aVisible ) | 
| pcbnew.EDA_TEXT.Similarity | ( | self, | |
| aOther ) | 
| pcbnew.EDA_TEXT.SwapAttributes | ( | self, | |
| aTradingPartner ) | 
| pcbnew.EDA_TEXT.SwapText | ( | self, | |
| aTradingPartner ) | 
| 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.
      
  | 
  static | 
      
  | 
  static |