gui
Class CGUIString

class CGUIString

String class, substitute for CStr, but that parses the tags and builds up a list of all text that will be different when outputted. The difference between CGUIString and SGUIText is that CGUIString is a string-class that parses the tags when the value is set. The SGUIText is just a container which stores the positions and settings of all text-calls that will have to be made to the Renderer.

m_RawString

private CStrW m_RawString;

The full raw string. Stripped of tags.

m_TextChunks

public std::vector< CGUIString::TextChunk > m_TextChunks;

TextChunks

m_Words

public std::vector< int > m_Words;

Words

GenerateTextCall

public void GenerateTextCall( CGUIString::SFeedback& Feedback, const CStr& DefaultFont, const int& from, const int& to, const bool FirstLine, const IGUIObject* pObject = NULL ) const;

Generate Text Call from specified range. The range must span only within ONE TextChunk though. Otherwise it can't be fit into a single Text Call Notice it won't make it complete, you will have to add X/Y values and such.

Parameters:

Feedback - contains all info that is generated.

DefaultFont - Default Font

from - From character n,

to - to character n.

FirstLine - Whether this is the first line of text, to calculate its height correctly pObject Only for Error outputting, optional! If NULL then no Errors will be reported! Useful when you need to make several GenerateTextCall in different phases, it avoids duplicates.

GetRawString

public const CStrW& GetRawString() const;

Get String, without tags

SetValue

public void SetValue( const CStrW& str );

Set the value, the string will automatically be parsed when set.