KiCAD pcbnew scripting
Public Member Functions | Public Attributes | List of all members
pcbnew.EDA_TEXT Class Reference
Inheritance diagram for pcbnew.EDA_TEXT:
Inheritance graph
[legend]

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 TextHitTest (self, args)
 
def LenSize (self, aLine)
 
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

 this
 

Detailed Description

Proxy of C++ EDA_TEXT class.

Definition at line 2641 of file pcbnew.py.

Constructor & Destructor Documentation

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

Definition at line 2650 of file pcbnew.py.

Member Function Documentation

def pcbnew.EDA_TEXT.Draw (   self,
  args 
)
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 2858 of file pcbnew.py.

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

Definition at line 2853 of file pcbnew.py.

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

Definition at line 2916 of file pcbnew.py.

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

Definition at line 2763 of file pcbnew.py.

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

Definition at line 2898 of file pcbnew.py.

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

Definition at line 2911 of file pcbnew.py.

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

Definition at line 2668 of file pcbnew.py.

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

Definition at line 2663 of file pcbnew.py.

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

Definition at line 2698 of file pcbnew.py.

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

Definition at line 2703 of file pcbnew.py.

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

Definition at line 2708 of file pcbnew.py.

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 2888 of file pcbnew.py.

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

Definition at line 2823 of file pcbnew.py.

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

Definition at line 2833 of file pcbnew.py.

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

Definition at line 2803 of file pcbnew.py.

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

Definition at line 2906 of file pcbnew.py.

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

Definition at line 2813 of file pcbnew.py.

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

Definition at line 2688 of file pcbnew.py.

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

Definition at line 2768 of file pcbnew.py.

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

Definition at line 2728 of file pcbnew.py.

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

Definition at line 2793 of file pcbnew.py.

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

Definition at line 2718 of file pcbnew.py.

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

Definition at line 2748 of file pcbnew.py.

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

Definition at line 2758 of file pcbnew.py.

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

Definition at line 2738 of file pcbnew.py.

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

Definition at line 2883 of file pcbnew.py.

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

Definition at line 2848 of file pcbnew.py.

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

Definition at line 2723 of file pcbnew.py.

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

Definition at line 2783 of file pcbnew.py.

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

Definition at line 2773 of file pcbnew.py.

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

Definition at line 2713 of file pcbnew.py.

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

Definition at line 2743 of file pcbnew.py.

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

Definition at line 2753 of file pcbnew.py.

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

Definition at line 2678 of file pcbnew.py.

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

Definition at line 2693 of file pcbnew.py.

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

Definition at line 2818 of file pcbnew.py.

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

Definition at line 2828 of file pcbnew.py.

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

Definition at line 2798 of file pcbnew.py.

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

Definition at line 2808 of file pcbnew.py.

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

Definition at line 2838 of file pcbnew.py.

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

Definition at line 2843 of file pcbnew.py.

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

Definition at line 2683 of file pcbnew.py.

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

Definition at line 2778 of file pcbnew.py.

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

Definition at line 2733 of file pcbnew.py.

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

Definition at line 2673 of file pcbnew.py.

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

Definition at line 2788 of file pcbnew.py.

def pcbnew.EDA_TEXT.TextHitTest (   self,
  args 
)
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 2872 of file pcbnew.py.

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

Definition at line 2867 of file pcbnew.py.

Member Data Documentation

pcbnew.EDA_TEXT.this

Definition at line 2659 of file pcbnew.py.


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