#include <guiScriptNotifyControl.h>

Inheritance diagram for GuiScriptNotifyCtrl:

Public Attributes
Event Callbacks
bool	mOnChildAdded
	Script Notify : onAddObject(object) More...

bool	mOnChildRemoved
	Script Notify : onRemoveObject(object) More...

bool	mOnResize
	Script Notify : onResize() More...

bool	mOnChildResized
	Script Notify : onChildResized(child) More...

bool	mOnParentResized
	Script Notify : onParentResized() More...

bool	mOnLoseFirstResponder
	Script Notify : onLoseFirstResponder() More...

bool	mOnGainFirstResponder

Public Attributes inherited from GuiControl
GuiControlProfile *	mProfile

GuiControlProfile *	mTooltipProfile

S32	mTipHoverTime

S32	mTooltipWidth

bool	mVisible

bool	mActive

bool	mAwake

bool	mSetFirstResponder

bool	mCanSave

bool	mIsContainer
	if true, then the GuiEditor can drag other controls into this one. More...

S32	mLayer

RectI	mBounds

Point2I	mMinExtent

StringTableEntry	mLangTableName

LangTable *	mLangTable

SimObjectPtr< GuiControl >	mFirstResponder

Initialization
	DECLARE_CONOBJECT (GuiScriptNotifyCtrl)

	GuiScriptNotifyCtrl ()

virtual	~GuiScriptNotifyCtrl ()

virtual void	resize (const Point2I &newPosition, const Point2I &newExtent)

virtual void	childResized (GuiScriptNotifyCtrl *child)

virtual void	parentResized (const Point2I &oldParentExtent, const Point2I &newParentExtent)

virtual void	onChildRemoved (GuiControl *child)
	Called when one of this objects children is removed. More...

virtual void	onChildAdded (GuiControl *child)
	Called when this object has a new child. More...

virtual void	setFirstResponder (GuiControl *firstResponder)

virtual void	setFirstResponder ()
	Sets this object to be a first responder. More...

void	clearFirstResponder ()

virtual void	onLoseFirstResponder ()
	Occurs when the first responder for this chain is lost. More...

virtual void	onMessage (GuiScriptNotifyCtrl *sender, S32 msg)
	Receive a message from another control. More...

virtual void	onDialogPush ()
	Called if this object is a dialog, when it is added to the visible layers. More...

virtual void	onDialogPop ()
	Called if this object is a dialog, when it is removed from the visible layers. More...

static void	initPersistFields ()

Additional Inherited Members
Public Types inherited from GuiControl
enum	horizSizingOptions { horizResizeRight = 0, horizResizeWidth, horizResizeLeft, horizResizeCenter, horizResizeRelative }

enum	vertSizingOptions { vertResizeBottom = 0, vertResizeHeight, vertResizeTop, vertResizeCenter, vertResizeRelative }

Public Member Functions inherited from GuiControl
virtual void	getScrollLineSizes (U32 rowHeight, U32 columnWidth)

virtual void	getCursor (GuiCursor *&cursor, bool &showCursor, const GuiEvent &lastGuiEvent)

void	awaken ()
	Called when this control and its children have been wired up. More...

void	sleep ()
	Called when this control is no more. More...

void	preRender ()
	Prerender this control and all its children. More...

virtual bool	onInputEvent (const InputEvent &event)
	General input handler. More...

virtual bool	ControlIsChild (GuiControl *child)

void	setControlProfile (GuiControlProfile *prof)

virtual void	onAction ()
	Occurs when this control performs its "action". More...

void	renderJustifiedText (Point2I offset, Point2I extent, const char *text)

void	inspectPostApply ()

void	inspectPreApply ()

void	setSizing (S32 horz, S32 vert)

void	write (Stream &stream, U32 tabStop, U32 flags)
	Overrides Parent Serialization to allow specific controls to not be saved (Dynamic Controls, etc) More...

bool	getCanSave ()
	Returns boolean specifying if a control can be serialized. More...

void	setCanSave (bool bCanSave)
	Set serialization flag. More...

bool	getCanSaveParent ()
	Returns boolean as to whether any parent of this control has the 'no serialization' flag set. More...

const Point2I &	getPosition ()
	Returns position of the control. More...

const Point2I &	getExtent ()
	Returns extents of the control. More...

const RectI &	getBounds ()
	Returns the bounds of the control. More...

const Point2I &	getMinExtent ()
	Returns minimum size the control can be. More...

const S32	getLeft ()
	Returns the X position of the control. More...

const S32	getTop ()
	Returns the Y position of the control. More...

const S32	getWidth ()
	Returns the width of the control. More...

const S32	getHeight ()
	Returns the height of the control. More...

virtual void	setVisible (bool value)

bool	isVisible ()
	Returns true if the object is visible. More...

void	setActive (bool value)

bool	isActive ()
	Returns true if this control is active. More...

bool	isAwake ()
	Returns true if this control is awake. More...

