.TH "KParts::HistoryProvider" 3 "28 Jan 2004" "kparts Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KParts::HistoryProvider \- Basic class to manage a history of 'items'.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <historyprovider.h>\fP
.PP
Inherits \fBQObject\fP.
.PP
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBcleared\fP ()"
.br
.RI "\fIEmitted after the history has been cleared. \fP"
.ti -1c
.RI "void \fBupdated\fP (const  \fBQStringList\fP &items)"
.br
.RI "\fIThis signal is never emitted from this class, it is only meant as an interface for subclasses. \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBHistoryProvider\fP (\fBQObject\fP *\fBparent\fP=0L, const  char *\fBname\fP=0)"
.br
.RI "\fICreates a KHistoryProvider with an optional parent and name. \fP"
.ti -1c
.RI "virtual \fB~HistoryProvider\fP ()"
.br
.RI "\fIDestroys the provider. \fP"
.ti -1c
.RI "virtual bool \fBcontains\fP (const  \fBQString\fP &item) const "
.br
.ti -1c
.RI "virtual void \fBinsert\fP (const  \fBQString\fP &item)"
.br
.RI "\fIInserts \fCitem\fP into the history. \fP"
.ti -1c
.RI "virtual void \fBremove\fP (const  \fBQString\fP &item)"
.br
.RI "\fIRemoves \fCitem\fP from the history. \fP"
.ti -1c
.RI "virtual void \fBclear\fP ()"
.br
.RI "\fIClears the history. \fP"
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "\fBHistoryProvider\fP * \fBself\fP ()"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SH "Detailed Description"
.PP 
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.
.PP
May be subclassed to implement a persistent history for example. For usage with khtml, just create your provider and call the \fBHistoryProvider\fP constructor _before_ you do any khtml stuff. That way, khtml, using the self()-method, will use your subclassed provider.
.PP
\fBAuthor:\fP
.RS 4
Carsten Pfeiffer <pfeiffer@kde.org> 
.RE
.PP

.PP
Definition at line 39 of file historyprovider.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KParts::HistoryProvider::HistoryProvider (\fBQObject\fP * parent = 0L, const char * name = 0)"
.PP
Creates a KHistoryProvider with an optional parent and name. 
.SS "virtual KParts::HistoryProvider::~\fBHistoryProvider\fP ()\fC [virtual]\fP"
.PP
Destroys the provider. 
.SH "Member Function Documentation"
.PP 
.SS "virtual bool KParts::HistoryProvider::contains (const \fBQString\fP & item) const\fC [virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
true if \fCitem\fP is present in the history. 
.RE
.PP

.SS "virtual void KParts::HistoryProvider::insert (const \fBQString\fP & item)\fC [virtual]\fP"
.PP
Inserts \fCitem\fP into the history. 
.SS "virtual void KParts::HistoryProvider::remove (const \fBQString\fP & item)\fC [virtual]\fP"
.PP
Removes \fCitem\fP from the history. 
.SS "virtual void KParts::HistoryProvider::clear ()\fC [virtual]\fP"
.PP
Clears the history. The \fBcleared\fP() signal is emitted after clearing. 
.SS "void KParts::HistoryProvider::cleared ()\fC [signal]\fP"
.PP
Emitted after the history has been cleared. 
.SS "void KParts::HistoryProvider::updated (const \fBQStringList\fP & items)\fC [signal]\fP"
.PP
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 \fCitems\fP. 

.SH "Author"
.PP 
Generated automatically by Doxygen for kparts Library from the source code.
