xtd - Reference Guide 0.2.0
xtd::forms::style_sheets::itext_model Class Referenceabstract

#include <itext_model.h>

Definition

The text model allows you to specify the alignment, color, decoration, transformation, and font of a text.

class itext_model interface_
Inheritance
xtd::interfacextd::forms::style_sheets::itext_model
Namespace
xtd::forms::style_sheets
Library
xtd.forms
Remarks
This class is used by xtd::forms::style_sheets::text_renderer.

Properties

virtual bool auto_ellipsis () const noexcept=0
 Gets a value indicating whether the ellipsis character (...) appears at the right edge of the control, denoting that the control text extends beyond the specified length of the control. More...
 
virtual xtd::forms::content_alignment text_alignment () const noexcept=0
 Gets the alignment of the text. More...
 
virtual const xtd::drawing::colorcolor () const noexcept=0
 Gets the color is used to add foreground effects to the text. More...
 
virtual xtd::forms::style_sheets::text_decoration decoration () const noexcept=0
 Gets the decoration of the text. More...
 
virtual const xtd::drawing::fontfont () const noexcept=0
 Gets the font of the text. More...
 
virtual xtd::forms::style_sheets::text_transformation transformation () const noexcept=0
 Gets the transformation of the text. More...
 
virtual xtd::forms::style_sheets::white_space white_space () const noexcept=0
 Gets how white-space inside an element is handled. More...
 

Methods

virtual xtd::drawing::string_format make_string_format () const noexcept=0
 Gets the string format of the text. More...
 

Member Function Documentation

◆ auto_ellipsis()

virtual bool xtd::forms::style_sheets::itext_model::auto_ellipsis ( ) const
pure virtualnoexcept

Gets a value indicating whether the ellipsis character (...) appears at the right edge of the control, denoting that the control text extends beyond the specified length of the control.

Returns
true if the additional control text is to be indicated by an ellipsis; otherwise, false.

Implemented in xtd::forms::style_sheets::control.

◆ color()

virtual const xtd::drawing::color& xtd::forms::style_sheets::itext_model::color ( ) const
pure virtualnoexcept

Gets the color is used to add foreground effects to the text.

Returns
The color is used to add foreground effects to the text.

Implemented in xtd::forms::style_sheets::control.

◆ decoration()

virtual xtd::forms::style_sheets::text_decoration xtd::forms::style_sheets::itext_model::decoration ( ) const
pure virtualnoexcept

Gets the decoration of the text.

Returns
One of xtd::forms::style_sheets::text_decoration values.

Implemented in xtd::forms::style_sheets::control.

◆ font()

virtual const xtd::drawing::font& xtd::forms::style_sheets::itext_model::font ( ) const
pure virtualnoexcept

Gets the font of the text.

Returns
The font of the text.

Implemented in xtd::forms::style_sheets::control.

◆ make_string_format()

virtual xtd::drawing::string_format xtd::forms::style_sheets::itext_model::make_string_format ( ) const
pure virtualnoexcept

Gets the string format of the text.

Returns
The string format used by xtd::drawing::graphics::draw_text method to draw a text.

Implemented in xtd::forms::style_sheets::control.

◆ text_alignment()

virtual xtd::forms::content_alignment xtd::forms::style_sheets::itext_model::text_alignment ( ) const
pure virtualnoexcept

Gets the alignment of the text.

Returns
A combination of xtd::forms::content_alignment values.

Implemented in xtd::forms::style_sheets::control.

◆ transformation()

virtual xtd::forms::style_sheets::text_transformation xtd::forms::style_sheets::itext_model::transformation ( ) const
pure virtualnoexcept

Gets the transformation of the text.

Returns
One of xtd::forms::style_sheets::text_transformation values.

Implemented in xtd::forms::style_sheets::control.

◆ white_space()

virtual xtd::forms::style_sheets::white_space xtd::forms::style_sheets::itext_model::white_space ( ) const
pure virtualnoexcept

Gets how white-space inside an element is handled.

Returns
One of xtd::forms::style_sheets::white_space values.

Implemented in xtd::forms::style_sheets::control.


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