Contents

FormTextAreaDelegate QML Type

A Form delegate that corresponds to a text area. More...

Import Statement: import org.kde.kirigamiaddons.formcard
Inherits:

AbstractFormDelegate

Properties

Signals

Methods

Detailed Description

FormCard.FormHeader {
    title: "Information"
}

FormCard.FormCard {
    FormCard.FormTextAreaDelegate {
        label: "Account name"
    }
}

Property Documentation

fieldActiveFocus : bool

This hold the activeFocus state of the internal TextArea.


inputMethodHints : enumeration

This property holds the inputMethodHints of the internal TextArea.

This consists of hints on the expected content or behavior of the text field, be it sensitive data, in a date format, or whether the characters will be hidden, for example.

See also TextInput.inputMethodHints.


label : string [required]

A label containing primary text that appears above and to the left the text field.


maximumLength : int [default: -1]

The maximum length of the text inside the TextArea if maxLength > 0.


placeholderText : string

This property holds the placeholderText of the internal TextArea.

This consists of secondary text shown by default on the text field if no text has been written in it.


readOnly : bool

This hold the readOnly state of the internal TextArea.


status : var

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

This consists of an inline message with a colorful background and an appropriate icon.

The status property will affect the color of statusMessage used.

Accepted values:

ConstantDescription
Kirigami.MessageType.Information(blue color)
Kirigami.MessageType.Positive(green color)
Kirigami.MessageType.Warning(orange color)
Kirigami.MessageType.Error(red color)

default: Kirigami.MessageType.Information if statusMessage is set, nothing otherwise.

See also Kirigami.MessageType.


statusMessage : string [default: ""]

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

If this property is not set, no status will be shown.


Signal Documentation

editingFinished()

This signal is emitted when the Return or Enter key is pressed or the text input loses focus.

Note that if there is a validator or inputMask set on the text input and enter/return is pressed, this signal will only be emitted if the input follows the inputMask and the validator returns an acceptable state.

Note: The corresponding handler is onEditingFinished.


Method Documentation

clear()

Clears the contents of the text input and resets partial text input from an input method.


insert(position, text)

Inserts text into the TextInput at position.