Torque Game Engine Documentation
TGE Version 1.5.2

GuiMLTextCtrl Class Reference

#include <guiMLTextCtrl.h>

Inheritance diagram for GuiMLTextCtrl:


Public Types
enum	Justification { LeftJustify, RightJustify, CenterJustify }
Public Member Functions
	GuiMLTextCtrl ()
	~GuiMLTextCtrl ()
U32	getNumChars () const
U32	getText (char *pBuffer, const U32 bufferSize) const
U32	getWrappedText (char *pBuffer, const U32 bufferSize) const
const char *	getTextContent ()
void	insertChars (const char *inputChars, const U32 numInputChars, const U32 position)
void	setText (const char *textBuffer, const U32 numChars)
void	addText (const char *textBuffer, const U32 numChars, bool reformat)
void	setAlpha (F32 alpha)
bool	setCursorPosition (const S32)
void	ensureCursorOnScreen ()
void	scrollToTag (U32 id)
void	scrollToTop ()
void	scrollToBottom ()
virtual void	reflow ()
	DECLARE_CONOBJECT (GuiMLTextCtrl)
void	setScriptValue (const char *value)
	Sets the value of the variable bound to this object.
const char *	getScriptValue ()
	Returns the value of the variable bound to this object.
void	setSelectionStart (U32 start)
void	setSelectionEnd (U32 end)
void	setSelectionActive (bool active)
S32	getCursorPosition ()
Static Public Member Functions
static void	initPersistFields ()
	Register dynamic fields in a subclass of ConsoleObject.
static char *	stripControlChars (const char *inString)
Protected Member Functions
void	freeLineBuffers ()
void	freeResources ()
Bitmap *	allocBitmap (const char *bitmapName, U32 bitmapNameLen)
Font *	allocFont (const char *faceName, U32 faceNameLen, U32 size)
LineTag *	allocLineTag (U32 id)
void	emitNewLine (U32 textStart)
Atom *	buildTextAtom (U32 start, U32 len, U32 left, U32 right, URL *url)
void	emitTextToken (U32 textStart, U32 len)
void	emitBitmapToken (Bitmap *bmp, U32 textStart, bool bitmapBreak)
void	processEmitAtoms ()
Atom *	splitAtomListEmit (Atom *list, U32 width)
void	drawAtomText (bool sel, U32 start, U32 end, Atom atom, Line line, Point2I offset)
Atom *	findHitAtom (const Point2I localCoords)
Style *	allocStyle (Style *style)
void	deleteChars (const U32 rangeStart, const U32 rangeEnd)
void	copyToClipboard (const U32 rangeStart, const U32 rangeEnd)
bool	isSelectionActive () const
void	clearSelection ()
S32	getTextPosition (const Point2I &localPosition)
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.
void	onPreRender ()
	Do special pre-render proecessing.
void	onRender (Point2I offset, const RectI &updateRect)
	Called when this control is to render itself.
void	getCursorPositionAndColor (Point2I &cursorTop, Point2I &cursorBottom, ColorI &color)
void	inspectPostApply ()
	Called after any property of the object is changed in the world editor.
void	resize (const Point2I &newPosition, const Point2I &newExtent)
	Changes the size and/or position of this control.
void	parentResized (const Point2I &oldParentExtent, const Point2I &newParentExtent)
	Called when this objects parent is resized.
bool	onKeyDown (const GuiEvent &event)
	Happens when a key is depressed.
