Vicon Shogun banner

Description

Sets the event handler for the num box user control that is specified by userControlID.

Event handlers are simply scripts to be called when certain events happen. User controls get notified about changes in state when users interact with them. Each event handler flag takes as an argument: a script (which must reside in your script directories).

To clear an event handler, pass the empty string, "", to the flag. If no options are specified, all handlers are reset, and the user control will not respond to any events.

Functional area

User Window

Command syntax

Syntax

setNumBoxHandler userControlID [-change string] [-loseFocus string]

Arguments

NameTypeRequiredComments
userControlIdintyesID of user control to set event handler for.

Flags

NameFlag argumentsArgument typeExclusive toComments
change1stringSpecifies the script to call when the user changes the value of the num box.
loseFocus1stringSpecifies the script to call when the num box loses the input focus.

Return value

void

Examples

// Set the event handler for the User Num Box.
int $windowId;
int $controlId;

// First create a User Window to place the Control on
$windowId = `createWindow "MyWindow"`;

// Create the User Control on the Window.
$controlId = `createNumBox $windowId`;

// Save the control ID to our profile, so we can retrieve it
// from the event handler
writeProfileInt "MyWindowSection" "NumBoxId" $controlId;

// Set the -loseFocus event handler for the Num Box. When
// the user clicks (or Tabs) out of Num Box item, this script will be
// executed. NumBoxLoseFocusHandler must reside in one of
// the scripts directories.
setNumBoxHandler $controlId -loseFocus "NumBoxLoseFocusHandler";

Additional information

Related commands