Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.

BUG:215923


git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdelibs@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da

1 files changed, 109 insertions, 0 deletions

diff --git a/kparts/historyprovider.h b/kparts/historyprovider.h
new file mode 100644
index 000000000..de0b4bf2b
--- /dev/null
+++ b/kparts/historyprovider.h
@@ -0,0 +1,109 @@
+/* This file is part of the KDE project
+   Copyright (C) 2001 Carsten Pfeiffer <pfeiffer@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 KHISTORYPROVIDER_H
+#define KHISTORYPROVIDER_H
+
+#include <qdict.h>
+#include <qobject.h>
+
+#include <kdelibs_export.h>
+
+namespace KParts {
+
+/**
+ * Basic class to manage a history of "items". This class is only meant
+ * for fast lookup, if an item is in the history or not.
+ *
+ * May be subclassed to implement a persistent history for example.
+ * For usage with khtml, just create your provider and call the
+ * HistoryProvider constructor _before_ you do any khtml stuff. That way,
+ * khtml, using the self()-method, will use your subclassed provider.
+ *
+ * @author Carsten Pfeiffer <pfeiffer@kde.org>
+ */
+class KPARTS_EXPORT HistoryProvider : public QObject
+{
+    Q_OBJECT
+
+public:
+    static HistoryProvider * self();
+
+    /**
+     * Creates a KHistoryProvider with an optional parent and name
+     */
+    HistoryProvider( QObject *parent = 0L, const char *name = 0 );
+
+    /**
+     * Destroys the provider.
+     */
+    virtual ~HistoryProvider();
+
+    /**
+     * @returns true if @p item is present in the history.
+     */
+    virtual bool contains( const QString& item ) const;
+
+    /**
+     * Inserts @p item into the history.
+     */
+    virtual void insert( const QString& item );
+
+    /**
+     * Removes @p item from the history.
+     */
+    virtual void remove( const QString& item );
+
+    /**
+     * Clears the history. The cleared() signal is emitted after clearing.
+     */
+    virtual void clear();
+
+signals:
+    /**
+     * Emitted after the history has been cleared.
+     */
+    void cleared();
+
+    /**
+     * This signal is never emitted from this class, it is only meant as an
+     * interface for subclasses. Emit this signal to notify others that the
+     * history has changed. Put those items that were added or removed from the
+     * history into @p items.
+     */
+    void updated( const QStringList& items );
+
+    /**
+     * Emitted after the item has been inserted
+     */
+    void inserted( const QString& item );
+
+private:
+    static HistoryProvider *s_self;
+
+protected:
+    virtual void virtual_hook( int id, void* data );
+private:
+    class HistoryProviderPrivate;
+    HistoryProviderPrivate *d;
+};
+
+}
+
+#endif // KHISTORYPROVIDER_H