void	onMouseDown (const GuiEvent &)
void	onMouseDragged (const GuiEvent &)
void	onMouseUp (const GuiEvent &)
Protected Attributes
bool	mIsEditCtrl
U32 *	mTabStops
U32	mTabStopCount
U32	mCurTabStop
F32	mAlpha
DataChunker	mViewChunker
DataChunker	mResourceChunker
Line *	mLineList
Bitmap *	mBitmapList
BitmapRef *	mBitmapRefList
Font *	mFontList
LineTag *	mTagList
bool	mDirty
Style *	mCurStyle
U32	mCurLMargin
U32	mCurRMargin
U32	mCurJustify
U32	mCurDiv
U32	mCurY
U32	mCurClipX
Atom *	mLineAtoms
Atom **	mLineAtomPtr
Atom *	mEmitAtoms
Atom **	mEmitAtomPtr
BitmapRef	mSentinel
Line **	mLineInsert
BitmapRef *	mBlockList
U32	mScanPos
U32	mCurX
U32	mMaxY
URL *	mCurURL
URL *	mHitURL
U32	mCursorPosition
StringBuffer	mTextBuffer
U32	mLineStart
S32	mMaxBufferSize
StringTableEntry	mInitialText
bool	mSelectionActive
U32	mSelectionStart
U32	mSelectionEnd
U32	mVertMoveAnchor
bool	mVertMoveAnchorValid
S32	mSelectionAnchor
Point2I	mSelectionAnchorDropped
Resource< GFont >	mFont
U32	mMinSensibleWidth
U32	mLineSpacingPixels
bool	mAllowColorChars
AudioProfile *	mDeniedSound
Static Protected Attributes
static const U32	csmTextBufferGrowthSize
Private Types
typedef GuiControl	Parent
Data Structures
struct	Atom
struct	Bitmap
struct	BitmapRef
struct	Font
struct	Line
struct	LineTag
struct	Style
struct	URL

Member Typedef Documentation

typedef GuiControl GuiMLTextCtrl::Parent [private]

Reimplemented from GuiControl.

Reimplemented in GuiMLTextEditCtrl.

Member Enumeration Documentation

enum GuiMLTextCtrl::Justification

Enumerator:

LeftJustify
RightJustify
CenterJustify

Constructor & Destructor Documentation

GuiMLTextCtrl::GuiMLTextCtrl ( )

GuiMLTextCtrl::~GuiMLTextCtrl ( )

Member Function Documentation

U32 GuiMLTextCtrl::getNumChars ( ) const

U32 GuiMLTextCtrl::getText	(	char *	pBuffer,
		const U32	bufferSize
	)			const

U32 GuiMLTextCtrl::getWrappedText	(	char *	pBuffer,
		const U32	bufferSize
	)			const

const char* GuiMLTextCtrl::getTextContent ( )

void GuiMLTextCtrl::insertChars	(	const char *	inputChars,
		const U32	numInputChars,
		const U32	position
	)

void GuiMLTextCtrl::setText	(	const char *	textBuffer,
		const U32	numChars
	)

void GuiMLTextCtrl::addText	(	const char *	textBuffer,
		const U32	numChars,
		bool	reformat
	)

void GuiMLTextCtrl::setAlpha ( F32 alpha ) [inline]

bool GuiMLTextCtrl::setCursorPosition ( const S32 )

void GuiMLTextCtrl::ensureCursorOnScreen ( )

void GuiMLTextCtrl::scrollToTag ( U32 id )

void GuiMLTextCtrl::scrollToTop ( )

void GuiMLTextCtrl::scrollToBottom ( )

virtual void GuiMLTextCtrl::reflow ( ) [virtual]

GuiMLTextCtrl::DECLARE_CONOBJECT ( GuiMLTextCtrl )

static void GuiMLTextCtrl::initPersistFields ( ) [static]

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

Reimplemented from GuiControl.

Reimplemented in GuiMLTextEditCtrl.

void GuiMLTextCtrl::setScriptValue ( const char * value ) [virtual]

Sets the value of the variable bound to this object.

Reimplemented from GuiControl.

const char* GuiMLTextCtrl::getScriptValue ( ) [virtual]

Returns the value of the variable bound to this object.

Reimplemented from GuiControl.

static char* GuiMLTextCtrl::stripControlChars ( const char * inString ) [static]

void GuiMLTextCtrl::freeLineBuffers ( ) [protected]

void GuiMLTextCtrl::freeResources ( ) [protected]

Bitmap* GuiMLTextCtrl::allocBitmap	(	const char *	bitmapName,
		U32	bitmapNameLen
	)			`[protected]`

