GuiControlProfile Class Reference
[Core Controls]

A collection of properties that determine control behavior and rendering. More...

Inheritance diagram for GuiControlProfile:

[legend]

List of all members.

Public Member Functions
int	getStringWidth (pString)
Public Attributes
string	category
	Category under which the profile will appear in the editor.
Text
bool	autoSizeHeight
	Automatically adjust height of control to fit contents.
bool	autoSizeWidth
	Automatically adjust width of control to fit contents.
ColorI	cursorColor
	Color to use for the text cursor.
GuiFontCharset	fontCharset
ColorI	fontColor
	Font color for normal text (same as fontColors[0]).
ColorI	fontColorHL
	Font color for highlighted text (same as fontColors[1]).
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]).
ColorI	fontColorNA
	Font color when control is not active/disabled (same as fontColors[2]).
ColorI	fontColors [10]
	Font colors to use for different text types/states.
ColorI	fontColorSEL
	Font color for selected text (same as fontColors[3]).
int	fontSize
	Font size in points.
string	fontType
	Name of font family and typeface (e.g. "Arial Bold").
GuiAlignmentType	justify
	Horizontal alignment for text.
bool	numbersOnly
	Whether control should only accept numerical data (GuiTextEditCtrl).
bool	returnTab
	Whether to add automatic tab event when return is pressed so focus moves on to next control (GuiTextEditCtrl).
Point2I	textOffset
Appearance
ColorI	bevelColorHL
ColorI	bevelColorLL
int	border
	Border type (0=no border).
ColorI	borderColor
	Color to draw border with.
ColorI	borderColorHL
ColorI	borderColorNA
int	borderThickness
	Thickness of border in pixels.
ColorI	fillColor
ColorI	fillColorHL
ColorI	fillColorNA
ColorI	fillColorSEL
bool	opaque
Misc
filename	bitmap
	Texture to use for rendering control.
bool	hasBitmapArray
	If true, 'bitmap' is an array of images.
string	profileForChildren
SFXTrack	soundButtonDown
	Sound to play when mouse has been pressed on control.
SFXTrack	soundButtonOver
	Sound to play when mouse is hovering over control.
Behavior
bool	canKeyFocus
	Whether the control can have the keyboard focus.
bool	modal
bool	mouseOverSelected
bool	tab

---

Detailed Description

A collection of properties that determine control behavior and rendering.

---

Member Function Documentation

int GuiControlProfile::getStringWidth

(

pString

)

---

Member Data Documentation

bool GuiControlProfile::autoSizeHeight

Automatically adjust height of control to fit contents.

bool GuiControlProfile::autoSizeWidth

Automatically adjust width of control to fit contents.

ColorI GuiControlProfile::bevelColorHL

ColorI GuiControlProfile::bevelColorLL

filename GuiControlProfile::bitmap

Texture to use for rendering control.

int GuiControlProfile::border

Border type (0=no border).

ColorI GuiControlProfile::borderColor

Color to draw border with.

ColorI GuiControlProfile::borderColorHL

ColorI GuiControlProfile::borderColorNA

int GuiControlProfile::borderThickness

Thickness of border in pixels.

bool GuiControlProfile::canKeyFocus

Whether the control can have the keyboard focus.

string GuiControlProfile::category

Category under which the profile will appear in the editor.

ColorI GuiControlProfile::cursorColor

Color to use for the text cursor.

ColorI GuiControlProfile::fillColor

ColorI GuiControlProfile::fillColorHL

ColorI GuiControlProfile::fillColorNA

ColorI GuiControlProfile::fillColorSEL

GuiFontCharset GuiControlProfile::fontCharset

ColorI GuiControlProfile::fontColor

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

ColorI GuiControlProfile::fontColorHL

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

ColorI GuiControlProfile::fontColorLink

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

ColorI GuiControlProfile::fontColorLinkHL

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

ColorI GuiControlProfile::fontColorNA

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

ColorI GuiControlProfile::fontColors[10]

Font colors to use for different text types/states.

ColorI GuiControlProfile::fontColorSEL

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

int GuiControlProfile::fontSize

Font size in points.

string GuiControlProfile::fontType

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

bool GuiControlProfile::hasBitmapArray

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

GuiAlignmentType GuiControlProfile::justify

Horizontal alignment for text.

bool GuiControlProfile::modal

bool GuiControlProfile::mouseOverSelected

bool GuiControlProfile::numbersOnly

Whether control should only accept numerical data (GuiTextEditCtrl).

bool GuiControlProfile::opaque

string GuiControlProfile::profileForChildren

bool GuiControlProfile::returnTab

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

SFXTrack GuiControlProfile::soundButtonDown

Sound to play when mouse has been pressed on control.

SFXTrack GuiControlProfile::soundButtonOver

Sound to play when mouse is hovering over control.

bool GuiControlProfile::tab

Point2I GuiControlProfile::textOffset