\section{KParts::History\-Provider Class Reference}
\label{classKParts_1_1HistoryProvider}\index{KParts::HistoryProvider@{KParts::HistoryProvider}}
Basic class to manage a history of \char`\"{}items\char`\"{}.  


{\tt \#include $<$historyprovider.h$>$}

Inheritance diagram for KParts::History\-Provider:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=80pt]{classKParts_1_1HistoryProvider__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for KParts::History\-Provider:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=108pt]{classKParts_1_1HistoryProvider__coll__graph}
\end{center}
\end{figure}
\subsection*{Signals}
\begin{CompactItemize}
\item 
void {\bf cleared} ()
\begin{CompactList}\small\item\em Emitted after the history has been cleared. \item\end{CompactList}\item 
void {\bf updated} (const  {\bf QString\-List} \&items)
\begin{CompactList}\small\item\em This signal is never emitted from this class, it is only meant as an interface for subclasses. \item\end{CompactList}\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf History\-Provider} ({\bf QObject} $\ast${\bf parent}=0L, const  char $\ast${\bf name}=0)
\begin{CompactList}\small\item\em Creates a KHistory\-Provider with an optional parent and name. \item\end{CompactList}\item 
virtual {\bf $\sim$History\-Provider} ()
\begin{CompactList}\small\item\em Destroys the provider. \item\end{CompactList}\item 
virtual bool {\bf contains} (const  {\bf QString} \&item) const 
\item 
virtual void {\bf insert} (const  {\bf QString} \&item)
\begin{CompactList}\small\item\em Inserts {\tt item} into the history. \item\end{CompactList}\item 
virtual void {\bf remove} (const  {\bf QString} \&item)
\begin{CompactList}\small\item\em Removes {\tt item} from the history. \item\end{CompactList}\item 
virtual void {\bf clear} ()
\begin{CompactList}\small\item\em Clears the history. \item\end{CompactList}\end{CompactItemize}
\subsection*{Static Public Member Functions}
\begin{CompactItemize}
\item 
{\bf History\-Provider} $\ast$ {\bf self} ()\label{classKParts_1_1HistoryProvider_e0}

\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
virtual void {\bf virtual\_\-hook} (int id, void $\ast$data)\label{classKParts_1_1HistoryProvider_b0}

\end{CompactItemize}


\subsection{Detailed Description}
Basic class to manage a history of \char`\"{}items\char`\"{}. 

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 {\bf History\-Provider}{\rm (p.\,\pageref{classKParts_1_1HistoryProvider})} constructor \_\-before\_\- you do any khtml stuff. That way, khtml, using the self()-method, will use your subclassed provider.

\begin{Desc}
\item[Author:]Carsten Pfeiffer $<${\tt pfeiffer@kde.org}$>$ \end{Desc}




Definition at line 39 of file historyprovider.h.

\subsection{Constructor \& Destructor Documentation}
\index{KParts::HistoryProvider@{KParts::History\-Provider}!HistoryProvider@{HistoryProvider}}
\index{HistoryProvider@{HistoryProvider}!KParts::HistoryProvider@{KParts::History\-Provider}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KParts::History\-Provider::History\-Provider ({\bf QObject} $\ast$ {\em parent} = 0L, const char $\ast$ {\em name} = 0)}\label{classKParts_1_1HistoryProvider_a0}


Creates a KHistory\-Provider with an optional parent and name. 

\index{KParts::HistoryProvider@{KParts::History\-Provider}!~HistoryProvider@{$\sim$HistoryProvider}}
\index{~HistoryProvider@{$\sim$HistoryProvider}!KParts::HistoryProvider@{KParts::History\-Provider}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual KParts::History\-Provider::$\sim${\bf History\-Provider} ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKParts_1_1HistoryProvider_a1}


Destroys the provider. 



\subsection{Member Function Documentation}
\index{KParts::HistoryProvider@{KParts::History\-Provider}!contains@{contains}}
\index{contains@{contains}!KParts::HistoryProvider@{KParts::History\-Provider}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual bool KParts::History\-Provider::contains (const {\bf QString} \& {\em item}) const\hspace{0.3cm}{\tt  [virtual]}}\label{classKParts_1_1HistoryProvider_a2}


\begin{Desc}
\item[Returns:]true if {\tt item} is present in the history. \end{Desc}
\index{KParts::HistoryProvider@{KParts::History\-Provider}!insert@{insert}}
\index{insert@{insert}!KParts::HistoryProvider@{KParts::History\-Provider}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KParts::History\-Provider::insert (const {\bf QString} \& {\em item})\hspace{0.3cm}{\tt  [virtual]}}\label{classKParts_1_1HistoryProvider_a3}


Inserts {\tt item} into the history. 

\index{KParts::HistoryProvider@{KParts::History\-Provider}!remove@{remove}}
\index{remove@{remove}!KParts::HistoryProvider@{KParts::History\-Provider}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KParts::History\-Provider::remove (const {\bf QString} \& {\em item})\hspace{0.3cm}{\tt  [virtual]}}\label{classKParts_1_1HistoryProvider_a4}


Removes {\tt item} from the history. 

\index{KParts::HistoryProvider@{KParts::History\-Provider}!clear@{clear}}
\index{clear@{clear}!KParts::HistoryProvider@{KParts::History\-Provider}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KParts::History\-Provider::clear ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKParts_1_1HistoryProvider_a5}


Clears the history. 

The {\bf cleared}{\rm (p.\,\pageref{classKParts_1_1HistoryProvider_l0})}() signal is emitted after clearing. \index{KParts::HistoryProvider@{KParts::History\-Provider}!cleared@{cleared}}
\index{cleared@{cleared}!KParts::HistoryProvider@{KParts::History\-Provider}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KParts::History\-Provider::cleared ()\hspace{0.3cm}{\tt  [signal]}}\label{classKParts_1_1HistoryProvider_l0}


Emitted after the history has been cleared. 

\index{KParts::HistoryProvider@{KParts::History\-Provider}!updated@{updated}}
\index{updated@{updated}!KParts::HistoryProvider@{KParts::History\-Provider}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KParts::History\-Provider::updated (const {\bf QString\-List} \& {\em items})\hspace{0.3cm}{\tt  [signal]}}\label{classKParts_1_1HistoryProvider_l1}


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 {\tt items}. 

The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
historyprovider.h\end{CompactItemize}
