Inheritance diagram for pcbnew.PCB_TEXT:
Public Member Functions | |
| def | __init__ (self, parent, idtype=PCB_TEXT_T) |
| def | GetShownText (self, aAllowExtraText, aDepth=0) |
| def | Mirror (self, aCentre, aMirrorAroundXAxis) |
| def | TextHitTest (self, *args) |
| def | HitTest (self, *args) |
| def | TransformTextToPolySet (self, aBuffer, aClearance, aError, aErrorLoc) |
| def | TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, aIgnoreLineWidth=False) |
| def | GetEffectiveShape (self, *args) |
| def | ViewGetLOD (self, aLayer, aView) |
| def | GetShownText (self) |
 Public Member Functions inherited from pcbnew.BOARD_ITEM | |
| def | __init__ (self, *args, **kwargs) |
| def | SetParentGroup (self, aGroup) |
| def | GetParentGroup (self) |
| def | GetX (self) |
| def | GetY (self) |
| def | GetCenter (self) |
| def | SetX (self, aX) |
| def | SetY (self, aY) |
| def | IsConnected (self) |
| def | IsOnCopperLayer (self) |
| def | HasHole (self) |
| def | IsTented (self) |
| def | GetEffectiveShape (self, *args) |
| def | GetEffectiveHoleShape (self) |
| def | GetParent (self) |
| def | GetParentFootprint (self) |
| def | HasLineStroke (self) |
| def | GetStroke (self) |
| def | SetStroke (self, aStroke) |
| def | GetLayer (self) |
| def | GetLayerSet (self) |
| def | SetLayerSet (self, aLayers) |
| def | SetLayer (self, aLayer) |
| def | Duplicate (self) |
| def | SwapItemData (self, aImage) |
| def | IsOnLayer (self, aLayer) |
| def | IsKnockout (self) |
| def | SetIsKnockout (self, aKnockout) |
| def | IsLocked (self) |
| def | SetLocked (self, aLocked) |
| def | DeleteStructure (self) |
| def | Move (self, aMoveVector) |
| def | Rotate (self, aRotCentre, aAngle) |
| def | Flip (self, aCentre, aFlipLeftRight) |
| def | GetBoard (self, *args) |
| def | GetLayerName (self) |
| def | TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, 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 | __init__ (self, *args, **kwargs) |
| def | Type (self) |
| def | GetParent (self) |
| def | SetParent (self, aParent) |
| def | IsModified (self) |
| def | IsNew (self) |
| def | IsMoving (self) |
| def | IsSelected (self) |
| def | IsEntered (self) |
| def | IsBrightened (self) |
| def | IsRollover (self) |
| def | SetSelected (self) |
| def | SetBrightened (self) |
| def | ClearSelected (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 | XorFlags (self, aMask) |
| def | ClearFlags (self, *args) |
| def | GetFlags (self) |
| def | HasFlag (self, aFlag) |
| def | GetEditFlags (self) |
| def | ClearTempFlags (self) |
| def | ClearEditFlags (self) |
| def | RenderAsBitmap (self, aWorldScale) |
| def | SetIsShownAsBitmap (self, aBitmap) |
| def | IsShownAsBitmap (self) |
| def | IsType (self, aScanTypes) |
| def | SetForceVisible (self, aEnable) |
| def | IsForceVisible (self) |
| def | GetMsgPanelInfo (self, aFrame, aList) |
| def | GetFriendlyName (self) |
| def | HitTest (self, *args) |
| def | GetBoundingBox (self) |
| def | GetPosition (self) |
| def | SetPosition (self, aPos) |
| def | GetFocusPosition (self) |
| def | GetSortPosition (self) |
| def | Clone (self) |
| def | Visit (self, inspector, testData, aScanTypes) |
| def | GetClass (self) |
| def | GetTypeDesc (self) |
| def | GetItemDescription (self, aUnitsProvider) |
| def | GetMenuImage (self) |
| def | Matches (self, aSearchData, aAuxData) |
| def | Replace (self, *args) |
| def | IsReplaceable (self) |
| def | __lt__ (self, aItem) |
| 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, aAllowExtraText, aDepth=0) |
| def | HasTextVars (self) |
| def | SetText (self, aText) |
| def | SetTextThickness (self, aWidth) |
| def | GetTextThickness (self) |
| def | GetEffectiveTextPenWidth (self, aDefaultPenWidth=0) |
| def | SetTextAngle (self, aAngle) |
| def | GetTextAngle (self) |
| def | SetTextAngleDegrees (self, aOrientation) |
| def | GetTextAngleDegrees (self) |
| def | SetItalic (self, aItalic) |
| 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 | SetHorizJustify (self, aType) |
| def | GetHorizJustify (self) |
| def | SetVertJustify (self, aType) |
| def | GetVertJustify (self) |
| def | SetKeepUpright (self, aKeepUpright) |
| def | IsKeepUpright (self) |
| def | SwapAttributes (self, aTradingPartner) |
| def | SwapText (self, aTradingPartner) |
| def | CopyText (self, aSrc) |
| def | SetAttributes (self, *args) |
| def | GetAttributes (self) |
| def | Replace (self, aSearchData) |
| def | IsDefaultFormatting (self) |
| def | SetFont (self, aFont) |
| def | GetFont (self) |
| def | GetFontName (self) |
| def | SetLineSpacing (self, aLineSpacing) |
| def | GetLineSpacing (self) |
| def | SetTextSize (self, aNewSize) |
| def | GetTextSize (self) |
| def | SetTextWidth (self, aWidth) |
| def | GetTextWidth (self) |
| def | SetTextHeight (self, aHeight) |
| def | GetTextHeight (self) |
| def | SetTextColor (self, aColor) |
| def | GetTextColor (self) |
| def | SetTextPos (self, aPoint) |
| def | GetTextPos (self) |
| def | SetTextX (self, aX) |
| def | SetTextY (self, aY) |
| def | Offset (self, aOffset) |
| def | Empty (self) |
| def | Print (self, aSettings, aOffset, aColor, aDisplay_mode=FILLED) |
| def | GetEffectiveTextShapeNative (self, *args) |
| def | TextHitTest (self, *args) |
| def | GetTextBox (self, aLine=-1, aInvertY=False) |
| def | GetInterline (self) |
| def | GetTextStyleName (self) |
| def | GetLinePositions (self, aPositions, aLineCount) |
| def | Format (self, aFormatter, aNestLevel, aControlBits) |
| def | GetDrawRotation (self) |
| def | GetDrawPos (self) |
| def | ClearRenderCache (self) |
| def | ClearBoundingBoxCache (self) |
| def | GetRenderCache (self, *args) |
| def | SetupRenderCache (self, aResolvedText, aAngle) |
| def | AddRenderCacheGlyph (self, aPoly) |
| def | Compare (self, aOther) |
| def | HasHyperlink (self) |
| def | GetHyperlink (self) |
| def | SetHyperlink (self, aLink) |
| def | RemoveHyperlink (self) |
| def | GetEffectiveTextShape (self, aTriangulate=True, aUseTextRotation=True) |
| def | GetShownText (self) |
Static Public Member Functions | |
| def | ClassOf (aItem) |
| Static Public Member Functions inherited from pcbnew.EDA_ITEM | |
| def | Sort (aLeft, aRight) |
| Static Public Member Functions inherited from pcbnew.EDA_TEXT | |
| def | MapHorizJustify (aHorizJustify) |
| def | MapVertJustify (aVertJustify) |
| def | ValidateHyperlink (aURL) |
| def | IsGotoPageHref (aHref, aDestination=None) |
| def | GotoPageHref (aDestination) |
Properties | |
| thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag") | |
| Properties inherited from pcbnew.BOARD_ITEM | |
| thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag") | |
| Properties inherited from pcbnew.EDA_ITEM | |
| thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag") | |
| m_Uuid = property(_pcbnew.EDA_ITEM_m_Uuid_get, doc=) | |
| Properties inherited from pcbnew.EDA_TEXT | |
| thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag") | |
Detailed Description
Constructor & Destructor Documentation
◆ __init__()
| def pcbnew.PCB_TEXT.__init__ | ( | self, | |
| parent, | |||
idtype = PCB_TEXT_T |
|||
| ) |
__init__(PCB_TEXT self, BOARD_ITEM parent, KICAD_T idtype=PCB_TEXT_T) -> PCB_TEXT
Reimplemented from pcbnew.EDA_TEXT.
Reimplemented in pcbnew.PCB_DIMENSION_BASE, pcbnew.PCB_DIM_ORTHOGONAL, pcbnew.PCB_DIM_RADIAL, pcbnew.PCB_DIM_LEADER, pcbnew.PCB_DIM_CENTER, and pcbnew.PCB_DIM_ALIGNED.
Member Function Documentation
◆ ClassOf()
|
static |
ClassOf(EDA_ITEM aItem) -> bool
Reimplemented in pcbnew.PCB_DIM_ALIGNED, pcbnew.PCB_DIM_ORTHOGONAL, pcbnew.PCB_DIM_RADIAL, pcbnew.PCB_DIM_LEADER, and pcbnew.PCB_DIM_CENTER.
◆ GetEffectiveShape()
| def pcbnew.PCB_TEXT.GetEffectiveShape | ( | self, | |
| * | args | ||
| ) |
GetEffectiveShape(PCB_TEXT self, PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=DEFAULT) -> std::shared_ptr< SHAPE >
Reimplemented from pcbnew.BOARD_ITEM.
Reimplemented in pcbnew.PCB_DIMENSION_BASE.
◆ GetShownText() [1/2]
| def pcbnew.PCB_TEXT.GetShownText | ( | self | ) |
GetShownText(PCB_TEXT self) -> wxString
Reimplemented from pcbnew.EDA_TEXT.
◆ GetShownText() [2/2]
| def pcbnew.PCB_TEXT.GetShownText | ( | self, | |
| aAllowExtraText, | |||
aDepth = 0 |
|||
| ) |
GetShownText(PCB_TEXT self, bool aAllowExtraText, int aDepth=0) -> wxString
Reimplemented from pcbnew.EDA_TEXT.
◆ HitTest()
| def pcbnew.PCB_TEXT.HitTest | ( | self, | |
| * | args | ||
| ) |
HitTest(PCB_TEXT self, VECTOR2I aPosition, int aAccuracy) -> bool
HitTest(PCB_TEXT self, BOX2I aRect, bool aContained, int aAccuracy=0) -> bool
Reimplemented from pcbnew.EDA_ITEM.
Reimplemented in pcbnew.PCB_DIMENSION_BASE.
Definition at line 14918 of file pcbnew.py.
Here is the caller graph for this function:
◆ Mirror()
| def pcbnew.PCB_TEXT.Mirror | ( | self, | |
| aCentre, | |||
| aMirrorAroundXAxis | |||
| ) |
Mirror(PCB_TEXT self, VECTOR2I aCentre, bool aMirrorAroundXAxis)
Reimplemented in pcbnew.PCB_DIMENSION_BASE, and pcbnew.PCB_DIM_ALIGNED.
◆ TextHitTest()
| def pcbnew.PCB_TEXT.TextHitTest | ( | self, | |
| * | args | ||
| ) |
TextHitTest(PCB_TEXT self, VECTOR2I aPoint, int aAccuracy=0) -> bool
TextHitTest(PCB_TEXT self, BOX2I aRect, bool aContains, int aAccuracy=0) -> bool
Reimplemented from pcbnew.EDA_TEXT.
Definition at line 14911 of file pcbnew.py.
Here is the caller graph for this function:
◆ TransformShapeToPolygon()
| def pcbnew.PCB_TEXT.TransformShapeToPolygon | ( | self, | |
| aBuffer, | |||
| aLayer, | |||
| aClearance, | |||
| aError, | |||
| aErrorLoc, | |||
aIgnoreLineWidth = False |
|||
| ) |
TransformShapeToPolygon(PCB_TEXT self, SHAPE_POLY_SET aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool aIgnoreLineWidth=False)
Reimplemented from pcbnew.BOARD_ITEM.
Reimplemented in pcbnew.PCB_DIMENSION_BASE.
◆ TransformTextToPolySet()
| def pcbnew.PCB_TEXT.TransformTextToPolySet | ( | self, | |
| aBuffer, | |||
| aClearance, | |||
| aError, | |||
| aErrorLoc | |||
| ) |
◆ ViewGetLOD()
| def pcbnew.PCB_TEXT.ViewGetLOD | ( | self, | |
| aLayer, | |||
| aView | |||
| ) |
Property Documentation
◆ thisown
|
static |
The documentation for this class was generated from the following file:
