Torque3D Documentation / _generateds / GuiControlProfile

GuiControlProfile

consoledoc.h

A collection of properties that determine control behavior and rendering.

More...

Behavior

bool
bool

Whether the control can have the keyboard focus.

bool

Appearance

bool
ColorI
ColorI
ColorI
ColorI
ColorI
int

Border type (0=no border).

int

Thickness of border in pixels.

ColorI

Color to draw border with.

ColorI
ColorI

Text

string

Name of font family and typeface (e.g. "Arial Bold").

int

Font size in points.

ColorI

Font colors to use for different text types/states.

ColorI

Font color for normal text (same as fontColors[0]).

ColorI

Font color for highlighted text (same as fontColors[1]).

ColorI

Font color when control is not active/disabled (same as fontColors[2]).

ColorI

Font color for selected text (same as fontColors[3]).

ColorI

Font color for links in text (same as fontColors[4]).

ColorI

Font color for highlighted links in text (same as fontColors[5]).

Horizontal alignment for text.

Point2I
bool

Automatically adjust width of control to fit contents.

bool

Automatically adjust height of control to fit contents.

bool

Whether to add automatic tab event when return is pressed so focus moves on to next control (GuiTextEditCtrl).

bool

Whether control should only accept numerical data (GuiTextEditCtrl).

ColorI

Color to use for the text cursor.

Misc

filename

Texture to use for rendering control.

bool

If true, 'bitmap' is an array of images.

Sound to play when mouse has been pressed on control.

Sound to play when mouse is hovering over control.

Public Attributes

string

Category under which the profile will appear in the editor.

Public Functions

int
getStringWidth(string string)

Get the width of the string in pixels.

Detailed Description

A collection of properties that determine control behavior and rendering.

Behavior

bool tab 
bool canKeyFocus 

Whether the control can have the keyboard focus.

bool mouseOverSelected 
bool modal 

Appearance

bool opaque 
ColorI fillColor 
ColorI fillColorHL 
ColorI fillColorNA 
ColorI fillColorERR 
ColorI fillColorSEL 
int border 

Border type (0=no border).

int borderThickness 

Thickness of border in pixels.

ColorI borderColor 

Color to draw border with.

ColorI borderColorHL 
ColorI borderColorNA 
ColorI bevelColorHL 
ColorI bevelColorLL 

Text

string fontType 

Name of font family and typeface (e.g. "Arial Bold").

int fontSize 

Font size in points.

GuiFontCharset fontCharset 
ColorI fontColors [10]

Font colors to use for different text types/states.

ColorI fontColor 

Font color for normal text (same as fontColors[0]).

ColorI fontColorHL 

Font color for highlighted text (same as fontColors[1]).

ColorI fontColorNA 

Font color when control is not active/disabled (same as fontColors[2]).

ColorI fontColorSEL 

Font color for selected text (same as fontColors[3]).

ColorI fontColorLink 

Font color for links in text (same as fontColors[4]).

ColorI fontColorLinkHL 

Font color for highlighted links in text (same as fontColors[5]).

GuiAlignmentType justify 

Horizontal alignment for text.

Point2I textOffset 
bool autoSizeWidth 

Automatically adjust width of control to fit contents.

bool autoSizeHeight 

Automatically adjust height of control to fit contents.

bool returnTab 

Whether to add automatic tab event when return is pressed so focus moves on to next control (GuiTextEditCtrl).

bool numbersOnly 

Whether control should only accept numerical data (GuiTextEditCtrl).

ColorI cursorColor 

Color to use for the text cursor.

Misc

filename bitmap 

Texture to use for rendering control.

bool hasBitmapArray 

If true, 'bitmap' is an array of images.

SFXTrack soundButtonDown 

Sound to play when mouse has been pressed on control.

SFXTrack soundButtonOver 

Sound to play when mouse is hovering over control.

string profileForChildren 

Public Attributes

string category 

Category under which the profile will appear in the editor.

Public Functions

getStringWidth(string string)

Get the width of the string in pixels.

Parameters:

string

String to get the width of.

return:

width of the string in pixels.