Vicon Shogun banner

Description

Creates a push button user control on the user window specified by windowId. A push button is a button that typically fires off an event.

The control is initially placed in the top-left corner of the user window, and must be placed by using the -pos option, or by using the setControlPos command.

The command returns the control ID of the user control, which should be saved for later operations on the control.

Functional area

User Window

Command syntax

Syntax

createPushButton parentWindowID [-hidden] [-text string] [-pos integer array] [-form integer] [-def]

Arguments

NameTypeRequiredComments
windowIdintyesID of user window to place the control on.

Flags

NameFlag argumentsArgument typeExclusive toComments
def0Specifies that the push button is the"default" button in the user window. When the user hits the Enter key in a user window, the "default" button "push" is automatically generated.
hidden0Specifies that the control should be hidden initially. Call showControl to subsequently make it visible. The default is for it to be visible.
text1stringSpecifies the text that appears on the push button. The default is no text.
pos1integer arrayA four-element int array representing a rectangle, which specifies the initial size/position of the control relative to the top left corner of the user window. The element order is Left, Top, Right, and Bottom.
form1integerControl ID of the form user control which will dynamically position this control.

Return value

integer

Examples

// Create a Push Button User Control.
int $windowId;
int $controlId;
int $rect[4];

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

// Position the Control
$rect[0] = 20; // Left
$rect[1] = 20; // Top
$rect[2] = 80; // Right
$rect[3] = 45; // Bottom

// Create the Control on the Window, passing
// in the Window Id of the User Window we
// just created. Make it the default button in the User Window
$controlId = `createPushButton $windowId -pos $rect -def -text "Push Me!"`;