Dunstblick Widgets

Description of the Widgets available in Dunstblick

Overview

The following widgets are available in Dunstblick:

• Button
• Label
• Picture
• TextBox
• CheckBox
• RadioButton
• ScrollView
• ScrollBar
• Slider
• ProgressBar
• SpinEdit
• Separator
• Spacer
• Panel
• Container
• TabLayout
• CanvasLayout
• FlowLayout
• GridLayout
• DockLayout
• StackLayout
• ComboBox
• TreeView
• ListBox

Widgets

Button

The button provides the user the ability to trigger a single-shot action like Save or Load. It provides a event callback when the user clicks it.

Properties:

horizontal-alignment, vertical-alignment, margins, paddings, dock-site, visibility, enabled, hit-test-visible, binding-context, child-source, child-template, widget-name, tab-title, size-hint, left, top, on-click

Label

This widget is used for text rendering. It will display its text, which can also be a multiline string.

Properties:

horizontal-alignment, vertical-alignment, margins, paddings, dock-site, visibility, enabled, hit-test-visible, binding-context, child-source, child-template, widget-name, tab-title, size-hint, left, top, text, font-family

Picture

This widget renders a bitmap or drawing. The image will be set using a certain size mode:

• none: The image will be displayed unscaled on the top-left of the Picture and will be cut off the edges of the Picture.
• center: The image will be centered inside the Picture without scaling. All excess will be cut off.
• stretch: The image will be stretched so it will fill the full Picture. This is a very nice option for background images.
• zoom: The image will be scaled in such a way that it will always touch at least two sides of the Picture. It will always be fully visible and no part of the image will be cut off. This mode is respecting the aspect of the image.
• cover: The image will be scaled in such a way that it will fully cover the Picture. This mode is respecting the aspect of the image, thus excess is cut off.
• contain: This is a combined mode which will behave like zoom if the image is larger than the Picture, otherwise it will behave like center.

Properties:

horizontal-alignment, vertical-alignment, margins, paddings, dock-site, visibility, enabled, hit-test-visible, binding-context, child-source, child-template, widget-name, tab-title, size-hint, left, top, image, image-scaling

TextBox

The text box is a single line text input field. The user can enter any text that has a single line.

Properties:

horizontal-alignment, vertical-alignment, margins, paddings, dock-site, visibility, enabled, hit-test-visible, binding-context, child-source, child-template, widget-name, tab-title, size-hint, left, top, text

CheckBox

The combobox provides the user with a yes/no option that can be toggled when clicked. Each combobox is separate from each other, and the property is-checked will be toggled.

Properties:

horizontal-alignment, vertical-alignment, margins, paddings, dock-site, visibility, enabled, hit-test-visible, binding-context, child-source, child-template, widget-name, tab-title, size-hint, left, top, is-checked

RadioButton

Radio buttons are grouped together by an integer value and will show active when that value matches their index. If the user clicks the radio button, the group value is set to the selected-index.

Properties:

horizontal-alignment, vertical-alignment, margins, paddings, dock-site, visibility, enabled, hit-test-visible, binding-context, child-source, child-template, widget-name, tab-title, size-hint, left, top, group, selected-index

ScrollView

This widget doesn't have any documentation at this moment.

Properties:

horizontal-alignment, vertical-alignment, margins, paddings, dock-site, visibility, enabled, hit-test-visible, binding-context, child-source, child-template, widget-name, tab-title, size-hint, left, top

ScrollBar

This widget doesn't have any documentation at this moment.

Properties:

horizontal-alignment, vertical-alignment, margins, paddings, dock-site, visibility, enabled, hit-test-visible, binding-context, child-source, child-template, widget-name, tab-title, size-hint, left, top, orientation, minimum, value, maximum

Slider

This widget doesn't have any documentation at this moment.

Properties:

horizontal-alignment, vertical-alignment, margins, paddings, dock-site, visibility, enabled, hit-test-visible, binding-context, child-source, child-template, widget-name, tab-title, size-hint, left, top, orientation, minimum, value, maximum

ProgressBar

This widget doesn't have any documentation at this moment.

Properties:

horizontal-alignment, vertical-alignment, margins, paddings, dock-site, visibility, enabled, hit-test-visible, binding-context, child-source, child-template, widget-name, tab-title, size-hint, left, top, orientation, minimum, value, maximum, display-progress-style

SpinEdit

This widget doesn't have any documentation at this moment.

Properties:

horizontal-alignment, vertical-alignment, margins, paddings, dock-site, visibility, enabled, hit-test-visible, binding-context, child-source, child-template, widget-name, tab-title, size-hint, left, top, orientation, minimum, value, maximum

Separator

This widget doesn't have any documentation at this moment.

Properties:

horizontal-alignment, vertical-alignment, margins, paddings, dock-site, visibility, enabled, hit-test-visible, binding-context, child-source, child-template, widget-name, tab-title, size-hint, left, top

Spacer

This widget doesn't have any documentation at this moment.

Properties:

horizontal-alignment, vertical-alignment, margins, paddings, dock-site, visibility, enabled, hit-test-visible, binding-context, child-source, child-template, widget-name, tab-title, size-hint, left, top

Panel

This widget doesn't have any documentation at this moment.

Properties:

horizontal-alignment, vertical-alignment, margins, paddings, dock-site, visibility, enabled, hit-test-visible, binding-context, child-source, child-template, widget-name, tab-title, size-hint, left, top

