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, aList)
 
def HitTest (self, args)
 
def GetClass (self)
 
def TransformBoundingBoxWithClearanceToPolygon (self, aCornerBuffer, aClearanceValue)
 
def TransformShapeWithClearanceToPolygonSet (self, aCornerBuffer, aClearanceValue, aCircleToSegmentsCount, aCorrectionFactor)
 
def GetSelectMenuText (self)
 
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 GetPosition (self)
 
def GetCenter (self)
 
def SetPosition (self, aPos)
 
def IsConnected (self)
 
def Next (self)
 
def Back (self)
 
def GetParent (self)
 
def GetLayer (self)
 
def GetLayerSet (self)
 
def SetLayer (self, aLayer)
 
def Draw (self, args)
 
def SwapData (self, aImage)
 
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 HitTest (self, args)
 
def FormatAngle (aAngle)
 
def FormatInternalUnits (args)
 
def ViewGetLayers (self, aLayers, aCount)
 
def TransformShapeWithClearanceToPolygon (self, aCornerBuffer, aClearanceValue, aCircleToSegmentsCount, aCorrectionFactor)
 
def Cast (self)
 
def Duplicate (self)
 
def SetPos (self, p)
 
def SetStartEnd (self, start, end)
 
- Public Member Functions inherited from pcbnew.EDA_ITEM
def __init__ (self, args, kwargs)
 
def Type (self)
 
def SetTimeStamp (self, aNewTimeStamp)
 
def GetTimeStamp (self)
 
def Next (self)
 
def Back (self)
 
def GetParent (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 SetForceVisible (self, aEnable)
 
def GetMsgPanelInfo (self, aList)
 
def HitTest (self, aPosition)
 
def GetBoundingBox (self)
 
def Clone (self)
 
def IterateForward (listStart, inspector, testData, scanTypes)
 
def Visit (self, inspector, testData, scanTypes)
 
def GetClass (self)
 
def GetSelectMenuText (self)
 
def GetMenuImage (self)
 
def Matches (self, aSearchData, aAuxData, aFindLocation)
 
def Replace (self, args)
 
def IsReplaceable (self)
 
def __lt__ (self, aItem)
 
def Sort (aLeft, aRight)
 
def ViewBBox (self)
 
def ViewGetLayers (self, aLayers, aCount)
 
- 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 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
 
- 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)
 
 FormatAngle = staticmethod(FormatAngle)
 
 FormatInternalUnits = staticmethod(FormatInternalUnits)
 
- 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 14438 of file pcbnew.py.

Constructor & Destructor Documentation

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

Definition at line 14451 of file pcbnew.py.

Member Function Documentation

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

Definition at line 14461 of file pcbnew.py.

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

Definition at line 14552 of file pcbnew.py.

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)

Definition at line 14499 of file pcbnew.py.

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

Definition at line 14494 of file pcbnew.py.

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

Definition at line 14547 of file pcbnew.py.

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

Definition at line 14522 of file pcbnew.py.

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

Definition at line 14542 of file pcbnew.py.

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

Definition at line 14507 of file pcbnew.py.

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

Definition at line 14469 of file pcbnew.py.

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

Definition at line 14537 of file pcbnew.py.

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

Definition at line 14512 of file pcbnew.py.

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

Definition at line 14479 of file pcbnew.py.

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

Definition at line 14489 of file pcbnew.py.

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

Definition at line 14474 of file pcbnew.py.

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

Definition at line 14484 of file pcbnew.py.

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

Definition at line 14557 of file pcbnew.py.

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

Definition at line 14527 of file pcbnew.py.

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

Member Data Documentation

pcbnew.TEXTE_PCB.ClassOf = staticmethod(ClassOf)
static

Definition at line 14466 of file pcbnew.py.

pcbnew.TEXTE_PCB.this

Definition at line 14457 of file pcbnew.py.


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