KiCad Pcbnew Python Scripting
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
[legend]

Public Member Functions

def __init__ (self, *args)
 
"wxString const &" GetText (self)
 
"wxString" GetShownText (self, "int" aDepth=0, "bool" aAllowExtraText=True)
 
"wxString" ShortenedShownText (self)
 
"bool" HasTextVars (self)
 
"void" SetText (self, "wxString" aText)
 
"void" SetTextThickness (self, "int" aWidth)
 
"int" GetTextThickness (self)
 
"int" GetEffectiveTextPenWidth (self, "int" aDefaultWidth=0)
 
"void" SetTextAngle (self, "double" aAngle)
 
"double" GetTextAngle (self)
 
"double" GetTextAngleDegrees (self)
 
"double" GetTextAngleRadians (self)
 
"void" SetItalic (self, "bool" isItalic)
 
"bool" IsItalic (self)
 
"void" SetBold (self, "bool" aBold)
 
"bool" IsBold (self)
 
"void" SetVisible (self, "bool" aVisible)
 
"bool" IsVisible (self)
 
"void" SetMirrored (self, "bool" isMirrored)
 
"bool" IsMirrored (self)
 
"void" SetMultilineAllowed (self, "bool" aAllow)
 
"bool" IsMultilineAllowed (self)
 
"EDA_TEXT_HJUSTIFY_T" GetHorizJustify (self)
 
"EDA_TEXT_VJUSTIFY_T" GetVertJustify (self)
 
"void" SetHorizJustify (self, "EDA_TEXT_HJUSTIFY_T" aType)
 
"void" SetVertJustify (self, "EDA_TEXT_VJUSTIFY_T" aType)
 
"void" SetEffects (self, "EDA_TEXT" aSrc)
 
"void" SwapEffects (self, "EDA_TEXT" aTradingPartner)
 
"void" SwapText (self, "EDA_TEXT" aTradingPartner)
 
"void" CopyText (self, "EDA_TEXT" aSrc)
 
"bool" Replace (self, "wxFindReplaceData const &" aSearchData)
 
"bool" IsDefaultFormatting (self)
 
"void" SetTextSize (self, "wxSize" aNewSize)
 
"wxSize const &" GetTextSize (self)
 
"void" SetTextWidth (self, "int" aWidth)
 
"int" GetTextWidth (self)
 
"void" SetTextHeight (self, "int" aHeight)
 
"int" GetTextHeight (self)
 
"void" SetTextPos (self, "wxPoint" aPoint)
 
"wxPoint const &" GetTextPos (self)
 
"void" SetTextX (self, "int" aX)
 
"void" SetTextY (self, "int" aY)
 
"void" Offset (self, "wxPoint" aOffset)
 
"void" Empty (self)
 
"void" Print (self, "RENDER_SETTINGS const *" aSettings, "wxPoint" aOffset, "COLOR4D" aColor, "OUTLINE_MODE" aDisplay_mode=FILLED)
 
"std::vector< wxPoint,std::allocator< wxPoint > >" TransformToSegmentList (self)
 
"void" TransformBoundingBoxWithClearanceToPolygon (self, "SHAPE_POLY_SET" aCornerBuffer, "int" aClearanceValue)
 
"std::shared_ptr< SHAPE_COMPOUND >" GetEffectiveTextShape (self)
 
"bool" TextHitTest (self, *args)
 
"int" LenSize (self, "wxString" aLine, "int" aThickness)
 
"EDA_RECT" GetTextBox (self, "int" aLine=-1, "bool" aInvertY=False)
 
"int" GetInterline (self)
 
"wxString" GetTextStyleName (self)
 
"void" GetLinePositions (self, "wxPoint_Vector" aPositions, "int" aLineCount)
 
"void" Format (self, "OUTPUTFORMATTER" aFormatter, "int" aNestLevel, "int" aControlBits)
 
"double" GetDrawRotation (self)
 
"wxPoint" GetDrawPos (self)
 
"EDA_TEXT_HJUSTIFY_T" GetDrawHorizJustify (self)
 
"EDA_TEXT_VJUSTIFY_T" GetDrawVertJustify (self)
 
"int" Compare (self, "EDA_TEXT" aOther)
 

Static Public Member Functions

"EDA_TEXT_HJUSTIFY_T" MapHorizJustify ("int" aHorizJustify)
 
"EDA_TEXT_VJUSTIFY_T" MapVertJustify ("int" aVertJustify)
 