Font* GuiMLTextCtrl::allocFont	(	const char *	faceName,
		U32	faceNameLen,
		U32	size
	)			`[protected]`

LineTag* GuiMLTextCtrl::allocLineTag ( U32 id ) [protected]

void GuiMLTextCtrl::emitNewLine ( U32 textStart ) [protected]

Atom* GuiMLTextCtrl::buildTextAtom	(	U32	start,
		U32	len,
		U32	left,
		U32	right,
		URL *	url
	)			`[protected]`

void GuiMLTextCtrl::emitTextToken	(	U32	textStart,
		U32	len
	)			`[protected]`

void GuiMLTextCtrl::emitBitmapToken	(	Bitmap *	bmp,
		U32	textStart,
		bool	bitmapBreak
	)			`[protected]`

void GuiMLTextCtrl::processEmitAtoms ( ) [protected]

Atom* GuiMLTextCtrl::splitAtomListEmit	(	Atom *	list,
		U32	width
	)			`[protected]`

void GuiMLTextCtrl::drawAtomText	(	bool	sel,
		U32	start,
		U32	end,
		Atom *	atom,
		Line *	line,
		Point2I	offset
	)			`[protected]`

Atom* GuiMLTextCtrl::findHitAtom ( const Point2I localCoords ) [protected]

Style* GuiMLTextCtrl::allocStyle ( Style * style ) [protected]

void GuiMLTextCtrl::deleteChars	(	const U32	rangeStart,
		const U32	rangeEnd
	)			`[protected]`

void GuiMLTextCtrl::copyToClipboard	(	const U32	rangeStart,
		const U32	rangeEnd
	)			`[protected]`

bool GuiMLTextCtrl::isSelectionActive ( ) const [protected]

void GuiMLTextCtrl::clearSelection ( ) [protected]

S32 GuiMLTextCtrl::getTextPosition ( const Point2I & localPosition ) [protected]

bool GuiMLTextCtrl::onAdd ( ) [protected, virtual]

Called when this object is added to the scene.

Reimplemented from GuiControl.

bool GuiMLTextCtrl::onWake ( ) [protected, virtual]

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

Reimplemented from GuiControl.

void GuiMLTextCtrl::onSleep ( ) [protected, virtual]

Called when this object is asked to sleep.

Reimplemented from GuiControl.

void GuiMLTextCtrl::onPreRender ( ) [protected, virtual]

Do special pre-render proecessing.

Reimplemented from GuiControl.