void	addObject (SimObject *obj)

void	removeObject (SimObject *obj)

GuiControl *	getParent ()
	Returns the control which owns this one. More...

GuiCanvas *	getRoot ()

Point2I	localToGlobalCoord (const Point2I &src)

Point2I	globalToLocalCoord (const Point2I &src)

virtual void	setPosition (const Point2I &newPosition)

virtual void	setExtent (const Point2I &newExtent)

virtual void	setBounds (const RectI &newBounds)

virtual void	setLeft (S32 newLeft)

virtual void	setTop (S32 newTop)

virtual void	setWidth (S32 newWidth)

virtual void	setHeight (S32 newHeight)

virtual void	childResized (GuiControl *child)

virtual void	onRender (Point2I offset, const RectI &updateRect)

virtual bool	renderTooltip (Point2I cursorPos, const char *tipText=NULL)

void	renderChildControls (Point2I offset, const RectI &updateRect)

void	setUpdateRegion (Point2I pos, Point2I ext)

virtual void	setUpdate ()
	Sets the update area of the control to encompass the whole control. More...

virtual bool	onWake ()
	Called when this object is asked to wake up returns true if it's actually awake at the end. More...

virtual void	onSleep ()
	Called when this object is asked to sleep. More...

virtual void	onPreRender ()
	Do special pre-render proecessing. More...

virtual void	onRemove ()
	Called when this object is removed. More...

bool	onAdd ()
	Called when this object is added to the scene. More...

virtual bool	pointInControl (const Point2I &parentCoordPoint)

bool	cursorInControl ()
	Returns true if the global cursor is inside this control. More...

virtual GuiControl *	findHitControl (const Point2I &pt, S32 initialLayer=-1)

void	mouseLock (GuiControl *lockingControl)

void	mouseLock ()
	Turn on mouse locking with last used lock control. More...

void	mouseUnlock ()
	Unlock the mouse. More...

bool	isMouseLocked ()
	Returns true if the mouse is locked. More...

virtual void	onMouseUp (const GuiEvent &event)

virtual void	onMouseDown (const GuiEvent &event)

virtual void	onMouseMove (const GuiEvent &event)

virtual void	onMouseDragged (const GuiEvent &event)

virtual void	onMouseEnter (const GuiEvent &event)

virtual void	onMouseLeave (const GuiEvent &event)

virtual bool	onMouseWheelUp (const GuiEvent &event)

virtual bool	onMouseWheelDown (const GuiEvent &event)

virtual void	onRightMouseDown (const GuiEvent &event)

virtual void	onRightMouseUp (const GuiEvent &event)

virtual void	onRightMouseDragged (const GuiEvent &event)

virtual void	onMiddleMouseDown (const GuiEvent &event)

virtual void	onMiddleMouseUp (const GuiEvent &event)

virtual void	onMiddleMouseDragged (const GuiEvent &event)

virtual bool	onMouseDownEditor (const GuiEvent &event, Point2I offset)

virtual bool	onMouseUpEditor (const GuiEvent &event, Point2I offset)

virtual bool	onRightMouseDownEditor (const GuiEvent &event, Point2I offset)

virtual bool	onMouseDraggedEditor (const GuiEvent &event, Point2I offset)

virtual GuiControl *	findFirstTabable ()
	Find the first tab-accessable child of this control. More...

virtual GuiControl *	findLastTabable (bool firstCall=true)

virtual GuiControl *	findPrevTabable (GuiControl *curResponder, bool firstCall=true)

virtual GuiControl *	findNextTabable (GuiControl *curResponder, bool firstCall=true)

virtual void	makeFirstResponder (bool value)

bool	isFirstResponder ()
	Returns true if this control is a first responder. More...

void	clearFirstResponder ()
	Clears the first responder for this chain. More...

GuiControl *	getFirstResponder ()
	Returns the first responder for this chain. More...

void	addAcceleratorKey ()
	Adds the accelerator key for this object to the canvas. More...

virtual void	buildAcceleratorMap ()

virtual void	acceleratorKeyPress (U32 index)

virtual void	acceleratorKeyRelease (U32 index)

virtual bool	onKeyDown (const GuiEvent &event)

virtual bool	onKeyUp (const GuiEvent &event)

virtual bool	onKeyRepeat (const GuiEvent &event)

void	messageSiblings (S32 message)
	Send a message to all siblings. More...

virtual void	onMessage (GuiControl *sender, S32 msg)

void	setConsoleVariable (const char *variable)

void	setConsoleCommand (const char *newCmd)

const char *	getConsoleCommand ()
	Returns the name of the function bound to this GuiControl. More...

LangTable *	getGUILangTable (void)

const UTF8 *	getGUIString (S32 id)

virtual const char *	getScriptValue ()
	Returns the value of the variable bound to this object. More...

