<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<title>kparts: KParts::HistoryProvider Class Reference (kparts)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<div id="nav_header_title" align="left">KDE API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../..">API Reference</a>
/ <a href=".">kparts</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<a name="content"></a>
<!-- Generated by Doxygen 1.7.4 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>KParts</b> </li>
<li class="navelem"><a class="el" href="classKParts_1_1HistoryProvider.html">HistoryProvider</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#signals">Signals</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<div class="title">KParts::HistoryProvider Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="KParts::HistoryProvider" --><!-- doxytag: inherits="QObject" -->
<p>Basic class to manage a history of "items".
<a href="classKParts_1_1HistoryProvider.html#details">More...</a></p>
<p><code>#include <<a class="el" href="historyprovider_8h_source.html">historyprovider.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for KParts::HistoryProvider:</div>
<div class="dyncontent">
<div class="center">
<img src="classKParts_1_1HistoryProvider.png" usemap="#KParts::HistoryProvider_map" alt=""/>
<map id="KParts::HistoryProvider_map" name="KParts::HistoryProvider_map">
<area href="qobject.html" alt="QObject" shape="rect" coords="0,0,144,24"/>
</map>
</div></div>
<p><a href="classKParts_1_1HistoryProvider-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="signals"></a>
Signals</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1HistoryProvider.html#ac1328e387f0adb62419ddfdd74b1839e">cleared</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1HistoryProvider.html#adf153d0a7a3efcdaba20a86e323e115f">updated</a> (const <a class="elRef" href="qstringlist.html">QStringList</a> &items)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1HistoryProvider.html#a24304e5276a1f113314eb7b4e464828f">inserted</a> (const <a class="elRef" href="qstring.html">QString</a> &item)</td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1HistoryProvider.html#a5c3753417c96feaeca9876f12ea0f7fe">HistoryProvider</a> (<a class="elRef" href="qobject.html">QObject</a> *<a class="elRef" href="qobject.html#parent">parent</a>=0L, const char *name=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1HistoryProvider.html#a4dda551811cf5beb59b459577aced662">~HistoryProvider</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1HistoryProvider.html#a498134270db3060ac032a8af6e5d5bef">contains</a> (const <a class="elRef" href="qstring.html">QString</a> &item) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1HistoryProvider.html#a02a9f183d6c9607f912c7047b39c6db1">insert</a> (const <a class="elRef" href="qstring.html">QString</a> &item)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1HistoryProvider.html#a385a1a584ea86c3680f4c4501a9665b8">remove</a> (const <a class="elRef" href="qstring.html">QString</a> &item)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1HistoryProvider.html#a9eb70389cbe1912435f4e97f56ed6943">clear</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af80fad416de3100cce6f16586398ee5d"></a><!-- doxytag: member="KParts::HistoryProvider::self" ref="af80fad416de3100cce6f16586398ee5d" args="()" -->
static <a class="el" href="classKParts_1_1HistoryProvider.html">HistoryProvider</a> * </td><td class="memItemRight" valign="bottom"><b>self</b> ()</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae818b668dea2b5a3526fb6e39e8970a4"></a><!-- doxytag: member="KParts::HistoryProvider::virtual_hook" ref="ae818b668dea2b5a3526fb6e39e8970a4" args="(int id, void *data)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>virtual_hook</b> (int id, void *data)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Basic class to manage a history of "items". </p>
<p>This class is only meant for fast lookup, if an item is in the history or not.</p>
<p>May be subclassed to implement a persistent history for example. For usage with khtml, just create your provider and call the <a class="el" href="classKParts_1_1HistoryProvider.html" title="Basic class to manage a history of "items".">HistoryProvider</a> constructor _before_ you do any khtml stuff. That way, khtml, using the self()-method, will use your subclassed provider.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>Carsten Pfeiffer <<a href="mailto:pfeiffer@kde.org">pfeiffer@kde.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="historyprovider_8h_source.html#l00041">41</a> of file <a class="el" href="historyprovider_8h_source.html">historyprovider.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5c3753417c96feaeca9876f12ea0f7fe"></a><!-- doxytag: member="KParts::HistoryProvider::HistoryProvider" ref="a5c3753417c96feaeca9876f12ea0f7fe" args="(QObject *parent=0L, const char *name=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">HistoryProvider::HistoryProvider </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="qobject.html">QObject</a> * </td>
<td class="paramname"><em>parent</em> = <code>0L</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a KHistoryProvider with an optional parent and name. </p>
<p>Definition at line <a class="el" href="historyprovider_8cpp_source.html#l00047">47</a> of file <a class="el" href="historyprovider_8cpp_source.html">historyprovider.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4dda551811cf5beb59b459577aced662"></a><!-- doxytag: member="KParts::HistoryProvider::~HistoryProvider" ref="a4dda551811cf5beb59b459577aced662" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">HistoryProvider::~HistoryProvider </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroys the provider. </p>
<p>Definition at line <a class="el" href="historyprovider_8cpp_source.html#l00056">56</a> of file <a class="el" href="historyprovider_8cpp_source.html">historyprovider.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a9eb70389cbe1912435f4e97f56ed6943"></a><!-- doxytag: member="KParts::HistoryProvider::clear" ref="a9eb70389cbe1912435f4e97f56ed6943" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HistoryProvider::clear </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clears the history. </p>
<p>The <a class="el" href="classKParts_1_1HistoryProvider.html#ac1328e387f0adb62419ddfdd74b1839e" title="Emitted after the history has been cleared.">cleared()</a> signal is emitted after clearing. </p>
<p>Definition at line <a class="el" href="historyprovider_8cpp_source.html#l00081">81</a> of file <a class="el" href="historyprovider_8cpp_source.html">historyprovider.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac1328e387f0adb62419ddfdd74b1839e"></a><!-- doxytag: member="KParts::HistoryProvider::cleared" ref="ac1328e387f0adb62419ddfdd74b1839e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KParts::HistoryProvider::cleared </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Emitted after the history has been cleared. </p>
</div>
</div>
<a class="anchor" id="a498134270db3060ac032a8af6e5d5bef"></a><!-- doxytag: member="KParts::HistoryProvider::contains" ref="a498134270db3060ac032a8af6e5d5bef" args="(const QString &item) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool HistoryProvider::contains </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>item</em></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>true if <code>item</code> is present in the history. </dd></dl>
<p>Definition at line <a class="el" href="historyprovider_8cpp_source.html#l00064">64</a> of file <a class="el" href="historyprovider_8cpp_source.html">historyprovider.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a02a9f183d6c9607f912c7047b39c6db1"></a><!-- doxytag: member="KParts::HistoryProvider::insert" ref="a02a9f183d6c9607f912c7047b39c6db1" args="(const QString &item)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HistoryProvider::insert </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>item</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Inserts <code>item</code> into the history. </p>
<p>Definition at line <a class="el" href="historyprovider_8cpp_source.html#l00069">69</a> of file <a class="el" href="historyprovider_8cpp_source.html">historyprovider.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a24304e5276a1f113314eb7b4e464828f"></a><!-- doxytag: member="KParts::HistoryProvider::inserted" ref="a24304e5276a1f113314eb7b4e464828f" args="(const QString &item)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KParts::HistoryProvider::inserted </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>item</em></td><td>)</td>
<td><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Emitted after the item has been inserted. </p>
</div>
</div>
<a class="anchor" id="a385a1a584ea86c3680f4c4501a9665b8"></a><!-- doxytag: member="KParts::HistoryProvider::remove" ref="a385a1a584ea86c3680f4c4501a9665b8" args="(const QString &item)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HistoryProvider::remove </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>item</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes <code>item</code> from the history. </p>
<p>Definition at line <a class="el" href="historyprovider_8cpp_source.html#l00076">76</a> of file <a class="el" href="historyprovider_8cpp_source.html">historyprovider.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="adf153d0a7a3efcdaba20a86e323e115f"></a><!-- doxytag: member="KParts::HistoryProvider::updated" ref="adf153d0a7a3efcdaba20a86e323e115f" args="(const QStringList &items)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KParts::HistoryProvider::updated </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstringlist.html">QStringList</a> & </td>
<td class="paramname"><em>items</em></td><td>)</td>
<td><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This signal is never emitted from this class, it is only meant as an interface for subclasses. </p>
<p>Emit this signal to notify others that the history has changed. Put those items that were added or removed from the history into <code>items</code>. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="historyprovider_8h_source.html">historyprovider.h</a></li>
<li><a class="el" href="historyprovider_8cpp_source.html">historyprovider.cpp</a></li>
</ul>
</div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>kparts</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="namespaces.html">Namespace List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="namespacemembers.html">Namespace Members</a></li><li><a href="functions.html">Class Members</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classKParts_1_1BrowserExtension.html">kparts::browserextension</option>, <option value="classKParts_1_1BrowserHostExtension.html">kparts::browserhostextension</option>, <option value="classKParts_1_1BrowserInterface.html">kparts::browserinterface</option>, <option value="classKParts_1_1BrowserRun.html">kparts::browserrun</option>, <option value="classKParts_1_1DockMainWindow.html">kparts::dockmainwindow</option>, <option value="classKParts_1_1Event.html">kparts::event</option>, <option value="classKParts_1_1Factory.html">kparts::factory</option>, <option value="classKParts_1_1GenericFactory.html">kparts::genericfactory</option>, <option value="classKParts_1_1GUIActivateEvent.html">kparts::guiactivateevent</option>, <option value="classKParts_1_1HistoryProvider.html">kparts::historyprovider</option>, <option value="classKParts_1_1LiveConnectExtension.html">kparts::liveconnectextension</option>, <option value="classKParts_1_1MainWindow.html">kparts::mainwindow</option>, <option value="classKParts_1_1OpenURLEvent.html">kparts::openurlevent</option>, <option value="classKParts_1_1Part.html">kparts::part</option>, <option value="classKParts_1_1PartActivateEvent.html">kparts::partactivateevent</option>, <option value="classKParts_1_1PartBase.html">kparts::partbase</option>, <option value="classKParts_1_1PartManager.html">kparts::partmanager</option>, <option value="classKParts_1_1PartSelectEvent.html">kparts::partselectevent</option>, <option value="classKParts_1_1Plugin.html">kparts::plugin</option>, <option value="classKParts_1_1ReadOnlyPart.html">kparts::readonlypart</option>, <option value="classKParts_1_1ReadWritePart.html">kparts::readwritepart</option>, <option value="classKParts_1_1StatusBarExtension.html">kparts::statusbarextension</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../arts/html/index.html">arts</a></li><li><a href="../../dcop/html/index.html">dcop</a></li><li><a href="../../dnssd/html/index.html">dnssd</a></li><li><a href="../../interfaces/html/index.html">interfaces</a></li><li> <a href="../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li> <a href="../../interfaces/kimproxy/library/html/index.html">library</a></li><li> <a href="../../interfaces/kspeech/html/index.html">kspeech</a></li><li> <a href="../../interfaces/ktexteditor/html/index.html">ktexteditor</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kate/html/index.html">kate</a></li><li><a href="../../kcmshell/html/index.html">kcmshell</a></li><li><a href="../../kdecore/html/index.html">kdecore</a></li><li><a href="../../kded/html/index.html">kded</a></li><li><a href="../../kdefx/html/index.html">kdefx</a></li><li><a href="../../kdeprint/html/index.html">kdeprint</a></li><li><a href="../../kdesu/html/index.html">kdesu</a></li><li><a href="../../kdeui/html/index.html">kdeui</a></li><li><a href="../../kdoctools/html/index.html">kdoctools</a></li><li><a href="../../khtml/html/index.html">khtml</a></li><li><a href="../../kimgio/html/index.html">kimgio</a></li><li><a href="../../kinit/html/index.html">kinit</a></li><li><a href="../../kio/html/index.html">kio</a></li><li> <a href="../../kio/bookmarks/html/index.html">bookmarks</a></li><li> <a href="../../kio/httpfilter/html/index.html">httpfilter</a></li><li> <a href="../../kio/kfile/html/index.html">kfile</a></li><li> <a href="../../kio/kio/html/index.html">kio</a></li><li> <a href="../../kio/kioexec/html/index.html">kioexec</a></li><li> <a href="../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li> <a href="../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/http/html/index.html">http</a></li><li><a href="../../kjs/html/index.html">kjs</a></li><li><a href="../../kmdi/html/index.html">kmdi</a></li><li> <a href="../../kmdi/kmdi/html/index.html">kmdi</a></li><li><a href="../../knewstuff/html/index.html">knewstuff</a></li><li><a href="../../kparts/html/index.html">kparts</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../kspell2/html/index.html">kspell2</a></li><li><a href="../../kunittest/html/index.html">kunittest</a></li><li><a href="../../kutils/html/index.html">kutils</a></li><li><a href="../../kwallet/html/index.html">kwallet</a></li><li><a href="../../libkmid/html/index.html">libkmid</a></li><li><a href="../../libkscreensaver/html/index.html">libkscreensaver</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
