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

Public Member Functions

def __init__ (self, args)
 
def ClassOf (aItem)
 
def GetPosition (self)
 
def SetPosition (self, aPos)
 
def SetTextAngle (self, aAngle)
 
def IsUnlocked (self)
 
def SetUnlocked (self, unlocked)
 
def Rotate (self, aOffset, aAngle)
 
def Flip (self, aCentre)
 
def Mirror (self, aCentre, aMirrorAroundXAxis)
 
def Move (self, aMoveVector)
 
def SetType (self, aType)
 
def GetType (self)
 
def SetEffects (self, aSrc)
 
def SwapEffects (self, aTradingPartner)
 
def SetPos0 (self, aPos)
 
def GetPos0 (self)
 
def GetLength (self)
 
def GetDrawRotation (self)
 
def GetDrawRotationRadians (self)
 
def GetBoundingBox (self)
 
def SetDrawCoord (self)
 
def SetLocalCoord (self)
 
def Draw (self, args)
 
def DrawUmbilical (self, args)
 
def GetMsgPanelInfo (self, aList)
 
def TextHitTest (self, args)
 
def HitTest (self, args)
 
def GetClass (self)
 
def GetSelectMenuText (self)
 
def GetMenuImage (self)
 
def Clone (self)
 
def GetShownText (self)
 
def ViewBBox (self)
 
def ViewGetLayers (self, aLayers, aCount)
 
def ViewGetLOD (self, aLayer, aView)
 
- 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

 TEXT_is_REFERENCE = _pcbnew.TEXTE_MODULE_TEXT_is_REFERENCE
 
 TEXT_is_VALUE = _pcbnew.TEXTE_MODULE_TEXT_is_VALUE
 
 TEXT_is_DIVERS = _pcbnew.TEXTE_MODULE_TEXT_is_DIVERS
 
 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_MODULE class.

Definition at line 15244 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.TEXTE_MODULE.__init__ (   self,
  args 
)
__init__(TEXTE_MODULE self, MODULE parent, TEXTE_MODULE::TEXT_TYPE text_type) -> TEXTE_MODULE
__init__(TEXTE_MODULE self, MODULE parent) -> TEXTE_MODULE

Definition at line 15260 of file pcbnew.py.

Member Function Documentation

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

Definition at line 15273 of file pcbnew.py.

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

Definition at line 15443 of file pcbnew.py.

def pcbnew.TEXTE_MODULE.Draw (   self,
  args 
)
Draw(TEXTE_MODULE self, EDA_DRAW_PANEL * aPanel, wxDC * aDC, GR_DRAWMODE aDrawMode, wxPoint aOffset)
Draw(TEXTE_MODULE self, EDA_DRAW_PANEL * aPanel, wxDC * aDC, GR_DRAWMODE aDrawMode)

Definition at line 15386 of file pcbnew.py.

def pcbnew.TEXTE_MODULE.DrawUmbilical (   self,
  args 
)
DrawUmbilical(TEXTE_MODULE self, EDA_DRAW_PANEL * aPanel, wxDC * aDC, GR_DRAWMODE aDrawMode, wxPoint aOffset)
DrawUmbilical(TEXTE_MODULE self, EDA_DRAW_PANEL * aPanel, wxDC * aDC, GR_DRAWMODE aDrawMode)

Definition at line 15394 of file pcbnew.py.

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

Definition at line 15311 of file pcbnew.py.

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

Definition at line 15371 of file pcbnew.py.

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

Definition at line 15428 of file pcbnew.py.

def pcbnew.TEXTE_MODULE.GetDrawRotation (   self)
GetDrawRotation(TEXTE_MODULE self) -> double

Definition at line 15361 of file pcbnew.py.

def pcbnew.TEXTE_MODULE.GetDrawRotationRadians (   self)
GetDrawRotationRadians(TEXTE_MODULE self) -> double

Definition at line 15366 of file pcbnew.py.

def pcbnew.TEXTE_MODULE.GetLength (   self)
GetLength(TEXTE_MODULE self) -> int

Definition at line 15356 of file pcbnew.py.

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

Definition at line 15438 of file pcbnew.py.

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

Definition at line 15402 of file pcbnew.py.

def pcbnew.TEXTE_MODULE.GetPos0 (   self)
GetPos0(TEXTE_MODULE self) -> wxPoint

