Formatter

Scaleform::Formatter

Declaration

class Formatter : public FmtResource, public Unassignable;

Description

Formatter is the base class for all formatters and can be used as a standalone object. This class is used to format different type of values to the string type.

Enumerations

Enumeration	Description
ParentRef	Indicates the position of a parent formatter.
requirement_t	Indicates the list of requirements for the formatter in formatting the strings.

Methods

Method	Description
GetNextStr	Obtains the next string required by the formatter for conversion.
Convert	Formats a value to the string type.
Converted	Checks the conversion status for optimization purposes.
Formatter	Initializes the Formatter object.
GetParentPos	Obtains the absolute position of the parent formatter.
GetParentRef	Obtains reference to a parent formatter.
GetPrevStr	Retrieves the previous string used by the formatter for conversion.
GetRequirements	Retrieve the requirements of the formatter.
GetResult	Retrieves the conversion result.
GetSize	Retrieves the size of a converted value.
Parse	Parses the formatting string and sets up the attributes of the formatter.
SetNextStr	Sets the next string to be used by the formatter.
SetPrevStr	Sets a string as previous string.
SetParent	Sets the parent formatter.

File

SF_MsgFormat.h