Inheritance diagram for pcbnew.PCB_TEXT:

[legend]

Public Member Functions
	__init__ (self, *args)

	Serialize (self, aContainer)

	Deserialize (self, aContainer)

	KeepUpright (self)

	GetShownText (self, aAllowExtraText, aDepth=0)

	TextHitTest (self, *args)

	HitTest (self, *args)

	GetClass (self)

	TransformTextToPolySet (self, aBuffer, aClearance, aMaxError, aErrorLoc)

	TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aMaxError, aErrorLoc, aIgnoreLineWidth=False)

	GetEffectiveShape (self, *args)

	GetKnockoutCache (self, aFont, forResolvedText, aMaxError)

	GetTextTypeDescription (self)

	ViewGetLOD (self, aLayer, aView)

	__eq__ (self, *args)

Public Member Functions inherited from pcbnew.BOARD_ITEM
	__init__ (self, args, *kwargs)

	CopyFrom (self, aOther)

	IsGroupableType (self)

	GetX (self)

	GetY (self)

	GetCenter (self)

	SetX (self, aX)

	SetY (self, aY)

	IsConnected (self)

	Similarity (self, aItem)

	__eq__ (self, aItem)

	IsOnCopperLayer (self)

	HasHole (self)

	HasDrilledHole (self)

	IsTented (self, aLayer)

	GetEffectiveHoleShape (self)

	RunOnChildren (self, aFunction, aMode)

	GetParent (self)

	GetParentFootprint (self)

	GetFPRelativePosition (self)

	SetFPRelativePosition (self, aPos)

	HasLineStroke (self)

	GetStroke (self)

	SetStroke (self, aStroke)

	GetFontMetrics (self)

	GetLayer (self)

	BoardLayerCount (self)

	BoardCopperLayerCount (self)

	BoardLayerSet (self)

	GetLayerSet (self)

	SetLayerSet (self, aLayers)

	IsSideSpecific (self)

	SetLayer (self, aLayer)

	Duplicate (self, addToParentGroup, aCommit=None)

	SwapItemData (self, aImage)

	IsOnLayer (self, aLayer)

	IsKnockout (self)

	SetIsKnockout (self, aKnockout)

	GetMaxError (self)

	StyleFromSettings (self, settings, aCheckSide)

	DeleteStructure (self)

	Move (self, aMoveVector)

	Rotate (self, aRotCentre, aAngle)

	Flip (self, aCentre, aFlipDirection)

	Mirror (self, aCentre, aFlipDirection)

	Normalize (self)

	NormalizeForCompare (self)

	GetBoard (self, *args)

	GetParentAsString (self)

	GetLayerName (self)

	TransformShapeToPolySet (self, aBuffer, aLayer, aClearance, aError, aErrorLoc)

	Cast (self)

	Duplicate (self)

	SetPos (self, p)

	SetStartEnd (self, start, end)

Public Member Functions inherited from pcbnew.EDA_ITEM
	__init__ (self, args, *kwargs)

	Type (self)

	SetParent (self, aParent)

	SetParentGroup (self, aGroup)

	GetParentGroup (self)

	GetParentGroupId (self)

	IsLocked (self)

	SetLocked (self, aLocked)

	IsModified (self)

	IsNew (self)

	IsMoving (self)

	IsSelected (self)

	IsEntered (self)

	IsBrightened (self)

	IsRollover (self)

	SetIsRollover (self, aIsRollover)

	SetSelected (self)

	SetBrightened (self)

	ClearSelected (self)

	ClearBrightened (self)

	SetModified (self)

	SetFlags (self, aMask)

	XorFlags (self, aMask)

	ClearFlags (self, *args)

	GetFlags (self)

	HasFlag (self, aFlag)

	GetEditFlags (self)

	ClearEditFlags (self)

	GetTempFlags (self)

	ClearTempFlags (self)

	RenderAsBitmap (self, aWorldScale)

	SetIsShownAsBitmap (self, aBitmap)

	IsShownAsBitmap (self)

	IsType (self, aScanTypes)

	SetForceVisible (self, aEnable)

	IsForceVisible (self)

	GetMsgPanelInfo (self, aFrame, aList)

	GetFriendlyName (self)

	GetBoundingBox (self)

	GetPosition (self)

	SetPosition (self, aPos)

	GetFocusPosition (self)

	GetSortPosition (self)

	Clone (self)

	Visit (self, inspector, testData, aScanTypes)

	GetTypeDesc (self)

	GetItemDescription (self, aUnitsProvider, aFull)

	GetMenuImage (self)

	Matches (self, aSearchData, aAuxData)

	Replace (self, *args)

	IsReplaceable (self)

	__lt__ (self, aItem)

	ViewBBox (self)

	ViewGetLayers (self)

	GetEmbeddedFiles (self)

	GetEmbeddedFonts (self)

	PyGetClass (self)

