Supported Widgets

The Button widget is for placing a button.

Compatible data items:

• None

The CheckBox widget is for placing a checkbox element.

Compatible data items:

• SimpleBool (default)
• SimpleInt (not encouraged)
• SimpleFloat (not encouraged)
• SimpleString (not encouraged)

The ColorPicker widget is for placing an element that allows a user to select or enter a hex color.

Compatible data items:

• SimpleHexColor

The DateTimeField widget is for placing a Date and Time picker control, allowing users to choose either date, or time, or both.

Compatible data items:

• SimpleDateTime (default)
• SimpleDate
• SimpleTime
• SimpleString
• ConstrainedDate
• ConstrainedDateTime

The DropDown widget is for placing a drop down element, which lets a user select from a variety of options, while not displaying them without the user expanding the dropdown.

Compatible data items:

• StringSelector (default)
• FieldSelector

The ListBox widget is for placing a list box element, which lets a user select multiple choices from a variety of options. This widget also allows a user to search available options.

Compatible data items:

• StringSelectorMulti (default)

• FieldSelectorMulti

The NumericSpinner widget is for allowing the selection of a numeric value, with up and down arrows to scroll through a range of choices.

Compatible data items:

• ConstraintFloat (default)
• ConstrainedInt
• SimpleFloat (poor functionality, prefer ConstrainedFloat)
• SimpleInt (poor functionality, prefer ConstrainedInt)

The ProgressBar widget is to visually display how far along the progress of a given operation is, as it actively progresses towards completion.

Compatible data items:

• SimpleInt (default)
• SimpleFloat
• ConstraintFloat
• ConstrainedInt

The RadioButton widget is for placing a single radio button. Radio buttons can have HTML elements and other widgets between them while still being a single control group.

Compatible data items:

• SimpleString (default)

The RadioGroup widget is for placing a group of radio button controls, given a selection of options.

Compatible data items:

• StringSelector (default)
• FieldSelector

The TextArea widget is for placing a text area, different from a text box in that it is intended to allow a large body of text to be written in it, including new lines.

Compatible data items:

• SimpleString (default)
• SimpleInt
• SimpleFloat
• ConstrainedInt (poor user experience, prefer NumericSpinner widget)
• ConstraintFloat (poor user experience, prefer NumericSpinner widget)

The TextBox widget is for placing a text box element. This also has a facility for being a password, which will encrypt in the tool’s configuration.

Compatible data items:

• SimpleString (default)
• SimpleInt
• SimpleFloat
• ConstrainedInt (poor user experience, prefer NumericSpinner widget)
• ConstraintFloat (poor user experience, prefer NumericSpinner widget)

The ToggleBar widget is for allowing users to visually select on, off, or other options by using a slider that has distinctly specified choices.

Compatible data items:

• StringSelector (default)
• FieldSelector