BlackTopp Studios inc
This struct represents a markup tag segment from the source string. More...
#include <texttoken.h>
Inheritance diagram for Mezzanine::UI::TagToken: Collaboration diagram for Mezzanine::UI::TagToken:Public Member Functions | |
| TagToken () | |
| Class constructor. | |
| TagToken (const String &RawText, const String &Name, const TokenType TType) | |
| Descriptive constructor. More... | |
| virtual | ~TagToken () |
| Class destructor. | |
| String | GetParameter (const String &Param) const |
| Gets a parameter specified in this token by name. More... | |
| const String & | GetTagName () const |
| Gets the name of the tag this token represents. More... | |
| Public Member Functions inherited from Mezzanine::UI::TextToken | |
| TextToken () | |
| Class constructor. More... | |
| TextToken (const String &RawText, const TokenType TType) | |
| Descriptive constructor. More... | |
| TextToken (const Char8 *Characters, const UInt32 Size) | |
| Char8 constructor. More... | |
| TextToken (const UInt32 *Characters, const UInt32 Size) | |
| Char8 constructor. More... | |
| virtual | ~TextToken () |
| Class destructor. | |
| virtual UInt32 | ClearAllCharacters () |
| Removes all the rendered characters from this token. More... | |
| virtual UInt32 | GetRawCharacterSize () const |
| Gets the number of Char8's that comprise the source text for this tag. More... | |
| virtual const String & | GetRawCharacterString () const |
| Gets the raw string for this token used to render or manipulate characters. More... | |
| virtual UInt32 | GetRenderCharacterSize () const |
| Gets the number of rendered characters this token generates. More... | |
| virtual TextToken::TokenType | GetTokenType () const |
| Gets the type of token this is. More... | |
| virtual UInt32 | InsertCharacter (const UInt32 Index, UInt32 UChar) |
| Inserts a single UTF-32 size character into this token. More... | |
| virtual UInt32 | InsertCharacters (const UInt32 Index, const Char8 *Characters, const UInt32 Size) |
| Inserts multiple characters into this token. More... | |
| virtual UInt32 | InsertCharacters (const UInt32 Index, const UInt32 *Characters, const UInt32 Size) |
| Inserts multiple characters into this token. More... | |
| virtual UInt32 | RemoveCharacter (const UInt32 Index) |
| Removes a single rendered character from this token. More... | |
| virtual UInt32 | RemoveCharacters (const UInt32 Index, const UInt32 Length) |
| Removes rendered characters from this token. More... | |
Protected Attributes | |
| NameValuePairMap | Params |
| The parameters provided for this tag, if any. | |
| String | TagName |
| Unconverted version of the tag name. | |
| Protected Attributes inherited from Mezzanine::UI::TextToken | |
| UInt32 | RenderSize |
| The number of rendered characters this token produced. More... | |
| String | Text |
| Container for the converted text. More... | |
| TokenType | Type |
| Type of token this is. More... | |
Friends | |
| class | MarkupParser |
Additional Inherited Members | |
| Public Types inherited from Mezzanine::UI::TextToken | |
| enum | TokenType { TT_Error = 0, TT_Text = 1, TT_TagInvalid = 2, TT_RangeTagStart = 3, TT_RangeTagEnd = 4, TT_InsertTag = 5 } |
| The type of token this class represents. More... | |
| Protected Member Functions inherited from Mezzanine::UI::TextToken | |
| UInt32 | ConvertRenderIndexToRawIndex (const UInt32 Index) |
| Takes a position of a renderable char and converts it to the respective position in the raw string. More... | |
This struct represents a markup tag segment from the source string.
Tag tokens are tokens that represent text that isn't intended to be rendered, but instead alter other text around it or create special characters of their own. The render size on tag token should never never match the text size, instead being 0 or 1.
Definition at line 163 of file texttoken.h.
| Mezzanine::UI::TagToken::TagToken | ( | const String & | RawText, |
| const String & | Name, | ||
| const TokenType | TType | ||
| ) |
Descriptive constructor.
| RawText | A string containing the raw text of this token. |
| Name | The name of this tag. |
| TType | The type of text token to be created. |
Definition at line 236 of file texttoken.cpp.
Gets a parameter specified in this token by name.
| Param | The name of the parameter to retrieve. |
Definition at line 247 of file texttoken.cpp.
| const String & Mezzanine::UI::TagToken::GetTagName | ( | ) | const |
Gets the name of the tag this token represents.
Definition at line 244 of file texttoken.cpp.
1.8.9.1. Thanks to the
Open Icon Library
for help with some of the icons.
