language

const language: object = _data

Defined in: api/node/typescript/generated/language.ts:360

Built-in enums and structs from the Slint language. Enum values are accessed via language.ColorScheme.Dark; struct values via the factory call language.PointerEvent({ button: … }). Enum and struct types are available in type position as language.ColorScheme / language.PointerEvent.

Type Declaration

AccessibleLiveness

readonly AccessibleLiveness: object

This enum represents the different values of the accessible-live-region property. It indicates that an element is a live region whose content changes should be announced by assistive technologies.

AccessibleLiveness.Assertive

readonly Assertive: "assertive" = "assertive"

Use in regions that present information that a user should know about right away. Assistive technologies are expected to announce to the user as soon as possible.

AccessibleLiveness.Off

readonly Off: "off" = "off"

Use in regions that present information that is of low-importance to the user. Assistive technologies are expected to not announce changes unless the user explicitly asks for it.

AccessibleLiveness.Polite

readonly Polite: "polite" = "polite"

Use in regions that present new information to users. Assistive technologies are expected to not interrupt the user to inform of changes to the live region.

AccessibleRole

readonly AccessibleRole: object

This enum represents the different values for the accessible-role property, used to describe the role of an element in the context of assistive technology such as screen readers.

In addition to widget roles, this enum includes landmark roles (banner, complementary, content-info, form, main, navigation, region, search). Landmarks identify large content areas that screen reader users can jump between, giving the application a navigable structure similar to headings in a document. See WAI-ARIA Landmark Regions ↗ for guidance on when and how to use them.

AccessibleRole.Banner

readonly Banner: "banner" = "banner"

Landmark: the header area of the application, typically containing a logo, title, or global navigation.

AccessibleRole.Button

readonly Button: "button" = "button"

The element is a Button or behaves like one.

AccessibleRole.Checkbox

readonly Checkbox: "checkbox" = "checkbox"

The element is a CheckBox or behaves like one.

AccessibleRole.Combobox

readonly Combobox: "combobox" = "combobox"

The element is a ComboBox or behaves like one.

AccessibleRole.Complementary

readonly Complementary: "complementary" = "complementary"

Landmark: a supporting section that complements the main content, such as a sidebar.

AccessibleRole.ContentInfo

readonly ContentInfo: "content-info" = "content-info"

Landmark: information about the application or its content, typically at the bottom (e.g. status bar, copyright).

AccessibleRole.Form

readonly Form: "form" = "form"

Landmark: a region containing input fields and controls for submitting information.

AccessibleRole.Groupbox

readonly Groupbox: "groupbox" = "groupbox"

The element is a GroupBox or behaves like one.

AccessibleRole.Image

readonly Image: "image" = "image"

The element is an Image or behaves like one. This is automatically applied to Image elements.

AccessibleRole.List

readonly List: "list" = "list"

The element is a ListView or behaves like one.

AccessibleRole.ListItem

readonly ListItem: "list-item" = "list-item"

The element is an item in a ListView.

AccessibleRole.Main

readonly Main: "main" = "main"

Landmark: the primary content of the application. Each view should have exactly one main landmark.

AccessibleRole.Navigation

readonly Navigation: "navigation" = "navigation"

Landmark: a group of links or controls used for navigating the application.

AccessibleRole.None

readonly None: "none" = "none"

The element isn’t accessible.

AccessibleRole.ProgressIndicator

readonly ProgressIndicator: "progress-indicator" = "progress-indicator"

The element is a ProgressIndicator or behaves like one.

AccessibleRole.RadioButton

readonly RadioButton: "radio-button" = "radio-button"

The element is a RadioButton or behaves like one.

AccessibleRole.RadioGroup

readonly RadioGroup: "radio-group" = "radio-group"

The element is a container grouping related RadioButtons.

AccessibleRole.Region

readonly Region: "region" = "region"

Landmark: a generic section significant enough to be listed in a summary. Use a more specific landmark if one applies.

AccessibleRole.Search

readonly Search: "search" = "search"

Landmark: a region containing controls for searching or filtering content.

AccessibleRole.Slider

readonly Slider: "slider" = "slider"

The element is a Slider or behaves like one.

AccessibleRole.Spinbox

readonly Spinbox: "spinbox" = "spinbox"

The element is a SpinBox or behaves like one.

AccessibleRole.Switch

readonly Switch: "switch" = "switch"

The element is a Switch or behaves like one.

AccessibleRole.Tab

readonly Tab: "tab" = "tab"

The element is a Tab or behaves like one.

AccessibleRole.Table

readonly Table: "table" = "table"

The role for a TableView or behaves like one.

AccessibleRole.TabList

readonly TabList: "tab-list" = "tab-list"

The element is similar to the tab bar in a TabWidget.

AccessibleRole.TabPanel

readonly TabPanel: "tab-panel" = "tab-panel"

The element is a container for tab content.

AccessibleRole.Text

readonly Text: "text" = "text"

The role for a Text element. This is automatically applied to Text elements.

AccessibleRole.TextInput

readonly TextInput: "text-input" = "text-input"

The role for widget with editable text such as a LineEdit or a TextEdit. This is automatically applied to TextInput elements.

AccessibleRole.Tree

