Torque3D Documentation / _generateds / GuiCore

GuiCore

More...

Classes:

class
GuiCanvas

A canvas on which rendering occurs.

class
GuiConsole

The on-screen, in-game console. Calls getLog() to get the on-screen console entries, then renders them as needed.

class
GuiConsoleEditCtrl

Text entry element of a GuiConsole.

class
GuiControl

Base class for all Gui control objects.

class
GuiControlProfile

A collection of properties that determine control behavior and rendering.

class
GuiCursor

Acts as a skin for the cursor, where each GuiCursor object can have its own look and click-zone.

class
GuiFadeinBitmapCtrl

A GUI control which renders a black square over a bitmap image. The black square will fade out, then fade back in after a determined time. This control is especially useful for transitions and splash screens.

class
GuiIconButtonCtrl

Draws the bitmap within a special button control. Only a single bitmap is used and the button will be drawn in a highlighted mode when the mouse hovers over it or when it has been clicked.

class
GuiListBoxCtrl

A list of text items.

class
GuiMenuBar

GUI Control which displays a horizontal bar with individual drop-down menu items. Each menu item may also have submenu items.

class
GuiMLTextCtrl

A text control that uses the Gui Markup Language ('ML') tags to dynamically change the text.

class
GuiMouseEventCtrl

Used to overlaps a 'hot region' where you want to catch inputs with and have specific events occur based on individual callbacks.

class
GuiTextCtrl

GUI control object this displays a single line of text, without TorqueML.

class
GuiTextEditSliderBitmapCtrl

GUI Control which displays a numerical value which can be increased or decreased using a pair of bitmap up/down buttons.

class
GuiTextEditSliderCtrl

GUI Control which displays a numerical value which can be increased or decreased using a pair of arrows.

Enumerations

enum
GuiAlignmentType {
  Left 
  Center 
  Right 
  Top 
  Bottom 
}
enum
GuiFontCharset {
  ANSI 
  SYMBOL 
  SHIFTJIS 
  HANGEUL 
  HANGUL 
  GB2312 
  CHINESEBIG5 
  OEM 
  JOHAB 
  HEBREW 
  ARABIC 
  GREEK 
  TURKISH 
  VIETNAMESE 
  THAI 
  EASTEUROPE 
  RUSSIAN 
  MAC 
  BALTIC 
}
enum
GuiHorizontalSizing {
  right 
  width 
  left 
  center 
  relative 
  aspectLeft 
  aspectRight 
  aspectCenter 
  windowRelative 
}

Horizontal sizing behavior of a GuiControl.

enum
GuiVerticalSizing {
  bottom 
  height 
  top 
  center 
  relative 
  aspectTop 
  aspectBottom 
  aspectCenter 
  windowRelative 
}

Vertical sizing behavior of a GuiControl.

Functions

bool

excludeOtherInstance(string appIdentifer)

Used to exclude/prevent all other instances using the same identifier specified.

string

StripMLControlChars(string inString)

Strip TorqueML control characters from the specified string, returning a 'clean' version.

Variables

GuiControl

$ThisControl

The control for which a command is currently being evaluated. Only set during 'command' and altCommand callbacks to the control for which the command or altCommand is invoked.

Detailed Description

Enumerations

GuiAlignmentType

Enumerator

Left

Child controls are positioned in order from right to left (right-most control is first)

Scroll from right towards left.

Center
Right

Child controls are positioned in order from left to right (left-most control is first)

Scroll from left towards right.

Top

Tab headers on top edge.

Child controls are positioned in order from bottom to top (bottom-most control is first)

Bottom

Tab headers on bottom edge.

Child controls are positioned in order from top to bottom (top-most control is first)

GuiFontCharset

Enumerator

ANSI
SYMBOL
SHIFTJIS
HANGEUL
HANGUL
GB2312
CHINESEBIG5
OEM
JOHAB
HEBREW
ARABIC
GREEK
TURKISH
VIETNAMESE
THAI
EASTEUROPE
RUSSIAN
MAC
BALTIC 
GuiHorizontalSizing

Enumerator

right

...

width
left

...

center
relative
aspectLeft
aspectRight
aspectCenter
windowRelative

Horizontal sizing behavior of a GuiControl.

GuiVerticalSizing

Enumerator

bottom
height
top
center
relative
aspectTop
aspectBottom
aspectCenter
windowRelative

Vertical sizing behavior of a GuiControl.

Functions

excludeOtherInstance(string appIdentifer)

Used to exclude/prevent all other instances using the same identifier specified.

note:

Not used on OSX, Xbox, or in Win debug builds

Parameters:
appIdentifier

Name of the app set up for exclusive use.

return:

False if another app is running that specified the same appIdentifier

StripMLControlChars(string inString)

Strip TorqueML control characters from the specified string, returning a 'clean' version.

Parameters:

inString

String to strip TorqueML control characters from.

// Define the string to strip TorqueML control characters from
%string = "<font:Arial:24>How Now <color:c43c12>Brown <color:000000>Cow";

// Request the stripped version of the string
%strippedString = StripMLControlChars(%string);

return:

Version of the inputted string with all TorqueML characters removed.

see:

References

Variables

GuiControl $ThisControl

The control for which a command is currently being evaluated. Only set during 'command' and altCommand callbacks to the control for which the command or altCommand is invoked.