KPasswordDialog

#include <KPasswordDialog>

Inheritance diagram for KPasswordDialog:

[legend]

Public Types
enum	ErrorType { UnknownError = 0 , UsernameError , PasswordError , FatalError , DomainError }

enum	KPasswordDialogFlag { NoFlags = 0x00 , ShowKeepPassword = 0x01 , ShowUsernameLine = 0x02 , UsernameReadOnly = 0x04 , ShowAnonymousLoginCheckBox = 0x08 , ShowDomainLine = 0x10 , DomainReadOnly = 0x20 }

typedef QFlags< KPasswordDialogFlag >	KPasswordDialogFlags

Public Types inherited from QDialog
enum	DialogCode

Public Types inherited from QWidget
enum	RenderFlag

typedef	RenderFlags

Public Types inherited from QObject
typedef	QObjectList

Public Types inherited from QPaintDevice
enum	PaintDeviceMetric

Signals
void	gotPassword (const QString &password, bool keep)

void	gotUsernameAndPassword (const QString &username, const QString &password, bool keep)

Public Member Functions
	KPasswordDialog (QWidget *parent=nullptr, const KPasswordDialogFlags &flags=KPasswordDialog::NoFlags)

	~KPasswordDialog () override

void	accept () override

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

bool	anonymousMode () const

QDialogButtonBox *	buttonBox () const

QString	domain () const

QIcon	icon () const

bool	isRevealPasswordAvailable () const

bool	keepPassword () const

QString	password () const

QString	prompt () const

KPassword::RevealMode	revealPasswordMode () const

void	setAnonymousMode (bool anonymous)

void	setDomain (const QString &)

void	setIcon (const QIcon &icon)

void	setKeepPassword (bool b)

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

void	setPassword (const QString &password)

void	setPrompt (const QString &prompt)

void	setRevealPasswordAvailable (bool reveal)

void	setRevealPasswordMode (KPassword::RevealMode revealPasswordMode)

void	setUsername (const QString &)

void	setUsernameContextHelp (const QString &help)

void	setUsernameReadOnly (bool readOnly)

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

QString	username () const

Public Member Functions inherited from QDialog
	QDialog (QWidget *parent, Qt::WindowFlags f)

void	accepted ()

virtual void	done (int r)

virtual int	exec ()

void	finished (int result)

bool	isSizeGripEnabled () const const

virtual QSize	minimumSizeHint () const const override

virtual void	open ()

virtual void	reject ()

void	rejected ()

int	result () const const

void	setModal (bool modal)

void	setResult (int i)

void	setSizeGripEnabled (bool)

virtual void	setVisible (bool visible) override

virtual QSize	sizeHint () const const override

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent, Qt::WindowFlags f)

bool	acceptDrops () const const

QString	accessibleDescription () const const

QString	accessibleName () const const

QList< QAction * >	actions () const const

void	activateWindow ()

QAction *	addAction (const QIcon &icon, const QString &text)

QAction *	addAction (const QIcon &icon, const QString &text, Args &&... args)

QAction *	addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut)

QAction *	addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut, Args &&... args)

QAction *	addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut, const QObject receiver, const char member, Qt::ConnectionType type)

QAction *	addAction (const QIcon &icon, const QString &text, const QObject receiver, const char member, Qt::ConnectionType type)

QAction *	addAction (const QString &text)

QAction *	addAction (const QString &text, Args &&... args)

QAction *	addAction (const QString &text, const QKeySequence &shortcut)

QAction *	addAction (const QString &text, const QKeySequence &shortcut, Args &&... args)

QAction *	addAction (const QString &text, const QKeySequence &shortcut, const QObject receiver, const char member, Qt::ConnectionType type)

QAction *	addAction (const QString &text, const QObject receiver, const char member, Qt::ConnectionType type)

void	addAction (QAction *action)

void	addActions (const QList< QAction * > &actions)

void	adjustSize ()

bool	autoFillBackground () const const

QPalette::ColorRole	backgroundRole () const const

QBackingStore *	backingStore () const const

QSize	baseSize () const const

QWidget *	childAt (const QPoint &p) const const

QWidget *	childAt (int x, int y) const const

QRect	childrenRect () const const

QRegion	childrenRegion () const const

void	clearFocus ()

void	clearMask ()

bool	close ()

QMargins	contentsMargins () const const

QRect	contentsRect () const const

Qt::ContextMenuPolicy	contextMenuPolicy () const const

QCursor	cursor () const const

void	customContextMenuRequested (const QPoint &pos)

WId	effectiveWinId () const const

void	ensurePolished () const const

Qt::FocusPolicy	focusPolicy () const const

QWidget *	focusProxy () const const

QWidget *	focusWidget () const const

const QFont &	font () const const

QFontInfo	fontInfo () const const

QFontMetrics	fontMetrics () const const

QPalette::ColorRole	foregroundRole () const const

QRect	frameGeometry () const const

QSize	frameSize () const const

const QRect &	geometry () const const

QPixmap	grab (const QRect &rectangle)

void	grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags)

void	grabKeyboard ()

void	grabMouse ()

void	grabMouse (const QCursor &cursor)

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)

QGraphicsEffect *	graphicsEffect () const const

QGraphicsProxyWidget *	graphicsProxyWidget () const const

bool	hasEditFocus () const const

bool	hasFocus () const const

virtual bool	hasHeightForWidth () const const

bool	hasMouseTracking () const const

bool	hasTabletTracking () const const

int	height () const const

virtual int	heightForWidth (int w) const const

void	hide ()

Qt::InputMethodHints	inputMethodHints () const const

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const const

void	insertAction (QAction before, QAction action)

void	insertActions (QAction before, const QList< QAction > &actions)

bool	isActiveWindow () const const

bool	isAncestorOf (const QWidget *child) const const

bool	isEnabled () const const

bool	isEnabledTo (const QWidget *ancestor) const const

bool	isFullScreen () const const

bool	isHidden () const const

bool	isMaximized () const const

bool	isMinimized () const const

bool	isModal () const const

bool	isTopLevel () const const

bool	isVisible () const const

bool	isVisibleTo (const QWidget *ancestor) const const

bool	isWindow () const const

bool	isWindowModified () const const

QLayout *	layout () const const

Qt::LayoutDirection	layoutDirection () const const

QLocale	locale () const const

void	lower ()

QPoint	mapFrom (const QWidget *parent, const QPoint &pos) const const

QPointF	mapFrom (const QWidget *parent, const QPointF &pos) const const

QPoint	mapFromGlobal (const QPoint &pos) const const

QPointF	mapFromGlobal (const QPointF &pos) const const

QPoint	mapFromParent (const QPoint &pos) const const

QPointF	mapFromParent (const QPointF &pos) const const

QPoint	mapTo (const QWidget *parent, const QPoint &pos) const const

QPointF	mapTo (const QWidget *parent, const QPointF &pos) const const

QPoint	mapToGlobal (const QPoint &pos) const const

QPointF	mapToGlobal (const QPointF &pos) const const

QPoint	mapToParent (const QPoint &pos) const const

QPointF	mapToParent (const QPointF &pos) const const

QRegion	mask () const const

int	maximumHeight () const const

QSize	maximumSize () const const

int	maximumWidth () const const

int	minimumHeight () const const

QSize	minimumSize () const const

int	minimumWidth () const const

void	move (const QPoint &)

void	move (int x, int y)

QWidget *	nativeParentWidget () const const

QWidget *	nextInFocusChain () const const

QRect	normalGeometry () const const

void	overrideWindowFlags (Qt::WindowFlags flags)

virtual QPaintEngine *	paintEngine () const const override

const QPalette &	palette () const const

QWidget *	parentWidget () const const

QPoint	pos () const const

QWidget *	previousInFocusChain () const const

	QWIDGETSIZE_MAX QWIDGETSIZE_MAX

void	raise ()

QRect	rect () const const

void	releaseKeyboard ()

void	releaseMouse ()

void	releaseShortcut (int id)

void	removeAction (QAction *action)

void	render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, RenderFlags renderFlags)

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, RenderFlags renderFlags)

void	repaint ()

void	repaint (const QRect &rect)

void	repaint (const QRegion &rgn)

void	repaint (int x, int y, int w, int h)

void	resize (const QSize &)

void	resize (int w, int h)

bool	restoreGeometry (const QByteArray &geometry)

QByteArray	saveGeometry () const const

QScreen *	screen () const const

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &r)

void	setAcceptDrops (bool on)

void	setAccessibleDescription (const QString &description)

void	setAccessibleName (const QString &name)

void	setAttribute (Qt::WidgetAttribute attribute, bool on)

void	setAutoFillBackground (bool enabled)

void	setBackgroundRole (QPalette::ColorRole role)

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)

void	setContentsMargins (const QMargins &margins)

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	setCursor (const QCursor &)

void	setDisabled (bool disable)

void	setEditFocus (bool enable)

void	setEnabled (bool)

void	setFixedHeight (int h)

void	setFixedSize (const QSize &s)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFocus ()

void	setFocus (Qt::FocusReason reason)

void	setFocusPolicy (Qt::FocusPolicy policy)

void	setFocusProxy (QWidget *w)

void	setFont (const QFont &)

void	setForegroundRole (QPalette::ColorRole role)

void	setGeometry (const QRect &)

void	setGeometry (int x, int y, int w, int h)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setHidden (bool hidden)

void	setInputMethodHints (Qt::InputMethodHints hints)

void	setLayout (QLayout *layout)

void	setLayoutDirection (Qt::LayoutDirection direction)

void	setLocale (const QLocale &locale)

void	setMask (const QBitmap &bitmap)

void	setMask (const QRegion &region)

void	setMaximumHeight (int maxh)

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)

void	setMaximumWidth (int maxw)

void	setMinimumHeight (int minh)

void	setMinimumSize (const QSize &)

void	setMinimumSize (int minw, int minh)

void	setMinimumWidth (int minw)

void	setMouseTracking (bool enable)

void	setPalette (const QPalette &)

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, Qt::WindowFlags f)

void	setScreen (QScreen *screen)

void	setShortcutAutoRepeat (int id, bool enable)

void	setShortcutEnabled (int id, bool enable)

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)

void	setSizePolicy (QSizePolicy)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

void	setStatusTip (const QString &)

void	setStyle (QStyle *style)

void	setStyleSheet (const QString &styleSheet)

void	setTabletTracking (bool enable)

void	setToolTip (const QString &)

void	setToolTipDuration (int msec)

void	setUpdatesEnabled (bool enable)

void	setupUi (QWidget *widget)

void	setWhatsThis (const QString &)

void	setWindowFilePath (const QString &filePath)

void	setWindowFlag (Qt::WindowType flag, bool on)

void	setWindowFlags (Qt::WindowFlags type)

void	setWindowIcon (const QIcon &icon)

void	setWindowIconText (const QString &)

void	setWindowModality (Qt::WindowModality windowModality)

void	setWindowModified (bool)

void	setWindowOpacity (qreal level)

void	setWindowRole (const QString &role)

void	setWindowState (Qt::WindowStates windowState)

void	setWindowTitle (const QString &)

void	show ()

void	showFullScreen ()

void	showMaximized ()

void	showMinimized ()

void	showNormal ()

QSize	size () const const

QSize	sizeIncrement () const const

QSizePolicy	sizePolicy () const const

void	stackUnder (QWidget *w)

QString	statusTip () const const

QStyle *	style () const const

QString	styleSheet () const const

bool	testAttribute (Qt::WidgetAttribute attribute) const const

QString	toolTip () const const

int	toolTipDuration () const const

QWidget *	topLevelWidget () const const

bool	underMouse () const const

void	ungrabGesture (Qt::GestureType gesture)

void	unsetCursor ()

void	unsetLayoutDirection ()

void	unsetLocale ()

void	update ()

void	update (const QRect &rect)

void	update (const QRegion &rgn)

void	update (int x, int y, int w, int h)

void	updateGeometry ()

bool	updatesEnabled () const const

QRegion	visibleRegion () const const

QString	whatsThis () const const

int	width () const const

QWidget *	window () const const

QString	windowFilePath () const const

Qt::WindowFlags	windowFlags () const const

QWindow *	windowHandle () const const

QIcon	windowIcon () const const

void	windowIconChanged (const QIcon &icon)

QString	windowIconText () const const

void	windowIconTextChanged (const QString &iconText)

Qt::WindowModality	windowModality () const const

qreal	windowOpacity () const const

QString	windowRole () const const

Qt::WindowStates	windowState () const const

QString	windowTitle () const const

void	windowTitleChanged (const QString &title)

Qt::WindowType	windowType () const const

WId	winId () const const

int	x () const const

int	y () const const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Public Member Functions inherited from QPaintDevice
int	colorCount () const const

int	depth () const const

