GuiScriptNotifyCtrl Class Reference

#include <guiScriptNotifyControl.h>

Inheritance diagram for GuiScriptNotifyCtrl:

Inheritance graph
[legend]
List of all members.

Initialization

 DECLARE_CONOBJECT (GuiScriptNotifyCtrl)
 GuiScriptNotifyCtrl ()
virtual ~GuiScriptNotifyCtrl ()
virtual bool resize (const Point2I &newPosition, const Point2I &newExtent)
 Changes the size and/or position of this control.
virtual void childResized (GuiScriptNotifyCtrl *child)
virtual void parentResized (const RectI &oldParentRect, const RectI &newParentRect)
 Called when this objects parent is resized.
virtual void onChildRemoved (GuiControl *child)
 Called when one of this objects children is removed.
virtual void onChildAdded (GuiControl *child)
 Called when this object has a new child.
virtual void setFirstResponder (GuiControl *firstResponder)
 Sets the first responder for child controls.
virtual void setFirstResponder ()
 Sets this object to be a first responder.
void clearFirstResponder ()
 Clears the first responder for this chain.
virtual void onLoseFirstResponder ()
 Occurs when the first responder for this chain is lost.
virtual void onMessage (GuiScriptNotifyCtrl *sender, S32 msg)
 Receive a message from another control.
virtual void onDialogPush ()
 Called if this object is a dialog, when it is added to the visible layers.
virtual void onDialogPop ()
 Called if this object is a dialog, when it is removed from the visible layers.
static void initPersistFields ()
 Register dynamic fields in a subclass of ConsoleObject.

Public Attributes

Event Callbacks
bool mOnChildAdded
 Script Notify : onAddObject(object).
bool mOnChildRemoved
 Script Notify : onRemoveObject(object).
bool mOnResize
 Script Notify : onResize().
bool mOnChildResized
 Script Notify : onChildResized(child).
bool mOnParentResized
 Script Notify : onParentResized().
bool mOnLoseFirstResponder
 Script Notify : onLoseFirstResponder().
bool mOnGainFirstResponder
 Script Notify : onGainFirstResponder().

Private Types

typedef GuiControl Parent

Member Typedef Documentation

Reimplemented from GuiControl.


Constructor & Destructor Documentation

GuiScriptNotifyCtrl::GuiScriptNotifyCtrl (  ) 

virtual GuiScriptNotifyCtrl::~GuiScriptNotifyCtrl (  )  [virtual]


Member Function Documentation

GuiScriptNotifyCtrl::DECLARE_CONOBJECT ( GuiScriptNotifyCtrl   ) 

static void GuiScriptNotifyCtrl::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

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

Reimplemented from GuiControl.

virtual bool GuiScriptNotifyCtrl::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.

virtual void GuiScriptNotifyCtrl::childResized ( GuiScriptNotifyCtrl child  )  [virtual]

virtual void GuiScriptNotifyCtrl::parentResized ( const RectI oldParentRect,
const RectI newParentRect 
) [virtual]

Called when this objects parent is resized.

Parameters:
oldParentRect The old rectangle of the parent object
newParentRect The new rectangle of the parent object

Reimplemented from GuiControl.

virtual void GuiScriptNotifyCtrl::onChildRemoved ( GuiControl child  )  [virtual]

Called when one of this objects children is removed.

Reimplemented from GuiControl.

virtual void GuiScriptNotifyCtrl::onChildAdded ( GuiControl child  )  [virtual]

Called when this object has a new child.

Reimplemented from GuiControl.

virtual void GuiScriptNotifyCtrl::setFirstResponder ( GuiControl firstResponder  )  [virtual]

Sets the first responder for child controls.

Parameters:
firstResponder First responder for this chain

Reimplemented from GuiControl.

virtual void GuiScriptNotifyCtrl::setFirstResponder (  )  [virtual]

Sets this object to be a first responder.

Reimplemented from GuiControl.

void GuiScriptNotifyCtrl::clearFirstResponder (  ) 

Clears the first responder for this chain.

Reimplemented from GuiControl.

virtual void GuiScriptNotifyCtrl::onLoseFirstResponder (  )  [virtual]

Occurs when the first responder for this chain is lost.

Reimplemented from GuiControl.

virtual void GuiScriptNotifyCtrl::onMessage ( GuiScriptNotifyCtrl sender,
S32  msg 
) [virtual]

Receive a message from another control.

virtual void GuiScriptNotifyCtrl::onDialogPush (  )  [virtual]

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

Reimplemented from GuiControl.

virtual void GuiScriptNotifyCtrl::onDialogPop (  )  [virtual]

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

Reimplemented from GuiControl.


Member Data Documentation

Script Notify : onAddObject(object).

Script Notify : onRemoveObject(object).

Script Notify : onResize().

Script Notify : onChildResized(child).

Script Notify : onParentResized().

Script Notify : onGainFirstResponder().