CGUIString Class Reference

String class, substitute for CStr, but that parses the tags and builds up a list of all text that will be different when outputted. More...

#include <GUItext.h>

Classes
struct	SFeedback
	All data generated in GenerateTextCall() More...
struct	TextChunk
	A chunk of text that represents one call to the renderer. More...

Public Member Functions
void	SetValue (const CStrW &str)
	Set the value, the string will automatically be parsed when set. More...
const CStrW &	GetRawString () const
	Get String, without tags. More...
const CStrW &	GetOriginalString () const
	Get String, with tags. More...
void	GenerateTextCall (SFeedback &Feedback, const CStrW &DefaultFont, const int &from, const int &to, const bool FirstLine, const IGUIObject *pObject=NULL) const
	Generate Text Call from specified range. More...

Public Attributes
std::vector< int >	m_Words
	Words. More...
std::vector< TextChunk >	m_TextChunks
	TextChunks. More...

Private Attributes
CStrW	m_RawString
	The full raw string. More...
CStrW	m_OriginalString
	The original string value passed to SetValue. More...

Detailed Description

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.

Definition at line 176 of file GUItext.h.

Member Function Documentation

void CGUIString::GenerateTextCall	(	SFeedback &	Feedback,
		const CStrW &	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.

Definition at line 46 of file GUItext.cpp.

const CStrW& CGUIString::GetOriginalString ( ) const

inline

Get String, with tags.

Definition at line 300 of file GUItext.h.

const CStrW& CGUIString::GetRawString ( ) const

inline

Get String, without tags.

Definition at line 295 of file GUItext.h.

void CGUIString::SetValue

(

const CStrW &

str

)

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

Definition at line 303 of file GUItext.cpp.

Member Data Documentation

CStrW CGUIString::m_OriginalString

private

The original string value passed to SetValue.

Definition at line 345 of file GUItext.h.

CStrW CGUIString::m_RawString

private

The full raw string.

Stripped of tags.

Definition at line 340 of file GUItext.h.

std::vector<TextChunk> CGUIString::m_TextChunks

TextChunks.

Definition at line 334 of file GUItext.h.

std::vector<int> CGUIString::m_Words

Words.

Definition at line 329 of file GUItext.h.

---

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

• /home/sathyam/0ad.svn/source/gui/GUItext.h
• /home/sathyam/0ad.svn/source/gui/GUItext.cpp