Definition at line 15351 of file pcbnew.py.

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

Definition at line 15281 of file pcbnew.py.

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

Definition at line 15433 of file pcbnew.py.

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

Definition at line 15448 of file pcbnew.py.

def pcbnew.TEXTE_MODULE.GetType (   self)
GetType(TEXTE_MODULE self) -> TEXTE_MODULE::TEXT_TYPE

Definition at line 15331 of file pcbnew.py.

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

Definition at line 15418 of file pcbnew.py.

def pcbnew.TEXTE_MODULE.IsUnlocked (   self)
IsUnlocked(TEXTE_MODULE self) -> bool

Definition at line 15296 of file pcbnew.py.

def pcbnew.TEXTE_MODULE.Mirror (   self,
  aCentre,
  aMirrorAroundXAxis 
)
Mirror(TEXTE_MODULE self, wxPoint aCentre, bool aMirrorAroundXAxis)

Definition at line 15316 of file pcbnew.py.

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

Definition at line 15321 of file pcbnew.py.

def pcbnew.TEXTE_MODULE.Rotate (   self,
  aOffset,
  aAngle 
)
Rotate(TEXTE_MODULE self, wxPoint aOffset, double aAngle)

Definition at line 15306 of file pcbnew.py.

def pcbnew.TEXTE_MODULE.SetDrawCoord (   self)
SetDrawCoord(TEXTE_MODULE self)

Definition at line 15376 of file pcbnew.py.

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

Definition at line 15336 of file pcbnew.py.

def pcbnew.TEXTE_MODULE.SetLocalCoord (   self)
SetLocalCoord(TEXTE_MODULE self)

Definition at line 15381 of file pcbnew.py.

def pcbnew.TEXTE_MODULE.SetPos0 (   self,
  aPos 
)
SetPos0(TEXTE_MODULE self, wxPoint aPos)

Definition at line 15346 of file pcbnew.py.

Here is the caller graph for this function:

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

Definition at line 15286 of file pcbnew.py.

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

Definition at line 15291 of file pcbnew.py.

def pcbnew.TEXTE_MODULE.SetType (   self,
  aType 
)
SetType(TEXTE_MODULE self, TEXTE_MODULE::TEXT_TYPE aType)

Definition at line 15326 of file pcbnew.py.

def pcbnew.TEXTE_MODULE.SetUnlocked (   self,
  unlocked 
)
SetUnlocked(TEXTE_MODULE self, bool unlocked)

Definition at line 15301 of file pcbnew.py.

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

Definition at line 15341 of file pcbnew.py.

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

Definition at line 15407 of file pcbnew.py.

def pcbnew.TEXTE_MODULE.ViewBBox (   self)
ViewBBox(TEXTE_MODULE self) -> BOX2I const

Definition at line 15453 of file pcbnew.py.

def pcbnew.TEXTE_MODULE.ViewGetLayers (   self,
  aLayers,
  aCount 
)
ViewGetLayers(TEXTE_MODULE self, int [] aLayers, int & aCount)

Definition at line 15458 of file pcbnew.py.

def pcbnew.TEXTE_MODULE.ViewGetLOD (   self,
  aLayer,
  aView 
)
ViewGetLOD(TEXTE_MODULE self, int aLayer, KIGFX::VIEW * aView) -> unsigned int

Definition at line 15463 of file pcbnew.py.

Member Data Documentation

pcbnew.TEXTE_MODULE.ClassOf = staticmethod(ClassOf)
static

Definition at line 15278 of file pcbnew.py.

pcbnew.TEXTE_MODULE.TEXT_is_DIVERS = _pcbnew.TEXTE_MODULE_TEXT_is_DIVERS
static

Definition at line 15258 of file pcbnew.py.

pcbnew.TEXTE_MODULE.TEXT_is_REFERENCE = _pcbnew.TEXTE_MODULE_TEXT_is_REFERENCE
static

Definition at line 15256 of file pcbnew.py.

pcbnew.TEXTE_MODULE.TEXT_is_VALUE = _pcbnew.TEXTE_MODULE_TEXT_is_VALUE
static

Definition at line 15257 of file pcbnew.py.

pcbnew.TEXTE_MODULE.this

Definition at line 15269 of file pcbnew.py.


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