Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | Protected Member Functions | List of all members
Mezzanine::UI::DefaultMarkupParser Class Reference

This class implements the default set of tags used by the UI markup system. More...

#include <defaultmarkupparser.h>

+ Inheritance diagram for Mezzanine::UI::DefaultMarkupParser:
+ Collaboration diagram for Mezzanine::UI::DefaultMarkupParser:

Public Member Functions

 DefaultMarkupParser ()
 Class constructor.
 
virtual ~DefaultMarkupParser ()
 Class destructor.
 
virtual Char8 GetMarkupTagEnd () const
 Gets the ID for the character that marks the end of a markup section. More...
 
virtual Char8 GetMarkupTagStart () const
 Gets the ID for the character that marks the start of a markup section. More...
 
virtual String GetName () const
 Gets the name of this parser implementation. More...
 
- Public Member Functions inherited from Mezzanine::UI::MarkupParser
 MarkupParser ()
 Class constructor.
 
virtual ~MarkupParser ()
 Class destructor.
 
virtual TokenStringLex (const String &Source) const
 Converts a string into a series of tokens that can be parsed more readily. More...
 
virtual CharacterContainer Parse (const String &Source, const CharacterTraits &InitialTraits, TextLayer *CallingLayer) const
 Processes a string encoded in UTF8 into a list of renderable characters. More...
 
virtual CharacterContainer ParseTextTokens (TokenString *Tokens, const CharacterTraits &InitialTraits, TextLayer *CallingLayer) const
 Processes a collection of text tokens into a list of renderable characters. More...
 

Protected Member Functions

virtual void Initialize ()
 Populates the tag map with the tags recognized by this parser. More...
 
- Protected Member Functions inherited from Mezzanine::UI::MarkupParser
virtual TextTokenCreateTagToken (const String &Text) const
 Helper method for creating tag tokens. More...
 
virtual TextTokenCreateTextToken (const String &Text) const
 Helper method for creating text tokens. More...
 
virtual void GenerateCharactersFromToken (const TextToken *Token, TextLayer *Layer, const CharacterTraits &Traits, CharacterContainer &Characters) const
 Helper method for converting text tokens into characters. More...
 
virtual void RegenerateTraits (CharacterTraits &Traits, const TagVector &ActiveTags, TextLayer *Layer) const
 Helper method for regenerating current traits after a tag is disabled. More...
 

Additional Inherited Members

- Public Types inherited from Mezzanine::UI::MarkupParser
typedef std::list< Character * > CharacterContainer
 Basic container type for the storage of Character instances used during processing by this class.
 
typedef CharacterContainer::iterator CharacterIterator
 Iterator type for Character instances being processed by this class.
 
typedef CharacterContainer::const_iterator ConstCharacterIterator
 Const Iterator type for Character instances being processed by this class.
 
typedef TagContainer::const_iterator ConstTagIterator
 Const Iterator type for MarkupTag instances stored by this class.
 
typedef TagVector::const_iterator ConstTagVecIterator
 Const Iterator type for TokenTagPair instances being processed by this class.
 
typedef TokenContainer::const_iterator ConstTokenIterator
 Const Iterator type for TextToken instances being processed by this class.
 
typedef std::map< String, MarkupTag * > TagContainer
 Basic container type for the storage of MarkupTag instances by this class.
 
typedef TagContainer::iterator TagIterator
 Iterator type for MarkupTag instances stored by this class.
 
typedef TagVector::iterator TagVecIterator
 Iterator type for TokenTagPair instances being processed by this class.
 
typedef std::vector< TokenTagPairTagVector
 Basic container type for the storage of TokenTagPair instances used during processing by this class.
 
typedef std::vector< TextToken * > TokenContainer
 Basic container type for the storage of TextToken instances used during processing by this class.
 
typedef TokenContainer::iterator TokenIterator
 Iterator type for TextToken instances being processed by this class.
 
typedef std::pair< TagToken *, MarkupTag * > TokenTagPair
 An std::pair type used to map a TagToken to the MarkupTag implementation it is calling.
 
- Protected Attributes inherited from Mezzanine::UI::MarkupParser
TagContainer Tags
 Map of tags recognized by this parser.
 

Detailed Description

This class implements the default set of tags used by the UI markup system.

Definition at line 162 of file defaultmarkupparser.h.

Member Function Documentation

Char8 Mezzanine::UI::DefaultMarkupParser::GetMarkupTagEnd ( ) const
virtual

Gets the ID for the character that marks the end of a markup section.

Returns
Returns an Int32 representing the end of a markup section.

Implements Mezzanine::UI::MarkupParser.

Definition at line 159 of file defaultmarkupparser.cpp.

Char8 Mezzanine::UI::DefaultMarkupParser::GetMarkupTagStart ( ) const
virtual

Gets the ID for the character that marks the start of a markup section.

Returns
Returns an Int32 representing the start of a markup section.

Implements Mezzanine::UI::MarkupParser.

Definition at line 156 of file defaultmarkupparser.cpp.

String Mezzanine::UI::DefaultMarkupParser::GetName ( ) const
virtual

Gets the name of this parser implementation.

Returns
Returns a string containing the name of this markup parser implementation.

Implements Mezzanine::UI::MarkupParser.

Definition at line 153 of file defaultmarkupparser.cpp.

void Mezzanine::UI::DefaultMarkupParser::Initialize ( )
protectedvirtual

Populates the tag map with the tags recognized by this parser.

Implements Mezzanine::UI::MarkupParser.

Definition at line 143 of file defaultmarkupparser.cpp.


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