Properties

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

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.EDA_TEXT.__init__ (   self,
*  args 
) 
    __init__(EDA_TEXT self, wxString text=wxEmptyString) -> EDA_TEXT
    __init__(EDA_TEXT self, EDA_TEXT aText) -> EDA_TEXT

Reimplemented in pcbnew.PCB_TEXT, and pcbnew.FP_TEXT.

Definition at line 2580 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ Compare()

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

Definition at line 2837 of file pcbnew.py.

◆ CopyText()

"void" pcbnew.EDA_TEXT.CopyText (   self,
"EDA_TEXT"  aSrc 
) 
CopyText(EDA_TEXT self, EDA_TEXT aSrc)

Definition at line 2704 of file pcbnew.py.

◆ Empty()

"void" pcbnew.EDA_TEXT.Empty (   self) 
Empty(EDA_TEXT self)

Definition at line 2760 of file pcbnew.py.

◆ Format()

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

Definition at line 2817 of file pcbnew.py.

◆ GetDrawHorizJustify()

"EDA_TEXT_HJUSTIFY_T" pcbnew.EDA_TEXT.GetDrawHorizJustify (   self) 
GetDrawHorizJustify(EDA_TEXT self) -> EDA_TEXT_HJUSTIFY_T

Definition at line 2829 of file pcbnew.py.

◆ GetDrawPos()

"wxPoint" pcbnew.EDA_TEXT.GetDrawPos (   self) 
GetDrawPos(EDA_TEXT self) -> wxPoint

Definition at line 2825 of file pcbnew.py.

◆ GetDrawRotation()

"double" pcbnew.EDA_TEXT.GetDrawRotation (   self) 
GetDrawRotation(EDA_TEXT self) -> double

Reimplemented in pcbnew.FP_TEXT.

Definition at line 2821 of file pcbnew.py.

◆ GetDrawVertJustify()

"EDA_TEXT_VJUSTIFY_T" pcbnew.EDA_TEXT.GetDrawVertJustify (   self) 
GetDrawVertJustify(EDA_TEXT self) -> EDA_TEXT_VJUSTIFY_T

Definition at line 2833 of file pcbnew.py.

◆ GetEffectiveTextPenWidth()

"int" pcbnew.EDA_TEXT.GetEffectiveTextPenWidth (   self,
"int"  aDefaultWidth = 0 
) 
GetEffectiveTextPenWidth(EDA_TEXT self, int aDefaultWidth=0) -> int

Definition at line 2616 of file pcbnew.py.

◆ GetEffectiveTextShape()

"std.shared_ptr< SHAPE_COMPOUND >" pcbnew.EDA_TEXT.GetEffectiveTextShape (   self) 
GetEffectiveTextShape(EDA_TEXT self) -> std::shared_ptr< SHAPE_COMPOUND >

Definition at line 2786 of file pcbnew.py.

◆ GetHorizJustify()

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

Definition at line 2676 of file pcbnew.py.

◆ GetInterline()

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

Definition at line 2805 of file pcbnew.py.

◆ GetLinePositions()

"void" pcbnew.EDA_TEXT.GetLinePositions (   self,
"wxPoint_Vector"  aPositions,
"int"  aLineCount 
) 
GetLinePositions(EDA_TEXT self, wxPoint_Vector aPositions, int aLineCount)

Definition at line 2813 of file pcbnew.py.

◆ GetShownText()

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

Reimplemented in pcbnew.PCB_TEXT, and pcbnew.FP_TEXT.

Definition at line 2592 of file pcbnew.py.

◆ GetText()

"wxString const &" pcbnew.EDA_TEXT.GetText (   self) 
GetText(EDA_TEXT self) -> wxString

Definition at line 2588 of file pcbnew.py.

◆ GetTextAngle()

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

Definition at line 2624 of file pcbnew.py.

◆ GetTextAngleDegrees()

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

Definition at line 2628 of file pcbnew.py.

◆ GetTextAngleRadians()

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

Definition at line 2632 of file pcbnew.py.

◆ GetTextBox()

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

Definition at line 2801 of file pcbnew.py.

◆ GetTextHeight()

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

Definition at line 2736 of file pcbnew.py.

◆ GetTextPos()

"wxPoint const &" pcbnew.EDA_TEXT.GetTextPos (   self) 
GetTextPos(EDA_TEXT self) -> wxPoint

Definition at line 2744 of file pcbnew.py.

◆ GetTextSize()

"wxSize const &" pcbnew.EDA_TEXT.GetTextSize (   self) 
GetTextSize(EDA_TEXT self) -> wxSize

