Torque Game Engine Documentation
TGE Version 1.5.2

GuiWindowCtrl Class Reference

#include <guiWindowCtrl.h>

Inheritance diagram for GuiWindowCtrl:


Public Member Functions
	GuiWindowCtrl ()
	DECLARE_CONOBJECT (GuiWindowCtrl)
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.
bool	isMinimized (S32 &index)
bool	initCursors ()
void	getCursor (GuiCursor *&cursor, bool &showCursor, const GuiEvent &lastGuiEvent)
	Get information about the cursor.
void	setFont (S32 fntTag)
GuiControl *	findHitControl (const Point2I &pt, S32 initialLayer=-1)
	Returns the control which the provided point is under, with layering.
void	resize (const Point2I &newPosition, const Point2I &newExtent)
	Changes the size and/or position of this control.
void	onMouseDown (const GuiEvent &event)
void	onMouseDragged (const GuiEvent &event)
void	onMouseUp (const GuiEvent &event)
GuiControl *	findNextTabable (GuiControl *curResponder, bool firstCall=true)
	Find next tab-accessable control with regards to the provided control.
GuiControl *	findPrevTabable (GuiControl *curResponder, bool firstCall=true)
	Find previous tab-accessable control with respect to the provided one.
bool	onKeyDown (const GuiEvent &event)
	Happens when a key is depressed.
S32	getTabIndex (void)
void	selectWindow (void)
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 Types
enum	BitmapIndices { BmpClose, BmpMaximize, BmpNormal, BmpMinimize, BmpCount }
enum	{ BorderTopLeftKey = 12, BorderTopRightKey, BorderTopKey, BorderTopLeftNoKey, BorderTopRightNoKey, BorderTopNoKey, BorderLeft, BorderRight, BorderBottomLeft, BorderBottom, BorderBottomRight, NumBitmaps }
enum	BitmapStates { BmpDefault = 0, BmpHilite, BmpDisabled, BmpStates }
Protected Member Functions
void	drawWinRect (const RectI &myRect)
Protected Attributes
RectI *	mBitmapBounds
TextureHandle	mTextureHandle
Private Types
typedef GuiTextCtrl	Parent
Private Member Functions
void	PositionButtons (void)
Private Attributes
bool	mResizeWidth
bool	mResizeHeight
bool	mCanMove
bool	mCanClose
bool	mCanMinimize
bool	mCanMaximize
bool	mPressClose
bool	mPressMinimize
bool	mPressMaximize
Point2I	mMinSize
GuiCursor *	mDefaultCursor
GuiCursor *	mLeftRightCursor
GuiCursor *	mUpDownCursor
GuiCursor *	mNWSECursor
GuiCursor *	mNESWCursor
StringTableEntry	mCloseCommand
S32	mTitleHeight
S32	mResizeRightWidth
S32	mResizeBottomHeight
bool	mMouseMovingWin
bool	mMouseResizeWidth
bool	mMouseResizeHeight
bool	mMinimized
bool	mMaximized
Point2I	mMouseDownPosition
RectI	mOrigBounds
RectI	mStandardBounds
RectI	mCloseButton
RectI	mMinimizeButton
RectI	mMaximizeButton
S32	mMinimizeIndex
S32	mTabIndex

Member Typedef Documentation

typedef GuiTextCtrl GuiWindowCtrl::Parent [private]

Reimplemented from GuiTextCtrl.

Member Enumeration Documentation

enum GuiWindowCtrl::BitmapIndices [protected]

Enumerator:

BmpClose
BmpMaximize
BmpNormal
BmpMinimize
BmpCount

anonymous enum [protected]

Enumerator:

BorderTopLeftKey
BorderTopRightKey
BorderTopKey
BorderTopLeftNoKey
BorderTopRightNoKey
BorderTopNoKey
BorderLeft
BorderRight
BorderBottomLeft
BorderBottom
BorderBottomRight
NumBitmaps

enum GuiWindowCtrl::BitmapStates [protected]

Enumerator:

BmpDefault
BmpHilite
BmpDisabled
BmpStates

Constructor & Destructor Documentation

GuiWindowCtrl::GuiWindowCtrl ( )

Member Function Documentation

void GuiWindowCtrl::PositionButtons ( void ) [private]

void GuiWindowCtrl::drawWinRect ( const RectI & myRect ) [protected]

GuiWindowCtrl::DECLARE_CONOBJECT ( GuiWindowCtrl )

static void GuiWindowCtrl::initPersistFields ( ) [static]

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

Reimplemented from GuiTextCtrl.

bool GuiWindowCtrl::onWake ( ) [virtual]

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

Reimplemented from GuiTextCtrl.

void GuiWindowCtrl::onSleep ( ) [virtual]

Called when this object is asked to sleep.

Reimplemented from GuiTextCtrl.

bool GuiWindowCtrl::isMinimized ( S32 & index )

bool GuiWindowCtrl::initCursors ( )

void GuiWindowCtrl::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 modifyer keys (ie ctrl, shift, alt etc)

Reimplemented from GuiControl.

void GuiWindowCtrl::setFont ( S32 fntTag )