pcbnew.PCB_TEXT Class Reference

Inheritance diagram for pcbnew.PCB_TEXT:

Public Member Functions
def	__init__ (self, "BOARD_ITEM" parent)
"bool"	IsType (self, "KICAD_T const []" aScanTypes)
"wxString"	GetShownText (self, "int" aDepth=0, "bool" aAllowExtraText=True)
"void"	SetVisible (self, "bool" aVisible)
"bool"	IsVisible (self)
"bool"	Matches (self, "wxFindReplaceData const &" aSearchData, "void *" aAuxData)
"wxPoint"	GetPosition (self)
"void"	SetPosition (self, "wxPoint" aPos)
"void"	Move (self, "wxPoint" aMoveVector)
"void"	SetTextAngle (self, "double" aAngle)
"void"	Rotate (self, "wxPoint" aRotCentre, "double" aAngle)
"void"	Flip (self, "wxPoint" aCentre, "bool" aFlipLeftRight)
"void"	GetMsgPanelInfo (self, "EDA_DRAW_FRAME *" aFrame, "std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &" aList)
"bool"	TextHitTest (self, *args)
"bool"	HitTest (self, *args)
"wxString"	GetClass (self)
"void"	TransformTextShapeWithClearanceToPolygon (self, "SHAPE_POLY_SET" aCornerBuffer, "PCB_LAYER_ID" aLayer, "int" aClearanceValue, "int" aError, "ERROR_LOC" aErrorLoc)
"void"	TransformShapeWithClearanceToPolygon (self, "SHAPE_POLY_SET" aCornerBuffer, "PCB_LAYER_ID" aLayer, "int" aClearanceValue, "int" aError, "ERROR_LOC" aErrorLoc, "bool" aIgnoreLineWidth=False)
"std::shared_ptr< SHAPE >"	GetEffectiveShape (self, *args)
"wxString"	GetSelectMenuText (self, "EDA_UNITS" aUnits)
"BITMAPS"	GetMenuImage (self)
"EDA_RECT const"	GetBoundingBox (self)
"EDA_ITEM *"	Clone (self)
"void"	SwapData (self, "BOARD_ITEM" aImage)
Public Member Functions inherited from pcbnew.BOARD_ITEM
def	__init__ (self, *args, **kwargs)
"void"	SetParentGroup (self, "PCB_GROUP" aGroup)
"PCB_GROUP *"	GetParentGroup (self)
"int"	GetX (self)
"int"	GetY (self)
"wxPoint"	GetCenter (self)
"void"	SetX (self, "int" aX)
"void"	SetY (self, "int" aY)
"bool"	IsConnected (self)
"bool"	IsOnCopperLayer (self)
"std::shared_ptr< SHAPE >"	GetEffectiveShape (self, *args)
"BOARD_ITEM_CONTAINER *"	GetParent (self)
"BOARD_ITEM_CONTAINER *"	GetParentFootprint (self)
"PCB_LAYER_ID"	GetLayer (self)
"LSET"	GetLayerSet (self)
"void"	SetLayerSet (self, "LSET" aLayers)
"void"	SetLayer (self, "PCB_LAYER_ID" aLayer)
"BOARD_ITEM *"	Duplicate (self)
"void"	SwapData (self, "BOARD_ITEM" aImage)
"bool"	IsOnLayer (self, "PCB_LAYER_ID" aLayer)
"bool"	IsTrack (self)
"bool"	IsLocked (self)
"void"	SetLocked (self, "bool" aLocked)
"void"	DeleteStructure (self)
"void"	Move (self, *args)
"void"	Rotate (self, *args)
"void"	Flip (self, *args)
"BOARD *"	GetBoard (self, *args)
"wxString"	GetLayerName (self)
"void"	ViewGetLayers (self, "int []" aLayers, "int &" aCount)
"void"	TransformShapeWithClearanceToPolygon (self, "SHAPE_POLY_SET" aCornerBuffer, "PCB_LAYER_ID" aLayer, "int" aClearanceValue, "int" aError, "ERROR_LOC" aErrorLoc, "bool" 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)
"KICAD_T"	Type (self)
"EDA_ITEM *"	GetParent (self)
"void"	SetParent (self, "EDA_ITEM" aParent)
"bool"	IsModified (self)
"bool"	IsNew (self)
"bool"	IsMoving (self)
"bool"	IsDragging (self)
"bool"	IsWireImage (self)
"bool"	IsSelected (self)
"bool"	IsEntered (self)
"bool"	IsResized (self)
"bool"	IsBrightened (self)
"void"	SetWireImage (self)
"void"	SetSelected (self)
"void"	SetBrightened (self)
"void"	ClearSelected (self)
"void"	ClearBrightened (self)
"void"	SetModified (self)
"int"	GetState (self, "EDA_ITEM_FLAGS" type)
"void"	SetState (self, "EDA_ITEM_FLAGS" type, "bool" state)
"EDA_ITEM_FLAGS"	GetStatus (self)
"void"	SetStatus (self, "EDA_ITEM_FLAGS" aStatus)
"void"	SetFlags (self, "EDA_ITEM_FLAGS" aMask)
"void"	ClearFlags (self, *args)
"EDA_ITEM_FLAGS"	GetFlags (self)
"bool"	HasFlag (self, "EDA_ITEM_FLAGS" aFlag)
"EDA_ITEM_FLAGS"	GetEditFlags (self)
"void"	ClearTempFlags (self)
"void"	ClearEditFlags (self)
"bool"	IsType (self, "KICAD_T const []" aScanTypes)
"void"	SetForceVisible (self, "bool" aEnable)
"bool"	IsForceVisible (self)
"void"	GetMsgPanelInfo (self, "EDA_DRAW_FRAME *" aFrame, "std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &" aList)
"bool"	HitTest (self, *args)
"EDA_RECT const"	GetBoundingBox (self)
"wxPoint"	GetPosition (self)
"void"	SetPosition (self, "wxPoint" aPos)
"wxPoint const"	GetFocusPosition (self)
"EDA_ITEM *"	Clone (self)
"SEARCH_RESULT"	Visit (self, "INSPECTOR" inspector, "void *" testData, "KICAD_T const []" scanTypes)
"wxString"	GetClass (self)
"wxString"	GetSelectMenuText (self, "EDA_UNITS" aUnits)
"BITMAPS"	GetMenuImage (self)
"bool"	Matches (self, "wxFindReplaceData const &" aSearchData, "void *" aAuxData)
"bool"	Replace (self, *args)
"bool"	IsReplaceable (self)
"bool"	__lt__ (self, "EDA_ITEM" aItem)
"BOX2I const"	ViewBBox (self)
"void"	ViewGetLayers (self, "int []" aLayers, "int &" aCount)
Public Member Functions inherited from pcbnew.EDA_TEXT
def	__init__ (self, *args)
"wxString const &"	GetText (self)
"wxString"	GetShownText (self, "int" aDepth=0, "bool" aAllowExtraText=True)
"wxString"	ShortenedShownText (self)
"bool"	HasTextVars (self)
"void"	SetText (self, "wxString" aText)
"void"	SetTextThickness (self, "int" aWidth)
"int"	GetTextThickness (self)
"int"	GetEffectiveTextPenWidth (self, "int" aDefaultWidth=0)
"void"	SetTextAngle (self, "double" aAngle)
"double"	GetTextAngle (self)
"double"	GetTextAngleDegrees (self)
"double"	GetTextAngleRadians (self)
"void"	SetItalic (self, "bool" isItalic)
"bool"	IsItalic (self)
"void"	SetBold (self, "bool" aBold)
"bool"	IsBold (self)
"void"	SetVisible (self, "bool" aVisible)
"bool"	IsVisible (self)
"void"	SetMirrored (self, "bool" isMirrored)
"bool"	IsMirrored (self)
"void"	SetMultilineAllowed (self, "bool" aAllow)
"bool"	IsMultilineAllowed (self)
"EDA_TEXT_HJUSTIFY_T"	GetHorizJustify (self)
"EDA_TEXT_VJUSTIFY_T"	GetVertJustify (self)
"void"	SetHorizJustify (self, "EDA_TEXT_HJUSTIFY_T" aType)
"void"	SetVertJustify (self, "EDA_TEXT_VJUSTIFY_T" aType)
"void"	SetEffects (self, "EDA_TEXT" aSrc)
"void"	SwapEffects (self, "EDA_TEXT" aTradingPartner)
"void"	SwapText (self, "EDA_TEXT" aTradingPartner)
"void"	CopyText (self, "EDA_TEXT" aSrc)
"bool"	Replace (self, "wxFindReplaceData const &" aSearchData)
"bool"	IsDefaultFormatting (self)
"void"	SetTextSize (self, "wxSize" aNewSize)
"wxSize const &"	GetTextSize (self)
"void"	SetTextWidth (self, "int" aWidth)
"int"	GetTextWidth (self)
"void"	SetTextHeight (self, "int" aHeight)
"int"	GetTextHeight (self)
"void"	SetTextPos (self, "wxPoint" aPoint)
"wxPoint const &"	GetTextPos (self)
"void"	SetTextX (self, "int" aX)
"void"	SetTextY (self, "int" aY)
"void"	Offset (self, "wxPoint" aOffset)
"void"	Empty (self)
"void"	Print (self, "RENDER_SETTINGS const *" aSettings, "wxPoint" aOffset, "COLOR4D" aColor, "OUTLINE_MODE" aDisplay_mode=FILLED)
"std::vector< wxPoint,std::allocator< wxPoint > >"	TransformToSegmentList (self)
"void"	TransformBoundingBoxWithClearanceToPolygon (self, "SHAPE_POLY_SET" aCornerBuffer, "int" aClearanceValue)
"std::shared_ptr< SHAPE_COMPOUND >"	GetEffectiveTextShape (self)
"bool"	TextHitTest (self, *args)
"int"	LenSize (self, "wxString" aLine, "int" aThickness)
"EDA_RECT"	GetTextBox (self, "int" aLine=-1, "bool" aInvertY=False)
"int"	GetInterline (self)
"wxString"	GetTextStyleName (self)
"void"	GetLinePositions (self, "wxPoint_Vector" aPositions, "int" aLineCount)
"void"	Format (self, "OUTPUTFORMATTER" aFormatter, "int" aNestLevel, "int" aControlBits)
"double"	GetDrawRotation (self)
"wxPoint"	GetDrawPos (self)
"EDA_TEXT_HJUSTIFY_T"	GetDrawHorizJustify (self)
"EDA_TEXT_VJUSTIFY_T"	GetDrawVertJustify (self)
"int"	Compare (self, "EDA_TEXT" aOther)

