konq_historyprovider.h

Go to the documentation of this file.

/* This file is part of the KDE project
   Copyright 2000,2001 Carsten Pfeiffer <pfeiffer@kde.org>
   Copyright 2007-2009 David Faure <faure@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 ) version 3 or, at the discretion of KDE e.V.
   ( which shall act as a proxy as in section 14 of the GPLv3 ), 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 KONQ_HISTORYPROVIDER_H
#define KONQ_HISTORYPROVIDER_H

#include <kparts/historyprovider.h>
#include <kurl.h>
#include "libkonq_export.h"
#include "konq_historyentry.h"

class KonqHistoryEntry;
class KonqHistoryList;
class KonqHistoryProviderPrivate;

class LIBKONQ_EXPORT KonqHistoryProvider : public KParts::HistoryProvider
{
    Q_OBJECT

public:
    static KonqHistoryProvider *self() {
        return static_cast<KonqHistoryProvider*>(KParts::HistoryProvider::self());
    }

    explicit KonqHistoryProvider(QObject* parent = 0);
    virtual ~KonqHistoryProvider();

    const KonqHistoryList& entries() const;

    int maxCount() const;

    int maxAge() const;

    void emitSetMaxCount(int count);

    void emitSetMaxAge(int days);

    void emitRemoveFromHistory(const KUrl& url);

    void emitRemoveListFromHistory(const KUrl::List& urls);

    void emitClear();

    bool loadHistory();

Q_SIGNALS:
    void entryAdded( const KonqHistoryEntry& entry );

    void entryRemoved( const KonqHistoryEntry& entry );

protected: // only to be used by konqueror's KonqHistoryManager

    virtual void finishAddingEntry(const KonqHistoryEntry& entry, bool isSender);
    virtual void removeEntry(KonqHistoryList::iterator it);

    KonqHistoryList::iterator findEntry(const KUrl& url);
    KonqHistoryList::const_iterator constFindEntry(const KUrl& url) const;

    void emitAddToHistory(const KonqHistoryEntry& entry);

private:
    KonqHistoryProviderPrivate* const d;
    friend class KonqHistoryProviderPrivate;
};

#endif /* KONQ_HISTORYPROVIDER_H */