mirror of
https://bitbucket.org/smil3y/kdelibs.git
synced 2025-02-23 18:32:49 +00:00
d28a9c8650
it is usually one comming from KPasswdStore Signed-off-by: Ivailo Monev <xakepa10@gmail.com>
269 lines
8 KiB
C++
269 lines
8 KiB
C++
/* This file is part of the KDE libraries
|
|
Copyright (C) 2000 David Faure <faure@kde.org>
|
|
Copyright (C) 2000 Dawit Alemayehu <adawit@kde.org>
|
|
Copyright (C) 2007 Olivier Goffart <ogoffart at kde.org>
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Library General Public
|
|
License version 2 as published by the Free Software Foundation.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Library General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Library General Public
|
|
License along with this library; see the file COPYING.LIB. If
|
|
not, write to the Free Software Foundation, Inc., 51 Franklin Street,
|
|
Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef KPASSWORDDIALOG_H
|
|
#define KPASSWORDDIALOG_H
|
|
|
|
#include <kdialog.h>
|
|
|
|
/**
|
|
* A dialog for requesting a password and optionaly a login from the end user.
|
|
*
|
|
* \section usage Usage Example
|
|
*
|
|
* Requesting a simple password, assynchronous
|
|
*
|
|
* \code
|
|
* KPasswordDialog *dlg = new KPasswordDialog( parent );
|
|
* dlg->setPrompt(i18n("Enter a password"));
|
|
* connect( dlg, SIGNAL( gotPassword( const QString& , bool ) ) , this, SLOT( setPassword( const QString &) ) );
|
|
* connect( dlg, SIGNAL( rejected() ) , this, SLOT( slotCancel() ) );
|
|
* dlg->show();
|
|
* \endcode
|
|
*
|
|
* Requesting a login and a password, synchronous
|
|
*
|
|
* \code
|
|
* 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() );
|
|
* \endcode
|
|
*
|
|
* \image html kpassworddialog.png "KDE Password Dialog"
|
|
*
|
|
* @short dialog for requesting login and password from the end user
|
|
*/
|
|
class KDEUI_EXPORT KPasswordDialog : public KDialog
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
enum KPasswordDialogFlag
|
|
{
|
|
NoFlags = 0x00,
|
|
/**
|
|
* 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
|
|
*/
|
|
ShowKeepPassword = 0x01,
|
|
/**
|
|
* 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.
|
|
*/
|
|
ShowUsernameLine = 0x02,
|
|
/**
|
|
* If this flag is set, the login lineedit will be in read only mode.
|
|
*/
|
|
UsernameReadOnly = 0x04,
|
|
/**
|
|
* If this flag is set, the Anonymous Login checkbox will be displayed
|
|
* @since 4.1
|
|
*/
|
|
ShowAnonymousLoginCheckBox = 0x08
|
|
};
|
|
Q_DECLARE_FLAGS(KPasswordDialogFlags, KPasswordDialogFlag)
|
|
|
|
enum ErrorType
|
|
{
|
|
UnknownError = 0,
|
|
|
|
/**
|
|
* A problem with the user name as entered
|
|
**/
|
|
UsernameError,
|
|
|
|
/**
|
|
* Incorrect password
|
|
*/
|
|
PasswordError,
|
|
|
|
/**
|
|
* Error preventing further attempts, will result in disabling most of the interface
|
|
*/
|
|
FatalError
|
|
};
|
|
|
|
/**
|
|
* create a password dialog
|
|
*
|
|
* @param parent the parent widget (default:NULL).
|
|
* @param flags a set of KPasswordDialogFlag flags
|
|
* @param otherButtons buttons to show in the dialog besides Ok and Cancel.
|
|
* Useful for adding application-specific buttons like
|
|
* "ignore" or "skip".
|
|
*/
|
|
explicit KPasswordDialog(QWidget *parent = nullptr,
|
|
const KPasswordDialogFlags flags = NoFlags,
|
|
const KDialog::ButtonCodes otherButtons = KDialog::None);
|
|
|
|
/**
|
|
* Destructor
|
|
*/
|
|
~KPasswordDialog();
|
|
|
|
/**
|
|
* Sets the prompt to show to the user.
|
|
* @param prompt instructional text to be shown.
|
|
*/
|
|
void setPrompt(const QString &prompt);
|
|
|
|
/**
|
|
* Returns the prompt
|
|
*/
|
|
QString prompt() const;
|
|
|
|
/**
|
|
* set an image that appears next to the prompt.
|
|
*/
|
|
void setPixmap(const QPixmap&);
|
|
/**
|
|
*
|
|
*/
|
|
QPixmap pixmap() const;
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @param label label for comment (ex:"Command:")
|
|
* @param comment the actual comment text.
|
|
*/
|
|
void addCommentLine(const QString &label, const QString &comment);
|
|
|
|
/**
|
|
* Shows an error message in the dialog box. Prevents having to show a dialog-on-a-dialog.
|
|
*
|
|
* @param message the error message to show
|
|
*/
|
|
void showErrorMessage(const QString &message, const ErrorType type = PasswordError);
|
|
|
|
/**
|
|
* Returns the password entered by the user.
|
|
* @return the password
|
|
*/
|
|
QString password() const;
|
|
|
|
/**
|
|
* set the default username.
|
|
*/
|
|
void setUsername(const QString &user);
|
|
|
|
/**
|
|
* Returns the username entered by the user.
|
|
* @return the user name
|
|
*/
|
|
QString username() const;
|
|
|
|
/**
|
|
* set anonymous mode (all other fields will be grayed out)
|
|
* @since 4.1
|
|
*/
|
|
void setAnonymousMode(bool anonymous);
|
|
|
|
/**
|
|
* @return anonymous mode has been selected.
|
|
* @since 4.1
|
|
*/
|
|
bool anonymousMode() 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
|
|
*
|
|
* @return true to keep the password
|
|
*/
|
|
bool keepPassword() const;
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
void setKeepPassword(bool b);
|
|
|
|
/**
|
|
* 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
|
|
*
|
|
* @param readOnly true to set the user field to read-only
|
|
*/
|
|
void setUsernameReadOnly(bool readOnly);
|
|
|
|
/**
|
|
* Presets the password.
|
|
* @param password the password to set
|
|
*/
|
|
void setPassword(const QString &password);
|
|
|
|
/**
|
|
* @internal
|
|
*/
|
|
void accept();
|
|
|
|
Q_SIGNALS:
|
|
/**
|
|
* emitted when the dialog has been accepted
|
|
* @param password the entered password
|
|
* @param keep true if the "remember password" checkbox was checked, false otherwise. false if ShowKeepPassword was not set in the constructor
|
|
*/
|
|
void gotPassword(const QString &password , bool keep);
|
|
|
|
/**
|
|
* emitted when the dialog has been accepted, and ShowUsernameLine was set on the constructor
|
|
* @param username the entered username
|
|
* @param password the entered password
|
|
* @param keep true if the "remember password" checkbox was checked, false otherwise. false if ShowKeepPassword was not set in the constructor
|
|
*/
|
|
void gotUsernameAndPassword(const QString &username, const QString &password, bool keep);
|
|
|
|
protected:
|
|
/**
|
|
* Virtual function that can be overridden to provide password
|
|
* checking in derived classes. It should return @p true if the
|
|
* password is valid, @p false otherwise.
|
|
*/
|
|
virtual bool checkPassword();
|
|
|
|
private:
|
|
Q_PRIVATE_SLOT(d, void actuallyAccept())
|
|
|
|
private:
|
|
class KPasswordDialogPrivate;
|
|
friend class KPasswordDialogPrivate;
|
|
KPasswordDialogPrivate* const d;
|
|
|
|
Q_DISABLE_COPY(KPasswordDialog)
|
|
};
|
|
|
|
Q_DECLARE_OPERATORS_FOR_FLAGS(KPasswordDialog::KPasswordDialogFlags)
|
|
|
|
#endif
|