Static Public Member Functions
"bool"	ClassOf ("EDA_ITEM" aItem)
Static Public Member Functions inherited from pcbnew.EDA_ITEM
"bool"	Sort ("EDA_ITEM" aLeft, "EDA_ITEM" aRight)
Static Public Member Functions inherited from pcbnew.EDA_TEXT
"EDA_TEXT_HJUSTIFY_T"	MapHorizJustify ("int" aHorizJustify)
"EDA_TEXT_VJUSTIFY_T"	MapVertJustify ("int" aVertJustify)

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

Proxy of C++ PCB_TEXT class.

Definition at line 13498 of file pcbnew.py.

Constructor & Destructor Documentation

__init__()

def pcbnew.PCB_TEXT.__init__	(		self,
		"BOARD_ITEM"	parent
	)

__init__(PCB_TEXT self, BOARD_ITEM parent) -> PCB_TEXT

Reimplemented from pcbnew.EDA_TEXT.

Definition at line 13504 of file pcbnew.py.

Member Function Documentation

ClassOf()

"bool" pcbnew.PCB_TEXT.ClassOf ( "EDA_ITEM"  aItem )

static

ClassOf(EDA_ITEM aItem) -> bool

Definition at line 13510 of file pcbnew.py.

Clone()

"EDA_ITEM *" pcbnew.PCB_TEXT.Clone

