Skin Elements Reference

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Abstract
Parents: [View] <- [Element]
Children: [Flexbox] [Layout]
Group: [Layout]
Schema children: [ViewsAndStatements]

ActivityIndicator

An ActivityIndicator shows activity by displaying some animation.

Description

Shows an animation while ActivityIndicator is visible. The duration of the animation is taken from the “duration” attribute of the foreground image resource.

Attributes (37)

Inherited from [ValueBar]

image (string): Image with 2 frames: “normal” for the background, “normalOn” for the value bar

Inherited from [ValueControl]

colorname (string): name of a color parameter used to colorize the hilite parts of value controls

Inherited from [Control]

command.category (string): If a control triggers a command, this is the command category
command.name (string): If a control triggers a command, this is the command name

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [ProgressBar] <- [ValueBar] <- [ValueControl] <- [Control] <- [View] <- [Element]
Group: [Controls]
Schema children: [ViewsAndStatements]

Align

Defines an alignment in a Visual Style.

See also: [Style]

Attributes (6)

align (enum)

Inherited from [Options]

options (enum)
type (string)
value (int)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Options] <- [Element]
Group: [Styles]

AlignView

Aligns child views according to an alignment parameter.

Description

Depending on the AlignView’s orientation (“horizontal” or “vertical”), the parameter selects one of the aligmnents “left”, “hcenter”, “right” or “top”, “vcenter”, “bottom” to align the child views relative to the parent area. The user can choose the aligment via the context menu.

Attributes (36)

persistence.id (string): storage id used to store and restore the selected alignment

Inherited from [Control]

command.category (string): If a control triggers a command, this is the command category
command.name (string): If a control triggers a command, this is the command name

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Control] <- [View] <- [Element]
Group: [Layout]
Schema children: [ViewsAndStatements]

AmbientLight3D

Attributes (7)

Inherited from [LightSource3D]

color (color): light color

Inherited from [SceneNode3D]

options (enum): node options
orientation (point3d): 3D orientation (yaw, pitch, roll in radians)
position (point3d): 3D position (x, y, z)
scale (point3d): 3D scale (x, y, z)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [LightSource3D] <- [SceneNode3D] <- [Element]
Group: [3D]

Anchor

An Anchor specifies the url for a child Link element.

Animation

Describes an animation of a property.

Description

Must be placed inside a <StartAnimation>.

The “property path is relative to the triggering view. An Animation specifies that the property value should transition “from” a start value “to” an end value for some “duration”.

Additionally, a “repeat” mode and a timing “function” can be specified.

Multiple animations can be in the same “group” to ensure synchronized execution.

BasicShape

A Shape is a vector graphics object, a combination of geometric figures that can be scaled without quality loss.

Description

This is the base class of all shapes, not to be used directly.

Attributes (9)

Brush.color (color)
Brush.gradient (string)
Pen.color (color)
Pen.width (float)
shaperef (string)
size (size)
style (enum)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Abstract
Parents: [Element]
Children: [Line] [Rectangle] [Shape] [Triangle]
Group: [Shapes]

Border

A Border is a decoration element that shows an image or a solid color.

Button

Button control base class and simple push button control.

Description

A Button is a control that changes the value of it’s parameter on a mouse click. By default this happens when the mouse button is released, which can be changed with the option “immediate”.

The Button base class behaves like a push button: it momentarily sets the parameter value to it’s maximum value and then resets it afterwards to it’s minimum. Derived classes like Toggle and MultiToggle behave differently.

See also: [Toggle] [MultiToggle] [ButtonStyle]

Attributes (39)

colorname (color)
icon (string): The icon is plotted onto the button. This allows the same background bitmap to be used and varied with the icon image.
image (string): Background image. The button uses different frames of the image to show its different states.
titlename (string)

Inherited from [Control]

command.category (string): If a control triggers a command, this is the command category
command.name (string): If a control triggers a command, this is the command name

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Control] <- [View] <- [Element]
Children: [DialogButton] [RadioButton] [Toggle] [UpDownButton]
Group: [Controls]
Schema children: [ViewsAndStatements]

Camera3D

Attributes (9)

fieldofviewangle (float): camera field of view angle in degrees
lookatposition (point3d): camera ‘look at’ position (3D)
lookatupvector (point3d): camera ‘look at’ up vector (3D)

Inherited from [SceneNode3D]

options (enum): node options
orientation (point3d): 3D orientation (yaw, pitch, roll in radians)
position (point3d): 3D position (x, y, z)
scale (point3d): 3D scale (x, y, z)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [SceneNode3D] <- [Element]
Group: [3D]

CheckBox

A standard dialog control with a check/unchecked state.

Description

A Checkbox is a Toggle that can draw an additional title besides the image.

Color

Defines a color in a Visual Style.

See also: [Style]

Attributes (3)

color (color)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Children: [ColorScheme.Color]
Group: [Styles]

ColorBox

A simple colored area where the color can be derived from a color parameter.

Description

A ColorBox fills it’s whole area with a color.

The parameter can be a special color parameter that directly tells the color, or an integer parameter that encodes the color as a 32 bit integer code.

Additional to the parameter that defines color, the ColorBox can have an additional parameter “selectname”. A click in the ColorBox sets that parameter to it’s maximum value.

With the option “border”, the ColorBox draws frame of “strokewidth” pixels in the “forecolor”, or “hilitecolor” if the “selectname” parameter has it’s maximum value.

Attributes (37)

radius (int): For a color box with rounded courners, set the radius attribute to the desired value
selectname (string): This attribute is the name of an optional parameter, that can be triggered, when the user clicks on the color box

Inherited from [Control]

command.category (string): If a control triggers a command, this is the command category
command.name (string): If a control triggers a command, this is the command name

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Control] <- [View] <- [Element]
Group: [Controls]
Schema children: [ViewsAndStatements]

ColorScheme

Attributes (2)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Group: [Resources]
Schema children: [ColorScheme.Color]

ColorScheme.Color

Attributes (12)

alphavalue (int)
contrast (string)
huefixed (bool)
invertedcolor (string)
invertedvalue (int)
invertible (bool)
luminance (string)
saturation (string)
slcombined (bool)

Inherited from [Color]

color (color)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Color] <- [Element]
Group: [Resources]

ComboBox

A combobox is a combination of a selectbox and a text edit field.

Description

A ComboBox allows to enter free text like an EditBox, and additionally offers a popupmenu with values to choose from, like a SelectBox.

CommandBarView

A specialized view that manages a user customizable arrangement of controls.

Attributes (35)

form.name (string): name of a form for items
menuform.name (string): name of a from for a context menu

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [View] <- [Element]
Group: [Controls]
Schema children: [ViewsAndStatements]

Control

Base class for all controls.

Description

A control is a user interface element, that operates on a parameter in a defined way. The name attribute of a control refers to the name of the parameter, that the controller must supply, when the user interfaces is constructed from the skin description. Instead of a parameter, a control can also trigger a command.

Attributes (35)

command.category (string): If a control triggers a command, this is the command category
command.name (string): If a control triggers a command, this is the command name

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [View] <- [Element]
Children: [AlignView] [Button] [ColorBox] [Divider] [Link] [ScrollBar] [ScrollPicker] [SegmentBox] [SwipeBox] [TabView] [TextBox] [UpDownBox] [ValueControl]
Group: [Controls]
Schema children: [ViewsAndStatements]

Cursor

Defines a Cursor resource.

Description

A cursor is defined with an image resource and an hotspot, which is the active point in the image.

Attributes (4)

hotspot (point): the active point in the image
image (string): cursor image

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Group: [Resources]

CursorView

Changes the mouse cursor.

Description

While the mouse is over the CursorView, the mouse cursor changes to the specified cursor.

Delegate

Dynamically creates a content view.

Description

Every time the Delegate gets attached, it creates a new child view using the given form name and controller. When the delegagte gets removed, the child view is destroyed.

The controller attribute is optional, default is the current controller.

A popular usage scenario is a <Delegate> inside a <Variant> controlled by a property. Everytime the property change is triggered by the application, the content gets recreated (see code example).

Example

<!-- the option "selectalways" here ensures that the view
is recreated although the property value did not really change -->
<Variant property="hasContent" options="selectalways">
   <Delegate form.name="MyContent" controller="IMyController"/>
</Variant>

Attributes (35)

controller (string): The name of the controller for creating the content view. Can be a sub controller of the current controller, or an absolute controler path.
form.name (string): The name of the form for creating the content view

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [View] <- [Element]
Group: [General]
Schema children: [ViewsAndStatements]

DialogButton

A button with a predefined standard behavior.

Description

Usually used in dialogs.

Example

<DialogButton result="cancel"/>

Attributes (40)

result (enum)

Inherited from [Button]

colorname (color)
icon (string): The icon is plotted onto the button. This allows the same background bitmap to be used and varied with the icon image.
image (string): Background image. The button uses different frames of the image to show its different states.
titlename (string)

Inherited from [Control]

command.category (string): If a control triggers a command, this is the command category
command.name (string): If a control triggers a command, this is the command name

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Button] <- [Control] <- [View] <- [Element]
Group: [Controls]
Schema children: [ViewsAndStatements]

DialogGroup

DirectionalLight3D

Attributes (7)

Inherited from [LightSource3D]

color (color): light color

Inherited from [SceneNode3D]

options (enum): node options
orientation (point3d): 3D orientation (yaw, pitch, roll in radians)
position (point3d): 3D position (x, y, z)
scale (point3d): 3D scale (x, y, z)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [LightSource3D] <- [SceneNode3D] <- [Element]
Group: [3D]

Divider

A view that can be dragged to divide screen space between two neighbour views.

Description

To be used inside a layout view

DropBox

A specialized scrollable view that manages a dynamic list of views.

Description

The controller must provide a special “item model” as object that is referenced with the DropBox name. For each of the items in the model, a View is created, with the item as controller and a Form from the skin. The form name for the items is the DropBox name appended with “Item”.

Attributes (40)

Inherited from [ItemView]

headerstyle (string): Name of a visual style that will be assigned to the column header view
scrolloptions (enum): Options for the surrounding scrollview

Inherited from [ScrollView]

hscroll.name (string): name of the horizontal scroll parameter
hscroll.style (string): name of a visual style for the horizontal scrollbar
persistence.id (string): storage id used to store and restore the scroll state
vscroll.name (string): name of the vertical scroll parameter
vscroll.style (string): name of a visual style for the vertical scrollbar

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [ItemView] <- [ScrollView] <- [View] <- [Element]
Group: [Views]
Schema children: [ViewsAndStatements]

EditBox

An edit box is a control for editing text based values and strings.

Description

An edit box displays text just like a TextBox, but the parameter value can also be changed by the user by editing text.

Element

The base class of all skin elements.

Description

This class is not used directly, but all other skin element classes inherit from it.

Attributes (2)

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Abstract
Children: [Anchor] [Animation] [BasicShape] [Color] [ColorScheme] [Cursor] [External] [Externals] [Font] [Forms] [Frame] [Gradient] [GradientStop] [ImageFilter] [Import] [Imports] [Include] [Includes] [Invoker] [Material3D] [Metric] [Options] [Overlay] [Overlays] [Parameter] [Perspective] [Resource] [Resources] [SceneNode3D] [Setter] [ShapeColorMapping] [Shapes] [Skin] [StartAnimation] [StopAnimation] [String] [Style] [Styles] [TextureMaterial3D.Texture] [Trigger] [Triggers] [View] [WindowClass] [WindowClasses] [Workspace] [Workspaces] [statement]
Group: [General]

Ellipse

A shape that draws an ellipse.

Attributes (11)

Inherited from [Rectangle]

radius (int)
rect (rect)

Inherited from [BasicShape]

Brush.color (color)
Brush.gradient (string)
Pen.color (color)
Pen.width (float)
shaperef (string)
size (size)
style (enum)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Rectangle] <- [BasicShape] <- [Element]
Group: [Shapes]

EmbeddedFrame

An EmbeddedFrame defines a sub tree of frames that can appear in the form of a parent class.

Description

The EmbeddedFrame element must appear in two places: placed inside the form of a “parent” window class and placed in the root frame of a perspective with the same name and a parent class. It defines a separate subtree of frames.

When a window class is about to be opened, the workspace system ensures that the parent class, whose view contains the EmbeddeFrame view gets opened first.

Example

<!-- inside form of parent window -->
<Form name="MyParentForm">
    <!-- ... -->
    <EmbeddedFrame name="Embedded"/>
</Form>

<!-- in root frame of perspective -->
<EmbeddedFrame name="Embedded" parent.class="MyParentClass">
    <Frame options="vertical">
        <Frame name="A" groups="a"/>
        <Frame name="B" groups="b"/>
    </Frame>
</EmbeddedFrame>

Attributes (35)

parent.class (string): parent class, whose view host the corresponding EmbeddedFrame view. Only used when describing an the EmbeddedFrame.
workspace (string): workspace id. Only used when describing an EmbeddedFrame view.

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum): transition used when content is replaced
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [View] <- [Element]
Group: [Workspace]
Schema children: [Frame]

External

Declares a name that has to be defined outside the skin pack.

Attributes (2)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Group: [General]

Externals

Enclosing tag for all Externals in a skin xml file.

Flexbox

Arranges its children according to the CSS Flexbox specification: https://www.w3.org/TR/css-flexbox-1/.

Attributes (45)

flex.align (enum): Alignment of the children on the cross axis
flex.direction (enum): Defines the direction of the main axis, in which the children are layed out
flex.gap (string): Shorthand for individual gaps, enter one or two values which are interpreted as follows: “row=column”, “row, column”
flex.gap.column (metric): Space added between elements vertically
flex.gap.row (metric): Space added between elements horizontally
flex.justify (enum): Justification of the children on the main axis
flex.padding (string): Shorthand for individual padding, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.padding.bottom (metric): Space added to the bottom edge on the inside of the container
flex.padding.left (metric): Space added to the left edge on the inside of the container
flex.padding.right (metric): Space added to the right edge on the inside of the container
flex.padding.top (metric): Space added to the top edge on the inside of the container
flex.wrap (enum): If children should wrap automatically if there is not enough room on the main axis

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [AbstractLayout] <- [View] <- [Element]
Group: [Layout]
Schema children: [ViewsAndStatements]

Font

Defines a font in a Visual Style.

See also: [Style]

Attributes (9)

face (string)
linespacing (metric)
size (metric)
smoothing (enum)
spacing (metric)
style (enum)
themeid (string)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Group: [Styles]

FontResource

Defines a font resource.

Example

<FontResource url="fonts/SEMPRG_.TTF"/>

Attributes (4)

style (enum)

Inherited from [Resource]

url (string): url of the file

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Resource] <- [Element]
Group: [Resources]

Form

A Form is the top level view building block in a skin, accessible by name.

Description

There are two main use cases for forms: 1. A form is the entry point in the skin when the application wants to create a specific view. 2. A form can by instantiated from another form using the <View> tag. This allows structuring large view hierarchies into smaller forms, and reusing the same form in different places.

As an ImageView, a Form can also have a backgoround image or color.

Attributes (41)

buttons (enum)
firstfocus (string): The name of a view in the form that will become the focus view when the form opens. If this optional name is specified, the child views of the form are searched (depth-first) to find the first view with that name.

This view becomes focus view e.g. when the form is used to open a dialog or window. * helpid (string): A string id that refers to a page in the user documentation * windowstyle (enum): The style applied to the window when the form is opened as window

Inherited from [ImageView]

datatarget (string): name of an application object that manages dragging data onto the image
image (string): name of an image resource
provider (string): name of an application object that can provide an image
selectname (string): name of a parameter that selects the image frame (“normal” or “pressed”)

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum): an animation that is performed when the image changes
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [ImageView] <- [View] <- [Element]
Group: [General]
Schema children: [ViewsAndStatements]

Forms

Enclosing tag for all Forms in a skin xml file.

Frame

A frame is an area in a perspective that can be either empty or occupied by the view of a window class.

Description

The “groups” attribute is list of group names from window classes, separated by spaces. It specifies which window classes can appear in the frame. Complex arrangements can be build with horizontal or vertical frame groups, which will create a layout container for their contained frames.

Gradient

Defines a gradient.

Attributes (4)

endcolor (color)
startcolor (color)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Children: [LinearGradient] [RadialGradient]
Group: [Resources]
Schema children: [GradientStop]

GradientStop

Defines a gradient stop.

Attributes (4)

color (color)
position (float)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Group: [Resources]

Header

Specifies the header view of a scroll view.

Description

The <Header> tag can only appear as child of a <ScrollView> tag. The name attribute specifies the name of a form that is used to create the target view.

Attributes (33)

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Target] <- [View] <- [Element]
Group: [Views]
Schema children: [ViewsAndStatements]

HelpAnchor

Allows setting a helpid for the area of this view.

Attributes (34)

helpid (string): A string id that refers to a page in the user documentation

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [View] <- [Element]
Group: [General]
Schema children: [ViewsAndStatements]

Horizontal

Arranges child views horizontally, trying to fill the width of the Horizontal element.

Description

The intitial widths of the child views are considered their preferred widths. For a given container width, the total preferred with of all child views can result in either some remaining or missing width.

The horizontal layout tries to distribute this remaining or missing width equally among the child views, by either enlarging or shrinking the childs. But this is limited by their attachments and their size limits: Like in the basic layout of the View class, a view only get’s sized horizontally, if it’s attached left and right to it’s parent (attach=”left right”).

Attributes (37)

Inherited from [Layout]

layoutclass (string): name of the layout class to be used
margin (metric): outer margin (in pixels)
persistence.id (string): storage id used to store and restore the layout state
spacing (metric): spacing between views (in pixels)

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): options specific to the selected layout class
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Layout] <- [AbstractLayout] <- [View] <- [Element]
Group: [Layout]
Schema children: [ViewsAndStatements]

IconSet

Combines image files from a folder to an image resource with multiple frames.

Description

The url specifies a folder. The image files in that folder must have the format “icon_SxS.png” with S being the size (same width and height) of the image.

Depending on the “frames” attribute, different sets of image file names are searched for in that folder: If frames has the value “all”, the sizes 16, 32, 48, 64, 128, 256, 512. Otherwise only 16 and 32 used.

Example

<IconSet name="FileIcon:song" url="icons/song_doc.iconset"/>

Attributes (10)

Inherited from [Image]

adaptive (bool): adaptive images can adapt to the brightness of a given color by the framework
duration (float): duration of a filmstrip animation with this image
frames (string): number of frames in the image, or space-separated list of frame names
image (string): name of the image
margin (rect): margins used for some tile modes: “left, top, right, bottom”
template (bool): template images can be colorized by the framework
tile (enum): specifies how the image is tiled when used to fill a larger area

Inherited from [Resource]

url (string): url of the file

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Image] <- [Resource] <- [Element]
Group: [Resources]

Image

Defines an image resource.

Description

An image can be defined by specifying a file url, another image resource or a set of multiple frames.

Example

<!-- From file -->
<Image name="MyImage1" url="folder/file.png">

<!-- From another image -->
<Image name="MyImage2" image="MyImage1">

<!-- Set of multiple frames -->
<Image name="MyMultiImage">
    <Image name="myFrame1" url="a.png"/>
    <Image name="myFrame1" url="b.png"/>
</Image>

Attributes (10)

adaptive (bool): adaptive images can adapt to the brightness of a given color by the framework
duration (float): duration of a filmstrip animation with this image
frames (string): number of frames in the image, or space-separated list of frame names
image (string): name of the image
margin (rect): margins used for some tile modes: “left, top, right, bottom”
template (bool): template images can be colorized by the framework
tile (enum): specifies how the image is tiled when used to fill a larger area

Inherited from [Resource]

url (string): url of the file

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Resource] <- [Element]
Children: [IconSet] [ImagePart] [ShapeImage]
Group: [Resources]
Schema children: [Image.Children]

ImageFilter

Defines a filter applied when an image resource is loaded.

Attributes (4)

color (color): filter color
value (float): filter value

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Group: [Resources]

ImagePart

An ImagePart defines a excerpt of an image as a new image resource.

Example

<ImagePart name="MyPart" image="MyImage" size="0,3,7,1" />

Attributes (11)

size (size): recangle the describes the excerpt area in the original image

Inherited from [Image]

adaptive (bool): adaptive images can adapt to the brightness of a given color by the framework
duration (float): duration of a filmstrip animation with this image
frames (string): number of frames in the image, or space-separated list of frame names
image (string): name of the image
margin (rect): margins used for some tile modes: “left, top, right, bottom”
template (bool): template images can be colorized by the framework
tile (enum): specifies how the image is tiled when used to fill a larger area

Inherited from [Resource]

url (string): url of the file

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Image] <- [Resource] <- [Element]
Group: [Resources]
Schema children: [ImageFilter]

ImageView

Shows an Image or color.

Description

An ImageView can draw - a static image (attribute “image”) - an image provided by an image parameter (attribute “provider”) - a color (“backcolor” from visual style, option “colorize”)

The image will be resized to the view area.

An optional parameter “selectname” can be used to chose the image frame to be displayed: By default, the frame “nornal” is used when the parameter value is zero, otherwise “pressed”. With option “framesbyname”, the parameter value is interpreted as a frame name.

Import

Imports the contents of a complete skin package.

Description

The content of the imported skin is merged into the containing model.

Attributes (3)

url (string)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Group: [General]

Imports

Enclosing tag for all Imports in a skin xml file.

Include

Includes the content of another Skin xml file.

Description

The content of the included file is merged into the containing model.

Attributes (3)

url (string)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Group: [General]

Includes

Enclosing tag for all Includes in a skin xml file.

Invoker

Trigger action that invokes a method of a target object.

Description

Must be placed inside a <Trigger>.

The “target” path is evaluated as a property path relative to the triggering view to find the target object. The method “name” of the target object is then called.

An <Invoker> action cannot pass any arguments to the method.

See also: [Trigger]

Example

<Invoker target="window" name="popupContextMenu"/>
<Invoker target="parent.controller" name="select"/>

Attributes (5)

arg1 (string)
arg2 (string)
target (string): property path to a target object whose method will be invoked

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): Method name to be invoked in the target

Meta

Parents: [Element]
Group: [Animation]

ItemView

Attributes (40)

headerstyle (string): Name of a visual style that will be assigned to the column header view
scrolloptions (enum): Options for the surrounding scrollview

Inherited from [ScrollView]

hscroll.name (string): name of the horizontal scroll parameter
hscroll.style (string): name of a visual style for the horizontal scrollbar
persistence.id (string): storage id used to store and restore the scroll state
vscroll.name (string): name of the vertical scroll parameter
vscroll.style (string): name of a visual style for the vertical scrollbar

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Abstract
Parents: [ScrollView] <- [View] <- [Element]
Children: [DropBox] [ListView] [TreeView]
Group: [Views]
Schema children: [ViewsAndStatements]

Knob

A Knob is a circular element that rotates depending on the parameter value.

Description

A typical knob draws a static background image, with a partial circle around the center of the knob (set via option or visualstyle “circle”). The circle color is the “hilitecolor” or set from the optional “colorname” parameter. The visible angle range represents the parameter value. Additionally, a line from the center to the end of the circle can be drawn (option “indicator”).

A completely different approach to display a knob can be taken with the “filmstrip” option. In this case the full knob area is filled with one frame of the “filmstrip” bitmap, with the frame index being chosen based on the parameter value.

Label

A Label draws a static text.

Description

The text can be arranged in a single line or broken into multiple lines (option “multiline”).

Layout

Base class for anchor layout elements.

Description

Currently the following layout classes are available:

“box” (<Horizontal> or <Vertical>), “clipper”, “sizevariant” (<SizeVariant>) or “table” (<Table>)

The layout class can be specified via the attribute “layout.class”.

See also: [Horizontal] [Vertical] [SizeVariant] [Table]

Attributes (37)

layoutclass (string): name of the layout class to be used
margin (metric): outer margin (in pixels)
persistence.id (string): storage id used to store and restore the layout state
spacing (metric): spacing between views (in pixels)

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): options specific to the selected layout class
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [AbstractLayout] <- [View] <- [Element]
Children: [Horizontal] [SizeVariant] [Table] [Vertical]
Group: [Layout]
Schema children: [ViewsAndStatements]

LightSource3D

Attributes (7)

color (color): light color

Inherited from [SceneNode3D]

options (enum): node options
orientation (point3d): 3D orientation (yaw, pitch, roll in radians)
position (point3d): 3D position (x, y, z)
scale (point3d): 3D scale (x, y, z)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Abstract
Parents: [SceneNode3D] <- [Element]
Children: [AmbientLight3D] [DirectionalLight3D] [PointLight3D]
Group: [3D]

Line

A shape that draws a line.

Attributes (12)

end (point)
scalealign (enum)
start (point)

Inherited from [BasicShape]

Brush.color (color)
Brush.gradient (string)
Pen.color (color)
Pen.width (float)
shaperef (string)
size (size)
style (enum)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [BasicShape] <- [Element]
Group: [Shapes]

LinearGradient

Defines a linear gradient.

Attributes (6)

end (point)
start (point)

Inherited from [Gradient]

endcolor (color)
startcolor (color)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Gradient] <- [Element]
Group: [Resources]
Schema children: [GradientStop]

Link

Displays a text link.

Description

Displays a text link similar as in a web browser. It can be used with an url or a parameter.

An url for the link must be specified in a parent <Anchor> element. When a parameter (“name”) is used, no Anchor is required. The Link then behaves like a button. The title can be omitted, and child views can be used instead e.g. an ImageView.

ListView

A specialized scrollable view that manages a dynamic list of items with icons & text.

Description

Scrollable list view. The controller must provide a special “item model” as object that is referenced with the ListView name. The ListView has the 3 different view types that define the basic layout of items.

Attributes (42)

texttrimmode (enum)
viewtype (enum)

Inherited from [ItemView]

headerstyle (string): Name of a visual style that will be assigned to the column header view
scrolloptions (enum): Options for the surrounding scrollview

Inherited from [ScrollView]

hscroll.name (string): name of the horizontal scroll parameter
hscroll.style (string): name of a visual style for the horizontal scrollbar
persistence.id (string): storage id used to store and restore the scroll state
vscroll.name (string): name of the vertical scroll parameter
vscroll.style (string): name of a visual style for the vertical scrollbar

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [ItemView] <- [ScrollView] <- [View] <- [Element]
Group: [Views]
Schema children: [ViewsAndStatements]

Material3D

Attributes (4)

depthbias (float): depth bias
lightmask (enum): light mask

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Children: [SolidColorMaterial3D] [TextureMaterial3D]
Group: [3D]

Metric

Defines a metric in a Visual Style.

See also: [Style]

Attributes (3)

value (float)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Group: [Styles]

Model3D

Attributes (3)

Inherited from [Resource]

url (string): url of the file

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Object] <- [Resource] <- [Element]
Group: [3D]
Schema children: [Model3D.Children]

ModelNode3D

Attributes (7)

model (string): model name

Inherited from [SceneNode3D]

options (enum): node options
orientation (point3d): 3D orientation (yaw, pitch, roll in radians)
position (point3d): 3D position (x, y, z)
scale (point3d): 3D scale (x, y, z)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [SceneNode3D] <- [Element]
Group: [3D]

MultiToggle

A Button with multiple states.

Description

A MultiToggle is a Button that has as many stable states as the parameter (usually of type integer) has. Every click increments the parameter until it wraps around from maximum to minimum.

Attributes (39)

Inherited from [Button]

colorname (color)
icon (string): The icon is plotted onto the button. This allows the same background bitmap to be used and varied with the icon image.
image (string): Background image. The button uses different frames of the image to show its different states.
titlename (string)

Inherited from [Control]

command.category (string): If a control triggers a command, this is the command category
command.name (string): If a control triggers a command, this is the command name

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Toggle] <- [Button] <- [Control] <- [View] <- [Element]
Group: [Controls]
Schema children: [ViewsAndStatements]

Null

An empty view (with initially empty size).

Description

The Null element is only used to clarify the intended meaning when an empty view is used somewhere. It behaves the same as a view.

Attributes (33)

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Space] <- [View] <- [Element]
Group: [General]
Schema children: [ViewsAndStatements]

Object

Attributes (3)

Inherited from [Resource]

url (string): url of the file

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Abstract
Parents: [Resource] <- [Element]
Children: [Model3D] [Scene3D]
Group: [Resources]

Options

Defines an integer value or options enumeration in a Visual Style.

See also: [Style]

Attributes (5)

options (enum)
type (string)
value (int)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Children: [Align]
Group: [Styles]

Overlay

Replaces an existing form description with another one.

Attributes (4)

source (string)
target (string)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Group: [General]

Overlays

Enclosing tag for all Overlays in a skin xml file.

PageControl

A PageControl indicates the scroll position of a ScrollView.

Description

The PageControl must be used with a scroll parameter. It draws a row of dots, with one dot per scroll page, where the current page is highlited.

Parameter

Creates a parameter that can be used in the skin.

Description

Sometimes parameters are required for controlling some activity in the skin, but have no meaning to the application logic. These parameters can be defined inside a <Perspective> element. In a form description, these parameters can be addressed via the “CustomParams” controller of a perspective.

Example

<Perspective name="myPerspective">
    <!-- ... -->
    <Parameter name="myParam" type="int" range="0,32767"/>
</Perspective>

<!-- address via "CustomParams" controller of a perspective: -->
<Divider name="://Workspace/myWorkspaceID/myPerspectiveID/CustomParams/myParam"/>

Attributes (6)

options (enum)
range (string): “min,max” for int and float; “range, pagesize” for scroll parameter; comma-separated list of values for a list
type (enum)
value (string): initial parameter value

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Group: [Workspace]

Perspective

A perspective defines an arrangement of nested frames, that can each house a window class.

Picture

Shows an image and pops up view with a larger version of the image.

Description

Like an imageview, the image is resized to the view area. On a mouse click, a view pops up that shows the image in it’s full size, but not exceeding a certain limit, which is currently 1024 x 1024 pixels.

Attributes (37)

Inherited from [ImageView]

datatarget (string): name of an application object that manages dragging data onto the image
image (string): name of an image resource
provider (string): name of an application object that can provide an image
selectname (string): name of a parameter that selects the image frame (“normal” or “pressed”)

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum): an animation that is performed when the image changes
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [ImageView] <- [View] <- [Element]
Group: [Views]
Schema children: [ViewsAndStatements]

PointLight3D

Attributes (11)

attenuationconstant (float): attenuation constant term
attenuationfactor (float): attenuation linear factor
attenuationminimum (float): attenuation minimum
attenuationradius (float): attenuation radius

Inherited from [LightSource3D]

color (color): light color

Inherited from [SceneNode3D]

options (enum): node options
orientation (point3d): 3D orientation (yaw, pitch, roll in radians)
position (point3d): 3D position (x, y, z)
scale (point3d): 3D scale (x, y, z)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [LightSource3D] <- [SceneNode3D] <- [Element]
Group: [3D]

PopupBox

Shows a temporary pop-up view when clicked.

Description

On a mouse click, a PopupBox opens a view in a temporary modal popup window. The view is created from the skin using the specified “form.name”. The “popup” attribute specifies the alignment of the popup menu relative to the PopupBox. The popup will close when clicked outside of it.

Child views inside the <PopupBox> are displayed as usual, they also get the mouse states “mouse over” and “mouse down” when the PopupBox is either hovered or pressed.

Example

<!-- Inside the popup form description, the special controller name "source" can be used to
address the original controller that contains the <PopupBox> -->
<Form name="MyPopup">
  <using controller="source">
  </using>
</Form>

Attributes (36)

form.name (string): The name of the skin form that defines the view that pops up
popup (enum): Specifies the alignment of the popup relative to the PopupBox
popupstyle (string): Specifies the style that is used for the popup

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [View] <- [Element]
Group: [Views]
Schema children: [ViewsAndStatements]

ProgressBar

A ProgressBar is used to display the progress of an operation.

Description

A ProgressBar is usually used to display the progress of an operation, but can also be used with any parameter.

Similar to a ValueBar, a ProgressBar displays a value as a bar. Two separate images, “background” and “foreground” are used to draw the background and the bar.

Additionally, an optional “indicator” image can emphasize the boundary between the background and the bar.

If the foreground image has more than 2 frames, it is used as a filmstrip that cycles through all frames.

RadialGradient

Defines a radial gradient.

Attributes (6)

center (point)
radius (float)

Inherited from [Gradient]

endcolor (color)
startcolor (color)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Gradient] <- [Element]
Group: [Resources]
Schema children: [GradientStop]

RadioButton

A RadioButton sets a parameter to a specific value.

Description

A RadioButton sets a parameter to a specific value. It appears in the “on” state when the parameter has that value.

Usually multiple RadioButtons for the same parameter are used together to give direct access to different values.

Attributes (40)

value (string): The parameter value that this button represents

Inherited from [Button]

colorname (color)
icon (string): The icon is plotted onto the button. This allows the same background bitmap to be used and varied with the icon image.
image (string): Background image. The button uses different frames of the image to show its different states.
titlename (string)

Inherited from [Control]

command.category (string): If a control triggers a command, this is the command category
command.name (string): If a control triggers a command, this is the command name

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Button] <- [Control] <- [View] <- [Element]
Children: [ToolButton]
Group: [Controls]
Schema children: [ViewsAndStatements]

RangeSlider

In addition to a slider a RangeSlider uses a second parameter, set by the xml-attribute “name2”.

Description

The RangeSlider itself always ensures a positive range. The “validate” option ensures a positive range when values can be set externally. The “limit” option delimits the value ranges. Changing the upper value cannot change the lower value and vice versa.

Rectangle

A shape that draws a rectangle.

Attributes (11)

radius (int)
rect (rect)

Inherited from [BasicShape]

Brush.color (color)
Brush.gradient (string)
Pen.color (color)
Pen.width (float)
shaperef (string)
size (size)
style (enum)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [BasicShape] <- [Element]
Children: [Ellipse]
Group: [Shapes]

Resource

Base class for Resources.

See also: [Cursor] [FontResource] [IconSet] [Image] [ImagePart] [Color]

Attributes (3)

url (string): url of the file

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Children: [FontResource] [Image] [Object]
Group: [Resources]

Resources

Enclosing tag for all Resources in a skin xml file.

Description

Resources are Cursor, FontResource, IconSet, Image, ImagesPart, Color

See also: [Cursor] [FontResource] [IconSet] [Image] [ImagePart] [Color]

Attributes (2)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Group: [General]
Schema children: [Resources.Children]

Scene3D

Attributes (3)

Inherited from [Resource]

url (string): url of the file

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Object] <- [Resource] <- [Element]
Group: [3D]
Schema children: [Scene3D.Children]

SceneNode3D

Attributes (6)

options (enum): node options
orientation (point3d): 3D orientation (yaw, pitch, roll in radians)
position (point3d): 3D position (x, y, z)
scale (point3d): 3D scale (x, y, z)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Abstract
Parents: [Element]
Children: [Camera3D] [LightSource3D] [ModelNode3D]
Group: [3D]

SceneView3D

Attributes (33)

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [View] <- [Element]
Group: [3D]
Schema children: [ViewsAndStatements]

ScrollBar

Scrollbars are used in a ScrollView to indicate and manipulate the scrolling postion.

Description

Note: A Scrollview can automatically create ScrollBars or ScrollButtons.

ScrollButton

A Button that can be used to perform a single scroll step per click.

Description

When connected to a scroll parameter, this button perfroms a single scroll step when clicked.

The attribute “part” (“buttonup”, “buttondown”) specifies the scroll direction (these 2 values are also used for a horizontal scrollview for the left / right direction).

ScrollPicker

A ScrollPicker is value is a control displaying its current value in the center of an underlying scrollview.

Description

Like ValueBox or Knob it allows changing the value by dragging the mouse.: Can be used in vertical (default) or horizontal orientation, w/o warparound option (endless dial).

Example: standard scrollpicker usage

 <ScrollPicker name="foo" size="0,0,110,110"/>

 # Second horizontal example using the wraparound option
 <Style name="HorizontalScrollPickerStyle" inherit="Standard.ScrollPicker">
     <Metric name="itemSize" value="30"/>
     <Metric name="centerSize" value="35"/>
 </Style>
 <ScrollPicker name="bar" options="wraparound horizontal" style="HorizontalScrollPickerStyle" size="0,0,110,20"/>

Attributes (36)

applyname (string): parameter name for an optional, transparent apply button in the center

Inherited from [Control]

command.category (string): If a control triggers a command, this is the command category
command.name (string): If a control triggers a command, this is the command name

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Control] <- [View] <- [Element]
Group: [Controls]
Schema children: [ViewsAndStatements]

ScrollView

Used to show a part of larger view with the ability to scroll the visble part.

Description

A Scrollview has a so called clip view, that contains the content (target view). It can also have Scroll bars or scroll buttons for controlling the visible area.

For each direction, scrollbars can be added permanently (options “horizontal” , “vertical”) or only when required (options “autohideh”, “autohidev”, “autohideboth”).

Scroll buttons can be used as an alternative, e.g. when there is not enough space for scroll bars (options “hbuttons”, “vbuttons”, “autobuttonsh”, “autobuttonsv”).

Attributes (38)

hscroll.name (string): name of the horizontal scroll parameter
hscroll.style (string): name of a visual style for the horizontal scrollbar
persistence.id (string): storage id used to store and restore the scroll state
vscroll.name (string): name of the vertical scroll parameter
vscroll.style (string): name of a visual style for the vertical scrollbar

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [View] <- [Element]
Children: [ItemView]
Group: [Views]
Schema children: [Target]

SegmentBox

Displays a numeric value in distinct segments that can be incremented / decremented separately.

SelectBox

A SelectBox is a TextBox with an additional popup menu.

Description

The SelectBox shows a button besides the text. Clicking this button opens a popup menu that shows a list of possible parameter values for the user to choose from.

Setter

Trigger action that sets a property of a target object, or a parameter value.

Description

Must be placed inside a <Trigger>.

Sets the property of the given target “property” or “parameter” to the specified “value”.

The property path can be an absolute path, or a path relative to the triggering view. The value can be a constant literal, but when it starts with “@”, it is interpreted as another property path, and that source property value gets assigned to the target property.

When a “parameter” path is specified instead of “property”, the parameter is set to the (always constant) “value”.

See also: [Trigger]

Example

<Setter property="parent.parent.parent.value" value="@parent.name"/>
<Setter parameter="://WindowManager/StartPage" value="1"/>

Attributes (5)

parameter (string): path to a parameter to be set
property (string): path to a property to be set
value (string): value to be assigned to the property or parameter

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Group: [Animation]

Shape

A shape that does not draw anything itself, but contains child shapes.

Attributes (9)

Inherited from [BasicShape]

Brush.color (color)
Brush.gradient (string)
Pen.color (color)
Pen.width (float)
shaperef (string)
size (size)
style (enum)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [BasicShape] <- [Element]
Group: [Shapes]
Schema children: [Shapes.Children]

ShapeColorMapping

Attributes (3)

color (color): replacement string

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Group: [Resources]

ShapeImage

Defines an image resource using a vector graphics shape.

Attributes (10)

Inherited from [Image]

adaptive (bool): adaptive images can adapt to the brightness of a given color by the framework
duration (float): duration of a filmstrip animation with this image
frames (string): number of frames in the image, or space-separated list of frame names
image (string): name of the image
margin (rect): margins used for some tile modes: “left, top, right, bottom”
template (bool): template images can be colorized by the framework
tile (enum): specifies how the image is tiled when used to fill a larger area

Inherited from [Resource]

url (string): url of the file

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Image] <- [Resource] <- [Element]
Group: [Shapes]
Schema children: [ShapeColorMapping]

Shapes

Enclosing tag for all Shapes in a skin xml file.

SizeVariant

Dynamically selects one of it’s child elements, depending on the container width or height.

Description

Child elements must specify their minimum width or height in the “data.minsize” attribute. The best matching child view gets selected every time the container size changes.

Example

<SizeVariant options="vertical" height="100" attach="all">
    <Label title="tiny"/> <!-- used when parent height < 10 -->
    <Label title="small" data.minsize="10"/> <!-- used when parent height >= 10 and < 20 -->
    <Label title="large" data.minsize="20"/> <!-- used when parent height >= 20 -->
</SizeVariant>

Attributes (37)

Inherited from [Layout]

layoutclass (string): name of the layout class to be used
margin (metric): outer margin (in pixels)
persistence.id (string): storage id used to store and restore the layout state
spacing (metric): spacing between views (in pixels)

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): options specific to the selected layout class
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Layout] <- [AbstractLayout] <- [View] <- [Element]
Group: [Layout]
Schema children: [ViewsAndStatements]

Skin

Skin XML Document.

Description

The root of a skin file.

Attributes (2)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Group: [General]
Schema children: [Skin.Children]

Slider

A Slider has a handle that can be moved linearly to set a value.

Description

Depending on the orientation (options “horizontal “ or “vertical”) the handle can be moved to adjust the parameter value.

The slider can have a background image or color. An optional “colorname” parameter can be used to dynamically colorize the handle or bargraph. Additionally to or instead of the handle, it can draw a bar graph (option “bargraph”), which is a partially filled rectangle that represents the current parameter value (like a ValueBar).

SolidColorMaterial3D

Attributes (6)

color (color): material color
shininess (float): material shininess

Inherited from [Material3D]

depthbias (float): depth bias
lightmask (enum): light mask

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Material3D] <- [Element]
Group: [3D]

Space

An view with the initial predefined size “Spacing”.

Description

A Space view gets the width and height “Spacing” from the theme, if it has no or an empty specified size. Apart from that it behaves the same as a view.

Attributes (33)

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [View] <- [Element]
Children: [Null]
Group: [General]
Schema children: [ViewsAndStatements]

StartAnimation

Trigger action that starts an animation.

Description

Must be placed inside a <Trigger>.

Has no special attributes. The <Animation> has to be a child of this element.

See also: [Trigger] [Animation] [StopAnimation]

Example

<Triggers>
    <Trigger event="onAttached">
        <StartAnimation>
            <Animation property="children[scrollView].vpos" from="0" to="1" duration="60"/>
        </StartAnimation>
    </Trigger>
    <Trigger event="onRemoved">
        <StopAnimation property="children[scrollView].vpos"/>
    </Trigger>
</Triggers>

Attributes (2)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Group: [Animation]
Schema children: [Animation]

StopAnimation

Trigger action that stops an animation.

Description

Must be placed inside a <Trigger>.

Looks for an animation for the given “property” (path relative to the triggering view) and stops it.

String

Defines a string in a Visual Style.

See also: [Style]

Attributes (3)

value (string)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Group: [Styles]

Style

Visual Style definition.

Description

A Style defines the visual appearance of a view. It is collection of definitions for images, colors, metrics and fonts. It can be assigned to a view element via it’s “style” attribute. Styles with the attribute “appstyle” can also be accessed directly by the application for specific purposes.

Example

<Style name="MyStyle">
    <Font name="textfont" face="Arial" size="10" style="bold"/>
    <Color name="textcolor" color="#666666" />
    <Image name="background" image="SomeImage"/>
    <Metric name="padding.left" value="7"/>
    <Align name="textalign" align="left"/>
    <Options name="someOption" value="23"/>
    <Options name="someOption" type="Align.align" options="left top"/>
</Style>

Attributes (18)

appstyle (bool): make style accessible from all skin scopes
backcolor (color): color of background
border (metric): border (in pixels)
forecolor (color): color of foreground
hilitecolor (color): color used for a hilite or seleciton state
inherit (string): inherit elements from this style
override (bool): silence warning for styles that are replaced on purpose
strokewidth (metric): width (in pixels) of drawn lines
textalign (enum): text alignment
textcolor (color): color used for drawing text
textface (string): name of font face
textoptions (enum): text options
textsize (metric): size of text
textsmoothing (enum): smoothing of font
textstyle (enum): style of font
textthemeid (string): identifier of theme font

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Children: [StyleAlias] [ThemeElements]
Group: [Styles]
Schema children: [Style.Children]

StyleAlias

Visual Style Alias definition.

Description

A visual style that dynamically delegates to one of the listed styles based on a paramter value. The parameter must be globally accessible. The value of the parameter is interpreted as an index in the list of available styles.

Example

<StyleAlias name="MyStyle"
        parameter="://hostapp/Configuration/styleIndex"
        styles="MyFirstStyle MySecondStyle MyThirdStyle">
</StyleAlias>

Attributes (20)

parameter (string): Url of a parameter that selects on of the styles specified in “styles”
styles (string): The available style names, separted by spaces

Inherited from [Style]

appstyle (bool): make style accessible from all skin scopes
backcolor (color): color of background
border (metric): border (in pixels)
forecolor (color): color of foreground
hilitecolor (color): color used for a hilite or seleciton state
inherit (string): inherit elements from this style
override (bool): silence warning for styles that are replaced on purpose
strokewidth (metric): width (in pixels) of drawn lines
textalign (enum): text alignment
textcolor (color): color used for drawing text
textface (string): name of font face
textoptions (enum): text options
textsize (metric): size of text
textsmoothing (enum): smoothing of font
textstyle (enum): style of font
textthemeid (string): identifier of theme font

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Style] <- [Element]
Group: [Styles]
Schema children: [Style.Children]

Styles

Enclosing tag for all Styles in a skin xml file.

See also: [Style]

Attributes (2)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Group: [General]
Schema children: [Style]

SwipeBox

Used to allow a “swipe” with the mouse or finger over a row of controls.

Description

When the user swipes over the swipe box, all views in the area of the swipe box (they don’t have to be child views) receive mouse events when the mouse enters / moves inside / leaves them. This way it’s possible to perform one-shot gesture over controls that don’t support this directly (like e.g. Button does with it’s “swipe” option).

If the swipe box has a parameter (“name” attribute), swiping is only enabled when the parameter has the value “true”.

Attributes (36)

target (string): (optional) Name of a target Contol class. Only controls of the given class will be used when swiping.

Inherited from [Control]

command.category (string): If a control triggers a command, this is the command category
command.name (string): If a control triggers a command, this is the command name

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Control] <- [View] <- [Element]
Group: [Controls]
Schema children: [ViewsAndStatements]

TabView

Shows a list of tab buttons to control a parameter or chose a child view.

Description

A tab view draws a row of Tab buttons, which behave like radio buttons. One button is the active tab, which can be controlled by the parameter. When there is not enough space for all tabs, a menu button is appended as last button, that gives access to all tabs.

If the tab view has child views, the child view that correspond to the active tab is automatically added to the content area of the tab view (remaining height without tabs). This feature is optional, a tabview can also be used only for tab buttons, controlling the parameter of a variant view that switches chhild view.

Table

Arranges child views in a table grid.

Description

To define the number of row and columns, either the “rows” or “columns” attribute must be specified. (Then other one is calculated from the specified one and the number of views).

The rows as a whole are arranged vertically by the same algorithm used by <Vertical>, while columns are arranged horizontally as in <Horizontal>.

The optional attribute “cellratio” sizes childs with the given aspect ratio (width/height, e.g. 1 for square views).

Attributes (41)

cellratio (float): aspect ratio for cell views (width/height, e.g. 1 for square views)
columns (int): number of columns (uses as many rows as required)
mincellratio (float): optional minimum aspect ratio for cell views (width/height, e.g. 1 for square views)
rows (int): number of rows (uses as many columns as required)

Inherited from [Layout]

layoutclass (string): name of the layout class to be used
margin (metric): outer margin (in pixels)
persistence.id (string): storage id used to store and restore the layout state
spacing (metric): spacing between views (in pixels)

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): options specific to the selected layout class
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Layout] <- [AbstractLayout] <- [View] <- [Element]
Group: [Layout]
Schema children: [ViewsAndStatements]

Target

Specifies the target view of a scroll view.

Description

The <Target> tag can only appear as child of a <ScrollView> tag. The name attribute specifies the name of a form that is used to create the target view.

Attributes (33)

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [View] <- [Element]
Children: [Header]
Group: [Views]
Schema children: [ViewsAndStatements]

TextBox

A TextBox displays the text representation of a parameter.

Description

The text is drawn in the “textcolor” of the visual style. An optional “backgound” image or “backcolor” of the style is drawn unless the “transparent” option is set.

The optional “labelname” specifies a parameter that gives a label text to be appended to the parameter value (e.g. a unit).

The “texttrimmode” specifies how the text is abbreviated when it doesn’t fit in the TextBox.

When there is no “textcolor.bright” style definition, the “colorname” parameter is used as text color. If “textcolor.bright” is defined the “colorname” parameter is used to keep text readable on varying background colors. It is used to inform the TextBox about the background color. When the luminance of the TextBox goes below the “textcolor.threshold” value, it switches the text color to the alternative “textcolor.bright” color. If this background color is transparent “textcolor.transparent” will be used to draw the text

TextEditor

A text editor is a scrollable control for displaying and editing multiline text.

Attributes (41)

Inherited from [EditBox]

keyboardtype (enum)
placeholder (string): optional placeholder string that is displayed with textcolor. Placeholder when editString is empty.
returnkeytype (enum)

Inherited from [TextBox]

colorname (string): name of a color parameter that sets the textcolor or helps switching the text color depending on the background luminance
labelname (string): (optional) specifies a parameter that gives a label text to be appended to the parameter value (like a unit)
texttrimmode (enum): how the text should be abbreviated when it doesn’t fit in the view

Inherited from [Control]

command.category (string): If a control triggers a command, this is the command category
command.name (string): If a control triggers a command, this is the command name

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [EditBox] <- [TextBox] <- [Control] <- [View] <- [Element]
Group: [Controls]
Schema children: [ViewsAndStatements]

TextureMaterial3D

Attributes (5)

opacity (float): texture opacity

Inherited from [Material3D]

depthbias (float): depth bias
lightmask (enum): light mask

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Material3D] <- [Element]
Group: [3D]

TextureMaterial3D.Texture

Attributes (3)

options (enum): texture options

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Group: [3D]

ThemeElements

Attributes (18)

Inherited from [Style]

appstyle (bool): make style accessible from all skin scopes
backcolor (color): color of background
border (metric): border (in pixels)
forecolor (color): color of foreground
hilitecolor (color): color used for a hilite or seleciton state
inherit (string): inherit elements from this style
override (bool): silence warning for styles that are replaced on purpose
strokewidth (metric): width (in pixels) of drawn lines
textalign (enum): text alignment
textcolor (color): color used for drawing text
textface (string): name of font face
textoptions (enum): text options
textsize (metric): size of text
textsmoothing (enum): smoothing of font
textstyle (enum): style of font
textthemeid (string): identifier of theme font

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Style] <- [Element]
Group: [Styles]
Schema children: [ThemeElements.Children]

Toggle

A Button with two states.

Description

A Toggle is a Button with two stable states. On each click it toggles the parameter value between it’s minimum and maximum.

Attributes (39)

Inherited from [Button]

colorname (color)
icon (string): The icon is plotted onto the button. This allows the same background bitmap to be used and varied with the icon image.
image (string): Background image. The button uses different frames of the image to show its different states.
titlename (string)

Inherited from [Control]

command.category (string): If a control triggers a command, this is the command category
command.name (string): If a control triggers a command, this is the command name

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Button] <- [Control] <- [View] <- [Element]
Children: [CheckBox] [MultiToggle]
Group: [Controls]
Schema children: [ViewsAndStatements]

ToolButton

A ToolButton is a RadioButton with an additional icon.

Description

The ToolButton behaves like a RadioButton, but can have an icon like the normal Button. A ToolButton can also have an an additional “mode parameter” that is used for tools with different modes. But this feature is not available on skin level.

TreeView

A specialized scrollable view that manages a dynamic tree structure of items with icons & text.

Attributes (40)

Inherited from [ItemView]

headerstyle (string): Name of a visual style that will be assigned to the column header view
scrolloptions (enum): Options for the surrounding scrollview

Inherited from [ScrollView]

hscroll.name (string): name of the horizontal scroll parameter
hscroll.style (string): name of a visual style for the horizontal scrollbar
persistence.id (string): storage id used to store and restore the scroll state
vscroll.name (string): name of the vertical scroll parameter
vscroll.style (string): name of a visual style for the vertical scrollbar

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [ItemView] <- [ScrollView] <- [View] <- [Element]
Group: [Views]
Schema children: [ViewsAndStatements]

TriVectorPad

A Control to edit three parameters in a triangle.

Description

The summed-up value of these parameters is always 1.: With the “invert” option the sum is 2 in the corners and 1 at the snappoints (the edge-center points). If this control is used in addition with individual level controls, the “keeplevels” option allows different sums and reset the parameters to the original values when the handle is moved back to the initial position. (Alt/Option)+drag up-down can change the overall level in the “keeplevel” case

Triangle

A shape that draws a triangle.

Attributes (12)

point1 (point)
point2 (point)
point3 (point)

Inherited from [BasicShape]

Brush.color (color)
Brush.gradient (string)
Pen.color (color)
Pen.width (float)
shaperef (string)
size (size)
style (enum)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [BasicShape] <- [Element]
Group: [Shapes]

Trigger

A trigger reacts on an event, signaled by a view.

Description

The event can be any messsage signaled by a view (attribute “event”).

As a special case, a “propertyChanged” message can be handled, that only triggers when the property takes a given value. (attributes “property”, “value”). When the “trigger” option of a view is set, it sends “propertyChanged” messages for it’s “mousestate”, “value” and “visualState” (the latter two only for controls).

When a trigger receives the specified event or property change, it executes all of it’s actions, which are placed as child elemnts in the <Trigger>. Actions are executed in order of their appearance.

Available actions are:

<Setter>: sets a property of a target object, or a parameter value <Invoker>: invokes a method of a target object <StartAnimation>: starts an animation <StopAnimation>: stops an animation

A Trigger can only appear in the <Triggers> list of a Visual Style.

See also: [TriggerView] [Setter] [Invoker] [StartAnimation] [StopAnimation] [Triggers]

Example

<Style name="MyStyle">
    <Triggers>
        <Trigger event="onDoubleClick">
            <StartAnimation>
                <Animation property="children[scrollView].vpos" from="0" to="1" duration="98"/>
            </StartAnimation>
        </Trigger>

        <Trigger property="value" value="1">
            <Setter property="phase" value="0"/>
            <Invoker target="window" name="popupContextMenu"/>
        </Trigger>
    </Triggers>
</Style>

Attributes (5)

event (string): name of messsage signaled by a view, that fires the trigger
property (string): name of a property, the trigger fires when the property changes to the given “value”
value (string): valued of the property that fires the trigger

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Group: [Animation]
Schema children: [Trigger.Children]

TriggerView

A view that sends messages on certain gui events.

Description

These messages can be refered to in the “event” attribute of a <Trigger>.

Available events are “onAttached”, “onRemoved”, “onMouseDown”, “onSingleClick” “onDoubleClick”, “onSingleTap”, “onLongPress”, “onSwipe”, “onSwipeH”, “onSwipeV”.

See also: [Trigger]

Attributes (34)

gesturepriority (enum): priority in touch gesture handling

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [View] <- [Element]
Group: [Animation]
Schema children: [ViewsAndStatements]

Triggers

A List of <Trigger> elements in a <Style>.

See also: [Trigger]

Attributes (2)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Group: [Animation]
Schema children: [Trigger]

UpDownBox

Combination of two UpDownButtons.

Description

Contains an Up button and a Down button, horizontally or vertcically arranged.

UpDownButton

Increments or decrements a parameter.

Description

On each click the parameter is incremented (option “increment”, the default) or decremented (option “decrement”).

ValueBar

Displays a value as a horizontal or verical bar.

Description

A ValueBar is a passive control that displays a value as a partially filled rectangle over a background.

If the ValueBar’s visual style has an image, the frame “normal” is used for the background, and frame “normalOn” for the bar. Otherwise “forecolor” and “backcolor” from the visual style are used to draw the bar and the background as a filled rectangle. An optional “colorname” parameter can be used to dynamically colorize the hilitebar.

For biplolar parameters, the bar rectangle starts in the center of the view.

ValueBox

A ValueBox is an EditBox with a special mouse editing ability for numeric paramters.

Description

In addition to an EditBox for displaying and editing the text representation of a parameter, the ValueBox allows changing the value by dragging the mouse up and down, like a Knob does.

ValueControl

Attributes (36)

colorname (string): name of a color parameter used to colorize the hilite parts of value controls

Inherited from [Control]

command.category (string): If a control triggers a command, this is the command category
command.name (string): If a control triggers a command, this is the command name

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Abstract
Parents: [Control] <- [View] <- [Element]
Children: [Slider] [ValueBar] [VectorPad]
Group: [Controls]
Schema children: [ViewsAndStatements]

Variant

Dynamically selects one of it’s child elements.

Description

A Variant has always only one (or none) of its child elements attached as a child view. The active child can selected via a numeric parameter or a property of the controller.

Example

<!-- Example 1: A numeric parameter selects a view by index -->
<Variant name="indexValue" attach="fitsize">
    <Label title="Variant 0"/>    <!-- shown when indexValue is 0 -->
    <Label title="Variant 1"/>    <!-- shown when indexValue is 1 -->
</Variant>

<!-- Example 2: A property of the controller selects a view by property value. -->
<Variant property="indexValue" attach="fitsize">
    <Label title="Variant 0"/>    <!-- shown when indexValue is 0 -->
    <Label title="Variant 1"/>    <!-- shown when indexValue is 1 -->
</Variant>

<!-- Example 3: A boolean parameter switches a view/on/off -->
<Variant name="boolValue" attach="fitsize">
    <Label title="Variant"/>    <!-- shown when boolValue is true -->
</Variant>

Attributes (35)

controller (string): controller that has the property
property (string): property that selects the current view

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum): transition that happens when view is replaced
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [View] <- [Element]
Group: [Layout]
Schema children: [ViewsAndStatements]

VectorPad

A Control with two parameters interpreted as coordinates of a handle.

Description

The values of the two parameters are interpreteted as x and y coordinates in the view area. A handle is displayed at the resulting point and can be moved using the mouse.

Vertical

Arranges child views vertically.

Description

Behaves the same as <Horizontal>, but in the vertical direction.

View

The basic view class.

Description

The View class is the general view class that all other view classes inherit from. It has a size and some more general properties. Not all of these properties have a meaning in all derived view classes. When views are nested, the “attach” attribute specifies some basic layout behavior. Defines can be used for style and inside size, width and height attributes:

Example

<define w="10" z="MyStyle">
    <View style="$z" size="0,0,$w,20" attach="all">
    <View width="$w" height="20" attach="hcenter top bottom"/>
 </define>

Attributes (33)

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [Element]
Children: [AbstractLayout] [Border] [CommandBarView] [Control] [Delegate] [DialogGroup] [EmbeddedFrame] [HelpAnchor] [ImageView] [Label] [PopupBox] [SceneView3D] [ScrollView] [Space] [Target] [TriggerView] [Variant] [WebView] [Zoomable]
Group: [General]
Schema children: [ViewsAndStatements]

WebView

A WebView embeds a WebBrowser in a view.

Attributes (33)

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [View] <- [Element]
Group: [Views]
Schema children: [ViewsAndStatements]

WindowClass

A WindowClass describes a potential screen content.

Description

A WindowClass is identified by it’s “name”. The most important attributes are “form.name” and “controller”, which are used to create a view. A Command catgegory and name can be specified, that will open or close the window class.

The window manager of the application maintains a parameter for each window class that reflects the open/closed state of the window. It can be used to toggle it.

It depends on the application how a window class will appear on the screen. In the simplest case, it might just open a window for each window class. A more sophisticated approach is a workspace . In this case, the “group” attribute specifies in which workspace frames the window class can appear.

WindowClasses

Enclosing tag for all WindowClasses in a skin xml file.

Workspace

A Workspace is a collection of multiple perspectives, that the application can switch between.

Description

A special view called “PerspectiveContainer” can be placed e.g. in the application window. The view tree created by each perspective will be inserted into the PerspectiveContainer.

Workspaces

Enclosing tag for all Workspaces in a skin xml file.

Zoomable

Creates the content view specified in form.

Description

name and zooms it to fit into the available space.: The aspect ratio of the content view is preserved.

Example

<Zoomable form.name="MyContent" factors="0.5 1.0 1.5 2" size="0,0,100,100" attach="all"/>

Attributes (35)

factors (string): List of supported zoom factors (no restriction if empty)
form.name (string): The name of the form for creating the content view

Inherited from [View]

attach (enum): Attachment of the view relative to it’s parent
data.layoutpriority (int): Priority of this view when placed inside a <Horizontal> or <Vertical> layout with option “hidepriority”. Views with lower priority are hidden first, views with priority “-1” are never hidden.
data.minsize (int): For views inside a <SizeVariant>: minimum container width or height that selects this view (if there’s no view with a higher “data.minsize”)
flex.alignself (enum): Overrides the flexbox item alignment setting when layed out inside a flexbox [auto, flexstart, flexend, center, stretch]
flex.basis (metric): The initial item size along the main axis inside a flexbox. If set to “auto”, the size of the item in the main axis direction is used.
flex.grow (float): Defines how remaining space in the parent is distributed relative to the other children’s flex grow values
flex.inset (string): Shorthand for individual insets, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.inset.bottom (metric): Distance of the bottom edge to the corresponding parent edge if positionType is “absolute” or to the calculated bottom edge of this element if the positionType is “relative”
flex.inset.left (metric): Distance of the left edge to the corresponding parent edge if positionType is “absolute” or to the calculated left edge of this element if the positionType is “relative”
flex.inset.right (metric): Distance of the right edge to the corresponding parent edge if positionType is “absolute” or to the calculated right edge of this element if the positionType is “relative”
flex.inset.top (metric): Distance of the top edge to the corresponding parent edge if positionType is “absolute” or to the calculated top edge of this element if the positionType is “relative”
flex.margin (string): Shorthand for individual margins, enter between one and four values which are interpreted as follows: “left=top=right=bottom”, “left=right, top=bottom”, “left, top, right, bottom=0”, “left, top, right, bottom”
flex.margin.bottom (metric): Space added to the bottom of this element if the parent is a flexbox
flex.margin.left (metric): Space added to the left of this element if the parent is a flexbox
flex.margin.right (metric): Space added to the right of this element if the parent is a flexbox
flex.margin.top (metric): Space added to the top of this element if the parent is a flexbox
flex.positiontype (enum): Elements with absolute position type are excluded from the flow inside a flexbox and positioned absolutely
flex.shrink (float): Defines how much an element should shrink relative to other children’s flex shrink values, if there is not enough space
flex.sizemode (enum): Items can either fill the available space or hug their content [hug, hughorizontal, hugvertical, fill]
height (metric): Height of the view. Alternative forms: “size” and “rect”.
layerbacking (enum): Enables layer backing
localize (bool)
options (enum): Options that change behavior and appearance of the view
rect (rect): Size of the view in format “left, top, right, bottom”. Alternative forms are “size” and “width” + “height”.
size (size): Size of the view in format “left, top, width, height”. Alternative forms are “rect” and “width” + “height”.
sizelimits (rect): Minimum and maximum width and height of the view. Specified in order “minWidth, minHeight, maxWidth, maxHeight”. Specifying “0” for a minimum or “-1” for a maximum means unlimited. “none” means completely unlimited.
style (string): Name of the style class used to display the view
title (string): Title of the view. Some views display their title.
tooltip (string): Tooltip that appears when mouse rest on the view for a certain time
transition (enum)
width (metric): Width of the view. Alternative forms: “size” and “rect”.

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [View] <- [Element]
Group: [General]
Schema children: [ViewsAndStatements]

case

One alternative branch in a switch statement.

Description

The contained elements are used if the variable or property has the given value.

default

The default case in a switch statement.

Description

The contained elements are used if none of the case statements applies.

Attributes (2)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [statement] <- [Element]
Group: [General]
Schema children: [ViewsAndStatements]

define

Defines one or multiple skin variables.

Description

Any attribute=”value” pair that appears in the Define statement defines a new variable and its value. The variables are valid inside the <define> tag and in form instantiations from there.

Apart from simple assignments of constant literals or variable values, some extra directives can be used in the value (see code example).

Example

<define keyName="productKey" listName="productKeyList">
<define number="@property:number" left="@eval:$number % 2" permission="aux$number">

<!-- Additional directives:
@property:propertyPath:
resolve the value of a property (starting with current controller)

@select:$variable:str1,str2,...,strn:
select a string from a list, indexed by a given variable

@eval:
evaluate an arithmetic expresssion, with operators
+ - * / %, parenthesis, constant literals and variable values ($)
-->

Attributes (2)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [statement] <- [Element]
Group: [General]
Schema children: [ViewsAndStatements]

foreach

Describes a loop that repeats the contained elements.

Description

There are two ways to use a for statement:

Using an integer variable that starts at “start” and is incremented after each pass, until “count” passes hae been performed:
Using a string variable that iterates the string token in “in” (separeted by spaces):

Example

<!-- Example 1 -->
<foreach variable="$index" count="numTools">
<!-- Example 2 -->
<foreach variable="$n" in="$names">

Attributes (6)

count (int): Number of repetitions. Can be a variable (starting with $).
in (string): String tokens to be iterated, separted by spaces. Can be a variable (starting with $).
start (int): Start value of the loop variable. Can be a variable (starting with $). Default value is 0.
variable (string): The variable that controls the loop

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [statement] <- [Element]
Group: [General]
Schema children: [ViewsAndStatements]

if

Only produces the contained elements if the property or variable has the specified “value”.

Description

<if> is a shorthand notation for a <switch> with only one case.

statement

Base Class for all statements.

Description

Statements don’t produce views directly. They are used to express conditions, loops, etc.

Attributes (2)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Abstract
Parents: [Element]
Children: [case] [default] [define] [foreach] [styleselector] [switch] [using] [zoom]
Group: [General]
Schema children: [ViewsAndStatements]

styleselector

Defines a variable for a Style that dynamically delegates to one of the specified styles (which are defined as usual in the <Styles> section).

Description

The variables are valid inside the <styleselector> tag and in form instantiations from there. The active style is selected via a numeric parameter as index (specified as “name”).

Example

<!-- Example: changing the style of a button based on value of a parameter "selected":
(assuming "RedButtonStyle" and "BlueButtonStyle" are defined in <Styles>)
-->
<styleselector name="selected" variable="$ButtonStyle" styles="RedButtonStyle BlueButtonStyle">
    <Button name="close" style="$ButtonStyle"/>
</styleselector>

Attributes (4)

styles (string): The available style names, separted by spaces
variable (string): A variable that references the dynamic style (starting with $)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [statement] <- [Element]
Group: [General]
Schema children: [ViewsAndStatements]

switch

Selects one of multiple available alternative cases based on a property or variable value.

Example

<switch property="myProperty">
 <case value="1">
  <!-- ... -->
 </case>
 <case value="0">
  <!-- ... -->
 </case>
 <default>
  <!-- ... -->
 </defautl>
</switch>

Attributes (6)

controller (string): Optional controller for evaluating the property or variable
defined (string): Interpreted as variable name, evaluates to 1 if the variable exists. Used as an alternative to the “property” attribute.
not.defined (string): Same as ‘defined’, but negates the condition
property (string): Name of the property or variable ($)

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [statement] <- [Element]
Children: [if]
Group: [General]
Schema children: [switch.Children]

using

Switches to another controller.

Description

When the application creates a view from a form description, it provides a controller. The controller is responsible for providing parameters, special objects and creating custom views.

Inside a form, the using statement can be used to switch to another controller. Inside the using tag, this new controller will be the current controller that is queried for parameters etc.

Attributes (5)

controller (string): Relative or absolute path to the new controller. Examples:

relative path:: “Child/GrandChild” “../Sibling/Child”
absolute path:: “object://WindowManager”.

namespace (string)
optional (bool): Flag that controller might not exist

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [statement] <- [Element]
Group: [General]
Schema children: [ViewsAndStatements]

zoom

Defines a zoom factor that will be applied to views created inside the <zoom> tag.

Description

The sizes and selected visual style metrics of these views will be multiplied by the zoom factor.

Example

<zoom factor="1.5">
    <Button size="10,10,100,100" title="Zoomed"> <!-- resulting size will be "15,15,150,150" -->
</zoom>

Attributes (3)

factor (float): zoom factor for views

Inherited from [Element]

comment (string): Optional comment for developers and tool support
name (string): The name of an element plays different roles, depending on the class of the element

Meta

Parents: [statement] <- [Element]
Group: [General]
Schema children: [ViewsAndStatements]

Enums

Align.align

Enumerators

bottom
center
hcenter
left
right
top
vcenter

AlignView.options

Enumerators

childsizable: child is sizable on the edge
passcontextmenu: allow other context menu handler to constribute to menu

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

Animation.function

Enumerators

ease-in: FourCC (‘eain’), slower start
ease-in-out: FourCC (‘eaio’), slower start and end
ease-out: FourCC (‘eaou’), slower end
linear: FourCC (‘linr’), constant speed from start to end
toggle: FourCC (‘togg’), a single abrupt jump from start to end in the middle of the duration

Animation.options

Enumerators

autoreverse: animation goes backward and forward

Animation.reset

Enumerators

backwards: animation resets to start value (default)
forwards: animation resets to end value

BasicShape.style

Enumerators

fill: fill entire shape with “Brush.color” or “Brush.gradient”
margin: used by RectShape: left and top margins are used prevent scaling. It is expected that left equals right margin - and top equals bottom margin.
scale: shape cordinates should be scaled when drawing in other size (instead of raster graphic transformation); specify for top level shape
stroke: draw shape’s outline with “Pen.color” only
tiled: used by RectShape: draw shape tiled (don’t stretch the pen border - keep rect radius)

Button.options

Enumerators

hidefocus: don’t draw focus rectangle
ignoreimagesize: the background image size is ignored when auto sizing the button (only title size is used)
immediate: parameter is changed on mouse down instead of mouse up
intermediate: parameter is changed on mouse down and back on mouse up
leadingicon: icon sticks to the left with respect to a given padding
middle: used instead of ‘background’’ image when button has option ‘middle’
momentary: parameter is changed on mouse down. In case of toggle buttons, the parameter change is just momentary (i.e. does not latch) if the button is pressed longer than 500 milliseconds.
multiline: button title will be drawn with wordwrap - requires button width to be set
needscommandkey: button only responds to mouse/touch input when the command key is pressed
needsoptionkey: button only responds to mouse/touch input when the option key is pressed (multiple modifier requirements can be combined)
needsshiftkey: button only responds to mouse/touch input when the shift key is pressed
passive: button is used as passive control - mouse clicks fall thru
scaletext: uses a dynamic font size to fill the available space
silenttracking: instead of changing the paramter value, a special preview handler is used
slide: instead of a simple click, the button can be slided to it’s new state (dragging the mouse). An additional ‘slide’ image is used during this manipulation. It should have 1 frame per button state and an equal number of intermediate frames between them.
swipe: mouse can be dragged over a horizontal or vertical row of buttons with the same name (from different controllers) to switch them all to the same value as the first clicked button
trailingicon: icon sticks to the right with respect to a given padding

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

CheckBox.options

Enumerators

tristate: checkbox has three states: off, mixed, on

Inherited from [Toggle.options]

invert: parameter is inverted

Inherited from [Button.options]

hidefocus: don’t draw focus rectangle
ignoreimagesize: the background image size is ignored when auto sizing the button (only title size is used)
immediate: parameter is changed on mouse down instead of mouse up
intermediate: parameter is changed on mouse down and back on mouse up
leadingicon: icon sticks to the left with respect to a given padding
middle: used instead of ‘background’’ image when button has option ‘middle’
momentary: parameter is changed on mouse down. In case of toggle buttons, the parameter change is just momentary (i.e. does not latch) if the button is pressed longer than 500 milliseconds.
multiline: button title will be drawn with wordwrap - requires button width to be set
needscommandkey: button only responds to mouse/touch input when the command key is pressed
needsoptionkey: button only responds to mouse/touch input when the option key is pressed (multiple modifier requirements can be combined)
needsshiftkey: button only responds to mouse/touch input when the shift key is pressed
passive: button is used as passive control - mouse clicks fall thru
scaletext: uses a dynamic font size to fill the available space
silenttracking: instead of changing the paramter value, a special preview handler is used
slide: instead of a simple click, the button can be slided to it’s new state (dragging the mouse). An additional ‘slide’ image is used during this manipulation. It should have 1 frame per button state and an equal number of intermediate frames between them.
swipe: mouse can be dragged over a horizontal or vertical row of buttons with the same name (from different controllers) to switch them all to the same value as the first clicked button
trailingicon: icon sticks to the right with respect to a given padding

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

ColorBox.options

Enumerators

nowheel: no mousewheel

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

ComboBox.keyboardtype

Enumerators

automatic: input field type derived from parameter type
decimal: input field with decimal point
decimalsigned: input field for signed decimal values
default: default input field
email: email address input field
numeric: numeric input field
numericsigned: numeric input field for signed values
phone: phone number input field
url: URL input field

ComboBox.options

Enumerators

doubleclick: edit only if double-clicked
password: password-style editing

Inherited from [SelectBox.options]

closemenu: close menu when mouse/touch is outside, even when nothing was selected
dragopen: defer opening the menu until mouse is dragged / swipe is detected
hidebutton: don’t draw the select button
hidefocus: don’t draw focus rectangle
hideimage: hide the image taken from the visualStyle ‘states’ image or the parameter, in case it is an imageprovider
hidetext: do not display text
ignorekeys: ignore arrow keys (when menu closed); Option+Up/Down is still handled to open the menu
inversewheel: inverse mousewheel direction
leadingbutton: draw the select button on left hand side from the text
nomodifier: mouse down events with modifiers are ignored
nowheel: no mousewheel
offstate: draw the first item as it is in off-state
showtitle: show view title instead of parameter value
stayopenonclick: popup stays open on single click on an item, closes on doubleclick
trailingbutton: draw the select button on right hand side even when no text is displayed (hidetext)

Inherited from [TextBox.options]

fittext: fit text to display width
markup: interpret text markup
multiline: multiline text
nocontextmenu: suppress context menu
scaletext: uses a dynamic font size to fill the available space

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

ComboBox.returnkeytype

Enumerators

Inherited from [EditBox.returnkeytype]

default: platform default, for example ‘Return’
done: ‘Done’
go: ‘Go’
next: ‘Next’
search: ‘Search’
send: ‘Send’

Delegate.options

Enumerators

deferredremove: don’t remove child in removed (), but just before creating a new one in attached
keepview: never remove child in removed (), the view created in attached is kept as child forever

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

DialogButton.result

Enumerators

apply: user input is confirmed, dialog stays open
cancel: user input is discarded, dialog is closed
close: user input is discarded, dialog is closed
okay: user input is confirmed, dialog is closed

DialogGroup.options

Enumerators

primary: primary dialog group
secondary: secondary dialog group

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

Divider.options

Enumerators

childrenontop: divider can have children on top
master: in a group of dividers synced to the same parameter, this divider takes some extra care of syncing the fellow dividers to the parameter
outreachbottom: the divider’s outreach (if defined) should only be applied to the bottom neighbor
outreachleft: the divider’s outreach (if defined) should only be applied to the left neighbor
outreachright: the divider’s outreach (if defined) should only be applied to the right neighbor
outreachtop: the divider’s outreach (if defined) should only be applied to the top neighbor
reverse: the parameter value refers to the distance of the divider from the parent’s bottom / right instead of top / left (default)
slave: in a group of dividers synced to the same parameter, this divider does not modify the parameter when it moves

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

DropBox.options

Enumerators

alignend: align views at right (horizontal) or bottom (vertical) of DropBox instead of left / top
autoresize: dropbox height is resized to content when views are wrapped
centered: views are centered inside the dropbox
colorize: fill with background color
commonbasesize: layout is calculated based on a common initial size for all views
dragnowhere: items that are dragged to a place where they cannot be handled are removed
dragswipeh: start dragging the touched item on a horizontal swipe gesture (with high priority)
dragswipev: start dragging the touched item on a vertical swipe gesture (with high priority)
scrollwheel: enable mousewheel scrolling (can be unpleasant if child views also handle the wheel, e. G. controls).
wrap: views that don’t fit in the container are wrapped to a new row

Inherited from [ItemView.options]

autoselect: automatically select item under mouse
columnfocus: limit focus rectangle to the focussed column
dragswipeh: start dragging the touched item on a horizontal swipe gesture (with high priority)
dragswipev: start dragging the touched item on a vertical swipe gesture (with high priority)
exclusive: max. One item can be selected.
focusselectable: only selectable items can get the focus
header: show a header view above the itemview
nocontextmenu: don’t display a context menu
nodoubleclick: don’t try to detect doubleclicks
nodrag: don’t try to drag items
nofocus: don’t draw focus rectangle
nonamenavigation: don’t use name navigator (which steals key commands sometimes)
norubber: don’t try to start a rubberband selection
nounselect: don’t unselect items on mouse down in empty region
resizeredraw: redraw the view on resize (use if data is drawn right-aligned or centered)
selectfullwidth: draw selection over full available width, ignoring title-width
selection: enable selection of items
simplemouse: combined option: no drag, no rubberband, no doubleclick
swallowalphachars: swallow key events with alphabetical characters (when name navigation fails)
thumbnails: show item thumbnails

Inherited from [ScrollView.options]

allowzoom: let another touch handler take over on a zoom gesture
autobuttonsh: automatically show horizontal scroll buttons only when necessary
autobuttonsv: automatically show vertical scroll buttons only when necessary
autohideboth: automatically shows/hides both scrollbars when necessary
autohideh: automatically shows/hides horizontal scrollbar when necessary
autohidev: automatically shows/hides vertical scrollbar when necessary
canscrollh: allow horizontal scrolling even if the ScrollView has no (own) scrollbar or buttons
canscrollv: allow vertical scrolling even if the ScrollView has no (own) scrollbar or buttons
centertarget: center target if target is smaller than scroll view (do not combine with kScrollViewExtendTarget)
extendtarget: make the target at least as big as the scroll area
hbuttons: horizontal scroll buttons at left & right edge
hscrollspace: addional reserved space for horizontal scrollbar (avoid resizing of clip view, when kScrollViewAutoHideHBar is set)
latchwheel: view locks the mouse wheel scroll to itself (no child handling) for a limited time after the last handled mouse wheel event
layeredscroll: use graphic layers for scrolling, if available
limittoscreen: don’t grow larger than current monitor size when autosizing to content
mousescroll: allow scrolling by dragging the mouse in scroll view area
noscreenscroll: do not use os scroll functions, just invalidate instead
noswipe: no swipe gesture used for scrollviews
notiledlayers: when kScrollViewLayeredScroll is set, use a regular layer instead of a tiled one
omnidirectional: scrollview allows scrolling in both directions at the same time
pagecontrol: use pagecontrols instead of scrollbars
relativeresize: scrollview resizes the target, keeping the ratio of the visible and hidden area
scrollbypage: snap to full pages, limit touch-based scrolling to one page per gesture
scrollnotify: sends notifications about current postion during animation
snappedtarget: target height is multiple of snap height
snapviews: snap to subview positions; ignores the explicit snap value
snapviewsdeep: snap to subview positions recursively
targetlimits: adjust sizeLimits of ScrollView so that it can’t be larger than the target’s limits allow
vbuttons: vertical scroll buttons at top & bottom edge
vscrollspace: addional reserved space for vertical scrollbar (avoid automatic horizontal scrollbar, because of space covered when vertical bar is shown)

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

EditBox.keyboardtype

Enumerators

automatic: input field type derived from parameter type
decimal: input field with decimal point
decimalsigned: input field for signed decimal values
default: default input field
email: email address input field
numeric: numeric input field
numericsigned: numeric input field for signed values
phone: phone number input field
url: URL input field

EditBox.options

Enumerators

dialogedit: edit has dialog behavior
doubleclick: edit only if double-clicked
dragtext: drag a text selection to another position to cut and paste it
extended: use framework editing implementation instead of native text control (regardless of global configuration)
hidetext: do not display text
immediate: parameter gets updates while editing
musthittext: on mouseclick, edit only if the text was hit
noclearbutton: no clear button (X)
nosuggestions: no text suggestions
nowheel: no mousewheel
opaqueedit: draw background while editing, even if the control is transparent
password: password-style editing
permanentcaret: show caret permanently when not focused

Inherited from [TextBox.options]

fittext: fit text to display width
markup: interpret text markup
multiline: multiline text
nocontextmenu: suppress context menu
scaletext: uses a dynamic font size to fill the available space

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

EditBox.returnkeytype

Enumerators

default: platform default, for example ‘Return’
done: ‘Done’
go: ‘Go’
next: ‘Next’
search: ‘Search’
send: ‘Send’

Flexbox.flex.align

Enumerators

center
flexend
flexstart
stretch

Flexbox.flex.direction

Enumerators

column
columnreverse
row
rowreverse

Flexbox.flex.justify

Enumerators

center
flexend
flexstart
spacearound
spacebetween
spaceevenly

Flexbox.flex.wrap

Enumerators

nowrap
wrap
wrapreverse

Font.smoothing

Enumerators

antialias: anti-aliasing
default: default
fast: high speed/low quality
none: no anti-aliasing

Font.style

Enumerators

bold: bold
italic: italic
normal: no decoration
underline: underline

FontResource.style

Enumerators

Inherited from [Font.style]

bold: bold
italic: italic
normal: no decoration
underline: underline

Form.buttons

Enumerators

Inherited from [DialogButton.result]

apply: user input is confirmed, dialog stays open
cancel: user input is discarded, dialog is closed
close: user input is discarded, dialog is closed
okay: user input is confirmed, dialog is closed

Form.options

Enumerators

allowstretch
allowzoom
backgroundlayer
centerimage
colorize
disable
fitimage
framesbyname
hfitimagesize
highquality
ignoreimagesize
insertdata
selectonclick
swallow-mouseclick
swallow-mousewheel
swallowmouse
windowmaximize
windowmovable
windowsizable

Inherited from [ImageView.options]

allowstretch: allow to stretch image (requires fit option)
allowzoom: allow to zoom image (requires fit option)
backgroundlayer: create a layer for the background image
centerimage: center image
colorize: fill with backcolor/forecolor depending on the select parameter or colorize the background image
disable: disable view - don’t allow children to perform any edits
fitimage: fit image proportionally (+ select best resolution)
framesbyname: interpret string of select parameter as frame name in background image
hfitimagesize: autosize view to width of current image
highquality: use high quality image interpolation mode
ignoreimagesize: don’t auto size to background image when initial size is empty
insertdata: IDataTarget::insertData() will be called even if there is a custom drag handler
selectonclick: select when clicked
swallow-mouseclick: don’t allow parents to perform mouse clicks (for example: start a drag)
swallow-mousewheel: don’t allow parents to perform mouse wheel
swallowmouse
windowmaximize: user can maximize window with double click
windowmovable: user can move window by clicking in view
windowsizable: user can resize window by clicking in border areas

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

Form.windowstyle

Enumerators

center: window is shown centered
customframe: window has a custom frame
dialogstyle: default dialog window style: title bar, centered
floating: window is in floating layer
fullscreen: window can enter fullscreen mode
inflate: window size should be inflated to fill the main monitor
intermediate: window is below floating windows and above base layer windows
maximize: windows can be maximized
panelstyle: panel window style: title bar, floating
pluginhost: window hosts foreign views
restorecenter: restore last known window center position
restorepos: restore last known window position
restoresize: restore last known window size
seethru: window is half-transparent when inactive
shadow: window has a shadow effect
sheetstyle: sheet presentation style (not available on all platforms)
sizable: window has a sizable border
titlebar: window has a title bar
topmost: windows is above other applications
windowstyle: default window style: title bar

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

Frame.options

Enumerators

detached: is a target for detaching window classes
dividers: automatically insert dividers between childs
fill: frame is preferred to fill fill the container
focusframe: draw a rectangle around this frame when it’s active
fullscreen: for popup / detached frames: window can be fullscreen
horizontal: frame orientation horizontal
maximize: for popup / detached frames: window can be maximized
multiple: can be opened multiple times with different content
noactivate: the frame’s view (WindowBase) can’t get activated
othermonitor: for popup / detached frames: try to open on another monitor than the main window
pinnable: can be pinned: the current content may not be replaced then
popup: opens content in a floating popup window
required: frame is required
shared: for detached frames: multiple detached frames can share a common popup, whose name is given as the first group name
system: opens content in a special system area specified by the frame’s name (e.g. “StatusBar”)
vertical: frame orientation vertical
volatile: frame is inside an EmbeddedFrame that is not under control of the workspace

Image.tile

Enumerators

repeat-x: tile=”repeat-x”
repeat-xy: tile=”repeat-xy”
repeat-y: tile=”repeat-y”
stretch-xy: tile=”stretch-xy” respecting the margin
tile-x: tile=”tile-x”
tile-xy: tile=”tile-xy”
tile-y: tile=”tile-y”

ImageFilter.name

Enumerators

adaptlight
alpha
blend
colorize
grayscale
invert
lighten
noise
saturate
tint

ImageView.options

Enumerators

allowstretch: allow to stretch image (requires fit option)
allowzoom: allow to zoom image (requires fit option)
backgroundlayer: create a layer for the background image
centerimage: center image
colorize: fill with backcolor/forecolor depending on the select parameter or colorize the background image
disable: disable view - don’t allow children to perform any edits
fitimage: fit image proportionally (+ select best resolution)
framesbyname: interpret string of select parameter as frame name in background image
hfitimagesize: autosize view to width of current image
highquality: use high quality image interpolation mode
ignoreimagesize: don’t auto size to background image when initial size is empty
insertdata: IDataTarget::insertData() will be called even if there is a custom drag handler
selectonclick: select when clicked
swallow-mouseclick: don’t allow parents to perform mouse clicks (for example: start a drag)
swallow-mousewheel: don’t allow parents to perform mouse wheel
swallowmouse
windowmaximize: user can maximize window with double click
windowmovable: user can move window by clicking in view
windowsizable: user can resize window by clicking in border areas

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

ItemView.options

Enumerators

autoselect: automatically select item under mouse
columnfocus: limit focus rectangle to the focussed column
dragswipeh: start dragging the touched item on a horizontal swipe gesture (with high priority)
dragswipev: start dragging the touched item on a vertical swipe gesture (with high priority)
exclusive: max. One item can be selected.
focusselectable: only selectable items can get the focus
header: show a header view above the itemview
nocontextmenu: don’t display a context menu
nodoubleclick: don’t try to detect doubleclicks
nodrag: don’t try to drag items
nofocus: don’t draw focus rectangle
nonamenavigation: don’t use name navigator (which steals key commands sometimes)
norubber: don’t try to start a rubberband selection
nounselect: don’t unselect items on mouse down in empty region
resizeredraw: redraw the view on resize (use if data is drawn right-aligned or centered)
selectfullwidth: draw selection over full available width, ignoring title-width
selection: enable selection of items
simplemouse: combined option: no drag, no rubberband, no doubleclick
swallowalphachars: swallow key events with alphabetical characters (when name navigation fails)
thumbnails: show item thumbnails

Inherited from [ScrollView.options]

allowzoom: let another touch handler take over on a zoom gesture
autobuttonsh: automatically show horizontal scroll buttons only when necessary
autobuttonsv: automatically show vertical scroll buttons only when necessary
autohideboth: automatically shows/hides both scrollbars when necessary
autohideh: automatically shows/hides horizontal scrollbar when necessary
autohidev: automatically shows/hides vertical scrollbar when necessary
canscrollh: allow horizontal scrolling even if the ScrollView has no (own) scrollbar or buttons
canscrollv: allow vertical scrolling even if the ScrollView has no (own) scrollbar or buttons
centertarget: center target if target is smaller than scroll view (do not combine with kScrollViewExtendTarget)
extendtarget: make the target at least as big as the scroll area
hbuttons: horizontal scroll buttons at left & right edge
hscrollspace: addional reserved space for horizontal scrollbar (avoid resizing of clip view, when kScrollViewAutoHideHBar is set)
latchwheel: view locks the mouse wheel scroll to itself (no child handling) for a limited time after the last handled mouse wheel event
layeredscroll: use graphic layers for scrolling, if available
limittoscreen: don’t grow larger than current monitor size when autosizing to content
mousescroll: allow scrolling by dragging the mouse in scroll view area
noscreenscroll: do not use os scroll functions, just invalidate instead
noswipe: no swipe gesture used for scrollviews
notiledlayers: when kScrollViewLayeredScroll is set, use a regular layer instead of a tiled one
omnidirectional: scrollview allows scrolling in both directions at the same time
pagecontrol: use pagecontrols instead of scrollbars
relativeresize: scrollview resizes the target, keeping the ratio of the visible and hidden area
scrollbypage: snap to full pages, limit touch-based scrolling to one page per gesture
scrollnotify: sends notifications about current postion during animation
snappedtarget: target height is multiple of snap height
snapviews: snap to subview positions; ignores the explicit snap value
snapviewsdeep: snap to subview positions recursively
targetlimits: adjust sizeLimits of ScrollView so that it can’t be larger than the target’s limits allow
vbuttons: vertical scroll buttons at top & bottom edge
vscrollspace: addional reserved space for vertical scrollbar (avoid automatic horizontal scrollbar, because of space covered when vertical bar is shown)

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

ItemView.scrolloptions

Enumerators

Inherited from [ScrollView.options]

allowzoom: let another touch handler take over on a zoom gesture
autobuttonsh: automatically show horizontal scroll buttons only when necessary
autobuttonsv: automatically show vertical scroll buttons only when necessary
autohideboth: automatically shows/hides both scrollbars when necessary
autohideh: automatically shows/hides horizontal scrollbar when necessary
autohidev: automatically shows/hides vertical scrollbar when necessary
canscrollh: allow horizontal scrolling even if the ScrollView has no (own) scrollbar or buttons
canscrollv: allow vertical scrolling even if the ScrollView has no (own) scrollbar or buttons
centertarget: center target if target is smaller than scroll view (do not combine with kScrollViewExtendTarget)
extendtarget: make the target at least as big as the scroll area
hbuttons: horizontal scroll buttons at left & right edge
hscrollspace: addional reserved space for horizontal scrollbar (avoid resizing of clip view, when kScrollViewAutoHideHBar is set)
latchwheel: view locks the mouse wheel scroll to itself (no child handling) for a limited time after the last handled mouse wheel event
layeredscroll: use graphic layers for scrolling, if available
limittoscreen: don’t grow larger than current monitor size when autosizing to content
mousescroll: allow scrolling by dragging the mouse in scroll view area
noscreenscroll: do not use os scroll functions, just invalidate instead
noswipe: no swipe gesture used for scrollviews
notiledlayers: when kScrollViewLayeredScroll is set, use a regular layer instead of a tiled one
omnidirectional: scrollview allows scrolling in both directions at the same time
pagecontrol: use pagecontrols instead of scrollbars
relativeresize: scrollview resizes the target, keeping the ratio of the visible and hidden area
scrollbypage: snap to full pages, limit touch-based scrolling to one page per gesture
scrollnotify: sends notifications about current postion during animation
snappedtarget: target height is multiple of snap height
snapviews: snap to subview positions; ignores the explicit snap value
snapviewsdeep: snap to subview positions recursively
targetlimits: adjust sizeLimits of ScrollView so that it can’t be larger than the target’s limits allow
vbuttons: vertical scroll buttons at top & bottom edge
vscrollspace: addional reserved space for vertical scrollbar (avoid automatic horizontal scrollbar, because of space covered when vertical bar is shown)

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

Knob.options

Enumerators

centered: draw centered bargraph (like bipolar param)
circle: a partial circle around the center is drawn
endless: knob works as an endless dial
filmstrip: ‘background’ image should be used as a filmstrip
indicator: a line from the center to the end of the circle is drawn

Inherited from [Slider.options]

bargraph: draw bar graph
centered: draw centered bargraph (like bipolar param)
defaultcentered: default value is used as center value for bargraph style
doubletap: slider notifies controller on double tap instead of parameter reset
globalmode: follow global slider mode
inversewheel: inverse mousewheel direction
notouchreset: don’t reset slider via touch input
nowheel: no mousewheel
optionclick: slider notifies controller on option+click
passive: slider is used as passive control - mouse clicks fall through
resetclick: slider notifies controller on reset click
reverse: draw reversed value (like reverse param)
swipe: swipe with right mouse button to copy value to related sliders
thinhandle: draw thin handle
tickscale: draw tick scale in slider (requires a IParamCurve that provides the ITickScale interface)
tooltip: show value tooltip while editing
xyediting: xy editing - enables vertical mouse movements for horizontal sliders and vice versa

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

Label.options

Enumerators

colorize: fill with “backcolor” (TextBox look)
markup: interpret text markup
multiline: multiline label

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

Layout.options

Enumerators

adaptive: views get a chance to constrain the proposed size via View::constrainSize ()
commonbasesize: layout is calculated based on a common initial size for all views (updated when a view changes its size)
hidepriority: views that don’t fit in the container are hidden, lowest priority first
no-minlimit: layout view reports 0 as minimum width (height), ignoring the value calculated from child views
reverse: start placing views at right (bottom) edge
unifysizes: try to give all views the same height (horizontal) or width (vertical)
wrap: views that don’t fit in the container are wrapped to a new row

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

LayoutClasses

Enumerators

box
clipper
flexbox
sizevariant
table

Line.scalealign

Enumerators

bottom
right

Link.options

Enumerators

button: link draws as button
fittitle: fit title to display width
urltitle: title is the url

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

ListView.options

Enumerators

autocentericons: auto-center list items to fill the available horizontal space
autosizeitems: auto-size list items to fill the available horizontal space
centerrows: center rows in listView
drawcustomitem: model draws item
extendlastcolumn: extend last column to right edge of view
hittitle: in title column, mouse must hit the actual text
navigateflat: interpret ‘Up’ / ‘Down’ and ‘Left’ / ‘Right’ commands as ‘previous / next item’ (no spatial navigation; useful with switchable view types, when commands are mapped to e. G. remote buttons).
noclipcells: cells are allowed to draw outside their cell rectangle
nodefaulticon: explicitly hide the default icon
nolinebreak: no line break in icon mode, all icons are placed in one row
swipetodelete: swipe horizontal on item to bring up a delete button
switchview: switch view type via commands & context menu

Inherited from [ItemView.options]

autoselect: automatically select item under mouse
columnfocus: limit focus rectangle to the focussed column
dragswipeh: start dragging the touched item on a horizontal swipe gesture (with high priority)
dragswipev: start dragging the touched item on a vertical swipe gesture (with high priority)
exclusive: max. One item can be selected.
focusselectable: only selectable items can get the focus
header: show a header view above the itemview
nocontextmenu: don’t display a context menu
nodoubleclick: don’t try to detect doubleclicks
nodrag: don’t try to drag items
nofocus: don’t draw focus rectangle
nonamenavigation: don’t use name navigator (which steals key commands sometimes)
norubber: don’t try to start a rubberband selection
nounselect: don’t unselect items on mouse down in empty region
resizeredraw: redraw the view on resize (use if data is drawn right-aligned or centered)
selectfullwidth: draw selection over full available width, ignoring title-width
selection: enable selection of items
simplemouse: combined option: no drag, no rubberband, no doubleclick
swallowalphachars: swallow key events with alphabetical characters (when name navigation fails)
thumbnails: show item thumbnails

Inherited from [ScrollView.options]

allowzoom: let another touch handler take over on a zoom gesture
autobuttonsh: automatically show horizontal scroll buttons only when necessary
autobuttonsv: automatically show vertical scroll buttons only when necessary
autohideboth: automatically shows/hides both scrollbars when necessary
autohideh: automatically shows/hides horizontal scrollbar when necessary
autohidev: automatically shows/hides vertical scrollbar when necessary
canscrollh: allow horizontal scrolling even if the ScrollView has no (own) scrollbar or buttons
canscrollv: allow vertical scrolling even if the ScrollView has no (own) scrollbar or buttons
centertarget: center target if target is smaller than scroll view (do not combine with kScrollViewExtendTarget)
extendtarget: make the target at least as big as the scroll area
hbuttons: horizontal scroll buttons at left & right edge
hscrollspace: addional reserved space for horizontal scrollbar (avoid resizing of clip view, when kScrollViewAutoHideHBar is set)
latchwheel: view locks the mouse wheel scroll to itself (no child handling) for a limited time after the last handled mouse wheel event
layeredscroll: use graphic layers for scrolling, if available
limittoscreen: don’t grow larger than current monitor size when autosizing to content
mousescroll: allow scrolling by dragging the mouse in scroll view area
noscreenscroll: do not use os scroll functions, just invalidate instead
noswipe: no swipe gesture used for scrollviews
notiledlayers: when kScrollViewLayeredScroll is set, use a regular layer instead of a tiled one
omnidirectional: scrollview allows scrolling in both directions at the same time
pagecontrol: use pagecontrols instead of scrollbars
relativeresize: scrollview resizes the target, keeping the ratio of the visible and hidden area
scrollbypage: snap to full pages, limit touch-based scrolling to one page per gesture
scrollnotify: sends notifications about current postion during animation
snappedtarget: target height is multiple of snap height
snapviews: snap to subview positions; ignores the explicit snap value
snapviewsdeep: snap to subview positions recursively
targetlimits: adjust sizeLimits of ScrollView so that it can’t be larger than the target’s limits allow
vbuttons: vertical scroll buttons at top & bottom edge
vscrollspace: addional reserved space for vertical scrollbar (avoid automatic horizontal scrollbar, because of space covered when vertical bar is shown)

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

ListView.texttrimmode

Enumerators

Inherited from [TextBox.texttrimmode]

default
keepend: put “..” to the right but leave last four characters
left: put “..” to the left
middle: put “..” in the middle
numeric: like kTrimModeKeepEnd, but removes spaces first (e.g. between a number and a unit)
right: put “..” to the right

ListView.viewtype

Enumerators

details: vertical list of items with multiple columns
icons: two-dimensional arrangement of icons & title
list: vertical list of items with icon & title

Material3D.lightmask

Enumerators

AmbientLight3D
DirectionalLight3D
PointLight3D_0
PointLight3D_1
PointLight3D_2
PointLight3D_3
PointLight3D_4

MultiToggle.options

Enumerators

decrement: parameter is decremented on push

Inherited from [Toggle.options]

invert: parameter is inverted

Inherited from [Button.options]

hidefocus: don’t draw focus rectangle
ignoreimagesize: the background image size is ignored when auto sizing the button (only title size is used)
immediate: parameter is changed on mouse down instead of mouse up
intermediate: parameter is changed on mouse down and back on mouse up
leadingicon: icon sticks to the left with respect to a given padding
middle: used instead of ‘background’’ image when button has option ‘middle’
momentary: parameter is changed on mouse down. In case of toggle buttons, the parameter change is just momentary (i.e. does not latch) if the button is pressed longer than 500 milliseconds.
multiline: button title will be drawn with wordwrap - requires button width to be set
needscommandkey: button only responds to mouse/touch input when the command key is pressed
needsoptionkey: button only responds to mouse/touch input when the option key is pressed (multiple modifier requirements can be combined)
needsshiftkey: button only responds to mouse/touch input when the shift key is pressed
passive: button is used as passive control - mouse clicks fall thru
scaletext: uses a dynamic font size to fill the available space
silenttracking: instead of changing the paramter value, a special preview handler is used
slide: instead of a simple click, the button can be slided to it’s new state (dragging the mouse). An additional ‘slide’ image is used during this manipulation. It should have 1 frame per button state and an equal number of intermediate frames between them.
swipe: mouse can be dragged over a horizontal or vertical row of buttons with the same name (from different controllers) to switch them all to the same value as the first clicked button
trailingicon: icon sticks to the right with respect to a given padding

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

Parameter.options

Enumerators

storable: parameter is storable

Parameter.type

Enumerators

float: numerical value floating point
int: numerical value integer
list: list of values
scroll: scroll parameter
string: string value

Perspective.options

Enumerators

explicit: perspective can only be opened by explicit intent, e.g. not via rotation
fullscreen: perspective should be appear in fullscreen
windowtransition: a specified transition should be applied to the whole window, not only to the perspective content (useful when system frames outside change their content, too)

Perspective.orientation

Enumerators

landscape: the horizontal edge is longer
portrait: the vertical edge is longer

Perspective.transition

Enumerators

Inherited from [View.transition]

conceal: new content slides in on top of old content (from right)
fade: old content fades out while new content becomes visible
fall: new content falls on top of old content
lift: old content lifts up and new content is revealed while (inverse of fall)
movein: new content slides in on top of old content (from left)
moveout: old content slides out and new content is revealed (to left - inverse of movein)
none: no transition
push: new content pushes old content to the right as it slides in
pushdown: new content pushes old content to the bottom as it slides in
pushleft: old content pushed to the left as new content slides in (inverse of push)
pushup: old content pushed to the top as new content slides in (inverse of pushdown)
reveal: old content slides out and new content is revealed (to right - inverse of conceal)
rise: new content rises on top of old content
sink: old content sinks down and new content is revealed (inverse of rise)
zoom: new content is zoomed in on top of old content
zoomin: new content is zoomed in on top of old content
zoomout: old content is zoomed out on top of new content (inverse of zoom)

PopupBox.options

Enumerators

doubleclick: double-click opens popup
hasparameter: name attribute specifies a bool parameter that indicates the popup state and can be used to trigger the popup (instead of a popupSelectorClient as object / component)
keepmousepos: for popup slider: don’t manipulate mouse pointer position
mouseinside: popup opens when mouse enters PopupBox and closes when mouse leaves
nowheel: no mousewheel
overrideposition: popup will move itself to preferred position
slider: popup a slider for the param in name attribute
wantsfocus: PopupBox will take focus
wantsmouseview: PopupBox will become mouse view (before child views)

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

RadioButton.options

Enumerators

toggle: parameter is set to min if radiovalue is already set

Inherited from [Button.options]

hidefocus: don’t draw focus rectangle
ignoreimagesize: the background image size is ignored when auto sizing the button (only title size is used)
immediate: parameter is changed on mouse down instead of mouse up
intermediate: parameter is changed on mouse down and back on mouse up
leadingicon: icon sticks to the left with respect to a given padding
middle: used instead of ‘background’’ image when button has option ‘middle’
momentary: parameter is changed on mouse down. In case of toggle buttons, the parameter change is just momentary (i.e. does not latch) if the button is pressed longer than 500 milliseconds.
multiline: button title will be drawn with wordwrap - requires button width to be set
needscommandkey: button only responds to mouse/touch input when the command key is pressed
needsoptionkey: button only responds to mouse/touch input when the option key is pressed (multiple modifier requirements can be combined)
needsshiftkey: button only responds to mouse/touch input when the shift key is pressed
passive: button is used as passive control - mouse clicks fall thru
scaletext: uses a dynamic font size to fill the available space
silenttracking: instead of changing the paramter value, a special preview handler is used
slide: instead of a simple click, the button can be slided to it’s new state (dragging the mouse). An additional ‘slide’ image is used during this manipulation. It should have 1 frame per button state and an equal number of intermediate frames between them.
swipe: mouse can be dragged over a horizontal or vertical row of buttons with the same name (from different controllers) to switch them all to the same value as the first clicked button
trailingicon: icon sticks to the right with respect to a given padding

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

RangeSlider.options

Enumerators

invertible: first value can be above second value - not compatible with ‘validate’
limit: lower and upper limits for value changes defined by boundaries
validate: external value changes will be validated (first value cannot be above second value)

Inherited from [Slider.options]

bargraph: draw bar graph
centered: draw centered bargraph (like bipolar param)
defaultcentered: default value is used as center value for bargraph style
doubletap: slider notifies controller on double tap instead of parameter reset
globalmode: follow global slider mode
inversewheel: inverse mousewheel direction
notouchreset: don’t reset slider via touch input
nowheel: no mousewheel
optionclick: slider notifies controller on option+click
passive: slider is used as passive control - mouse clicks fall through
resetclick: slider notifies controller on reset click
reverse: draw reversed value (like reverse param)
swipe: swipe with right mouse button to copy value to related sliders
thinhandle: draw thin handle
tickscale: draw tick scale in slider (requires a IParamCurve that provides the ITickScale interface)
tooltip: show value tooltip while editing
xyediting: xy editing - enables vertical mouse movements for horizontal sliders and vice versa

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

SceneNode3D.options

Enumerators

hittesting

ScrollButton.part

Enumerators

buttondown: down or left button
buttonup: up or right button
handle: scrollbar handle
pagedown: page down or page right button
pageup: page up or page left button
trackarea: area where scrollbar handle can be moved

ScrollPicker.options

Enumerators

digitmode: the renderer uses single digit-bitmaps for integer parameters (no wrap- or flat-mode support)
flat: barrel appears to be flat
hideimage: disable carousel mode for images
wraparound: no stops at min or max - the value is wrapped around when exceeding min/max

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

ScrollView.options

Enumerators

allowzoom: let another touch handler take over on a zoom gesture
autobuttonsh: automatically show horizontal scroll buttons only when necessary
autobuttonsv: automatically show vertical scroll buttons only when necessary
autohideboth: automatically shows/hides both scrollbars when necessary
autohideh: automatically shows/hides horizontal scrollbar when necessary
autohidev: automatically shows/hides vertical scrollbar when necessary
canscrollh: allow horizontal scrolling even if the ScrollView has no (own) scrollbar or buttons
canscrollv: allow vertical scrolling even if the ScrollView has no (own) scrollbar or buttons
centertarget: center target if target is smaller than scroll view (do not combine with kScrollViewExtendTarget)
extendtarget: make the target at least as big as the scroll area
hbuttons: horizontal scroll buttons at left & right edge
hscrollspace: addional reserved space for horizontal scrollbar (avoid resizing of clip view, when kScrollViewAutoHideHBar is set)
latchwheel: view locks the mouse wheel scroll to itself (no child handling) for a limited time after the last handled mouse wheel event
layeredscroll: use graphic layers for scrolling, if available
limittoscreen: don’t grow larger than current monitor size when autosizing to content
mousescroll: allow scrolling by dragging the mouse in scroll view area
noscreenscroll: do not use os scroll functions, just invalidate instead
noswipe: no swipe gesture used for scrollviews
notiledlayers: when kScrollViewLayeredScroll is set, use a regular layer instead of a tiled one
omnidirectional: scrollview allows scrolling in both directions at the same time
pagecontrol: use pagecontrols instead of scrollbars
relativeresize: scrollview resizes the target, keeping the ratio of the visible and hidden area
scrollbypage: snap to full pages, limit touch-based scrolling to one page per gesture
scrollnotify: sends notifications about current postion during animation
snappedtarget: target height is multiple of snap height
snapviews: snap to subview positions; ignores the explicit snap value
snapviewsdeep: snap to subview positions recursively
targetlimits: adjust sizeLimits of ScrollView so that it can’t be larger than the target’s limits allow
vbuttons: vertical scroll buttons at top & bottom edge
vscrollspace: addional reserved space for vertical scrollbar (avoid automatic horizontal scrollbar, because of space covered when vertical bar is shown)

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

SegmentBox.options

Enumerators

nocontextmenu: suppress context menu
scaletext: uses a dynamic font size to fill the available space
separatedigits: draw each digit separately (default: one string per segment)
static: control is only for display and cannot be edited

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

SelectBox.options

Enumerators

closemenu: close menu when mouse/touch is outside, even when nothing was selected
dragopen: defer opening the menu until mouse is dragged / swipe is detected
hidebutton: don’t draw the select button
hidefocus: don’t draw focus rectangle
hideimage: hide the image taken from the visualStyle ‘states’ image or the parameter, in case it is an imageprovider
hidetext: do not display text
ignorekeys: ignore arrow keys (when menu closed); Option+Up/Down is still handled to open the menu
inversewheel: inverse mousewheel direction
leadingbutton: draw the select button on left hand side from the text
nomodifier: mouse down events with modifiers are ignored
nowheel: no mousewheel
offstate: draw the first item as it is in off-state
showtitle: show view title instead of parameter value
stayopenonclick: popup stays open on single click on an item, closes on doubleclick
trailingbutton: draw the select button on right hand side even when no text is displayed (hidetext)

Inherited from [TextBox.options]

fittext: fit text to display width
markup: interpret text markup
multiline: multiline text
nocontextmenu: suppress context menu
scaletext: uses a dynamic font size to fill the available space

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

Slider.mode

Enumerators

jump: slider handle is allowed to jump
relative: slider can be hit anywhere; handle does not jump but moves relatively
touch: slider handle must be hit

Slider.options

Enumerators

bargraph: draw bar graph
centered: draw centered bargraph (like bipolar param)
defaultcentered: default value is used as center value for bargraph style
doubletap: slider notifies controller on double tap instead of parameter reset
globalmode: follow global slider mode
inversewheel: inverse mousewheel direction
notouchreset: don’t reset slider via touch input
nowheel: no mousewheel
optionclick: slider notifies controller on option+click
passive: slider is used as passive control - mouse clicks fall through
resetclick: slider notifies controller on reset click
reverse: draw reversed value (like reverse param)
swipe: swipe with right mouse button to copy value to related sliders
thinhandle: draw thin handle
tickscale: draw tick scale in slider (requires a IParamCurve that provides the ITickScale interface)
tooltip: show value tooltip while editing
xyediting: xy editing - enables vertical mouse movements for horizontal sliders and vice versa

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

Style.textalign

Enumerators

Inherited from [Align.align]

bottom
center
hcenter
left
right
top
vcenter

Style.textoptions

Enumerators

wordbreak: break line after last word inside layout rectangle

Style.textsmoothing

Enumerators

Inherited from [Font.smoothing]

antialias: anti-aliasing
default: default
fast: high speed/low quality
none: no anti-aliasing

Style.textstyle

Enumerators

bold: bold
italic: italic
normal: no decoration
underline: underline

TabView.options

Enumerators

drag: data associated with a tab can be dragged
extendtabs: extend tabs to fill the header, if there is more space available
fitallviews: when autosizing, use largest size of all content views
nohoveractivate: do not activate tab when any drag enters view
nomenu: suppresses the menu button that appears when not all tabs fit in the view
nowheel: no mousewheel
reorder: tabs can be reorderd by drag & drop
tabmenu: the active tab displays a menu icon

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

TextBox.options

Enumerators

fittext: fit text to display width
markup: interpret text markup
multiline: multiline text
nocontextmenu: suppress context menu
scaletext: uses a dynamic font size to fill the available space

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

TextBox.texttrimmode

Enumerators

default
keepend: put “..” to the right but leave last four characters
left: put “..” to the left
middle: put “..” in the middle
numeric: like kTrimModeKeepEnd, but removes spaces first (e.g. between a number and a unit)
right: put “..” to the right

TextureMaterial3D.Texture.options

Enumerators

clamptoborder: When sampling pixels outside of the textures boundaries, use border color
clamptoedge: When sampling pixels outside of the textures boundaries, use edge pixels (default)
immutable: The texture is immutable. It’s data cannot be changed.
mipmapenabled: Automatically generate mipmaps on creation and whenever the texture is updated
mirror: When sampling pixels outside of the textures boundaries, mirror the texture
repeat: When sampling pixels outside of the textures boundaries, repeat the texture

Toggle.options

Enumerators

invert: parameter is inverted

Inherited from [Button.options]

hidefocus: don’t draw focus rectangle
ignoreimagesize: the background image size is ignored when auto sizing the button (only title size is used)
immediate: parameter is changed on mouse down instead of mouse up
intermediate: parameter is changed on mouse down and back on mouse up
leadingicon: icon sticks to the left with respect to a given padding
middle: used instead of ‘background’’ image when button has option ‘middle’
momentary: parameter is changed on mouse down. In case of toggle buttons, the parameter change is just momentary (i.e. does not latch) if the button is pressed longer than 500 milliseconds.
multiline: button title will be drawn with wordwrap - requires button width to be set
needscommandkey: button only responds to mouse/touch input when the command key is pressed
needsoptionkey: button only responds to mouse/touch input when the option key is pressed (multiple modifier requirements can be combined)
needsshiftkey: button only responds to mouse/touch input when the shift key is pressed
passive: button is used as passive control - mouse clicks fall thru
scaletext: uses a dynamic font size to fill the available space
silenttracking: instead of changing the paramter value, a special preview handler is used
slide: instead of a simple click, the button can be slided to it’s new state (dragging the mouse). An additional ‘slide’ image is used during this manipulation. It should have 1 frame per button state and an equal number of intermediate frames between them.
swipe: mouse can be dragged over a horizontal or vertical row of buttons with the same name (from different controllers) to switch them all to the same value as the first clicked button
trailingicon: icon sticks to the right with respect to a given padding

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

ToolButton.options

Enumerators

fixedicon: no mode icons are shown
modetoggle: like toggle option - use when modeParam is equal to control parameter without off-state
nowheel: no mousewheel

Inherited from [RadioButton.options]

toggle: parameter is set to min if radiovalue is already set

Inherited from [Button.options]

hidefocus: don’t draw focus rectangle
ignoreimagesize: the background image size is ignored when auto sizing the button (only title size is used)
immediate: parameter is changed on mouse down instead of mouse up
intermediate: parameter is changed on mouse down and back on mouse up
leadingicon: icon sticks to the left with respect to a given padding
middle: used instead of ‘background’’ image when button has option ‘middle’
momentary: parameter is changed on mouse down. In case of toggle buttons, the parameter change is just momentary (i.e. does not latch) if the button is pressed longer than 500 milliseconds.
multiline: button title will be drawn with wordwrap - requires button width to be set
needscommandkey: button only responds to mouse/touch input when the command key is pressed
needsoptionkey: button only responds to mouse/touch input when the option key is pressed (multiple modifier requirements can be combined)
needsshiftkey: button only responds to mouse/touch input when the shift key is pressed
passive: button is used as passive control - mouse clicks fall thru
scaletext: uses a dynamic font size to fill the available space
silenttracking: instead of changing the paramter value, a special preview handler is used
slide: instead of a simple click, the button can be slided to it’s new state (dragging the mouse). An additional ‘slide’ image is used during this manipulation. It should have 1 frame per button state and an equal number of intermediate frames between them.
swipe: mouse can be dragged over a horizontal or vertical row of buttons with the same name (from different controllers) to switch them all to the same value as the first clicked button
trailingicon: icon sticks to the right with respect to a given padding

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

TreeView.options

Enumerators

autoexpand: automatically expand a selected item
expandall: automatically expand all items - no collapse is possible
expanddrag: automatically expand item under mouse when dragging
expandmouse: automatically expand item under mouse after a short delay
noicons: hide tree item icons
noroot: hide root item

Inherited from [ItemView.options]

autoselect: automatically select item under mouse
columnfocus: limit focus rectangle to the focussed column
dragswipeh: start dragging the touched item on a horizontal swipe gesture (with high priority)
dragswipev: start dragging the touched item on a vertical swipe gesture (with high priority)
exclusive: max. One item can be selected.
focusselectable: only selectable items can get the focus
header: show a header view above the itemview
nocontextmenu: don’t display a context menu
nodoubleclick: don’t try to detect doubleclicks
nodrag: don’t try to drag items
nofocus: don’t draw focus rectangle
nonamenavigation: don’t use name navigator (which steals key commands sometimes)
norubber: don’t try to start a rubberband selection
nounselect: don’t unselect items on mouse down in empty region
resizeredraw: redraw the view on resize (use if data is drawn right-aligned or centered)
selectfullwidth: draw selection over full available width, ignoring title-width
selection: enable selection of items
simplemouse: combined option: no drag, no rubberband, no doubleclick
swallowalphachars: swallow key events with alphabetical characters (when name navigation fails)
thumbnails: show item thumbnails

Inherited from [ScrollView.options]

allowzoom: let another touch handler take over on a zoom gesture
autobuttonsh: automatically show horizontal scroll buttons only when necessary
autobuttonsv: automatically show vertical scroll buttons only when necessary
autohideboth: automatically shows/hides both scrollbars when necessary
autohideh: automatically shows/hides horizontal scrollbar when necessary
autohidev: automatically shows/hides vertical scrollbar when necessary
canscrollh: allow horizontal scrolling even if the ScrollView has no (own) scrollbar or buttons
canscrollv: allow vertical scrolling even if the ScrollView has no (own) scrollbar or buttons
centertarget: center target if target is smaller than scroll view (do not combine with kScrollViewExtendTarget)
extendtarget: make the target at least as big as the scroll area
hbuttons: horizontal scroll buttons at left & right edge
hscrollspace: addional reserved space for horizontal scrollbar (avoid resizing of clip view, when kScrollViewAutoHideHBar is set)
latchwheel: view locks the mouse wheel scroll to itself (no child handling) for a limited time after the last handled mouse wheel event
layeredscroll: use graphic layers for scrolling, if available
limittoscreen: don’t grow larger than current monitor size when autosizing to content
mousescroll: allow scrolling by dragging the mouse in scroll view area
noscreenscroll: do not use os scroll functions, just invalidate instead
noswipe: no swipe gesture used for scrollviews
notiledlayers: when kScrollViewLayeredScroll is set, use a regular layer instead of a tiled one
omnidirectional: scrollview allows scrolling in both directions at the same time
pagecontrol: use pagecontrols instead of scrollbars
relativeresize: scrollview resizes the target, keeping the ratio of the visible and hidden area
scrollbypage: snap to full pages, limit touch-based scrolling to one page per gesture
scrollnotify: sends notifications about current postion during animation
snappedtarget: target height is multiple of snap height
snapviews: snap to subview positions; ignores the explicit snap value
snapviewsdeep: snap to subview positions recursively
targetlimits: adjust sizeLimits of ScrollView so that it can’t be larger than the target’s limits allow
vbuttons: vertical scroll buttons at top & bottom edge
vscrollspace: addional reserved space for vertical scrollbar (avoid automatic horizontal scrollbar, because of space covered when vertical bar is shown)

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

TriVectorPad.options

Enumerators

invert: parameter is inverted
keeplevel: combined levels are remembered - only parameter ratios change. (i.e. initial full scale state of all three parameters is reset when moving the handle back to center).
tooltip: show tooltip values
upsidedown: triangle is ‘upsidedown’

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

TriggerView.gesturepriority

Enumerators

high
highest
low
normal

TriggerView.options

Enumerators

swallowdrag

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

UpDownButton.options

Enumerators

decrement: button decrements parameter value
increment: button increments parameter value

Inherited from [Button.options]

hidefocus: don’t draw focus rectangle
ignoreimagesize: the background image size is ignored when auto sizing the button (only title size is used)
immediate: parameter is changed on mouse down instead of mouse up
intermediate: parameter is changed on mouse down and back on mouse up
leadingicon: icon sticks to the left with respect to a given padding
middle: used instead of ‘background’’ image when button has option ‘middle’
momentary: parameter is changed on mouse down. In case of toggle buttons, the parameter change is just momentary (i.e. does not latch) if the button is pressed longer than 500 milliseconds.
multiline: button title will be drawn with wordwrap - requires button width to be set
needscommandkey: button only responds to mouse/touch input when the command key is pressed
needsoptionkey: button only responds to mouse/touch input when the option key is pressed (multiple modifier requirements can be combined)
needsshiftkey: button only responds to mouse/touch input when the shift key is pressed
passive: button is used as passive control - mouse clicks fall thru
scaletext: uses a dynamic font size to fill the available space
silenttracking: instead of changing the paramter value, a special preview handler is used
slide: instead of a simple click, the button can be slided to it’s new state (dragging the mouse). An additional ‘slide’ image is used during this manipulation. It should have 1 frame per button state and an equal number of intermediate frames between them.
swipe: mouse can be dragged over a horizontal or vertical row of buttons with the same name (from different controllers) to switch them all to the same value as the first clicked button
trailingicon: icon sticks to the right with respect to a given padding

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

ValueBox.options

Enumerators

nodrag: drag events can be handled by controls beneath
xyediting: use xyediting with a default sensitivity of 200 points and set the vertical size cursor immediately

Inherited from [EditBox.options]

dialogedit: edit has dialog behavior
doubleclick: edit only if double-clicked
dragtext: drag a text selection to another position to cut and paste it
extended: use framework editing implementation instead of native text control (regardless of global configuration)
hidetext: do not display text
immediate: parameter gets updates while editing
musthittext: on mouseclick, edit only if the text was hit
noclearbutton: no clear button (X)
nosuggestions: no text suggestions
nowheel: no mousewheel
opaqueedit: draw background while editing, even if the control is transparent
password: password-style editing
permanentcaret: show caret permanently when not focused

Inherited from [TextBox.options]

fittext: fit text to display width
markup: interpret text markup
multiline: multiline text
nocontextmenu: suppress context menu
scaletext: uses a dynamic font size to fill the available space

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

Variant.options

Enumerators

boundvalue: always create a child view even if the numeric parameter is out of bounds
fill: child views always get the full client area of the variant view (can be used for optimization, as other views don’t need to be resized)
invert: invert the on/off value of the given parameter
selectalways: always rebuild child view, even if index did not change
unifysizes: when switching views, pass width / height of previous view to new view, depending on the options horizontal (for width) / vertical (for height)

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

View.accessibility

Enumerators

disabled
enabled

View.attach

Enumerators

all: all of the view’s edges keep their distances to the corresponding parent edge
bottom: the view’s bottom edge keeps it’s distance to the left parent’s bottom edge
fill: frame is preferred to fill fill the container
fitsize: when childs are sized, the view adjusts it’s size to fit the childs
hcenter: center popup horizontally in parent
hfit: when childs are sized, the view adjusts it’s width to fit the childs
left: the view’s left edge keeps it’s distance to the parent’s left edge
prefercurrent: this view accepts any size given by parent, and keeps that on autoSize
right: the view’s right edge keeps it’s distance to the parent’s top edge
top: the view’s top edge keeps it’s distance to the parent’s top edge
vcenter: center popup vertically in parent
vfit: when childs are sized, the view adjusts it’s height to fit the childs

View.flex.alignself

Enumerators

auto
center
flexend
flexstart
stretch

View.flex.positiontype

Enumerators

absolute
relative

View.flex.sizemode

Enumerators

fill
hug
hughorizontal
hugvertical

View.layerbacking

Enumerators

false
optional
true

View.options

Enumerators

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

View.transition

Enumerators

conceal: new content slides in on top of old content (from right)
fade: old content fades out while new content becomes visible
fall: new content falls on top of old content
lift: old content lifts up and new content is revealed while (inverse of fall)
movein: new content slides in on top of old content (from left)
moveout: old content slides out and new content is revealed (to left - inverse of movein)
none: no transition
push: new content pushes old content to the right as it slides in
pushdown: new content pushes old content to the bottom as it slides in
pushleft: old content pushed to the left as new content slides in (inverse of push)
pushup: old content pushed to the top as new content slides in (inverse of pushdown)
reveal: old content slides out and new content is revealed (to right - inverse of conceal)
rise: new content rises on top of old content
sink: old content sinks down and new content is revealed (inverse of rise)
zoom: new content is zoomed in on top of old content
zoomin: new content is zoomed in on top of old content
zoomout: old content is zoomed out on top of new content (inverse of zoom)

WebView.options

Enumerators

localonly: restrict to local pages only

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

Workspace.windowstyle

Enumerators

Inherited from [Form.windowstyle]

center: window is shown centered
customframe: window has a custom frame
dialogstyle: default dialog window style: title bar, centered
floating: window is in floating layer
fullscreen: window can enter fullscreen mode
inflate: window size should be inflated to fill the main monitor
intermediate: window is below floating windows and above base layer windows
maximize: windows can be maximized
panelstyle: panel window style: title bar, floating
pluginhost: window hosts foreign views
restorecenter: restore last known window center position
restorepos: restore last known window position
restoresize: restore last known window size
seethru: window is half-transparent when inactive
shadow: window has a shadow effect
sheetstyle: sheet presentation style (not available on all platforms)
sizable: window has a sizable border
titlebar: window has a title bar
topmost: windows is above other applications
windowstyle: default window style: title bar

Inherited from [View.options]

border: usually default
composited
directupdate: redraw control directly
horizontal: control orientation
layerupdate: each invalidate also forces updating sub layers of all child views (deep)
left: left variant
nohelp: deliver empty help identifier (instead of delegating to parent): siblings (underneath) will get a chance to contribute a help id
right: right variant
small: smaller variant
translucent: alpha channel needs to be respected
transparent: don’t draw background
trigger: enable property triggers
vertical: control orientation

zoom.mode

Enumerators

absolute: a new absolute zoom factor is applied to scoped views
relative: a new zoom factor is applied relative to the current zoom factor (default)

Skin Elements Reference

Groups

3D (14)

Animation (8)

Controls (34)

General (37)

Layout (12)

Resources (15)

Shapes (7)

Styles (9)

Views (11)

Workspace (6)

Schema Groups

Frame.Children (4)

Image.Children (4)

Model3D.Children (3)

Perspective.Children (2)

Resources.Children (15)

Scene3D.Children (7)

Shapes.Children (5)

Skin.Children (11)

Style (2)

Style.Children (11)

Target (2)

ThemeElements.Children (3)

Trigger.Children (4)

ViewsAndStatements (76)

switch.Children (2)

Classes

AbstractLayout

ActivityIndicator

Align

AlignView

AmbientLight3D

Anchor

Animation

BasicShape

Border

Button

Camera3D

CheckBox

Color

ColorBox

ColorScheme

ColorScheme.Color

ComboBox

CommandBarView

Control

Cursor

CursorView

Delegate

DialogButton

DialogGroup

DirectionalLight3D

Divider

DropBox

EditBox

Element

Ellipse

EmbeddedFrame

External

Externals

Flexbox

Font

FontResource

Form

Forms

Frame

Gradient

GradientStop

Header

HelpAnchor

Horizontal

IconSet

Image

ImageFilter

ImagePart

ImageView

Import

Imports