KNewPasswordWidget

#include <KNewPasswordWidget>

Inheritance diagram for KNewPasswordWidget:

[legend]

Public Types
enum	PasswordStatus { EmptyPasswordNotAllowed , PasswordTooShort , PasswordNotVerified , WeakPassword , StrongPassword }

enum class	RevealPasswordMode { OnlyNew , Never , Always }

Public Types inherited from QWidget
enum	RenderFlag

typedef	RenderFlags

Public Types inherited from QObject
typedef	QObjectList

Public Types inherited from QPaintDevice
enum	PaintDeviceMetric

Properties
bool	allowEmptyPasswords

QColor	backgroundWarningColor

int	maximumPasswordLength

int	minimumPasswordLength

PasswordStatus	passwordStatus

bool	passwordStrengthMeterVisible

int	passwordStrengthWarningLevel

int	reasonablePasswordLength

bool	revealPasswordAvailable

KPassword::RevealMode	revealPasswordMode

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

Signals
void	passwordStatusChanged ()

Public Slots
void	setAllowEmptyPasswords (bool allowed)

void	setBackgroundWarningColor (const QColor &color)

void	setMaximumPasswordLength (int maxLength)

void	setMinimumPasswordLength (int minLength)

void	setPasswordStrengthMeterVisible (bool visible)

void	setPasswordStrengthWarningLevel (int warningLevel)

void	setReasonablePasswordLength (int reasonableLength)

void	setRevealPasswordAvailable (bool reveal)

void	setRevealPasswordMode (KPassword::RevealMode revealPasswordMode)

Public Member Functions
	KNewPasswordWidget (QWidget *parent=nullptr)

	~KNewPasswordWidget () override

bool	allowEmptyPasswords () const

QColor	backgroundWarningColor () const

bool	isPasswordStrengthMeterVisible () const

bool	isRevealPasswordAvailable () const

int	maximumPasswordLength () const

int	minimumPasswordLength () const

QString	password () const

PasswordStatus	passwordStatus () const

int	passwordStrengthWarningLevel () const

int	reasonablePasswordLength () const

KPassword::RevealMode	revealPasswordMode () const

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

virtual QSize	minimumSizeHint () 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)

virtual void	setVisible (bool visible)

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

virtual QSize	sizeHint () 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

virtual bool	eventFilter (QObject watched, QEvent event)

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

Additional Inherited Members
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 QWidget
	DrawChildren

	DrawWindowBackground

	IgnoreMask

Public Attributes inherited from QPaintDevice
	PdmDepth

	PdmDevicePixelRatio

	PdmDevicePixelRatioScaled

	PdmDpiX

	PdmDpiY

	PdmHeight

	PdmHeightMM

	PdmNumColors

	PdmPhysicalDpiX

	PdmPhysicalDpiY

	PdmWidth

	PdmWidthMM

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

virtual void	changeEvent (QEvent *event)

virtual void	closeEvent (QCloseEvent *event)