(

self

)

Clone(PCB_TEXT self) -> EDA_ITEM

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 13604 of file pcbnew.py.

Here is the caller graph for this function:

Flip()

"void" pcbnew.PCB_TEXT.Flip	(		self,
		"wxPoint"	aCentre,
		"bool"	aFlipLeftRight
	)

Flip(PCB_TEXT self, wxPoint aCentre, bool aFlipLeftRight)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 13554 of file pcbnew.py.

GetBoundingBox()

"EDA_RECT const" pcbnew.PCB_TEXT.GetBoundingBox

(

self

)

GetBoundingBox(PCB_TEXT self) -> EDA_RECT

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 13600 of file pcbnew.py.

GetClass()

"wxString" pcbnew.PCB_TEXT.GetClass

(

self

)

GetClass(PCB_TEXT self) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 13576 of file pcbnew.py.

Here is the caller graph for this function:

GetEffectiveShape()

"std.shared_ptr< SHAPE >" 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.

Definition at line 13588 of file pcbnew.py.

GetMenuImage()

"BITMAPS" pcbnew.PCB_TEXT.GetMenuImage

(

self

)

GetMenuImage(PCB_TEXT self) -> BITMAPS

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 13596 of file pcbnew.py.

GetMsgPanelInfo()

"void" pcbnew.PCB_TEXT.GetMsgPanelInfo	(		self,
		"EDA_DRAW_FRAME *"	aFrame,
		"std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &"	aList
	)

