GuiRolloutCtrl Class Reference

#include <guiRolloutCtrl.h>

Inheritance diagram for GuiRolloutCtrl:

Inheritance graph

[legend]List of all members.


Public Types
	CollapsedLeft = 0
	CollapsedCenter
	CollapsedRight
	TopLeftHeader
	TopMidHeader
	TopRightHeader
	MidPageLeft
	MidPageCenter
	MidPageRight
	BottomLeftHeader
	BottomMidHeader
	BottomRightHeader
	NumBitmaps
	Number of bitmaps in this array.
enum	{ CollapsedLeft = 0, CollapsedCenter, CollapsedRight, TopLeftHeader, TopMidHeader, TopRightHeader, MidPageLeft, MidPageCenter, MidPageRight, BottomLeftHeader, BottomMidHeader, BottomRightHeader, NumBitmaps }
Public Member Functions
	GuiRolloutCtrl ()
	~GuiRolloutCtrl ()
	DECLARE_CONOBJECT (GuiRolloutCtrl)
bool	onWake ()
	Called when this object is asked to wake up returns true if it's actually awake at the end.
void	addObject (SimObject *obj)
	Adds an object as a child of this object.
void	removeObject (SimObject *obj)
	Removes a child object from this control.
virtual void	childResized (GuiControl *child)
	Called when a child control of the object is resized.
virtual void	onMouseDown (const GuiEvent &event)
virtual void	onMouseUp (const GuiEvent &event)
virtual void	calculateHeights ()
virtual bool	resize (const Point2I &newPosition, const Point2I &newExtent)
	Changes the size and/or position of this control.
virtual void	sizeToContents ()
bool	isExpanded ()
void	animateTo (S32 height)
virtual void	processTick ()
	This method is called once every 32ms if isProcessingTicks returns true when called on the object.
void	collapse ()
void	expand ()
void	instantCollapse ()
void	instantExpand ()
virtual void	onRender (Point2I offset, const RectI &updateRect)
	Called when this control is to render itself.
bool	onAdd ()
	Called when this object is added to the scene.
Static Public Member Functions
static void	initPersistFields ()
	Register dynamic fields in a subclass of ConsoleObject.
static bool	setCollapsed (void obj, const char data)
Public Attributes
StringTableEntry	mCaption
RectI	mHeader
RectI	mExpanded
RectI	mChildRect
Point2I	mMargin
bool	mIsExpanded
bool	mIsAnimating
bool	mCollapsing
S32	mAnimateDestHeight
S32	mAnimateStep
S32	mDefaultHeight
bool	mCanCollapse
GuiCursor *	mDefaultCursor
GuiCursor *	mVertSizingCursor
bool	mHasTexture
	Indicates whether we have a texture to render the tabs with.
RectI *	mBitmapBounds
	Array of rectangles identifying textures for tab book.
Private Types
typedef GuiControl	Parent

Member Typedef Documentation

typedef GuiControl GuiRolloutCtrl::Parent [private]

Reimplemented from GuiTickCtrl.

Reimplemented in GuiInspectorDynamicGroup, and GuiInspectorGroup.

Member Enumeration Documentation

anonymous enum

Enumerator:

CollapsedLeft
CollapsedCenter
CollapsedRight
TopLeftHeader
TopMidHeader
TopRightHeader
MidPageLeft
MidPageCenter
MidPageRight
BottomLeftHeader
BottomMidHeader
BottomRightHeader
NumBitmaps	Number of bitmaps in this array.

Constructor & Destructor Documentation

GuiRolloutCtrl::GuiRolloutCtrl ( )

GuiRolloutCtrl::~GuiRolloutCtrl ( )

Member Function Documentation

GuiRolloutCtrl::DECLARE_CONOBJECT ( GuiRolloutCtrl )

static void GuiRolloutCtrl::initPersistFields ( ) [static]

Register dynamic fields in a subclass of ConsoleObject.

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

Reimplemented from GuiControl.

Reimplemented in GuiInspectorGroup.

bool GuiRolloutCtrl::onWake ( ) [virtual]

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

Reimplemented from GuiControl.

void GuiRolloutCtrl::addObject ( SimObject * obj ) [virtual]

Adds an object as a child of this object.

Parameters:

obj

New child object of this control

Reimplemented from GuiControl.

void GuiRolloutCtrl::removeObject ( SimObject * obj ) [virtual]

Removes a child object from this control.

Parameters:

obj

Object to remove from this control

Reimplemented from GuiControl.

virtual void GuiRolloutCtrl::childResized ( GuiControl * child ) [virtual]

Called when a child control of the object is resized.

Parameters:

child

Child object

Reimplemented from GuiControl.

virtual void GuiRolloutCtrl::onMouseDown ( const GuiEvent & event ) [virtual]

Reimplemented from GuiControl.

virtual void GuiRolloutCtrl::onMouseUp ( const GuiEvent & event ) [virtual]

Reimplemented from GuiControl.

virtual void GuiRolloutCtrl::calculateHeights ( ) [virtual]

virtual bool GuiRolloutCtrl::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 GuiControl.

virtual void GuiRolloutCtrl::sizeToContents ( ) [virtual]

bool GuiRolloutCtrl::isExpanded ( ) [inline]

void GuiRolloutCtrl::animateTo ( S32 height )

virtual void GuiRolloutCtrl::processTick ( ) [virtual]

This method is called once every 32ms if isProcessingTicks returns true when called on the object.

Reimplemented from GuiTickCtrl.

void GuiRolloutCtrl::collapse ( ) [inline]

void GuiRolloutCtrl::expand ( ) [inline]

void GuiRolloutCtrl::instantCollapse ( )

void GuiRolloutCtrl::instantExpand ( )

static bool GuiRolloutCtrl::setCollapsed	(	void *	obj,
		const char *	data
	)			`[inline, static]`

virtual void GuiRolloutCtrl::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.

bool GuiRolloutCtrl::onAdd ( ) [virtual]

Called when this object is added to the scene.

Reimplemented from GuiControl.

Reimplemented in GuiInspectorGroup.

Member Data Documentation

StringTableEntry GuiRolloutCtrl::mCaption

RectI GuiRolloutCtrl::mHeader

RectI GuiRolloutCtrl::mExpanded

RectI GuiRolloutCtrl::mChildRect

Point2I GuiRolloutCtrl::mMargin

bool GuiRolloutCtrl::mIsExpanded

bool GuiRolloutCtrl::mIsAnimating

bool GuiRolloutCtrl::mCollapsing

S32 GuiRolloutCtrl::mAnimateDestHeight

S32 GuiRolloutCtrl::mAnimateStep

S32 GuiRolloutCtrl::mDefaultHeight

bool GuiRolloutCtrl::mCanCollapse

GuiCursor* GuiRolloutCtrl::mDefaultCursor

GuiCursor* GuiRolloutCtrl::mVertSizingCursor

bool GuiRolloutCtrl::mHasTexture

Indicates whether we have a texture to render the tabs with.

RectI* GuiRolloutCtrl::mBitmapBounds

Array of rectangles identifying textures for tab book.