virtual void	setScriptValue (const char *value)
	Sets the value of the variable bound to this object. More...

	DECLARE_CONOBJECT (GuiControl)

	GuiControl ()

virtual	~GuiControl ()

Static Public Member Functions inherited from GuiControl
static void	initPersistFields ()

Static Public Member Functions inherited from SimObject
static void	initPersistFields ()

Static Public Attributes inherited from GuiControl
static GuiEditCtrl *	smEditorHandle = NULL

static S32	smCursorChanged = -1
	Has this control modified the cursor? -1 or type. More...

static bool	smDesignTime = false

static GuiControl *	smPrevResponder = NULL

static GuiControl *	smCurResponder = NULL

Protected Types inherited from SimObject
enum	SimObjectNSLinkType { LinkClassName = BIT(0), LinkSuperClassName = BIT(1) }

Protected Member Functions inherited from GuiControl
const char *	execConsoleCallback ()
	Executes mConsoleCommand, and returns the result. More...

const char *	execAltConsoleCallback ()
	Executes mAltConsoleCommand, and returns the result. More...

void	setVariable (const char *value)

void	setIntVariable (S32 value)

void	setFloatVariable (F32 value)

const char *	getVariable ()
	Returns value of control's bound variable as a string. More...

S32	getIntVariable ()
	Returns value of control's bound variable as a integer. More...

F32	getFloatVariable ()
	Returns value of control's bound variable as a float. More...

Static Protected Member Functions inherited from SimObject
static bool	setClass (void obj, const char data)

static bool	setSuperClass (void obj, const char data)

static bool	writeCanSaveDynamicFields (void *obj, StringTableEntry pFieldName)

static bool	writeInternalName (void *obj, StringTableEntry pFieldName)

static bool	setParentGroup (void obj, const char data)

static bool	writeParentGroup (void *obj, StringTableEntry pFieldName)

static bool	writeSuperclass (void *obj, StringTableEntry pFieldName)

static bool	writeClass (void *obj, StringTableEntry pFieldName)

static SimObject::Notify *	allocNotify ()
	Get a free Notify structure. More...

static void	freeNotify (SimObject::Notify *)
	Mark a Notify structure as free. More...

Protected Attributes inherited from GuiControl
S32	mHorizSizing
	Set from horizSizingOptions. More...

S32	mVertSizing
	Set from vertSizingOptions. More...

StringTableEntry	mConsoleVariable

StringTableEntry	mConsoleCommand

StringTableEntry	mAltConsoleCommand

StringTableEntry	mAcceleratorKey

StringTableEntry	mTooltip

Protected Attributes inherited from SimSet
SimObjectList	objectList

void *	mMutex

Static Protected Attributes inherited from SimObject
static SimObject::Notify *	mNotifyFreeList = NULL

Constructor & Destructor Documentation

GuiScriptNotifyCtrl ( )

~GuiScriptNotifyCtrl ( )

virtual

Member Function Documentation

void childResized ( GuiScriptNotifyCtrl * child )

virtual

void clearFirstResponder ( )

DECLARE_CONOBJECT ( GuiScriptNotifyCtrl )

void initPersistFields ( void )

static

void onChildAdded ( GuiControl * child )

virtual

Called when this object has a new child.

Reimplemented from GuiControl.

void onChildRemoved ( GuiControl * child )

virtual

Called when one of this objects children is removed.

Reimplemented from GuiControl.

void onDialogPop ( )

virtual

Called if this object is a dialog, when it is removed from the visible layers.

Reimplemented from GuiControl.

void onDialogPush ( )

virtual

Called if this object is a dialog, when it is added to the visible layers.

Reimplemented from GuiControl.

void onLoseFirstResponder ( )

virtual

Occurs when the first responder for this chain is lost.

Reimplemented from GuiControl.

void onMessage	(	GuiScriptNotifyCtrl *	sender,
		S32	msg
	)

virtual

Receive a message from another control.

void parentResized	(	const Point2I &	oldParentExtent,
		const Point2I &	newParentExtent
	)

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.

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

void setFirstResponder ( GuiControl * firstResponder )

virtual

Sets the first responder for child controls

Parameters

firstResponder First responder for this chain

Reimplemented from GuiControl.

void setFirstResponder ( )

virtual

Sets this object to be a first responder.

Reimplemented from GuiControl.

Member Data Documentation

bool mOnChildAdded

Script Notify : onAddObject(object)

bool mOnChildRemoved

Script Notify : onRemoveObject(object)

bool mOnChildResized

Script Notify : onChildResized(child)

bool mOnGainFirstResponder

Script Notify : onGainFirstResponder()

bool mOnLoseFirstResponder

Script Notify : onLoseFirstResponder()

bool mOnParentResized

Script Notify : onParentResized()

bool mOnResize

Script Notify : onResize()

The documentation for this class was generated from the following files:

gui/guiScriptNotifyControl.h
gui/guiScriptNotifyControl.cc

Public Attributes

Initialization

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation