FormSpinBoxDelegate

Search for usage in LXR

FormSpinBoxDelegate Class Reference
Inheritance diagram for FormSpinBoxDelegate:

Properties

alias displayText
 
alias from
 
string label
 
var status
 
string statusMessage
 
alias stepSize
 
alias textFromValue
 
alias to
 
alias value
 
alias valueFromText
 

Public Member Functions

void decrease ()
 
void increase ()
 

Detailed Description

A Form delegate that corresponds to a spinbox.

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"
}
}
A single card that follows a form style.
Definition FormCard.qml:35
string label
A label that appears above the spinbox.
Since
KirigamiAddons 0.11.0

Definition at line 31 of file FormSpinBoxDelegate.qml.

Property Documentation

◆ displayText

alias FormSpinBoxDelegate::displayText
read

This property holds the displayText of the internal spinbox.

Definition at line 65 of file FormSpinBoxDelegate.qml.

◆ from

alias FormSpinBoxDelegate::from
read

This property holds the from of the internal spinbox.

Definition at line 45 of file FormSpinBoxDelegate.qml.

◆ label

string FormSpinBoxDelegate::label
read

A label that appears above the spinbox.

Definition at line 37 of file FormSpinBoxDelegate.qml.

◆ status

var FormSpinBoxDelegate::status
read

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:

  • Kirigami.MessageType.Information
  • Kirigami.MessageType.Positive
  • Kirigami.MessageType.Warning
  • Kirigami.MessageType.Error
See also
Kirigami.MessageType

Definition at line 81 of file FormSpinBoxDelegate.qml.

◆ statusMessage

string FormSpinBoxDelegate::statusMessage
read

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

Definition at line 85 of file FormSpinBoxDelegate.qml.

◆ stepSize

alias FormSpinBoxDelegate::stepSize
read

This property holds the stepSize of the internal spinbox.

Definition at line 53 of file FormSpinBoxDelegate.qml.

◆ textFromValue

alias FormSpinBoxDelegate::textFromValue
read

This property holds the textFromValue of the internal spinbox.

Definition at line 57 of file FormSpinBoxDelegate.qml.

◆ to

alias FormSpinBoxDelegate::to
read

This property holds the to of the internal spinbox.

Definition at line 49 of file FormSpinBoxDelegate.qml.

◆ value

alias FormSpinBoxDelegate::value
read

This property holds the value of the internal spinbox.

Definition at line 41 of file FormSpinBoxDelegate.qml.

◆ valueFromText

alias FormSpinBoxDelegate::valueFromText
read

This property holds the valueFromText of the internal spinbox.

Definition at line 61 of file FormSpinBoxDelegate.qml.

Member Function Documentation

◆ decrease()

void FormSpinBoxDelegate::decrease ( )

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

◆ increase()

void FormSpinBoxDelegate::increase ( )

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


The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jul 12 2024 11:54:04 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.