A mix-in class (via multiple inheritance) that handles texts such as labels, parts, components, or footprints. More...

#include <eda_text.h>

Inheritance diagram for EDA_TEXT:

Public Member Functions
	EDA_TEXT (const EDA_IU_SCALE &aIuScale, const wxString &aText=wxEmptyString)

	EDA_TEXT (const EDA_TEXT &aText)

virtual	~EDA_TEXT ()

EDA_TEXT &	operator= (const EDA_TEXT &aItem)

virtual const wxString &	GetText () const
	Return the string associated with the text object. More...

virtual wxString	GetShownText (int aDepth=0, bool aAllowExtraText=true) const
	Return the string actually shown after processing of the base text. More...

bool	HasTextVars () const
	Indicates the ShownText has text var references which need to be processed. More...

virtual void	SetText (const wxString &aText)

void	SetTextThickness (int aWidth)
	The TextThickness is that set by the user. More...

int	GetTextThickness () const

int	GetEffectiveTextPenWidth (int aDefaultPenWidth=0) const
	The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultPenWidth. More...

virtual void	SetTextAngle (const EDA_ANGLE &aAngle)

const EDA_ANGLE &	GetTextAngle () const

void	SetTextAngleDegrees (double aOrientation)

double	GetTextAngleDegrees () const

void	SetItalic (bool aItalic)

bool	IsItalic () const

void	SetBold (bool aBold)

bool	IsBold () const

virtual void	SetVisible (bool aVisible)

virtual bool	IsVisible () const

void	SetMirrored (bool isMirrored)

bool	IsMirrored () const

void	SetMultilineAllowed (bool aAllow)

bool	IsMultilineAllowed () const

void	SetHorizJustify (GR_TEXT_H_ALIGN_T aType)

GR_TEXT_H_ALIGN_T	GetHorizJustify () const

void	SetVertJustify (GR_TEXT_V_ALIGN_T aType)

GR_TEXT_V_ALIGN_T	GetVertJustify () const

void	SetKeepUpright (bool aKeepUpright)

bool	IsKeepUpright () const

void	SetAttributes (const EDA_TEXT &aSrc)
	Set the text attributes from another instance. More...

void	SwapAttributes (EDA_TEXT &aTradingPartner)
	Swap the text attributes of the two involved instances. More...

void	SwapText (EDA_TEXT &aTradingPartner)

void	CopyText (const EDA_TEXT &aSrc)

void	SetAttributes (const TEXT_ATTRIBUTES &aTextAttrs)

const TEXT_ATTRIBUTES &	GetAttributes () const

bool	Replace (const EDA_SEARCH_DATA &aSearchData)
	Helper function used in search and replace dialog. More...

bool	IsDefaultFormatting () const

void	SetFont (KIFONT::FONT *aFont)

KIFONT::FONT *	GetFont () const

wxString	GetFontName () const

void	SetLineSpacing (double aLineSpacing)

double	GetLineSpacing () const

void	SetTextSize (const VECTOR2I &aNewSize)

VECTOR2I	GetTextSize () const

void	SetTextWidth (int aWidth)

int	GetTextWidth () const

void	SetTextHeight (int aHeight)

int	GetTextHeight () const

void	SetTextColor (const COLOR4D &aColor)

COLOR4D	GetTextColor () const

void	SetTextPos (const VECTOR2I &aPoint)

const VECTOR2I &	GetTextPos () const

void	SetTextX (int aX)

void	SetTextY (int aY)

void	Offset (const VECTOR2I &aOffset)

void	Empty ()

void	Print (const RENDER_SETTINGS *aSettings, const VECTOR2I &aOffset, const COLOR4D &aColor, OUTLINE_MODE aDisplay_mode=FILLED)
	Print this text object to the device context aDC. More...

void	TransformBoundingBoxToPolygon (SHAPE_POLY_SET *aBuffer, int aClearance) const
	Convert the text bounding box to a rectangular polygon depending on the text orientation, the bounding box is not always horizontal or vertical. More...

std::shared_ptr< SHAPE_COMPOUND >	GetEffectiveTextShape (bool aTriangulate=true, bool aUseTextRotation=true) const
	build a list of segments (SHAPE_SEGMENT) to describe a text shape. More...

virtual bool	TextHitTest (const VECTOR2I &aPoint, int aAccuracy=0) const
	Test if aPoint is within the bounds of this object. More...

virtual bool	TextHitTest (const BOX2I &aRect, bool aContains, int aAccuracy=0) const
	Test if object bounding box is contained within or intersects aRect. More...

BOX2I	GetTextBox (int aLine=-1, bool aInvertY=false) const
	Useful in multiline texts to calculate the full text or a line area (for zones filling, locate functions....) More...

int	GetInterline () const
	Return the distance between two lines of text. More...

wxString	GetTextStyleName () const

void	GetLinePositions (std::vector< VECTOR2I > &aPositions, int aLineCount) const
	Populate aPositions with the position of each line of a multiline text, according to the vertical justification and the rotation of the whole text. More...

virtual void	Format (OUTPUTFORMATTER *aFormatter, int aNestLevel, int aControlBits) const
	Output the object to aFormatter in s-expression form. More...

virtual EDA_ANGLE	GetDrawRotation () const

virtual VECTOR2I	GetDrawPos () const

virtual void	ClearRenderCache ()

virtual void	ClearBoundingBoxCache ()

std::vector< std::unique_ptr< KIFONT::GLYPH > > *	GetRenderCache (const KIFONT::FONT *aFont, const wxString &forResolvedText, const VECTOR2I &aOffset={ 0, 0 }) const

void	SetupRenderCache (const wxString &aResolvedText, const EDA_ANGLE &aAngle)

void	AddRenderCacheGlyph (const SHAPE_POLY_SET &aPoly)

int	Compare (const EDA_TEXT *aOther) const

virtual bool	HasHyperlink () const

wxString	GetHyperlink () const

void	SetHyperlink (wxString aLink)

void	RemoveHyperlink ()

Static Public Member Functions
static GR_TEXT_H_ALIGN_T	MapHorizJustify (int aHorizJustify)

static GR_TEXT_V_ALIGN_T	MapVertJustify (int aVertJustify)

static bool	ValidateHyperlink (const wxString &aURL)
	Check if aURL is a valid hyperlink. More...

static bool	IsGotoPageHref (const wxString &aHref, wxString *aDestination=nullptr)
	Check if aHref is a valid internal hyperlink. More...

static wxString	GotoPageHref (const wxString &aDestination)
	Generate a href to a page in the current schematic. More...

Protected Member Functions
virtual KIFONT::FONT *	getDrawFont () const

void	cacheShownText ()

void	printOneLineOfText (const RENDER_SETTINGS *aSettings, const VECTOR2I &aOffset, const COLOR4D &aColor, OUTLINE_MODE aFillMode, const wxString &aText, const VECTOR2I &aPos)
	Print each line of this EDA_TEXT. More...

Protected Attributes
wxString	m_hyperlink
	A hyperlink URL. More...

Private Attributes
wxString	m_text

wxString	m_shown_text

bool	m_shown_text_has_text_var_refs

std::reference_wrapper< const EDA_IU_SCALE >	m_IuScale

wxString	m_render_cache_text

EDA_ANGLE	m_render_cache_angle

VECTOR2I	m_render_cache_offset

std::vector< std::unique_ptr< KIFONT::GLYPH > >	m_render_cache

bool	m_bounding_box_cache_valid

VECTOR2I	m_bounding_box_cache_pos

int	m_bounding_box_cache_line

bool	m_bounding_box_cache_inverted

BOX2I	m_bounding_box_cache

TEXT_ATTRIBUTES	m_attributes

VECTOR2I	m_pos

Detailed Description

A mix-in class (via multiple inheritance) that handles texts such as labels, parts, components, or footprints.

Because it's a mix-in class, care is used to provide function names (accessors) that to not collide with function names likely to be seen in the combined derived classes.

Definition at line 71 of file eda_text.h.

Constructor & Destructor Documentation

◆ EDA_TEXT() [1/2]

EDA_TEXT::EDA_TEXT	(	const EDA_IU_SCALE &	aIuScale,
		const wxString &	aText = `wxEmptyString`
	)

Definition at line 90 of file eda_text.cpp.

 :
 m_text( aText ),
 m_IuScale( aIuScale ),
 m_bounding_box_cache_valid( false ),
 m_bounding_box_cache_line( -1 ),
 m_bounding_box_cache_inverted( false )
{
 SetTextSize( VECTOR2I( EDA_UNIT_UTILS::Mils2IU( m_IuScale, DEFAULT_SIZE_TEXT ),
 EDA_UNIT_UTILS::Mils2IU( m_IuScale, DEFAULT_SIZE_TEXT ) ) );
 cacheShownText();
}

References cacheShownText(), DEFAULT_SIZE_TEXT, m_IuScale, EDA_UNIT_UTILS::Mils2IU(), and SetTextSize().

◆ EDA_TEXT() [2/2]

EDA_TEXT::EDA_TEXT ( const EDA_TEXT & aText )

Definition at line 103 of file eda_text.cpp.

 :
 m_IuScale( aText.m_IuScale )
{
 m_text = aText.m_text;
 m_shown_text = aText.m_shown_text;
 m_shown_text_has_text_var_refs = aText.m_shown_text_has_text_var_refs;
 
 m_attributes = aText.m_attributes;
 m_pos = aText.m_pos;
 
 m_render_cache_text = aText.m_render_cache_text;
 m_render_cache_angle = aText.m_render_cache_angle;
 
 m_render_cache.clear();
 
 for( const std::unique_ptr<KIFONT::GLYPH>& glyph : aText.m_render_cache )
 {
 KIFONT::OUTLINE_GLYPH* outline_glyph = static_cast<KIFONT::OUTLINE_GLYPH*>( glyph.get() );
 m_render_cache.emplace_back( std::make_unique<KIFONT::OUTLINE_GLYPH>( *outline_glyph ) );
 }
 
 m_bounding_box_cache_valid = aText.m_bounding_box_cache_valid;
 m_bounding_box_cache = aText.m_bounding_box_cache;
 m_bounding_box_cache_line = aText.m_bounding_box_cache_line;
 m_bounding_box_cache_inverted = aText.m_bounding_box_cache_inverted;
}

References m_attributes, m_bounding_box_cache, m_bounding_box_cache_inverted, m_bounding_box_cache_line, m_bounding_box_cache_valid, m_pos, m_render_cache, m_render_cache_angle, m_render_cache_text, m_shown_text, m_shown_text_has_text_var_refs, and m_text.

◆ ~EDA_TEXT()

EDA_TEXT::~EDA_TEXT ( )

virtual

Definition at line 131 of file eda_text.cpp.

132{

133}

Member Function Documentation

◆ AddRenderCacheGlyph()

void EDA_TEXT::AddRenderCacheGlyph ( const SHAPE_POLY_SET & aPoly )

Definition at line 491 of file eda_text.cpp.

{
 m_render_cache.emplace_back( std::make_unique<KIFONT::OUTLINE_GLYPH>( aPoly ) );
}

References m_render_cache.

◆ cacheShownText()

void EDA_TEXT::cacheShownText ( )

protected

Definition at line 408 of file eda_text.cpp.