qreal	devicePixelRatio () const const

qreal	devicePixelRatioF () const const

int	height () const const

int	heightMM () const const

int	logicalDpiX () const const

int	logicalDpiY () const const

bool	paintingActive () const const

int	physicalDpiX () const const

int	physicalDpiY () const const

int	width () const const

int	widthMM () const const

Protected Member Functions
virtual bool	checkPassword ()

Protected Member Functions inherited from QDialog
virtual void	closeEvent (QCloseEvent *e) override

virtual void	contextMenuEvent (QContextMenuEvent *e) override

virtual bool	eventFilter (QObject o, QEvent e) override

virtual void	keyPressEvent (QKeyEvent *e) override

virtual void	resizeEvent (QResizeEvent *) override

virtual void	showEvent (QShowEvent *event) override

Protected Member Functions inherited from QWidget
virtual void	actionEvent (QActionEvent *event)

virtual void	changeEvent (QEvent *event)

void	create (WId window, bool initializeWindow, bool destroyOldWindow)

void	destroy (bool destroyWindow, bool destroySubWindows)

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual void	enterEvent (QEnterEvent *event)

virtual bool	event (QEvent *event) override

virtual void	focusInEvent (QFocusEvent *event)

bool	focusNextChild ()

virtual bool	focusNextPrevChild (bool next)

virtual void	focusOutEvent (QFocusEvent *event)

bool	focusPreviousChild ()

virtual void	hideEvent (QHideEvent *event)

virtual void	initPainter (QPainter *painter) const const override

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	leaveEvent (QEvent *event)

virtual int	metric (PaintDeviceMetric m) const const override

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual bool	nativeEvent (const QByteArray &eventType, void message, qintptr result)

virtual void	paintEvent (QPaintEvent *event)

virtual void	tabletEvent (QTabletEvent *event)

void	updateMicroFocus (Qt::InputMethodQuery query)

virtual void	wheelEvent (QWheelEvent *event)

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Protected Member Functions inherited from QPaintDevice

Additional Inherited Members
Properties inherited from QDialog
	modal

	sizeGripEnabled

Properties inherited from QWidget
	acceptDrops

	accessibleDescription

	accessibleName

	autoFillBackground

	baseSize

	childrenRect

	childrenRegion

	contextMenuPolicy

	cursor

	enabled

	focus

	focusPolicy

	font

	frameGeometry

	frameSize

	fullScreen

	geometry

	height

	inputMethodHints

	isActiveWindow

	layoutDirection

	locale

	maximized

	maximumHeight

	maximumSize

	maximumWidth

	minimized

	minimumHeight

	minimumSize

	minimumSizeHint

	minimumWidth

	modal

	mouseTracking

	normalGeometry

	palette

	pos

	rect

	size

	sizeHint

	sizeIncrement

	sizePolicy

	statusTip

	styleSheet

	tabletTracking

	toolTip

	toolTipDuration

	updatesEnabled

	visible

	whatsThis

	width

	windowFilePath

	windowFlags

	windowIcon

	windowIconText

	windowModality

	windowModified

	windowOpacity

	windowTitle

	x

	y

Properties inherited from QObject
	objectName

Static Public Member Functions inherited from QWidget
QWidget *	createWindowContainer (QWindow window, QWidget parent, Qt::WindowFlags flags)

QWidget *	find (WId id)

QWidget *	keyboardGrabber ()

QWidget *	mouseGrabber ()

void	setTabOrder (QWidget first, QWidget second)

void	setTabOrder (std::initializer_list< QWidget * > widgets)

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QDialog
	Accepted

	Rejected

Public Attributes inherited from QWidget
	DrawChildren

	DrawWindowBackground

	IgnoreMask

Public Attributes inherited from QPaintDevice
	PdmDepth

	PdmDevicePixelRatio

	PdmDevicePixelRatioScaled

	PdmDpiX

	PdmDpiY

	PdmHeight

	PdmHeightMM

	PdmNumColors

	PdmPhysicalDpiX

	PdmPhysicalDpiY

	PdmWidth

	PdmWidthMM

Detailed Description

A dialog for requesting a password and optionally a login from the end user.

Usage Example

Requesting a simple password, asynchronous

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();

Requesting a login and a password, synchronous

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());

KPasswordDialog

dialog for requesting login and password from the end user

Definition at line 54 of file kpassworddialog.h.

