kpassworddialog.h

Go to the documentation of this file.

/* 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>
#include <QtCore/QFlags>

class KDEUI_EXPORT KPasswordDialog : public KDialog
{
    Q_OBJECT

public:
    
    enum KPasswordDialogFlag
    {
        NoFlags = 0x00,
        ShowKeepPassword = 0x01,
        ShowUsernameLine = 0x02,
        UsernameReadOnly = 0x04,
        ShowAnonymousLoginCheckBox = 0x08,
        ShowDomainLine = 0x10,
        DomainReadOnly = 0x20
    };
    Q_DECLARE_FLAGS(KPasswordDialogFlags, KPasswordDialogFlag)

    enum ErrorType
    {
        UnknownError = 0,

        UsernameError,
        
        PasswordError,

        FatalError,
        
        DomainError        
    };

    explicit KPasswordDialog( QWidget *parent = 0L,
                              const KPasswordDialogFlags& flags = 0,
                              const KDialog::ButtonCodes otherButtons = 0);

    ~KPasswordDialog();

    void setPrompt( const QString& prompt );

    QString prompt() const;

    void setPixmap(const QPixmap&);
    QPixmap pixmap() const;

    void addCommentLine( const QString& label, const QString& comment );

    void showErrorMessage( const QString& message, const ErrorType type = PasswordError );

    QString password() const;

    void setUsername(const QString&);

    QString username() const;

    void setDomain(const QString&);

    QString domain() const;
    
    void setAnonymousMode(bool anonymous);

    bool anonymousMode() const;    
    
    bool keepPassword() const;

    void setKeepPassword( bool b );

    void setUsernameReadOnly( bool readOnly );

    void setPassword( const QString& password );

    void setKnownLogins( const QMap<QString, QString>& knownLogins );

    void accept();

Q_SIGNALS:
    void gotPassword( const QString& password , bool keep );

    void gotUsernameAndPassword( const QString& username, const QString& password , bool keep );

protected:
    virtual bool checkPassword();


private:
    Q_PRIVATE_SLOT(d, void actuallyAccept())
    Q_PRIVATE_SLOT(d, void activated( const QString& userName ))
    Q_PRIVATE_SLOT(d, void updateFields())

private:
    class KPasswordDialogPrivate;
    friend class KPasswordDialogPrivate;
    KPasswordDialogPrivate* const d;
    
    Q_DISABLE_COPY(KPasswordDialog)
};

Q_DECLARE_OPERATORS_FOR_FLAGS(KPasswordDialog::KPasswordDialogFlags)

#endif