Mezzanine::UI::DefaultSpriteTag Class Reference

This class implements a sprite inserting tag. More...

#include <defaultmarkupparser.h>

Inheritance diagram for Mezzanine::UI::DefaultSpriteTag:

Collaboration diagram for Mezzanine::UI::DefaultSpriteTag:

Public Member Functions
	DefaultSpriteTag ()
	Class constructor.
virtual	~DefaultSpriteTag ()
	Class destructor.
virtual const String &	GetName () const
	Gets the name of this tag. More...
virtual Boolean	IsRangeTag () const
	Gets whether or not this tag applies to a range of characters. More...
virtual ProcessResult	Process (NameValuePairMap &Params, CharacterTraits &Traits, TextLayer *Layer) const
	Processes this tag. More...
Public Member Functions inherited from Mezzanine::UI::MarkupTag
	MarkupTag ()
	Class constructor.
virtual	~MarkupTag ()
	Class destructor.

Static Public Attributes
static const String	TagName = "Sprite"
	The name of this tag as it should appear in markup.

Additional Inherited Members
Public Types inherited from Mezzanine::UI::MarkupTag
typedef std::list< Character * >	CharacterContainer
	Basic container type for the storage of Character instances by this class.
typedef CharacterContainer::iterator	CharacterIterator
	Iterator type for Character instances stored by this class.
typedef CharacterContainer::const_iterator	ConstCharacterIterator
	Const Iterator type for Character instances stored by this class.
typedef std::pair< Boolean, Character * >	ProcessResult
	An std::pair used to report the result of a MarkupTag being processed any the character it may have generated.

Detailed Description

This class implements a sprite inserting tag.

This tag only supports long notation. Example: "[Sprite Name=Background]". A size can also be specified such as in this example: "[Sprite Name=Background Size=12x12]". The name is the same name as specified in the texture atlas the calling layer has set as it's primary. The size is the actual dimensions to have set (before scaling) for the character that will be generated using the named sprite.

Definition at line 130 of file defaultmarkupparser.h.

Member Function Documentation

virtual const String& Mezzanine::UI::DefaultSpriteTag::GetName ( ) const

inlinevirtual

Gets the name of this tag.

Returns

Returns a String containing the name of this tag.

Implements Mezzanine::UI::MarkupTag.

Definition at line 148 of file defaultmarkupparser.h.

virtual Boolean Mezzanine::UI::DefaultSpriteTag::IsRangeTag ( ) const

inlinevirtual

Gets whether or not this tag applies to a range of characters.

Returns

Returns true if this tag requires a closing tag to accompany to be valid, false otherwise.

Implements Mezzanine::UI::MarkupTag.

Definition at line 151 of file defaultmarkupparser.h.

MarkupTag::ProcessResult Mezzanine::UI::DefaultSpriteTag::Process ( NameValuePairMap &  Params, CharacterTraits &  Traits, TextLayer *  Layer  ) const

virtual

Processes this tag.

Parameters

Params	A NameValuePairMap of all the parameters provided for this tag.
Traits	The character traits to be modified and used for future character construction.
Layer	A pointer to the TextLayer currently being parsed.

Returns

Returns a process result where the first value is true if this tag succeeded in making it's alterations and the second value contains a pointer to a generated character if one was generated. The second value can be NULL.

Implements Mezzanine::UI::MarkupTag.

Definition at line 105 of file defaultmarkupparser.cpp.

---

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

• /home/sqeaky/Code/Mezzanine/Mezzanine/src/UI/defaultmarkupparser.h
• /home/sqeaky/Code/Mezzanine/Mezzanine/src/UI/defaultmarkupparser.cpp