This is the text_style. This class gathers information about text style. More...

Public Types
enum	FontStyleEnum { StyleRegular = 0, StyleBold, StyleItalic, StyleBoldItalic }

enum	TextAttributeEnum { AttributeNone = 0, AttributeUnderline = 1, AttributeStrikethrough = 2, AttributeOverline = 4, AttributeSuperscript = 8, AttributeSubscript = 16 }

enum	TextJustificationEnum { JustificationLeft = 0, JustificationCenter, JustificationRight, JustificationNone }

Public Member Functions
TextAttributeEnum &	Attributes ()
	Retrieves the text attribute - get/set -. More...

const TextAttributeEnum &	Attributes () const
	Retrieves the text attribute - read only -. More...

Dtk_Double64 &	CharHeight ()
	Retrieves the char height - get/set -. More...

const Dtk_Double64 &	CharHeight () const
	Retrieves the char height - Read Only -. More...

Dtk_Double64 &	CharSpacing ()
	Retrieves the char spacing - get/set -. More...

const Dtk_Double64 &	CharSpacing () const
	Retrieves the char spacing - read only -. More...

Dtk_Double64 &	CharWidth ()
	Retrieves the char width - get/set -. More...

const Dtk_Double64 &	CharWidth () const
	Retrieves the char width - read only -. More...

	Dtk_TextStyle ()
	Default constructor. More...

Dtk_Font &	Font ()
	Retrieves the font - get/set -. More...

const Dtk_Font &	Font () const
	Retrieves the font - read only -. More...

FontStyleEnum &	FontStyle ()
	Retrieves the font style - get/set -. More...

const FontStyleEnum &	FontStyle () const
	Retrieves the font style - read only -. More...

TextJustificationEnum &	Justification ()
	Retrieves the text justification - get/set -. More...

const TextJustificationEnum &	Justification () const
	Retrieves the text justification - read only -. More...

Dtk_Double64 &	LineSpacing ()
	Retrieves the line spacing - get/set -. More...

const Dtk_Double64 &	LineSpacing () const
	Retrieves the line spacing - read only -. More...

Dtk_Double64 &	Pitch ()
	Retrieves the text pitch - get/set -. More...

const Dtk_Double64 &	Pitch () const
	Retrieves the text pitch - read only -. More...

Dtk_Double64 &	Ratio ()
	Retrieves the text ratio - get/set -. More...

const Dtk_Double64 &	Ratio () const
	Retrieves the text ratio - Read Only -. More...

Dtk_Double64 &	Slant ()
	Retrieves the text slant - get/set -. More...

const Dtk_Double64 &	Slant () const
	Retrieves the text slant - read only -. More...

	~Dtk_TextStyle ()
	Destructor. More...

Static Public Member Functions
static Dtk_string	FontStyleEnumToString (const FontStyleEnum &inEnum)

static Dtk_string	TextJustificationEnumToString (const TextJustificationEnum &inEnum)

Protected Attributes
TextAttributeEnum	_attributes
	Text Attribute (Underline, etc...) More...

Dtk_Double64	_char_height
	Height of each char in the text. More...

Dtk_Double64	_char_spacing
	Spacing between two chars. More...

Dtk_Double64	_char_width
	Width of each char in the text. More...

Dtk_Font	_font
	Font informations. More...

FontStyleEnum	_font_style
	Font Style type (Regular, Italic, etc...) More...

TextJustificationEnum	_justification
	Text Justification (Left, etc...) More...

Dtk_Double64	_line_spacing
	Spacing between two lines in the text - for multiline texts for example -. More...

Dtk_Double64	_pitch
	Char Pitch. More...

Dtk_Double64	_ratio
	Char Ratio. It represents the stretch of the width of the text. Default value is 1. More...

Dtk_Double64	_slant
	Char Slant (PI/2 by default) More...

Detailed Description

This is the text_style. This class gathers information about text style.

Member Enumeration Documentation

◆ FontStyleEnum

enum Dtk_TextStyle::FontStyleEnum

Enumerator
StyleRegular
StyleBold
StyleItalic
StyleBoldItalic

                         {
           //! \image html FontStyleRegular.png
           StyleRegular = 0,
           //! \image html FontStyleBold.png
           StyleBold,
           //! \image html FontStyleItalic.png
           StyleItalic,
           //! \image html FontStyleBoldItalic.png
           StyleBoldItalic
      };

◆ TextAttributeEnum

enum Dtk_TextStyle::TextAttributeEnum

