KiCad Pcbnew Python Scripting
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
pcbnew.TEXTE_PCB Class Reference
Inheritance diagram for pcbnew.TEXTE_PCB:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, parent)
 
def ClassOf (aItem)
 
def GetPosition (self)
 
def SetPosition (self, aPos)
 
def Move (self, aMoveVector)
 
def SetTextAngle (self, aAngle)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre)
 
def Draw (self, *args)
 
def GetMsgPanelInfo (self, aUnits, aList)
 
def HitTest (self, *args)
 
def GetClass (self)
 
def TransformShapeWithClearanceToPolygonSet (self, aCornerBuffer, aClearanceValue, aCircleToSegmentsCount, aCorrectionFactor)
 
def GetSelectMenuText (self, aUnits)
 
def GetMenuImage (self)
 
def GetBoundingBox (self)
 
def Clone (self)
 
def SwapData (self, aImage)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
def __init__ (self, *args, **kwargs)
 
def GetCenter (self)
 
def IsConnected (self)
 
def Next (self)
 
def Back (self)
 
def GetParent (self)
 
def GetLayer (self)
 
def GetLayerSet (self)
 
def SetLayer (self, aLayer)
 
def IsOnLayer (self, aLayer)
 
def IsTrack (self)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
def UnLink (self)
 
def DeleteStructure (self)
 
def ShowShape (aShape)
 
def Move (self, *args)
 
def Rotate (self, *args)
 
def Flip (self, *args)
 
def GetBoard (self)
 
def GetLayerName (self)
 
def ViewGetLayers (self, aLayers, aCount)
 
def TransformShapeWithClearanceToPolygon (self, aCornerBuffer, aClearanceValue, aCircleToSegmentsCount, aCorrectionFactor, ignoreLineWidth=False)
 
def Cast (self)
 
def Duplicate (self)
 
def SetPos (self, p)
 
def SetStartEnd (self, start, end)
 
- Public Member Functions inherited from pcbnew.EDA_ITEM
def Type (self)
 
def SetTimeStamp (self, aNewTimeStamp)
 
def GetTimeStamp (self)
 
def GetList (self)
 
def SetParent (self, aParent)
 
def SetList (self, aList)
 
def IsNew (self)
 
def IsModified (self)
 
def IsMoving (self)
 
def IsDragging (self)
 
def IsWireImage (self)
 
def IsSelected (self)
 
def IsResized (self)
 
def IsHighlighted (self)
 
def IsBrightened (self)
 
def SetWireImage (self)
 
def SetSelected (self)
 
def SetHighlighted (self)
 
def SetBrightened (self)
 
def ClearSelected (self)
 
def ClearHighlighted (self)
 
def ClearBrightened (self)
 
def SetModified (self)
 
def GetState (self, type)
 
def SetState (self, type, state)
 
def GetStatus (self)
 
def SetStatus (self, aStatus)
 
def SetFlags (self, aMask)
 
def ClearFlags (self, aMask=-1)
 
def GetFlags (self)
 
def GetEditFlags (self)
 
def ClearTempFlags (self)
 
def IsType (self, aScanTypes)
 
def SetForceVisible (self, aEnable)
 
def IterateForward (listStart, inspector, testData, scanTypes)
 
def Visit (self, inspector, testData, scanTypes)
 
def Matches (self, aSearchData, aAuxData, aFindLocation)
 
def Replace (self, *args)
 
def IsReplaceable (self)
 
def __lt__ (self, aItem)
 
def Sort (aLeft, aRight)
 
def ViewBBox (self)
 
- Public Member Functions inherited from pcbnew.EDA_TEXT
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 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 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

 this
 
- Public Attributes inherited from pcbnew.EDA_TEXT
 this
 

Static Public Attributes

 ClassOf = staticmethod(ClassOf)
 
- Static Public Attributes inherited from pcbnew.BOARD_ITEM
 ShowShape = staticmethod(ShowShape)
 
- Static Public Attributes inherited from pcbnew.EDA_ITEM
 IterateForward = staticmethod(IterateForward)
 
 Sort = staticmethod(Sort)
 

Detailed Description

Proxy of C++ TEXTE_PCB class.

Definition at line 14374 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.TEXTE_PCB.__init__ (   self,
  parent 
)
__init__(TEXTE_PCB self, BOARD_ITEM parent) -> TEXTE_PCB

Definition at line 14387 of file pcbnew.py.

Member Function Documentation

◆ ClassOf()

def pcbnew.TEXTE_PCB.ClassOf (   aItem)
ClassOf(EDA_ITEM aItem) -> bool

Definition at line 14397 of file pcbnew.py.

◆ Clone()

