checkbox
Module(s): vncanvas-base, vncanvas-form
Description: Creates a HTML form checkbox element with corresponding label.
- Note: Use only on a 'form', not a 'cform'
- Instantiating form elements without using "form" is not recommended.
checkbox, {param} |
Creates a checkbox. Parameters are given as {param:value, param:value, ...} |
| Parameter | Attributes and Description |
|---|---|
|
name:"checkbox_label"
|
This sets the label and id of the checkbox
|
|
bind:"variable"
|
The corresponding variable to bind the
checkbox to. Changing the value of the checkbox (true/false) updates
the bound variable. "variable" can be a config or user variable.
|
|
tip:"tool_tip_to_display"
|
Optional
The tooltip to display when mouse hovers
over its label.
|
The following checkbox is bound to a configuration variable named "actorShowAvatar".
chapter = [
...
checkbox, {name:"Show avatar",
bind:"actorShowAvatar",
tip:"Show actor avatar on dialog box."},
...
];