text_attributes.h File Reference

#include <math/vector2d.h>
#include <gal/color4d.h>
#include <geometry/eda_angle.h>
#include <gal/gal.h>

Go to the source code of this file.

Classes
class	TEXT_ATTRIBUTES
struct	std::hash< TEXT_ATTRIBUTES >

Namespaces
namespace	KIFONT

Enumerations
enum	GR_TEXT_H_ALIGN_T { GR_TEXT_H_ALIGN_LEFT = -1 , GR_TEXT_H_ALIGN_CENTER = 0 , GR_TEXT_H_ALIGN_RIGHT = 1 , GR_TEXT_H_ALIGN_INDETERMINATE }
	This is API surface mapped to common.types.HorizontalAlignment. More...
enum	GR_TEXT_V_ALIGN_T { GR_TEXT_V_ALIGN_TOP = -1 , GR_TEXT_V_ALIGN_CENTER = 0 , GR_TEXT_V_ALIGN_BOTTOM = 1 , GR_TEXT_V_ALIGN_INDETERMINATE }
	This is API surface mapped to common.types.VertialAlignment. More...

Functions
constexpr GR_TEXT_H_ALIGN_T	GetFlippedAlignment (GR_TEXT_H_ALIGN_T aAlign)
	Get the reverse alignment: left-right are swapped, others are unchanged.
constexpr GR_TEXT_V_ALIGN_T	GetFlippedAlignment (GR_TEXT_V_ALIGN_T aAlign)
	Get the reverse alignment: top-bottom are swapped, others are unchanged.
constexpr GR_TEXT_H_ALIGN_T	ToHAlignment (int x)
	Convert an integral value to horizontal alignment.
GAL_API std::ostream &	operator<< (std::ostream &aStream, const TEXT_ATTRIBUTES &aAttributes)

Enumeration Type Documentation

GR_TEXT_H_ALIGN_T

enum GR_TEXT_H_ALIGN_T

This is API surface mapped to common.types.HorizontalAlignment.

Enumerator
GR_TEXT_H_ALIGN_LEFT
GR_TEXT_H_ALIGN_CENTER
GR_TEXT_H_ALIGN_RIGHT
GR_TEXT_H_ALIGN_INDETERMINATE

Definition at line 42 of file text_attributes.h.

GR_TEXT_V_ALIGN_T

enum GR_TEXT_V_ALIGN_T

This is API surface mapped to common.types.VertialAlignment.

Enumerator
GR_TEXT_V_ALIGN_TOP
GR_TEXT_V_ALIGN_CENTER
GR_TEXT_V_ALIGN_BOTTOM
GR_TEXT_V_ALIGN_INDETERMINATE

Definition at line 51 of file text_attributes.h.

Function Documentation

GetFlippedAlignment() [1/2]

constexpr GR_TEXT_H_ALIGN_T GetFlippedAlignment ( GR_TEXT_H_ALIGN_T  aAlign )

constexpr

Get the reverse alignment: left-right are swapped, others are unchanged.

Definition at line 63 of file text_attributes.h.

References GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_INDETERMINATE, GR_TEXT_H_ALIGN_LEFT, and GR_TEXT_H_ALIGN_RIGHT.

Referenced by AUTOPLACER::justifyField(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), and PIN_LAYOUT_CACHE::transformTextForPin().

GetFlippedAlignment() [2/2]

constexpr GR_TEXT_V_ALIGN_T GetFlippedAlignment ( GR_TEXT_V_ALIGN_T  aAlign )

constexpr

Get the reverse alignment: top-bottom are swapped, others are unchanged.

Definition at line 83 of file text_attributes.h.

References GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_INDETERMINATE, and GR_TEXT_V_ALIGN_TOP.

operator<<()

GAL_API std::ostream & operator<<	(	std::ostream &	aStream,
		const TEXT_ATTRIBUTES &	aAttributes
	)

Definition at line 105 of file text_attributes.cpp.

References TEXT_ATTRIBUTES::m_Angle, TEXT_ATTRIBUTES::m_Bold, TEXT_ATTRIBUTES::m_Color, TEXT_ATTRIBUTES::m_Font, TEXT_ATTRIBUTES::m_Halign, TEXT_ATTRIBUTES::m_Italic, TEXT_ATTRIBUTES::m_KeepUpright, TEXT_ATTRIBUTES::m_LineSpacing, TEXT_ATTRIBUTES::m_Mirrored, TEXT_ATTRIBUTES::m_Multiline, TEXT_ATTRIBUTES::m_Size, TEXT_ATTRIBUTES::m_StrokeWidth, TEXT_ATTRIBUTES::m_Underlined, TEXT_ATTRIBUTES::m_Valign, and operator<<().

ToHAlignment()

constexpr GR_TEXT_H_ALIGN_T ToHAlignment ( int  x )

constexpr

Convert an integral value to horizontal alignment.

• x < 0: Left align
• x == 0: Center
• x > 0: Right align

Definition at line 106 of file text_attributes.h.

References GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_LEFT, and GR_TEXT_H_ALIGN_RIGHT.

Referenced by AUTOPLACER::justifyField().