TreeText

Scaleform::Render::TreeNode
    Scaleform::Render::TreeText

Declaration

class TreeText : public TreeNode;

Description

TreeText defines a tree node that represents a TextField.

Classes

Class	Description
NodeData	Node data representing a TextField.

Enumerations

Enumeration	Description
AAMode	Supported anti-alias mode types.
Alignment	Horizontal alignment types of the text object. The default alignment of the text is left.
FilterFlagsType	Describes the bit flags for filters.
FilterType	Enumeration of supported filters.
FontStyle	List of font styles used for formatting the text object.
VAlignment	Vertical alignment types of the text object. The default text alignment is top.

Methods

Method	Description
ClearFilters	Removes all filters from the text.
GetAAMode	Returns the currently set anti-aliasing mode.
GetAlignment	Returns the horizontal text alignment.
GetBackgroundColor	Returns the currently set background color.
GetBorderColor	Returns the currently set border color.
GetBounds	Obtains the bounding rectangle set around the text field.
GetDocView	Retrieves the docview used for rendering of rich text.
GetFilters	Returns the filters set on the text.
GetHtmlText	Returns the currently set text in HTML format.
GetLayout	Returns the visible layout of the text field.
GetText	Returns currently set text in UTF-8 format.
GetTextSize	Returns size (width and height) of the text.
GetVAlignment	Returns vertical text alignment such as top, bottom or center.
Init	Either creates new docview or initializes with an existing docview.
IsMultiline	Determines whether the text is multi-line or single-line.
IsWordWrap	Determines whether the wordwrap feature is turned on/off for the text object.
NotifyLayoutChanged	Sets a flag to rebuild text layout and add to propagation.
SetAAMode	Sets the anti-aliasing mode for the text object.
SetAlignment	Sets the horizontal text alignment.
SetBackgroundColor	Sets the color of the background under the text.
SetBorderColor	Sets the color of border around the text.
SetBounds	Sets a bounding rectangle around the text field.
SetColor	Sets color (R, G, B, A) to whole text or to a part of text.
SetFilters	Sets filters on the text.
SetFont	Sets font to whole text or to a part of text.
SetFontSize	Sets font size to the whole text or to a part of text.
SetFontStyle	Sets font style to the whole text or to a part of text.
SetHtmlText	Parses UTF-8, UCS-2 or String encoded HTML and initializes the text object by the parsed HTML text.
SetLayout	Sets the visible layout of the text field.
SetLetterSpacing	Sets letter spacing to whole text or to the part of text in interval [startPos..endPos].
SetMultiline	Sets the multi-line or single-line type of the text.
SetText	Sets the UTF-8, UCS-2, or String text value to the text object.
SetUnderline	Sets or clears underline to whole text or to a part of text.
SetVAlignment	Sets vertical text alignment such as top, bottom or center.
SetWordWrap	Turns wordwrapping feature on/off for the text object.

Structures

Structure	Description
Filter	Structure defining filters on the text.

File

Render_TreeText.h