FormTextAreaDelegate Class Reference

Inheritance diagram for FormTextAreaDelegate:

Properties
alias	fieldActiveFocus
alias	inputMethodHints
string	label
int	maximumLength
alias	placeholderText
alias	readOnly
var	status
string	statusMessage

Signals
void	editingFinished ()

Public Member Functions
void	clear ()
void	insert (int position, string text)

Detailed Description

A Form delegate that corresponds to a text area.

FormCard.FormHeader {
    title: "Information"
}
 
FormCard.FormCard {
    FormCard.FormTextAreaDelegate {
        label: "Account name"
    }
}

Since

KirigamiAddons 0.11.0

Definition at line 29 of file FormTextAreaDelegate.qml.

Property Documentation

fieldActiveFocus

alias FormTextAreaDelegate::fieldActiveFocus

read

This hold the activeFocus state of the internal TextArea.

Definition at line 43 of file FormTextAreaDelegate.qml.

inputMethodHints

alias FormTextAreaDelegate::inputMethodHints

read

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

Definition at line 58 of file FormTextAreaDelegate.qml.

label

string FormTextAreaDelegate::label

read

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

Definition at line 35 of file FormTextAreaDelegate.qml.

maximumLength

int FormTextAreaDelegate::maximumLength

read

set the maximum length of the text inside the TextArea if maxLength > 0

Definition at line 39 of file FormTextAreaDelegate.qml.

placeholderText

alias FormTextAreaDelegate::placeholderText

read

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.

Definition at line 66 of file FormTextAreaDelegate.qml.

readOnly

alias FormTextAreaDelegate::readOnly

read

This hold the readOnly state of the internal TextArea.

Definition at line 47 of file FormTextAreaDelegate.qml.

status

var FormTextAreaDelegate::status

read

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:

• 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

Definition at line 87 of file FormTextAreaDelegate.qml.

statusMessage

string FormTextAreaDelegate::statusMessage

read

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

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

Definition at line 94 of file FormTextAreaDelegate.qml.

Member Function Documentation

clear()

void FormTextAreaDelegate::clear

(

)

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

editingFinished

void FormTextAreaDelegate::editingFinished ( )

signal

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.

insert()

void FormTextAreaDelegate::insert	(	int	position,
		string	text )

Inserts text into the TextInput at position.

---

The documentation for this class was generated from the following file:

• FormTextAreaDelegate.qml