Torque3D Documentation / _generateds / GuiSplitContainer

GuiSplitContainer

Engine/source/gui/containers/guiSplitContainer.h

More...

Public Types

enum
FixedPanel {
  None = 0
  FirstPanel = 1
  SecondPanel 
}
enum
Orientation {
  Vertical = 0
  Horizontal = 1
}

Private Types

Parent 

Public Functions

DECLARE_DESCRIPTION("A container that splits its area between two child <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">controls.\n</a>" "The split ratio can be dynamically adjusted with <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> handle <a href="/coding/file/guieditctrl_8cpp/#guieditctrl_8cpp_1abb04e3738c4c5a96b3ade6fa47013a6c">control</a> between the two <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">children.\n</a>" "Splitting can be either horizontal or vertical." )
getCursor(GuiCursor *& cursor, bool & showCursor, const GuiEvent & lastGuiEvent)

Get information about the cursor.

Returns minimum size the control can be.

The Splitters entire Client Rectangle, this takes into account padding of this control.

bool
layoutControls(RectI & clientRect)

Called when the Layout for a Container needs to be updated because of a resize call or a call to setUpdateLayout.

bool

Called when this object is added to the scene.

onRender(Point2I offset, const RectI & updateRect)

Called when this control is to render itself.

bool

Called when this object is asked to wake up returns true if it's actually awake at the end.

parentResized(const RectI & oldParentRect, const RectI & newParentRect)

GuiContainer deals with parentResized calls differently than GuiControl.

bool
resize(const Point2I & newPosition, const Point2I & newExtent)

Changes the size and/or position of this control.

solvePanelConstraints(Point2I newDragPos, GuiContainer * firstPanel, GuiContainer * secondPanel, const RectI & clientRect)

Public Static Functions

Detailed Description

Public Types

FixedPanel

Enumerator

None = 0
FirstPanel = 1
SecondPanel
Orientation

Enumerator

Vertical = 0
Horizontal = 1

Private Types

typedef GuiContainer Parent 

Protected Attributes

bool mDragging 
S32 mFixedPanel 
S32 mFixedPanelSize 
S32 mOrientation 
Point2I mSplitPoint 
RectI mSplitRect 
S32 mSplitterSize 

Public Functions

GuiSplitContainer()

DECLARE_CONOBJECT(GuiSplitContainer )

DECLARE_DESCRIPTION("A container that splits its area between two child <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">controls.\n</a>" "The split ratio can be dynamically adjusted with <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> handle <a href="/coding/file/guieditctrl_8cpp/#guieditctrl_8cpp_1abb04e3738c4c5a96b3ade6fa47013a6c">control</a> between the two <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">children.\n</a>" "Splitting can be either horizontal or vertical." )

getCursor(GuiCursor *& cursor, bool & showCursor, const GuiEvent & lastGuiEvent)

Reimplemented from: GuiControl

getMinExtent()

Reimplemented from: GuiControl

getSplitPoint()

getSplitRect()

The Splitters entire Client Rectangle, this takes into account padding of this control.

layoutControls(RectI & clientRect)

Reimplemented from: GuiContainer

onAdd()

Reimplemented from: GuiControl

onMouseDown(const GuiEvent & event)

Reimplemented from: GuiControl

onMouseDragged(const GuiEvent & event)

Reimplemented from: GuiControl

onMouseUp(const GuiEvent & event)

Reimplemented from: GuiControl

onRender(Point2I offset, const RectI & updateRect)

Reimplemented from: GuiControl

onWake()

Reimplemented from: GuiControl

parentResized(const RectI & oldParentRect, const RectI & newParentRect)

Reimplemented from: GuiContainer

resize(const Point2I & newPosition, const Point2I & newExtent)

Reimplemented from: GuiContainer

setSplitPoint(Point2I splitPoint)

solvePanelConstraints(Point2I newDragPos, GuiContainer * firstPanel, GuiContainer * secondPanel, const RectI & clientRect)

Public Static Functions

initPersistFields()