Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KPasswordDialog Class Reference

A password input dialog. More...

#include <kpassdlg.h>

Inheritance diagram for KPasswordDialog:

KDialogBase KDialog List of all members.

Public Types

enum  Types { Password, NewPassword }

Public Methods

 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)
virtual ~KPasswordDialog ()
void setPrompt (QString prompt)
QString prompt () const
void addLine (QString key, QString value)
const char * password () const
bool keep () const

Static Public Methods

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

Protected Slots

void slotOk ()
void slotCancel ()

Protected Methods

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

Detailed Description

A password input dialog.

This dialog asks the user to enter a password. The functions you're probably interested in are the static methods, getPassword() and getNewPassword().

@sect Usage example 

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

@sect 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 133 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 142 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.
Version:
New in 3.0

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. May be removed in KDE 4.0

virtual KPasswordDialog::~KPasswordDialog (    )  [virtual]
 

Destructs the password dialog.

Member Function Documentation

void KPasswordDialog::addLine (  QString    key,
QString    value
) 
 

Adds a line of information to the dialog.

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

void KPasswordDialog::disableCoreDumps (    )  [static]
 

Static helper funtion that disables core dumps.

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.

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.

bool KPasswordDialog::keep (    )  const [inline]
 

Returns true if the user wants to keep the password.

Definition at line 202 of file kpassdlg.h.

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

References KPasswordEdit::password().

QString KPasswordDialog::prompt (    ) 
 

Returns the password prompt.

void KPasswordDialog::setPrompt (  QString    prompt ) 
 

Sets the password prompt.

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.

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

Activated when the Ok button has been clicked. The QDialog::accept() is activated.

Reimplemented from KDialogBase.

The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:20 2003 for kdelibs by doxygen1.2.18