SUI_AddFormButton Table of Contents || Prev | Next || [?]

 
SUI_AddFormButton (formType; phrase; postKey{; keyModifiers{; objectName}})
 
ParameterTypeDescription
formTypeInteger1 = input; 2 = dialog
phraseStringWord or phrase to listen for
postKeyIntegerAscii value of key
keyModifiersIntegerModifiers
objectNameStringObject name of button
 
Description

SUI_AddFormButton allows you to trigger key posts with a word or phrase, as assigned to a form button.

Example

To voice-enable the accept and cancel buttons on an input form, you call SUI_AddFormButton in the input form method:

SUI_AddFormButton (1;"Accept changes";Return Key)
SUI_AddFormButton (1;"Cancel changes";Escape Key)

When "Accept changes" or "Cancel changes" is spoken, SUI Pack will post the keystroke
specified in $3 (and with any modifiers passed as $4).

To disable the voicing of a button, use SUI_RemFormObject.

New in v3.0.0

Instead of having SUI Pack post a key to click the button, you can now pass the object name as $5 and SUI Pack will "click" the button when the button title is spoken. In this case parms $3 and $4 are ignored.