FormPasswordFieldDelegate Class Reference

Inheritance diagram for FormPasswordFieldDelegate:

Properties
alias	acceptableInput
alias	echoMode
alias	fieldActiveFocus
alias	inputMethodHints
string	label
alias	maximumLength
alias	placeholderText
alias	readOnly
var	status
string	statusMessage
alias	validator

Signals
void	accepted ()
void	editingFinished ()
void	textEdited ()

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

Detailed Description

A Form delegate that corresponds to a password field.

FormCard.FormHeader {
    title: "Information"
}
 
FormCard.FormCard {
    FormCard.FormTextFieldDelegate {
        label: "Account name"
    }
 
    FormCard.FormPasswordFieldDelegate {
        label: "Password"
        statusMessage: "Password incorrect"
        status: Kirigami.MessageType.Error
        text: "666666666"
    }
 
    FormCard.FormPasswordFieldDelegate {
        label: "Password repeat"
        statusMessage: "Password match"
        text: "4242424242"
        status: Kirigami.MessageType.Positive
        echoMode: TextInput.Password
    }
}

Since

KirigamiAddons 0.11.0

Definition at line 43 of file FormPasswordFieldDelegate.qml.

Property Documentation

acceptableInput

alias FormPasswordFieldDelegate::acceptableInput

read

This property holds the acceptableInput of the internal TextField.

Definition at line 97 of file FormPasswordFieldDelegate.qml.

echoMode

alias FormPasswordFieldDelegate::echoMode

read

This property holds the echoMode of the internal TextField.

This consists of how the text inside the text field will be displayed to the user.

See also

TextInput.echoMode

Definition at line 70 of file FormPasswordFieldDelegate.qml.

fieldActiveFocus

alias FormPasswordFieldDelegate::fieldActiveFocus

read

This hold the activeFocus state of the internal TextField.

Definition at line 57 of file FormPasswordFieldDelegate.qml.

inputMethodHints

alias FormPasswordFieldDelegate::inputMethodHints

read

This property holds the inputMethodHints of the internal TextField.

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 81 of file FormPasswordFieldDelegate.qml.

label

string FormPasswordFieldDelegate::label

read

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

Definition at line 49 of file FormPasswordFieldDelegate.qml.

maximumLength

alias FormPasswordFieldDelegate::maximumLength

read

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

Definition at line 53 of file FormPasswordFieldDelegate.qml.

placeholderText

alias FormPasswordFieldDelegate::placeholderText

read

This property holds the placeholderText of the internal TextField.

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

Definition at line 89 of file FormPasswordFieldDelegate.qml.

readOnly

alias FormPasswordFieldDelegate::readOnly

read

This hold the readOnly state of the internal TextField.

Definition at line 61 of file FormPasswordFieldDelegate.qml.

status

var FormPasswordFieldDelegate::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 118 of file FormPasswordFieldDelegate.qml.

statusMessage

string FormPasswordFieldDelegate::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 125 of file FormPasswordFieldDelegate.qml.

validator

alias FormPasswordFieldDelegate::validator

read

This property holds the validator of the internal TextField.

Definition at line 93 of file FormPasswordFieldDelegate.qml.

Member Function Documentation

accepted

void FormPasswordFieldDelegate::accepted ( )

signal

@This signal is emitted when the Return or Enter key is pressed.

Note that if there is a validator or inputMask set on the text input, the signal will only be emitted if the input is in an acceptable state.

clear()

void FormPasswordFieldDelegate::clear

(

)

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

editingFinished

void FormPasswordFieldDelegate::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 FormPasswordFieldDelegate::insert	(	int	position,
		string	text )

Inserts text into the TextInput at position.

textEdited

void FormPasswordFieldDelegate::textEdited ( )

signal

This signal is emitted whenever the text is edited.

Unlike textChanged(), this signal is not emitted when the text is changed programmatically, for example, by changing the value of the text property or by calling clear().

---

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

• FormPasswordFieldDelegate.qml