Torque Game Engine Documentation
TGE Version 1.5.2

GuiEditCtrl Class Reference

#include <guiEditCtrl.h>

Inheritance diagram for GuiEditCtrl:


Public Types
enum	Justification { JUSTIFY_LEFT, JUSTIFY_CENTER, JUSTIFY_RIGHT, JUSTIFY_TOP, JUSTIFY_BOTTOM, SPACING_VERTICAL, SPACING_HORIZONTAL }
Public Member Functions
	GuiEditCtrl ()
	DECLARE_CONOBJECT (GuiEditCtrl)
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.
void	select (GuiControl *ctrl)
void	setRoot (GuiControl *ctrl)
void	setEditMode (bool value)
S32	getSizingHitKnobs (const Point2I &pt, const RectI &box)
void	getDragRect (RectI &b)
void	drawNut (const Point2I &nut, ColorI &outlineColor, ColorI &nutColor)
void	drawNuts (RectI &box, ColorI &outlineColor, ColorI &nutColor)
void	onPreRender ()
	Do special pre-render proecessing.
void	onRender (Point2I offset, const RectI &updateRect)
	Called when this control is to render itself.
void	addNewControl (GuiControl *ctrl)
bool	selectionContains (GuiControl *ctrl)
void	setCurrentAddSet (GuiControl *ctrl)
void	setSelection (GuiControl *ctrl, bool inclusive=false)
bool	initCursors ()
void	getCursor (GuiCursor *&cursor, bool &showCursor, const GuiEvent &lastGuiEvent)
	Get information about the cursor.
const Vector< GuiControl * > *	getSelected () const
const GuiControl *	getAddSet () const
bool	onKeyDown (const GuiEvent &event)
	Happens when a key is depressed.
void	onMouseDown (const GuiEvent &event)
void	onMouseUp (const GuiEvent &event)
void	onMouseDragged (const GuiEvent &event)
void	onRightMouseDown (const GuiEvent &event)
void	justifySelection (Justification j)
void	moveSelection (const Point2I &delta)
void	saveSelection (const char *filename)
void	loadSelection (const char *filename)
void	addSelection (S32 id)
void	removeSelection (S32 id)
void	deleteSelection ()
void	clearSelection ()
void	selectAll ()
void	bringToFront ()
void	pushToBack ()
Private Types
enum	mouseModes { Selecting, MovingSelection, SizingSelection, DragSelecting }
enum	sizingModes { sizingNone = 0, sizingLeft = 1, sizingRight = 2, sizingTop = 4, sizingBottom = 8 }
typedef GuiControl	Parent
Private Attributes
Vector< GuiControl * >	mSelectedControls
GuiControl *	mCurrentAddSet
GuiControl *	mContentControl
Point2I	mLastMousePos
Point2I	mSelectionAnchor
Point2I	mGridSnap
Point2I	mDragBeginPoint
Vector< Point2I >	mDragBeginPoints
GuiCursor *	mDefaultCursor
GuiCursor *	mLeftRightCursor
GuiCursor *	mUpDownCursor
GuiCursor *	mNWSECursor
GuiCursor *	mNESWCursor
GuiCursor *	mMoveCursor
mouseModes	mMouseDownMode
sizingModes	mSizingMode

Member Typedef Documentation

typedef GuiControl GuiEditCtrl::Parent [private]

Reimplemented from GuiControl.

Member Enumeration Documentation

enum GuiEditCtrl::mouseModes [private]

Enumerator:

Selecting
MovingSelection
SizingSelection
DragSelecting

enum GuiEditCtrl::sizingModes [private]

Enumerator:

sizingNone
sizingLeft
sizingRight
sizingTop
sizingBottom

enum GuiEditCtrl::Justification

Enumerator:

JUSTIFY_LEFT
JUSTIFY_CENTER
JUSTIFY_RIGHT
JUSTIFY_TOP
JUSTIFY_BOTTOM
SPACING_VERTICAL
SPACING_HORIZONTAL

Constructor & Destructor Documentation

GuiEditCtrl::GuiEditCtrl ( )

Member Function Documentation

GuiEditCtrl::DECLARE_CONOBJECT ( GuiEditCtrl )

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

Called when this object is asked to sleep.

Reimplemented from GuiControl.

void GuiEditCtrl::select ( GuiControl * ctrl )

void GuiEditCtrl::setRoot ( GuiControl * ctrl )

void GuiEditCtrl::setEditMode ( bool value )

S32 GuiEditCtrl::getSizingHitKnobs	(	const Point2I &	pt,
		const RectI &	box
	)

void GuiEditCtrl::getDragRect ( RectI & b )

void GuiEditCtrl::drawNut	(	const Point2I &	nut,
		ColorI &	outlineColor,
		ColorI &	nutColor
	)

void GuiEditCtrl::drawNuts	(	RectI &	box,
		ColorI &	outlineColor,
		ColorI &	nutColor
	)

void GuiEditCtrl::onPreRender ( ) [virtual]

Do special pre-render proecessing.

Reimplemented from GuiControl.

void GuiEditCtrl::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.

void GuiEditCtrl::addNewControl ( GuiControl * ctrl )

bool GuiEditCtrl::selectionContains ( GuiControl * ctrl )

void GuiEditCtrl::setCurrentAddSet ( GuiControl * ctrl )

void GuiEditCtrl::setSelection	(	GuiControl *	ctrl,
		bool	inclusive = `false`
	)

bool GuiEditCtrl::initCursors ( )

void GuiEditCtrl::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.

const Vector<GuiControl *>* GuiEditCtrl::getSelected ( ) const [inline]