GuiContainers

More...

Classes:

class

GuiAutoScrollCtrl

A container that scrolls its child control up over time.

class

GuiContainer

Brief Desc.

class

GuiControlArrayControl

Brief Desc.

class

GuiDynamicCtrlArrayControl

A container that arranges children into a grid.

class

GuiFrameSetCtrl

A gui control allowing a window to be subdivided into panes, each of which displays a gui control child of the GuiFrameSetCtrl.

class

GuiPaneControl

A collapsable pane control.

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.

class

GuiRolloutCtrl

A container that shows a single child with an optional header bar that can be used to collapse and expand the rollout.

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.

class

GuiSpeedometerHud

Displays the speed of the current Vehicle based control object.

class

GuiSplitContainer

A container that splits its area between two child controls.

class

GuiStackControl

A container that stacks its children horizontally or vertically.

class

GuiTabBookCtrl

A container.

class

GuiTabPageCtrl

A single page in a GuiTabBookCtrl.

class

GuiTreeViewCtrl

Hierarchical list of text items with optional icons.

class

GuiWindowCtrl

A window with a title bar and an optional set of buttons.

Enumerations

enum

GuiAutoScrollDirection {
  Up 
  Down 
  Left 
  Right 
}

Direction in which to scroll the child control.

enum

GuiDockingType {
  None 
  Client 
  Top 
  Bottom 
  Left 
  Right 
}

enum

GuiFrameState {
  alwaysOn 
  alwaysOff 
  dynamic 
}

enum

GuiHorizontalStackingType {
  Right 
  Left 
}

Determines how child controls are stacked horizontally.

enum

GuiScrollBarBehavior {
  alwaysOn 
  alwaysOff 
  dynamic 
}

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

enum

GuiSplitFixedPanel {
  None 
  FirstPanel 
  SecondPanel 
}

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

enum

GuiSplitOrientation {
  Vertical 
  Horizontal 
}

Axis along which to divide the container's space.

enum

GuiStackingType {
  Vertical 
  Horizontal 
  Dynamic 
}

Stacking method used to position child controls.

enum

GuiTabPosition {
  Top 
  Bottom 
}

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

enum

GuiVerticalStackingType {
  Bottom 
  Top 
}

Determines how child controls are stacked vertically.

Detailed Description

Enumerations

GuiAutoScrollDirection

Enumerator

Up

Scroll from bottom towards top.

Down

Scroll from top towards bottom.

Left

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

Scroll from right towards left.

Right

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

Scroll from left towards right.

Direction in which to scroll the child control.

GuiDockingType

Enumerator

None

Simple point sampled filtering. This is the fastest and lowest quality mode.

No transition. Immediately move on to processing the slot or immediately move on to the next slot.

Allow both childs to resize (default).

Disable blending for this material.

No mesh data.

Client

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)

Left

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

Scroll from right towards left.

Right

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

Scroll from left towards right.

GuiFrameState

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.

GuiHorizontalStackingType

Enumerator

Right

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

Scroll from left towards right.

Left

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

Scroll from right towards left.

Determines how child controls are stacked horizontally.

GuiScrollBarBehavior

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.

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

GuiSplitFixedPanel

Enumerator

None

Simple point sampled filtering. This is the fastest and lowest quality mode.

No transition. Immediately move on to processing the slot or immediately move on to the next slot.

Allow both childs to resize (default).

Disable blending for this material.

No mesh data.

FirstPanel

Keep.

SecondPanel

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

GuiSplitOrientation

Enumerator

Vertical

Stack children vertically by setting their Y position.

Divide vertically placing one child left and one child right.

Horizontal

Stack children horizontall by setting their X position.

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

Axis along which to divide the container's space.

GuiStackingType

Enumerator

Vertical

Stack children vertically by setting their Y position.

Divide vertically placing one child left and one child right.

Horizontal

Stack children horizontall by setting their X position.

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

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.

Stacking method used to position child controls.

GuiTabPosition

Enumerator

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)

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

GuiVerticalStackingType

Enumerator

Bottom

Tab headers on bottom edge.

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

Top

Tab headers on top edge.

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

Determines how child controls are stacked vertically.