Member Typedef Documentation

◆ KPasswordDialogFlags

QFlags< KPasswordDialogFlag > KPasswordDialog::KPasswordDialogFlags

Stores a combination of KPasswordDialogFlag values.

Definition at line 97 of file kpassworddialog.h.

Member Enumeration Documentation

◆ ErrorType

enum KPasswordDialog::ErrorType

Enumerator
UsernameError	A problem with the user name as entered.
PasswordError	Incorrect password.
FatalError	Error preventing further attempts, will result in disabling most of the interface.
DomainError	A problem with the domain as entered. Since 4.1

Definition at line 99 of file kpassworddialog.h.

◆ KPasswordDialogFlag

enum KPasswordDialog::KPasswordDialogFlag

See also: KPasswordDialogFlags

Enumerator
ShowKeepPassword	If this flag is set, the "keep this password" checkbox will been shown, otherwise, it will not be shown and keepPassword will have no effect.
ShowUsernameLine	If this flag is set, there will be an additional line to let the user enter his login. otherwise, only the password line will be shown.
UsernameReadOnly	If this flag is set, the login lineedit will be in read only mode.
ShowAnonymousLoginCheckBox	If this flag is set, the Anonymous Login checkbox will be displayed. Since 4.1
ShowDomainLine	If this flag is set, there will be an additional line to let the user enter the domain. Since 4.1
DomainReadOnly	If this flag is set, the domain lineedit will be in read only mode. Since 4.1

Definition at line 62 of file kpassworddialog.h.

Constructor & Destructor Documentation

◆ KPasswordDialog()

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

explicit

create a password dialog

Parameters

parent	the parent widget
flags	a set of KPasswordDialogFlag flags

Definition at line 48 of file kpassworddialog.cpp.

◆ ~KPasswordDialog()

KPasswordDialog::~KPasswordDialog ( )

overridedefault

Destructor.

Member Function Documentation

◆ accept()

void KPasswordDialog::accept ( )

overridevirtual

Reimplemented from QDialog.

Definition at line 392 of file kpassworddialog.cpp.

◆ addCommentLine()

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.

Parameters

label	label for comment (ex:"Command:")
comment	the actual comment text.

Definition at line 201 of file kpassworddialog.cpp.

◆ anonymousMode()

bool KPasswordDialog::anonymousMode ( ) const

Returns: anonymous mode has been selected.

Since: 4.1

Definition at line 186 of file kpassworddialog.cpp.

◆ buttonBox()

QDialogButtonBox * KPasswordDialog::buttonBox ( ) const

Returns the button box used in the dialog.

This can be used to add new buttons.

Returns: the button box

Since: 5.0

Definition at line 432 of file kpassworddialog.cpp.

◆ checkPassword()

bool KPasswordDialog::checkPassword ( )

protectedvirtual

Virtual function that can be overridden to provide password checking in derived classes.

It should return true if the password is valid, false otherwise.

Definition at line 427 of file kpassworddialog.cpp.

◆ domain()

QString KPasswordDialog::domain ( ) const

Returns the domain entered by the user.

Returns: the domain name

Since: 4.1

Definition at line 167 of file kpassworddialog.cpp.

◆ gotPassword

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

signal

emitted when the dialog has been accepted

Parameters

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

◆ gotUsernameAndPassword

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

signal

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

Parameters

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

◆ icon()

QIcon KPasswordDialog::icon ( ) const

Returns the icon that appears next to the prompt.

Definition at line 134 of file kpassworddialog.cpp.

◆ isRevealPasswordAvailable()

bool KPasswordDialog::isRevealPasswordAvailable ( ) const

Whether the visibility trailing action in the line edit is visible.

Since: 5.84

Definition at line 367 of file kpassworddialog.cpp.

◆ keepPassword()

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: true to keep the password

Definition at line 196 of file kpassworddialog.cpp.

◆ password()

QString KPasswordDialog::password ( ) const

Returns the password entered by the user.

Returns: the password

Definition at line 157 of file kpassworddialog.cpp.

◆ prompt()

QString KPasswordDialog::prompt ( ) const

Returns the prompt.

Definition at line 297 of file kpassworddialog.cpp.

◆ revealPasswordMode()

KPassword::RevealMode KPasswordDialog::revealPasswordMode ( ) const

Return when the reveal password button is visible.

Since: 6.0

