Torque3D Documentation / _generateds / GuiScriptNotifyCtrl

GuiScriptNotifyCtrl

consoledoc.h

A control which adds several reactions to other GUIs via callbacks.

More...

Callbacks

void
onResize(SimObjectId ID)

Called when this GUI is resized.

void
onChildAdded(SimObjectId ID, SimObjectId childID)

Called when a child is added to this GUI.

void
onChildRemoved(SimObjectId ID, SimObjectId childID)

Called when a child is removed from this GUI.

void
onChildResized(SimObjectId ID, SimObjectId childID)

Called when a child is of this GUI is being resized.

void
onParentResized(SimObjectId ID)

Called when this GUI's parent is resized.

void
onLoseFirstResponder(SimObjectId ID)

Called when this GUI loses focus.

void
onGainFirstResponder(SimObjectId ID)

Called when this GUI gains focus.

bool

Enables/disables onChildAdded callback.

bool

Enables/disables onChildRemoved callback.

bool

Enables/disables onChildResized callback.

bool

Enables/disables onParentResized callback.

bool

Enables/disables onResize callback.

bool

Enables/disables onLoseFirstResponder callback.

bool

Enables/disables onGainFirstResponder callback.

Detailed Description

A control which adds several reactions to other GUIs via callbacks.

GuiScriptNotifyCtrl does not exist to render anything. When parented or made a child of other controls, you can toggle flags on or off to make use of its specialized callbacks. Normally these callbacks are used as utility functions by the GUI Editor, or other container classes. However, for very fancy GUI work where controls interact with each other constantly, this is a handy utility to make use of.

// Common member fields left out for sake of example
new GuiScriptNotifyCtrl()
{
   onChildAdded = "0";
   onChildRemoved = "0";
   onChildResized = "0";
   onParentResized = "0";
};

Callbacks

onResize(SimObjectId ID)

Called when this GUI is resized.

Parameters:

ID

Unique object ID assigned when created (this in script).

onChildAdded(SimObjectId ID, SimObjectId childID)

Called when a child is added to this GUI.

Parameters:

ID

Unique object ID assigned when created (this in script).

childID

Unique object ID of child being added.

onChildRemoved(SimObjectId ID, SimObjectId childID)

Called when a child is removed from this GUI.

Parameters:

ID

Unique object ID assigned when created (this in script).

childID

Unique object ID of child being removed.

onChildResized(SimObjectId ID, SimObjectId childID)

Called when a child is of this GUI is being resized.

Parameters:

ID

Unique object ID assigned when created (this in script).

childID

Unique object ID of child being resized.

onParentResized(SimObjectId ID)

Called when this GUI's parent is resized.

Parameters:

ID

Unique object ID assigned when created (this in script).

onLoseFirstResponder(SimObjectId ID)

Called when this GUI loses focus.

Parameters:

ID

Unique object ID assigned when created (this in script).

onGainFirstResponder(SimObjectId ID)

Called when this GUI gains focus.

Parameters:

ID

Unique object ID assigned when created (this in script).

bool notifyOnChildAdded 

Enables/disables onChildAdded callback.

bool notifyOnChildRemoved 

Enables/disables onChildRemoved callback.

bool notifyOnChildResized 

Enables/disables onChildResized callback.

bool notifyOnParentResized 

Enables/disables onParentResized callback.

bool notifyOnResize 

Enables/disables onResize callback.

bool notifyOnLoseFirstResponder 

Enables/disables onLoseFirstResponder callback.

bool notifyOnGainFirstResponder 

Enables/disables onGainFirstResponder callback.