File indexing completed on 2024-04-28 04:58:10

 /*
     This file is part of the KDE project
     SPDX-FileCopyrightText: 2001 Carsten Pfeiffer <pfeiffer@kde.org>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef KHISTORYPROVIDER_H
 #define KHISTORYPROVIDER_H
 
 #include <libkonq_export.h>
 
 #include <QObject>
 
 class HistoryProviderPrivate;
 
 /**
  * @short 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 LIBKONQ_EXPORT HistoryProvider : public QObject
 {
     Q_OBJECT
     friend class ::HistoryProviderPrivate;
 
 public:
     static HistoryProvider *self();
 
     /**
      * @returns true if a provider has already been created.
      * @since 4.4
      */
     static bool exists();
 
     /**
      * @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();
 
 Q_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);
 
 protected:
     /**
      * Creates a KHistoryProvider with an optional parent and name
      */
     HistoryProvider(QObject *parent = nullptr);
 
     /**
      * Destroys the provider.
      */
     ~HistoryProvider() override;
 
 private:
     HistoryProviderPrivate *const d;
 };
 
 #endif // KHISTORYPROVIDER_H