ComponentTextT Class Reference

This components adds text to its window. More...

Inheritance diagram for ComponentTextT:

Public Attributes
string	Text
	The text to show in this window. More...
string	Font
	The name of the font. More...
number	Scale
	The scale that is applied for rendering the text. More...
tuple	Padding
	Padding between text and window rectangle. More...
tuple	Color
	The text color. More...
number	Alpha
	The alpha component of the color. More...
number	horAlign
	How the text is aligned horizontally (left, center, right). More...
number	verAlign
	How the text is aligned vertically (top, middle, bottom). More...

Additional Inherited Members
Public Member Functions inherited from ComponentBaseT
any	get (string var_name)
	Returns the value of an attribute (a member variable) of this class. More...
	set (string var_name, any new_value)
	Sets an attribute (a member variable) of this class to a new value. More...
string	GetExtraMessage (string var_name)
	Returns the result of VarBaseT::GetExtraMessage() for the given member variable. More...
	interpolate (string var_name, number start_value, number end_value, number time)
	Schedules a value for interpolation between a start and end value over a given period of time. More...

Detailed Description

This components adds text to its window.

Note that the variables of this class (also referred to as "Public Attributes" or "Member Data") must be used with the get() and set() methods at this time – see get() and set() for details.

If you would like to create a new component of this type explicitly (those defined in the CaWE GUI Editor are instantiated automatically), use GuiT::new():

local comp = gui:new("ComponentTextT")

Implementing C++ Class:

cf::GuiSys::ComponentTextT

Member Data Documentation

number Alpha

The alpha component of the color.

Related C++ type:

float

tuple Color

The text color.

Related C++ type:

Vector3fT

string Font

The name of the font.

Typical values:

Value	Description
Fonts/Arial	Fonts/Arial
Fonts/Impact	Fonts/Impact

Related C++ type:

std::string

number horAlign

How the text is aligned horizontally (left, center, right).

Typical values:

Value	Description
-1	left
0	center
1	right

Related C++ type:

int

tuple Padding

Padding between text and window rectangle.

Related C++ type:

Vector2fT

number Scale

The scale that is applied for rendering the text.

Related C++ type:

float

string Text

The text to show in this window.

Related C++ type:

std::string

number verAlign

How the text is aligned vertically (top, middle, bottom).

Typical values:

Value	Description
-1	top
0	middle
1	bottom

Related C++ type:

int