GuiSplitContainer Class Reference [Containers]

#include <guiSplitContainer.h>

Inheritance diagram for GuiSplitContainer:

Inheritance graph
[legend]
List of all members.

Public Types

 panelFirst = 1
 panelSecond
enum  FixedPanel {
  panelFirst = 1,
  panelSecond
}

Public Member Functions

 DECLARE_CONOBJECT (GuiSplitContainer)
 GuiSplitContainer ()
 ~GuiSplitContainer ()
virtual bool onAdd ()
 Called when this object is added to the scene.
virtual bool onWake ()
 Called when this object is asked to wake up returns true if it's actually awake at the end.
virtual 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.
virtual void getCursor (GuiCursor *&cursor, bool &showCursor, const GuiEvent &lastGuiEvent)
 Get information about the cursor.
virtual Point2I getSplitPoint ()
virtual RectI getSplitRect ()
 The Splitters entire Client Rectangle, this takes into account padding of this control.
virtual void onMouseDown (const GuiEvent &event)
virtual void onMouseUp (const GuiEvent &event)
virtual void onMouseDragged (const GuiEvent &event)
virtual void solvePanelConstraints (Point2I newDragPos, GuiContainer *firstPanel, GuiContainer *secondPanel, RectI clientRect)
virtual void parentResized (const RectI &oldParentRect, const RectI &newParentRect)
 Called when this objects parent is resized.
virtual Point2I getMinExtent ()
virtual bool resize (const Point2I &newPosition, const Point2I &newExtent)
 Changes the size and/or position of this control.
void onRender (Point2I offset, const RectI &updateRect)
 Called when this control is to render itself.

Static Public Member Functions

static void initPersistFields ()
 Register dynamic fields in a subclass of ConsoleObject.

Protected Attributes

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

Private Types

typedef GuiContainer Parent

Member Typedef Documentation

Reimplemented from GuiContainer.


Member Enumeration Documentation

Enumerator:
panelFirst 
panelSecond 


Constructor & Destructor Documentation

GuiSplitContainer::GuiSplitContainer (  ) 

GuiSplitContainer::~GuiSplitContainer (  ) 


Member Function Documentation

GuiSplitContainer::DECLARE_CONOBJECT ( GuiSplitContainer   ) 

virtual bool GuiSplitContainer::onAdd (  )  [virtual]

Called when this object is added to the scene.

Reimplemented from GuiControl.

virtual bool GuiSplitContainer::onWake (  )  [virtual]

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

Reimplemented from GuiControl.

virtual bool GuiSplitContainer::layoutControls ( RectI clientRect  )  [virtual]

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

Parameters:
clientRect The Client Rectangle that is available for this Container to layout it's children in

Reimplemented from GuiContainer.

virtual void GuiSplitContainer::getCursor ( GuiCursor *&  cursor,
bool showCursor,
const GuiEvent lastGuiEvent 
) [virtual]

Get information about the cursor.

Parameters:
cursor Cursor information will be stored here
showCursor Will be set to true if the cursor is visible
lastGuiEvent GuiEvent containing cursor position and modifier keys (ie ctrl, shift, alt etc)

Reimplemented from GuiControl.

virtual Point2I GuiSplitContainer::getSplitPoint (  )  [inline, virtual]

virtual RectI GuiSplitContainer::getSplitRect (  )  [inline, virtual]

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

virtual void GuiSplitContainer::onMouseDown ( const GuiEvent event  )  [virtual]

Reimplemented from GuiControl.

virtual void GuiSplitContainer::onMouseUp ( const GuiEvent event  )  [virtual]

Reimplemented from GuiControl.

virtual void GuiSplitContainer::onMouseDragged ( const GuiEvent event  )  [virtual]

Reimplemented from GuiControl.

virtual void GuiSplitContainer::solvePanelConstraints ( Point2I  newDragPos,
GuiContainer firstPanel,
GuiContainer secondPanel,
RectI  clientRect 
) [virtual]

virtual void GuiSplitContainer::parentResized ( const RectI oldParentRect,
const RectI newParentRect 
) [virtual]

Called when this objects parent is resized.

Parameters:
oldParentRect The old rectangle of the parent object
newParentRect The new rectangle of the parent object

Reimplemented from GuiContainer.

virtual Point2I GuiSplitContainer::getMinExtent (  )  [virtual]

virtual bool GuiSplitContainer::resize ( const Point2I newPosition,
const Point2I newExtent 
) [virtual]

Changes the size and/or position of this control.

Parameters:
newPosition New position of this control
newExtent New size of this control

Reimplemented from GuiContainer.

static void GuiSplitContainer::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

See also:
addField(), addFieldV(), addDeprecatedField(), addGroup(), endGroup()

Reimplemented from GuiContainer.

void GuiSplitContainer::onRender ( Point2I  offset,
const RectI updateRect 
) [virtual]

Called when this control is to render itself.

Parameters:
offset The location this control is to begin rendering
updateRect The screen area this control has drawing access to

Reimplemented from GuiControl.


Member Data Documentation