Inheritance diagram for pcbnew.PCB_TEXT:
Public Member Functions | |
| def | __init__ (self, *args) |
| def | Serialize (self, aContainer) |
| def | Deserialize (self, aContainer) |
| def | KeepUpright (self) |
| def | GetShownText (self, aAllowExtraText, aDepth=0) |
| def | TextHitTest (self, *args) |
| def | HitTest (self, *args) |
| def | GetClass (self) |
| def | TransformTextToPolySet (self, aBuffer, aClearance, aMaxError, aErrorLoc) |
| def | TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aMaxError, aErrorLoc, aIgnoreLineWidth=False) |
| def | GetEffectiveShape (self, *args) |
| def | GetKnockoutCache (self, aFont, forResolvedText, aMaxError) |
| def | GetTextTypeDescription (self) |
| def | ViewGetLOD (self, aLayer, aView) |
| def | __eq__ (self, *args) |
 Public Member Functions inherited from pcbnew.BOARD_ITEM | |
| def | __init__ (self, *args, **kwargs) |
| def | CopyFrom (self, aOther) |
| 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 | Similarity (self, aItem) |
| def | __eq__ (self, aItem) |
| def | IsOnCopperLayer (self) |
| def | HasHole (self) |
| def | HasDrilledHole (self) |
| def | IsTented (self, aLayer) |
| def | GetEffectiveShape (self, *args) |
| def | GetEffectiveHoleShape (self) |
| def | RunOnChildren (self, aFunction) |
| def | RunOnDescendants (self, aFunction, aDepth=0) |
| def | GetParent (self) |
| def | GetParentFootprint (self) |
| def | GetFPRelativePosition (self) |
| def | SetFPRelativePosition (self, aPos) |
| def | HasLineStroke (self) |
| def | GetStroke (self) |
| def | SetStroke (self, aStroke) |
| def | GetFontMetrics (self) |
| def | GetLayer (self) |
| def | BoardLayerCount (self) |
| def | BoardCopperLayerCount (self) |
| def | BoardLayerSet (self) |
| def | GetLayerSet (self) |
| def | SetLayerSet (self, aLayers) |
| def | IsSideSpecific (self) |
| 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 | StyleFromSettings (self, settings) |
| def | DeleteStructure (self) |
| def | Move (self, aMoveVector) |
| def | Rotate (self, aRotCentre, aAngle) |
| def | Flip (self, aCentre, aFlipDirection) |
| def | Mirror (self, aCentre, aFlipDirection) |
| def | Normalize (self) |
| def | NormalizeForCompare (self) |
| def | GetBoard (self, *args) |
| def | GetParentAsString (self) |
| 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 | SetIsRollover (self, aIsRollover) |
| def | SetSelected (self) |
| def | SetBrightened (self) |
| def | ClearSelected (self) |
| def | ClearBrightened (self) |
| def | SetModified (self) |
| def | SetFlags (self, aMask) |
| def | XorFlags (self, aMask) |
| def | ClearFlags (self, *args) |
| def | GetFlags (self) |
| def | HasFlag (self, aFlag) |
| def | GetEditFlags (self) |
| def | ClearEditFlags (self) |
| def | GetTempFlags (self) |
| def | ClearTempFlags (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 | GetTypeDesc (self) |
| def | GetItemDescription (self, aUnitsProvider, aFull) |
| 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) |
| def | GetEmbeddedFiles (self) |
| def | PyGetClass (self) |
| def | GetClass (self) |
| Public Member Functions inherited from pcbnew.EDA_TEXT | |
| def | __init__ (self, *args) |
| def | Serialize (self, aContainer) |
| def | Deserialize (self, aContainer) |
| 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 | SetItalicFlag (self, aItalic) |
| def | IsItalic (self) |
| def | SetBold (self, aBold) |
| def | SetBoldFlag (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 | FlipHJustify (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 | SetUnresolvedFontName (self, aFontName) |
| def | ResolveFont (self, aEmbeddedFonts) |
| def | GetFontName (self) |
| def | SetFontIndex (self, aIdx) |
| def | GetFontIndex (self) |
| def | SetLineSpacing (self, aLineSpacing) |
| def | GetLineSpacing (self) |
| def | SetTextSize (self, aNewSize, aEnforceMinTextSize=True) |
| 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 | GetEffectiveTextShape (self, *args) |
| def | TextHitTest (self, *args) |
| def | GetTextBox (self, aSettings, aLine=-1) |
| def | GetInterline (self, aSettings) |
| def | GetTextStyleName (self) |
| def | GetLinePositions (self, aSettings, aPositions, aLineCount) |
| def | Levenshtein (self, aOther) |
| def | Similarity (self, aOther) |
| def | Format (self, aFormatter, aControlBits) |
| def | GetDrawRotation (self) |
| def | GetDrawPos (self) |
| def | GetDrawFont (self, aSettings) |
| def | ClearRenderCache (self) |
| def | ClearBoundingBoxCache (self) |
| def | GetRenderCache (self, *args) |
| def | SetupRenderCache (self, aResolvedText, aFont, aAngle, aOffset) |
| def | AddRenderCacheGlyph (self, aPoly) |
| def | Compare (self, aOther) |
| def | __eq__ (self, aRhs) |
| def | __lt__ (self, aRhs) |
| def | __gt__ (self, aRhs) |
| def | HasHyperlink (self) |
| def | GetHyperlink (self) |
| def | SetHyperlink (self, aLink) |
| def | RemoveHyperlink (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 | |
| property | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag") |
| Properties inherited from pcbnew.BOARD_ITEM | |
| property | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag") |
| Properties inherited from pcbnew.EDA_ITEM | |
| property | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag") |
| property | m_Uuid = property(_pcbnew.EDA_ITEM_m_Uuid_get, doc=) |
| Properties inherited from pcbnew.EDA_TEXT | |
| property | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag") |
Additional Inherited Members | |
| Static Public Attributes inherited from pcbnew.BOARD_ITEM | |
| _pcbnew | DRC = _pcbnew.BOARD_ITEM_DRC |
| _pcbnew | INSTANCE_TO_INSTANCE = _pcbnew.BOARD_ITEM_INSTANCE_TO_INSTANCE |
Detailed Description
Constructor & Destructor Documentation
◆ __init__()
| def pcbnew.PCB_TEXT.__init__ | ( | self, | |
| * | args | ||
| ) |
__init__(PCB_TEXT self, BOARD_ITEM parent, KICAD_T idtype=PCB_TEXT_T) -> PCB_TEXT
__init__(PCB_TEXT self, FOOTPRINT aParent, KICAD_T idtype=PCB_TEXT_T) -> PCB_TEXT
Reimplemented from pcbnew.EDA_TEXT.
Reimplemented in pcbnew.PCB_FIELD, 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.
Definition at line 16643 of file pcbnew.py.
Here is the caller graph for this function:
Member Function Documentation
◆ __eq__()
| def pcbnew.PCB_TEXT.__eq__ | ( | self, | |
| * | args | ||
| ) |
__eq__(PCB_TEXT self, PCB_TEXT aOther) -> bool
__eq__(PCB_TEXT self, BOARD_ITEM aBoardItem) -> bool
Reimplemented from pcbnew.EDA_TEXT.
Reimplemented in pcbnew.PCB_FIELD, and pcbnew.PCB_DIMENSION_BASE.
Definition at line 16714 of file pcbnew.py.
Here is the caller graph for this function:
◆ ClassOf()
|
static |
ClassOf(EDA_ITEM aItem) -> bool
Reimplemented in pcbnew.PCB_FIELD, pcbnew.PCB_DIM_ALIGNED, pcbnew.PCB_DIM_ORTHOGONAL, pcbnew.PCB_DIM_RADIAL, pcbnew.PCB_DIM_LEADER, and pcbnew.PCB_DIM_CENTER.
◆ Deserialize()
| def pcbnew.PCB_TEXT.Deserialize | ( | self, | |
| aContainer | |||
| ) |
Deserialize(PCB_TEXT self, google::protobuf::Any const & aContainer) -> bool
Reimplemented from pcbnew.EDA_TEXT.
Reimplemented in pcbnew.PCB_FIELD, pcbnew.PCB_DIMENSION_BASE, pcbnew.PCB_DIM_ALIGNED, pcbnew.PCB_DIM_ORTHOGONAL, pcbnew.PCB_DIM_RADIAL, pcbnew.PCB_DIM_LEADER, and pcbnew.PCB_DIM_CENTER.
◆ GetClass()
| def pcbnew.PCB_TEXT.GetClass | ( | self | ) |
GetClass(PCB_TEXT self) -> wxString
Reimplemented from pcbnew.EDA_ITEM.
Reimplemented in pcbnew.PCB_FIELD, pcbnew.PCB_DIM_ALIGNED, pcbnew.PCB_DIM_ORTHOGONAL, pcbnew.PCB_DIM_RADIAL, pcbnew.PCB_DIM_LEADER, and pcbnew.PCB_DIM_CENTER.
Definition at line 16686 of file pcbnew.py.
Here is the caller graph for this function:
◆ 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.
◆ GetKnockoutCache()
| def pcbnew.PCB_TEXT.GetKnockoutCache | ( | self, | |
| aFont, | |||
| forResolvedText, | |||
| aMaxError | |||
| ) |
◆ GetShownText()
| def pcbnew.PCB_TEXT.GetShownText | ( | self, | |
| aAllowExtraText, | |||
aDepth = 0 |
|||
| ) |
GetShownText(PCB_TEXT self, bool aAllowExtraText, int aDepth=0) -> wxString
Reimplemented from pcbnew.EDA_TEXT.
◆ GetTextTypeDescription()
| def pcbnew.PCB_TEXT.GetTextTypeDescription | ( | self | ) |
◆ 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 16679 of file pcbnew.py.
Here is the caller graph for this function:
◆ KeepUpright()
| def pcbnew.PCB_TEXT.KeepUpright | ( | self | ) |
◆ Serialize()
| def pcbnew.PCB_TEXT.Serialize | ( | self, | |
| aContainer | |||
| ) |
Serialize(PCB_TEXT self, google::protobuf::Any & aContainer)
Reimplemented from pcbnew.EDA_TEXT.
Reimplemented in pcbnew.PCB_FIELD, pcbnew.PCB_DIMENSION_BASE, pcbnew.PCB_DIM_ALIGNED, pcbnew.PCB_DIM_ORTHOGONAL, pcbnew.PCB_DIM_RADIAL, pcbnew.PCB_DIM_LEADER, and pcbnew.PCB_DIM_CENTER.
◆ 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 16672 of file pcbnew.py.
Here is the caller graph for this function:
◆ TransformShapeToPolygon()
| def pcbnew.PCB_TEXT.TransformShapeToPolygon | ( | self, | |
| aBuffer, | |||
| aLayer, | |||
| aClearance, | |||
| aMaxError, | |||
| aErrorLoc, | |||
aIgnoreLineWidth = False |
|||
| ) |
TransformShapeToPolygon(PCB_TEXT self, SHAPE_POLY_SET aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aMaxError, 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, | |||
| aMaxError, | |||
| aErrorLoc | |||
| ) |
◆ ViewGetLOD()
| def pcbnew.PCB_TEXT.ViewGetLOD | ( | self, | |
| aLayer, | |||
| aView | |||
| ) |
ViewGetLOD(PCB_TEXT self, int aLayer, KIGFX::VIEW const * aView) -> double
Reimplemented in pcbnew.PCB_FIELD.
Property Documentation
◆ thisown
|
static |
The documentation for this class was generated from the following file:
