Description

Sets the event handler for the check 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 a 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

setCheckBoxHandler userControlId [-click string]

Arguments

Name	Type	Required	Comments
`userControlId`	int	yes	ID of user control to set event handler for.

Flags

Name	Flag arguments	Argument type	Exclusive to	Comments
`click`	1	string	—	Specifies the script to call when the user clicks on the check box.

Return value

void

Examples

// Set the event handler for the User Check 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 = `createCheckBox $windowId -text "Check Me"`;
  
// Save the control ID to our profile, so we can retrieve it
// from the event handler
writeProfileInt "MyWindowSection" "CheckBoxId" $controlId;
 
// Set the -click event handler for the Check Box. When
// the user clicks on the Check Box, this script will be
// executed. CheckBoxClickHandler must reside in one of
// the scripts directories.
setCheckBoxHandler $controlId -click "CheckBoxClickHandler";

Shogun 1.11 Documentation

setCheckBoxHandler