> For the complete documentation index, see [llms.txt](https://docs.flipabit.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flipabit.dev/api/widget/form.md).

# Form

<div align="left"><img src="/files/-MIxukRdgySA0YtJVJyy" alt=""></div>

| Property        | Function                                                                                                                                                                                                            | Type                                                                                                                                                                                                                                                                                                                                                            |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Type            | <p>Form element type<br><br><strong>Actions editor:</strong><br><code>Property > Form > Type</code><br><strong>Code:</strong><br><code>widget.content.controlType</code></p>                                        | <p><code>enum</code><br><br><strong>Values:</strong><br><code>Button</code><br><code>CheckBox</code><br><code>ComboBox</code><br><code>Dial</code><br><code>RadioButton</code><br><code>Slider</code><br><code>SpinBox</code><br><code>TextArea</code><br><code>TextField</code><br><code>Tumbler</code><br><code>ImageButton</code><br><code>Switch</code></p> |
| Checkable       | <p>Sets whether the button is checkable<br><br><strong>Actions editor:</strong><br><code>Property > Form > Checkable</code><br><strong>Code:</strong><br><code>widget.content.buttonCheckable</code></p>            | `bool`                                                                                                                                                                                                                                                                                                                                                          |
| Checked         | <p>Sets checked state<br><br><strong>Actions editor:</strong><br><code>Property > Form > Checked</code><br><strong>Code:</strong><br><code>widget.content.checked</code></p>                                        | `bool`                                                                                                                                                                                                                                                                                                                                                          |
| Label           | <p>Form element label<br><br><strong>Actions editor:</strong><br><code>Property > Form > Label</code><br><strong>Code:</strong><br><code>widget.content.label</code></p>                                            | `string`                                                                                                                                                                                                                                                                                                                                                        |
| Text            | <p>Form element value<br><br><strong>Actions editor:</strong><br><code>Property > Form > Text</code><br><strong>Code:</strong><br><code>widget.content.text</code></p>                                              | `string`                                                                                                                                                                                                                                                                                                                                                        |
| Index           | <p>Current index of Tumbler<br><br><strong>Actions editor:</strong><br><code>Property > Form > Index</code><br><strong>Code:</strong><br><code>widget.content.currentIndex</code></p>                               | `double`                                                                                                                                                                                                                                                                                                                                                        |
| Minimum         | <p>Slider minimum value<br><br><strong>Actions editor:</strong><br><code>Property > Form > Minimum</code><br><strong>Code:</strong><br><code>widget.content.minimumValue</code></p>                                 | `double`                                                                                                                                                                                                                                                                                                                                                        |
| Maximum         | <p>Slider maximum value<br><br><strong>Actions editor:</strong><br><code>Property > Form > Maximum</code><br><strong>Code:</strong><br><code>widget.content.maximumValue</code></p>                                 | `double`                                                                                                                                                                                                                                                                                                                                                        |
| Step            | <p>Slider value step size<br><br><strong>Actions editor:</strong><br><code>Property > Form > Step</code><br><strong>Code:</strong><br><code>widget.content.stepSize</code></p>                                      | `double`                                                                                                                                                                                                                                                                                                                                                        |
| List            | <p>List of Tumbler values<br><br><strong>Actions editor:</strong><br><code>Property > Form > List</code><br><strong>Code:</strong><br><code>widget.content.model</code></p>                                         | `string`                                                                                                                                                                                                                                                                                                                                                        |
| Orientation     | <p>Tumbler orientation<br><br><strong>Actions editor:</strong><br><code>Property > Form > Orientation</code><br><strong>Code:</strong><br><code>widget.content.controlOrientation</code></p>                        | <p><code>enum</code><br><br><strong>Values:</strong><br><code>Qt::Vertical</code><br><code>Qt::Horizontal</code></p>                                                                                                                                                                                                                                            |
| Image           | <p>Image for ImageButton element<br><br><strong>Actions editor:</strong><br><code>Property > Form > Image</code><br><strong>Code:</strong><br><code>widget.content.buttonImage</code></p>                           | `string`                                                                                                                                                                                                                                                                                                                                                        |
| Selected image  | <p>Selected image for ImageButton element<br><br><strong>Actions editor:</strong><br><code>Property > Form > Selected image</code><br><strong>Code:</strong><br><code>widget.content.buttonSelectedImage</code></p> | `string`                                                                                                                                                                                                                                                                                                                                                        |
| Exclusive       | <p>Sets exclusive state<br><br><strong>Actions editor:</strong><br><code>Property > Form > Exclusive</code><br><strong>Code:</strong><br><code>widget.content.exclusive</code></p>                                  | `bool`                                                                                                                                                                                                                                                                                                                                                          |
| Read only       | <p>Sets read only<br><br><strong>Actions editor:</strong><br><code>Property > Form > Read only</code><br><strong>Code:</strong><br><code>widget.content.readOnly</code></p>                                         | `bool`                                                                                                                                                                                                                                                                                                                                                          |
| Select by mouse | <p>Sets select by mouse<br><br><strong>Actions editor:</strong><br><code>Property > Form > Select by mouse</code><br><strong>Code:</strong><br><code>widget.content.selectByMouse</code></p>                        | `bool`                                                                                                                                                                                                                                                                                                                                                          |
| Ok button       | <p>Show button Ok<br><br><strong>Actions editor:</strong><br><code>Property > Form > Ok button</code><br><strong>Code:</strong><br><code>widget.content.okButton</code></p>                                         | `bool`                                                                                                                                                                                                                                                                                                                                                          |
| Cancel button   | <p>Show button Cancel<br><br><strong>Actions editor:</strong><br><code>Property > Form > Cancel button</code><br><strong>Code:</strong><br><code>widget.content.cancelButton</code></p>                             | `bool`                                                                                                                                                                                                                                                                                                                                                          |
| Placeholder     | <p>Show hint when the text field is empty<br><br><strong>Actions editor:</strong><br><code>Property > Form > Placeholder</code><br><strong>Code:</strong><br><code>widget.content.placeholderText</code></p>        | `string`                                                                                                                                                                                                                                                                                                                                                        |

## Actions

| Property  | Function                                                                                                                                                                                                   |
| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Set text  | <p><strong>Actions editor:</strong><br><code>Actions > Common > Set text</code><br><strong>Code:</strong><br><code>widget.content.script.actionSetText(QString text)</code></p>                            |
| Check     | <p><strong>Actions editor:</strong><br><code>Actions > Common > Check</code><br><strong>Code:</strong><br><code>widget.content.script.actionCheck()</code></p>                                             |
| Uncheck   | <p><strong>Actions editor:</strong><br><code>Actions > Common > Uncheck</code><br><strong>Code:</strong><br><code>widget.content.script.actionUnCheck()</code></p>                                         |
| Toggle    | <p>Toggle checked state<br><br><strong>Actions editor:</strong><br><code>Actions > Common > Toggle</code><br><strong>Code:</strong><br><code>widget.content.script.actionToggle()</code></p>               |
| Set index | <p>Set current index<br><br><strong>Actions editor:</strong><br><code>Actions > Common > Set index</code><br><strong>Code:</strong><br><code>widget.content.script.actionSetIndex(double index)</code></p> |

## Events

| Property       | Function                                                                                                                                                                                                |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Text changed   | <p>Event when text is changed<br><br><strong>Actions editor:</strong><br><code>Event > Text changed</code><br><strong>Code:</strong><br><code>widget.content.script.eventTextChanged()</code></p>       |
| Checked        | <p>Event when item is checked<br><br><strong>Actions editor:</strong><br><code>Event > Checked</code><br><strong>Code:</strong><br><code>widget.content.script.eventChecked()</code></p>                |
| Unchecked      | <p>Event when item is unchecked<br><br><strong>Actions editor:</strong><br><code>Event > Unchecked</code><br><strong>Code:</strong><br><code>widget.content.script.eventUnChecked()</code></p>          |
| Toggled        | <p>Event when checked state is toggled<br><br><strong>Actions editor:</strong><br><code>Event > Toggled</code><br><strong>Code:</strong><br><code>widget.content.script.eventToggled()</code></p>       |
| Index changed  | <p>Event when index is changed<br><br><strong>Actions editor:</strong><br><code>Event > Index changed</code><br><strong>Code:</strong><br><code>widget.content.script.eventIndexChanged()</code></p>    |
| Return pressed | <p>Event when return is pressed<br><br><strong>Actions editor:</strong><br><code>Event > Return pressed</code><br><strong>Code:</strong><br><code>widget.content.script.eventReturnPressed()</code></p> |
| Accepted       | <p>Event when user has pressed Ok<br><br><strong>Actions editor:</strong><br><code>Event > Accepted</code><br><strong>Code:</strong><br><code>widget.content.script.eventAccepted()</code></p>          |
| Rejected       | <p>Event when user has pressed Cancel<br><br><strong>Actions editor:</strong><br><code>Event > Rejected</code><br><strong>Code:</strong><br><code>widget.content.script.eventRejected()</code></p>      |
