API Reference#

Core application components#

Component

Description

Application

The application itself

Window

Window object

MainWindow

Main Window

General widgets#

Component

Description

ActivityIndicator

A small animated indicator showing activity on a task of indeterminate length, usually rendered as a “spinner” animation.

Button

A button that can be pressed or clicked.

Canvas

Area you can draw on

DetailedList

A list of complex content

Divider

A separator used to visually distinguish two sections of content in a layout.

ImageView

Image Viewer

Label

A text label for annotating forms or interfaces.

MultilineTextInput

A scrollable panel that allows for the display and editing of multiple lines of text.

NumberInput

A text input that is limited to numeric input.

PasswordInput

A widget to allow the entry of a password. Any value typed by the user will be obscured, allowing the user to see the number of characters they have typed, but not the actual characters.

ProgressBar

A horizontal bar to visualize task progress. The task being monitored can be of known or indeterminate length.

Selection

Selection

Slider

A widget for selecting a value within a range. The range is shown as a horizontal line, and the selected value is shown as a draggable marker.

Switch

A clickable button with two stable states: True (on, checked); and False (off, unchecked). The button has a text label.

Table

Table of data

TextInput

A widget for the display and editing of a single line of text.

Tree

Tree of data

WebView

A panel for displaying HTML

Widget

The abstract base class of all widgets. This class should not be be instantiated directly.

Layout widgets#

Usage

Description

Box

A generic container for other widgets. Used to construct layouts.

ScrollContainer

Scrollable Container

SplitContainer

Split Container

OptionContainer

Option Container

Resources#

Component

Description

Font

Fonts

Command

Command

Group

Command group

Icon

An icon for buttons, menus, etc

Image

An image

Validators

Input validators