0 A.D.: SGUIText

Overview

Project

Class

Tree

Deprecated

Index

0 A.D.

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

gui
Struct SGUIText

in GUItext.h

struct SGUIText

An SGUIText object is a parsed string, divided into text-rendering components. Each component, being a call to the Renderer. For instance, if you by tags change the color, then the GUI will have to make individual calls saying it want that color on the text. For instance: "Hello [b]there[/b] bunny!" That without word-wrapping would mean 3 components. i.e. 3 calls to CRenderer. One drawing "Hello", one drawing "there" in bold, and one drawing "bunny!".

Inner Classes, Typedefs, and Enums
`struct`	`SGUIText::SSpriteCall` A sprite call to the CRenderer
`struct`	`SGUIText::STextCall` A text call to the CRenderer

Field Summary
`CSize`	`m_Size` Width and height of the whole output, used when setting up scrollbars and such.
`std::list< SGUIText::SSpriteCall >`	`m_SpriteCalls` List of sprites, or "icons" that should be rendered along with the text.
`std::vector< SGUIText::STextCall >`	`m_TextCalls` List of TextCalls, for instance "Hello", "there!"

Field Detail

m_Size

public CSize m_Size;

Width and height of the whole output, used when setting up scrollbars and such.

m_SpriteCalls

public std::list< SGUIText::SSpriteCall > m_SpriteCalls;

List of sprites, or "icons" that should be rendered along with the text.

m_TextCalls

public std::vector< SGUIText::STextCall > m_TextCalls;

List of TextCalls, for instance "Hello", "there!"