<?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" xml:lang="en">
<head>
<title>Akonadi::AgentBase Class Reference</title>
<style type="text/css">
.cp-doNotDisplay { display: none; }
@media aural, braille, handheld, tty { .cp-doNotDisplay { display: inline; speak: normal; }}
.cp-edit { text-align: right; }
@media print, embossed { .cp-edit { display: none; }}
</style>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="meta" href="http://www.kde.org/labels.rdf" type="application/rdf+xml" title="ICRA labels" />
<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" />
<meta name="no-email-collection" content="http://www.unspam.com/noemailcollection" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link rel="shortcut icon" href="../../favicon.ico" /><link rel="icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../../kde.css" />
<link rel="stylesheet" media="print, embossed" type="text/css" href="../../print.css" />
<link rel="stylesheet" media="screen, aural, handheld, tty, braille" type="text/css" title="Flat" href="../../flat.css" />
<link rel="stylesheet" type="text/css" href="../../doxygen.css" />
<link rel="stylesheet" type="text/css" href="../../tabs.css" />
</head>
<body>
<ul class="cp-doNotDisplay">
<li><a href="#cp-content" accesskey="2">Skip to content</a></li>
<li><a href="#cp-menu" accesskey="5">Skip to link menu</a></li>
</ul>
<div id="container">
<div id="header">
<div id="header_top"><div><div>
<img alt ="" src="../../top-kde.jpg"/>
</div></div></div>
<div id="header_bottom">
<div id="location">
<ul>
<li><a href="http://api.kde.org">KDE API Reference</a></li>
<li><a href="../../index.html">kdepimlibs-4.10.5 API Reference</a></li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="http://www.kde.org/">KDE Home</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<!-- End page header -->
<div id="body_wrapper">
<div id="body">
<!-- begin main content -->
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h2><a name="content"></a>akonadi</h2>
<!-- BC -->
<div id="top">
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceAkonadi.html">Akonadi</a></li><li class="navelem"><a class="el" href="classAkonadi_1_1AgentBase.html">AgentBase</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-slots">Public Slots</a> |
<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> |
<a href="classAkonadi_1_1AgentBase-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Akonadi::AgentBase Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="agentbase_8h_source.html">agentbase.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Akonadi::AgentBase:</div>
<div class="dyncontent">
<div class="center">
<img src="classAkonadi_1_1AgentBase.png" usemap="#Akonadi::AgentBase_map" alt=""/>
<map id="Akonadi::AgentBase_map" name="Akonadi::AgentBase_map">
<area href="classAkonadi_1_1PreprocessorBase.html" title="The base class for all Akonadi preprocessor agents." alt="Akonadi::PreprocessorBase" shape="rect" coords="0,56,169,80"/>
<area href="classAkonadi_1_1ResourceBase.html" title="The base class for all Akonadi resources." alt="Akonadi::ResourceBase" shape="rect" coords="179,56,348,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase_1_1Observer.html">Observer</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase_1_1ObserverV2.html">ObserverV2</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aa382371cd5c61d6ebd5011c6e699c237"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#aa382371cd5c61d6ebd5011c6e699c237">Status</a> { <a class="el" href="classAkonadi_1_1AgentBase.html#aa382371cd5c61d6ebd5011c6e699c237afdf359ee3525c7c4ff7524a2c1081a62">Idle</a> = 0,
<a class="el" href="classAkonadi_1_1AgentBase.html#aa382371cd5c61d6ebd5011c6e699c237a06bbae3ba79df9d736aa258adf63034d">Running</a>,
<a class="el" href="classAkonadi_1_1AgentBase.html#aa382371cd5c61d6ebd5011c6e699c237a439d75ef57e46a1d5960a55737238b9f">Broken</a>,
<a class="el" href="classAkonadi_1_1AgentBase.html#aa382371cd5c61d6ebd5011c6e699c237a25c877cfd6ded3c25e13db6cae9277f1">NotConfigured</a>
}</td></tr>
<tr class="separator:aa382371cd5c61d6ebd5011c6e699c237"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-slots"></a>
Public Slots</h2></td></tr>
<tr class="memitem:a88a08911cd0a69934207ef1a154a23ba"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#a88a08911cd0a69934207ef1a154a23ba">configure</a> (WId windowId)</td></tr>
<tr class="separator:a88a08911cd0a69934207ef1a154a23ba"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="signals"></a>
Signals</h2></td></tr>
<tr class="memitem:ab0fc76bc5e62a07414188562ffd6138a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#ab0fc76bc5e62a07414188562ffd6138a">abortRequested</a> ()</td></tr>
<tr class="separator:ab0fc76bc5e62a07414188562ffd6138a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2fc735a14099b962ba33907b64cde9a0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#a2fc735a14099b962ba33907b64cde9a0">advancedStatus</a> (const QVariantMap &<a class="el" href="classAkonadi_1_1AgentBase.html#aa2bc2c0822f93f2c00f7a4a892afa2ad">status</a>)</td></tr>
<tr class="separator:a2fc735a14099b962ba33907b64cde9a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad9f7e5fcfe35602dfc030190ab11e310"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#ad9f7e5fcfe35602dfc030190ab11e310">agentNameChanged</a> (const QString &name)</td></tr>
<tr class="separator:ad9f7e5fcfe35602dfc030190ab11e310"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18929e704b4c1c0ec3582b8ded988204"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#a18929e704b4c1c0ec3582b8ded988204">configurationDialogAccepted</a> ()</td></tr>
<tr class="separator:a18929e704b4c1c0ec3582b8ded988204"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aecedf10c6cef62934a9cd4b0f4a0b178"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#aecedf10c6cef62934a9cd4b0f4a0b178">configurationDialogRejected</a> ()</td></tr>
<tr class="separator:aecedf10c6cef62934a9cd4b0f4a0b178"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae1b46d3b422b032db44ebb2770e46e82"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#ae1b46d3b422b032db44ebb2770e46e82">error</a> (const QString &message)</td></tr>
<tr class="separator:ae1b46d3b422b032db44ebb2770e46e82"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a43efaaf7e5888aa83ae0d396e2e3b73f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#a43efaaf7e5888aa83ae0d396e2e3b73f">onlineChanged</a> (bool online)</td></tr>
<tr class="separator:a43efaaf7e5888aa83ae0d396e2e3b73f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaf7949e7deac2b69a64b6e71c199a155"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#aaf7949e7deac2b69a64b6e71c199a155">percent</a> (int <a class="el" href="classAkonadi_1_1AgentBase.html#a6b90f7092b2da5963777bbecee6df8ea">progress</a>)</td></tr>
<tr class="separator:aaf7949e7deac2b69a64b6e71c199a155"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4cf347bc93ed2ee2a104b79d7f748964"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#a4cf347bc93ed2ee2a104b79d7f748964">reloadConfiguration</a> ()</td></tr>
<tr class="separator:a4cf347bc93ed2ee2a104b79d7f748964"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9e9eee087d5f7a4e1020f9bfd1317776"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#a9e9eee087d5f7a4e1020f9bfd1317776">status</a> (int status, const QString &message=QString())</td></tr>
<tr class="separator:a9e9eee087d5f7a4e1020f9bfd1317776"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a072173432d3fb111e03da88ba5f529ae"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#a072173432d3fb111e03da88ba5f529ae">warning</a> (const QString &message)</td></tr>
<tr class="separator:a072173432d3fb111e03da88ba5f529ae"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a604aa61e4c8e9296b2178fd671ce3122"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#a604aa61e4c8e9296b2178fd671ce3122">agentName</a> () const </td></tr>
<tr class="separator:a604aa61e4c8e9296b2178fd671ce3122"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4c75000ad277f6f0c11e9f634c191e52"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#a4c75000ad277f6f0c11e9f634c191e52">cleanup</a> ()</td></tr>
<tr class="separator:a4c75000ad277f6f0c11e9f634c191e52"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af784bb2cca984e18250236c326c3ef44"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#af784bb2cca984e18250236c326c3ef44">identifier</a> () const </td></tr>
<tr class="separator:af784bb2cca984e18250236c326c3ef44"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b90f7092b2da5963777bbecee6df8ea"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#a6b90f7092b2da5963777bbecee6df8ea">progress</a> () const </td></tr>
<tr class="separator:a6b90f7092b2da5963777bbecee6df8ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a92b92657f34a8d8c44e497f8e5f756ac"><td class="memItemLeft" align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#a92b92657f34a8d8c44e497f8e5f756ac">progressMessage</a> () const </td></tr>
<tr class="separator:a92b92657f34a8d8c44e497f8e5f756ac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af4e832c050543543cfeecac390009131"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#af4e832c050543543cfeecac390009131">registerObserver</a> (<a class="el" href="classAkonadi_1_1AgentBase_1_1Observer.html">Observer</a> *observer)</td></tr>
<tr class="separator:af4e832c050543543cfeecac390009131"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a79fd14b5b5a8822c6b3c8deb0bd76075"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#a79fd14b5b5a8822c6b3c8deb0bd76075">setAgentName</a> (const QString &name)</td></tr>
<tr class="separator:a79fd14b5b5a8822c6b3c8deb0bd76075"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa2bc2c0822f93f2c00f7a4a892afa2ad"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#aa2bc2c0822f93f2c00f7a4a892afa2ad">status</a> () const </td></tr>
<tr class="separator:aa2bc2c0822f93f2c00f7a4a892afa2ad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abbd6cd366385910e5146c5a8d2e70dd0"><td class="memItemLeft" align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#abbd6cd366385910e5146c5a8d2e70dd0">statusMessage</a> () const </td></tr>
<tr class="separator:abbd6cd366385910e5146c5a8d2e70dd0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a378a1e6277f8a3c230f17064ec7e576b"><td class="memItemLeft" align="right" valign="top">WId </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#a378a1e6277f8a3c230f17064ec7e576b">winIdForDialogs</a> () const </td></tr>
<tr class="separator:a378a1e6277f8a3c230f17064ec7e576b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a4f0394eb585f3b6718942be6e39c148c"><td class="memItemLeft" align="right" valign="top">static KComponentData </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#a4f0394eb585f3b6718942be6e39c148c">componentData</a> ()</td></tr>
<tr class="separator:a4f0394eb585f3b6718942be6e39c148c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad406b695edf920e2be625ad77ad7a146"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr class="memitem:ad406b695edf920e2be625ad77ad7a146"><td class="memTemplItemLeft" align="right" valign="top">static int </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#ad406b695edf920e2be625ad77ad7a146">init</a> (int argc, char **argv)</td></tr>
<tr class="separator:ad406b695edf920e2be625ad77ad7a146"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:aee3bc923ee5e81b5bde9497f1c6701e4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#aee3bc923ee5e81b5bde9497f1c6701e4">AgentBase</a> (const QString &id)</td></tr>
<tr class="separator:aee3bc923ee5e81b5bde9497f1c6701e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a10fe376bfb40b080585c6897741a8e9a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#a10fe376bfb40b080585c6897741a8e9a">~AgentBase</a> ()</td></tr>
<tr class="separator:a10fe376bfb40b080585c6897741a8e9a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a879807e4784e47c81b2a2d83d7d368a2"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#a879807e4784e47c81b2a2d83d7d368a2">aboutToQuit</a> ()</td></tr>
<tr class="separator:a879807e4784e47c81b2a2d83d7d368a2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0989731bb6a79974b0ed0fe4694d64a3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#a0989731bb6a79974b0ed0fe4694d64a3">changeProcessed</a> ()</td></tr>
<tr class="separator:a0989731bb6a79974b0ed0fe4694d64a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a16560007472553312ba43bc458460395"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classAkonadi_1_1ChangeRecorder.html">ChangeRecorder</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#a16560007472553312ba43bc458460395">changeRecorder</a> () const </td></tr>
<tr class="separator:a16560007472553312ba43bc458460395"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a487209edfa15db132d700945ef21b818"><td class="memItemLeft" align="right" valign="top">KSharedConfigPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#a487209edfa15db132d700945ef21b818">config</a> ()</td></tr>
<tr class="separator:a487209edfa15db132d700945ef21b818"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a13819438ee499c3389ffd7978ceee79a"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#a13819438ee499c3389ffd7978ceee79a">doSetOnline</a> (bool online)</td></tr>
<tr class="separator:a13819438ee499c3389ffd7978ceee79a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab8f7642c638be7425bfb558d940e2fe2"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#ab8f7642c638be7425bfb558d940e2fe2">isOnline</a> () const </td></tr>
<tr class="separator:ab8f7642c638be7425bfb558d940e2fe2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3026e3a1ac5eaa829082cddbb026b36a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#a3026e3a1ac5eaa829082cddbb026b36a">setNeedsNetwork</a> (bool needsNetwork)</td></tr>
<tr class="separator:a3026e3a1ac5eaa829082cddbb026b36a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc3c939b844960239b92667614ca158b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1AgentBase.html#adc3c939b844960239b92667614ca158b">setOnline</a> (bool state)</td></tr>
<tr class="separator:adc3c939b844960239b92667614ca158b"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The base class for all <a class="el" href="namespaceAkonadi.html" title="FreeBusyManager::Singleton.">Akonadi</a> agents and resources. </p>
<p>This class is a base class for all <a class="el" href="namespaceAkonadi.html" title="FreeBusyManager::Singleton.">Akonadi</a> agents, which covers the real agent processes and all resources.</p>
<p>It provides:</p>
<ul>
<li>lifetime management</li>
<li>change monitoring and recording</li>
<li>configuration interface</li>
<li>problem reporting</li>
</ul>
<p><a class="el" href="namespaceAkonadi.html" title="FreeBusyManager::Singleton.">Akonadi</a> Server supports several ways to launch agents and resources:</p>
<ul>
<li>As a separate application (<dl class="section see"><dt>See Also</dt><dd>AKONADI_AGENT_MAIN)</dd></dl>
</li>
<li>As a thread in the AgentServer</li>
<li>As a separate process, using the akonadi_agent_launcher</li>
</ul>
<p>The idea is this, the agent or resource is written as a plugin instead of an executable (</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classAkonadi_1_1AgentFactory.html" title="A factory for in-process agents.">AgentFactory</a>). In the AgentServer case, the AgentServer looks up the plugin and launches the agent in a separate thread. In the launcher case, a new akonadi_agent_launcher process is started for each agent or resource instance.</dd></dl>
<p>When making an Agent or Resource suitable for running in the AgentServer some extra caution is needed. Because multiple instances of several kinds of agents run in the same process, one cannot blindly use global objects like KGlobal. For this reasons several methods where added to avoid problems in this context, most notably <a class="el" href="classAkonadi_1_1AgentBase.html#a487209edfa15db132d700945ef21b818" title="Returns the config object for this Agent.">AgentBase::config()</a> and <a class="el" href="classAkonadi_1_1AgentBase.html#a4f0394eb585f3b6718942be6e39c148c" title="Returns the component data object for this agent instance.">AgentBase::componentData()</a>. Additionally, one cannot use QDBusConnection::sessionBus() with dbus < 1.4, because of a multithreading bug in libdbus. Instead one should use DBusConnectionPool::threadConnection() which works around this problem.</p>
<dl class="section author"><dt>Author</dt><dd>Till Adam <a href="#" onclick="location.href='mai'+'lto:'+'ada'+'m@'+'kde'+'.o'+'rg'; return false;">adam@<span style="display: none;">.nosp@m.</span>kde.<span style="display: none;">.nosp@m.</span>org</a>, Volker Krause <a href="#" onclick="location.href='mai'+'lto:'+'vkr'+'au'+'se@'+'kd'+'e.o'+'rg'; return false;">vkrau<span style="display: none;">.nosp@m.</span>se@k<span style="display: none;">.nosp@m.</span>de.or<span style="display: none;">.nosp@m.</span>g</a> </dd></dl>
<p>Definition at line <a class="el" href="agentbase_8h_source.html#l00079">79</a> of file <a class="el" href="agentbase_8h_source.html">agentbase.h</a>.</p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="aa382371cd5c61d6ebd5011c6e699c237"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classAkonadi_1_1AgentBase.html#aa382371cd5c61d6ebd5011c6e699c237">Akonadi::AgentBase::Status</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>This enum describes the different states the agent can be in. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="aa382371cd5c61d6ebd5011c6e699c237afdf359ee3525c7c4ff7524a2c1081a62"></a>Idle</em> </td><td class="fielddoc">
<p>The agent does currently nothing. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="aa382371cd5c61d6ebd5011c6e699c237a06bbae3ba79df9d736aa258adf63034d"></a>Running</em> </td><td class="fielddoc">
<p>The agent is working on something. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="aa382371cd5c61d6ebd5011c6e699c237a439d75ef57e46a1d5960a55737238b9f"></a>Broken</em> </td><td class="fielddoc">
<p>The agent encountered an error state. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="aa382371cd5c61d6ebd5011c6e699c237a25c877cfd6ded3c25e13db6cae9277f1"></a>NotConfigured</em> </td><td class="fielddoc">
<p>The agent is lacking required configuration. </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="agentbase_8h_source.html#l00302">302</a> of file <a class="el" href="agentbase_8h_source.html">agentbase.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="aee3bc923ee5e81b5bde9497f1c6701e4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Akonadi::AgentBase::AgentBase </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an agent base. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>The instance id of the agent. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a10fe376bfb40b080585c6897741a8e9a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Akonadi::AgentBase::~AgentBase </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroys the agent base. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ab0fc76bc5e62a07414188562ffd6138a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Akonadi::AgentBase::abortRequested </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">signal</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Emitted when another application has remotely asked the agent to abort its current operation. </p>
<p>Connect to this signal if your agent supports abortion. After aborting and cleaning up, agents should return to Idle status.</p>
<dl class="section since"><dt>Since</dt><dd>4.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a879807e4784e47c81b2a2d83d7d368a2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void AgentBase::aboutToQuit </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method is called whenever the agent application is about to quit. </p>
<p>Reimplement this method to do session cleanup (e.g. disconnecting from groupware server). </p>
<p>Definition at line <a class="el" href="agentbase_8cpp_source.html#l00714">714</a> of file <a class="el" href="agentbase_8cpp_source.html">agentbase.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a2fc735a14099b962ba33907b64cde9a0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Akonadi::AgentBase::advancedStatus </td>
<td>(</td>
<td class="paramtype">const QVariantMap & </td>
<td class="paramname"><em>status</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">signal</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This signal should be emitted whenever the status of the agent has been changed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>The object that describes the status change.</td></tr>
</table>
</dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>4.6 </dd></dl>
</div>
</div>
<a class="anchor" id="a604aa61e4c8e9296b2178fd671ce3122"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString AgentBase::agentName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the name of the agent. </p>
<dl class="section since"><dt>Since</dt><dd>4.3 </dd></dl>
<p>Definition at line <a class="el" href="agentbase_8cpp_source.html#l00789">789</a> of file <a class="el" href="agentbase_8cpp_source.html">agentbase.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad9f7e5fcfe35602dfc030190ab11e310"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Akonadi::AgentBase::agentNameChanged </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">signal</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This signal is emitted whenever the name of the agent has changed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The new name of the agent.</td></tr>
</table>
</dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>4.3 </dd></dl>
</div>
</div>
<a class="anchor" id="a0989731bb6a79974b0ed0fe4694d64a3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void AgentBase::changeProcessed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Marks the current change as processes and replays the next change if change recording is enabled (noop otherwise). </p>
<p>This method is called from the default implementation of the change notification slots. While not required when not using change recording, it is nevertheless recommended to call this method when done with processing a change notification. </p>
<p>Definition at line <a class="el" href="agentbase_8cpp_source.html#l00799">799</a> of file <a class="el" href="agentbase_8cpp_source.html">agentbase.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a16560007472553312ba43bc458460395"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classAkonadi_1_1ChangeRecorder.html">ChangeRecorder</a> * AgentBase::changeRecorder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the <a class="el" href="classAkonadi_1_1ChangeRecorder.html" title="Records and replays change notification.">Akonadi::ChangeRecorder</a> object used for monitoring. </p>
<p>Use this to configure which parts you want to monitor. </p>
<p>Definition at line <a class="el" href="agentbase_8cpp_source.html#l00805">805</a> of file <a class="el" href="agentbase_8cpp_source.html">agentbase.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4c75000ad277f6f0c11e9f634c191e52"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void AgentBase::cleanup </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method is called when the agent is removed from the system, so it can do some cleanup stuff. </p>
<dl class="section note"><dt>Note</dt><dd>If you reimplement this in a subclass make sure to call this base implementation at the end. </dd></dl>
<p>Definition at line <a class="el" href="agentbase_8cpp_source.html#l00718">718</a> of file <a class="el" href="agentbase_8cpp_source.html">agentbase.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4f0394eb585f3b6718942be6e39c148c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">KComponentData AgentBase::componentData </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the component data object for this agent instance. </p>
<p>In case of stand-alone agents this is identical to KGlobal::mainComponent(). In case of in-process agents there is one component data object per agent instance thread. This method provides valid results even when called in the agent ctor. </p>
<dl class="section since"><dt>Since</dt><dd>4.6 </dd></dl>
<p>Definition at line <a class="el" href="agentbase_8cpp_source.html#l00831">831</a> of file <a class="el" href="agentbase_8cpp_source.html">agentbase.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a487209edfa15db132d700945ef21b818"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">KSharedConfigPtr AgentBase::config </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the config object for this Agent. </p>
<p>Definition at line <a class="el" href="agentbase_8cpp_source.html#l00810">810</a> of file <a class="el" href="agentbase_8cpp_source.html">agentbase.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a18929e704b4c1c0ec3582b8ded988204"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Akonadi::AgentBase::configurationDialogAccepted </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">signal</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This signal is emitted whenever the user has accepted the configuration dialog. </p>
<dl class="section note"><dt>Note</dt><dd>Implementors of agents/resources are responsible to emit this signal if the agent/resource reimplements <a class="el" href="classAkonadi_1_1AgentBase.html#a88a08911cd0a69934207ef1a154a23ba" title="This method is called whenever the agent shall show its configuration dialog to the user...">configure()</a>.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>4.4 </dd></dl>
</div>
</div>
<a class="anchor" id="aecedf10c6cef62934a9cd4b0f4a0b178"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Akonadi::AgentBase::configurationDialogRejected </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">signal</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This signal is emitted whenever the user has rejected the configuration dialog. </p>
<dl class="section note"><dt>Note</dt><dd>Implementors of agents/resources are responsible to emit this signal if the agent/resource reimplements <a class="el" href="classAkonadi_1_1AgentBase.html#a88a08911cd0a69934207ef1a154a23ba" title="This method is called whenever the agent shall show its configuration dialog to the user...">configure()</a>.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>4.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a88a08911cd0a69934207ef1a154a23ba"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void AgentBase::configure </td>
<td>(</td>
<td class="paramtype">WId </td>
<td class="paramname"><em>windowId</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">slot</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method is called whenever the agent shall show its configuration dialog to the user. </p>
<p>It will be automatically called when the agent is started for the first time.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">windowId</td><td>The parent window id.</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>If the method is reimplemented it has to emit the <a class="el" href="classAkonadi_1_1AgentBase.html#a18929e704b4c1c0ec3582b8ded988204" title="This signal is emitted whenever the user has accepted the configuration dialog.">configurationDialogAccepted()</a> or <a class="el" href="classAkonadi_1_1AgentBase.html#aecedf10c6cef62934a9cd4b0f4a0b178" title="This signal is emitted whenever the user has rejected the configuration dialog.">configurationDialogRejected()</a> signals depending on the users choice. </dd></dl>
<p>Definition at line <a class="el" href="agentbase_8cpp_source.html#l00668">668</a> of file <a class="el" href="agentbase_8cpp_source.html">agentbase.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a13819438ee499c3389ffd7978ceee79a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void AgentBase::doSetOnline </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>online</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method is called whenever the <code>online</code> status has changed. </p>
<p>Reimplement this method to react on online status changes. </p>
<p>Reimplemented in <a class="el" href="classAkonadi_1_1ResourceBase.html#a42c9d9ae9ff4b11e6a2874dd80107c11">Akonadi::ResourceBase</a>.</p>
<p>Definition at line <a class="el" href="agentbase_8cpp_source.html#l00663">663</a> of file <a class="el" href="agentbase_8cpp_source.html">agentbase.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae1b46d3b422b032db44ebb2770e46e82"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Akonadi::AgentBase::error </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>message</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">signal</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This signal shall be used to report errors. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">message</td><td>The i18n'ed error message. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af784bb2cca984e18250236c326c3ef44"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString AgentBase::identifier </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the instance identifier of this agent. </p>
<p>Definition at line <a class="el" href="agentbase_8cpp_source.html#l00761">761</a> of file <a class="el" href="agentbase_8cpp_source.html">agentbase.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad406b695edf920e2be625ad77ad7a146"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int AgentBase::init </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>argv</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Use this method in the main function of your agent application to initialize your agent subclass. </p>
<p>This method also takes care of creating a KApplication object and parsing command line arguments.</p>
<dl class="section note"><dt>Note</dt><dd>In case the given class is also derived from <a class="el" href="classAkonadi_1_1AgentBase_1_1Observer.html" title="The interface for reacting on monitored or replayed changes.">AgentBase::Observer</a> it gets registered as its own observer (see <a class="el" href="classAkonadi_1_1AgentBase_1_1Observer.html" title="The interface for reacting on monitored or replayed changes.">AgentBase::Observer</a>), e.g. <code>agentInstance->registerObserver( agentInstance );</code></dd></dl>
<div class="fragment"><div class="line"><span class="keyword">class </span>MyAgent : <span class="keyword">public</span> <a class="code" href="classAkonadi_1_1AgentBase.html#aee3bc923ee5e81b5bde9497f1c6701e4" title="Creates an agent base.">AgentBase</a></div>
<div class="line">{</div>
<div class="line"> ...</div>
<div class="line">};</div>
<div class="line"></div>
<div class="line">AKONADI_AGENT_MAIN( MyAgent )</div>
</div><!-- fragment -->
<p>Definition at line <a class="el" href="agentbase_8h_source.html#l00331">331</a> of file <a class="el" href="agentbase_8h_source.html">agentbase.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab8f7642c638be7425bfb558d940e2fe2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool AgentBase::isOnline </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns whether the agent is currently online. </p>
<p>Definition at line <a class="el" href="agentbase_8cpp_source.html#l00617">617</a> of file <a class="el" href="agentbase_8cpp_source.html">agentbase.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a43efaaf7e5888aa83ae0d396e2e3b73f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Akonadi::AgentBase::onlineChanged </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>online</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">signal</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Emitted when the online state changed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">online</td><td>The online state. </td></tr>
</table>
</dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="aaf7949e7deac2b69a64b6e71c199a155"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Akonadi::AgentBase::percent </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>progress</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">signal</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This signal should be emitted whenever the progress of an action in the agent (e.g. </p>
<p>data transfer, connection establishment to remote server etc.) has changed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">progress</td><td>The progress of the action in percent. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6b90f7092b2da5963777bbecee6df8ea"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int AgentBase::progress </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method returns the current progress of the agent in percentage. </p>
<p>Definition at line <a class="el" href="agentbase_8cpp_source.html#l00603">603</a> of file <a class="el" href="agentbase_8cpp_source.html">agentbase.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a92b92657f34a8d8c44e497f8e5f756ac"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QString AgentBase::progressMessage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method returns an i18n'ed description of the current progress. </p>
<p>Definition at line <a class="el" href="agentbase_8cpp_source.html#l00610">610</a> of file <a class="el" href="agentbase_8cpp_source.html">agentbase.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af4e832c050543543cfeecac390009131"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AgentBase::registerObserver </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classAkonadi_1_1AgentBase_1_1Observer.html">Observer</a> * </td>
<td class="paramname"><em>observer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers the given observer for reacting on monitored or recorded changes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">observer</td><td>The change handler to register. No ownership transfer, i.e. the caller stays owner of the pointer and can reset the registration by calling this method with <code>0</code> </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="agentbase_8cpp_source.html#l00755">755</a> of file <a class="el" href="agentbase_8cpp_source.html">agentbase.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4cf347bc93ed2ee2a104b79d7f748964"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Akonadi::AgentBase::reloadConfiguration </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">signal</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Emitted if another application has changed the agent's configuration remotely and called <a class="el" href="classAkonadi_1_1AgentInstance.html#ab06083071c55547dac249c90a7066043" title="Tell the agent that its configuration has been changed remotely via D-Bus.">AgentInstance::reconfigure()</a>. </p>
<dl class="section since"><dt>Since</dt><dd>4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a79fd14b5b5a8822c6b3c8deb0bd76075"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AgentBase::setAgentName </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This method is used to set the name of the agent. </p>
<dl class="section since"><dt>Since</dt><dd>4.3 </dd></dl>
<p>Definition at line <a class="el" href="agentbase_8cpp_source.html#l00766">766</a> of file <a class="el" href="agentbase_8cpp_source.html">agentbase.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3026e3a1ac5eaa829082cddbb026b36a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void AgentBase::setNeedsNetwork </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>needsNetwork</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets whether the agent needs network or not. </p>
<dl class="section since"><dt>Since</dt><dd>4.2 </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>use this in combination with Solid::Networking::Notifier to change the onLine status of the agent. </dd></dl>
<p>Definition at line <a class="el" href="agentbase_8cpp_source.html#l00624">624</a> of file <a class="el" href="agentbase_8cpp_source.html">agentbase.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="adc3c939b844960239b92667614ca158b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void AgentBase::setOnline </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>state</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets whether the agent shall be online or not. </p>
<p>Definition at line <a class="el" href="agentbase_8cpp_source.html#l00641">641</a> of file <a class="el" href="agentbase_8cpp_source.html">agentbase.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa2bc2c0822f93f2c00f7a4a892afa2ad"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int AgentBase::status </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method returns the current status code of the agent. </p>
<p>The following return values are possible:</p>
<ul>
<li>0 - Idle</li>
<li>1 - Running</li>
<li>2 - Broken</li>
<li>3 - NotConfigured </li>
</ul>
<p>Definition at line <a class="el" href="agentbase_8cpp_source.html#l00589">589</a> of file <a class="el" href="agentbase_8cpp_source.html">agentbase.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9e9eee087d5f7a4e1020f9bfd1317776"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Akonadi::AgentBase::status </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>status</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>message</em> = <code>QString()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">signal</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This signal should be emitted whenever the status of the agent has been changed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>The new Status code. </td></tr>
<tr><td class="paramname">message</td><td>A i18n'ed description of the new status. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="abbd6cd366385910e5146c5a8d2e70dd0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QString AgentBase::statusMessage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method returns an i18n'ed description of the current status code. </p>
<p>Definition at line <a class="el" href="agentbase_8cpp_source.html#l00596">596</a> of file <a class="el" href="agentbase_8cpp_source.html">agentbase.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a072173432d3fb111e03da88ba5f529ae"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Akonadi::AgentBase::warning </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>message</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">signal</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This signal shall be used to report warnings. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">message</td><td>The i18n'ed warning message. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a378a1e6277f8a3c230f17064ec7e576b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">WId AgentBase::winIdForDialogs </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>This method returns the windows id, which should be used for dialogs. </p>
<p>Definition at line <a class="el" href="agentbase_8cpp_source.html#l00681">681</a> of file <a class="el" href="agentbase_8cpp_source.html">agentbase.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="agentbase_8h_source.html">agentbase.h</a></li>
<li><a class="el" href="agentbase_8cpp_source.html">agentbase.cpp</a></li>
</ul>
</div><!-- contents -->
<div class="copyrights">
This file is part of the KDE documentation.<br/>
Documentation copyright © 1996-2013 The KDE developers.<br/>
Generated on Fri Jul 12 2013 16:49:00 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.3.1 written
by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, © 1997-2006
<p>
KDE's <a href="http://techbase.kde.org/Policies/Library_Documentation_Policy">Doxygen guidelines</a> are available online.
</p>
</div>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">akonadi</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "akonadi"</a>
</div></div>
<ul><li><a href="index.html">Main Page</a></li><li><a href="namespaces.html">Namespace List</a></li><li><a href="namespacemembers.html">Namespace Members</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="functions.html">Class Members</a></li><li><a href="files.html">File List</a></li><li><a href="modules.html">Modules</a></li><li><a href="pages.html">Related Pages</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="classAddressEditDialog.html">addresseditdialog</option>, <option value="classAddressEditWidget.html">addresseditwidget</option>, <option value="classAddressSelectionWidget.html">addressselectionwidget</option>, <option value="classAddressTypeCombo.html">addresstypecombo</option>, <option value="classAkonadi_1_1AbstractContactFormatter.html">akonadi::abstractcontactformatter</option>, <option value="classAkonadi_1_1AbstractContactGroupFormatter.html">akonadi::abstractcontactgroupformatter</option>, <option value="classAkonadi_1_1AbstractDifferencesReporter.html">akonadi::abstractdifferencesreporter</option>, <option value="classAkonadi_1_1ActionStateManager.html">akonadi::actionstatemanager</option>, <option value="classAkonadi_1_1AddressAttribute.html">akonadi::addressattribute</option>, <option value="classAkonadi_1_1AgentActionManager.html">akonadi::agentactionmanager</option>, <option value="classAkonadi_1_1AgentBase.html">akonadi::agentbase</option>, <option value="classAkonadi_1_1AgentBase_1_1Observer.html">akonadi::agentbase::observer</option>, <option value="classAkonadi_1_1AgentBase_1_1ObserverV2.html">akonadi::agentbase::observerv2</option>, <option value="classAkonadi_1_1AgentBasePrivate.html">akonadi::agentbaseprivate</option>, <option value="classAkonadi_1_1AgentFactory.html">akonadi::agentfactory</option>, <option value="classAkonadi_1_1AgentFactoryBase.html">akonadi::agentfactorybase</option>, <option value="classAkonadi_1_1AgentFilterProxyModel.html">akonadi::agentfilterproxymodel</option>, <option value="classAkonadi_1_1AgentInstance.html">akonadi::agentinstance</option>, <option value="classAkonadi_1_1AgentInstance_1_1Private.html">akonadi::agentinstance::private</option>, <option value="classAkonadi_1_1AgentInstanceCreateJob.html">akonadi::agentinstancecreatejob</option>, <option value="classAkonadi_1_1AgentInstanceModel.html">akonadi::agentinstancemodel</option>, <option value="classAkonadi_1_1AgentInstanceWidget.html">akonadi::agentinstancewidget</option>, <option value="classAkonadi_1_1AgentManager.html">akonadi::agentmanager</option>, <option value="classAkonadi_1_1AgentManagerPrivate.html">akonadi::agentmanagerprivate</option>, <option value="classAkonadi_1_1AgentSearchInterface.html">akonadi::agentsearchinterface</option>, <option value="classAkonadi_1_1AgentType.html">akonadi::agenttype</option>, <option value="classAkonadi_1_1AgentType_1_1Private.html">akonadi::agenttype::private</option>, <option value="classAkonadi_1_1AgentTypeDialog.html">akonadi::agenttypedialog</option>, <option value="classAkonadi_1_1AgentTypeModel.html">akonadi::agenttypemodel</option>, <option value="classAkonadi_1_1AgentTypeWidget.html">akonadi::agenttypewidget</option>, <option value="classAkonadi_1_1AsyncSelectionHandler.html">akonadi::asyncselectionhandler</option>, <option value="classAkonadi_1_1Attribute.html">akonadi::attribute</option>, <option value="classAkonadi_1_1AttributeFactory.html">akonadi::attributefactory</option>, <option value="classAkonadi_1_1BlockAlarmsAttribute.html">akonadi::blockalarmsattribute</option>, <option value="classAkonadi_1_1CachePolicy.html">akonadi::cachepolicy</option>, <option value="classAkonadi_1_1CachePolicyPage.html">akonadi::cachepolicypage</option>, <option value="classAkonadi_1_1CalendarBase.html">akonadi::calendarbase</option>, <option value="classAkonadi_1_1ChangeNotificationDependenciesFactory.html">akonadi::changenotificationdependenciesfactory</option>, <option value="classAkonadi_1_1ChangeRecorder.html">akonadi::changerecorder</option>, <option value="classAkonadi_1_1Collection.html">akonadi::collection</option>, <option value="classAkonadi_1_1CollectionAttributesSynchronizationJob.html">akonadi::collectionattributessynchronizationjob</option>, <option value="classAkonadi_1_1CollectionComboBox.html">akonadi::collectioncombobox</option>, <option value="classAkonadi_1_1CollectionCopyJob.html">akonadi::collectioncopyjob</option>, <option value="classAkonadi_1_1CollectionCreateJob.html">akonadi::collectioncreatejob</option>, <option value="classAkonadi_1_1CollectionDeleteJob.html">akonadi::collectiondeletejob</option>, <option value="classAkonadi_1_1CollectionDialog.html">akonadi::collectiondialog</option>, <option value="classAkonadi_1_1CollectionFetchJob.html">akonadi::collectionfetchjob</option>, <option value="classAkonadi_1_1CollectionFetchScope.html">akonadi::collectionfetchscope</option>, <option value="classAkonadi_1_1CollectionFilterProxyModel.html">akonadi::collectionfilterproxymodel</option>, <option value="classAkonadi_1_1CollectionModel.html">akonadi::collectionmodel</option>, <option value="classAkonadi_1_1CollectionModelPrivate.html">akonadi::collectionmodelprivate</option>, <option value="classAkonadi_1_1CollectionModifyJob.html">akonadi::collectionmodifyjob</option>, <option value="classAkonadi_1_1CollectionMoveJob.html">akonadi::collectionmovejob</option>, <option value="classAkonadi_1_1CollectionPathResolver.html">akonadi::collectionpathresolver</option>, <option value="classAkonadi_1_1CollectionPrivate.html">akonadi::collectionprivate</option>, <option value="classAkonadi_1_1CollectionPropertiesDialog.html">akonadi::collectionpropertiesdialog</option>, <option value="classAkonadi_1_1CollectionPropertiesPage.html">akonadi::collectionpropertiespage</option>, <option value="classAkonadi_1_1CollectionPropertiesPageFactory.html">akonadi::collectionpropertiespagefactory</option>, <option value="classAkonadi_1_1CollectionQuotaAttribute.html">akonadi::collectionquotaattribute</option>, <option value="classAkonadi_1_1CollectionRequester.html">akonadi::collectionrequester</option>, <option value="classAkonadi_1_1CollectionRightsAttribute.html">akonadi::collectionrightsattribute</option>, <option value="classAkonadi_1_1CollectionSelectJob.html">akonadi::collectionselectjob</option>, <option value="classAkonadi_1_1CollectionStatistics.html">akonadi::collectionstatistics</option>, <option value="classAkonadi_1_1CollectionStatisticsDelegate.html">akonadi::collectionstatisticsdelegate</option>, <option value="classAkonadi_1_1CollectionStatisticsJob.html">akonadi::collectionstatisticsjob</option>, <option value="classAkonadi_1_1CollectionStatisticsModel.html">akonadi::collectionstatisticsmodel</option>, <option value="classAkonadi_1_1CollectionSync.html">akonadi::collectionsync</option>, <option value="classAkonadi_1_1CollectionView.html">akonadi::collectionview</option>, <option value="classAkonadi_1_1ConflictHandler.html">akonadi::conflicthandler</option>, <option value="classAkonadi_1_1ConflictResolveDialog.html">akonadi::conflictresolvedialog</option>, <option value="classAkonadi_1_1ContactDefaultActions.html">akonadi::contactdefaultactions</option>, <option value="classAkonadi_1_1ContactEditor.html">akonadi::contacteditor</option>, <option value="classAkonadi_1_1ContactEditorDialog.html">akonadi::contacteditordialog</option>, <option value="classAkonadi_1_1ContactEditorPagePlugin.html">akonadi::contacteditorpageplugin</option>, <option value="classAkonadi_1_1ContactGroupEditor.html">akonadi::contactgroupeditor</option>, <option value="classAkonadi_1_1ContactGroupEditorDialog.html">akonadi::contactgroupeditordialog</option>, <option value="classAkonadi_1_1ContactGroupExpandJob.html">akonadi::contactgroupexpandjob</option>, <option value="classAkonadi_1_1ContactGroupSearchJob.html">akonadi::contactgroupsearchjob</option>, <option value="classAkonadi_1_1ContactGroupViewer.html">akonadi::contactgroupviewer</option>, <option value="classAkonadi_1_1ContactGroupViewerDialog.html">akonadi::contactgroupviewerdialog</option>, <option value="classAkonadi_1_1ContactMetaData.html">akonadi::contactmetadata</option>, <option value="classAkonadi_1_1ContactMetaDataAttribute.html">akonadi::contactmetadataattribute</option>, <option value="classAkonadi_1_1ContactSearchJob.html">akonadi::contactsearchjob</option>, <option value="classAkonadi_1_1ContactsFilterProxyModel.html">akonadi::contactsfilterproxymodel</option>, <option value="classAkonadi_1_1ContactsTreeModel.html">akonadi::contactstreemodel</option>, <option value="classAkonadi_1_1ContactViewer.html">akonadi::contactviewer</option>, <option value="classAkonadi_1_1ContactViewerDialog.html">akonadi::contactviewerdialog</option>, <option value="classAkonadi_1_1Control.html">akonadi::control</option>, <option value="classAkonadi_1_1DefaultItemSerializerPlugin.html">akonadi::defaultitemserializerplugin</option>, <option value="classAkonadi_1_1DefaultResourceJob.html">akonadi::defaultresourcejob</option>, <option value="classAkonadi_1_1DialPhoneNumberAction.html">akonadi::dialphonenumberaction</option>, <option value="classAkonadi_1_1DifferencesAlgorithmInterface.html">akonadi::differencesalgorithminterface</option>, <option value="classAkonadi_1_1EmailAddressSelection.html">akonadi::emailaddressselection</option>, <option value="classAkonadi_1_1EmailAddressSelectionDialog.html">akonadi::emailaddressselectiondialog</option>, <option value="classAkonadi_1_1EmailAddressSelectionWidget.html">akonadi::emailaddressselectionwidget</option>, <option value="classAkonadi_1_1Entity.html">akonadi::entity</option>, <option value="classAkonadi_1_1EntityCache.html">akonadi::entitycache</option>, <option value="classAkonadi_1_1EntityCacheBase.html">akonadi::entitycachebase</option>, <option value="classAkonadi_1_1EntityDeletedAttribute.html">akonadi::entitydeletedattribute</option>, <option value="classAkonadi_1_1EntityDisplayAttribute.html">akonadi::entitydisplayattribute</option>, <option value="classAkonadi_1_1EntityHiddenAttribute.html">akonadi::entityhiddenattribute</option>, <option value="classAkonadi_1_1EntityListView.html">akonadi::entitylistview</option>, <option value="classAkonadi_1_1EntityMimeTypeFilterModel.html">akonadi::entitymimetypefiltermodel</option>, <option value="classAkonadi_1_1EntityOrderProxyModel.html">akonadi::entityorderproxymodel</option>, <option value="classAkonadi_1_1EntityPrivate.html">akonadi::entityprivate</option>, <option value="classAkonadi_1_1EntityRightsFilterModel.html">akonadi::entityrightsfiltermodel</option>, <option value="classAkonadi_1_1EntityTreeModel.html">akonadi::entitytreemodel</option>, <option value="classAkonadi_1_1EntityTreeModelPrivate.html">akonadi::entitytreemodelprivate</option>, <option value="classAkonadi_1_1EntityTreeView.html">akonadi::entitytreeview</option>, <option value="classAkonadi_1_1EntityTreeViewStateSaver.html">akonadi::entitytreeviewstatesaver</option>, <option value="classAkonadi_1_1ErrorOverlay.html">akonadi::erroroverlay</option>, <option value="classAkonadi_1_1Exception.html">akonadi::exception</option>, <option value="classAkonadi_1_1FavoriteCollectionsModel.html">akonadi::favoritecollectionsmodel</option>, <option value="classAkonadi_1_1FetchJobCalendar.html">akonadi::fetchjobcalendar</option>, <option value="classAkonadi_1_1Firstrun.html">akonadi::firstrun</option>, <option value="classAkonadi_1_1FreeBusyProviderBase.html">akonadi::freebusyproviderbase</option>, <option value="classAkonadi_1_1FreeBusyProviderBasePrivate.html">akonadi::freebusyproviderbaseprivate</option>, <option value="classAkonadi_1_1GetLockJob.html">akonadi::getlockjob</option>, <option value="classAkonadi_1_1History.html">akonadi::history</option>, <option value="classAkonadi_1_1ImageProvider.html">akonadi::imageprovider</option>, <option value="classAkonadi_1_1IncidenceFetchJob.html">akonadi::incidencefetchjob</option>, <option value="classAkonadi_1_1IncidenceMimeTypeVisitor.html">akonadi::incidencemimetypevisitor</option>, <option value="classAkonadi_1_1IndexPolicyAttribute.html">akonadi::indexpolicyattribute</option>, <option value="classAkonadi_1_1Internal_1_1SharedValuePool.html">akonadi::internal::sharedvaluepool</option>, <option value="classAkonadi_1_1InvalidateCacheJob.html">akonadi::invalidatecachejob</option>, <option value="classAkonadi_1_1InvitationHandlerHelper.html">akonadi::invitationhandlerhelper</option>, <option value="classAkonadi_1_1Item.html">akonadi::item</option>, <option value="classAkonadi_1_1ItemCopyJob.html">akonadi::itemcopyjob</option>, <option value="classAkonadi_1_1ItemCreateJob.html">akonadi::itemcreatejob</option>, <option value="classAkonadi_1_1ItemDeleteJob.html">akonadi::itemdeletejob</option>, <option value="classAkonadi_1_1ItemFetchJob.html">akonadi::itemfetchjob</option>, <option value="classAkonadi_1_1ItemFetchScope.html">akonadi::itemfetchscope</option>, <option value="classAkonadi_1_1ItemFetchScopePrivate.html">akonadi::itemfetchscopeprivate</option>, <option value="classAkonadi_1_1ItemModel.html">akonadi::itemmodel</option>, <option value="classAkonadi_1_1ItemModifyJob.html">akonadi::itemmodifyjob</option>, <option value="classAkonadi_1_1ItemModifyJobPrivate.html">akonadi::itemmodifyjobprivate</option>, <option value="classAkonadi_1_1ItemMonitor.html">akonadi::itemmonitor</option>, <option value="classAkonadi_1_1ItemMonitor_1_1Private.html">akonadi::itemmonitor::private</option>, <option value="classAkonadi_1_1ItemMoveJob.html">akonadi::itemmovejob</option>, <option value="classAkonadi_1_1ItemPrivate.html">akonadi::itemprivate</option>, <option value="classAkonadi_1_1ItemSearchJob.html">akonadi::itemsearchjob</option>, <option value="classAkonadi_1_1ItemSerializer.html">akonadi::itemserializer</option>, <option value="classAkonadi_1_1ItemSerializerPlugin.html">akonadi::itemserializerplugin</option>, <option value="classAkonadi_1_1ItemSerializerPluginV2.html">akonadi::itemserializerpluginv2</option>, <option value="classAkonadi_1_1ItemSync.html">akonadi::itemsync</option>, <option value="classAkonadi_1_1ItemView.html">akonadi::itemview</option>, <option value="classAkonadi_1_1Job.html">akonadi::job</option>, <option value="classAkonadi_1_1JobPrivate.html">akonadi::jobprivate</option>, <option value="classAkonadi_1_1KColumnFilterProxyModel.html">akonadi::kcolumnfilterproxymodel</option>, <option value="classAkonadi_1_1KJobPrivateBase.html">akonadi::kjobprivatebase</option>, <option value="classAkonadi_1_1LinkJob.html">akonadi::linkjob</option>, <option value="classAkonadi_1_1LinkJobImpl.html">akonadi::linkjobimpl</option>, <option value="classAkonadi_1_1MessageFolderAttribute.html">akonadi::messagefolderattribute</option>, <option value="classAkonadi_1_1MessageModel.html">akonadi::messagemodel</option>, <option value="classAkonadi_1_1MessageStatus.html">akonadi::messagestatus</option>, <option value="classAkonadi_1_1MessageThreaderProxyModel.html">akonadi::messagethreaderproxymodel</option>, <option value="classAkonadi_1_1MessageThreadingAttribute.html">akonadi::messagethreadingattribute</option>, <option value="classAkonadi_1_1MimeTypeChecker.html">akonadi::mimetypechecker</option>, <option value="classAkonadi_1_1MimeTypeCheckerPrivate.html">akonadi::mimetypecheckerprivate</option>, <option value="classAkonadi_1_1Monitor.html">akonadi::monitor</option>, <option value="classAkonadi_1_1MonitorPrivate.html">akonadi::monitorprivate</option>, <option value="classAkonadi_1_1MonitorPrivate_1_1PurgeBuffer.html">akonadi::monitorprivate::purgebuffer</option>, <option value="classAkonadi_1_1MoveJobImpl.html">akonadi::movejobimpl</option>, <option value="classAkonadi_1_1NoteUtils_1_1Attachment.html">akonadi::noteutils::attachment</option>, <option value="classAkonadi_1_1NoteUtils_1_1NoteMessageWrapper.html">akonadi::noteutils::notemessagewrapper</option>, <option value="classAkonadi_1_1ObjectNotificationMessage.html">akonadi::objectnotificationmessage</option>, <option value="classAkonadi_1_1PartFetcher.html">akonadi::partfetcher</option>, <option value="classAkonadi_1_1PersistentSearchAttribute.html">akonadi::persistentsearchattribute</option>, <option value="classAkonadi_1_1PreprocessorBase.html">akonadi::preprocessorbase</option>, <option value="classAkonadi_1_1ProtocolHelper.html">akonadi::protocolhelper</option>, <option value="classAkonadi_1_1RecentContactsCollectionRequestJob.html">akonadi::recentcontactscollectionrequestjob</option>, <option value="classAkonadi_1_1RecentContactsCollections.html">akonadi::recentcontactscollections</option>, <option value="classAkonadi_1_1RecursiveCollectionFilterProxyModel.html">akonadi::recursivecollectionfilterproxymodel</option>, <option value="classAkonadi_1_1RecursiveItemFetchJob.html">akonadi::recursiveitemfetchjob</option>, <option value="classAkonadi_1_1RecursiveMover.html">akonadi::recursivemover</option>, <option value="classAkonadi_1_1RemoveDuplicatesJob.html">akonadi::removeduplicatesjob</option>, <option value="classAkonadi_1_1ResourceBase.html">akonadi::resourcebase</option>, <option value="classAkonadi_1_1ResourceScanJob.html">akonadi::resourcescanjob</option>, <option value="classAkonadi_1_1ResourceSelectJob.html">akonadi::resourceselectjob</option>, <option value="classAkonadi_1_1ResourceSynchronizationJob.html">akonadi::resourcesynchronizationjob</option>, <option value="classAkonadi_1_1Scheduler.html">akonadi::scheduler</option>, <option value="classAkonadi_1_1SearchCreateJob.html">akonadi::searchcreatejob</option>, <option value="classAkonadi_1_1SelectionProxyModel.html">akonadi::selectionproxymodel</option>, <option value="classAkonadi_1_1SelfTestDialog.html">akonadi::selftestdialog</option>, <option value="classAkonadi_1_1ServerManager.html">akonadi::servermanager</option>, <option value="classAkonadi_1_1Session.html">akonadi::session</option>, <option value="classAkonadi_1_1SessionPrivate.html">akonadi::sessionprivate</option>, <option value="classAkonadi_1_1ShowAddressAction.html">akonadi::showaddressaction</option>, <option value="classAkonadi_1_1SocialFeedItem.html">akonadi::socialfeeditem</option>, <option value="classAkonadi_1_1SpecialCollectionAttribute.html">akonadi::specialcollectionattribute</option>, <option value="classAkonadi_1_1SpecialCollections.html">akonadi::specialcollections</option>, <option value="classAkonadi_1_1SpecialCollectionsPrivate.html">akonadi::specialcollectionsprivate</option>, <option value="classAkonadi_1_1SpecialCollectionsRequestJob.html">akonadi::specialcollectionsrequestjob</option>, <option value="classAkonadi_1_1SpecialMailCollections.html">akonadi::specialmailcollections</option>, <option value="classAkonadi_1_1SpecialMailCollectionsRequestJob.html">akonadi::specialmailcollectionsrequestjob</option>, <option value="classAkonadi_1_1SpecialMailCollectionsTesting.html">akonadi::specialmailcollectionstesting</option>, <option value="classAkonadi_1_1StandardActionManager.html">akonadi::standardactionmanager</option>, <option value="classAkonadi_1_1StandardCalendarActionManager.html">akonadi::standardcalendaractionmanager</option>, <option value="classAkonadi_1_1StandardContactActionManager.html">akonadi::standardcontactactionmanager</option>, <option value="classAkonadi_1_1StandardContactFormatter.html">akonadi::standardcontactformatter</option>, <option value="classAkonadi_1_1StandardContactGroupFormatter.html">akonadi::standardcontactgroupformatter</option>, <option value="classAkonadi_1_1StandardMailActionManager.html">akonadi::standardmailactionmanager</option>, <option value="classAkonadi_1_1StatisticsProxyModel.html">akonadi::statisticsproxymodel</option>, <option value="classAkonadi_1_1StdStringItemSerializerPlugin.html">akonadi::stdstringitemserializerplugin</option>, <option value="classAkonadi_1_1SubscriptionDialog.html">akonadi::subscriptiondialog</option>, <option value="classAkonadi_1_1SubscriptionJob.html">akonadi::subscriptionjob</option>, <option value="classAkonadi_1_1SubscriptionModel.html">akonadi::subscriptionmodel</option>, <option value="classAkonadi_1_1TextBrowser.html">akonadi::textbrowser</option>, <option value="classAkonadi_1_1TransactionBeginJob.html">akonadi::transactionbeginjob</option>, <option value="classAkonadi_1_1TransactionCommitJob.html">akonadi::transactioncommitjob</option>, <option value="classAkonadi_1_1TransactionRollbackJob.html">akonadi::transactionrollbackjob</option>, <option value="classAkonadi_1_1TransactionSequence.html">akonadi::transactionsequence</option>, <option value="classAkonadi_1_1TransportResourceBase.html">akonadi::transportresourcebase</option>, <option value="classAkonadi_1_1TransportResourceBasePrivate.html">akonadi::transportresourcebaseprivate</option>, <option value="classAkonadi_1_1TrashFilterProxyModel.html">akonadi::trashfilterproxymodel</option>, <option value="classAkonadi_1_1TrashJob.html">akonadi::trashjob</option>, <option value="classAkonadi_1_1TrashRestoreJob.html">akonadi::trashrestorejob</option>, <option value="classAkonadi_1_1UnlinkJob.html">akonadi::unlinkjob</option>, <option value="classAutoQPointer.html">autoqpointer</option>, <option value="classCategoriesEditWidget.html">categorieseditwidget</option>, <option value="classCollectionFilterModel.html">collectionfiltermodel</option>, <option value="classContactEditorWidget.html">contacteditorwidget</option>, <option value="classCustomField.html">customfield</option>, <option value="classCustomFieldManager.html">customfieldmanager</option>, <option value="classDisplayNameEditWidget.html">displaynameeditwidget</option>, <option value="classEmailEditWidget.html">emaileditwidget</option>, <option value="classIMEditWidget.html">imeditwidget</option>, <option value="classKDatePickerPopup.html">kdatepickerpopup</option>, <option value="classKEditTagsDialog.html">kedittagsdialog</option>, <option value="classNameEditWidget.html">nameeditwidget</option>, <option value="classPhoneEditWidget.html">phoneeditwidget</option>, <option value="classPhoneNumberListWidget.html">phonenumberlistwidget</option>, <option value="classPhoneNumberWidget.html">phonenumberwidget</option>, <option value="classPhoneTypeCombo.html">phonetypecombo</option>, <option value="classPhoneTypeDialog.html">phonetypedialog</option>, <option value="classWaitingOverlay.html">waitingoverlay</option>,
</select>
</form>
</div>
-->
<div class="menu_box">
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">kdepimlibs-4.10.5 API Reference</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "kdepimlibs-4.10.5 API Reference"</a>
</div></div>
<div class="nav_list">
<ul>
<li><a href="../../akonadi/html/index.html">akonadi</a></li><li> <a href="../../akonadi/contact/html/index.html">contact</a></li><li> <a href="../../akonadi/kmime/html/index.html">kmime</a></li><li> <a href="../../akonadi/socialutils/html/index.html">socialutils</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kalarmcal/html/index.html">kalarmcal</a></li><li><a href="../../kblog/html/index.html">kblog</a></li><li><a href="../../kcal/html/index.html">kcal</a></li><li><a href="../../kcalcore/html/index.html">kcalcore</a></li><li><a href="../../kcalutils/html/index.html">kcalutils</a></li><li><a href="../../kholidays/html/index.html">kholidays</a></li><li><a href="../../kimap/html/index.html">kimap</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/imap4/html/index.html">imap4</a></li><li> <a href="../../kioslave/mbox/html/index.html">mbox</a></li><li> <a href="../../kioslave/nntp/html/index.html">nntp</a></li><li><a href="../../kldap/html/index.html">kldap</a></li><li><a href="../../kmbox/html/index.html">kmbox</a></li><li><a href="../../kmime/html/index.html">kmime</a></li><li><a href="../../kontactinterface/html/index.html">kontactinterface</a></li><li><a href="../../kpimidentities/html/index.html">kpimidentities</a></li><li><a href="../../kpimtextedit/html/index.html">kpimtextedit</a></li><li><a href="../../kpimutils/html/index.html">kpimutils</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../ktnef/html/index.html">ktnef</a></li><li><a href="../../kxmlrpcclient/html/index.html">kxmlrpcclient</a></li><li><a href="../../mailtransport/html/index.html">mailtransport</a></li><li><a href="../../microblog/html/index.html">microblog</a></li><li><a href="../../qgpgme/html/index.html">qgpgme</a></li><li><a href="../../syndication/html/index.html">syndication</a></li><li> <a href="../../syndication/atom/html/index.html">atom</a></li><li> <a href="../../syndication/rdf/html/index.html">rdf</a></li><li> <a href="../../syndication/rss2/html/index.html">rss2</a></li>
</ul></div></div>
<!-- api_searchbox -->
</div>
</div>
<div class="clearer"></div>
</div>
<div class="clearer"></div>
</div>
<div id="end_body"></div>
<div id="footer"><div id="footer_text">
Report problems with this website to <a href="https://bugs.kde.org/enter_sysadmin_request.cgi?component=api.kde.org">our bug tracking system</a>.<br>
Contact the specific authors with questions and comments about the page contents.<p>
KDE<sup>®</sup> and <a href="/media/images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a></p>
</div></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-45abe0e0c3bebc77@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