Definition at line 2720 of file pcbnew.py.

◆ GetTextStyleName()

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

Definition at line 2809 of file pcbnew.py.

◆ GetTextThickness()

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

Definition at line 2612 of file pcbnew.py.

◆ GetTextWidth()

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

Definition at line 2728 of file pcbnew.py.

◆ GetVertJustify()

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

Definition at line 2680 of file pcbnew.py.

◆ HasTextVars()

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

Definition at line 2600 of file pcbnew.py.

◆ IsBold()

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

Definition at line 2648 of file pcbnew.py.

◆ IsDefaultFormatting()

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

Definition at line 2712 of file pcbnew.py.

◆ IsItalic()

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

Definition at line 2640 of file pcbnew.py.

◆ IsMirrored()

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

Definition at line 2664 of file pcbnew.py.

◆ IsMultilineAllowed()

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

Definition at line 2672 of file pcbnew.py.

◆ IsVisible()

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

Reimplemented in pcbnew.PCB_TEXT.

Definition at line 2656 of file pcbnew.py.

◆ LenSize()

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

Definition at line 2797 of file pcbnew.py.

◆ MapHorizJustify()

"EDA_TEXT_HJUSTIFY_T" pcbnew.EDA_TEXT.MapHorizJustify ( "int"  aHorizJustify)
static 
MapHorizJustify(int aHorizJustify) -> EDA_TEXT_HJUSTIFY_T

Definition at line 2765 of file pcbnew.py.

◆ MapVertJustify()

"EDA_TEXT_VJUSTIFY_T" pcbnew.EDA_TEXT.MapVertJustify ( "int"  aVertJustify)
static 
MapVertJustify(int aVertJustify) -> EDA_TEXT_VJUSTIFY_T

Definition at line 2770 of file pcbnew.py.

◆ Offset()

"void" pcbnew.EDA_TEXT.Offset (   self,
"wxPoint"  aOffset 
) 
Offset(EDA_TEXT self, wxPoint aOffset)

Definition at line 2756 of file pcbnew.py.

◆ Print()

"void" pcbnew.EDA_TEXT.Print (   self,
"RENDER_SETTINGS const *"  aSettings,
"wxPoint"  aOffset,
"COLOR4D"  aColor,
"OUTLINE_MODE"  aDisplay_mode = FILLED 
) 
Print(EDA_TEXT self, RENDER_SETTINGS const * aSettings, wxPoint aOffset, COLOR4D aColor, OUTLINE_MODE aDisplay_mode=FILLED)

Definition at line 2774 of file pcbnew.py.

◆ Replace()

"bool" pcbnew.EDA_TEXT.Replace (   self,
"wxFindReplaceData const &"  aSearchData 
) 
Replace(EDA_TEXT self, wxFindReplaceData const & aSearchData) -> bool

Definition at line 2708 of file pcbnew.py.

◆ SetBold()

"void" pcbnew.EDA_TEXT.SetBold (   self,
"bool"  aBold 
) 
SetBold(EDA_TEXT self, bool aBold)

Definition at line 2644 of file pcbnew.py.

◆ SetEffects()

"void" pcbnew.EDA_TEXT.SetEffects (   self,
"EDA_TEXT"  aSrc 
) 
SetEffects(EDA_TEXT self, EDA_TEXT aSrc)

Reimplemented in pcbnew.FP_TEXT.

Definition at line 2692 of file pcbnew.py.

◆ SetHorizJustify()

"void" pcbnew.EDA_TEXT.SetHorizJustify (   self,
"EDA_TEXT_HJUSTIFY_T"  aType 
) 
SetHorizJustify(EDA_TEXT self, EDA_TEXT_HJUSTIFY_T aType)

Definition at line 2684 of file pcbnew.py.

◆ SetItalic()

"void" pcbnew.EDA_TEXT.SetItalic (   self,
"bool"  isItalic 
) 
SetItalic(EDA_TEXT self, bool isItalic)

Definition at line 2636 of file pcbnew.py.

◆ SetMirrored()

"void" pcbnew.EDA_TEXT.SetMirrored (   self,
"bool"  isMirrored 
) 
SetMirrored(EDA_TEXT self, bool isMirrored)

Definition at line 2660 of file pcbnew.py.

◆ SetMultilineAllowed()

"void" pcbnew.EDA_TEXT.SetMultilineAllowed (   self,
"bool"  aAllow 
) 
SetMultilineAllowed(EDA_TEXT self, bool aAllow)