Enumerator
AttributeNone
AttributeUnderline
AttributeStrikethrough
AttributeOverline
AttributeSuperscript
AttributeSubscript

                             {
           //! \image html TextAttributeNone.png
           AttributeNone = 0,
           //! \image html TextAttributeUnderline.png
           AttributeUnderline = 1,
           //! \image html TextAttributeStrikethrough.png
           AttributeStrikethrough = 2,
           //! \image html TextAttributeOverline.png
           AttributeOverline = 4,
           //! \image html TextAttributeSuperscript.png
           AttributeSuperscript = 8,
           //! \image html TextAttributeSubscript.png
           AttributeSubscript = 16
      };

◆ TextJustificationEnum

enum Dtk_TextStyle::TextJustificationEnum

Enumerator
JustificationLeft
JustificationCenter
JustificationRight
JustificationNone

                                 {
           //! \image html TextJustificationLeft.png
           JustificationLeft = 0,
           //! \image html TextJustificationCenter.png
           JustificationCenter,
           //! \image html TextJustificationRight.png
           JustificationRight,
           JustificationNone
      };

Constructor & Destructor Documentation

◆ ~Dtk_TextStyle()

Dtk_TextStyle::~Dtk_TextStyle ( )

Destructor.

◆ Dtk_TextStyle()

Dtk_TextStyle::Dtk_TextStyle ( )

Default constructor.

Member Function Documentation

◆ Attributes() [1/2]

TextAttributeEnum& Dtk_TextStyle::Attributes ( )

Retrieves the text attribute - get/set -.

Returns: The text attribute

See also: Attributes() const

◆ Attributes() [2/2]

const TextAttributeEnum& Dtk_TextStyle::Attributes ( ) const

Retrieves the text attribute - read only -.

Returns: The text attribute

See also: Attributes()

◆ CharHeight() [1/2]

Dtk_Double64& Dtk_TextStyle::CharHeight ( )

Retrieves the char height - get/set -.

Returns: The char height

See also: CharHeight() const

◆ CharHeight() [2/2]

const Dtk_Double64& Dtk_TextStyle::CharHeight ( ) const

Retrieves the char height - Read Only -.

Returns: The char height

See also: CharHeight()

◆ CharSpacing() [1/2]

Dtk_Double64& Dtk_TextStyle::CharSpacing ( )

Retrieves the char spacing - get/set -.

Returns: The char spacing

See also: CharSpacing() const

◆ CharSpacing() [2/2]

const Dtk_Double64& Dtk_TextStyle::CharSpacing ( ) const

Retrieves the char spacing - read only -.

Returns: The char spacing

See also: CharSpacing()

◆ CharWidth() [1/2]

Dtk_Double64& Dtk_TextStyle::CharWidth ( )

Retrieves the char width - get/set -.

Returns: The char width

See also: CharWidth() const

◆ CharWidth() [2/2]

const Dtk_Double64& Dtk_TextStyle::CharWidth ( ) const

Retrieves the char width - read only -.

Returns: The char width

See also: CharWidth()

◆ Font() [1/2]

Dtk_Font& Dtk_TextStyle::Font ( )

Retrieves the font - get/set -.

Returns: The font

See also: Font() const

◆ Font() [2/2]

const Dtk_Font& Dtk_TextStyle::Font ( ) const

Retrieves the font - read only -.

Returns: The font

See also: Font()

◆ FontStyle() [1/2]

FontStyleEnum& Dtk_TextStyle::FontStyle ( )

Retrieves the font style - get/set -.

Returns: The font style

See also: FontStyle() const

◆ FontStyle() [2/2]

const FontStyleEnum& Dtk_TextStyle::FontStyle ( ) const

Retrieves the font style - read only -.

Returns: The font style

See also: FontStyle()

◆ FontStyleEnumToString()

static Dtk_string Dtk_TextStyle::FontStyleEnumToString ( const FontStyleEnum & inEnum )

static

     {
         switch( inEnum )
         {
             default:
             case StyleRegular: return L"StyleRegular";
             case StyleBold: return L"StyleBold";
             case StyleItalic: return L"StyleItalic";
             case StyleBoldItalic: return L"StyleBoldItalic";
         }
     }

◆ Justification() [1/2]

TextJustificationEnum& Dtk_TextStyle::Justification ( )

Retrieves the text justification - get/set -.

Returns: The text justification

See also: Justification()

◆ Justification() [2/2]

const TextJustificationEnum& Dtk_TextStyle::Justification ( ) const

Retrieves the text justification - read only -.

Returns: The text justification

See also: Justification() const

◆ LineSpacing() [1/2]

Dtk_Double64& Dtk_TextStyle::LineSpacing ( )

Retrieves the line spacing - get/set -.

Returns: The line spacing

