xtd 1.0.0
Loading...
Searching...
No Matches
xtd::forms::style_sheets::itext_model Class Referenceabstract
Inheritance diagram for xtd::forms::style_sheets::itext_model:
xtd::interface xtd::forms::style_sheets::control

Definition

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

The text model allows you to specify the alignment, color, decoration, transformation,...
Definition itext_model.hpp:40
#define interface_
This keyword is use to represent an interface.
Definition interface.hpp:58
Inheritance
xtd::interfacextd::forms::style_sheets::itext_model
Header
#include <xtd/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.

Public Properties

virtual auto auto_ellipsis () const noexcept -> bool=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.
virtual auto text_alignment () const noexcept -> xtd::forms::content_alignment=0
 Gets the alignment of the text.
virtual auto color () const noexcept -> const xtd::drawing::color &=0
 Gets the color is used to add foreground effects to the text.
virtual auto decoration () const noexcept -> xtd::forms::style_sheets::text_decoration=0
 Gets the decoration of the text.
virtual auto font () const noexcept -> const xtd::drawing::font &=0
 Gets the font of the text.
virtual auto shadows () const noexcept -> xtd::forms::style_sheets::shadows=0
 Gets an xtd::forms::style_sheets::shadow array used to draw shadows under the text.
virtual auto transformation () const noexcept -> xtd::forms::style_sheets::text_transformation=0
 Gets the transformation of the text.
virtual auto white_space () const noexcept -> xtd::forms::style_sheets::white_space=0
 Gets how white-space inside an element is handled.

Public Methods

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

Member Function Documentation

◆ auto_ellipsis()

virtual auto xtd::forms::style_sheets::itext_model::auto_ellipsis ( ) const -> bool
nodiscardpure 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.

◆ text_alignment()

virtual auto xtd::forms::style_sheets::itext_model::text_alignment ( ) const -> xtd::forms::content_alignment
nodiscardpure virtualnoexcept

Gets the alignment of the text.

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

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

◆ color()

virtual auto xtd::forms::style_sheets::itext_model::color ( ) const -> const xtd::drawing::color &
nodiscardpure 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 auto xtd::forms::style_sheets::itext_model::decoration ( ) const -> xtd::forms::style_sheets::text_decoration
nodiscardpure 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 auto xtd::forms::style_sheets::itext_model::font ( ) const -> const xtd::drawing::font &
nodiscardpure virtualnoexcept

Gets the font of the text.

Returns
The font of the text.

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

◆ shadows()

virtual auto xtd::forms::style_sheets::itext_model::shadows ( ) const -> xtd::forms::style_sheets::shadows
nodiscardpure virtualnoexcept

Gets an xtd::forms::style_sheets::shadow array used to draw shadows under the text.

Returns
The xtd::forms::style_sheets::shadow array used to draw shadows under the text.

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

◆ transformation()

virtual auto xtd::forms::style_sheets::itext_model::transformation ( ) const -> xtd::forms::style_sheets::text_transformation
nodiscardpure 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 auto xtd::forms::style_sheets::itext_model::white_space ( ) const -> xtd::forms::style_sheets::white_space
nodiscardpure 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.

◆ make_string_format()

virtual auto xtd::forms::style_sheets::itext_model::make_string_format ( ) const -> xtd::drawing::string_format
nodiscardpure 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.


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