readonly Tree: "tree" = "tree"

The role for a TreeView or behaves like one. (Not provided yet)

ColorScheme

readonly ColorScheme: object

This enum indicates the color scheme used by the widget style. Use this to explicitly switch between dark and light schemes, or choose Unknown to fall back to the system default.

ColorScheme.Dark

readonly Dark: "dark" = "dark"

The style chooses light colors for the background and dark for the foreground.

ColorScheme.Light

readonly Light: "light" = "light"

The style chooses dark colors for the background and light for the foreground.

ColorScheme.Unknown

readonly Unknown: "unknown" = "unknown"

The scheme is not known and a system wide setting configures this. This could mean that the widgets are shown in a dark or light scheme, but it could also be a custom color scheme.

DragAction

readonly DragAction: object

This enum describes the action negotiated between the source of a drag (DragArea) and its target (DropArea) during a drag-and-drop operation. The source declares which actions it permits, the target picks one in its can-drop callback, and the chosen action is reported back to the source via drag-finished so that, for example, a move source can remove the original data. The same enum is used for drags that come from another application or window once native drag-and-drop is in play.

DragAction.Copy

readonly Copy: "copy" = "copy"

The data is copied to the target; the source retains it.

DragAction.Link

readonly Link: "link" = "link"

A link to the source data is created at the target; neither side gives up ownership.

DragAction.Move

readonly Move: "move" = "move"

The data is moved to the target; the source should remove it once the operation completes.

DragAction.None

readonly None: "none" = "none"

No action: the drag is rejected, no drop will be delivered.

DropEvent

readonly DropEvent: (props?) => DropEvent

Build a value of this struct. Any field you omit takes a documented default, which lets Slint add fields later without breaking existing call-sites.

This structure is passed to the callbacks of the DropArea element

Parameters

props?

Partial<DropEvent>

Returns

DropEvent

KeyboardModifiers

readonly KeyboardModifiers: (props?) => KeyboardModifiers

Build a value of this struct. Any field you omit takes a documented default, which lets Slint add fields later without breaking existing call-sites.

The KeyboardModifiers struct provides booleans to indicate possible modifier keys on a keyboard, such as Shift, Control, etc. It is provided as part of KeyEvent’s modifiers field.

Keyboard shortcuts on Apple platforms typically use the Command key (⌘), such as Command+C for “Copy”. On other platforms the same shortcut is typically represented using Control+C. To make it easier to develop cross-platform applications, on macOS, Slint maps the Command key to the control modifier, and the Control key to the meta modifier.

On Windows, the Windows key is mapped to the meta modifier.

Parameters

props?

Partial<KeyboardModifiers>

Returns

KeyboardModifiers

KeyEvent

readonly KeyEvent: (props?) => KeyEvent

Build a value of this struct. Any field you omit takes a documented default, which lets Slint add fields later without breaking existing call-sites.

This structure is generated and passed to the key press and release callbacks of the FocusScope element.

Parameters

props?

Partial<KeyEvent>

Returns

KeyEvent

Orientation

readonly Orientation: object

Represents the orientation of an element or widget such as the Slider.

Orientation.Horizontal

readonly Horizontal: "horizontal" = "horizontal"

Element is oriented horizontally.

Orientation.Vertical

readonly Vertical: "vertical" = "vertical"

Element is oriented vertically.

PointerEvent

readonly PointerEvent: (props?) => PointerEvent

Build a value of this struct. Any field you omit takes a documented default, which lets Slint add fields later without breaking existing call-sites.

Represents a Pointer event sent by the windowing system. This structure is passed to the pointer-event callback of the TouchArea element.

Parameters

props?

Partial<PointerEvent>

Returns

PointerEvent

PointerEventButton

readonly PointerEventButton: object

This enum describes the different types of buttons for a pointer event, typically on a mouse or a pencil.

PointerEventButton.Back

readonly Back: "back" = "back"

The back button.

PointerEventButton.Forward

readonly Forward: "forward" = "forward"

The forward button.

PointerEventButton.Left

readonly Left: "left" = "left"

The left button.

PointerEventButton.Middle

readonly Middle: "middle" = "middle"

The center button.

PointerEventButton.Other

readonly Other: "other" = "other"

A button that is none of left, right, middle, back or forward. For example, this is used for the task button on a mouse with many buttons.

PointerEventButton.Right

readonly Right: "right" = "right"

The right button.

PointerEventKind

readonly PointerEventKind: object

The enum reports what happened to the PointerEventButton in the event

PointerEventKind.Cancel

readonly Cancel: "cancel" = "cancel"

The action was cancelled.

PointerEventKind.Down

readonly Down: "down" = "down"

The button was pressed.

PointerEventKind.Move

readonly Move: "move" = "move"

The pointer has moved,

PointerEventKind.Up

readonly Up: "up" = "up"

The button was released.

PointerScrollEvent

readonly PointerScrollEvent: (props?) => PointerScrollEvent

Build a value of this struct. Any field you omit takes a documented default, which lets Slint add fields later without breaking existing call-sites.

Represents a Pointer scroll (or wheel) event sent by the windowing system. This structure is passed to the scroll-event callback of the TouchArea element.