GetMsgPanelInfo(PCB_TEXT self, EDA_DRAW_FRAME * aFrame, std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > & aList)

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 13558 of file pcbnew.py.

GetPosition()

"wxPoint" pcbnew.PCB_TEXT.GetPosition

(

self

)

GetPosition(PCB_TEXT self) -> wxPoint

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 13534 of file pcbnew.py.

GetSelectMenuText()

"wxString" pcbnew.PCB_TEXT.GetSelectMenuText	(		self,
		"EDA_UNITS"	aUnits
	)

GetSelectMenuText(PCB_TEXT self, EDA_UNITS aUnits) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 13592 of file pcbnew.py.

GetShownText()

"wxString" pcbnew.PCB_TEXT.GetShownText	(		self,
		"int"	aDepth = 0,
		"bool"	aAllowExtraText = True
	)

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

Reimplemented from pcbnew.EDA_TEXT.

Definition at line 13518 of file pcbnew.py.

HitTest()

"bool" pcbnew.PCB_TEXT.HitTest	(		self,
		*	args
	)

    HitTest(PCB_TEXT self, wxPoint aPosition, int aAccuracy) -> bool
    HitTest(PCB_TEXT self, EDA_RECT aRect, bool aContained, int aAccuracy=0) -> bool

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 13569 of file pcbnew.py.

Here is the caller graph for this function:

IsType()

"bool" pcbnew.PCB_TEXT.IsType	(		self,
		"KICAD_T const []"	aScanTypes
	)

IsType(PCB_TEXT self, KICAD_T const [] aScanTypes) -> bool

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 13514 of file pcbnew.py.

IsVisible()

"bool" pcbnew.PCB_TEXT.IsVisible

(

self

)

IsVisible(PCB_TEXT self) -> bool

Reimplemented from pcbnew.EDA_TEXT.

Definition at line 13526 of file pcbnew.py.

Matches()

