KPasswordDialog Class

KPasswordDialog *dlg = new KPasswordDialog(parent);
dlg->setPrompt(i18n("Enter a password"));
connect(dlg, &KPasswordDialog::gotPassword,
        this, [this](const QString &password) { setPassword(password); });
connect(dlg, &QDialog::rejected, this, [this]() { slotCancel(); });
dlg->show();

KPasswordDialog dlg(parent, KPasswordDialog::ShowUsernameLine);
dlg.setPrompt(i18n("Enter a login and a password"));
if(!dlg.exec()) {
    return; //the user canceled
}
use(dlg.username(), dlg.password());

Member Function Documentation

[explicit] KPasswordDialog::KPasswordDialog(QWidget *parent = nullptr, const KPasswordDialog::KPasswordDialogFlags &flags = KPasswordDialog::NoFlags)

create a password dialog

parent the parent widget

flags a set of KPasswordDialogFlag flags

void KPasswordDialog::addCommentLine(const QString &label, const QString &comment)

Adds a comment line to the dialog.

This function allows you to add one additional comment line to this widget. Calling this function after a comment has already been added will not have any effect.

label label for comment (ex:"Command:")

comment the actual comment text.

[since 4.1] bool KPasswordDialog::anonymousMode() const

Returns whether anonymous mode has been selected.

This function was introduced in 4.1.

See also setAnonymousMode().

[since 5.0] QDialogButtonBox *KPasswordDialog::buttonBox() const

Returns the button box used in the dialog. This can be used to add new buttons.

This function was introduced in 5.0.

[virtual protected] bool KPasswordDialog::checkPassword()

Virtual function that can be overridden to provide password checking in derived classes. It should return true if the password is valid, false otherwise.

[since 4.1] QString KPasswordDialog::domain() const

Returns the domain entered by the user.

This function was introduced in 4.1.

See also setDomain().

[signal] void KPasswordDialog::gotPassword(const QString &password, bool keep)

emitted when the dialog has been accepted

password the entered password

keep true if the "remember password" checkbox was checked, false otherwise. false if ShowKeepPassword was not set in the constructor

[signal] void KPasswordDialog::gotUsernameAndPassword(const QString &username, const QString &password, bool keep)

emitted when the dialog has been accepted, and ShowUsernameLine was set on the constructor

username the entered username

password the entered password

keep true if the "remember password" checkbox was checked, false otherwise. false if ShowKeepPassword was not set in the constructor

QIcon KPasswordDialog::icon() const

Returns the icon that appears next to the prompt.

See also setIcon().

bool KPasswordDialog::keepPassword() const

Determines whether supplied authorization should persist even after the application has been closed.

this is set with the check password checkbox is the ShowKeepCheckBox flag is set in the constructor, if it is not set, this function return false

Returns whether to keep the password

See also setKeepPassword().

QString KPasswordDialog::password() const

Returns the password entered by the user.

See also setPassword().

QString KPasswordDialog::prompt() const

Returns the prompt

See also setPrompt().

[since 6.0] KPassword::RevealMode KPasswordDialog::revealPasswordMode() const

Return when the reveal password button is visible.

This function was introduced in 6.0.

[since 4.1] void KPasswordDialog::setAnonymousMode(bool anonymous)

set anonymous mode (all other fields will be grayed out)

This function was introduced in 4.1.

See also anonymousMode().

[since 4.1] void KPasswordDialog::setDomain(const QString &)

set the default domain.

This function was introduced in 4.1.

See also domain().

[since 5.63] void KPasswordDialog::setIcon(const QIcon &icon)

Set the icon that appears next to the prompt.

This function was introduced in 5.63.

See also icon().

void KPasswordDialog::setKeepPassword(bool b)

Check or uncheck the "keep password" checkbox. This can be used to check it before showing the dialog, to tell the user that the password is stored already (e.g. in the wallet). enableKeep must have been set to true in the constructor.

has only effect if ShowKeepCheckBox is set in the constructor

See also keepPassword().

void KPasswordDialog::setKnownLogins(const QMap<QString, QString> &knownLogins)

Presets a number of login+password pairs that the user can choose from.

The passwords can be empty if you simply want to offer usernames to choose from.

This require the flag ShowUsernameLine to be set in the constructoe, and not the flag UsernameReadOnly

knownLogins map of known logins: the keys are usernames, the values are passwords.

void KPasswordDialog::setPassword(const QString &password)

Presets the password.

If the password is not empty, the ability to show the password will not be available.

password the password to set

See also password().

void KPasswordDialog::setPrompt(const QString &prompt)

Sets the prompt to show to the user.

prompt instructional text to be shown.

See also prompt().

void KPasswordDialog::setUsername(const QString &)

set the default username.

See also username().

[since 5.76] void KPasswordDialog::setUsernameContextHelp(const QString &help)

Sets contextual help for the username input field. This displays a somewhat visual hint in the UI giving very visible access to a whats-this style input description for the user name line. This is particularly useful when the user name may require or support special input syntax. For example windows-like auth dialogs supports multiple different logon name syntax.

This function was introduced in 5.76.

void KPasswordDialog::setUsernameReadOnly(bool readOnly)

Sets the username field read-only and sets the focus to the password field.

this can also be set by passing UsernameReadOnly as flag in the constructor

readOnly true to set the user field to read-only

void KPasswordDialog::showErrorMessage(const QString &message, const KPasswordDialog::ErrorType type = PasswordError)

Shows an error message in the dialog box. Prevents having to show a dialog-on-a-dialog.

message the error message to show

QString KPasswordDialog::username() const

Returns the username entered by the user.

See also setUsername().