See also: LineSpacing() const

◆ LineSpacing() [2/2]

const Dtk_Double64& Dtk_TextStyle::LineSpacing ( ) const

Retrieves the line spacing - read only -.

Returns: The line spacing

See also: LineSpacing()

◆ Pitch() [1/2]

Dtk_Double64& Dtk_TextStyle::Pitch ( )

Retrieves the text pitch - get/set -.

Returns: The text pitch

See also: Pitch() const

◆ Pitch() [2/2]

const Dtk_Double64& Dtk_TextStyle::Pitch ( ) const

Retrieves the text pitch - read only -.

Returns: The text pitch

See also: Pitch()

◆ Ratio() [1/2]

Dtk_Double64& Dtk_TextStyle::Ratio ( )

Retrieves the text ratio - get/set -.

Returns: The text ratio

See also: Ratio() const

◆ Ratio() [2/2]

const Dtk_Double64& Dtk_TextStyle::Ratio ( ) const

Retrieves the text ratio - Read Only -.

Returns: The text ratio

See also: Ratio()

◆ Slant() [1/2]

Dtk_Double64& Dtk_TextStyle::Slant ( )

Retrieves the text slant - get/set -.

Returns: The text slant

See also: Slant() const

◆ Slant() [2/2]

const Dtk_Double64& Dtk_TextStyle::Slant ( ) const

Retrieves the text slant - read only -.

Returns: The text slant

See also: Slant()

◆ TextJustificationEnumToString()

static Dtk_string Dtk_TextStyle::TextJustificationEnumToString ( const TextJustificationEnum & inEnum )

static

     {
         switch( inEnum )
         {
             default:
             case JustificationLeft: return L"JustificationLeft";
             case JustificationCenter: return L"JustificationCenter";
             case JustificationRight: return L"JustificationRight";
             case JustificationNone: return L"JustificationNone";
         }
     }

Field Documentation

◆ _attributes

TextAttributeEnum Dtk_TextStyle::_attributes

protected

Text Attribute (Underline, etc...)

◆ _char_height

Dtk_Double64 Dtk_TextStyle::_char_height

protected

Height of each char in the text.

◆ _char_spacing

Dtk_Double64 Dtk_TextStyle::_char_spacing

protected

Spacing between two chars.

◆ _char_width

Dtk_Double64 Dtk_TextStyle::_char_width

protected

Width of each char in the text.

◆ _font

Dtk_Font Dtk_TextStyle::_font

protected

Font informations.

◆ _font_style

FontStyleEnum Dtk_TextStyle::_font_style

protected

Font Style type (Regular, Italic, etc...)

◆ _justification

TextJustificationEnum Dtk_TextStyle::_justification

protected

Text Justification (Left, etc...)

◆ _line_spacing

Dtk_Double64 Dtk_TextStyle::_line_spacing

protected

Spacing between two lines in the text - for multiline texts for example -.

◆ _pitch

Dtk_Double64 Dtk_TextStyle::_pitch

protected

Char Pitch.

◆ _ratio

Dtk_Double64 Dtk_TextStyle::_ratio

protected

Char Ratio. It represents the stretch of the width of the text. Default value is 1.

◆ _slant

Dtk_Double64 Dtk_TextStyle::_slant

protected

Char Slant (PI/2 by default)

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ FontStyleEnum

◆ TextAttributeEnum

◆ TextJustificationEnum

Constructor & Destructor Documentation

◆ ~Dtk_TextStyle()

◆ Dtk_TextStyle()

Member Function Documentation

◆ Attributes() [1/2]

◆ Attributes() [2/2]

◆ CharHeight() [1/2]

◆ CharHeight() [2/2]

◆ CharSpacing() [1/2]

◆ CharSpacing() [2/2]

◆ CharWidth() [1/2]

◆ CharWidth() [2/2]

◆ Font() [1/2]

◆ Font() [2/2]

◆ FontStyle() [1/2]

◆ FontStyle() [2/2]

◆ FontStyleEnumToString()

◆ Justification() [1/2]

◆ Justification() [2/2]

◆ LineSpacing() [1/2]

◆ LineSpacing() [2/2]

◆ Pitch() [1/2]

◆ Pitch() [2/2]

◆ Ratio() [1/2]

◆ Ratio() [2/2]

◆ Slant() [1/2]

◆ Slant() [2/2]

◆ TextJustificationEnumToString()

Field Documentation

◆ _attributes

◆ _char_height

◆ _char_spacing

◆ _char_width

◆ _font

◆ _font_style

◆ _justification

◆ _line_spacing

◆ _pitch

◆ _ratio

◆ _slant