Public Member Functions inherited from pcbnew.EDA_TEXT
	__init__ (self, *args)

	GetText (self)

	HasTextVars (self)

	SetText (self, aText)

	EvaluateText (self, aText)

	SetTextThickness (self, aWidth)

	GetTextThickness (self)

	GetTextThicknessProperty (self)

	SetAutoThickness (self, aAuto)

	GetAutoThickness (self)

	GetEffectiveTextPenWidth (self, aDefaultPenWidth=0)

	SetTextAngle (self, aAngle)

	GetTextAngle (self)

	SetTextAngleDegrees (self, aOrientation)

	GetTextAngleDegrees (self)

	SetItalic (self, aItalic)

	SetItalicFlag (self, aItalic)

	IsItalic (self)

	SetBold (self, aBold)

	SetBoldFlag (self, aBold)

	IsBold (self)

	SetVisible (self, aVisible)

	IsVisible (self)

	SetMirrored (self, isMirrored)

	IsMirrored (self)

	SetMultilineAllowed (self, aAllow)

	IsMultilineAllowed (self)

	SetHorizJustify (self, aType)

	GetHorizJustify (self)

	SetVertJustify (self, aType)

	GetVertJustify (self)

	SetKeepUpright (self, aKeepUpright)

	IsKeepUpright (self)

	FlipHJustify (self)

	SwapAttributes (self, aTradingPartner)

	SwapText (self, aTradingPartner)

	CopyText (self, aSrc)

	SetAttributes (self, *args)

	GetAttributes (self)

	Replace (self, aSearchData)

	IsDefaultFormatting (self)

	SetFont (self, aFont)

	GetFont (self)

	SetUnresolvedFontName (self, aFontName)

	ResolveFont (self, aEmbeddedFonts)

	GetFontName (self)

	SetFontProp (self, aFontName)

	GetFontProp (self)

	SetLineSpacing (self, aLineSpacing)

	GetLineSpacing (self)

	SetTextSize (self, aNewSize, aEnforceMinTextSize=True)

	GetTextSize (self)

	SetTextWidth (self, aWidth)

	GetTextWidth (self)

	SetTextHeight (self, aHeight)

	GetTextHeight (self)

	SetTextColor (self, aColor)

	GetTextColor (self)

	SetTextPos (self, aPoint)

	GetTextPos (self)

	SetTextX (self, aX)

	SetTextY (self, aY)

	Offset (self, aOffset)

	Empty (self)

	Print (self, aSettings, aOffset, aColor)

	GetEffectiveTextShape (self, *args)

	GetTextBox (self, aSettings, aLine=-1)

	GetInterline (self, aSettings)

	GetTextStyleName (self)

	GetLinePositions (self, aSettings, aPositions, aLineCount)

	Levenshtein (self, aOther)

	Similarity (self, aOther)

	Format (self, aFormatter, aControlBits)

	GetDrawRotation (self)

	GetDrawPos (self)

	GetDrawFont (self, aSettings)

	ClearRenderCache (self)

	ClearBoundingBoxCache (self)

	GetRenderCache (self, *args)

	SetupRenderCache (self, aResolvedText, aFont, aAngle, aOffset)

	AddRenderCacheGlyph (self, aPoly)

	Compare (self, aOther)

	__eq__ (self, aRhs)

	__lt__ (self, aRhs)

	__gt__ (self, aRhs)

	HasHyperlink (self)

	GetHyperlink (self)

	SetHyperlink (self, aLink)

	RemoveHyperlink (self)

Static Public Member Functions
	ClassOf (aItem)

Static Public Member Functions inherited from pcbnew.EDA_ITEM
	Sort (aLeft, aRight)

Static Public Member Functions inherited from pcbnew.EDA_TEXT
	MapHorizJustify (aHorizJustify)

	MapVertJustify (aVertJustify)

	ValidateHyperlink (aURL)

	IsGotoPageHref (aHref, aDestination=None)

	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")

Additional Inherited Members
Static Public Attributes inherited from pcbnew.BOARD_ITEM
	DRC = _pcbnew.BOARD_ITEM_DRC

	INSTANCE_TO_INSTANCE = _pcbnew.BOARD_ITEM_INSTANCE_TO_INSTANCE

Detailed Description

Proxy of C++ PCB_TEXT class.

Definition at line 17218 of file pcbnew.py.

Constructor & Destructor Documentation

◆ init()

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

Definition at line 17224 of file pcbnew.py.

Member Function Documentation

◆ eq()

pcbnew.PCB_TEXT.__eq__	(		self,
		*	args )

    __eq__(PCB_TEXT self, PCB_TEXT aOther) -> bool
    __eq__(PCB_TEXT self, BOARD_ITEM aBoardItem) -> bool

Definition at line 17297 of file pcbnew.py.

◆ ClassOf()

pcbnew.PCB_TEXT.ClassOf ( aItem )

static

ClassOf(EDA_ITEM aItem) -> bool

Reimplemented in pcbnew.PCB_DIM_ALIGNED, pcbnew.PCB_DIM_CENTER, pcbnew.PCB_DIM_LEADER, pcbnew.PCB_DIM_ORTHOGONAL, pcbnew.PCB_DIM_RADIAL, and pcbnew.PCB_FIELD.

