KiCad Pcbnew Python Scripting
Public Member Functions | Public Attributes | 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)
def ShortenedShownText (self)
def SetText (self, aText)
def SetThickness (self, aNewThickness)
def GetThickness (self)
def SetTextAngle (self, aAngle)
def GetTextAngle (self)
def GetTextAngleDegrees (self)
def GetTextAngleRadians (self)
def SetItalic (self, isItalic)
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 GetHorizJustify (self)
def GetVertJustify (self)
def SetHorizJustify (self, aType)
def SetVertJustify (self, aType)
def SetEffects (self, aSrc)
def SwapEffects (self, aTradingPartner)
def IsDefaultFormatting (self)
def SetTextSize (self, aNewSize)
def GetTextSize (self)
def SetTextWidth (self, aWidth)
def GetTextWidth (self)
def SetTextHeight (self, aHeight)
def GetTextHeight (self)
def SetTextPos (self, aPoint)
def GetTextPos (self)
def SetTextX (self, aX)
def SetTextY (self, aY)
def Offset (self, aOffset)
def Empty (self)
def Draw (self, args)
def TransformTextShapeToSegmentList (self, aCornerBuffer)
def TransformBoundingBoxWithClearanceToPolygon (self, aCornerBuffer, aClearanceValue)
def TextHitTest (self, args)
def LenSize (self, aLine, aThickness)
def GetTextBox (self, aLine=-1, aThickness=-1, aInvertY=False)
def GetInterline (self, aTextThickness=-1)
def GetTextStyleName (self)
def GetPositionsOfLinesOfMultilineText (self, aPositions, aLineCount)
def Format (self, aFormatter, aNestLevel, aControlBits)

Public Attributes


Detailed Description

Proxy of C++ EDA_TEXT class.

Definition at line 2785 of file

Constructor & Destructor Documentation

def pcbnew.EDA_TEXT.__init__ (   self,
__init__(EDA_TEXT self, wxString text) -> EDA_TEXT
__init__(EDA_TEXT self) -> EDA_TEXT

Definition at line 2794 of file

Member Function Documentation

def pcbnew.EDA_TEXT.Draw (   self,
Draw(EDA_TEXT self, EDA_RECT aClipBox, wxDC * aDC, wxPoint aOffset, COLOR4D aColor, GR_DRAWMODE aDrawMode, EDA_DRAW_MODE_T aDisplay_mode=FILLED, COLOR4D aAnchor_color)
Draw(EDA_TEXT self, EDA_RECT aClipBox, wxDC * aDC, wxPoint aOffset, COLOR4D aColor, GR_DRAWMODE aDrawMode, EDA_DRAW_MODE_T aDisplay_mode=FILLED)
Draw(EDA_TEXT self, EDA_RECT aClipBox, wxDC * aDC, wxPoint aOffset, COLOR4D aColor, GR_DRAWMODE aDrawMode)

Definition at line 3002 of file

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

Definition at line 2997 of file

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

Definition at line 3065 of file

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

Definition at line 2907 of file

def pcbnew.EDA_TEXT.GetInterline (   self,
  aTextThickness = -1 
GetInterline(EDA_TEXT self, int aTextThickness=-1) -> int
GetInterline(EDA_TEXT self) -> int

Definition at line 3047 of file

def pcbnew.EDA_TEXT.GetPositionsOfLinesOfMultilineText (   self,
GetPositionsOfLinesOfMultilineText(EDA_TEXT self, wxPoint_Vector aPositions, int aLineCount)

Definition at line 3060 of file

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

Definition at line 2812 of file

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

Definition at line 2807 of file

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

Definition at line 2842 of file

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

Definition at line 2847 of file

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

Definition at line 2852 of file

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

Definition at line 3037 of file

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

Definition at line 2967 of file

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

Definition at line 2977 of file

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

Definition at line 2947 of file

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

Definition at line 3055 of file

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

Definition at line 2957 of file

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

Definition at line 2832 of file

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

Definition at line 2912 of file

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

Definition at line 2872 of file

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

Definition at line 2937 of file

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

Definition at line 2862 of file

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

Definition at line 2892 of file

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

Definition at line 2902 of file

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

Definition at line 2882 of file

def pcbnew.EDA_TEXT.LenSize (   self,
LenSize(EDA_TEXT self, wxString aLine, int aThickness) -> int

Definition at line 3032 of file

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

Definition at line 2992 of file

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

Definition at line 2867 of file

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

Definition at line 2927 of file

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

Definition at line 2917 of file

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

Definition at line 2857 of file

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

Definition at line 2887 of file

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

Definition at line 2897 of file

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

Definition at line 2822 of file

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

Definition at line 2837 of file

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

Definition at line 2962 of file

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

Definition at line 2972 of file

def pcbnew.EDA_TEXT.SetTextSize (   self,
SetTextSize(EDA_TEXT self, wxSize aNewSize)

Definition at line 2942 of file

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

Definition at line 2952 of file

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

Definition at line 2982 of file

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

Definition at line 2987 of file

def pcbnew.EDA_TEXT.SetThickness (   self,
SetThickness(EDA_TEXT self, int aNewThickness)

Definition at line 2827 of file

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

Definition at line 2922 of file

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

Definition at line 2877 of file

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

Definition at line 2817 of file

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

Definition at line 2932 of file

def pcbnew.EDA_TEXT.TextHitTest (   self,
TextHitTest(EDA_TEXT self, wxPoint aPoint, int aAccuracy=0) -> bool
TextHitTest(EDA_TEXT self, wxPoint aPoint) -> bool
TextHitTest(EDA_TEXT self, EDA_RECT aRect, bool aContains=False, int aAccuracy=0) -> bool
TextHitTest(EDA_TEXT self, EDA_RECT aRect, bool aContains=False) -> bool
TextHitTest(EDA_TEXT self, EDA_RECT aRect) -> bool

Definition at line 3021 of file

def pcbnew.EDA_TEXT.TransformBoundingBoxWithClearanceToPolygon (   self,
TransformBoundingBoxWithClearanceToPolygon(EDA_TEXT self, SHAPE_POLY_SET aCornerBuffer, int aClearanceValue)

Definition at line 3016 of file

def pcbnew.EDA_TEXT.TransformTextShapeToSegmentList (   self,
TransformTextShapeToSegmentList(EDA_TEXT self, wxPoint_Vector aCornerBuffer)

Definition at line 3011 of file

Member Data Documentation


Definition at line 2803 of file

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