hiCreateButtonBoxField
hiCreateButtonBoxField(
?name s_fieldName
?choices l_buttonText
?callback l_callbackList
?prompt t_fieldPrompt
[ ?help g_fieldHelp ]
[ ?font t_font ]
[ ?enabled g_enabled ]
[ ?invisible g_invisible ]
)
=> r_fieldHandle
Description
Creates a button box field for a form. A button box field contains individual buttons to be displayed in one row. Each button in the button box have an associated callback procedure that is run when that button is selected. A prompt is displayed on this row as well.
This field can also have a context menu, that is, a pop-up menu that is displayed when you right-click on the field.
For information on creating tooltips for fields, see Creating Tool Tips for Fields.
Arguments
|
?name s_fieldName
|
Handle to this field within a form. To reference it, use:
formHandle->hiFieldSym
|
|
?choices l_buttonText
|
|
|
List of text strings representing the text displayed within each individual button in the button box (in left-to-right order).
|
|
?callback l_callbackList
|
|
|
List of callbacks. Each callback can be of string, symbol, or function object type. The number of button text entries must equal the length of the l_callbackList. The callback is executed when the corresponding button is pressed.
If function object type callback is specified, use the following syntax:
< button box field callback > ( o_field g_scope t_button_text)
where t_button_text is a string member given in the ?choices (l_buttonText) argument.t_fieldPrompt
String specifying the prompt for the field. To reference it, use:
formHandle->hiFieldSym->prompt
|
|
?prompt t_fieldPrompt
|
|
|
A string specifying the prompt for the field. To reference it, use:
formHandle-><fieldName>->prompt
|
|
?help g_fieldHelp
|
A string or symbol used to reference help. If not specified, s_fieldName is used. This argument is currently not used.
|
|
?font t_font
|
A font argument is accepted but is not supported at this time.
|
|
?enabled g_enabled
|
|
|
Specifies whether the fields in the layout are enabled. The default value is t.
|
|
?invisible g_invisible
|
|
|
Specifies whether the layout and the fields within are invisible. The default value is nil.
|
Values Returned
|
r_fieldHandle
|
Handle to the button box field.
|
Related Topics
Form and Field Functions
Creating Context Menus for Fields
Return to top
