#include <eda_item.h>
#include <font/text_attributes.h>

Namespaces
namespace	KIGFX
	The Cairo implementation of the graphics abstraction layer.

Macros
#define	MIN_TEXT_SIZE 5
	Minimum dimension in pixel for drawing/no drawing a text used in Pcbnew to decide to draw (or not) some texts ( like net names on pads/tracks ). More...

#define	MIN_DRAWABLE_TEXT_SIZE 3

Functions
int	Clamp_Text_PenSize (int aPenSize, int aSize, bool aStrict=false)
	Pen width should not allow characters to become cluttered up in their own fatness. More...

float	Clamp_Text_PenSize (float aPenSize, int aSize, bool aStrict=false)

int	Clamp_Text_PenSize (int aPenSize, const VECTOR2I &aSize, bool aStrict=false)

int	GetPenSizeForBold (int aTextSize)

int	GetPenSizeForBold (const wxSize &aTextSize)

int	GetPenSizeForDemiBold (int aTextSize)

int	GetPenSizeForDemiBold (const wxSize &aTextSize)

int	GetPenSizeForNormal (int aTextSize)

int	GetPenSizeForNormal (const wxSize &aTextSize)

void	InferBold (TEXT_ATTRIBUTES *aAttrs)

int	GetKnockoutTextMargin (const VECTOR2I &aSize, int aThickness)
	Returns the margin for knocking out text. More...

int	GraphicTextWidth (const wxString &aText, KIFONT::FONT *aFont, const VECTOR2I &aSize, int aThickness, bool aBold, bool aItalic)
	The full X size is GraphicTextWidth + the thickness of graphic lines. More...

void	GRPrintText (wxDC aDC, const VECTOR2I &aPos, const KIGFX::COLOR4D &aColor, const wxString &aText, const EDA_ANGLE &aOrient, const VECTOR2I &aSize, enum GR_TEXT_H_ALIGN_T aH_justify, enum GR_TEXT_V_ALIGN_T aV_justify, int aWidth, bool aItalic, bool aBold, KIFONT::FONT aFont)
	Print a graphic text through wxDC. More...

Macro Definition Documentation

◆ MIN_DRAWABLE_TEXT_SIZE

#define MIN_DRAWABLE_TEXT_SIZE 3

Definition at line 48 of file gr_text.h.

◆ MIN_TEXT_SIZE

#define MIN_TEXT_SIZE 5

Minimum dimension in pixel for drawing/no drawing a text used in Pcbnew to decide to draw (or not) some texts ( like net names on pads/tracks ).

When a text height is smaller than MIN_TEXT_SIZE, it is not drawn by Pcbnew.

Definition at line 42 of file gr_text.h.

Function Documentation

◆ Clamp_Text_PenSize() [1/3]

float Clamp_Text_PenSize	(	float	aPenSize,
		int	aSize,
		bool	aStrict = `false`
	)

Definition at line 96 of file gr_text.cpp.

References scale.

◆ Clamp_Text_PenSize() [2/3]

int Clamp_Text_PenSize	(	int	aPenSize,
		const VECTOR2I &	aSize,
		bool	aStrict = `false`
	)

Definition at line 105 of file gr_text.cpp.

