KParts::HistoryProvider Class Reference

#include <historyprovider.h>

Inherits TQObject.

Signals
void	cleared ()
void	updated (const TQStringList &items)
void	inserted (const TQString &item)

Public Member Functions
	HistoryProvider (TQObject *parent=0L, const char *name=0)
virtual	~HistoryProvider ()
virtual bool	contains (const TQString &item) const
virtual void	insert (const TQString &item)
virtual void	remove (const TQString &item)
virtual void	clear ()

Static Public Member Functions
static HistoryProvider *	self ()

Protected Member Functions
virtual void	virtual_hook (int id, void *data)

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 tdehtml, just create your provider and call the HistoryProvider constructor before you do any tdehtml stuff. That way, tdehtml, using the self()-method, will use your subclassed provider.

Author

Carsten Pfeiffer pfeif.nosp@m.fer@.nosp@m.kde.o.nosp@m.rg

Definition at line 41 of file historyprovider.h.

Constructor & Destructor Documentation

HistoryProvider()

HistoryProvider::HistoryProvider	(	TQObject *	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::~HistoryProvider ( )

virtual

Destroys the provider.

Definition at line 56 of file historyprovider.cpp.

Member Function Documentation

clear()

void HistoryProvider::clear ( )

virtual

Clears the history.

The cleared() signal is emitted after clearing.

Definition at line 81 of file historyprovider.cpp.

cleared

void KParts::HistoryProvider::cleared ( )

signal

Emitted after the history has been cleared.

contains()

bool HistoryProvider::contains ( const TQString &  item ) const

virtual

Returns

true if item is present in the history.

Definition at line 64 of file historyprovider.cpp.

insert()

void HistoryProvider::insert ( const TQString &  item )

virtual

Inserts item into the history.

Definition at line 69 of file historyprovider.cpp.

inserted

void KParts::HistoryProvider::inserted ( const TQString &  item )

signal

Emitted after the item has been inserted.

remove()

void HistoryProvider::remove ( const TQString &  item )

virtual

Removes item from the history.

Definition at line 76 of file historyprovider.cpp.

updated

void KParts::HistoryProvider::updated ( const TQStringList &  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:

• historyprovider.h
• historyprovider.cpp