def pcbnew.TEXTE_PCB.Clone (   self)
Clone(TEXTE_PCB self) -> EDA_ITEM

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14480 of file pcbnew.py.

◆ Draw()

def pcbnew.TEXTE_PCB.Draw (   self,
args 
)
Draw(TEXTE_PCB self, EDA_DRAW_PANEL * panel, wxDC * DC, GR_DRAWMODE aDrawMode, wxPoint offset)
Draw(TEXTE_PCB self, EDA_DRAW_PANEL * panel, wxDC * DC, GR_DRAWMODE aDrawMode)

Reimplemented from pcbnew.EDA_TEXT.

Definition at line 14433 of file pcbnew.py.

◆ Flip()

def pcbnew.TEXTE_PCB.Flip (   self,
  aCentre 
)
Flip(TEXTE_PCB self, wxPoint aCentre)

Definition at line 14428 of file pcbnew.py.

◆ GetBoundingBox()

def pcbnew.TEXTE_PCB.GetBoundingBox (   self)
GetBoundingBox(TEXTE_PCB self) -> EDA_RECT

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14475 of file pcbnew.py.

◆ GetClass()

def pcbnew.TEXTE_PCB.GetClass (   self)
GetClass(TEXTE_PCB self) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14455 of file pcbnew.py.

◆ GetMenuImage()

def pcbnew.TEXTE_PCB.GetMenuImage (   self)
GetMenuImage(TEXTE_PCB self) -> BITMAP_DEF

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14470 of file pcbnew.py.

◆ GetMsgPanelInfo()

def pcbnew.TEXTE_PCB.GetMsgPanelInfo (   self,
  aUnits,
  aList 
)
GetMsgPanelInfo(TEXTE_PCB self, EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > & aList)

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14441 of file pcbnew.py.

◆ GetPosition()

def pcbnew.TEXTE_PCB.GetPosition (   self)
GetPosition(TEXTE_PCB self) -> wxPoint

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 14403 of file pcbnew.py.

◆ GetSelectMenuText()

def pcbnew.TEXTE_PCB.GetSelectMenuText (   self,
  aUnits 
)
GetSelectMenuText(TEXTE_PCB self, EDA_UNITS_T aUnits) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14465 of file pcbnew.py.

◆ HitTest()

def pcbnew.TEXTE_PCB.HitTest (   self,
args 
)
HitTest(TEXTE_PCB self, wxPoint aPosition, int aAccuracy) -> bool
HitTest(TEXTE_PCB self, EDA_RECT aRect, bool aContained, int aAccuracy=0) -> bool
HitTest(TEXTE_PCB self, EDA_RECT aRect, bool aContained) -> bool

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14446 of file pcbnew.py.

◆ Move()

def pcbnew.TEXTE_PCB.Move (   self,
  aMoveVector 
)
Move(TEXTE_PCB self, wxPoint aMoveVector)

Definition at line 14413 of file pcbnew.py.

◆ Rotate()

def pcbnew.TEXTE_PCB.Rotate (   self,
  aRotCentre,
  aAngle 
)
Rotate(TEXTE_PCB self, wxPoint aRotCentre, double aAngle)

Definition at line 14423 of file pcbnew.py.

◆ SetPosition()

def pcbnew.TEXTE_PCB.SetPosition (   self,
  aPos 
)
SetPosition(TEXTE_PCB self, wxPoint aPos)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 14408 of file pcbnew.py.

◆ SetTextAngle()

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

Reimplemented from pcbnew.EDA_TEXT.

Definition at line 14418 of file pcbnew.py.

◆ SwapData()

def pcbnew.TEXTE_PCB.SwapData (   self,
  aImage 
)
SwapData(TEXTE_PCB self, BOARD_ITEM aImage)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 14485 of file pcbnew.py.

◆ TransformShapeWithClearanceToPolygonSet()

def pcbnew.TEXTE_PCB.TransformShapeWithClearanceToPolygonSet (   self,
  aCornerBuffer,
  aClearanceValue,
  aCircleToSegmentsCount,
  aCorrectionFactor 
)
TransformShapeWithClearanceToPolygonSet(TEXTE_PCB self, SHAPE_POLY_SET aCornerBuffer, int aClearanceValue, int aCircleToSegmentsCount, double aCorrectionFactor)

Definition at line 14460 of file pcbnew.py.

Member Data Documentation

◆ ClassOf

pcbnew.TEXTE_PCB.ClassOf = staticmethod(ClassOf)
static

Definition at line 14401 of file pcbnew.py.

◆ this

pcbnew.TEXTE_PCB.this

Definition at line 14393 of file pcbnew.py.


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