"bool" pcbnew.PCB_TEXT.Matches	(		self,
		"wxFindReplaceData const &"	aSearchData,
		"void *"	aAuxData
	)

Matches(PCB_TEXT self, wxFindReplaceData const & aSearchData, void * aAuxData) -> bool

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 13530 of file pcbnew.py.

Move()

"void" pcbnew.PCB_TEXT.Move	(		self,
		"wxPoint"	aMoveVector
	)

Move(PCB_TEXT self, wxPoint aMoveVector)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 13542 of file pcbnew.py.

Rotate()

"void" pcbnew.PCB_TEXT.Rotate	(		self,
		"wxPoint"	aRotCentre,
		"double"	aAngle
	)

Rotate(PCB_TEXT self, wxPoint aRotCentre, double aAngle)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 13550 of file pcbnew.py.

SetPosition()

"void" pcbnew.PCB_TEXT.SetPosition	(		self,
		"wxPoint"	aPos
	)

SetPosition(PCB_TEXT self, wxPoint aPos)

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 13538 of file pcbnew.py.

Here is the caller graph for this function:

SetTextAngle()

"void" pcbnew.PCB_TEXT.SetTextAngle	(		self,
		"double"	aAngle
	)

SetTextAngle(PCB_TEXT self, double aAngle)

Reimplemented from pcbnew.EDA_TEXT.

Definition at line 13546 of file pcbnew.py.

SetVisible()

"void" pcbnew.PCB_TEXT.SetVisible	(		self,
		"bool"	aVisible
	)

SetVisible(PCB_TEXT self, bool aVisible)

Reimplemented from pcbnew.EDA_TEXT.

Definition at line 13522 of file pcbnew.py.

SwapData()

"void" pcbnew.PCB_TEXT.SwapData	(		self,
		"BOARD_ITEM"	aImage
	)

SwapData(PCB_TEXT self, BOARD_ITEM aImage)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 13608 of file pcbnew.py.

TextHitTest()

"bool" pcbnew.PCB_TEXT.TextHitTest	(		self,
		*	args
	)

    TextHitTest(PCB_TEXT self, wxPoint aPoint, int aAccuracy=0) -> bool
    TextHitTest(PCB_TEXT self, EDA_RECT aRect, bool aContains, int aAccuracy=0) -> bool

Reimplemented from pcbnew.EDA_TEXT.

Definition at line 13562 of file pcbnew.py.

Here is the caller graph for this function:

TransformShapeWithClearanceToPolygon()

"void" pcbnew.PCB_TEXT.TransformShapeWithClearanceToPolygon	(		self,
		"SHAPE_POLY_SET"	aCornerBuffer,
		"PCB_LAYER_ID"	aLayer,
		"int"	aClearanceValue,
		"int"	aError,
		"ERROR_LOC"	aErrorLoc,
		"bool"	aIgnoreLineWidth = False
	)

TransformShapeWithClearanceToPolygon(PCB_TEXT self, SHAPE_POLY_SET aCornerBuffer, PCB_LAYER_ID aLayer, int aClearanceValue, int aError, ERROR_LOC aErrorLoc, bool aIgnoreLineWidth=False)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 13584 of file pcbnew.py.

TransformTextShapeWithClearanceToPolygon()

"void" pcbnew.PCB_TEXT.TransformTextShapeWithClearanceToPolygon	(		self,
		"SHAPE_POLY_SET"	aCornerBuffer,
		"PCB_LAYER_ID"	aLayer,
		"int"	aClearanceValue,
		"int"	aError,
		"ERROR_LOC"	aErrorLoc
	)

TransformTextShapeWithClearanceToPolygon(PCB_TEXT self, SHAPE_POLY_SET aCornerBuffer, PCB_LAYER_ID aLayer, int aClearanceValue, int aError, ERROR_LOC aErrorLoc)

Definition at line 13580 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 13501 of file pcbnew.py.

---

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

• pcbnew.py