kwebwallet.h

Go to the documentation of this file.

/*
 * This file is part of the KDE project.
 *
 * Copyright (C) 2009 Dawit Alemayehu <adawit@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 as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * 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 KWEBWALLET_H
#define KWEBWALLET_H

#include <kdewebkit_export.h>

#include <kurl.h>

#include <QtCore/QObject>
#include <QtCore/QString>
#include <QtCore/QList>
#include <QtCore/QPair>
#include <QtGui/QWidget>
#include <QtCore/QtGlobal>

class QWebFrame;
class QWebPage;


class KDEWEBKIT_EXPORT KWebWallet : public QObject
{
    Q_OBJECT

public:

    struct WebForm
    {
        typedef QPair<QString, QString> WebField;

        QUrl url;
        QString name;
        QString index;
        QList<WebField> fields;
    };

    typedef QList<WebForm> WebFormList;

    explicit KWebWallet(QObject* parent = 0, WId wid = 0);

    virtual ~KWebWallet();

    WebFormList formsWithCachedData(QWebFrame* frame, bool recursive = true) const;

    void saveFormData(QWebFrame *frame, bool recursive = true, bool ignorePasswordFields = false);

    void fillFormData(QWebFrame *frame, bool recursive = true);

    void removeFormData (QWebFrame *frame, bool recursive);

    void removeFormData(const WebFormList &forms);

public Q_SLOTS:
    void acceptSaveFormDataRequest(const QString &key);

    void rejectSaveFormDataRequest(const QString &key);

Q_SIGNALS:
    void saveFormDataRequested(const QString &key, const QUrl &url);

    void saveFormDataCompleted(const QUrl &url, bool ok);

    void fillFormRequestCompleted(bool ok);

    void walletClosed();

protected:
    WebFormList formsToFill(const KUrl &url) const;

    WebFormList formsToSave(const QString &key) const;

    WebFormList formsToDelete() const;

    virtual bool hasCachedFormData(const WebForm &form) const;

    void fillWebForm(const KUrl &url, const WebFormList &forms);

    virtual void fillFormDataFromCache(const KUrl::List &list);

    virtual void saveFormDataToCache(const QString &key);

    virtual void removeFormDataFromCache(const WebFormList &forms);

private:
    class KWebWalletPrivate;
    friend class KWebWalletPrivate;
    KWebWalletPrivate * const d;

    Q_PRIVATE_SLOT(d, void _k_openWalletDone(bool))
    Q_PRIVATE_SLOT(d, void _k_walletClosed())
};

#endif // KWEBWALLET_H