Definition at line 2668 of file pcbnew.py.

◆ SetText()

"void" pcbnew.EDA_TEXT.SetText (   self,
"wxString"  aText 
) 
SetText(EDA_TEXT self, wxString aText)

Definition at line 2604 of file pcbnew.py.

◆ SetTextAngle()

"void" pcbnew.EDA_TEXT.SetTextAngle (   self,
"double"  aAngle 
) 
SetTextAngle(EDA_TEXT self, double aAngle)

Reimplemented in pcbnew.PCB_TEXT, and pcbnew.FP_TEXT.

Definition at line 2620 of file pcbnew.py.

◆ SetTextHeight()

"void" pcbnew.EDA_TEXT.SetTextHeight (   self,
"int"  aHeight 
) 
SetTextHeight(EDA_TEXT self, int aHeight)

Definition at line 2732 of file pcbnew.py.

◆ SetTextPos()

"void" pcbnew.EDA_TEXT.SetTextPos (   self,
"wxPoint"  aPoint 
) 
SetTextPos(EDA_TEXT self, wxPoint aPoint)

Definition at line 2740 of file pcbnew.py.

◆ SetTextSize()

"void" pcbnew.EDA_TEXT.SetTextSize (   self,
"wxSize"  aNewSize 
) 
SetTextSize(EDA_TEXT self, wxSize aNewSize)

Definition at line 2716 of file pcbnew.py.

◆ SetTextThickness()

"void" pcbnew.EDA_TEXT.SetTextThickness (   self,
"int"  aWidth 
) 
SetTextThickness(EDA_TEXT self, int aWidth)

Definition at line 2608 of file pcbnew.py.

◆ SetTextWidth()

"void" pcbnew.EDA_TEXT.SetTextWidth (   self,
"int"  aWidth 
) 
SetTextWidth(EDA_TEXT self, int aWidth)

Definition at line 2724 of file pcbnew.py.

◆ SetTextX()

"void" pcbnew.EDA_TEXT.SetTextX (   self,
"int"  aX 
) 
SetTextX(EDA_TEXT self, int aX)

Definition at line 2748 of file pcbnew.py.

◆ SetTextY()

"void" pcbnew.EDA_TEXT.SetTextY (   self,
"int"  aY 
) 
SetTextY(EDA_TEXT self, int aY)

Definition at line 2752 of file pcbnew.py.

◆ SetVertJustify()

"void" pcbnew.EDA_TEXT.SetVertJustify (   self,
"EDA_TEXT_VJUSTIFY_T"  aType 
) 
SetVertJustify(EDA_TEXT self, EDA_TEXT_VJUSTIFY_T aType)

Definition at line 2688 of file pcbnew.py.

◆ SetVisible()

"void" pcbnew.EDA_TEXT.SetVisible (   self,
"bool"  aVisible 
) 
SetVisible(EDA_TEXT self, bool aVisible)

Reimplemented in pcbnew.PCB_TEXT.

Definition at line 2652 of file pcbnew.py.

◆ ShortenedShownText()

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

Definition at line 2596 of file pcbnew.py.

◆ SwapEffects()

"void" pcbnew.EDA_TEXT.SwapEffects (   self,
"EDA_TEXT"  aTradingPartner 
) 
SwapEffects(EDA_TEXT self, EDA_TEXT aTradingPartner)

Reimplemented in pcbnew.FP_TEXT.

Definition at line 2696 of file pcbnew.py.

◆ SwapText()

"void" pcbnew.EDA_TEXT.SwapText (   self,
"EDA_TEXT"  aTradingPartner 
) 
SwapText(EDA_TEXT self, EDA_TEXT aTradingPartner)

Definition at line 2700 of file pcbnew.py.

◆ TextHitTest()

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

Reimplemented in pcbnew.PCB_TEXT, and pcbnew.FP_TEXT.

Definition at line 2790 of file pcbnew.py.

Here is the caller graph for this function:

◆ TransformBoundingBoxWithClearanceToPolygon()

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

Definition at line 2782 of file pcbnew.py.

◆ TransformToSegmentList()

"std.vector< wxPoint,std.allocator< wxPoint > >" pcbnew.EDA_TEXT.TransformToSegmentList (   self) 
TransformToSegmentList(EDA_TEXT self) -> wxPoint_Vector

Definition at line 2778 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 2577 of file pcbnew.py.

The documentation for this class was generated from the following file:
Generated on Sun Jan 1 2023 00:51:22 for KiCad Pcbnew Python Scripting by doxygen 1.9.4