Definition at line 374 of file kpassworddialog.cpp.

◆ setAnonymousMode()

void KPasswordDialog::setAnonymousMode ( bool anonymous )

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

Since: 4.1

Definition at line 172 of file kpassworddialog.cpp.

◆ setDomain()

void KPasswordDialog::setDomain ( const QString & domain )

set the default domain.

Since: 4.1

Definition at line 162 of file kpassworddialog.cpp.

◆ setIcon()

void KPasswordDialog::setIcon ( const QIcon & icon )

Set the icon that appears next to the prompt.

Since: 5.63

Definition at line 124 of file kpassworddialog.cpp.

◆ setKeepPassword()

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

Definition at line 191 of file kpassworddialog.cpp.

◆ setKnownLogins()

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

Parameters

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

Definition at line 316 of file kpassworddialog.cpp.

◆ setPassword()

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.

Parameters

password the password to set

Definition at line 302 of file kpassworddialog.cpp.

◆ setPrompt()

void KPasswordDialog::setPrompt ( const QString & prompt )

Sets the prompt to show to the user.

Parameters

prompt instructional text to be shown.

Definition at line 287 of file kpassworddialog.cpp.

◆ setRevealPasswordAvailable()

void KPasswordDialog::setRevealPasswordAvailable ( bool reveal )

Whether to show the visibility trailing action in the line edit.

Default is true. This can be used to honor the lineedit_reveal_password kiosk key, for example:

dlg->setRevealPasswordAvailable(KAuthorized::authorize(QStringLiteral("lineedit_reveal_password")));

KAuthorized::authorize

static Q_INVOKABLE bool authorize(const QString &action)

Since: 5.84

Definition at line 362 of file kpassworddialog.cpp.

◆ setRevealPasswordMode()

void KPasswordDialog::setRevealPasswordMode ( KPassword::RevealMode revealPasswordMode )

Set when the reveal password button will be visible.

The default is RevealMode::OnlyNew and the reveal password button will only be visible when entering a new password.

This can be used to honor the lineedit_reveal_password kiosk key, for example:

if (KAuthorized::authorize(QStringLiteral("lineedit_reveal_password"))) {
    passwordDialog.setRevealPasswordMode(KPassword::RevealMode::OnlyNew);
} else {
    passwordDialog.setRevealPasswordMode(KPassword::RevealMode::Never);
}

Since: 6.0

Definition at line 379 of file kpassworddialog.cpp.

◆ setUsername()

void KPasswordDialog::setUsername ( const QString & user )

set the default username.

Definition at line 139 of file kpassworddialog.cpp.

◆ setUsernameContextHelp()

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.

Since: 5.76

Definition at line 437 of file kpassworddialog.cpp.

◆ setUsernameReadOnly()

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

Parameters

readOnly true to set the user field to read-only

Definition at line 307 of file kpassworddialog.cpp.

◆ showErrorMessage()

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

Shows an error message in the dialog box.

Prevents having to show a dialog-on-a-dialog.

Parameters

message the error message to show

Definition at line 249 of file kpassworddialog.cpp.

◆ username()

QString KPasswordDialog::username ( ) const

Returns the username entered by the user.

Returns: the user name

Definition at line 152 of file kpassworddialog.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KWidgetsAddons

KPasswordDialog

Public Types

Signals

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Usage Example

Member Typedef Documentation

◆ KPasswordDialogFlags

Member Enumeration Documentation

◆ ErrorType

◆ KPasswordDialogFlag

Constructor & Destructor Documentation

◆ KPasswordDialog()

◆ ~KPasswordDialog()

Member Function Documentation

◆ accept()

◆ addCommentLine()

◆ anonymousMode()

◆ buttonBox()

◆ checkPassword()

◆ domain()

◆ gotPassword

◆ gotUsernameAndPassword

◆ icon()

◆ isRevealPasswordAvailable()

◆ keepPassword()

◆ password()

◆ prompt()

◆ revealPasswordMode()

◆ setAnonymousMode()

◆ setDomain()

◆ setIcon()

◆ setKeepPassword()

◆ setKnownLogins()

◆ setPassword()

◆ setPrompt()

◆ setRevealPasswordAvailable()

◆ setRevealPasswordMode()

◆ setUsername()

◆ setUsernameContextHelp()

◆ setUsernameReadOnly()

◆ showErrorMessage()

◆ username()