Definition at line 17233 of file pcbnew.py.

◆ Deserialize()

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_DIM_ALIGNED, pcbnew.PCB_DIM_CENTER, pcbnew.PCB_DIM_LEADER, pcbnew.PCB_DIM_ORTHOGONAL, pcbnew.PCB_DIM_RADIAL, pcbnew.PCB_DIMENSION_BASE, and pcbnew.PCB_FIELD.

Definition at line 17241 of file pcbnew.py.

◆ GetClass()

pcbnew.PCB_TEXT.GetClass ( self )

GetClass(PCB_TEXT self) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.PCB_DIM_ALIGNED, pcbnew.PCB_DIM_CENTER, pcbnew.PCB_DIM_LEADER, pcbnew.PCB_DIM_ORTHOGONAL, pcbnew.PCB_DIM_RADIAL, and pcbnew.PCB_FIELD.

Definition at line 17269 of file pcbnew.py.

◆ GetEffectiveShape()

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.

Definition at line 17281 of file pcbnew.py.

◆ GetKnockoutCache()

pcbnew.PCB_TEXT.GetKnockoutCache	(	self,
		aFont,
		forResolvedText,
		aMaxError )

GetKnockoutCache(PCB_TEXT self, KIFONT::FONT const * aFont, wxString forResolvedText, int aMaxError) -> SHAPE_POLY_SET

Definition at line 17285 of file pcbnew.py.

◆ GetShownText()

pcbnew.PCB_TEXT.GetShownText	(	self,
		aAllowExtraText,
		aDepth = 0 )

GetShownText(PCB_TEXT self, bool aAllowExtraText, int aDepth=0) -> wxString

Reimplemented from pcbnew.EDA_TEXT.

Definition at line 17249 of file pcbnew.py.

◆ GetTextTypeDescription()

pcbnew.PCB_TEXT.GetTextTypeDescription ( self )

GetTextTypeDescription(PCB_TEXT self) -> wxString

Definition at line 17289 of file pcbnew.py.

◆ HitTest()

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
    HitTest(PCB_TEXT self, SHAPE_LINE_CHAIN aPoly, bool aContained) -> bool

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.PCB_DIMENSION_BASE.

Definition at line 17261 of file pcbnew.py.

◆ KeepUpright()

pcbnew.PCB_TEXT.KeepUpright ( self )

KeepUpright(PCB_TEXT self)

Definition at line 17245 of file pcbnew.py.

◆ Serialize()

pcbnew.PCB_TEXT.Serialize	(		self,
			aContainer )

Serialize(PCB_TEXT self, google::protobuf::Any & aContainer)

Reimplemented from pcbnew.EDA_TEXT.

Reimplemented in pcbnew.PCB_DIM_ALIGNED, pcbnew.PCB_DIM_CENTER, pcbnew.PCB_DIM_LEADER, pcbnew.PCB_DIM_ORTHOGONAL, pcbnew.PCB_DIM_RADIAL, pcbnew.PCB_DIMENSION_BASE, and pcbnew.PCB_FIELD.

Definition at line 17237 of file pcbnew.py.

◆ TextHitTest()

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
    TextHitTest(PCB_TEXT self, SHAPE_LINE_CHAIN aPoly, bool aContained) -> bool

Reimplemented from pcbnew.EDA_TEXT.

Definition at line 17253 of file pcbnew.py.

◆ TransformShapeToPolygon()

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.

Definition at line 17277 of file pcbnew.py.

◆ TransformTextToPolySet()

pcbnew.PCB_TEXT.TransformTextToPolySet	(	self,
		aBuffer,
		aClearance,
		aMaxError,
		aErrorLoc )

TransformTextToPolySet(PCB_TEXT self, SHAPE_POLY_SET aBuffer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc)

Definition at line 17273 of file pcbnew.py.

◆ ViewGetLOD()

pcbnew.PCB_TEXT.ViewGetLOD	(	self,
		aLayer,
		aView )

ViewGetLOD(PCB_TEXT self, int aLayer, KIGFX::VIEW const * aView) -> double

Reimplemented in pcbnew.PCB_FIELD.

Definition at line 17293 of file pcbnew.py.

Property Documentation

◆ thisown

pcbnew.PCB_TEXT.thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

static

Definition at line 17221 of file pcbnew.py.

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

pcbnew.py

Public Member Functions

Static Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __eq__()

◆ ClassOf()

◆ Deserialize()

◆ GetClass()

◆ GetEffectiveShape()

◆ GetKnockoutCache()

◆ GetShownText()

◆ GetTextTypeDescription()

◆ HitTest()

◆ KeepUpright()

◆ Serialize()

◆ TextHitTest()

◆ TransformShapeToPolygon()

◆ TransformTextToPolySet()

◆ ViewGetLOD()

Property Documentation

◆ thisown

◆ init()

◆ eq()