Container

This widget doesn't have any documentation at this moment.

Properties:

horizontal-alignment, vertical-alignment, margins, paddings, dock-site, visibility, enabled, hit-test-visible, binding-context, child-source, child-template, widget-name, tab-title, size-hint, left, top

TabLayout

This widget doesn't have any documentation at this moment.

Properties:

horizontal-alignment, vertical-alignment, margins, paddings, dock-site, visibility, enabled, hit-test-visible, binding-context, child-source, child-template, widget-name, tab-title, size-hint, left, top, selected-index

CanvasLayout

This widget doesn't have any documentation at this moment.

Properties:

horizontal-alignment, vertical-alignment, margins, paddings, dock-site, visibility, enabled, hit-test-visible, binding-context, child-source, child-template, widget-name, tab-title, size-hint, left, top

FlowLayout

This widget doesn't have any documentation at this moment.

Properties:

horizontal-alignment, vertical-alignment, margins, paddings, dock-site, visibility, enabled, hit-test-visible, binding-context, child-source, child-template, widget-name, tab-title, size-hint, left, top

GridLayout

This widget doesn't have any documentation at this moment.

Properties:

horizontal-alignment, vertical-alignment, margins, paddings, dock-site, visibility, enabled, hit-test-visible, binding-context, child-source, child-template, widget-name, tab-title, size-hint, left, top, columns, rows

DockLayout

This widget doesn't have any documentation at this moment.

Properties:

horizontal-alignment, vertical-alignment, margins, paddings, dock-site, visibility, enabled, hit-test-visible, binding-context, child-source, child-template, widget-name, tab-title, size-hint, left, top

StackLayout

This widget doesn't have any documentation at this moment.

Properties:

horizontal-alignment, vertical-alignment, margins, paddings, dock-site, visibility, enabled, hit-test-visible, binding-context, child-source, child-template, widget-name, tab-title, size-hint, left, top, orientation

ComboBox

This widget doesn't have any documentation at this moment.

Properties:

horizontal-alignment, vertical-alignment, margins, paddings, dock-site, visibility, enabled, hit-test-visible, binding-context, child-source, child-template, widget-name, tab-title, size-hint, left, top

TreeView

This widget doesn't have any documentation at this moment.

Properties:

horizontal-alignment, vertical-alignment, margins, paddings, dock-site, visibility, enabled, hit-test-visible, binding-context, child-source, child-template, widget-name, tab-title, size-hint, left, top

ListBox

This widget doesn't have any documentation at this moment.

Properties:

horizontal-alignment, vertical-alignment, margins, paddings, dock-site, visibility, enabled, hit-test-visible, binding-context, child-source, child-template, widget-name, tab-title, size-hint, left, top

Properties

horizontal-alignment

This property doesn't have any documentation at this moment.

Data Type: enumeration

Possible Values: left, center, right, stretch

vertical-alignment

This property doesn't have any documentation at this moment.

Data Type: enumeration

Possible Values: top, middle, bottom, stretch

margins

This property doesn't have any documentation at this moment.

Data Type: margins

paddings

This property doesn't have any documentation at this moment.

Data Type: margins

dock-site

This property doesn't have any documentation at this moment.

Data Type: enumeration

Possible Values: left, right, top, bottom

visibility

This property doesn't have any documentation at this moment.

Data Type: enumeration

Possible Values: visible, hidden, collapsed

size-hint

This property doesn't have any documentation at this moment.

Data Type: size

font-family

This property doesn't have any documentation at this moment.

Data Type: enumeration

Possible Values: sans, serif, monospace

text

This property doesn't have any documentation at this moment.

Data Type: string

minimum

This property doesn't have any documentation at this moment.

Data Type: number

maximum

This property doesn't have any documentation at this moment.

Data Type: number

value

This property doesn't have any documentation at this moment.

Data Type: number

display-progress-style

This property doesn't have any documentation at this moment.

Data Type: enumeration

Possible Values: none, percent, absolute

is-checked

This property doesn't have any documentation at this moment.

Data Type: boolean

tab-title

This property doesn't have any documentation at this moment.

Data Type: string

selected-index

This property doesn't have any documentation at this moment.

Data Type: integer

group

This property doesn't have any documentation at this moment.

Data Type: integer

columns

This property doesn't have any documentation at this moment.

Data Type: sizelist

rows

This property doesn't have any documentation at this moment.

Data Type: sizelist

left

This property doesn't have any documentation at this moment.

Data Type: integer

top

This property doesn't have any documentation at this moment.

Data Type: integer

enabled

This property doesn't have any documentation at this moment.

Data Type: boolean

image-scaling

This property doesn't have any documentation at this moment.

Data Type: enumeration

Possible Values: none, center, stretch, zoom, contain, cover

image

This property doesn't have any documentation at this moment.

Data Type: resource

binding-context

This property doesn't have any documentation at this moment.

Data Type: object

child-source

This property doesn't have any documentation at this moment.

Data Type: objectlist

child-template

This property doesn't have any documentation at this moment.

Data Type: resource

hit-test-visible

This property doesn't have any documentation at this moment.

Data Type: boolean

on-click

This property doesn't have any documentation at this moment.

Data Type: event

orientation

This property doesn't have any documentation at this moment.

Data Type: enumeration

Possible Values: horizontal, vertical

widget-name

This property doesn't have any documentation at this moment.

Data Type: widget