void GuiMLTextCtrl::onRender	(	Point2I	offset,
		const RectI &	updateRect
	)			`[protected, 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.

Reimplemented in GuiMLTextEditCtrl.

void GuiMLTextCtrl::getCursorPositionAndColor	(	Point2I &	cursorTop,
		Point2I &	cursorBottom,
		ColorI &	color
	)			`[protected]`

void GuiMLTextCtrl::inspectPostApply ( ) [protected, virtual]

Called after any property of the object is changed in the world editor.

See also:: inspectPreApply

Reimplemented from GuiControl.

void GuiMLTextCtrl::resize	(	const Point2I &	newPosition,
		const Point2I &	newExtent
	)			`[protected, 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.

Reimplemented in GuiMLTextEditCtrl.

void GuiMLTextCtrl::parentResized	(	const Point2I &	oldParentExtent,
		const Point2I &	newParentExtent
	)			`[protected, virtual]`

Called when this objects parent is resized.

Parameters:

	oldParentExtent	The old size of the parent object
	newParentExtent	The new size of the parent object

Reimplemented from GuiControl.

bool GuiMLTextCtrl::onKeyDown ( const GuiEvent & event ) [protected, virtual]

Happens when a key is depressed.

Parameters:

event

Event descriptor (which contains the key)

Reimplemented from GuiControl.

Reimplemented in GuiMLTextEditCtrl.

void GuiMLTextCtrl::onMouseDown ( const GuiEvent & ) [protected, virtual]

Reimplemented from GuiControl.

void GuiMLTextCtrl::onMouseDragged ( const GuiEvent & ) [protected, virtual]

Reimplemented from GuiControl.

void GuiMLTextCtrl::onMouseUp ( const GuiEvent & ) [protected, virtual]

Reimplemented from GuiControl.

void GuiMLTextCtrl::setSelectionStart ( U32 start ) [inline]

void GuiMLTextCtrl::setSelectionEnd ( U32 end ) [inline]

void GuiMLTextCtrl::setSelectionActive ( bool active ) [inline]

S32 GuiMLTextCtrl::getCursorPosition ( ) [inline]

Field Documentation

bool GuiMLTextCtrl::mIsEditCtrl [protected]

U32* GuiMLTextCtrl::mTabStops [protected]

U32 GuiMLTextCtrl::mTabStopCount [protected]

U32 GuiMLTextCtrl::mCurTabStop [protected]

F32 GuiMLTextCtrl::mAlpha [protected]

DataChunker GuiMLTextCtrl::mViewChunker [protected]

DataChunker GuiMLTextCtrl::mResourceChunker [protected]

Line* GuiMLTextCtrl::mLineList [protected]

Bitmap* GuiMLTextCtrl::mBitmapList [protected]

BitmapRef* GuiMLTextCtrl::mBitmapRefList [protected]

Font* GuiMLTextCtrl::mFontList [protected]

LineTag* GuiMLTextCtrl::mTagList [protected]

bool GuiMLTextCtrl::mDirty [protected]

Style* GuiMLTextCtrl::mCurStyle [protected]

U32 GuiMLTextCtrl::mCurLMargin [protected]

U32 GuiMLTextCtrl::mCurRMargin [protected]

U32 GuiMLTextCtrl::mCurJustify [protected]

U32 GuiMLTextCtrl::mCurDiv [protected]

U32 GuiMLTextCtrl::mCurY [protected]

U32 GuiMLTextCtrl::mCurClipX [protected]

Atom* GuiMLTextCtrl::mLineAtoms [protected]

Atom** GuiMLTextCtrl::mLineAtomPtr [protected]

Atom* GuiMLTextCtrl::mEmitAtoms [protected]

Atom** GuiMLTextCtrl::mEmitAtomPtr [protected]

BitmapRef GuiMLTextCtrl::mSentinel [protected]

Line** GuiMLTextCtrl::mLineInsert [protected]

BitmapRef* GuiMLTextCtrl::mBlockList [protected]

U32 GuiMLTextCtrl::mScanPos [protected]

U32 GuiMLTextCtrl::mCurX [protected]

U32 GuiMLTextCtrl::mMaxY [protected]

URL* GuiMLTextCtrl::mCurURL [protected]

URL* GuiMLTextCtrl::mHitURL [protected]

const U32 GuiMLTextCtrl::csmTextBufferGrowthSize [static, protected]

U32 GuiMLTextCtrl::mCursorPosition [protected]

StringBuffer GuiMLTextCtrl::mTextBuffer [protected]

U32 GuiMLTextCtrl::mLineStart [protected]

S32 GuiMLTextCtrl::mMaxBufferSize [protected]

StringTableEntry GuiMLTextCtrl::mInitialText [protected]

bool GuiMLTextCtrl::mSelectionActive [protected]

U32 GuiMLTextCtrl::mSelectionStart [protected]

U32 GuiMLTextCtrl::mSelectionEnd [protected]

U32 GuiMLTextCtrl::mVertMoveAnchor [protected]

bool GuiMLTextCtrl::mVertMoveAnchorValid [protected]

S32 GuiMLTextCtrl::mSelectionAnchor [protected]

Point2I GuiMLTextCtrl::mSelectionAnchorDropped [protected]

Resource<GFont> GuiMLTextCtrl::mFont [protected]

U32 GuiMLTextCtrl::mMinSensibleWidth [protected]

U32 GuiMLTextCtrl::mLineSpacingPixels [protected]

bool GuiMLTextCtrl::mAllowColorChars [protected]

AudioProfile* GuiMLTextCtrl::mDeniedSound [protected]

GuiMLTextCtrl Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Data Structures

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation