FormSpinBoxDelegate QML Type

A Form delegate that corresponds to a spinbox. More...

• List of all members, including inherited members

Properties

• description : string
• displayText : string
• fieldActiveFocus : bool
• from : int
• inputMethodComposing : bool
• inputMethodHints : enumeration
• label : string
• status : var
• statusMessage : string
• stepSize : int
• textFromValue : function
• to : int
• trailing : var
• validator : Validator
• value : int
• valueFromText : function
• wrap : bool

Signals

• valueModified()

Methods

• decrease()
• increase()

Detailed Description

This component is used to select a number. By default, the spinbox will be initialized with a minimum of 0 and a maximum of 99.

Example code:

FormCard.FormCardHeader {
    title: "Information"
}

FormCard.FormCard {
    FormCard.FormSpinBoxDelegate {
        label: "Amount"
    }
}

Property Documentation

description : string [default: ""]

A label containing secondary text that appears under the inherited text property.

This provides additional information shown in a faint gray color.

displayText : string

This property holds the displayText of the internal spinbox.

fieldActiveFocus : bool

The activeFocus state of the internal spinbox.

from : int

This property holds the from of the internal spinbox.

inputMethodComposing : bool

This property holds the inputMethodComposing of the internal spinbox.

inputMethodHints : enumeration

This property holds the inputMethodHints of the internal spinbox.

label : string [required]

A label that appears above the spinbox.

status : var

This property holds the current type of status displayed in the text field.

Depending on the status of the text field, the statusMessage property will look different.

Accepted values:

See also Kirigami.MessageType.

statusMessage : string [default: ""]

This property holds the current status message of the text field.

stepSize : int

This property holds the stepSize of the internal spinbox.

textFromValue : function

This property holds the textFromValue of the internal spinbox.

to : int

This property holds the to of the internal spinbox.

trailing : var [default: null]

This property holds an item that will be displayed after the delegate's contents.

validator : Validator

This property holds the validator of the internal spinbox.

value : int

This property holds the value of the internal spinbox.

valueFromText : function

This property holds the valueFromText of the internal spinbox.

wrap : bool

This property holds the wrap of the internal spinbox.

Signal Documentation

valueModified()

This signal is emitted when the spin box value has been interactively modified by the user.

By either touch, mouse, wheel, or keys. In the case of interaction via keyboard, the signal is only emitted when the text has been accepted; meaning when the enter or return keys are pressed, or the input field loses focus.

Method Documentation

decrease()

Decreases the value by stepSize, or 1 if stepSize is not defined.

increase()

Increases the value by stepSize, or 1 if stepSize is not defined.