References std::abs(), Clamp_Text_PenSize(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ Clamp_Text_PenSize() [3/3]

int Clamp_Text_PenSize	(	int	aPenSize,
		int	aSize,
		bool	aStrict
	)

Pen width should not allow characters to become cluttered up in their own fatness.

Normal text is normally around 15% the fontsize, and bold text around 20%. So we set a hard limit at 25%, and a secondary limit for non-decorative text that must be readable at small sizes at 18%.

Parameters

aPenSize	the pen size to clamp.
aSize	the char size (height or width, or its wxSize).
aBold	true if text accept bold pen size.

Returns: the max pen size allowed.

Normal text is normally around 15% the fontsize, and bold text around 20%. So we set a hard limit at 25%, and a secondary limit for non-decorative text that must be readable at small sizes at 18%.

Parameters

aPenSize	is the pen size to clamp.
aSize	is the character size (height or width).
aBold	use true if text accept bold pen size.

Returns: the max pen size allowed.

Definition at line 87 of file gr_text.cpp.

References KiROUND(), and scale.

Referenced by Clamp_Text_PenSize(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT::GetEffectiveTextPenWidth(), LIB_PIN::PlotPinTexts(), LIB_PIN::printPinTexts(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::Validate(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Validate().

◆ GetKnockoutTextMargin()

int GetKnockoutTextMargin	(	const VECTOR2I &	aSize,
		int	aThickness
	)

inline

Returns the margin for knocking out text.

Definition at line 101 of file gr_text.h.

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

Referenced by PCB_TEXT::getKnockoutMargin(), PCB_TEXT::TextHitTest(), and PCB_TEXT::TransformTextToPolySet().

◆ GetPenSizeForBold() [1/2]

int GetPenSizeForBold ( const wxSize & aTextSize )

Definition at line 52 of file gr_text.cpp.

References GetPenSizeForBold().

◆ GetPenSizeForBold() [2/2]

int GetPenSizeForBold ( int aTextSize )

Parameters

aTextSize the char size (height or width).

Returns: the "best" value for a pen size to draw/plot a bold text.

Parameters

aTextSize is the char size (height or width).

Returns: the "best" value for a pen size to draw/plot a bold text.

Definition at line 40 of file gr_text.cpp.

References KiROUND().

Referenced by EDA_TEXT::GetEffectiveTextPenWidth(), GetPenSizeForBold(), GRPrintText(), InferBold(), SCH_LEGACY_PLUGIN::loadText(), SCH_EAGLE_PLUGIN::loadTextAttributes(), DIALOG_DIMENSION_PROPERTIES::onBoldToggle(), DIALOG_TEXT_PROPERTIES::onBoldToggle(), DIALOG_TEXTBOX_PROPERTIES::onBoldToggle(), DIALOG_DIMENSION_PROPERTIES::onFontSelected(), DIALOG_TEXT_PROPERTIES::onFontSelected(), DIALOG_TEXTBOX_PROPERTIES::onFontSelected(), DIALOG_DIMENSION_PROPERTIES::onThickness(), DIALOG_TEXT_PROPERTIES::onThickness(), DIALOG_TEXTBOX_PROPERTIES::onThickness(), PLOTTER::PlotText(), DS_DATA_ITEM_TEXT::SyncDrawItems(), PLOTTER::Text(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), and DIALOG_TEXT_PROPERTIES::TransferDataFromWindow().

◆ GetPenSizeForDemiBold() [1/2]

int GetPenSizeForDemiBold ( const wxSize & aTextSize )

Definition at line 58 of file gr_text.cpp.

References GetPenSizeForDemiBold().

◆ GetPenSizeForDemiBold() [2/2]

int GetPenSizeForDemiBold ( int aTextSize )

Parameters

aTextSize the char size (height or width).

Returns: the "best" value for a pen size to draw/plot a demibold text.

Definition at line 46 of file gr_text.cpp.

References KiROUND().

Referenced by KIGFX::SCH_PAINTER::draw(), and GetPenSizeForDemiBold().

◆ GetPenSizeForNormal() [1/2]

int GetPenSizeForNormal ( const wxSize & aTextSize )

Definition at line 70 of file gr_text.cpp.

References GetPenSizeForNormal().

◆ GetPenSizeForNormal() [2/2]

int GetPenSizeForNormal ( int aTextSize )

Parameters

aTextSize = the char size (height or width).

Returns: the "best" value for a pen size to draw/plot a non-bold text.

Definition at line 64 of file gr_text.cpp.

References KiROUND().

Referenced by KIGFX::PCB_PAINTER::draw(), EDA_TEXT::GetEffectiveTextPenWidth(), GetPenSizeForNormal(), InferBold(), DIALOG_DIMENSION_PROPERTIES::onBoldToggle(), DIALOG_TEXT_PROPERTIES::onBoldToggle(), DIALOG_TEXTBOX_PROPERTIES::onBoldToggle(), DIALOG_DIMENSION_PROPERTIES::onFontSelected(), DIALOG_TEXT_PROPERTIES::onFontSelected(), DIALOG_TEXTBOX_PROPERTIES::onFontSelected(), DIALOG_DIMENSION_PROPERTIES::onThickness(), DIALOG_TEXT_PROPERTIES::onThickness(), DIALOG_TEXTBOX_PROPERTIES::onThickness(), and LIB_PIN::validateExtentsCache().

◆ GraphicTextWidth()

int GraphicTextWidth	(	const wxString &	aText,
		KIFONT::FONT *	aFont,
		const VECTOR2I &	aSize,
		int	aThickness,
		bool	aBold,
		bool	aItalic
	)

The full X size is GraphicTextWidth + the thickness of graphic lines.

Returns: the X size of the graphic text.

Definition at line 113 of file gr_text.cpp.

References KIFONT::FONT::GetFont(), KiROUND(), KIFONT::FONT::StringBoundaryLimits(), and VECTOR2< T >::x.

Referenced by SVG_PLOTTER::Text().

◆ GRPrintText()

void GRPrintText	(	wxDC *	aDC,
		const VECTOR2I &	aPos,
		const COLOR4D &	aColor,
		const wxString &	aText,
		const EDA_ANGLE &	aOrient,
		const VECTOR2I &	aSize,
		enum GR_TEXT_H_ALIGN_T	aH_justify,
		enum GR_TEXT_V_ALIGN_T	aV_justify,
		int	aWidth,
		bool	aItalic,
		bool	aBold,
		KIFONT::FONT *	aFont
	)

Print a graphic text through wxDC.

Parameters

aDC	is the current Device Context.
aPos	is the text position (according to h_justify, v_justify).
aColor	is the text color.
aText	is the text to draw.
aOrient	is the angle.
aSize	is the text size (size.x or size.y can be < 0 for mirrored texts).
aH_justify	is the horizontal justification (Left, center, right).
aV_justify	is the vertical justification (bottom, center, top).
aWidth	is the line width (pen width) (use default width if aWidth = 0). if width < 0 : draw segments in sketch mode, width = abs(width) Use a value min(aSize.x, aSize.y) / 5 for a bold text.
aItalic	is the true to simulate an italic font.
aBold	use true to use a bold font. Useful only with default width value (aWidth = 0).
aFont	is the font to use, or nullptr for the KiCad stroke font

Definition at line 141 of file gr_text.cpp.

References KIFONT::FONT::Draw(), KIFONT::FONT::GetFont(), GetPenSizeForBold(), GRClosedPoly(), GRCSegm(), GRLine(), TEXT_ATTRIBUTES::m_Angle, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SCH_FIELD::Print(), LIB_FIELD::print(), LIB_TEXT::print(), LIB_TEXTBOX::print(), EDA_TEXT::printOneLineOfText(), LIB_PIN::printPinElectricalTypeName(), and LIB_PIN::printPinTexts().

◆ InferBold()

void InferBold ( TEXT_ATTRIBUTES * aAttrs )

inline

Definition at line 88 of file gr_text.h.

References GetPenSizeForBold(), GetPenSizeForNormal(), TEXT_ATTRIBUTES::m_Bold, TEXT_ATTRIBUTES::m_Size, TEXT_ATTRIBUTES::m_StrokeWidth, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by DRAWING_TOOL::drawShape(), and DRAWING_TOOL::PlaceText().

Namespaces

Macros

Functions

Macro Definition Documentation

◆ MIN_DRAWABLE_TEXT_SIZE

◆ MIN_TEXT_SIZE

Function Documentation

◆ Clamp_Text_PenSize() [1/3]

◆ Clamp_Text_PenSize() [2/3]

◆ Clamp_Text_PenSize() [3/3]

◆ GetKnockoutTextMargin()

◆ GetPenSizeForBold() [1/2]

◆ GetPenSizeForBold() [2/2]

◆ GetPenSizeForDemiBold() [1/2]

◆ GetPenSizeForDemiBold() [2/2]

◆ GetPenSizeForNormal() [1/2]

◆ GetPenSizeForNormal() [2/2]

◆ GraphicTextWidth()

◆ GRPrintText()

◆ InferBold()