kparts Library API Documentation

KParts::HistoryProvider Class Reference

Basic class to manage a history of "items". More...

#include <historyprovider.h>

Inheritance diagram for KParts::HistoryProvider:

QObject List of all members.

Signals

void cleared ()
 Emitted after the history has been cleared.

void updated (const QStringList &items)
 This signal is never emitted from this class, it is only meant as an interface for subclasses.


Public Methods

 HistoryProvider (QObject *parent=0L, const char *name=0)
 Creates a KHistoryProvider with an optional parent and name.

virtual ~HistoryProvider ()
 Destroys the provider.

virtual bool contains (const QString &item) const
virtual void insert (const QString &item)
 Inserts item into the history.

virtual void remove (const QString &item)
 Removes item from the history.

virtual void clear ()
 Clears the history.


Detailed Description

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>

Definition at line 39 of file historyprovider.h.


Constructor & Destructor Documentation

HistoryProvider::HistoryProvider QObject   parent = 0L,
const char *    name = 0
 

Creates a KHistoryProvider with an optional parent and name.

Definition at line 47 of file historyprovider.cpp.

HistoryProvider::~HistoryProvider   [virtual]
 

Destroys the provider.

Definition at line 56 of file historyprovider.cpp.


Member Function Documentation

bool HistoryProvider::contains const QString   item const [virtual]
 

Returns:
true if item is present in the history.

Definition at line 64 of file historyprovider.cpp.

void HistoryProvider::insert const QString   item [virtual]
 

Inserts item into the history.

Definition at line 69 of file historyprovider.cpp.

void HistoryProvider::remove const QString   item [virtual]
 

Removes item from the history.

Definition at line 75 of file historyprovider.cpp.

void HistoryProvider::clear   [virtual]
 

Clears the history.

The cleared() signal is emitted after clearing.

Definition at line 80 of file historyprovider.cpp.

References cleared().

void KParts::HistoryProvider::cleared   [signal]
 

Emitted after the history has been cleared.

Referenced by clear().

void KParts::HistoryProvider::updated const QStringList   items [signal]
 

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 items.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.0.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed Oct 8 12:21:45 2003 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2001