{
 if( m_text.IsEmpty() )
 {
 m_shown_text = wxEmptyString;
 m_shown_text_has_text_var_refs = false;
 }
 else
 {
 m_shown_text = UnescapeString( m_text );
 m_shown_text_has_text_var_refs = m_shown_text.Contains( wxT( "${" ) );
 }
 
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References ClearRenderCache(), m_bounding_box_cache_valid, m_shown_text, m_shown_text_has_text_var_refs, m_text, and UnescapeString().

Referenced by EDA_TEXT(), Replace(), and SetText().

◆ ClearBoundingBoxCache()

void EDA_TEXT::ClearBoundingBoxCache ( )

virtual

Definition at line 444 of file eda_text.cpp.

{
 m_bounding_box_cache_valid = false;
}

References m_bounding_box_cache_valid.

Referenced by SCH_FIELD::ClearCaches(), EESCHEMA_HELPERS::LoadSchematic(), and SCH_EDIT_FRAME::RecomputeIntersheetRefs().

◆ ClearRenderCache()

void EDA_TEXT::ClearRenderCache ( )

virtual

Reimplemented in SCH_FIELD.

Definition at line 438 of file eda_text.cpp.

{
 m_render_cache.clear();
}

References m_render_cache.

Referenced by cacheShownText(), SCH_FIELD::ClearRenderCache(), CopyText(), Empty(), Replace(), SetAttributes(), SetBold(), SetFont(), SetHorizJustify(), SetItalic(), SetKeepUpright(), SetLineSpacing(), SetMirrored(), SetMultilineAllowed(), SetText(), SetTextAngle(), SetTextHeight(), SetTextSize(), SetTextThickness(), SetTextWidth(), SetVertJustify(), SetVisible(), SwapAttributes(), SwapText(), and EE_POINT_EDITOR::updateParentItem().

◆ Compare()

int EDA_TEXT::Compare ( const EDA_TEXT * aOther ) const

Definition at line 911 of file eda_text.cpp.

{
#define EPSILON 2 // Should be enough for rounding errors on calculated items
 
#define TEST( a, b ) { if( a != b ) return a - b; }
#define TEST_E( a, b ) { if( abs( a - b ) > EPSILON ) return a - b; }
#define TEST_PT( a, b ) { TEST_E( a.x, b.x ); TEST_E( a.y, b.y ); }
 
 TEST_PT( m_pos, aOther->m_pos );
 
 TEST_PT( m_attributes.m_Size, aOther->m_attributes.m_Size );
 TEST_E( m_attributes.m_StrokeWidth, aOther->m_attributes.m_StrokeWidth );
 TEST( m_attributes.m_Angle.AsDegrees(), aOther->m_attributes.m_Angle.AsDegrees() );
 TEST( m_attributes.m_LineSpacing, aOther->m_attributes.m_LineSpacing );
 
 TEST( m_attributes.m_Halign, aOther->m_attributes.m_Halign );
 TEST( m_attributes.m_Valign, aOther->m_attributes.m_Valign );
 TEST( m_attributes.m_Italic, aOther->m_attributes.m_Italic );
 TEST( m_attributes.m_Bold, aOther->m_attributes.m_Bold );
 TEST( m_attributes.m_Underlined, aOther->m_attributes.m_Underlined );
 TEST( m_attributes.m_Visible, aOther->m_attributes.m_Visible );
 TEST( m_attributes.m_Mirrored, aOther->m_attributes.m_Mirrored );
 TEST( m_attributes.m_Multiline, aOther->m_attributes.m_Multiline );
 TEST( m_attributes.m_KeepUpright, aOther->m_attributes.m_KeepUpright );
 
 int val = GetFontName().Cmp( aOther->GetFontName() );
 
 if( val != 0 )
 return val;
 
 return m_text.Cmp( aOther->m_text );
}

References EDA_ANGLE::AsDegrees(), GetFontName(), TEXT_ATTRIBUTES::m_Angle, m_attributes, TEXT_ATTRIBUTES::m_Bold, TEXT_ATTRIBUTES::m_Halign, TEXT_ATTRIBUTES::m_Italic, TEXT_ATTRIBUTES::m_KeepUpright, TEXT_ATTRIBUTES::m_LineSpacing, TEXT_ATTRIBUTES::m_Mirrored, TEXT_ATTRIBUTES::m_Multiline, m_pos, TEXT_ATTRIBUTES::m_Size, TEXT_ATTRIBUTES::m_StrokeWidth, m_text, TEXT_ATTRIBUTES::m_Underlined, TEXT_ATTRIBUTES::m_Valign, TEXT_ATTRIBUTES::m_Visible, TEST, TEST_E, and TEST_PT.

◆ CopyText()

void EDA_TEXT::CopyText ( const EDA_TEXT & aSrc )

Definition at line 174 of file eda_text.cpp.

{
 m_text = aSrc.m_text;
 m_shown_text = aSrc.m_shown_text;
 m_shown_text_has_text_var_refs = aSrc.m_shown_text_has_text_var_refs;
 
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References ClearRenderCache(), m_bounding_box_cache_valid, m_shown_text, m_shown_text_has_text_var_refs, and m_text.

Referenced by LIB_FIELD::Copy(), and CLIPBOARD_IO::SaveSelection().

◆ Empty()

void EDA_TEXT::Empty ( )

Definition at line 400 of file eda_text.cpp.

{
 m_text.Empty();
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References ClearRenderCache(), m_bounding_box_cache_valid, and m_text.

Referenced by SCH_LEGACY_PLUGIN_CACHE::LoadPart().

◆ Format()

void EDA_TEXT::Format	(	OUTPUTFORMATTER *	aFormatter,
		int	aNestLevel,
		int	aControlBits
	)		const

virtual

Output the object to aFormatter in s-expression form.

Parameters

aFormatter	The OUTPUTFORMATTER object to write to.
aNestLevel	The indentation next level.
aControlBits	The control bit definition for object specific formatting.

Exceptions

IO_ERROR on write error.

Definition at line 781 of file eda_text.cpp.

{
 aFormatter->Print( aNestLevel + 1, "(effects" );
 
 aFormatter->Print( 0, " (font" );
 
 if( GetFont() && !GetFont()->GetName().IsEmpty() )
 aFormatter->Print( 0, " (face \"%s\")", GetFont()->NameAsToken() );
 
 // Text size
 aFormatter->Print( 0, " (size %s %s)",
 EDA_UNIT_UTILS::FormatInternalUnits( m_IuScale, GetTextHeight() ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( m_IuScale, GetTextWidth() ).c_str() );
 
 if( GetLineSpacing() != 1.0 )
 {
 aFormatter->Print( 0, " (line_spacing %s)",
 FormatDouble2Str( GetLineSpacing() ).c_str() );
 }
 
 if( GetTextThickness() )
 {
 aFormatter->Print( 0, " (thickness %s)",
 EDA_UNIT_UTILS::FormatInternalUnits( m_IuScale, GetTextThickness() ).c_str() );
 }
 
 if( IsBold() )
 aFormatter->Print( 0, " bold" );
 
 if( IsItalic() )
 aFormatter->Print( 0, " italic" );
 
 if( GetTextColor() != COLOR4D::UNSPECIFIED )
 {
 aFormatter->Print( 0, " (color %d %d %d %s)",
 KiROUND( GetTextColor().r * 255.0 ),
 KiROUND( GetTextColor().g * 255.0 ),
 KiROUND( GetTextColor().b * 255.0 ),
 FormatDouble2Str( GetTextColor().a ).c_str() );
 }
 
 aFormatter->Print( 0, ")"); // (font
 
 if( IsMirrored() || GetHorizJustify() != GR_TEXT_H_ALIGN_CENTER
 || GetVertJustify() != GR_TEXT_V_ALIGN_CENTER )
 {
 aFormatter->Print( 0, " (justify");
 
 if( GetHorizJustify() != GR_TEXT_H_ALIGN_CENTER )
 aFormatter->Print( 0, GetHorizJustify() == GR_TEXT_H_ALIGN_LEFT ? " left" : " right" );
 
 if( GetVertJustify() != GR_TEXT_V_ALIGN_CENTER )
 aFormatter->Print( 0, GetVertJustify() == GR_TEXT_V_ALIGN_TOP ? " top" : " bottom" );
 
 if( IsMirrored() )
 aFormatter->Print( 0, " mirror" );
 
 aFormatter->Print( 0, ")" ); // (justify
 }
 
 if( !( aControlBits & CTL_OMIT_HIDE ) && !IsVisible() )
 aFormatter->Print( 0, " hide" );
 
 if( HasHyperlink() )
 {
 aFormatter->Print( 0, " (href %s)", aFormatter->Quotew( GetHyperlink() ).c_str() );
 }
 
 aFormatter->Print( 0, ")\n" ); // (effects
}

References CTL_OMIT_HIDE, FormatDouble2Str(), EDA_UNIT_UTILS::FormatInternalUnits(), GetFont(), GetHorizJustify(), GetHyperlink(), GetLineSpacing(), GetTextColor(), GetTextHeight(), GetTextThickness(), GetTextWidth(), GetVertJustify(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_TOP, HasHyperlink(), IsBold(), IsItalic(), IsMirrored(), IsVisible(), KiROUND(), m_IuScale, OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().

Referenced by SCH_SEXPR_PLUGIN_CACHE::saveField(), and SCH_SEXPR_PLUGIN::saveField().

◆ GetAttributes()

const TEXT_ATTRIBUTES & EDA_TEXT::GetAttributes ( ) const

inline

Definition at line 172 of file eda_text.h.

172{ return m_attributes; }

References m_attributes.

Referenced by BOARD_ADAPTER::addText(), KIGFX::DS_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), GetEffectiveTextShape(), GetRenderCache(), LIB_TEXT::Plot(), BRDITEMS_PLOTTER::PlotPcbText(), PNS_KICAD_IFACE_BASE::syncTextItem(), FP_TEXT::TransformTextToPolySet(), FP_TEXTBOX::TransformTextToPolySet(), PCB_TEXT::TransformTextToPolySet(), and PCB_TEXTBOX::TransformTextToPolySet().

◆ getDrawFont()

KIFONT::FONT * EDA_TEXT::getDrawFont ( ) const

protectedvirtual

Reimplemented in LIB_FIELD, LIB_TEXT, LIB_TEXTBOX, SCH_FIELD, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 426 of file eda_text.cpp.

{
 KIFONT::FONT* font = GetFont();
 
 if( !font )
 font = KIFONT::FONT::GetFont( wxEmptyString, IsBold(), IsItalic() );
 
 return font;
}

References GetFont(), KIFONT::FONT::GetFont(), IsBold(), and IsItalic().

Referenced by GetEffectiveTextShape(), GetInterline(), GetRenderCache(), FP_TEXTBOX::GetShownText(), PCB_TEXTBOX::GetShownText(), GetTextBox(), TransformBoundingBoxToPolygon(), FP_TEXT::TransformTextToPolySet(), FP_TEXTBOX::TransformTextToPolySet(), PCB_TEXT::TransformTextToPolySet(), and PCB_TEXTBOX::TransformTextToPolySet().

◆ GetDrawPos()

virtual VECTOR2I EDA_TEXT::GetDrawPos ( ) const

inlinevirtual

Reimplemented in LIB_TEXTBOX, SCH_TEXTBOX, FP_TEXTBOX, and PCB_TEXTBOX.

Definition at line 318 of file eda_text.h.

318{ return GetTextPos(); }

EDA_TEXT::GetTextPos

const VECTOR2I & GetTextPos() const

Definition: eda_text.h:208

References GetTextPos().

Referenced by BOARD_ADAPTER::addText(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), GetEffectiveTextShape(), GetLinePositions(), GetRenderCache(), GetTextBox(), BRDITEMS_PLOTTER::PlotPcbText(), Print(), TextHitTest(), and TransformBoundingBoxToPolygon().

◆ GetDrawRotation()

virtual EDA_ANGLE EDA_TEXT::GetDrawRotation ( ) const

inlinevirtual

Reimplemented in SCH_FIELD, FP_TEXT, and FP_TEXTBOX.

Definition at line 317 of file eda_text.h.

317{ return GetTextAngle(); }

EDA_TEXT::GetTextAngle

const EDA_ANGLE & GetTextAngle() const

Definition: eda_text.h:120

References GetTextAngle().

Referenced by BOARD_ADAPTER::addText(), KIGFX::SCH_PAINTER::draw(), PCB_PLUGIN::formatRenderCache(), PCB_TEXTBOX::GetAnchorAndOppositeCorner(), PCB_TEXTBOX::GetBotRight(), PCB_TEXTBOX::GetDrawPos(), GetEffectiveTextShape(), GetLinePositions(), GetRenderCache(), PCB_TEXTBOX::GetTopLeft(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotPcbText(), SCH_TEXT::Print(), printOneLineOfText(), PCB_TEXTBOX::SetBottom(), PCB_TEXTBOX::SetLeft(), PCB_TEXTBOX::SetRight(), PCB_TEXTBOX::SetTop(), TextHitTest(), and TransformBoundingBoxToPolygon().

◆ GetEffectiveTextPenWidth()

int EDA_TEXT::GetEffectiveTextPenWidth ( int aDefaultPenWidth = 0 ) const

The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultPenWidth.

Definition at line 297 of file eda_text.cpp.

{
 int penWidth = GetTextThickness();
 
 if( penWidth <= 1 )
 {
 penWidth = aDefaultPenWidth;
 
 if( IsBold() )
 penWidth = GetPenSizeForBold( GetTextWidth() );
 else if( penWidth <= 1 )
 penWidth = GetPenSizeForNormal( GetTextWidth() );
 }
 
 // Clip pen size for small texts:
 penWidth = Clamp_Text_PenSize( penWidth, GetTextSize() );
 
 return penWidth;
}

References Clamp_Text_PenSize(), GetPenSizeForBold(), GetPenSizeForNormal(), GetTextSize(), GetTextThickness(), GetTextWidth(), and IsBold().

Referenced by BOARD_ADAPTER::addText(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), SCH_LABEL_BASE::GetBodyBoundingBox(), SCH_LABEL::GetBodyBoundingBox(), SCH_HIERLABEL::GetBodyBoundingBox(), FP_TEXT::GetEffectiveShape(), PCB_TEXT::GetEffectiveShape(), GetEffectiveTextShape(), LIB_FIELD::GetPenWidth(), LIB_TEXT::GetPenWidth(), SCH_FIELD::GetPenWidth(), SCH_DIRECTIVE_LABEL::GetPenWidth(), SCH_TEXT::GetPenWidth(), GetTextBox(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), SCH_FIELD::Print(), LIB_TEXT::print(), LIB_TEXTBOX::print(), printOneLineOfText(), FP_TEXT::TransformTextToPolySet(), FP_TEXTBOX::TransformTextToPolySet(), PCB_TEXT::TransformTextToPolySet(), PCB_TEXTBOX::TransformTextToPolySet(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), PCB_DIM_RADIAL::updateGeometry(), PCB_DIM_LEADER::updateGeometry(), PCB_DIM_ALIGNED::updateText(), and PCB_DIM_ORTHOGONAL::updateText().

◆ GetEffectiveTextShape()

std::shared_ptr< SHAPE_COMPOUND > EDA_TEXT::GetEffectiveTextShape	(	bool	aTriangulate = `true`,
		bool	aUseTextRotation = `true`
	)		const

build a list of segments (SHAPE_SEGMENT) to describe a text shape.

Parameters

aTriangulate	true to build also the triangulation of each shape
aUseTextRotation	true to use the actual text draw rotation. false to build a list of shape for a not rotated text ("native" shapes).

Definition at line 853 of file eda_text.cpp.

{
 std::shared_ptr<SHAPE_COMPOUND> shape = std::make_shared<SHAPE_COMPOUND>();
 KIGFX::GAL_DISPLAY_OPTIONS empty_opts;
 KIFONT::FONT* font = getDrawFont();
 int penWidth = GetEffectiveTextPenWidth();
 TEXT_ATTRIBUTES attrs = GetAttributes();
 
 if( aUseTextRotation )
 attrs.m_Angle = GetDrawRotation();
 else
 attrs.m_Angle = ANGLE_0;
 
 if( aTriangulate )
 {
 CALLBACK_GAL callback_gal(
 empty_opts,
 // Stroke callback
 [&]( const VECTOR2I& aPt1, const VECTOR2I& aPt2 )
 {
 shape->AddShape( new SHAPE_SEGMENT( aPt1, aPt2, penWidth ) );
 },
 // Triangulation callback
 [&]( const VECTOR2I& aPt1, const VECTOR2I& aPt2, const VECTOR2I& aPt3 )
 {
 SHAPE_SIMPLE* triShape = new SHAPE_SIMPLE;
 
 for( const VECTOR2I& point : { aPt1, aPt2, aPt3 } )
 triShape->Append( point.x, point.y );
 
 shape->AddShape( triShape );
 } );
 
 font->Draw( &callback_gal, GetShownText(), GetDrawPos(), attrs );
 }
 else
 {
 CALLBACK_GAL callback_gal(
 empty_opts,
 // Stroke callback
 [&]( const VECTOR2I& aPt1, const VECTOR2I& aPt2 )
 {
 shape->AddShape( new SHAPE_SEGMENT( aPt1, aPt2, penWidth ) );
 },
 // Outline callback
 [&]( const SHAPE_LINE_CHAIN& aPoly )
 {
 shape->AddShape( aPoly.Clone() );
 } );
 
 font->Draw( &callback_gal, GetShownText(), GetDrawPos(), attrs );
 }
 
 return shape;
}

References ANGLE_0, SHAPE_SIMPLE::Append(), KIFONT::FONT::Draw(), GetAttributes(), getDrawFont(), GetDrawPos(), GetDrawRotation(), GetEffectiveTextPenWidth(), GetShownText(), and TEXT_ATTRIBUTES::m_Angle.

Referenced by FP_TEXT::GetEffectiveShape(), FP_TEXTBOX::GetEffectiveShape(), PCB_TEXT::GetEffectiveShape(), PCB_TEXTBOX::GetEffectiveShape(), PCB_SELECTION_TOOL::hitTestDistance(), PNS_KICAD_IFACE_BASE::syncTextItem(), and TransformBoundingBoxToPolygon().

◆ GetFont()

KIFONT::FONT * EDA_TEXT::GetFont ( ) const

inline

Definition at line 188 of file eda_text.h.

188{ return m_attributes.m_Font; }

TEXT_ATTRIBUTES::m_Font

KIFONT::FONT * m_Font

Definition: text_attributes.h:66

References m_attributes, and TEXT_ATTRIBUTES::m_Font.

◆ GetFontName()

wxString EDA_TEXT::GetFontName ( ) const

Definition at line 757 of file eda_text.cpp.

{
 if( GetFont() )
 return GetFont()->GetName();
 else
 return wxEmptyString;
}

References GetFont(), and KIFONT::FONT::GetName().

Referenced by Compare(), IsDefaultFormatting(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ GetHorizJustify()

GR_TEXT_H_ALIGN_T EDA_TEXT::GetHorizJustify ( ) const

inline

Definition at line 149 of file eda_text.h.

149{ return m_attributes.m_Halign; };

References m_attributes, and TEXT_ATTRIBUTES::m_Halign.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), LIB_TEXTBOX::compare(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), AUTOPLACER::fieldHPlacement(), Format(), LIB_TEXTBOX::GetDrawPos(), SCH_TEXTBOX::GetDrawPos(), FP_TEXTBOX::GetDrawPos(), PCB_TEXTBOX::GetDrawPos(), SCH_FIELD::GetEffectiveHorizJustify(), LIB_FIELD::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), GetTextBox(), hash_fp_item(), IsDefaultFormatting(), SCH_FIELD::IsHorizJustifyFlipped(), FP_TEXT::KeepUpright(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_EDIT_TOOL::Mirror(), FP_TEXT::Mirror(), PCB_TEXT::Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_TEXTBOX::MirrorHorizontally(), SCH_TEXTBOX::MirrorHorizontally(), LIB_TEXT::MirrorVertical(), LIB_TEXTBOX::MirrorVertically(), SCH_TEXTBOX::MirrorVertically(), LIB_TEXT::NormalizeJustification(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), positioningChanged(), LIB_FIELD::print(), printOneLineOfText(), LIB_TEXT::Rotate(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), textsNeedUpdate(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow().

◆ GetHyperlink()

wxString EDA_TEXT::GetHyperlink ( ) const

inline

Definition at line 334 of file eda_text.h.

334{ return m_hyperlink; }

EDA_TEXT::m_hyperlink

wxString m_hyperlink

A hyperlink URL.

Definition: eda_text.h:386

References m_hyperlink.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), EDA_TEXT_DESC::EDA_TEXT_DESC(), Format(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), and DIALOG_TEXT_PROPERTIES::TransferDataToWindow().

◆ GetInterline()

int EDA_TEXT::GetInterline ( ) const

Return the distance between two lines of text.

Calculates the distance (pitch) between two lines of text. This distance includes the interline distance plus room for characters like j, {, and [. It also used for single line text, to calculate the text bounding box.

Definition at line 497 of file eda_text.cpp.

{
 return KiROUND( getDrawFont()->GetInterline( GetTextHeight() ) );
}

References getDrawFont(), GetInterline(), GetTextHeight(), and KiROUND().

Referenced by CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), GetInterline(), and GetLinePositions().

◆ GetLinePositions()

void EDA_TEXT::GetLinePositions	(	std::vector< VECTOR2I > &	aPositions,
		int	aLineCount
	)		const

Populate aPositions with the position of each line of a multiline text, according to the vertical justification and the rotation of the whole text.

Parameters

aPositions	is the list to populate by the VECTOR2I positions.
aLineCount	is the number of lines (not recalculated here for efficiency reasons.

Definition at line 671 of file eda_text.cpp.

{
 VECTOR2I pos = GetDrawPos(); // Position of first line of the multiline text according
 // to the center of the multiline text block
 
 VECTOR2I offset; // Offset to next line.
 
 offset.y = GetInterline();
 
 if( aLineCount > 1 )
 {
 switch( GetVertJustify() )
 {
 case GR_TEXT_V_ALIGN_TOP:
 break;
 
 case GR_TEXT_V_ALIGN_CENTER:
 pos.y -= ( aLineCount - 1 ) * offset.y / 2;
 break;
 
 case GR_TEXT_V_ALIGN_BOTTOM:
 pos.y -= ( aLineCount - 1 ) * offset.y;
 break;
 }
 }
 
 // Rotate the position of the first line around the center of the multiline text block
 RotatePoint( pos, GetDrawPos(), GetDrawRotation() );
 
 // Rotate the offset lines to increase happened in the right direction
 RotatePoint( offset, GetDrawRotation() );
 
 for( int ii = 0; ii < aLineCount; ii++ )
 {
 aPositions.push_back( (VECTOR2I) pos );
 pos += offset;
 }
}

References GetDrawPos(), GetDrawRotation(), GetInterline(), GetVertJustify(), GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_TOP, RotatePoint(), and VECTOR2< T >::y.

Referenced by SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotPcbText(), and Print().

◆ GetLineSpacing()

double EDA_TEXT::GetLineSpacing ( ) const

inline

Definition at line 193 of file eda_text.h.

193{ return m_attributes.m_LineSpacing; }

References m_attributes, and TEXT_ATTRIBUTES::m_LineSpacing.

Referenced by Format().

◆ GetRenderCache()

std::vector< std::unique_ptr< KIFONT::GLYPH > > * EDA_TEXT::GetRenderCache	(	const KIFONT::FONT *	aFont,
		const wxString &	forResolvedText,
		const VECTOR2I &	aOffset = `{ 0, 0 }`
	)		const

Definition at line 451 of file eda_text.cpp.

{
 if( getDrawFont()->IsOutline() )
 {
 EDA_ANGLE resolvedAngle = GetDrawRotation();
 
 if( m_render_cache.empty()
 || m_render_cache_text != forResolvedText
 || m_render_cache_angle != resolvedAngle
 || m_render_cache_offset != aOffset )
 {
 m_render_cache.clear();
 
 KIFONT::OUTLINE_FONT* font = static_cast<KIFONT::OUTLINE_FONT*>( getDrawFont() );
 TEXT_ATTRIBUTES attrs = GetAttributes();
 
 attrs.m_Angle = resolvedAngle;
 
 font->GetLinesAsGlyphs( &m_render_cache, GetShownText(), GetDrawPos() + aOffset, attrs );
 m_render_cache_angle = resolvedAngle;
 m_render_cache_text = forResolvedText;
 m_render_cache_offset = aOffset;
 }
 
 return &m_render_cache;
 }
 
 return nullptr;
}

References GetAttributes(), getDrawFont(), GetDrawPos(), GetDrawRotation(), KIFONT::OUTLINE_FONT::GetLinesAsGlyphs(), GetShownText(), TEXT_ATTRIBUTES::m_Angle, m_render_cache, m_render_cache_angle, m_render_cache_offset, and m_render_cache_text.

Referenced by KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), and PCB_PLUGIN::formatRenderCache().

◆ GetShownText()

virtual wxString EDA_TEXT::GetShownText	(	int	aDepth = `0`,
		bool	aAllowExtraText = `true`
	)		const

inlinevirtual

Return the string actually shown after processing of the base text.

Parameters

aDepth	is used to prevent infinite recursions and loops when expanding text variables.
aAllowExtraText	is true to allow adding more text than the initial expanded text, for intance a title, a prefix for texts in display functions. False to disable any added text (for instance when writing the shown text in netlists).

Reimplemented in LIB_FIELD, LIB_TEXTBOX, SCH_FIELD, SCH_LABEL_BASE, SCH_TEXT, SCH_TEXTBOX, FP_TEXT, FP_TEXTBOX, PCB_TEXT, and PCB_TEXTBOX.

Definition at line 98 of file eda_text.h.

98{ return m_shown_text; }

References m_shown_text.

Referenced by BOARD_ADAPTER::addText(), KIGFX::DS_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), PCB_PLUGIN::formatRenderCache(), GetEffectiveTextShape(), LIB_TEXT::GetItemDescription(), DS_DRAW_ITEM_TEXT::GetItemDescription(), GetRenderCache(), LIB_FIELD::GetShownText(), LIB_TEXTBOX::GetShownText(), SCH_FIELD::GetShownText(), SCH_LABEL_BASE::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXTBOX::GetShownText(), FP_TEXT::GetShownText(), FP_TEXTBOX::GetShownText(), PCB_TEXT::GetShownText(), PCB_TEXTBOX::GetShownText(), GetTextBox(), BRDITEMS_PLOTTER::PlotPcbText(), Print(), and LIB_TEXT::print().

◆ GetText()

virtual const wxString & EDA_TEXT::GetText ( ) const

inlinevirtual

Return the string associated with the text object.

Returns: a const wxString reference containing the string of the item.

Definition at line 87 of file eda_text.h.

87{ return m_text; }

References m_text.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), SCH_EAGLE_PLUGIN::addImplicitConnections(), SCH_SHEET_PATH::AddNewSymbolInstances(), NETLIST_EXPORTER_XML::addSymbolFields(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_FRAME::AutoRotateItem(), EE_SELECTION_TOOL::autostartEvent(), CONNECTION_GRAPH::buildConnectionGraph(), SCH_EDIT_TOOL::ChangeTextType(), CheckLibSymbol(), SCH_SHEET::CleanupSheet(), LIB_TEXT::Clone(), LIB_FIELD::compare(), LIB_TEXT::compare(), LIB_TEXTBOX::compare(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::createSheetPin(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), DIALOG_LIB_FIELD_PROPERTIES::DIALOG_LIB_FIELD_PROPERTIES(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), KIGFX::SCH_VIEW::DisplaySymbol(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT_DESC::EDA_TEXT_DESC(), CONNECTION_GRAPH::ercCheckHierSheets(), CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), LIB_SYMBOL::Flatten(), PCB_PLUGIN::format(), LIB_SYMBOL::GetFootprint(), SCH_SYMBOL::GetFootprintFieldText(), LIB_FIELD::GetFullText(), FOOTPRINT_INFO_GENERATOR::GetHtmlFieldRow(), SCH_LABEL_BASE::GetIntersheetRefs(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadNet(), FP_TEXT::GetLength(), LIB_FIELD::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), LIB_TEXTBOX::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), LIB_SYMBOL::GetPrefix(), SCH_SYMBOL::GetRef(), FOOTPRINT::GetReference(), LIB_SYMBOL::GetSearchText(), PCB_DIMENSION_BASE::GetText(), FOOTPRINT::GetValue(), SCH_SYMBOL::GetValueFieldText(), hash_fp_item(), SCH_SHEET::HasUndefinedPins(), LIB_FIELD::HitTest(), SCH_DRAWING_TOOLS::importHierLabel(), SCH_LABEL_BASE::IncrementLabel(), GENERAL_COLLECTOR::Inspect(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_EAGLE_PLUGIN::loadSchematic(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_EAGLE_PLUGIN::loadSegments(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), LIB_TEXTBOX::Matches(), SCH_LABEL_BASE::Matches(), SCH_SHEET_PIN::Matches(), SCH_TEXT::Matches(), SCH_TEXTBOX::Matches(), DIALOG_SHEET_PIN_PROPERTIES::onComboBox(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), SCH_FIELD::operator<(), SCH_TEXT::operator<(), SCH_TEXTBOX::operator<(), LIB_FIELD::operator=(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceText(), LIB_FIELD::Plot(), LIB_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), DIALOG_RESCUE_EACH::PopulateInstanceList(), LIB_FIELD::print(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_EDIT_FRAME::PutDataInPreviousState(), NETLIST_EXPORTER_SPICE_MODEL::readPorts(), SCHEMATIC::RecomputeIntersheetRefs(), SCH_GLOBALLABEL::ResolveTextVar(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_SEXPR_PLUGIN::saveField(), CLIPBOARD_IO::SaveSelection(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), SCH_LEGACY_PLUGIN::saveSymbol(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN::saveText(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveTextBox(), SCH_SEXPR_PLUGIN::saveTextBox(), SCH_EDIT_FRAME::SendSelectItemsToPcb(), SYMBOL_EDIT_FRAME::setupUIConditions(), SYMBOL_VIEWER_FRAME::setupUIConditions(), EE_INSPECTION_TOOL::ShowDatasheet(), SCH_SHEET::SymbolCount(), textsNeedUpdate(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow(), TransformBoundingBoxToPolygon(), SCH_EDITOR_CONTROL::updatePastedSymbol(), SCH_SYMBOL::UpdatePrefix(), SYMBOL_EDIT_FRAME::UpdateSymbolMsgPanelInfo(), and FP_TEXT::ViewGetLOD().

◆ GetTextAngle()

const EDA_ANGLE & EDA_TEXT::GetTextAngle ( ) const

inline

Definition at line 120 of file eda_text.h.

120{ return m_attributes.m_Angle; }

References TEXT_ATTRIBUTES::m_Angle, and m_attributes.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_TOOL::ChangeTextType(), LIB_TEXTBOX::compare(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), PCB_TEXT::Flip(), PCB_TEXTBOX::Flip(), PCB_PLUGIN::format(), SCH_LABEL::GetBodyBoundingBox(), LIB_FIELD::GetBoundingBox(), LIB_TEXT::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), PCB_TEXT::GetBoundingBox(), LIB_TEXTBOX::GetDrawPos(), SCH_TEXTBOX::GetDrawPos(), GetDrawRotation(), SCH_FIELD::GetDrawRotation(), FP_TEXT::GetDrawRotation(), FP_TEXTBOX::GetDrawRotation(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), LIB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), hash_fp_item(), LIB_FIELD::HitTest(), LIB_TEXT::HitTest(), FP_TEXT::KeepUpright(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), FP_TEXT::Mirror(), PCB_TEXT::Mirror(), PCB_DIMENSION_BASE::Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_TEXTBOX::MirrorHorizontally(), SCH_TEXTBOX::MirrorHorizontally(), LIB_TEXT::MirrorVertical(), LIB_TEXTBOX::MirrorVertically(), SCH_TEXTBOX::MirrorVertically(), LIB_TEXT::NormalizeJustification(), KI_TEST::kitest_cmp_drawings::operator()(), EAGLE_PLUGIN::orientFPText(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_FIELD::Plot(), LIB_TEXT::Plot(), positioningChanged(), SCH_FIELD::Print(), LIB_FIELD::print(), LIB_TEXT::print(), SCH_EDIT_TOOL::Rotate(), SCH_TEXTBOX::Rotate(), LIB_TEXTBOX::Rotate(), LIB_FIELD::Rotate(), LIB_TEXT::Rotate(), FP_TEXT::Rotate(), FP_TEXTBOX::Rotate(), PCB_DIMENSION_BASE::Rotate(), PCB_TEXT::Rotate(), PCB_TEXTBOX::Rotate(), SCH_TEXTBOX::Rotate90(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_SEXPR_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveTextBox(), SCH_SEXPR_PLUGIN::saveTextBox(), textsNeedUpdate(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), PCB_DIM_RADIAL::updateGeometry(), and PCB_DIM_LEADER::updateGeometry().

◆ GetTextAngleDegrees()

double EDA_TEXT::GetTextAngleDegrees ( ) const

inline

Definition at line 127 of file eda_text.h.

127{ return m_attributes.m_Angle.AsDegrees(); }

References EDA_ANGLE::AsDegrees(), TEXT_ATTRIBUTES::m_Angle, and m_attributes.

Referenced by EDA_TEXT_DESC::EDA_TEXT_DESC().

◆ GetTextBox()

BOX2I EDA_TEXT::GetTextBox	(	int	aLine = `-1`,
		bool	aInvertY = `false`
	)		const

Useful in multiline texts to calculate the full text or a line area (for zones filling, locate functions....)

Parameters

aLine	The line of text to consider. Pass -1 for all lines.
aInvertY	Invert the Y axis when calculating bounding box.

Returns: the rect containing the line of text (i.e. the position and the size of one line) this rectangle is calculated for 0 orient text. If orientation is not 0 the rect must be rotated to match the physical area

Definition at line 503 of file eda_text.cpp.

{
 VECTOR2I drawPos = GetDrawPos();
 
 if( m_bounding_box_cache_valid
 && m_bounding_box_cache_pos == drawPos
 && m_bounding_box_cache_line == aLine
 && m_bounding_box_cache_inverted == aInvertY )
 {
 return m_bounding_box_cache;
 }
 
 BOX2I bbox;
 wxArrayString strings;
 wxString text = GetShownText();
 int thickness = GetEffectiveTextPenWidth();
 
 if( IsMultilineAllowed() )
 {
 wxStringSplit( text, strings, '\n' );
 
 if( strings.GetCount() ) // GetCount() == 0 for void strings with multilines allowed
 {
 if( aLine >= 0 && ( aLine < static_cast<int>( strings.GetCount() ) ) )
 text = strings.Item( aLine );
 else
 text = strings.Item( 0 );
 }
 }
 
 // calculate the H and V size
 KIFONT::FONT* font = getDrawFont();
 VECTOR2D fontSize( GetTextSize() );
 bool bold = IsBold();
 bool italic = IsItalic();
 VECTOR2I extents = font->StringBoundaryLimits( text, fontSize, thickness, bold, italic );
 int overbarOffset = 0;
 
 // Creates bounding box (rectangle) for horizontal, left and top justified text. The
 // bounding box will be moved later according to the actual text options
 wxSize textsize = wxSize( extents.x, extents.y );
 VECTOR2I pos = drawPos;
 
 if( IsMultilineAllowed() && aLine > 0 && aLine < (int) strings.GetCount() )
 pos.y -= KiROUND( aLine * font->GetInterline( fontSize.y ) );
 
 if( text.Contains( wxT( "~{" ) ) )
 overbarOffset = extents.y / 14;
 
 if( aInvertY )
 pos.y = -pos.y;
 
 bbox.SetOrigin( pos );
 
 // for multiline texts and aLine < 0, merge all rectangles (aLine == -1 signals all lines)
 if( IsMultilineAllowed() && aLine < 0 && strings.GetCount() )
 {
 for( unsigned ii = 1; ii < strings.GetCount(); ii++ )
 {
 text = strings.Item( ii );
 extents = font->StringBoundaryLimits( text, fontSize, thickness, bold, italic );
 textsize.x = std::max( textsize.x, extents.x );
 }
 
 // interline spacing is only *between* lines, so total height is the height of the first
 // line plus the interline distance (with interline spacing) for all subsequent lines
 textsize.y += KiROUND( ( strings.GetCount() - 1 ) * font->GetInterline( fontSize.y ) );
 }
 
 bbox.SetSize( textsize );
 
 /*
 * At this point the rectangle origin is the text origin (m_Pos). This is correct only for
 * left and top justified, non-mirrored, non-overbarred texts. Recalculate for all others.
 */
 int italicOffset = IsItalic() ? KiROUND( fontSize.y * ITALIC_TILT ) : 0;
 
 switch( GetHorizJustify() )
 {
 case GR_TEXT_H_ALIGN_LEFT:
 if( IsMirrored() )
 bbox.SetX( bbox.GetX() - ( bbox.GetWidth() - italicOffset ) );
 break;
 
 case GR_TEXT_H_ALIGN_CENTER:
 bbox.SetX( bbox.GetX() - ( bbox.GetWidth() - italicOffset ) / 2 );
 break;
 
 case GR_TEXT_H_ALIGN_RIGHT:
 if( !IsMirrored() )
 bbox.SetX( bbox.GetX() - ( bbox.GetWidth() - italicOffset ) );
 break;
 }
 
 switch( GetVertJustify() )
 {
 case GR_TEXT_V_ALIGN_TOP:
 break;
 
 case GR_TEXT_V_ALIGN_CENTER:
 bbox.SetY( bbox.GetY() - ( bbox.GetHeight() + overbarOffset ) / 2 );
 break;
 
 case GR_TEXT_V_ALIGN_BOTTOM:
 bbox.SetY( bbox.GetY() - ( bbox.GetHeight() + overbarOffset ) );
 break;
 }
 
 bbox.Normalize(); // Make h and v sizes always >= 0
 
 m_bounding_box_cache_valid = true;
 m_bounding_box_cache_pos = drawPos;
 m_bounding_box_cache_line = aLine;
 m_bounding_box_cache_inverted = aInvertY;
 m_bounding_box_cache = bbox;
 
 return bbox;
}

References getDrawFont(), GetDrawPos(), GetEffectiveTextPenWidth(), BOX2< Vec >::GetHeight(), GetHorizJustify(), KIFONT::FONT::GetInterline(), GetShownText(), GetTextSize(), GetVertJustify(), BOX2< Vec >::GetWidth(), BOX2< Vec >::GetX(), BOX2< Vec >::GetY(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_TOP, IsBold(), IsItalic(), IsMirrored(), IsMultilineAllowed(), ITALIC_TILT, KiROUND(), m_bounding_box_cache, m_bounding_box_cache_inverted, m_bounding_box_cache_line, m_bounding_box_cache_pos, m_bounding_box_cache_valid, BOX2< Vec >::Normalize(), BOX2< Vec >::SetOrigin(), BOX2< Vec >::SetSize(), BOX2< Vec >::SetX(), BOX2< Vec >::SetY(), KIFONT::FONT::StringBoundaryLimits(), text, wxStringSplit(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ GetTextColor()

COLOR4D EDA_TEXT::GetTextColor ( ) const

inline

Definition at line 205 of file eda_text.h.

205{ return m_attributes.m_Color; }

TEXT_ATTRIBUTES::m_Color

KIGFX::COLOR4D m_Color

Definition: text_attributes.h:75

References m_attributes, and TEXT_ATTRIBUTES::m_Color.

Referenced by DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), Format(), SCH_FIELD::GetFieldColor(), SCH_LABEL_BASE::GetLabelColor(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_FIELD::Plot(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), SCH_FIELD::Print(), LIB_FIELD::print(), LIB_TEXT::print(), LIB_TEXTBOX::print(), SCH_LABEL_BASE::Print(), SCH_TEXT::Print(), SCH_TEXTBOX::Print(), DS_DRAW_ITEM_TEXT::PrintWsItem(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXT_PROPERTIES::TransferDataToWindow().

◆ GetTextHeight()

int EDA_TEXT::GetTextHeight ( ) const

inline

Definition at line 202 of file eda_text.h.

202{ return m_attributes.m_Size.y; }

References m_attributes, TEXT_ATTRIBUTES::m_Size, and VECTOR2< T >::y.

Referenced by SCH_LABEL_BASE::AutoplaceFields(), LIB_FIELD::compare(), LIB_TEXT::compare(), LIB_TEXTBOX::compare(), SCH_GLOBALLABEL::CreateGraphicShape(), SCH_HIERLABEL::CreateGraphicShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), Format(), SCH_HIERLABEL::GetBodyBoundingBox(), GetInterline(), PCB_TEXT::getKnockoutMargin(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), SCH_GLOBALLABEL::GetSchematicTextOffset(), hash_fp_item(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), SCH_SEXPR_PLUGIN::saveField(), PCB_DIM_ALIGNED::updateText(), and PCB_DIM_ORTHOGONAL::updateText().

◆ GetTextPos()

const VECTOR2I & EDA_TEXT::GetTextPos ( ) const

inline

Definition at line 208 of file eda_text.h.

208{ return m_pos; }

References m_pos.

Referenced by SCH_LABEL_BASE::AutoplaceFields(), LIB_FIELD::compare(), LIB_TEXT::compare(), SCH_SHEET_PIN::ConstrainOnEdge(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), SCH_LABEL::doIsConnected(), SCH_GLOBALLABEL::doIsConnected(), SCH_HIERLABEL::doIsConnected(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), PCB_TEXT::Flip(), PCB_PLUGIN::format(), SCH_LABEL_BASE::GetBodyBoundingBox(), SCH_LABEL::GetBodyBoundingBox(), SCH_HIERLABEL::GetBodyBoundingBox(), LIB_FIELD::GetBoundingBox(), LIB_TEXT::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), FP_TEXT::GetBoundingBox(), PCB_TEXT::GetBoundingBox(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_LABEL_BASE::GetConnectionPoints(), GetDrawPos(), SCH_LABEL_BASE::GetEndPoints(), SCH_SHEET_PIN::GetEndPoints(), SCH_FIELD::GetLibPosition(), LIB_FIELD::GetPosition(), LIB_TEXT::GetPosition(), SCH_FIELD::GetPosition(), SCH_TEXT::GetPosition(), DS_DRAW_ITEM_TEXT::GetPosition(), FP_TEXT::GetPosition(), PCB_TEXT::GetPosition(), LIB_FIELD::HitTest(), LIB_TEXT::HitTest(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), FP_TEXT::Mirror(), PCB_TEXT::Mirror(), PCB_DIMENSION_BASE::Mirror(), LIB_FIELD::MirrorHorizontal(), LIB_TEXT::MirrorHorizontal(), SCH_SHEET_PIN::MirrorHorizontally(), SCH_TEXT::MirrorHorizontally(), LIB_FIELD::MirrorVertical(), LIB_TEXT::MirrorVertical(), SCH_SHEET_PIN::MirrorVertically(), SCH_TEXT::MirrorVertically(), LIB_TEXT::NormalizeJustification(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), DRAWING_TOOL::PlaceText(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), LIB_FIELD::print(), SCH_LABEL_BASE::Print(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_LABEL_BASE::Rotate(), SCH_SHEET_PIN::Rotate(), SCH_TEXT::Rotate(), LIB_FIELD::Rotate(), LIB_TEXT::Rotate(), FP_TEXT::Rotate(), PCB_DIMENSION_BASE::Rotate(), PCB_TEXT::Rotate(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), FP_TEXT::SetDrawCoord(), FP_TEXT::SetLocalCoord(), FP_TEXT::TextHitTest(), FP_TEXT::TransformTextToPolySet(), PCB_TEXT::TransformTextToPolySet(), SCH_LABEL_BASE::UpdateDanglingState(), and FP_TEXT::ViewBBox().

◆ GetTextSize()

VECTOR2I EDA_TEXT::GetTextSize ( ) const

inline

Definition at line 196 of file eda_text.h.

196{ return m_attributes.m_Size; }

References m_attributes, and TEXT_ATTRIBUTES::m_Size.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), MICROWAVE_TOOL::createMicrowaveInductor(), KIGFX::SCH_PAINTER::draw(), FP_TEXT::GetEffectiveShape(), PCB_TEXT::GetEffectiveShape(), GetEffectiveTextPenWidth(), SCH_LABEL_BASE::GetLabelBoxExpansion(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), LIB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), FP_TEXTBOX::GetShownText(), PCB_TEXTBOX::GetShownText(), GetTextBox(), LIB_TEXTBOX::GetTextMargin(), SCH_TEXTBOX::GetTextMargin(), FP_TEXTBOX::GetTextMargin(), PCB_TEXTBOX::GetTextMargin(), SCH_TEXT::GetTextOffset(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), EAGLE_PLUGIN::orientFPText(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_FIELD::Plot(), LIB_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), SCH_FIELD::Print(), LIB_FIELD::print(), LIB_TEXT::print(), SCH_TEXT::Print(), printOneLineOfText(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), SCH_LEGACY_PLUGIN::saveSheet(), textsNeedUpdate(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow().

◆ GetTextStyleName()

wxString EDA_TEXT::GetTextStyleName ( ) const

Returns: a wxString with the style name( Normal, Italic, Bold, Bold+Italic).

Definition at line 736 of file eda_text.cpp.

{
 int style = 0;
 
 if( IsItalic() )
 style = 1;
 
 if( IsBold() )
 style += 2;
 
 wxString stylemsg[4] = {
 _("Normal"),
 _("Italic"),
 _("Bold"),
 _("Bold+Italic")
 };
 
 return stylemsg[style];
}

References _, IsBold(), and IsItalic().

Referenced by LIB_FIELD::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), and SCH_FIELD::GetMsgPanelInfo().

◆ GetTextThickness()

int EDA_TEXT::GetTextThickness ( ) const

inline

Definition at line 112 of file eda_text.h.

112{ return m_attributes.m_StrokeWidth; };

References m_attributes, and TEXT_ATTRIBUTES::m_StrokeWidth.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), EDA_TEXT_DESC::EDA_TEXT_DESC(), Format(), GetEffectiveTextPenWidth(), PCB_TEXT::getKnockoutMargin(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), LIB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), FP_TEXTBOX::GetShownText(), PCB_TEXTBOX::GetShownText(), ALTIUM_PCB::HelperParseDimensions6Linear(), ALTIUM_PCB::HelperParseDimensions6Radial(), IsDefaultFormatting(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), SCH_LEGACY_PLUGIN::saveText(), textsNeedUpdate(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow().

◆ GetTextWidth()

int EDA_TEXT::GetTextWidth ( ) const

inline

Definition at line 199 of file eda_text.h.

199{ return m_attributes.m_Size.x; }

References m_attributes, TEXT_ATTRIBUTES::m_Size, and VECTOR2< T >::x.

◆ GetVertJustify()

GR_TEXT_V_ALIGN_T EDA_TEXT::GetVertJustify ( ) const

inline

Definition at line 152 of file eda_text.h.

152{ return m_attributes.m_Valign; };

References m_attributes, and TEXT_ATTRIBUTES::m_Valign.

Referenced by DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), EDA_TEXT_DESC::EDA_TEXT_DESC(), Format(), LIB_TEXTBOX::GetDrawPos(), SCH_TEXTBOX::GetDrawPos(), SCH_FIELD::GetEffectiveVertJustify(), GetLinePositions(), LIB_FIELD::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), GetTextBox(), hash_fp_item(), IsDefaultFormatting(), SCH_FIELD::IsVertJustifyFlipped(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), SCH_EDIT_TOOL::Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_TEXT::MirrorVertical(), LIB_TEXT::NormalizeJustification(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), positioningChanged(), LIB_FIELD::print(), printOneLineOfText(), LIB_TEXT::Rotate(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), textsNeedUpdate(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXT_PROPERTIES::TransferDataToWindow().

◆ GotoPageHref()

wxString EDA_TEXT::GotoPageHref ( const wxString & aDestination )

static

Generate a href to a page in the current schematic.

Parameters

aDestination Destination sheet's page number.

Returns: A hyperlink href string that goes to the specified page.

Definition at line 1004 of file eda_text.cpp.

{
 return wxT( "#" ) + aDestination;
}

Referenced by SCH_SHEET::Plot().

◆ HasHyperlink()

virtual bool EDA_TEXT::HasHyperlink ( ) const

inlinevirtual

Definition at line 333 of file eda_text.h.

333{ return !m_hyperlink.IsEmpty(); }

References m_hyperlink.

Referenced by Format(), SCH_TEXT::IsHypertext(), SCH_TEXTBOX::IsHypertext(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), and DIALOG_TEXT_PROPERTIES::TransferDataToWindow().

◆ HasTextVars()

bool EDA_TEXT::HasTextVars ( ) const

inline

Indicates the ShownText has text var references which need to be processed.

Definition at line 103 of file eda_text.h.

103{ return m_shown_text_has_text_var_refs; }

References m_shown_text_has_text_var_refs.

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_FIELD::GetShownText(), SCH_LABEL_BASE::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXTBOX::GetShownText(), FP_TEXT::GetShownText(), FP_TEXTBOX::GetShownText(), PCB_TEXT::GetShownText(), and PCB_TEXTBOX::GetShownText().

◆ IsBold()

bool EDA_TEXT::IsBold ( ) const

inline

Definition at line 133 of file eda_text.h.

133{ return m_attributes.m_Bold; }

References m_attributes, and TEXT_ATTRIBUTES::m_Bold.

Referenced by BOARD_ADAPTER::addText(), SCH_EDIT_TOOL::ChangeTextType(), LIB_TEXTBOX::compare(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), Format(), getDrawFont(), LIB_FIELD::getDrawFont(), LIB_TEXT::getDrawFont(), LIB_TEXTBOX::getDrawFont(), SCH_FIELD::getDrawFont(), SCH_TEXT::getDrawFont(), SCH_TEXTBOX::getDrawFont(), GetEffectiveTextPenWidth(), LIB_TEXTBOX::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), SCH_FIELD::GetRenderCache(), LIB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), FP_TEXTBOX::GetShownText(), PCB_TEXTBOX::GetShownText(), GetTextBox(), GetTextStyleName(), hash_fp_item(), IsDefaultFormatting(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_FIELD::Plot(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), SCH_FIELD::Print(), LIB_FIELD::print(), LIB_TEXT::print(), LIB_TEXTBOX::print(), SCH_TEXT::Print(), printOneLineOfText(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), textsNeedUpdate(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow().

◆ IsDefaultFormatting()

bool EDA_TEXT::IsDefaultFormatting ( ) const

Definition at line 766 of file eda_text.cpp.

{
 return ( IsVisible()
 && !IsMirrored()
 && GetHorizJustify() == GR_TEXT_H_ALIGN_CENTER
 && GetVertJustify() == GR_TEXT_V_ALIGN_CENTER
 && GetTextThickness() == 0
 && !IsItalic()
 && !IsBold()
 && !IsMultilineAllowed()
 && GetFontName().IsEmpty()
 );
}

References GetFontName(), GetHorizJustify(), GetTextThickness(), GetVertJustify(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_V_ALIGN_CENTER, IsBold(), IsItalic(), IsMirrored(), IsMultilineAllowed(), and IsVisible().

Referenced by SCH_SEXPR_PLUGIN::saveField().

◆ IsGotoPageHref()

bool EDA_TEXT::IsGotoPageHref	(	const wxString &	aHref,
		wxString *	aDestination = `nullptr`
	)

static

Check if aHref is a valid internal hyperlink.

Parameters

aHref	String to validate
aDestination	[optional] pointer to populate with the destination page

Returns: true if aHref is a valid internal hyperlink. Does not check if the destination page actually exists.

Definition at line 998 of file eda_text.cpp.

{
 return aHref.StartsWith( wxT( "#" ), aDestination );
}

Referenced by PDF_PLOTTER::EndPlot(), SCH_NAVIGATE_TOOL::HypertextCommand(), and ValidateHyperlink().

◆ IsItalic()

bool EDA_TEXT::IsItalic ( ) const

inline

Definition at line 130 of file eda_text.h.

130{ return m_attributes.m_Italic; }

References m_attributes, and TEXT_ATTRIBUTES::m_Italic.

Referenced by BOARD_ADAPTER::addText(), SCH_DIRECTIVE_LABEL::AutoplaceFields(), SCH_EDIT_TOOL::ChangeTextType(), LIB_TEXTBOX::compare(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), Format(), getDrawFont(), LIB_FIELD::getDrawFont(), LIB_TEXT::getDrawFont(), LIB_TEXTBOX::getDrawFont(), SCH_FIELD::getDrawFont(), SCH_TEXT::getDrawFont(), SCH_TEXTBOX::getDrawFont(), LIB_TEXTBOX::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), SCH_FIELD::GetRenderCache(), LIB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), FP_TEXTBOX::GetShownText(), PCB_TEXTBOX::GetShownText(), GetTextBox(), GetTextStyleName(), hash_fp_item(), IsDefaultFormatting(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_FIELD::Plot(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), SCH_FIELD::Print(), LIB_FIELD::print(), LIB_TEXT::print(), LIB_TEXTBOX::print(), SCH_TEXT::Print(), printOneLineOfText(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN::saveText(), textsNeedUpdate(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow().

◆ IsKeepUpright()

bool EDA_TEXT::IsKeepUpright ( ) const

inline

Definition at line 155 of file eda_text.h.

155{ return m_attributes.m_KeepUpright; }

References m_attributes, and TEXT_ATTRIBUTES::m_KeepUpright.

Referenced by PCB_PLUGIN::format(), FP_TEXT::GetDrawRotation(), FP_TEXT::KeepUpright(), and textsNeedUpdate().

◆ IsMirrored()

bool EDA_TEXT::IsMirrored ( ) const

inline

◆ IsMultilineAllowed()

bool EDA_TEXT::IsMultilineAllowed ( ) const

inline

Definition at line 146 of file eda_text.h.

146{ return m_attributes.m_Multiline; }

References m_attributes, and TEXT_ATTRIBUTES::m_Multiline.

Referenced by GetTextBox(), IsDefaultFormatting(), BRDITEMS_PLOTTER::PlotPcbText(), and Print().

◆ IsVisible()

virtual bool EDA_TEXT::IsVisible ( ) const

inlinevirtual

Reimplemented in PCB_TEXT, and PCB_TEXTBOX.

Definition at line 136 of file eda_text.h.

136{ return m_attributes.m_Visible; }

References m_attributes, and TEXT_ATTRIBUTES::m_Visible.

Referenced by BOARD_ADAPTER::addFootprintShapes(), SCH_EDITOR_CONTROL::AssignFootprints(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), AUTOPLACER::DoAutoplace(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT_DESC::EDA_TEXT_DESC(), SCH_EDIT_TOOL::EditField(), PCB_PLUGIN::format(), Format(), FOOTPRINT::GetBoundingBox(), LIB_FIELD::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), SCH_FIELD::HitTest(), DRC_RTREE::Insert(), IsDefaultFormatting(), SCH_EAGLE_PLUGIN::loadInstance(), SCH_FIELD::Matches(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), SCH_FIELD::Plot(), LIB_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), SCH_FIELD::Print(), LIB_SYMBOL::Print(), LIB_FIELD::print(), LIB_TEXT::print(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_EDIT_TOOL::Properties(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), textsNeedUpdate(), FOOTPRINT::TransformFPShapesToPolySet(), SCH_SHEET_PATH::UpdateAllScreenReferences(), FP_TEXT::ViewGetLayers(), and FP_TEXTBOX::ViewGetLayers().

◆ MapHorizJustify()

GR_TEXT_H_ALIGN_T EDA_TEXT::MapHorizJustify ( int aHorizJustify )

static

Definition at line 62 of file eda_text.cpp.

{
 wxASSERT( aHorizJustify >= GR_TEXT_H_ALIGN_LEFT && aHorizJustify <= GR_TEXT_H_ALIGN_RIGHT );
 
 if( aHorizJustify > GR_TEXT_H_ALIGN_RIGHT )
 return GR_TEXT_H_ALIGN_RIGHT;
 
 if( aHorizJustify < GR_TEXT_H_ALIGN_LEFT )
 return GR_TEXT_H_ALIGN_LEFT;
 
 return static_cast<GR_TEXT_H_ALIGN_T>( aHorizJustify );
}

References GR_TEXT_H_ALIGN_LEFT, and GR_TEXT_H_ALIGN_RIGHT.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_LIB_FIELD_PROPERTIES::UpdateField(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ MapVertJustify()

GR_TEXT_V_ALIGN_T EDA_TEXT::MapVertJustify ( int aVertJustify )

static

Definition at line 76 of file eda_text.cpp.

{
 wxASSERT( aVertJustify >= GR_TEXT_V_ALIGN_TOP && aVertJustify <= GR_TEXT_V_ALIGN_BOTTOM );
 
 if( aVertJustify > GR_TEXT_V_ALIGN_BOTTOM )
 return GR_TEXT_V_ALIGN_BOTTOM;
 
 if( aVertJustify < GR_TEXT_V_ALIGN_TOP )
 return GR_TEXT_V_ALIGN_TOP;
 
 return static_cast<GR_TEXT_V_ALIGN_T>( aVertJustify );
}

References GR_TEXT_V_ALIGN_BOTTOM, and GR_TEXT_V_ALIGN_TOP.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_LIB_FIELD_PROPERTIES::UpdateField(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ Offset()

void EDA_TEXT::Offset ( const VECTOR2I & aOffset )

Definition at line 389 of file eda_text.cpp.

{
 m_pos += aOffset;
 
 for( std::unique_ptr<KIFONT::GLYPH>& glyph : m_render_cache )
 static_cast<KIFONT::OUTLINE_GLYPH*>( glyph.get() )->Move( aOffset );
 
 m_bounding_box_cache_valid = false;
}

References m_bounding_box_cache_valid, m_pos, and m_render_cache.

Referenced by CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), SCH_FIELD::Move(), SCH_SHEET_PIN::Move(), SCH_TEXT::Move(), SCH_TEXTBOX::Move(), FP_TEXT::Move(), FP_TEXTBOX::Move(), PCB_TEXT::Move(), PCB_TEXTBOX::Move(), PCB_DIMENSION_BASE::Move(), LIB_FIELD::Offset(), LIB_TEXT::Offset(), FP_TEXT::SetDrawCoord(), SetTextPos(), SetTextX(), SetTextY(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ operator=()

EDA_TEXT & EDA_TEXT::operator= ( const EDA_TEXT & aItem )

Definition at line 136 of file eda_text.cpp.

{
 m_text = aText.m_text;
 m_shown_text = aText.m_shown_text;
 m_shown_text_has_text_var_refs = aText.m_shown_text_has_text_var_refs;
 
 m_attributes = aText.m_attributes;
 m_pos = aText.m_pos;
 
 m_render_cache_text = aText.m_render_cache_text;
 m_render_cache_angle = aText.m_render_cache_angle;
 
 m_render_cache.clear();
 
 for( const std::unique_ptr<KIFONT::GLYPH>& glyph : aText.m_render_cache )
 {
 KIFONT::OUTLINE_GLYPH* outline_glyph = static_cast<KIFONT::OUTLINE_GLYPH*>( glyph.get() );
 m_render_cache.emplace_back( std::make_unique<KIFONT::OUTLINE_GLYPH>( *outline_glyph ) );
 }
 
 m_bounding_box_cache_valid = aText.m_bounding_box_cache_valid;
 m_bounding_box_cache = aText.m_bounding_box_cache;
 
 return *this;
}

References m_attributes, m_bounding_box_cache, m_bounding_box_cache_valid, m_pos, m_render_cache, m_render_cache_angle, m_render_cache_text, m_shown_text, m_shown_text_has_text_var_refs, and m_text.

Referenced by SCH_FIELD::operator=().

◆ Print()

void EDA_TEXT::Print	(	const RENDER_SETTINGS *	aSettings,
		const VECTOR2I &	aOffset,
		const COLOR4D &	aColor,
		OUTLINE_MODE	aDisplay_mode = `FILLED`
	)

Print this text object to the device context aDC.

Parameters

aDC	the current Device Context.
aOffset	draw offset (usually (0,0)).
aColor	text color.
aDisplay_mode	FILLED or SKETCH.

Definition at line 648 of file eda_text.cpp.

{
 if( IsMultilineAllowed() )
 {
 std::vector<VECTOR2I> positions;
 wxArrayString strings;
 wxStringSplit( GetShownText(), strings, '\n' );
 
 positions.reserve( strings.Count() );
 
 GetLinePositions( positions, (int) strings.Count() );
 
 for( unsigned ii = 0; ii < strings.Count(); ii++ )
 printOneLineOfText( aSettings, aOffset, aColor, aFillMode, strings[ii], positions[ii] );
 }
 else
 {
 printOneLineOfText( aSettings, aOffset, aColor, aFillMode, GetShownText(), GetDrawPos() );
 }
}

References GetDrawPos(), GetLinePositions(), GetShownText(), IsMultilineAllowed(), printOneLineOfText(), and wxStringSplit().

Referenced by SCH_LABEL_BASE::Print(), SCH_TEXT::Print(), SCH_TEXTBOX::Print(), and DS_DRAW_ITEM_TEXT::PrintWsItem().

◆ printOneLineOfText()

void EDA_TEXT::printOneLineOfText	(	const RENDER_SETTINGS *	aSettings,
		const VECTOR2I &	aOffset,
		const COLOR4D &	aColor,
		OUTLINE_MODE	aFillMode,
		const wxString &	aText,
		const VECTOR2I &	aPos
	)

protected

Print each line of this EDA_TEXT.

Parameters

aOffset	draw offset (usually (0,0)).
aColor	text color.
aFillMode	FILLED or SKETCH
aText	the single line of text to draw.
aPos	the position of this line ).

Definition at line 711 of file eda_text.cpp.

{
 wxDC* DC = aSettings->GetPrintDC();
 int penWidth = GetEffectiveTextPenWidth( aSettings->GetDefaultPenWidth() );
 
 if( aFillMode == SKETCH )
 penWidth = -penWidth;
 
 VECTOR2I size = GetTextSize();
 
 if( IsMirrored() )
 size.x = -size.x;
 
 KIFONT::FONT* font = GetFont();
 
 if( !font )
 font = KIFONT::FONT::GetFont( aSettings->GetDefaultFont(), IsBold(), IsItalic() );
 
 GRPrintText( DC, aOffset + aPos, aColor, aText, GetDrawRotation(), size, GetHorizJustify(),
 GetVertJustify(), penWidth, IsItalic(), IsBold(), font );
}

References KIGFX::RENDER_SETTINGS::GetDefaultFont(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), GetDrawRotation(), GetEffectiveTextPenWidth(), GetFont(), KIFONT::FONT::GetFont(), GetHorizJustify(), KIGFX::RENDER_SETTINGS::GetPrintDC(), GetTextSize(), GetVertJustify(), GRPrintText(), IsBold(), IsItalic(), IsMirrored(), SKETCH, and VECTOR2< T >::x.

Referenced by Print().

◆ RemoveHyperlink()

void EDA_TEXT::RemoveHyperlink ( )

inline

Definition at line 336 of file eda_text.h.

336{ m_hyperlink = wxEmptyString; }

References m_hyperlink.

◆ Replace()

bool EDA_TEXT::Replace ( const EDA_SEARCH_DATA & aSearchData )

Helper function used in search and replace dialog.

Perform a text replace using the find and replace criteria in aSearchData.

Parameters

aSearchData A reference to a EDA_SEARCH_DATA object containing the search and replace criteria.

Returns: True if the text item was modified, otherwise false.

Definition at line 318 of file eda_text.cpp.

{
 bool retval = EDA_ITEM::Replace( aSearchData, m_text );
 
 cacheShownText();
 
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
 
 return retval;
}

References cacheShownText(), ClearRenderCache(), m_bounding_box_cache_valid, m_text, and EDA_ITEM::Replace().

Referenced by LIB_TEXTBOX::Replace(), SCH_LABEL_BASE::Replace(), SCH_TEXT::Replace(), SCH_TEXTBOX::Replace(), SCH_FIELD::Replace(), and SCH_SHEET_PIN::Replace().

◆ SetAttributes() [1/2]

void EDA_TEXT::SetAttributes ( const EDA_TEXT & aSrc )

Set the text attributes from another instance.

Definition at line 264 of file eda_text.cpp.

{
 m_attributes = aSrc.m_attributes;
 m_pos = aSrc.m_pos;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References ClearRenderCache(), m_attributes, m_bounding_box_cache_valid, and m_pos.

Referenced by LIB_TEXT::Clone(), LIB_FIELD::Copy(), SCH_FIELD::ImportValues(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), LIB_FIELD::operator=(), DRAWING_TOOL::PlaceText(), DIALOG_CHANGE_SYMBOLS::processSymbol(), and CLIPBOARD_IO::SaveSelection().

◆ SetAttributes() [2/2]

void EDA_TEXT::SetAttributes ( const TEXT_ATTRIBUTES & aTextAttrs )

inline

Definition at line 171 of file eda_text.h.

171{ m_attributes = aTextAttrs; }

References m_attributes.

◆ SetBold()

void EDA_TEXT::SetBold ( bool aBold )

Definition at line 209 of file eda_text.cpp.

{
 m_attributes.m_Bold = aBold;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References ClearRenderCache(), m_attributes, TEXT_ATTRIBUTES::m_Bold, and m_bounding_box_cache_valid.

Referenced by SCH_ALTIUM_PLUGIN::AddTextBox(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT_DESC::EDA_TEXT_DESC(), ALTIUM_PCB::HelperParseDimensions6Linear(), ALTIUM_PCB::HelperParseDimensions6Radial(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_LEGACY_PLUGIN::loadSymbol(), SCH_EAGLE_PLUGIN::loadTextAttributes(), DIALOG_LABEL_PROPERTIES::OnAddField(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseHarnessPort(), SCH_ALTIUM_PLUGIN::ParseLabel(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetFont()

void EDA_TEXT::SetFont ( KIFONT::FONT * aFont )

◆ SetHorizJustify()

void EDA_TEXT::SetHorizJustify ( GR_TEXT_H_ALIGN_T aType )

Definition at line 240 of file eda_text.cpp.

{
 m_attributes.m_Halign = aType;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References ClearRenderCache(), m_attributes, m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_Halign.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), GRAPHICS_IMPORTER_PCBNEW::AddText(), SCH_ALTIUM_PLUGIN::AddTextBox(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), eagleToKicadAlignment(), EDA_TEXT_DESC::EDA_TEXT_DESC(), FP_TEXTBOX::FP_TEXTBOX(), ALTIUM_PCB::HelperParseDimensions6Radial(), AUTOPLACER::justifyField(), FP_TEXT::KeepUpright(), LIB_TEXTBOX::LIB_TEXTBOX(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), FABMASTER::loadFootprints(), SCH_EAGLE_PLUGIN::loadFrame(), FABMASTER::loadGraphics(), LEGACY_PLUGIN::loadMODULE_TEXT(), FABMASTER::loadOutline(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_LEGACY_PLUGIN::loadSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), SCH_EDIT_TOOL::Mirror(), FP_TEXT::Mirror(), PCB_TEXT::Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_TEXTBOX::MirrorHorizontally(), SCH_TEXTBOX::MirrorHorizontally(), LIB_TEXT::MirrorVertical(), LIB_TEXTBOX::MirrorVertically(), SCH_TEXTBOX::MirrorVertically(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseHarnessPort(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), PCB_TEXTBOX::PCB_TEXTBOX(), LIB_TEXT::Rotate(), SCH_TEXTBOX::SCH_TEXTBOX(), PCAD2KICAD::SetTextJustify(), SCH_TEXT::SetTextSpinStyle(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_FIELD_PROPERTIES::UpdateField(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ SetHyperlink()

void EDA_TEXT::SetHyperlink ( wxString aLink )

inline

Definition at line 335 of file eda_text.h.

335{ m_hyperlink = aLink; }

References m_hyperlink.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), EDA_TEXT_DESC::EDA_TEXT_DESC(), SCH_SEXPR_PARSER::parseEDA_TEXT(), and DIALOG_TEXT_PROPERTIES::TransferDataFromWindow().

◆ SetItalic()

void EDA_TEXT::SetItalic ( bool aItalic )

Definition at line 201 of file eda_text.cpp.

{
 m_attributes.m_Italic = aItalic;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References ClearRenderCache(), m_attributes, m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_Italic.

Referenced by SCH_ALTIUM_PLUGIN::AddTextBox(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCB_TEXT::AddToBoard(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewText(), DRAWING_TOOL::DrawDimension(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT_DESC::EDA_TEXT_DESC(), ALTIUM_PCB::HelperParseDimensions6Linear(), ALTIUM_PCB::HelperParseDimensions6Radial(), SCH_LEGACY_PLUGIN_CACHE::loadField(), FABMASTER::loadFootprints(), FABMASTER::loadGraphics(), LEGACY_PLUGIN::loadMODULE_TEXT(), FABMASTER::loadOutline(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_LEGACY_PLUGIN::loadSymbol(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), DIALOG_LABEL_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseHarnessPort(), SCH_ALTIUM_PLUGIN::ParseLabel(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetKeepUpright()

void EDA_TEXT::SetKeepUpright ( bool aKeepUpright )

Definition at line 256 of file eda_text.cpp.

{
 m_attributes.m_KeepUpright = aKeepUpright;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References ClearRenderCache(), m_attributes, m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_KeepUpright.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), ALTIUM_PCB::ConvertTexts6ToFootprintItemOnLayer(), PCB_BASE_FRAME::CreateNewFootprint(), FP_TEXT::FP_TEXT(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ SetLineSpacing()

void EDA_TEXT::SetLineSpacing ( double aLineSpacing )

Definition at line 339 of file eda_text.cpp.

{
 m_attributes.m_LineSpacing = aLineSpacing;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References ClearRenderCache(), m_attributes, m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_LineSpacing.

Referenced by PCB_PARSER::parseEDA_TEXT(), and SCH_SEXPR_PARSER::parseEDA_TEXT().

◆ SetMirrored()

void EDA_TEXT::SetMirrored ( bool isMirrored )

Definition at line 224 of file eda_text.cpp.

{
 m_attributes.m_Mirrored = isMirrored;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References ClearRenderCache(), m_attributes, m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_Mirrored.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCB_TEXT::AddToBoard(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), EDA_TEXT_DESC::EDA_TEXT_DESC(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), PCB_TEXT::Flip(), PCB_TEXTBOX::Flip(), FP_TEXT::FP_TEXT(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), PCB_DIMENSION_BASE::Mirror(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), PCB_PARSER::parseEDA_TEXT(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow().

◆ SetMultilineAllowed()

void EDA_TEXT::SetMultilineAllowed ( bool aAllow )

Parameters

aAllow true if ok to use multiline option, false if ok to use only single line text. (Single line is faster in calculations than multiline.)

Definition at line 232 of file eda_text.cpp.

{
 m_attributes.m_Multiline = aAllow;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References ClearRenderCache(), m_attributes, m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_Multiline.

Referenced by FP_TEXTBOX::FP_TEXTBOX(), LIB_TEXTBOX::LIB_TEXTBOX(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), PCB_TEXT::PCB_TEXT(), PCB_TEXTBOX::PCB_TEXTBOX(), SCH_LABEL_BASE::SCH_LABEL_BASE(), SCH_TEXT::SCH_TEXT(), and SCH_TEXTBOX::SCH_TEXTBOX().

◆ SetText()

void EDA_TEXT::SetText ( const wxString & aText )

virtual

Definition at line 163 of file eda_text.cpp.

{
 m_text = aText;
 
 cacheShownText();
 
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References cacheShownText(), ClearRenderCache(), m_bounding_box_cache_valid, and m_text.

◆ SetTextAngle()

void EDA_TEXT::SetTextAngle ( const EDA_ANGLE & aAngle )

virtual

Definition at line 193 of file eda_text.cpp.

{
 m_attributes.m_Angle = aAngle;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References ClearRenderCache(), TEXT_ATTRIBUTES::m_Angle, m_attributes, and m_bounding_box_cache_valid.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), GRAPHICS_IMPORTER_PCBNEW::AddText(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCB_TEXT::AddToBoard(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToBoardItemOnLayer(), ALTIUM_PCB::ConvertTexts6ToFootprintItemOnLayer(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), eagleToKicadAlignment(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), PCB_TEXT::Flip(), PCB_TEXTBOX::Flip(), LIB_FIELD::HitTest(), LIB_TEXT::HitTest(), LIB_FIELD::Init(), FP_TEXT::KeepUpright(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_LEGACY_PLUGIN::loadSymbol(), PCB_DIMENSION_BASE::Mirror(), DIALOG_LABEL_PROPERTIES::OnAddField(), DIALOG_SHEET_PROPERTIES::OnAddField(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_EDIT_TOOL::Rotate(), SCH_TEXTBOX::Rotate(), LIB_TEXTBOX::Rotate(), LIB_FIELD::Rotate(), LIB_TEXT::Rotate(), FP_TEXT::Rotate(), FP_TEXTBOX::Rotate(), PCB_DIMENSION_BASE::Rotate(), PCB_TEXT::Rotate(), PCB_TEXTBOX::Rotate(), SCH_TEXTBOX::Rotate90(), SetTextAngleDegrees(), SCH_TEXT::SetTextSpinStyle(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), PCB_DIM_ALIGNED::updateText(), PCB_DIM_ORTHOGONAL::updateText(), PCB_DIM_RADIAL::updateText(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetTextAngleDegrees()

void EDA_TEXT::SetTextAngleDegrees ( double aOrientation )

inline

Definition at line 123 of file eda_text.h.

 {
 SetTextAngle( EDA_ANGLE( aOrientation, DEGREES_T ) );
 }

References DEGREES_T, and SetTextAngle().

Referenced by EDA_TEXT_DESC::EDA_TEXT_DESC().

◆ SetTextColor()

void EDA_TEXT::SetTextColor ( const COLOR4D & aColor )

inline

Definition at line 204 of file eda_text.h.

204{ m_attributes.m_Color = aColor; }

References m_attributes, and TEXT_ATTRIBUTES::m_Color.

Referenced by DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseHarnessPort(), SCH_ALTIUM_PLUGIN::ParseHarnessType(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetTextHeight()

void EDA_TEXT::SetTextHeight ( int aHeight )

Definition at line 363 of file eda_text.cpp.

{
 m_attributes.m_Size.y = aHeight;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References ClearRenderCache(), m_attributes, m_bounding_box_cache_valid, TEXT_ATTRIBUTES::m_Size, and VECTOR2< T >::y.

Referenced by GRAPHICS_IMPORTER_PCBNEW::AddText(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), EDA_TEXT_DESC::EDA_TEXT_DESC(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), FABMASTER::loadFootprints(), FABMASTER::loadGraphics(), and FABMASTER::loadOutline().

◆ SetTextPos()

void EDA_TEXT::SetTextPos ( const VECTOR2I & aPoint )

Definition at line 371 of file eda_text.cpp.

{
 Offset( VECTOR2I( aPoint.x - m_pos.x, aPoint.y - m_pos.y ) );
}

References m_pos, Offset(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), GRAPHICS_IMPORTER_PCBNEW::AddText(), PCAD2KICAD::PCB_TEXT::AddToBoard(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), CADSTAR_SCH_ARCHIVE_LOADER::applyToLibraryFieldAttribute(), LIB_FIELD::BeginEdit(), LIB_TEXT::BeginEdit(), LIB_FIELD::CalcEdit(), LIB_TEXT::CalcEdit(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), FP_TEXT::FP_TEXT(), LIB_FIELD::HitTest(), LIB_TEXT::HitTest(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), FABMASTER::loadFootprints(), FABMASTER::loadGraphics(), FABMASTER::loadOutline(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_LEGACY_PLUGIN::loadSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), PCB_DIMENSION_BASE::Mirror(), LIB_FIELD::MoveTo(), LIB_TEXT::MoveTo(), LIB_TEXT::NormalizeJustification(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), SCH_SEXPR_PARSER::parseSchText(), DRAWING_TOOL::PlaceText(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_LABEL_BASE::Rotate(), SCH_SHEET_PIN::Rotate(), SCH_TEXT::Rotate(), LIB_FIELD::Rotate(), LIB_TEXT::Rotate(), FP_TEXT::Rotate(), PCB_DIMENSION_BASE::Rotate(), PCB_TEXT::Rotate(), SCH_FIELD::SCH_FIELD(), SCH_SHEET_PIN::SCH_SHEET_PIN(), SCH_TEXT::SCH_TEXT(), FP_TEXT::SetDrawCoord(), DS_DRAW_ITEM_TEXT::SetPosition(), FP_TEXT::SetPosition(), PCB_TEXT::SetPosition(), SCH_FIELD::SetPosition(), SCH_TEXT::SetPosition(), DIALOG_LIB_FIELD_PROPERTIES::UpdateField(), SCH_SYMBOL::UpdateFields(), PCB_DIM_ALIGNED::updateText(), and PCB_DIM_ORTHOGONAL::updateText().

◆ SetTextSize()

void EDA_TEXT::SetTextSize ( const VECTOR2I & aNewSize )

Definition at line 347 of file eda_text.cpp.

{
 m_attributes.m_Size = aNewSize;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References ClearRenderCache(), m_attributes, m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_Size.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), SCH_EAGLE_PLUGIN::addImplicitConnections(), SCH_ALTIUM_PLUGIN::AddTextBox(), CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), MICROWAVE_TOOL::createBaseFootprint(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::createSheetPin(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawDimension(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), ALTIUM_PCB::HelperParseDimensions6Linear(), ALTIUM_PCB::HelperParseDimensions6Radial(), LIB_TEXT::LIB_TEXT(), LIB_TEXTBOX::LIB_TEXTBOX(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), SCH_EAGLE_PLUGIN::loadFrame(), LEGACY_PLUGIN::loadMODULE_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_LEGACY_PLUGIN::loadSheet(), SCH_LEGACY_PLUGIN::loadSymbol(), SCH_EAGLE_PLUGIN::loadTextAttributes(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), DIALOG_LIB_SYMBOL_PROPERTIES::OnAddField(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseHarnessPort(), SCH_ALTIUM_PLUGIN::ParseLabel(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BACK_ANNOTATE::processNetNameChange(), PCB_DIMENSION_BASE::SetTextSize(), PCAD2KICAD::SetTextSizeFromStrokeFontHeight(), PCAD2KICAD::SetTextSizeFromTrueTypeFontHeight(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetTextThickness()

void EDA_TEXT::SetTextThickness ( int aWidth )

The TextThickness is that set by the user.

The EffectiveTextPenWidth also factors in bold text and thickness clamping.

Definition at line 185 of file eda_text.cpp.

{
 m_attributes.m_StrokeWidth = aWidth;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References ClearRenderCache(), m_attributes, m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_StrokeWidth.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), GRAPHICS_IMPORTER_PCBNEW::AddText(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCB_TEXT::AddToBoard(), CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), MICROWAVE_TOOL::createBaseFootprint(), PCB_BASE_FRAME::CreateNewFootprint(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawDimension(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT_DESC::EDA_TEXT_DESC(), FP_TEXT::FP_TEXT(), ALTIUM_PCB::HelperParseDimensions6Linear(), ALTIUM_PCB::HelperParseDimensions6Radial(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), FABMASTER::loadFootprints(), FABMASTER::loadGraphics(), LEGACY_PLUGIN::loadMODULE_TEXT(), FABMASTER::loadOutline(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_EAGLE_PLUGIN::loadTextAttributes(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow().

◆ SetTextWidth()

void EDA_TEXT::SetTextWidth ( int aWidth )

Definition at line 355 of file eda_text.cpp.

{
 m_attributes.m_Size.x = aWidth;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References ClearRenderCache(), m_attributes, m_bounding_box_cache_valid, TEXT_ATTRIBUTES::m_Size, and VECTOR2< T >::x.

Referenced by GRAPHICS_IMPORTER_PCBNEW::AddText(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), EDA_TEXT_DESC::EDA_TEXT_DESC(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), FABMASTER::loadFootprints(), FABMASTER::loadGraphics(), and FABMASTER::loadOutline().

◆ SetTextX()

void EDA_TEXT::SetTextX ( int aX )

Definition at line 377 of file eda_text.cpp.

{
 Offset( VECTOR2I( aX - m_pos.x, 0 ) );
}

References m_pos, Offset(), and VECTOR2< T >::x.

Referenced by SCH_SHEET_PIN::ConstrainOnEdge(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), PCB_TEXT::Flip(), FP_TEXT::Mirror(), PCB_TEXT::Mirror(), LIB_FIELD::MirrorHorizontal(), LIB_TEXT::MirrorHorizontal(), SCH_SHEET_PIN::MirrorHorizontally(), SCH_TEXT::MirrorHorizontally(), and SCH_SHEET_PIN::SetSide().

◆ SetTextY()

void EDA_TEXT::SetTextY ( int aY )

Definition at line 383 of file eda_text.cpp.

{
 Offset( VECTOR2I( 0, aY - m_pos.y ) );
}

References m_pos, Offset(), and VECTOR2< T >::y.

Referenced by SCH_SHEET_PIN::ConstrainOnEdge(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), PCB_TEXT::Flip(), FP_TEXT::Mirror(), PCB_TEXT::Mirror(), LIB_FIELD::MirrorVertical(), LIB_TEXT::MirrorVertical(), SCH_SHEET_PIN::MirrorVertically(), SCH_TEXT::MirrorVertically(), and SCH_SHEET_PIN::SetSide().

◆ SetupRenderCache()

void EDA_TEXT::SetupRenderCache	(	const wxString &	aResolvedText,
		const EDA_ANGLE &	aAngle
	)

Definition at line 483 of file eda_text.cpp.

{
 m_render_cache_text = aResolvedText;
 m_render_cache_angle = aAngle;
 m_render_cache.clear();
}

References m_render_cache, m_render_cache_angle, and m_render_cache_text.

◆ SetVertJustify()

void EDA_TEXT::SetVertJustify ( GR_TEXT_V_ALIGN_T aType )

Definition at line 248 of file eda_text.cpp.

{
 m_attributes.m_Valign = aType;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References ClearRenderCache(), m_attributes, m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_Valign.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), GRAPHICS_IMPORTER_PCBNEW::AddText(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), eagleToKicadAlignment(), EDA_TEXT_DESC::EDA_TEXT_DESC(), FP_TEXTBOX::FP_TEXTBOX(), ALTIUM_PCB::HelperParseDimensions6Radial(), AUTOPLACER::justifyField(), LIB_TEXTBOX::LIB_TEXTBOX(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), SCH_EAGLE_PLUGIN::loadFrame(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_LEGACY_PLUGIN::loadSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), SCH_EDIT_TOOL::Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_TEXT::MirrorVertical(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_TEXTBOX::PCB_TEXTBOX(), LIB_TEXT::Rotate(), SCH_GLOBALLABEL::SCH_GLOBALLABEL(), SCH_TEXTBOX::SCH_TEXTBOX(), PCAD2KICAD::SetTextJustify(), SCH_TEXT::SetTextSpinStyle(), SCH_GLOBALLABEL::SetTextSpinStyle(), SCH_HIERLABEL::SetTextSpinStyle(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_FIELD_PROPERTIES::UpdateField(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ SetVisible()

void EDA_TEXT::SetVisible ( bool aVisible )

virtual

Reimplemented in PCB_TEXT, and PCB_TEXTBOX.

Definition at line 217 of file eda_text.cpp.

{
 m_attributes.m_Visible = aVisible;
 ClearRenderCache();
}

References ClearRenderCache(), m_attributes, and TEXT_ATTRIBUTES::m_Visible.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), SCH_EDITOR_CONTROL::AssignFootprints(), SCH_EDIT_TOOL::ChangeTextType(), PCB_BASE_FRAME::CreateNewFootprint(), EDA_TEXT_DESC::EDA_TEXT_DESC(), LIB_FIELD::Init(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), EAGLE_PLUGIN::loadElements(), SCH_LEGACY_PLUGIN_CACHE::loadField(), FABMASTER::loadFootprints(), SCH_EAGLE_PLUGIN::loadInstance(), SCH_EAGLE_PLUGIN::loadLibrary(), LEGACY_PLUGIN::loadMODULE_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_LEGACY_PLUGIN_CACHE::LoadPart(), EAGLE_PLUGIN::loadPlain(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_LEGACY_PLUGIN::loadSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymbolFieldAttribute(), SCH_DATABASE_PLUGIN::loadSymbolFromRow(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), DIALOG_LABEL_PROPERTIES::OnAddField(), ALTIUM_PCB::ParseComponents6Data(), SCH_ALTIUM_PLUGIN::ParseDesignator(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseFileName(), SCH_ALTIUM_PLUGIN::ParseHarnessType(), SCH_ALTIUM_PLUGIN::ParseParameter(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_SEXPR_PARSER::parseSchText(), SCH_ALTIUM_PLUGIN::ParseSheetName(), SCH_EDITOR_CONTROL::processCmpToFootprintLinkFile(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_SEXPR_PLUGIN_CACHE::saveDcmInfoAsFields(), SCH_FIELD::SCH_FIELD(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), SCH_SHEET_PATH::UpdateAllScreenReferences(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SwapAttributes()

void EDA_TEXT::SwapAttributes ( EDA_TEXT & aTradingPartner )

Swap the text attributes of the two involved instances.

Definition at line 284 of file eda_text.cpp.

{
 std::swap( m_attributes, aTradingPartner.m_attributes );
 std::swap( m_pos, aTradingPartner.m_pos );
 
 ClearRenderCache();
 aTradingPartner.ClearRenderCache();
 
 m_bounding_box_cache_valid = false;
 aTradingPartner.m_bounding_box_cache_valid = false;
}

References ClearRenderCache(), m_attributes, m_bounding_box_cache_valid, and m_pos.

Referenced by SCH_FIELD::SwapData(), SCH_TEXT::SwapData(), and SCH_TEXTBOX::SwapData().

◆ SwapText()

void EDA_TEXT::SwapText ( EDA_TEXT & aTradingPartner )

Definition at line 273 of file eda_text.cpp.

{
 std::swap( m_text, aTradingPartner.m_text );
 std::swap( m_shown_text, aTradingPartner.m_shown_text );
 std::swap( m_shown_text_has_text_var_refs, aTradingPartner.m_shown_text_has_text_var_refs );
 
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

References ClearRenderCache(), m_bounding_box_cache_valid, m_shown_text, m_shown_text_has_text_var_refs, and m_text.

Referenced by SCH_FIELD::SwapData(), SCH_TEXT::SwapData(), and SCH_TEXTBOX::SwapData().

◆ TextHitTest() [1/2]

bool EDA_TEXT::TextHitTest	(	const BOX2I &	aRect,
		bool	aContains,
		int	aAccuracy = `0`
	)		const

virtual

Test if object bounding box is contained within or intersects aRect.

Parameters

aRect	Rect to test against.
aContains	Test for containment instead of intersection if true.
aAccuracy	Amount to inflate the bounding box.

Returns: true if a hit, else false.

Reimplemented in FP_TEXT, and PCB_TEXT.

Definition at line 635 of file eda_text.cpp.

{
 BOX2I rect = aRect;
 
 rect.Inflate( aAccuracy );
 
 if( aContains )
 return rect.Contains( GetTextBox() );
 
 return rect.Intersects( GetTextBox(), GetDrawRotation() );
}

References BOX2< Vec >::Contains(), GetDrawRotation(), GetTextBox(), BOX2< Vec >::Inflate(), and BOX2< Vec >::Intersects().

◆ TextHitTest() [2/2]

bool EDA_TEXT::TextHitTest	(	const VECTOR2I &	aPoint,
		int	aAccuracy = `0`
	)		const

virtual

Test if aPoint is within the bounds of this object.

Parameters

aPoint	A VECTOR2I to test.
aAccuracy	Amount to inflate the bounding box.

Returns: true if a hit, else false.

Reimplemented in FP_TEXT, and PCB_TEXT.

Definition at line 623 of file eda_text.cpp.

{
 BOX2I rect = GetTextBox();
 VECTOR2I location = aPoint;
 
 rect.Inflate( aAccuracy );
 RotatePoint( location, GetDrawPos(), -GetDrawRotation() );
 
 return rect.Contains( location );
}

References BOX2< Vec >::Contains(), GetDrawPos(), GetDrawRotation(), GetTextBox(), BOX2< Vec >::Inflate(), and RotatePoint().

Referenced by LIB_FIELD::HitTest(), LIB_TEXT::HitTest(), DS_DRAW_ITEM_TEXT::HitTest(), and PCB_TEXT::TextHitTest().

◆ TransformBoundingBoxToPolygon()

void EDA_TEXT::TransformBoundingBoxToPolygon	(	SHAPE_POLY_SET *	aBuffer,
		int	aClearance
	)		const

Convert the text bounding box to a rectangular polygon depending on the text orientation, the bounding box is not always horizontal or vertical.

Used in filling zones calculations Circles and arcs are approximated by segments

Parameters

aBuffer	a buffer to store the polygon.
aClearance	the clearance around the text bounding box to the real clearance value (usually near from 1.0).

Definition at line 945 of file eda_text.cpp.

{
 if( GetText().Length() == 0 )
 return;
 
 VECTOR2I corners[4]; // Buffer of polygon corners
 BOX2I rect = GetTextBox();
 
 // TrueType bounding boxes aren't guaranteed to include all descenders, diacriticals, etc.
 // Since we use this for zone knockouts and DRC, we need something more accurate.
 if( getDrawFont()->IsOutline() )
 rect = GetEffectiveTextShape( false, false )->BBox();
 
 rect.Inflate( aClearance );
 
 corners[0].x = rect.GetOrigin().x;
 corners[0].y = rect.GetOrigin().y;
 corners[1].y = corners[0].y;
 corners[1].x = rect.GetRight();
 corners[2].x = corners[1].x;
 corners[2].y = rect.GetBottom();
 corners[3].y = corners[2].y;
 corners[3].x = corners[0].x;
 
 aBuffer->NewOutline();
 
 for( VECTOR2I& corner : corners )
 {
 RotatePoint( corner, GetDrawPos(), GetDrawRotation() );
 
 aBuffer->Append( corner.x, corner.y );
 }
}

References SHAPE_POLY_SET::Append(), BOX2< Vec >::GetBottom(), getDrawFont(), GetDrawPos(), GetDrawRotation(), GetEffectiveTextShape(), BOX2< Vec >::GetOrigin(), BOX2< Vec >::GetRight(), GetText(), GetTextBox(), BOX2< Vec >::Inflate(), SHAPE_POLY_SET::NewOutline(), RotatePoint(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BOARD_ADAPTER::addText(), KIGFX::PCB_PAINTER::draw(), FP_TEXT::GetEffectiveShape(), PCB_TEXT::GetEffectiveShape(), BRDITEMS_PLOTTER::PlotPcbText(), PNS_KICAD_IFACE_BASE::syncTextItem(), PCB_TEXT::TextHitTest(), FP_TEXT::TransformShapeToPolygon(), and PCB_TEXT::TransformShapeToPolygon().

◆ ValidateHyperlink()

bool EDA_TEXT::ValidateHyperlink ( const wxString & aURL )

static

Check if aURL is a valid hyperlink.

Parameters

aURL	String to validate

Returns: true if aURL is a valid hyperlink

Definition at line 980 of file eda_text.cpp.

{
 if( aURL.IsEmpty() || IsGotoPageHref( aURL ) )
 return true;
 
 // Limit valid urls to file, http and https for now. Note wxURL doesn't support https
 wxURI uri;
 
 if( uri.Create( aURL ) && uri.HasScheme() )
 {
 const wxString& scheme = uri.GetScheme();
 return scheme == wxT( "file" ) || scheme == wxT( "http" ) || scheme == wxT( "https" );
 }
 
 return false;
}

References IsGotoPageHref().

Referenced by SCH_SEXPR_PARSER::parseEDA_TEXT(), and DIALOG_TEXT_PROPERTIES::TransferDataFromWindow().

Member Data Documentation

◆ m_attributes

TEXT_ATTRIBUTES EDA_TEXT::m_attributes

private

◆ m_bounding_box_cache

BOX2I EDA_TEXT::m_bounding_box_cache

mutableprivate

Definition at line 404 of file eda_text.h.

Referenced by EDA_TEXT(), GetTextBox(), and operator=().

◆ m_bounding_box_cache_inverted

bool EDA_TEXT::m_bounding_box_cache_inverted

mutableprivate

Definition at line 403 of file eda_text.h.

Referenced by EDA_TEXT(), and GetTextBox().

◆ m_bounding_box_cache_line

int EDA_TEXT::m_bounding_box_cache_line

mutableprivate

Definition at line 402 of file eda_text.h.

Referenced by EDA_TEXT(), and GetTextBox().

◆ m_bounding_box_cache_pos

VECTOR2I EDA_TEXT::m_bounding_box_cache_pos

mutableprivate

Definition at line 401 of file eda_text.h.

Referenced by GetTextBox().

◆ m_bounding_box_cache_valid

bool EDA_TEXT::m_bounding_box_cache_valid

mutableprivate

Definition at line 400 of file eda_text.h.

Referenced by cacheShownText(), ClearBoundingBoxCache(), CopyText(), EDA_TEXT(), Empty(), GetTextBox(), Offset(), operator=(), Replace(), SetAttributes(), SetBold(), SetFont(), SetHorizJustify(), SetItalic(), SetKeepUpright(), SetLineSpacing(), SetMirrored(), SetMultilineAllowed(), SetText(), SetTextAngle(), SetTextHeight(), SetTextSize(), SetTextThickness(), SetTextWidth(), SetVertJustify(), SwapAttributes(), and SwapText().

◆ m_hyperlink

wxString EDA_TEXT::m_hyperlink

protected

A hyperlink URL.

If empty, this text object is not a hyperlink.

Definition at line 386 of file eda_text.h.

Referenced by SCH_TEXT::DoHypertextAction(), SCH_TEXTBOX::DoHypertextAction(), GetHyperlink(), HasHyperlink(), RemoveHyperlink(), and SetHyperlink().

◆ m_IuScale

std::reference_wrapper<const EDA_IU_SCALE> EDA_TEXT::m_IuScale

private

Definition at line 393 of file eda_text.h.

Referenced by EDA_TEXT(), and Format().

◆ m_pos

VECTOR2I EDA_TEXT::m_pos

private

Definition at line 407 of file eda_text.h.

Referenced by Compare(), EDA_TEXT(), GetTextPos(), Offset(), operator=(), SetAttributes(), SetTextPos(), SetTextX(), SetTextY(), and SwapAttributes().

◆ m_render_cache

std::vector<std::unique_ptr<KIFONT::GLYPH> > EDA_TEXT::m_render_cache

mutableprivate

Definition at line 398 of file eda_text.h.

Referenced by AddRenderCacheGlyph(), ClearRenderCache(), EDA_TEXT(), GetRenderCache(), Offset(), operator=(), and SetupRenderCache().

◆ m_render_cache_angle

EDA_ANGLE EDA_TEXT::m_render_cache_angle

mutableprivate

Definition at line 396 of file eda_text.h.

Referenced by EDA_TEXT(), GetRenderCache(), operator=(), and SetupRenderCache().

◆ m_render_cache_offset

VECTOR2I EDA_TEXT::m_render_cache_offset

mutableprivate

Definition at line 397 of file eda_text.h.

Referenced by GetRenderCache().

◆ m_render_cache_text

wxString EDA_TEXT::m_render_cache_text

mutableprivate

Definition at line 395 of file eda_text.h.

Referenced by EDA_TEXT(), GetRenderCache(), operator=(), and SetupRenderCache().

◆ m_shown_text

wxString EDA_TEXT::m_shown_text

private

Definition at line 390 of file eda_text.h.

Referenced by cacheShownText(), CopyText(), EDA_TEXT(), GetShownText(), operator=(), and SwapText().

◆ m_shown_text_has_text_var_refs

bool EDA_TEXT::m_shown_text_has_text_var_refs

private

Definition at line 391 of file eda_text.h.

Referenced by cacheShownText(), CopyText(), EDA_TEXT(), HasTextVars(), operator=(), and SwapText().

◆ m_text

wxString EDA_TEXT::m_text

private

Definition at line 389 of file eda_text.h.

Referenced by cacheShownText(), Compare(), CopyText(), EDA_TEXT(), Empty(), GetText(), operator=(), Replace(), SetText(), and SwapText().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EDA_TEXT() [1/2]

◆ EDA_TEXT() [2/2]

◆ ~EDA_TEXT()

Member Function Documentation

◆ AddRenderCacheGlyph()

◆ cacheShownText()

◆ ClearBoundingBoxCache()

◆ ClearRenderCache()

◆ Compare()

◆ CopyText()

◆ Empty()

◆ Format()

◆ GetAttributes()

◆ getDrawFont()

◆ GetDrawPos()

◆ GetDrawRotation()

◆ GetEffectiveTextPenWidth()

◆ GetEffectiveTextShape()

◆ GetFont()

◆ GetFontName()

◆ GetHorizJustify()

◆ GetHyperlink()

◆ GetInterline()

◆ GetLinePositions()

◆ GetLineSpacing()

◆ GetRenderCache()

◆ GetShownText()

◆ GetText()

◆ GetTextAngle()

◆ GetTextAngleDegrees()

◆ GetTextBox()

◆ GetTextColor()

◆ GetTextHeight()

◆ GetTextPos()

◆ GetTextSize()

◆ GetTextStyleName()

◆ GetTextThickness()

◆ GetTextWidth()

◆ GetVertJustify()

◆ GotoPageHref()

◆ HasHyperlink()

◆ HasTextVars()

◆ IsBold()

◆ IsDefaultFormatting()

◆ IsGotoPageHref()

◆ IsItalic()

◆ IsKeepUpright()

◆ IsMirrored()

◆ IsMultilineAllowed()

◆ IsVisible()

◆ MapHorizJustify()

◆ MapVertJustify()

◆ Offset()

◆ operator=()

◆ Print()

◆ printOneLineOfText()

◆ RemoveHyperlink()

◆ Replace()

◆ SetAttributes() [1/2]

◆ SetAttributes() [2/2]

◆ SetBold()

◆ SetFont()

◆ SetHorizJustify()

◆ SetHyperlink()

◆ SetItalic()

◆ SetKeepUpright()

◆ SetLineSpacing()

◆ SetMirrored()

◆ SetMultilineAllowed()

◆ SetText()

◆ SetTextAngle()

◆ SetTextAngleDegrees()

◆ SetTextColor()