kdeui Library API Documentation

KPasswordDialog Class Reference

This dialog asks the user to enter a password. A password input dialog. More...

#include <kpassdlg.h>

Inheritance diagram for KPasswordDialog:

KDialogBase KDialog QDialog List of all members.

Public Types

enum  Types { Password, NewPassword }

Public Member Functions

 KPasswordDialog (Types type, bool enableKeep, int extraBttn, QWidget *parent=0, const char *name=0)
 KPasswordDialog (int type, QString prompt, bool enableKeep=false, int extraBttn=0) KDE_DEPRECATED
 KPasswordDialog (Types type, bool enableKeep, int extraBttn, const QString &iconName, QWidget *parent=0, const char *name=0)
virtual ~KPasswordDialog ()
void setPrompt (QString prompt)
QString prompt () const
void addLine (QString key, QString value)
const char * password () const
void clearPassword ()
bool keep () const

Static Public Member Functions

int getPassword (QCString &password, QString prompt, int *keep=0L)
int getNewPassword (QCString &password, QString prompt)
void disableCoreDumps ()

Protected Slots

void slotOk ()
void slotCancel ()
void slotKeep (bool)

Protected Member Functions

virtual bool checkPassword (const char *)
virtual void virtual_hook (int id, void *data)

Detailed Description

This dialog asks the user to enter a password. A password input dialog.

The functions you're probably interested in are the static methods, getPassword() and getNewPassword().

Usage example

 QCString password;
 int result = KPasswordDialog::getPassword(password, i18n("Password"));
 if (result == KPasswordDialog::Accepted)
     use(password);

Security notes:

Keeping passwords in memory can be a potential security hole. You should handle this situation with care.

Author:
Geert Jansen <jansen@kde.org>

Definition at line 145 of file kpassdlg.h.


Member Enumeration Documentation

enum KPasswordDialog::Types
 

This enum distinguishes the two operation modes of this dialog:.

Enumeration values:
Password  The user is asked to enter a password.
NewPassword  The user is asked to enter a password and to confirm it a second time.

This is usually used when the user changes his password.

Definition at line 154 of file kpassdlg.h.


Constructor & Destructor Documentation

KPasswordDialog::KPasswordDialog Types  type,
bool  enableKeep,
int  extraBttn,
QWidget parent = 0,
const char *  name = 0
 

Constructs a password dialog.

Parameters:
type: if NewPassword is given here, the dialog contains two input fields, so that the user must confirm his password and possible typos are detected immediately.
enableKeep: if true, a check box is shown in the dialog which allows the user to keep his password input for later.
extraBttn: allows to show additional buttons, KDialogBase.
parent Passed to lower level constructor.
name Passed to lower level constructor
Since:
3.0
Definition at line 238 of file kpassdlg.cpp.

Referenced by getNewPassword(), and getPassword().

KPasswordDialog::KPasswordDialog int  type,
QString  prompt,
bool  enableKeep = false,
int  extraBttn = 0
 

Deprecated:
Variant of the previous constructor without the possibility to specify a parent. Will be removed in KDE 4.0
Definition at line 259 of file kpassdlg.cpp.

References setPrompt().

KPasswordDialog::KPasswordDialog Types  type,
bool  enableKeep,
int  extraBttn,
const QString iconName,
QWidget parent = 0,
const char *  name = 0
 

Construct a password dialog.

Essentially the same as above but allows the icon in the password dialog to be set via iconName.

Parameters:
type if NewPassword is given here, the dialog contains two input fields, so that the user must confirm his password and possible typos are detected immediately
iconName the name of the icon to be shown in the dialog. If empty, a default icon is used
Since:
3.3
Definition at line 247 of file kpassdlg.cpp.

KPasswordDialog::~KPasswordDialog  )  [virtual]
 

Destructs the password dialog.

Definition at line 366 of file kpassdlg.cpp.


Member Function Documentation

void KPasswordDialog::setPrompt QString  prompt  ) 
 

Sets the password prompt.

Definition at line 377 of file kpassdlg.cpp.

Referenced by KPasswordDialog().

QString KPasswordDialog::prompt  )  const
 

Returns the password prompt.

Definition at line 384 of file kpassdlg.cpp.

void KPasswordDialog::addLine QString  key,
QString  value
 

Adds a line of information to the dialog.

Definition at line 392 of file kpassdlg.cpp.

const char* KPasswordDialog::password  )  const [inline]
 

Returns the password entered.

The memory is freed in the destructor, so you should make a copy. Definition at line 231 of file kpassdlg.h.

References KPasswordEdit::password().

Referenced by getNewPassword(), and getPassword().

void KPasswordDialog::clearPassword  ) 
 

Clears the password input field.

You might want to use this after the user failed to enter the correct password.

Since:
3.3
Definition at line 371 of file kpassdlg.cpp.

References KPasswordEdit::erase().

bool KPasswordDialog::keep  )  const [inline]
 

Returns true if the user wants to keep the password.

Definition at line 243 of file kpassdlg.h.

Referenced by getPassword().

int KPasswordDialog::getPassword QCString password,
QString  prompt,
int *  keep = 0L
[static]
 

Pops up the dialog, asks the user for a password, and returns it.

Parameters:
password The password is returned in this reference parameter.
prompt A prompt for the password. This can be a few lines of information. The text is word broken to fit nicely in the dialog.
keep Enable/disable a checkbox controlling password keeping. If you pass a null pointer, or a pointer to the value 0, the checkbox is not shown. If you pass a pointer to a nonzero value, the checkbox is shown and the result is stored in *keep.
Returns:
Result code: Accepted or Rejected.
Definition at line 450 of file kpassdlg.cpp.

References keep(), KPasswordDialog(), password(), and Password.

int KPasswordDialog::getNewPassword QCString password,
QString  prompt
[static]
 

Pops up the dialog, asks the user for a password and returns it.

The user has to enter the password twice to make sure it was entered correctly.

Parameters:
password The password is returned in this reference parameter.
prompt A prompt for the password. This can be a few lines of information. The text is word broken to fit nicely in the dialog.
Returns:
Result code: Accepted or Rejected.
Definition at line 467 of file kpassdlg.cpp.

References KPasswordDialog(), NewPassword, and password().

void KPasswordDialog::disableCoreDumps  )  [static]
 

Static helper function that disables core dumps.

Definition at line 479 of file kpassdlg.cpp.

void KPasswordDialog::slotOk  )  [protected, virtual, slot]
 

Activated when the Ok button has been clicked.

The QDialog::accept() is activated.

Reimplemented from KDialogBase.

Definition at line 419 of file kpassdlg.cpp.

References checkPassword(), NewPassword, KPasswordEdit::password(), and KMessageBox::sorry().

void KPasswordDialog::slotCancel  )  [protected, virtual, slot]
 

Activated when the Cancel button has been clicked.

The QDialog::reject() is activated in regular mode and QDialog::done( Cancel ) when in message box mode.

Reimplemented from KDialogBase.

Definition at line 437 of file kpassdlg.cpp.

virtual bool KPasswordDialog::checkPassword const char *   )  [inline, protected, virtual]
 

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 288 of file kpassdlg.h.

Referenced by slotOk().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdeui Library Version 3.3.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Sep 29 09:43:33 2004 by doxygen 1.3.8 written by Dimitri van Heesch, © 1997-2003