---

KIO::PasswordDialog Class Reference

#include <passdlg.h>

Inheritance diagram for KIO::PasswordDialog:

List of all members.

Public Methods
	PasswordDialog (const QString &prompt, const QString &user, bool enableKeep=false, bool modal=true, QWidget *parent=0, const char *name=0)
	~PasswordDialog ()
void	setPrompt (const QString &prompt)
void	addCommentLine (const QString &label, const QString comment)
QString	password () const
QString	username () const
bool	keepPassword () const
void	setUserReadOnly (bool readOnly)
void	setEnableUserField (bool enable, bool=false)
void	setPassword (const QString &password)
Static Public Methods
int	getNameAndPassword (QString &user, QString &pass, bool *keep, const QString &prompt=QString::null, bool readOnly=false, const QString &caption=QString::null, const QString &comment=QString::null, const QString &label=QString::null)
Protected Methods
virtual void	virtual_hook (int id, void *data)

---

Detailed Description

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

KIO-Slave authors are encouraged to use SlaveBase::openPassDlg instead of directly instantiating this dialog.

Definition at line 35 of file passdlg.h.

---

Constructor & Destructor Documentation

KIO::PasswordDialog::PasswordDialog (  const QString &    prompt, const QString &    user, bool    enableKeep = false, bool    modal = true, QWidget *    parent = 0, const char *    name = 0 )

Create a password dialog. Parameters: prompt  instructional text to be shown. user  username, if known initially. enableKeep  if true, makes password persistent until KDE is shutdown. modal  if true, the dialog will be modal (default:true). parent  the parent widget (default:NULL). name  the dialog name (default:NULL).

KIO::PasswordDialog::~PasswordDialog (    )

Destructor

---

Member Function Documentation

void KIO::PasswordDialog::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 fucntion after a comment has already been added will not have any effect. Parameters: label  label for comment (ex:"Command:") comment  the actual comment text.

int KIO::PasswordDialog::getNameAndPassword (  QString &    user, QString &    pass, bool *    keep, const QString &    prompt = QString::null, bool    readOnly = false, const QString &    caption = QString::null, const QString &    comment = QString::null, const QString &    label = QString::null )  [static]

A convienence static method for obtaining authorization information from the end user. Parameters: user  username pass  password keep  pointer to flag that indicates prompt  text to display to user. readOnly  make the username field read-only. caption  set the title bar to given text. comment  extra comment to display to user. label  optinal label for extra comment. Returns: Accept/Reject based on the user choice.

bool KIO::PasswordDialog::keepPassword (    )

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

QString KIO::PasswordDialog::password (    )

Returns the password entered by the user.

void KIO::PasswordDialog::setEnableUserField (  bool    enable, bool    = false )  [inline]

Deprecated: . Use setUserReadOnly(bool). Definition at line 103 of file passdlg.h. References setUserReadOnly().

void KIO::PasswordDialog::setPassword (  const QString &    password )

Presets the password Since: 3.1

void KIO::PasswordDialog::setPrompt (  const QString &    prompt )

Sets the prompt to show to the user.

void KIO::PasswordDialog::setUserReadOnly (  bool    readOnly )

Sets the username field read-only and sets the focus to the password field. Parameters: readOnly  Referenced by setEnableUserField().

QString KIO::PasswordDialog::username (    )

Returns the username entered by the user.

---

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

• passdlg.h

---