virtual void	contextMenuEvent (QContextMenuEvent *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	keyPressEvent (QKeyEvent *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	resizeEvent (QResizeEvent *event)

virtual void	showEvent (QShowEvent *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

Detailed Description

A password input widget.

This widget allows the user to enter a new password.

The password has to be entered twice to check if the passwords match. A hint about the strength of the entered password is also shown.

In order to embed this widget in your custom password dialog, you may want to connect to the passwordStatus() signal. This way you can e.g. disable the OK button if the passwords don't match, warn the user if the password is too weak, and so on.

Usage Example

Setup

KNewPasswordWidget *m_passwordWidget = new KNewPasswordWidget(this);
// set a background warning color (taken from the current color scheme)
KColorScheme colorScheme(QPalette::Active, KColorScheme::View);
m_passwordWidget->setBackgroundWarningColor(colorScheme.background(KColorScheme::NegativeBackground).color());
// listen to password status updates
connect(m_passwordWidget, &KNewPasswordWidget::passwordStatusChanged, this, &MyCustomDialog::slotPasswordStatusChanged);
...

Update your custom dialog

void MyPasswordDialog::slotPasswordStatusChanged()
{
    // You may want to extend this switch with more cases,
    // in order to warn the user about all the possible password issues.
    switch (m_passwordWidget->passwordStatus()) {
    case KNewPasswordWidget::WeakPassword:
    case KNewPasswordWidget::StrongPassword:
        m_buttonBox->button(QDialogButtonBox::Ok)->setEnabled(true);
        break;
    default:
        m_buttonBox->button(QDialogButtonBox::Ok)->setEnabled(false);
        break;
    }
}

Accept your custom dialog

void MyPasswordDialog::accept()
{
    switch (m_passwordWidget->passwordStatus()) {
    case KNewPasswordWidget::WeakPassword:
    case KNewPasswordWidget::StrongPassword:
        QDialog::accept();
        break;
    case KNewPasswordWidget::PasswordNotVerified:
        KMessageBox::error(nullptr, i18n("The chosen password does not match the given verification password."));
        break;
    case KNewPasswordWidget::EmptyPasswordNotAllowed:
        KMessageBox::error(nullptr, i18n("The chosen password cannot be empty."));
        break;
    case KNewPasswordWidget::PasswordTooShort:
        KMessageBox::error(nullptr, i18n("The chosen password is too short."));
        break;
    }
}

Author: Geert Jansen janse.nosp@m.n@kd.nosp@m.e.org; Olivier Goffart ogoff.nosp@m.art@.nosp@m.kde.o.nosp@m.rg; Elvis Angelaccio elvis.nosp@m..ang.nosp@m.elacc.nosp@m.io@k.nosp@m.de.or.nosp@m.g

Since: 5.16

Definition at line 64 of file knewpasswordwidget.h.

Member Enumeration Documentation

◆ PasswordStatus

enum KNewPasswordWidget::PasswordStatus

Status of the password being typed in the widget.

Enumerator
EmptyPasswordNotAllowed	Both passwords fields empty, but minimum length > 0.
PasswordTooShort	Password length is too low.
PasswordNotVerified	Password and verification password don't match.
WeakPassword	Passwords match but the strength level is not enough.
StrongPassword	Passwords match and the strength level is good.

Definition at line 87 of file knewpasswordwidget.h.

◆ RevealPasswordMode

enum class KNewPasswordWidget::RevealPasswordMode

strong

This enum describe when the reveal password button is visible.

Since: 6.0

Enumerator

Enumerator
OnlyNew	Display the button when entering a new password, but doesn't let you see a previously entered password. This is the default.
Never	Never display the reveal button.
Always	Always display the reveal button. Usefull in a password manager for example.

OnlyNew

Display the button when entering a new password, but doesn't let you see a previously entered password.

This is the default.

Never

Never display the reveal button.

Always

Always display the reveal button.

Usefull in a password manager for example.

Definition at line 100 of file knewpasswordwidget.h.

Property Documentation

◆ allowEmptyPasswords

bool KNewPasswordWidget::allowEmptyPasswords

readwrite

Definition at line 68 of file knewpasswordwidget.h.

◆ backgroundWarningColor

QColor KNewPasswordWidget::backgroundWarningColor

readwrite

Definition at line 73 of file knewpasswordwidget.h.

◆ maximumPasswordLength

int KNewPasswordWidget::maximumPasswordLength

readwrite

Definition at line 70 of file knewpasswordwidget.h.

◆ minimumPasswordLength

int KNewPasswordWidget::minimumPasswordLength

readwrite

Definition at line 69 of file knewpasswordwidget.h.

◆ passwordStatus

PasswordStatus KNewPasswordWidget::passwordStatus

read

Definition at line 67 of file knewpasswordwidget.h.

◆ passwordStrengthMeterVisible

bool KNewPasswordWidget::passwordStrengthMeterVisible

readwrite

Definition at line 74 of file knewpasswordwidget.h.

◆ passwordStrengthWarningLevel

int KNewPasswordWidget::passwordStrengthWarningLevel

readwrite

Definition at line 72 of file knewpasswordwidget.h.

◆ reasonablePasswordLength

int KNewPasswordWidget::reasonablePasswordLength

readwrite

Definition at line 71 of file knewpasswordwidget.h.

◆ revealPasswordAvailable

bool KNewPasswordWidget::revealPasswordAvailable

readwrite

Since: 5.31

Definition at line 79 of file knewpasswordwidget.h.

◆ revealPasswordMode

KPassword::RevealMode KNewPasswordWidget::revealPasswordMode

readwrite

Definition at line 81 of file knewpasswordwidget.h.

Constructor & Destructor Documentation

◆ KNewPasswordWidget()

KNewPasswordWidget::KNewPasswordWidget ( QWidget * parent = nullptr )

explicit

Constructs a password widget.

Parameters

parent Passed to lower level constructor.

Definition at line 193 of file knewpasswordwidget.cpp.

◆ ~KNewPasswordWidget()

KNewPasswordWidget::~KNewPasswordWidget ( )

overridedefault

Destructs the password widget.

Member Function Documentation

◆ allowEmptyPasswords()

bool KNewPasswordWidget::allowEmptyPasswords ( ) const

Allow empty passwords?

Returns: true if minimumPasswordLength() == 0

Definition at line 207 of file knewpasswordwidget.cpp.

◆ backgroundWarningColor()

QColor KNewPasswordWidget::backgroundWarningColor ( ) const

The color used as warning for the verification password field's background.

Definition at line 232 of file knewpasswordwidget.cpp.

◆ isPasswordStrengthMeterVisible()

bool KNewPasswordWidget::isPasswordStrengthMeterVisible ( ) const

Whether the password strength meter is visible.

Definition at line 237 of file knewpasswordwidget.cpp.

◆ isRevealPasswordAvailable()

bool KNewPasswordWidget::isRevealPasswordAvailable ( ) const

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

Since: 5.31

Definition at line 245 of file knewpasswordwidget.cpp.

◆ maximumPasswordLength()

int KNewPasswordWidget::maximumPasswordLength ( ) const

Maximum acceptable password length.

Definition at line 217 of file knewpasswordwidget.cpp.

◆ minimumPasswordLength()

int KNewPasswordWidget::minimumPasswordLength ( ) const

Minimum acceptable password length.

Definition at line 212 of file knewpasswordwidget.cpp.

◆ password()

QString KNewPasswordWidget::password ( ) const

Returns the password entered.

Note: Only returns meaningful data when passwordStatus is either WeakPassword or StrongPassword.

Definition at line 257 of file knewpasswordwidget.cpp.

◆ passwordStatus()

KNewPasswordWidget::PasswordStatus KNewPasswordWidget::passwordStatus ( ) const

The current status of the password in the widget.

Definition at line 202 of file knewpasswordwidget.cpp.

◆ passwordStatusChanged

void KNewPasswordWidget::passwordStatusChanged ( )

signal

Notify about the current status of the password being typed.

◆ passwordStrengthWarningLevel()

int KNewPasswordWidget::passwordStrengthWarningLevel ( ) const

Password strength level below which a warning is given.

Definition at line 227 of file knewpasswordwidget.cpp.

◆ reasonablePasswordLength()

int KNewPasswordWidget::reasonablePasswordLength ( ) const

Password length that is expected to be reasonably safe.

Definition at line 222 of file knewpasswordwidget.cpp.

◆ revealPasswordMode()

KPassword::RevealMode KNewPasswordWidget::revealPasswordMode ( ) const

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

Since: 6.0

Definition at line 252 of file knewpasswordwidget.cpp.

◆ setAllowEmptyPasswords

void KNewPasswordWidget::setAllowEmptyPasswords ( bool allowed )

slot

Allow empty passwords? - Default: true.

same as setMinimumPasswordLength( allowed ? 0 : 1 )

Definition at line 262 of file knewpasswordwidget.cpp.

◆ setBackgroundWarningColor

void KNewPasswordWidget::setBackgroundWarningColor ( const QColor & color )

slot

When the verification password does not match, the background color of the verification field is set to color.

As soon as the passwords match, the original color of the verification field is restored.

Definition at line 296 of file knewpasswordwidget.cpp.

◆ setMaximumPasswordLength

void KNewPasswordWidget::setMaximumPasswordLength ( int maxLength )

slot

Maximum acceptable password length.

Parameters

maxLength The new maximum password length.

Definition at line 274 of file knewpasswordwidget.cpp.

◆ setMinimumPasswordLength

void KNewPasswordWidget::setMinimumPasswordLength ( int minLength )

slot

Minimum acceptable password length.

Default: 0

Parameters

minLength The new minimum password length

Definition at line 268 of file knewpasswordwidget.cpp.

◆ setPasswordStrengthMeterVisible

void KNewPasswordWidget::setPasswordStrengthMeterVisible ( bool visible )

slot

Whether to show the password strength meter (label and progress bar).

Default is true.

Definition at line 302 of file knewpasswordwidget.cpp.

◆ setPasswordStrengthWarningLevel

void KNewPasswordWidget::setPasswordStrengthWarningLevel ( int warningLevel )

slot

Set the password strength level below which a warning is given The value is guaranteed to be in the range from 0 to 99.

Empty passwords score 0; non-empty passwords score up to 100, depending on their length and whether they contain numbers, mixed case letters and punctuation.

Default: 1 - warn if the password has no discernible strength whatsoever

Parameters

warningLevel The level below which a warning should be given.

Definition at line 291 of file knewpasswordwidget.cpp.

◆ setReasonablePasswordLength

void KNewPasswordWidget::setReasonablePasswordLength ( int reasonableLength )

slot

Password length that is expected to be reasonably safe.

The value is guaranteed to be in the range from 1 to maximumPasswordLength().

Used to compute the strength level

Default: 8 - the standard UNIX password length

Parameters

reasonableLength The new reasonable password length.

Definition at line 286 of file knewpasswordwidget.cpp.

◆ setRevealPasswordAvailable

void KNewPasswordWidget::setRevealPasswordAvailable ( bool reveal )

slot

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:

passwordWidget.setRevealPasswordAvailable(KAuthorized::authorize(QStringLiteral("lineedit_reveal_password")));

KAuthorized::authorize

static Q_INVOKABLE bool authorize(const QString &action)

Since: 5.31

Definition at line 311 of file knewpasswordwidget.cpp.

◆ setRevealPasswordMode

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

slot

Set when the reveal password button will be visible.

The default is RevealPasswordMode::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"))) {
    newPasswordWidget.setRevealPasswordMode(KPassword::RevealMode::OnlyNew);
} else {
    newPasswordWidget.setRevealPasswordMode(KPassword::RevealMode::Never);
}

Since: 6.0

Definition at line 318 of file knewpasswordwidget.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

KNewPasswordWidget

Public Types

Properties

Signals

Public Slots

Public Member Functions

Additional Inherited Members

Detailed Description

Usage Example

Setup

Update your custom dialog

Accept your custom dialog

Member Enumeration Documentation

◆ PasswordStatus

◆ RevealPasswordMode

Property Documentation

◆ allowEmptyPasswords

◆ backgroundWarningColor

◆ maximumPasswordLength

◆ minimumPasswordLength

◆ passwordStatus

◆ passwordStrengthMeterVisible

◆ passwordStrengthWarningLevel

◆ reasonablePasswordLength

◆ revealPasswordAvailable

◆ revealPasswordMode

Constructor & Destructor Documentation

◆ KNewPasswordWidget()

◆ ~KNewPasswordWidget()

Member Function Documentation

◆ allowEmptyPasswords()

◆ backgroundWarningColor()

◆ isPasswordStrengthMeterVisible()

◆ isRevealPasswordAvailable()

◆ maximumPasswordLength()

◆ minimumPasswordLength()

◆ password()

◆ passwordStatus()

◆ passwordStatusChanged

◆ passwordStrengthWarningLevel()

◆ reasonablePasswordLength()

◆ revealPasswordMode()

◆ setAllowEmptyPasswords

◆ setBackgroundWarningColor

◆ setMaximumPasswordLength

◆ setMinimumPasswordLength

◆ setPasswordStrengthMeterVisible

◆ setPasswordStrengthWarningLevel

◆ setReasonablePasswordLength

◆ setRevealPasswordAvailable

◆ setRevealPasswordMode