Torque 3D - Script Manual: Container Controls

TorqueScript

previous page next page
Main   Class List   Namespace List   Online

Container Controls
[GUI]

A collection of various containers (container, window, scroll, etc). More...

Classes

class  GuiAutoScrollCtrl
 A container that scrolls its child control up over time. More...
class  GuiContainer
 Brief Desc. More...
class  GuiControlArrayControl
 Brief Desc. More...
class  GuiDynamicCtrlArrayControl
 A container that arranges children into a grid. More...
class  GuiFrameSetCtrl
 A gui control allowing a window to be subdivided into panes, each of which displays a gui control child of the GuiFrameSetCtrl. More...
class  GuiPaneControl
 A collapsable pane control. More...
class  GuiPanel
 The GuiPanel panel is a container that when opaque will draw a left to right gradient using its profile fill and fill highlight colors. More...
class  GuiRolloutCtrl
 A container that shows a single child with an optional header bar that can be used to collapse and expand the rollout. More...
class  GuiScrollCtrl
 A container that allows to view one or more possibly larger controls inside its area by providing horizontal and/or vertical scroll bars. More...
class  GuiSpeedometerHud
 Displays the speed of the current Vehicle based control object. More...
class  GuiSplitContainer
 A container that splits its area between two child controls. More...
class  GuiStackControl
 A container that stacks its children horizontally or vertically. More...
class  GuiTabBookCtrl
 A container. More...
class  GuiTabPageCtrl
 A single page in a GuiTabBookCtrl. More...
class  GuiTreeViewCtrl
 Hierarchical list of text items with optional icons. More...
class  GuiWindowCtrl
 A window with a title bar and an optional set of buttons. More...

Enumerations

enum  GuiAutoScrollDirection {
  Up,
  Down,
  Left,
  Right
}
 

Direction in which to scroll the child control.

More...
enum  GuiDockingType {
  None,
  Client,
  Top,
  Bottom,
  Left,
  Right
}
enum  GuiFrameState {
  alwaysOn,
  alwaysOff,
  dynamic
}
enum  GuiHorizontalStackingType {
  Right,
  Left
}
 

Determines how child controls are stacked horizontally.

More...
enum  GuiScrollBarBehavior {
  alwaysOn,
  alwaysOff,
  dynamic
}
 

Display behavior of a scroll bar. Determines when a scrollbar will be visible.

More...
enum  GuiSplitFixedPanel {
  None,
  FirstPanel,
  SecondPanel
}
 

Which side of the splitter to keep at a fixed size (if any).

More...
enum  GuiSplitOrientation {
  Vertical,
  Horizontal
}
 

Axis along which to divide the container's space.

More...
enum  GuiStackingType {
  Vertical,
  Horizontal,
  Dynamic
}
 

Stacking method used to position child controls.

More...
enum  GuiTabPosition {
  Top,
  Bottom
}
 

Where the control should put the tab headers for selecting individual pages.

More...
enum  GuiVerticalStackingType {
  Bottom,
  Top
}
 

Determines how child controls are stacked vertically.

More...

Detailed Description

A collection of various containers (container, window, scroll, etc).

Enumeration Type Documentation

enum GuiAutoScrollDirection

Direction in which to scroll the child control.

Enumerator:
Up 

Scroll from bottom towards top.

Down 

Scroll from top towards bottom.

Left 

Scroll from right towards left.

Right 

Scroll from left towards right.

enum GuiDockingType
Enumerator:
None 
Client 
Top 
Bottom 
Left 
Right 
enum GuiFrameState
Enumerator:
alwaysOn 
alwaysOff 
dynamic 
enum GuiHorizontalStackingType

Determines how child controls are stacked horizontally.

Enumerator:
Right 

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

Left 

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

enum GuiScrollBarBehavior

Display behavior of a scroll bar. Determines when a scrollbar will be visible.

Enumerator:
alwaysOn 

Always visible.

alwaysOff 

Never visible.

dynamic 

Only visible when actually needed, i.e. when the child control(s) exceed the visible space on the given axis.

enum GuiSplitFixedPanel

Which side of the splitter to keep at a fixed size (if any).

Enumerator:
None 

Allow both childs to resize (default).

FirstPanel 

Keep.

SecondPanel 
enum GuiSplitOrientation

Axis along which to divide the container's space.

Enumerator:
Vertical 

Divide vertically placing one child left and one child right.

Horizontal 

Divide horizontally placing one child on top and one child below.

enum GuiStackingType

Stacking method used to position child controls.

Enumerator:
Vertical 

Stack children vertically by setting their Y position.

Horizontal 

Stack children horizontall by setting their X position.

Dynamic 

Automatically switch between Vertical and Horizontal stacking. Vertical stacking is chosen when the stack control is taller than it is wide, horizontal stacking is chosen when the stack control is wider than it is tall.

enum GuiTabPosition

Where the control should put the tab headers for selecting individual pages.

Enumerator:
Top 

Tab headers on top edge.

Bottom 

Tab headers on bottom edge.

enum GuiVerticalStackingType

Determines how child controls are stacked vertically.

Enumerator:
Bottom 

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

Top 

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



Copyright © GarageGames, LLC. All Rights Reserved.
previous page start next page