GuiFormCtrl Class Reference [Containers]

#include <guiFormCtrl.h>

Inheritance diagram for GuiFormCtrl:

Inheritance graph

[legend]List of all members.


Public Member Functions
	GuiFormCtrl ()
virtual	~GuiFormCtrl ()
void	setCaption (const char *caption)
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.
bool	onAdd ()
	Called when this object is added to the scene.
bool	onWake ()
	Called when this object is asked to wake up returns true if it's actually awake at the end.
void	onSleep ()
	Called when this object is asked to sleep.
virtual void	addObject (SimObject *newObj)
	Adds an object as a child of this object.
void	onMouseDown (const GuiEvent &event)
void	onMouseUp (const GuiEvent &event)
void	onMouseMove (const GuiEvent &event)
void	onMouseLeave (const GuiEvent &event)
void	onMouseEnter (const GuiEvent &event)
	DECLARE_CONOBJECT (GuiFormCtrl)
Static Public Member Functions
static void	initPersistFields ()
	Register dynamic fields in a subclass of ConsoleObject.
Private Types
typedef GuiPanel	Parent
Private Attributes
Resource< GFont >	mFont
StringTableEntry	mCaption
bool	mCanMove
bool	mUseSmallCaption
StringTableEntry	mSmallCaption
StringTableEntry	mContentLibrary
StringTableEntry	mContent
Point2I	mThumbSize
bool	mMouseMovingWin
Point2I	mMouseDownPosition
RectI	mOrigBounds
RectI	mStandardBounds
RectI	mCloseButton
RectI	mMinimizeButton
RectI	mMaximizeButton
bool	mMouseOver
bool	mDepressed

Member Typedef Documentation

typedef GuiPanel GuiFormCtrl::Parent [private]

Reimplemented from GuiPanel.

Constructor & Destructor Documentation

GuiFormCtrl::GuiFormCtrl ( )

virtual GuiFormCtrl::~GuiFormCtrl ( ) [virtual]

Member Function Documentation

void GuiFormCtrl::setCaption ( const char * caption )

bool GuiFormCtrl::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.

void GuiFormCtrl::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 GuiPanel.

bool GuiFormCtrl::onAdd ( ) [virtual]

Called when this object is added to the scene.

Reimplemented from GuiControl.

bool GuiFormCtrl::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 GuiFormCtrl::onSleep ( ) [virtual]

Called when this object is asked to sleep.

Reimplemented from GuiControl.

virtual void GuiFormCtrl::addObject ( SimObject * newObj ) [virtual]

Adds an object as a child of this object.

Parameters:

obj

New child object of this control

Reimplemented from GuiContainer.

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

Reimplemented from GuiControl.

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

Reimplemented from GuiControl.

void GuiFormCtrl::onMouseMove ( const GuiEvent & event ) [virtual]

Reimplemented from GuiControl.

void GuiFormCtrl::onMouseLeave ( const GuiEvent & event ) [virtual]

Reimplemented from GuiControl.

void GuiFormCtrl::onMouseEnter ( const GuiEvent & event ) [virtual]

Reimplemented from GuiControl.

static void GuiFormCtrl::initPersistFields ( ) [static]

Register dynamic fields in a subclass of ConsoleObject.

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

Reimplemented from GuiContainer.

GuiFormCtrl::DECLARE_CONOBJECT ( GuiFormCtrl )

Member Data Documentation

Resource<GFont> GuiFormCtrl::mFont [private]

StringTableEntry GuiFormCtrl::mCaption [private]

bool GuiFormCtrl::mCanMove [private]

bool GuiFormCtrl::mUseSmallCaption [private]

StringTableEntry GuiFormCtrl::mSmallCaption [private]

StringTableEntry GuiFormCtrl::mContentLibrary [private]

StringTableEntry GuiFormCtrl::mContent [private]

Point2I GuiFormCtrl::mThumbSize [private]

bool GuiFormCtrl::mMouseMovingWin [private]

Point2I GuiFormCtrl::mMouseDownPosition [private]

RectI GuiFormCtrl::mOrigBounds [private]

RectI GuiFormCtrl::mStandardBounds [private]

RectI GuiFormCtrl::mCloseButton [private]

RectI GuiFormCtrl::mMinimizeButton [private]

RectI GuiFormCtrl::mMaximizeButton [private]

bool GuiFormCtrl::mMouseOver [private]

bool GuiFormCtrl::mDepressed [private]