<?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::EntityTreeModel 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_1EntityTreeModel.html">EntityTreeModel</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</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_1EntityTreeModel-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Akonadi::EntityTreeModel Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="entitytreemodel_8h_source.html">entitytreemodel.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Akonadi::EntityTreeModel:</div>
<div class="dyncontent">
<div class="center">
<img src="classAkonadi_1_1EntityTreeModel.png" usemap="#Akonadi::EntityTreeModel_map" alt=""/>
<map id="Akonadi::EntityTreeModel_map" name="Akonadi::EntityTreeModel_map">
<area href="classAkonadi_1_1ContactsTreeModel.html" title="A model for contacts and contact groups as available in Akonadi." alt="Akonadi::ContactsTreeModel" shape="rect" coords="0,56,174,80"/>
</map>
</div></div>
<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:aaf514b1eeffd1c08e01555cc14edb072"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#aaf514b1eeffd1c08e01555cc14edb072">CollectionFetchStrategy</a> { <a class="el" href="classAkonadi_1_1EntityTreeModel.html#aaf514b1eeffd1c08e01555cc14edb072a06ed9692fd27d881c022ac6edbae9b50">FetchNoCollections</a>,
<a class="el" href="classAkonadi_1_1EntityTreeModel.html#aaf514b1eeffd1c08e01555cc14edb072a613cfcdb511722448bc7fb5c8ff34279">FetchFirstLevelChildCollections</a>,
<a class="el" href="classAkonadi_1_1EntityTreeModel.html#aaf514b1eeffd1c08e01555cc14edb072a77eef9309fe7dee5bb207bcd5f006032">FetchCollectionsRecursive</a>,
<a class="el" href="classAkonadi_1_1EntityTreeModel.html#aaf514b1eeffd1c08e01555cc14edb072a0797046b326fb5117173a71c51662798">InvisibleCollectionFetch</a>
}</td></tr>
<tr class="separator:aaf514b1eeffd1c08e01555cc14edb072"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a59d6be7b54f9c45eba7aa448d07ccbf2"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#a59d6be7b54f9c45eba7aa448d07ccbf2">FetchState</a> { <a class="el" href="classAkonadi_1_1EntityTreeModel.html#a59d6be7b54f9c45eba7aa448d07ccbf2ab75b8dccd52a67f2ad1b46d53464100b">IdleState</a>,
<a class="el" href="classAkonadi_1_1EntityTreeModel.html#a59d6be7b54f9c45eba7aa448d07ccbf2a012aa97f135a4be70aa20c5444fef918">FetchingState</a>
}</td></tr>
<tr class="separator:a59d6be7b54f9c45eba7aa448d07ccbf2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a78fb18875ea3f23e4765ce67f6546bcd"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#a78fb18875ea3f23e4765ce67f6546bcd">HeaderGroup</a> { <br/>
  <a class="el" href="classAkonadi_1_1EntityTreeModel.html#a78fb18875ea3f23e4765ce67f6546bcdab968be3ac0c10f1c57d5bd995217800b">EntityTreeHeaders</a>,
<a class="el" href="classAkonadi_1_1EntityTreeModel.html#a78fb18875ea3f23e4765ce67f6546bcda5ab957ade511bcaa9ca49c91454ac9b5">CollectionTreeHeaders</a>,
<a class="el" href="classAkonadi_1_1EntityTreeModel.html#a78fb18875ea3f23e4765ce67f6546bcda7efbbe3fbde0ab13401e0180a41d0a30">ItemListHeaders</a>,
<a class="el" href="classAkonadi_1_1EntityTreeModel.html#a78fb18875ea3f23e4765ce67f6546bcda6ff58406034ab6be01c5320c70dd9226">UserHeaders</a> = 10,
<br/>
  <a class="el" href="classAkonadi_1_1EntityTreeModel.html#a78fb18875ea3f23e4765ce67f6546bcda774e4e46ab585839aa8dc6dccf09ad98">EndHeaderGroup</a> = 32
<br/>
}</td></tr>
<tr class="separator:a78fb18875ea3f23e4765ce67f6546bcd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a24c3ee01a13dd66eed4521a3519dad06"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#a24c3ee01a13dd66eed4521a3519dad06">ItemPopulationStrategy</a> { <a class="el" href="classAkonadi_1_1EntityTreeModel.html#a24c3ee01a13dd66eed4521a3519dad06ae76372ae0607f73b95a1b3059234bea3">NoItemPopulation</a>,
<a class="el" href="classAkonadi_1_1EntityTreeModel.html#a24c3ee01a13dd66eed4521a3519dad06a3d17a5381d995654b0a944d6b09a2fd5">ImmediatePopulation</a>,
<a class="el" href="classAkonadi_1_1EntityTreeModel.html#a24c3ee01a13dd66eed4521a3519dad06af342ba6a74929a6abce70b70a51764f2">LazyPopulation</a>
}</td></tr>
<tr class="separator:a24c3ee01a13dd66eed4521a3519dad06"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afb2cc4f8ecf57b3db2ef56068e7223c2"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2">Roles</a> { <br/>
  <a class="el" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2a02fefb9d2b8dfae91eaf617d933e048a">ItemIdRole</a> = Qt::UserRole + 1,
<a class="el" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2a38e48c0690b5a932e20b0ba804418c7c">ItemRole</a> = Qt::UserRole + 2,
<a class="el" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2ae8195c8a8aeb2ae1615d8d8b46a9cd24">MimeTypeRole</a> = Qt::UserRole + 3,
<a class="el" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2ababfe9216edd5f66ec3a7e105a3e003f">CollectionIdRole</a> = Qt::UserRole + 10,
<br/>
  <a class="el" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2aac18752d89491b2cfd0d5db6718abf78">CollectionRole</a> = Qt::UserRole + 11,
<a class="el" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2a6e9e4da9e2e402c4370efa7385fd6d7a">RemoteIdRole</a>,
<a class="el" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2ae9b9cc0435b0ea7311c0d52b06b40d14">CollectionChildOrderRole</a>,
<a class="el" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2a8ce2682b2090f19007ad7445728a0c25">AmazingCompletionRole</a>,
<br/>
  <a class="el" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2a339c6dad6c0444619389b7625204837f">ParentCollectionRole</a>,
<a class="el" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2afb326adddd9002afafd281993dd4fb5f">ColumnCountRole</a>,
<a class="el" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2a618c231feb5925e20c88d5318aedc306">LoadedPartsRole</a>,
<a class="el" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2a1675206bdeeccc71f2e8b316bc0f193b">AvailablePartsRole</a>,
<br/>
  <a class="el" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2a7999f3f2631114d548b342a091a4a4cb">SessionRole</a>,
<a class="el" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2ad6fd518c05a98611a4aa7e70fba36f1c">CollectionRefRole</a>,
<a class="el" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2a67e72f7da5cb5df42a412f12a7ecd978">CollectionDerefRole</a>,
<a class="el" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2ac83d5987830741d9bb93a6325f221c97">PendingCutRole</a>,
<br/>
  <a class="el" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2ab5917e94a8e18acbb0d02d2c81422c5c">EntityUrlRole</a>,
<a class="el" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2acff6114ff533562bcbfcee683000ee04">UnreadCountRole</a>,
<a class="el" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2af014549388a46d8bd005d9f44d10c095">FetchStateRole</a>,
<a class="el" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2aa7a80e3838d47128ffdaa609bdf0750f">CollectionSyncProgressRole</a>,
<br/>
  <a class="el" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2adb59744862d276c2c293104b267d13f5">IsPopulatedRole</a>,
<a class="el" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2aa50c2c35488fe2317a7f85c64ad4d785">UserRole</a> = Qt::UserRole + 500,
<a class="el" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2a44c9568a0b33403682ed7b95731f289b">TerminalUserRole</a> = 2000,
<b>EndRole</b> = 65535
<br/>
}</td></tr>
<tr class="separator:afb2cc4f8ecf57b3db2ef56068e7223c2"><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:a9b8d56111224a0ce439c3d8cc659c42e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#a9b8d56111224a0ce439c3d8cc659c42e">collectionFetched</a> (int collectionId)</td></tr>
<tr class="separator:a9b8d56111224a0ce439c3d8cc659c42e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac94dc517423372ea39b22279472f0f67"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#ac94dc517423372ea39b22279472f0f67">collectionPopulated</a> (<a class="el" href="classAkonadi_1_1Entity.html#af2be5f7f801231641bfff0e2ae9f686f">Akonadi::Collection::Id</a> collectionId)</td></tr>
<tr class="separator:ac94dc517423372ea39b22279472f0f67"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3512513e1fb86ce0b226fa95728f7658"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#a3512513e1fb86ce0b226fa95728f7658">collectionTreeFetched</a> (const <a class="el" href="classAkonadi_1_1Collection.html#a5ba0681ec86428cf5f5d3a1610ff6ad1">Akonadi::Collection::List</a> &collections)</td></tr>
<tr class="separator:a3512513e1fb86ce0b226fa95728f7658"><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:ab105bb398739eca63df5aac3a735bebd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#ab105bb398739eca63df5aac3a735bebd">EntityTreeModel</a> (<a class="el" href="classAkonadi_1_1ChangeRecorder.html">ChangeRecorder</a> *monitor, QObject *parent=0)</td></tr>
<tr class="separator:ab105bb398739eca63df5aac3a735bebd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a777bb33900021025308e7ced26a2c42a"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#a777bb33900021025308e7ced26a2c42a">~EntityTreeModel</a> ()</td></tr>
<tr class="separator:a777bb33900021025308e7ced26a2c42a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b3dec85c9af5993d8029f060aa77e3f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6b3dec85c9af5993d8029f060aa77e3f"></a>
virtual bool </td><td class="memItemRight" valign="bottom"><b>canFetchMore</b> (const QModelIndex &parent) const </td></tr>
<tr class="separator:a6b3dec85c9af5993d8029f060aa77e3f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a42273018c0b64912a971e9f68bc51570"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#aaf514b1eeffd1c08e01555cc14edb072">CollectionFetchStrategy</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#a42273018c0b64912a971e9f68bc51570">collectionFetchStrategy</a> () const </td></tr>
<tr class="separator:a42273018c0b64912a971e9f68bc51570"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a55fdf12610f70ddb55efd0f6f5dcf7cb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a55fdf12610f70ddb55efd0f6f5dcf7cb"></a>
virtual int </td><td class="memItemRight" valign="bottom"><b>columnCount</b> (const QModelIndex &parent=QModelIndex()) const </td></tr>
<tr class="separator:a55fdf12610f70ddb55efd0f6f5dcf7cb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaf7a353234ce66d3f8a6732ae240dedc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf7a353234ce66d3f8a6732ae240dedc"></a>
virtual QVariant </td><td class="memItemRight" valign="bottom"><b>data</b> (const QModelIndex &index, int role=Qt::DisplayRole) const </td></tr>
<tr class="separator:aaf7a353234ce66d3f8a6732ae240dedc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1928f6dad8db51d34852110c9c2a9008"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1928f6dad8db51d34852110c9c2a9008"></a>
virtual bool </td><td class="memItemRight" valign="bottom"><b>dropMimeData</b> (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)</td></tr>
<tr class="separator:a1928f6dad8db51d34852110c9c2a9008"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaef5615f495e75e02cc3b8e58f149680"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaef5615f495e75e02cc3b8e58f149680"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>fetchMore</b> (const QModelIndex &parent)</td></tr>
<tr class="separator:aaef5615f495e75e02cc3b8e58f149680"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6bda57a6255aa6d7197d02c2acb6d81a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6bda57a6255aa6d7197d02c2acb6d81a"></a>
virtual Qt::ItemFlags </td><td class="memItemRight" valign="bottom"><b>flags</b> (const QModelIndex &index) const </td></tr>
<tr class="separator:a6bda57a6255aa6d7197d02c2acb6d81a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aebcb8d1d69b2bf7f174666409d3143c4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aebcb8d1d69b2bf7f174666409d3143c4"></a>
virtual bool </td><td class="memItemRight" valign="bottom"><b>hasChildren</b> (const QModelIndex &parent=QModelIndex()) const </td></tr>
<tr class="separator:aebcb8d1d69b2bf7f174666409d3143c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6d8d98818b5545711627db46d3a92f8a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6d8d98818b5545711627db46d3a92f8a"></a>
virtual QVariant </td><td class="memItemRight" valign="bottom"><b>headerData</b> (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const </td></tr>
<tr class="separator:a6d8d98818b5545711627db46d3a92f8a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abeb4419c518dafbf2ebccdbe891955d4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#abeb4419c518dafbf2ebccdbe891955d4">includeRootCollection</a> () const </td></tr>
<tr class="separator:abeb4419c518dafbf2ebccdbe891955d4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7db8b3ef8a9818ebc8e604810d9c3bcf"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#a7db8b3ef8a9818ebc8e604810d9c3bcf">includeUnsubscribed</a> () const </td></tr>
<tr class="separator:a7db8b3ef8a9818ebc8e604810d9c3bcf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad07a36bb0fe7685cd7401cf5eedfa107"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad07a36bb0fe7685cd7401cf5eedfa107"></a>
virtual QModelIndex </td><td class="memItemRight" valign="bottom"><b>index</b> (int row, int column, const QModelIndex &parent=QModelIndex()) const </td></tr>
<tr class="separator:ad07a36bb0fe7685cd7401cf5eedfa107"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6556915c2836499793d08c18d2a56178"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#a6556915c2836499793d08c18d2a56178">isCollectionTreeFetched</a> () const </td></tr>
<tr class="separator:a6556915c2836499793d08c18d2a56178"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd9334dc6ed936f3f125c2d080df7063"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#a24c3ee01a13dd66eed4521a3519dad06">ItemPopulationStrategy</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#acd9334dc6ed936f3f125c2d080df7063">itemPopulationStrategy</a> () const </td></tr>
<tr class="separator:acd9334dc6ed936f3f125c2d080df7063"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae1835c6fed6d514c3de7ddf73e888d0b"><td class="memItemLeft" align="right" valign="top">virtual QModelIndexList </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#ae1835c6fed6d514c3de7ddf73e888d0b">match</a> (const QModelIndex &start, int role, const QVariant &value, int hits=1, Qt::MatchFlags flags=Qt::MatchFlags(Qt::MatchStartsWith|Qt::MatchWrap)) const </td></tr>
<tr class="separator:ae1835c6fed6d514c3de7ddf73e888d0b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a20ea88c0bf67382f132ce740c70d1925"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a20ea88c0bf67382f132ce740c70d1925"></a>
virtual QMimeData * </td><td class="memItemRight" valign="bottom"><b>mimeData</b> (const QModelIndexList &indexes) const </td></tr>
<tr class="separator:a20ea88c0bf67382f132ce740c70d1925"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4094ebc7df92381538ef15b10373a16c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4094ebc7df92381538ef15b10373a16c"></a>
virtual QStringList </td><td class="memItemRight" valign="bottom"><b>mimeTypes</b> () const </td></tr>
<tr class="separator:a4094ebc7df92381538ef15b10373a16c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab26789b2379528fe4f9eb722c65f7336"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab26789b2379528fe4f9eb722c65f7336"></a>
virtual QModelIndex </td><td class="memItemRight" valign="bottom"><b>parent</b> (const QModelIndex &index) const </td></tr>
<tr class="separator:ab26789b2379528fe4f9eb722c65f7336"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa794da23daddeec92983026472f17c0"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#aaa794da23daddeec92983026472f17c0">rootCollectionDisplayName</a> () const </td></tr>
<tr class="separator:aaa794da23daddeec92983026472f17c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a626668f370d2b4a60280a36c407c9a5c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a626668f370d2b4a60280a36c407c9a5c"></a>
virtual int </td><td class="memItemRight" valign="bottom"><b>rowCount</b> (const QModelIndex &parent=QModelIndex()) const </td></tr>
<tr class="separator:a626668f370d2b4a60280a36c407c9a5c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6e7fb7f5ca6c56e939b8bbb687c1531a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#a6e7fb7f5ca6c56e939b8bbb687c1531a">setCollectionFetchStrategy</a> (<a class="el" href="classAkonadi_1_1EntityTreeModel.html#aaf514b1eeffd1c08e01555cc14edb072">CollectionFetchStrategy</a> strategy)</td></tr>
<tr class="separator:a6e7fb7f5ca6c56e939b8bbb687c1531a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6954d8abf4ee012364f83abf86368e3a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6954d8abf4ee012364f83abf86368e3a"></a>
virtual bool </td><td class="memItemRight" valign="bottom"><b>setData</b> (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole)</td></tr>
<tr class="separator:a6954d8abf4ee012364f83abf86368e3a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc2b46206706718b14d604ec9cfa8213"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#adc2b46206706718b14d604ec9cfa8213">setIncludeRootCollection</a> (bool include)</td></tr>
<tr class="separator:adc2b46206706718b14d604ec9cfa8213"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a990f47f11b1013426b821e338690557a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#a990f47f11b1013426b821e338690557a">setIncludeUnsubscribed</a> (bool show)</td></tr>
<tr class="separator:a990f47f11b1013426b821e338690557a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acdb3543fd0cb42e1aa92b48361971cb8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#acdb3543fd0cb42e1aa92b48361971cb8">setItemPopulationStrategy</a> (<a class="el" href="classAkonadi_1_1EntityTreeModel.html#a24c3ee01a13dd66eed4521a3519dad06">ItemPopulationStrategy</a> strategy)</td></tr>
<tr class="separator:acdb3543fd0cb42e1aa92b48361971cb8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a199ca669e57bdd57e8d0dcd771e7215d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#a199ca669e57bdd57e8d0dcd771e7215d">setRootCollectionDisplayName</a> (const QString &name)</td></tr>
<tr class="separator:a199ca669e57bdd57e8d0dcd771e7215d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0f74287eb50fc2c3f771e5cf2679795e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#a0f74287eb50fc2c3f771e5cf2679795e">setShowSystemEntities</a> (bool show)</td></tr>
<tr class="separator:a0f74287eb50fc2c3f771e5cf2679795e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a65f1d3cfc0aab1fa047e35a1398867e9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a65f1d3cfc0aab1fa047e35a1398867e9"></a>
virtual Qt::DropActions </td><td class="memItemRight" valign="bottom"><b>supportedDropActions</b> () const </td></tr>
<tr class="separator:a65f1d3cfc0aab1fa047e35a1398867e9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a03547dee565f6f37cf067c71a57120de"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#a03547dee565f6f37cf067c71a57120de">systemEntitiesShown</a> () const </td></tr>
<tr class="separator:a03547dee565f6f37cf067c71a57120de"><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:ae23d286ab95beec54354e849bf506a90"><td class="memItemLeft" align="right" valign="top">static QModelIndexList </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#ae23d286ab95beec54354e849bf506a90">modelIndexesForItem</a> (const QAbstractItemModel *model, const <a class="el" href="classAkonadi_1_1Item.html">Item</a> &item)</td></tr>
<tr class="separator:ae23d286ab95beec54354e849bf506a90"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aed2e03092e9d43e2f41a1c6547406489"><td class="memItemLeft" align="right" valign="top">static QModelIndex </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#aed2e03092e9d43e2f41a1c6547406489">modelIndexForCollection</a> (const QAbstractItemModel *model, const <a class="el" href="classAkonadi_1_1Collection.html">Collection</a> &collection)</td></tr>
<tr class="separator:aed2e03092e9d43e2f41a1c6547406489"><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:a471b8c4c6ca58bd46fd1a70f5906ffe2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#a471b8c4c6ca58bd46fd1a70f5906ffe2">clearAndReset</a> ()</td></tr>
<tr class="separator:a471b8c4c6ca58bd46fd1a70f5906ffe2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac674f8b6db49049c53e033fb92822d8b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac674f8b6db49049c53e033fb92822d8b"></a>
virtual int </td><td class="memItemRight" valign="bottom"><b>entityColumnCount</b> (<a class="el" href="classAkonadi_1_1EntityTreeModel.html#a78fb18875ea3f23e4765ce67f6546bcd">HeaderGroup</a> headerGroup) const </td></tr>
<tr class="separator:ac674f8b6db49049c53e033fb92822d8b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af238a75f4f0f75e3934e266ab4b1e184"><td class="memItemLeft" align="right" valign="top">virtual QVariant </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#af238a75f4f0f75e3934e266ab4b1e184">entityData</a> (const <a class="el" href="classAkonadi_1_1Item.html">Item</a> &item, int column, int role=Qt::DisplayRole) const </td></tr>
<tr class="separator:af238a75f4f0f75e3934e266ab4b1e184"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad40585156bc33e4787c5485a65894481"><td class="memItemLeft" align="right" valign="top">virtual QVariant </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#ad40585156bc33e4787c5485a65894481">entityData</a> (const <a class="el" href="classAkonadi_1_1Collection.html">Collection</a> &collection, int column, int role=Qt::DisplayRole) const </td></tr>
<tr class="separator:ad40585156bc33e4787c5485a65894481"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4214db2f9e902694112fc42bf498ed08"><td class="memItemLeft" align="right" valign="top">virtual QVariant </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#a4214db2f9e902694112fc42bf498ed08">entityHeaderData</a> (int section, Qt::Orientation orientation, int role, <a class="el" href="classAkonadi_1_1EntityTreeModel.html#a78fb18875ea3f23e4765ce67f6546bcd">HeaderGroup</a> headerGroup) const </td></tr>
<tr class="separator:a4214db2f9e902694112fc42bf498ed08"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb8b056108b017b97db76b3f5de52237"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#abb8b056108b017b97db76b3f5de52237">entityMatch</a> (const <a class="el" href="classAkonadi_1_1Item.html">Item</a> &item, const QVariant &value, Qt::MatchFlags flags) const </td></tr>
<tr class="separator:abb8b056108b017b97db76b3f5de52237"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aefc9f8d5d6e8a0c2dc90d503f594a9f8"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#aefc9f8d5d6e8a0c2dc90d503f594a9f8">entityMatch</a> (const <a class="el" href="classAkonadi_1_1Collection.html">Collection</a> &collection, const QVariant &value, Qt::MatchFlags flags) const </td></tr>
<tr class="separator:aefc9f8d5d6e8a0c2dc90d503f594a9f8"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A model for collections and items together. </p>
<p><a class="el" href="namespaceAkonadi.html" title="FreeBusyManager::Singleton.">Akonadi</a> models and views provide a high level way to interact with the akonadi server. Most applications will use these classes.</p>
<p>Models provide an interface for viewing, updating, deleting and moving Items and Collections. Additionally, the models are updated automatically if another application changes the data or inserts of deletes items etc.</p>
<dl class="section note"><dt>Note</dt><dd>The <a class="el" href="classAkonadi_1_1EntityTreeModel.html" title="A model for collections and items together.">EntityTreeModel</a> should be used with the <a class="el" href="classAkonadi_1_1EntityTreeView.html" title="A view to show an item/collection tree provided by an EntityTreeModel.">EntityTreeView</a> or the <a class="el" href="classAkonadi_1_1EntityListView.html" title="A view to show an item/collection list provided by an EntityTreeModel.">EntityListView</a> class either directly or indirectly via proxy models.</dd></dl>
<h3>Retrieving Collections and Items from the model</h3>
<p>If you want to retrieve and <a class="el" href="classAkonadi_1_1Item.html" title="Represents a PIM item stored in Akonadi storage.">Item</a> or <a class="el" href="classAkonadi_1_1Collection.html" title="Represents a collection of PIM items.">Collection</a> from the model, and already have a valid QModelIndex for the correct row, the <a class="el" href="classAkonadi_1_1Collection.html" title="Represents a collection of PIM items.">Collection</a> can be retrieved like this:</p>
<div class="fragment"><div class="line">Collection col = index.data( <a class="code" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2aac18752d89491b2cfd0d5db6718abf78" title="The collection.">EntityTreeModel::CollectionRole</a> ).value<Collection>();</div>
</div><!-- fragment --><p>And similarly for Items. This works even if there is a proxy model between the calling code and the <a class="el" href="classAkonadi_1_1EntityTreeModel.html" title="A model for collections and items together.">EntityTreeModel</a>.</p>
<p>If you want to retrieve a <a class="el" href="classAkonadi_1_1Collection.html" title="Represents a collection of PIM items.">Collection</a> for a particular <a class="el" href="classAkonadi_1_1Entity.html#af2be5f7f801231641bfff0e2ae9f686f" title="Describes the unique id type.">Collection::Id</a> and you do not yet have a valid QModelIndex, use modelIndexForCollection.</p>
<h3>Using <a class="el" href="classAkonadi_1_1EntityTreeModel.html" title="A model for collections and items together.">EntityTreeModel</a> in your application</h3>
<p>The responsibilities which fall to the application developer are</p>
<ul>
<li>Configuring the <a class="el" href="classAkonadi_1_1ChangeRecorder.html" title="Records and replays change notification.">ChangeRecorder</a> and <a class="el" href="classAkonadi_1_1EntityTreeModel.html" title="A model for collections and items together.">EntityTreeModel</a></li>
<li>Making use of this class via proxy models</li>
<li>Subclassing for type specific display information</li>
</ul>
<h3>Creating and configuring the <a class="el" href="classAkonadi_1_1EntityTreeModel.html" title="A model for collections and items together.">EntityTreeModel</a></h3>
<p>This class is a wrapper around a <a class="el" href="classAkonadi_1_1ChangeRecorder.html" title="Records and replays change notification.">Akonadi::ChangeRecorder</a> object. The model represents a part of the collection and item tree configured in the <a class="el" href="classAkonadi_1_1ChangeRecorder.html" title="Records and replays change notification.">ChangeRecorder</a>. The structure of the model mirrors the structure of Collections and Items on the Akonadi server.</p>
<p>The following code creates a model which fetches items and collections relevant to addressees (contacts), and automatically manages keeping the items up to date.</p>
<div class="fragment"><div class="line">ChangeRecorder *changeRecorder = <span class="keyword">new</span> ChangeRecorder( <span class="keyword">this</span> );</div>
<div class="line">changeRecorder->setCollectionMonitored( <a class="code" href="classAkonadi_1_1Collection.html#a31432a037116d1d14a67917e334bd200" title="Returns the root collection.">Collection::root</a>() );</div>
<div class="line">changeRecorder->setMimeTypeMonitored( KABC::addresseeMimeType() );</div>
<div class="line">changeRecorder->setSession( session );</div>
<div class="line"></div>
<div class="line"><a class="code" href="classAkonadi_1_1EntityTreeModel.html#ab105bb398739eca63df5aac3a735bebd" title="Creates a new entity tree model.">EntityTreeModel</a> *model = <span class="keyword">new</span> <a class="code" href="classAkonadi_1_1EntityTreeModel.html#ab105bb398739eca63df5aac3a735bebd" title="Creates a new entity tree model.">EntityTreeModel</a>( changeRecorder, <span class="keyword">this</span> );</div>
<div class="line"></div>
<div class="line">EntityTreeView *view = <span class="keyword">new</span> EntityTreeView( <span class="keyword">this</span> );</div>
<div class="line">view->setModel( model );</div>
</div><!-- fragment --><p>The <a class="el" href="classAkonadi_1_1EntityTreeModel.html" title="A model for collections and items together.">EntityTreeModel</a> will show items of a different type by changing the line</p>
<div class="fragment"><div class="line">changeRecorder->setMimeTypeMonitored( KABC::addresseeMimeType() );</div>
</div><!-- fragment --><p>to a different mimetype. KABC::addresseeMimeType() is an alias for "text/directory". If changed to KMime::Message::mimeType() (an alias for "message/rfc822") the model would instead contain emails. The model can be configured to contain items of any mimetype known to Akonadi.</p>
<dl class="section note"><dt>Note</dt><dd>The <a class="el" href="classAkonadi_1_1EntityTreeModel.html" title="A model for collections and items together.">EntityTreeModel</a> does some extra configuration on the <a class="el" href="classAkonadi_1_1Monitor.html" title="Monitors an item or collection for changes.">Monitor</a>, such as setting itemFetchScope() and collectionFetchScope() to retrieve all ancestors. This is necessary for proper function of the model.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classAkonadi_1_1ItemFetchScope.html#afbbbfb1be0c8cff370f3404d6d51970b" title="Describes the ancestor retrieval depth.">Akonadi::ItemFetchScope::AncestorRetrieval</a>.</dd>
<dd>
akonadi-mimetypes.</dd></dl>
<p>The <a class="el" href="classAkonadi_1_1EntityTreeModel.html" title="A model for collections and items together.">EntityTreeModel</a> can be further configured for certain behaviours such as fetching of collections and items.</p>
<p>The model can be configured to not fetch items into the model (ie, fetch collections only) by setting</p>
<div class="fragment"><div class="line">entityTreeModel->setItemPopulationStrategy( <a class="code" href="classAkonadi_1_1EntityTreeModel.html#a24c3ee01a13dd66eed4521a3519dad06ae76372ae0607f73b95a1b3059234bea3" title="Do not include items in the model.">EntityTreeModel::NoItemPopulation</a> );</div>
</div><!-- fragment --><p>The items may be fetched lazily, i.e. not inserted into the model until request by the user for performance reasons.</p>
<p>The <a class="el" href="classAkonadi_1_1Collection.html" title="Represents a collection of PIM items.">Collection</a> tree is always built immediately if Collections are to be fetched.</p>
<div class="fragment"><div class="line">entityTreeModel->setItemPopulationStrategy( <a class="code" href="classAkonadi_1_1EntityTreeModel.html#a24c3ee01a13dd66eed4521a3519dad06af342ba6a74929a6abce70b70a51764f2" title="Fetch items only when requested (using canFetchMore/fetchMore)">EntityTreeModel::LazyPopulation</a> );</div>
</div><!-- fragment --><p>This will typically be used with a <a class="el" href="classAkonadi_1_1EntityMimeTypeFilterModel.html" title="A proxy model that filters entities by mime type.">EntityMimeTypeFilterModel</a> in a configuration such as KMail4.5 or AkonadiConsole.</p>
<p>The CollectionFetchStrategy determines how the model will be populated with Collections. That is, if FetchNoCollections is set, no collections beyond the root of the model will be fetched. This can be used in combination with setting a particular <a class="el" href="classAkonadi_1_1Collection.html" title="Represents a collection of PIM items.">Collection</a> to monitor.</p>
<div class="fragment"><div class="line"><span class="comment">// Get an collection id from a config file.</span></div>
<div class="line"><a class="code" href="classAkonadi_1_1Entity.html#af2be5f7f801231641bfff0e2ae9f686f" title="Describes the unique id type.">Collection::Id</a> id;</div>
<div class="line">monitor->setCollectionMonitored( Collection( <span class="keywordtype">id</span> ) );</div>
<div class="line"><span class="comment">// ... Other initialization code.</span></div>
<div class="line">entityTree->setCollectionFetchStrategy( <a class="code" href="classAkonadi_1_1EntityTreeModel.html#aaf514b1eeffd1c08e01555cc14edb072a06ed9692fd27d881c022ac6edbae9b50" title="Fetches nothing. This creates an empty model.">FetchNoCollections</a> );</div>
</div><!-- fragment --><p>This has the effect of creating a model of only a list of Items, and not collections. This is similar in behaviour and aims to the <a class="el" href="classAkonadi_1_1ItemModel.html" title="A table model for items.">ItemModel</a>. By using FetchFirstLevelCollections instead, a mixed list of entities can be created.</p>
<dl class="section note"><dt>Note</dt><dd>It is important that you set only one <a class="el" href="classAkonadi_1_1Collection.html" title="Represents a collection of PIM items.">Collection</a> to be monitored in the monitor object. This one collection will be the root of the tree. If you need a model with a more complex structure, consider monitoring a common ancestor and using a <a class="el" href="classAkonadi_1_1SelectionProxyModel.html" title="A proxy model used to reference count selected Akonadi::Collection in a view.">SelectionProxyModel</a>.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd>lazy-model-population</dd></dl>
<p>It is also possible to show the root <a class="el" href="classAkonadi_1_1Collection.html" title="Represents a collection of PIM items.">Collection</a> as part of the selectable model:</p>
<div class="fragment"><div class="line">entityTree->setIncludeRootCollection( <span class="keyword">true</span> );</div>
</div><!-- fragment --><p>By default the displayed name of the root collection is '[*]', because it doesn't require i18n, and is generic. It can be changed too.</p>
<div class="fragment"><div class="line">entityTree->setIncludeRootCollection( <span class="keyword">true</span> );</div>
<div class="line">entityTree->setRootCollectionDisplayName( i18nc( <span class="stringliteral">"Name of top level for all addressbooks in the application"</span>, <span class="stringliteral">"[All AddressBooks]"</span> ) )</div>
</div><!-- fragment --><p>This feature is used in KAddressBook.</p>
<p>If items are to be fetched by the model, it is necessary to specify which parts of the items are to be fetched, using the <a class="el" href="classAkonadi_1_1ItemFetchScope.html" title="Specifies which parts of an item should be fetched from the Akonadi storage.">ItemFetchScope</a> class. By default, only the basic metadata is fetched. To fetch all item data, including all attributes:</p>
<div class="fragment"><div class="line">changeRecorder->itemFetchScope().fetchFullPayload();</div>
<div class="line">changeRecorder->itemFetchScope().fetchAllAttributes();</div>
</div><!-- fragment --><h2>Using <a class="el" href="classAkonadi_1_1EntityTreeModel.html" title="A model for collections and items together.">EntityTreeModel</a> with Proxy models</h2>
<p>An <a class="el" href="classAkonadi_1_1SelectionProxyModel.html" title="A proxy model used to reference count selected Akonadi::Collection in a view.">Akonadi::SelectionProxyModel</a> can be used to simplify managing selection in one view through multiple proxy models to a representation in another view. The selectionModel of the initial view is used to create a proxied model which filters out anything not related to the current selection.</p>
<div class="fragment"><div class="line"><span class="comment">// ... create an EntityTreeModel</span></div>
<div class="line"></div>
<div class="line">collectionTree = <span class="keyword">new</span> EntityMimeTypeFilterModel( <span class="keyword">this</span> );</div>
<div class="line">collectionTree->setSourceModel( entityTreeModel );</div>
<div class="line"></div>
<div class="line"><span class="comment">// Include only collections in this proxy model.</span></div>
<div class="line">collectionTree->addMimeTypeInclusionFilter( <a class="code" href="classAkonadi_1_1Collection.html#a0fbb1e4f3bf84fe061873c1813ec857e" title="Returns the mimetype used for collections.">Collection::mimeType</a>() );</div>
<div class="line">collectionTree->setHeaderGroup( <a class="code" href="classAkonadi_1_1EntityTreeModel.html#a78fb18875ea3f23e4765ce67f6546bcda5ab957ade511bcaa9ca49c91454ac9b5" title="Header information for a collection-only tree.">EntityTreeModel::CollectionTreeHeaders</a> );</div>
<div class="line"></div>
<div class="line">treeview->setModel(collectionTree);</div>
<div class="line"></div>
<div class="line"><span class="comment">// SelectionProxyModel can handle complex selections:</span></div>
<div class="line">treeview->setSelectionMode( QAbstractItemView::ExtendedSelection );</div>
<div class="line"></div>
<div class="line">SelectionProxyModel *selProxy = <span class="keyword">new</span> SelectionProxyModel( treeview->selectionModel(), this );</div>
<div class="line">selProxy->setSourceModel( entityTreeModel );</div>
<div class="line"></div>
<div class="line">itemList = <span class="keyword">new</span> EntityMimeTypeFilterModel( <span class="keyword">this</span> );</div>
<div class="line">itemList->setSourceModel( selProxy );</div>
<div class="line"></div>
<div class="line"><span class="comment">// Filter out collections. Show only items.</span></div>
<div class="line">itemList->addMimeTypeExclusionFilter( <a class="code" href="classAkonadi_1_1Collection.html#a0fbb1e4f3bf84fe061873c1813ec857e" title="Returns the mimetype used for collections.">Collection::mimeType</a>() );</div>
<div class="line">itemList->setHeaderGroup( <a class="code" href="classAkonadi_1_1EntityTreeModel.html#a78fb18875ea3f23e4765ce67f6546bcda7efbbe3fbde0ab13401e0180a41d0a30" title="Header information for a list of items.">EntityTreeModel::ItemListHeaders</a> );</div>
<div class="line"></div>
<div class="line">EntityTreeView *itemView = <span class="keyword">new</span> EntityTreeView( splitter );</div>
<div class="line">itemView->setModel( itemList );</div>
</div><!-- fragment --><p>The <a class="el" href="classAkonadi_1_1SelectionProxyModel.html" title="A proxy model used to reference count selected Akonadi::Collection in a view.">SelectionProxyModel</a> can handle complex selections.</p>
<p>See the KSelectionProxyModel documentation for the valid configurations of a <a class="el" href="classAkonadi_1_1SelectionProxyModel.html" title="A proxy model used to reference count selected Akonadi::Collection in a view.">Akonadi::SelectionProxyModel</a>.</p>
<p>Obviously, the <a class="el" href="classAkonadi_1_1SelectionProxyModel.html" title="A proxy model used to reference count selected Akonadi::Collection in a view.">SelectionProxyModel</a> may be used in a view, or further processed with other proxy models. Typically, the result from this model will be further filtered to remove collections from the item list as in the above example.</p>
<p>There are several advantages of using <a class="el" href="classAkonadi_1_1EntityTreeModel.html" title="A model for collections and items together.">EntityTreeModel</a> with the <a class="el" href="classAkonadi_1_1SelectionProxyModel.html" title="A proxy model used to reference count selected Akonadi::Collection in a view.">SelectionProxyModel</a>, namely the items can be fetched and cached instead of being fetched many times, and the chain of proxies from the core model to the view is automatically handled. There is no need to manage all the mapToSource and mapFromSource calls manually.</p>
<p>A KDescendantsProxyModel can be used to represent all descendants of a model as a flat list. For example, to show all descendant items in a selected <a class="el" href="classAkonadi_1_1Collection.html" title="Represents a collection of PIM items.">Collection</a> in a list: </p>
<div class="fragment"><div class="line">collectionTree = <span class="keyword">new</span> EntityMimeTypeFilterModel( <span class="keyword">this</span> );</div>
<div class="line">collectionTree->setSourceModel( entityTreeModel );</div>
<div class="line"></div>
<div class="line"><span class="comment">// Include only collections in this proxy model.</span></div>
<div class="line">collectionTree->addMimeTypeInclusionFilter( <a class="code" href="classAkonadi_1_1Collection.html#a0fbb1e4f3bf84fe061873c1813ec857e" title="Returns the mimetype used for collections.">Collection::mimeType</a>() );</div>
<div class="line">collectionTree->setHeaderGroup( <a class="code" href="classAkonadi_1_1EntityTreeModel.html#a78fb18875ea3f23e4765ce67f6546bcda5ab957ade511bcaa9ca49c91454ac9b5" title="Header information for a collection-only tree.">EntityTreeModel::CollectionTreeHeaders</a> );</div>
<div class="line"></div>
<div class="line">treeview->setModel( collectionTree );</div>
<div class="line"></div>
<div class="line">SelectionProxyModel *selProxy = <span class="keyword">new</span> SelectionProxyModel( treeview->selectionModel(), this );</div>
<div class="line">selProxy->setSourceModel( entityTreeModel );</div>
<div class="line"></div>
<div class="line">descendedList = <span class="keyword">new</span> DescendantEntitiesProxyModel( <span class="keyword">this</span> );</div>
<div class="line">descendedList->setSourceModel( selProxy );</div>
<div class="line"></div>
<div class="line">itemList = <span class="keyword">new</span> EntityMimeTypeFilterModel( <span class="keyword">this</span> );</div>
<div class="line">itemList->setSourceModel( descendedList );</div>
<div class="line"></div>
<div class="line"><span class="comment">// Exclude collections from the list view.</span></div>
<div class="line">itemList->addMimeTypeExclusionFilter( <a class="code" href="classAkonadi_1_1Collection.html#a0fbb1e4f3bf84fe061873c1813ec857e" title="Returns the mimetype used for collections.">Collection::mimeType</a>() );</div>
<div class="line">itemList->setHeaderGroup( <a class="code" href="classAkonadi_1_1EntityTreeModel.html#a78fb18875ea3f23e4765ce67f6546bcda7efbbe3fbde0ab13401e0180a41d0a30" title="Header information for a list of items.">EntityTreeModel::ItemListHeaders</a> );</div>
<div class="line"></div>
<div class="line">listView = <span class="keyword">new</span> EntityTreeView( <span class="keyword">this</span> );</div>
<div class="line">listView->setModel( itemList );</div>
</div><!-- fragment --><p>Note that it is important in this case to use the DescendantEntitesProxyModel before the <a class="el" href="classAkonadi_1_1EntityMimeTypeFilterModel.html" title="A proxy model that filters entities by mime type.">EntityMimeTypeFilterModel</a>. Otherwise, by filtering out the collections first, you would also be filtering out their child items.</p>
<p>This pattern is used in KAddressBook.</p>
<p>It would not make sense to use a KDescendantsProxyModel with LazyPopulation.</p>
<h3>Subclassing <a class="el" href="classAkonadi_1_1EntityTreeModel.html" title="A model for collections and items together.">EntityTreeModel</a></h3>
<p>Usually an application will create a subclass of an <a class="el" href="classAkonadi_1_1EntityTreeModel.html" title="A model for collections and items together.">EntityTreeModel</a> and use that in several views via proxy models.</p>
<p>The subclassing is necessary in order for the data in the model to have type-specific representation in applications</p>
<p>For example, the headerData for an <a class="el" href="classAkonadi_1_1EntityTreeModel.html" title="A model for collections and items together.">EntityTreeModel</a> will be different depending on whether it is in a view showing only Collections in which case the header data should be "AddressBooks" for example, or only Items, in which case the headerData would be for example "Family Name", "Given Name" and "Email addres" for contacts or "Subject", "Sender", "Date" in the case of emails.</p>
<p>Additionally, the actual data shown in the rows of the model should be type specific.</p>
<p>In summary, it must be possible to have different numbers of columns, different data in hte rows of those columns, and different titles for each column depending on the contents of the view.</p>
<p>The way this is accomplished is by using the <a class="el" href="classAkonadi_1_1EntityMimeTypeFilterModel.html" title="A proxy model that filters entities by mime type.">EntityMimeTypeFilterModel</a> for splitting the model into a "CollectionTree" and an "Item List" as in the above example, and using a type-specific <a class="el" href="classAkonadi_1_1EntityTreeModel.html" title="A model for collections and items together.">EntityTreeModel</a> subclass to return the type-specific data, typically for only one type (for example, contacts or emails).</p>
<p>The following protected virtual methods should be implemented in the subclass:</p>
<ul>
<li>int entityColumnCount( HeaderGroup headerGroup ) const; – Implement to return the number of columns for a HeaderGroup. If the HeaderGroup is CollectionTreeHeaders, return the number of columns to display for the <a class="el" href="classAkonadi_1_1Collection.html" title="Represents a collection of PIM items.">Collection</a> tree, and if it is ItemListHeaders, return the number of columns to display for the item. In the case of addressee, this could be for example, two (for given name and family name) or for emails it could be three (for subject, sender, date). This is a decision of the subclass implementor.</li>
<li>QVariant <a class="el" href="classAkonadi_1_1EntityTreeModel.html#a4214db2f9e902694112fc42bf498ed08" title="Reimplement this to provide different header data.">entityHeaderData( int section, Qt::Orientation orientation, int role, HeaderGroup headerGroup ) const</a>; – Implement to return the data for each section for a HeaderGroup. For example, if the header group is CollectionTreeHeaders in a contacts model, the string "Address books" might be returned for column 0, whereas if the headerGroup is ItemListHeaders, the strings "Given Name", "Family Name", "Email Address" might be returned for the columns 0, 1, and 2.</li>
<li>QVariant entityData( const <a class="el" href="classAkonadi_1_1Collection.html" title="Represents a collection of PIM items.">Collection</a> &collection, int column, int role = Qt::DisplayRole ) const; – Implement to return data for a particular <a class="el" href="classAkonadi_1_1Collection.html" title="Represents a collection of PIM items.">Collection</a>. Typically this will be the name of the collection or the <a class="el" href="classAkonadi_1_1EntityDisplayAttribute.html" title="Attribute that stores the properties that are used to display an entity.">EntityDisplayAttribute</a>.</li>
<li>QVariant entityData( const <a class="el" href="classAkonadi_1_1Item.html" title="Represents a PIM item stored in Akonadi storage.">Item</a> &item, int column, int role = Qt::DisplayRole ) const; – Implement to return the data for a particular item and column. In the case of email for example, this would be the actual subject, sender and date of the email.</li>
</ul>
<dl class="section note"><dt>Note</dt><dd>The entityData methods are just for convenience. the QAbstractItemMOdel::data method can be overridden if required.</dd></dl>
<p>The application writer must then properly configure proxy models for the views, so that the correct data is shown in the correct view. That is the purpose of these lines in the above example</p>
<div class="fragment"><div class="line">collectionTree->setHeaderGroup( <a class="code" href="classAkonadi_1_1EntityTreeModel.html#a78fb18875ea3f23e4765ce67f6546bcda5ab957ade511bcaa9ca49c91454ac9b5" title="Header information for a collection-only tree.">EntityTreeModel::CollectionTreeHeaders</a> );</div>
<div class="line">itemList->setHeaderGroup( <a class="code" href="classAkonadi_1_1EntityTreeModel.html#a78fb18875ea3f23e4765ce67f6546bcda7efbbe3fbde0ab13401e0180a41d0a30" title="Header information for a list of items.">EntityTreeModel::ItemListHeaders</a> );</div>
</div><!-- fragment --><h3>Progress reporting</h3>
<p>The <a class="el" href="classAkonadi_1_1EntityTreeModel.html" title="A model for collections and items together.">EntityTreeModel</a> uses asynchronous <a class="el" href="classAkonadi_1_1Job.html" title="Base class for all actions in the Akonadi storage.">Akonadi::Job</a> instances to fill and update itself. For example, a job is run to fetch the contents of collections (that is, list the items in it). Additionally, individual Akonadi::Items can be fetched in different parts at different times.</p>
<p>To indicate that such a job is underway, the <a class="el" href="classAkonadi_1_1EntityTreeModel.html" title="A model for collections and items together.">EntityTreeModel</a> makes the FetchState available. The FetchState returned from a QModelIndex representing a <a class="el" href="classAkonadi_1_1Collection.html" title="Represents a collection of PIM items.">Akonadi::Collection</a> will be FetchingState if a listing of the items in that collection is underway, otherwise the state is IdleState.</p>
<dl class="section author"><dt>Author</dt><dd>Stephen Kelly <a href="#" onclick="location.href='mai'+'lto:'+'ste'+'ve'+'ire'+'@g'+'mai'+'l.'+'com'; return false;">steve<span style="display: none;">.nosp@m.</span>ire@<span style="display: none;">.nosp@m.</span>gmail<span style="display: none;">.nosp@m.</span>.com</a> </dd></dl>
<dl class="section since"><dt>Since</dt><dd>4.4 </dd></dl>
<p>Definition at line <a class="el" href="entitytreemodel_8h_source.html#l00317">317</a> of file <a class="el" href="entitytreemodel_8h_source.html">entitytreemodel.h</a>.</p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="aaf514b1eeffd1c08e01555cc14edb072"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classAkonadi_1_1EntityTreeModel.html#aaf514b1eeffd1c08e01555cc14edb072">Akonadi::EntityTreeModel::CollectionFetchStrategy</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Describes what collections shall be fetched by and represent in the model. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="aaf514b1eeffd1c08e01555cc14edb072a06ed9692fd27d881c022ac6edbae9b50"></a>FetchNoCollections</em> </td><td class="fielddoc">
<p>Fetches nothing. This creates an empty model. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="aaf514b1eeffd1c08e01555cc14edb072a613cfcdb511722448bc7fb5c8ff34279"></a>FetchFirstLevelChildCollections</em> </td><td class="fielddoc">
<p>Fetches first level collections in the root collection. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="aaf514b1eeffd1c08e01555cc14edb072a77eef9309fe7dee5bb207bcd5f006032"></a>FetchCollectionsRecursive</em> </td><td class="fielddoc">
<p>Fetches collections in the root collection recursively. This is the default. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="aaf514b1eeffd1c08e01555cc14edb072a0797046b326fb5117173a71c51662798"></a>InvisibleCollectionFetch</em> </td><td class="fielddoc">
<p>Fetches collections, but does not put them in the model. This can be used to create a list of items in all collections. The ParentCollectionRole can still be used to retrieve the parent collection of an <a class="el" href="classAkonadi_1_1Item.html" title="Represents a PIM item stored in Akonadi storage.">Item</a>. </p>
<dl class="section since"><dt>Since</dt><dd>4.5 </dd></dl>
</td></tr>
</table>
<p>Definition at line <a class="el" href="entitytreemodel_8h_source.html#l00487">487</a> of file <a class="el" href="entitytreemodel_8h_source.html">entitytreemodel.h</a>.</p>
</div>
</div>
<a class="anchor" id="a59d6be7b54f9c45eba7aa448d07ccbf2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classAkonadi_1_1EntityTreeModel.html#a59d6be7b54f9c45eba7aa448d07ccbf2">Akonadi::EntityTreeModel::FetchState</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Describes the state of fetch jobs related to particular collections. </p>
<div class="fragment"><div class="line">QModelIndex collectionIndex = getIndex();</div>
<div class="line"><span class="keywordflow">if</span> (collectionIndex.data(<a class="code" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2af014549388a46d8bd005d9f44d10c095" title="Returns the FetchState of a particular item.">EntityTreeModel::FetchStateRole</a>).toLongLong() == <a class="code" href="classAkonadi_1_1EntityTreeModel.html#a59d6be7b54f9c45eba7aa448d07ccbf2a012aa97f135a4be70aa20c5444fef918" title="There is a fetch of items in this collection in progress.">FetchingState</a>) {</div>
<div class="line"> <span class="comment">// There is a fetch underway</span></div>
<div class="line">} <span class="keywordflow">else</span> {</div>
<div class="line"> <span class="comment">// There is no fetch underway.</span></div>
<div class="line">}</div>
</div><!-- fragment --><dl class="section since"><dt>Since</dt><dd>4.5 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a59d6be7b54f9c45eba7aa448d07ccbf2ab75b8dccd52a67f2ad1b46d53464100b"></a>IdleState</em> </td><td class="fielddoc">
<p>There is no fetch of items in this collection in progress. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a59d6be7b54f9c45eba7aa448d07ccbf2a012aa97f135a4be70aa20c5444fef918"></a>FetchingState</em> </td><td class="fielddoc">
<p>There is a fetch of items in this collection in progress. </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="entitytreemodel_8h_source.html#l00372">372</a> of file <a class="el" href="entitytreemodel_8h_source.html">entitytreemodel.h</a>.</p>
</div>
</div>
<a class="anchor" id="a78fb18875ea3f23e4765ce67f6546bcd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classAkonadi_1_1EntityTreeModel.html#a78fb18875ea3f23e4765ce67f6546bcd">Akonadi::EntityTreeModel::HeaderGroup</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Describes what header information the model shall return. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a78fb18875ea3f23e4765ce67f6546bcdab968be3ac0c10f1c57d5bd995217800b"></a>EntityTreeHeaders</em> </td><td class="fielddoc">
<p>Header information for a tree with collections and items. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a78fb18875ea3f23e4765ce67f6546bcda5ab957ade511bcaa9ca49c91454ac9b5"></a>CollectionTreeHeaders</em> </td><td class="fielddoc">
<p>Header information for a collection-only tree. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a78fb18875ea3f23e4765ce67f6546bcda7efbbe3fbde0ab13401e0180a41d0a30"></a>ItemListHeaders</em> </td><td class="fielddoc">
<p>Header information for a list of items. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a78fb18875ea3f23e4765ce67f6546bcda6ff58406034ab6be01c5320c70dd9226"></a>UserHeaders</em> </td><td class="fielddoc">
<p>Last header information for submodel extensions. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a78fb18875ea3f23e4765ce67f6546bcda774e4e46ab585839aa8dc6dccf09ad98"></a>EndHeaderGroup</em> </td><td class="fielddoc">
<p>Last headergroup role. Don't use a role beyond this or headerData will break. </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="entitytreemodel_8h_source.html#l00381">381</a> of file <a class="el" href="entitytreemodel_8h_source.html">entitytreemodel.h</a>.</p>
</div>
</div>
<a class="anchor" id="a24c3ee01a13dd66eed4521a3519dad06"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classAkonadi_1_1EntityTreeModel.html#a24c3ee01a13dd66eed4521a3519dad06">Akonadi::EntityTreeModel::ItemPopulationStrategy</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Describes how the model should populated its items. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a24c3ee01a13dd66eed4521a3519dad06ae76372ae0607f73b95a1b3059234bea3"></a>NoItemPopulation</em> </td><td class="fielddoc">
<p>Do not include items in the model. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a24c3ee01a13dd66eed4521a3519dad06a3d17a5381d995654b0a944d6b09a2fd5"></a>ImmediatePopulation</em> </td><td class="fielddoc">
<p>Retrieve items immediately when their parent is in the model. This is the default. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a24c3ee01a13dd66eed4521a3519dad06af342ba6a74929a6abce70b70a51764f2"></a>LazyPopulation</em> </td><td class="fielddoc">
<p>Fetch items only when requested (using canFetchMore/fetchMore) </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="entitytreemodel_8h_source.html#l00406">406</a> of file <a class="el" href="entitytreemodel_8h_source.html">entitytreemodel.h</a>.</p>
</div>
</div>
<a class="anchor" id="afb2cc4f8ecf57b3db2ef56068e7223c2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2">Akonadi::EntityTreeModel::Roles</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Describes the roles for items. </p>
<p>Roles for collections are defined by the superclass. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="afb2cc4f8ecf57b3db2ef56068e7223c2a02fefb9d2b8dfae91eaf617d933e048a"></a>ItemIdRole</em> </td><td class="fielddoc">
<p>The item id. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afb2cc4f8ecf57b3db2ef56068e7223c2a38e48c0690b5a932e20b0ba804418c7c"></a>ItemRole</em> </td><td class="fielddoc">
<p>The <a class="el" href="classAkonadi_1_1Item.html" title="Represents a PIM item stored in Akonadi storage.">Item</a>. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afb2cc4f8ecf57b3db2ef56068e7223c2ae8195c8a8aeb2ae1615d8d8b46a9cd24"></a>MimeTypeRole</em> </td><td class="fielddoc">
<p>The mimetype of the entity. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afb2cc4f8ecf57b3db2ef56068e7223c2ababfe9216edd5f66ec3a7e105a3e003f"></a>CollectionIdRole</em> </td><td class="fielddoc">
<p>The collection id. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afb2cc4f8ecf57b3db2ef56068e7223c2aac18752d89491b2cfd0d5db6718abf78"></a>CollectionRole</em> </td><td class="fielddoc">
<p>The collection. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afb2cc4f8ecf57b3db2ef56068e7223c2a6e9e4da9e2e402c4370efa7385fd6d7a"></a>RemoteIdRole</em> </td><td class="fielddoc">
<p>The remoteId of the entity. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afb2cc4f8ecf57b3db2ef56068e7223c2ae9b9cc0435b0ea7311c0d52b06b40d14"></a>CollectionChildOrderRole</em> </td><td class="fielddoc">
<p>Ordered list of child items if available. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afb2cc4f8ecf57b3db2ef56068e7223c2a8ce2682b2090f19007ad7445728a0c25"></a>AmazingCompletionRole</em> </td><td class="fielddoc">
<p>Role used to implement amazing completion. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afb2cc4f8ecf57b3db2ef56068e7223c2a339c6dad6c0444619389b7625204837f"></a>ParentCollectionRole</em> </td><td class="fielddoc">
<p>The parent collection of the entity. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afb2cc4f8ecf57b3db2ef56068e7223c2afb326adddd9002afafd281993dd4fb5f"></a>ColumnCountRole</em> </td><td class="fielddoc">
<p>Used by proxies to determine the number of columns for a header group. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afb2cc4f8ecf57b3db2ef56068e7223c2a618c231feb5925e20c88d5318aedc306"></a>LoadedPartsRole</em> </td><td class="fielddoc">
<p>Parts available in the model for the item. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afb2cc4f8ecf57b3db2ef56068e7223c2a1675206bdeeccc71f2e8b316bc0f193b"></a>AvailablePartsRole</em> </td><td class="fielddoc">
<p>Parts available in the <a class="el" href="namespaceAkonadi.html" title="FreeBusyManager::Singleton.">Akonadi</a> server for the item. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afb2cc4f8ecf57b3db2ef56068e7223c2a7999f3f2631114d548b342a091a4a4cb"></a>SessionRole</em> </td><td class="fielddoc">
<p>The <a class="el" href="classAkonadi_1_1Session.html" title="A communication session with the Akonadi storage.">Session</a> used by this model </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afb2cc4f8ecf57b3db2ef56068e7223c2ad6fd518c05a98611a4aa7e70fba36f1c"></a>CollectionRefRole</em> </td><td class="fielddoc">
<p>Used to increase the reference count on a <a class="el" href="classAkonadi_1_1Collection.html" title="Represents a collection of PIM items.">Collection</a> </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afb2cc4f8ecf57b3db2ef56068e7223c2a67e72f7da5cb5df42a412f12a7ecd978"></a>CollectionDerefRole</em> </td><td class="fielddoc">
<p>Used to decrease the reference count on a <a class="el" href="classAkonadi_1_1Collection.html" title="Represents a collection of PIM items.">Collection</a> </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afb2cc4f8ecf57b3db2ef56068e7223c2ac83d5987830741d9bb93a6325f221c97"></a>PendingCutRole</em> </td><td class="fielddoc">
<p>Used to indicate items which are to be cut </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afb2cc4f8ecf57b3db2ef56068e7223c2ab5917e94a8e18acbb0d02d2c81422c5c"></a>EntityUrlRole</em> </td><td class="fielddoc">
<p>The akonadi:/ Url of the entity as a string. <a class="el" href="classAkonadi_1_1Item.html" title="Represents a PIM item stored in Akonadi storage.">Item</a> urls will contain the mimetype. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afb2cc4f8ecf57b3db2ef56068e7223c2acff6114ff533562bcbfcee683000ee04"></a>UnreadCountRole</em> </td><td class="fielddoc">
<p>Returns the number of unread items in a collection. </p>
<dl class="section since"><dt>Since</dt><dd>4.5 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afb2cc4f8ecf57b3db2ef56068e7223c2af014549388a46d8bd005d9f44d10c095"></a>FetchStateRole</em> </td><td class="fielddoc">
<p>Returns the FetchState of a particular item. </p>
<dl class="section since"><dt>Since</dt><dd>4.5 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afb2cc4f8ecf57b3db2ef56068e7223c2aa7a80e3838d47128ffdaa609bdf0750f"></a>CollectionSyncProgressRole</em> </td><td class="fielddoc">
<p>Returns the progress of synchronization in percent for a particular collection. </p>
<dl class="section since"><dt>Since</dt><dd>4.6 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afb2cc4f8ecf57b3db2ef56068e7223c2adb59744862d276c2c293104b267d13f5"></a>IsPopulatedRole</em> </td><td class="fielddoc">
<p>Returns whether a <a class="el" href="classAkonadi_1_1Collection.html" title="Represents a collection of PIM items.">Collection</a> has been populated, i.e. whether its items have been fetched. </p>
<dl class="section since"><dt>Since</dt><dd>4.10 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afb2cc4f8ecf57b3db2ef56068e7223c2aa50c2c35488fe2317a7f85c64ad4d785"></a>UserRole</em> </td><td class="fielddoc">
<p>First role for user extensions. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afb2cc4f8ecf57b3db2ef56068e7223c2a44c9568a0b33403682ed7b95731f289b"></a>TerminalUserRole</em> </td><td class="fielddoc">
<p>Last role for user extensions. Don't use a role beyond this or headerData will break. </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="entitytreemodel_8h_source.html#l00325">325</a> of file <a class="el" href="entitytreemodel_8h_source.html">entitytreemodel.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="ab105bb398739eca63df5aac3a735bebd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">EntityTreeModel::EntityTreeModel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classAkonadi_1_1ChangeRecorder.html">ChangeRecorder</a> * </td>
<td class="paramname"><em>monitor</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QObject * </td>
<td class="paramname"><em>parent</em> = <code>0</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">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new entity tree model. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">monitor</td><td>The <a class="el" href="classAkonadi_1_1ChangeRecorder.html" title="Records and replays change notification.">ChangeRecorder</a> whose entities should be represented in the model. </td></tr>
<tr><td class="paramname">parent</td><td>The parent object. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="entitytreemodel_8cpp_source.html#l00055">55</a> of file <a class="el" href="entitytreemodel_8cpp_source.html">entitytreemodel.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a777bb33900021025308e7ced26a2c42a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">EntityTreeModel::~EntityTreeModel </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>Destroys the entity tree model. </p>
<p>Definition at line <a class="el" href="entitytreemodel_8cpp_source.html#l00074">74</a> of file <a class="el" href="entitytreemodel_8cpp_source.html">entitytreemodel.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a471b8c4c6ca58bd46fd1a70f5906ffe2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void EntityTreeModel::clearAndReset </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>Clears and resets the model. </p>
<p>Always call this instead of the reset method in the superclass. Using the reset method will not reliably clear or refill the model. </p>
<p>Definition at line <a class="el" href="entitytreemodel_8cpp_source.html#l00119">119</a> of file <a class="el" href="entitytreemodel_8cpp_source.html">entitytreemodel.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9b8d56111224a0ce439c3d8cc659c42e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Akonadi::EntityTreeModel::collectionFetched </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>collectionId</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 once a collection has been fetched for the very first time. </p>
<p>This is like a dataChanged(), but specific to the initial loading, in order to update the GUI (window caption, state of actions). Usually, the GUI uses <a class="el" href="classAkonadi_1_1Monitor.html" title="Monitors an item or collection for changes.">Akonadi::Monitor</a> to be notified of further changes to the collections. </p>
<dl class="section since"><dt>Since</dt><dd>4.9.3 </dd></dl>
</div>
</div>
<a class="anchor" id="a42273018c0b64912a971e9f68bc51570"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#aaf514b1eeffd1c08e01555cc14edb072">EntityTreeModel::CollectionFetchStrategy</a> EntityTreeModel::collectionFetchStrategy </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the collection fetch strategy of the model. </p>
<p>Definition at line <a class="el" href="entitytreemodel_8cpp_source.html#l01163">1163</a> of file <a class="el" href="entitytreemodel_8cpp_source.html">entitytreemodel.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac94dc517423372ea39b22279472f0f67"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Akonadi::EntityTreeModel::collectionPopulated </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classAkonadi_1_1Entity.html#af2be5f7f801231641bfff0e2ae9f686f">Akonadi::Collection::Id</a> </td>
<td class="paramname"><em>collectionId</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>Signal emitted when a collection has been populated, i.e. </p>
<p>its items have been fetched. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">collectionId</td><td>id of the collection which has been populated</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classAkonadi_1_1EntityTreeModel.html#a3512513e1fb86ce0b226fa95728f7658" title="Signal emitted when the collection tree has been fetched for the first time.">collectionTreeFetched</a> </dd></dl>
<dl class="section since"><dt>Since</dt><dd>4.10 </dd></dl>
</div>
</div>
<a class="anchor" id="a3512513e1fb86ce0b226fa95728f7658"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Akonadi::EntityTreeModel::collectionTreeFetched </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classAkonadi_1_1Collection.html#a5ba0681ec86428cf5f5d3a1610ff6ad1">Akonadi::Collection::List</a> & </td>
<td class="paramname"><em>collections</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>Signal emitted when the collection tree has been fetched for the first time. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">collections</td><td>list of collections which have been fetched</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classAkonadi_1_1EntityTreeModel.html#a6556915c2836499793d08c18d2a56178" title="Returns whether the collection tree has been fetched at initialisation.">isCollectionTreeFetched</a>, <a class="el" href="classAkonadi_1_1EntityTreeModel.html#ac94dc517423372ea39b22279472f0f67" title="Signal emitted when a collection has been populated, i.e.">collectionPopulated</a> </dd></dl>
<dl class="section since"><dt>Since</dt><dd>4.10 </dd></dl>
</div>
</div>
<a class="anchor" id="af238a75f4f0f75e3934e266ab4b1e184"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QVariant EntityTreeModel::entityData </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classAkonadi_1_1Item.html">Item</a> & </td>
<td class="paramname"><em>item</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>column</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>role</em> = <code>Qt::DisplayRole</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</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>Provided for convenience of subclasses. </p>
<p>Definition at line <a class="el" href="entitytreemodel_8cpp_source.html#l00138">138</a> of file <a class="el" href="entitytreemodel_8cpp_source.html">entitytreemodel.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad40585156bc33e4787c5485a65894481"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QVariant EntityTreeModel::entityData </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classAkonadi_1_1Collection.html">Collection</a> & </td>
<td class="paramname"><em>collection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>column</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>role</em> = <code>Qt::DisplayRole</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</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>Provided for convenience of subclasses. </p>
<p>Definition at line <a class="el" href="entitytreemodel_8cpp_source.html#l00168">168</a> of file <a class="el" href="entitytreemodel_8cpp_source.html">entitytreemodel.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4214db2f9e902694112fc42bf498ed08"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QVariant EntityTreeModel::entityHeaderData </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>section</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Qt::Orientation </td>
<td class="paramname"><em>orientation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>role</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#a78fb18875ea3f23e4765ce67f6546bcd">HeaderGroup</a> </td>
<td class="paramname"><em>headerGroup</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</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>Reimplement this to provide different header data. </p>
<p>This is needed when using one model with multiple proxies and views, and each should show different header data. </p>
<p>Definition at line <a class="el" href="entitytreemodel_8cpp_source.html#l00703">703</a> of file <a class="el" href="entitytreemodel_8cpp_source.html">entitytreemodel.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="abb8b056108b017b97db76b3f5de52237"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool EntityTreeModel::entityMatch </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classAkonadi_1_1Item.html">Item</a> & </td>
<td class="paramname"><em>item</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QVariant & </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Qt::MatchFlags </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</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>Reimplement this in a subclass to return true if <code>item</code> matches <code>value</code> with <code>flags</code> in the AmazingCompletionRole. </p>
<p>Definition at line <a class="el" href="entitytreemodel_8cpp_source.html#l00934">934</a> of file <a class="el" href="entitytreemodel_8cpp_source.html">entitytreemodel.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aefc9f8d5d6e8a0c2dc90d503f594a9f8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool EntityTreeModel::entityMatch </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classAkonadi_1_1Collection.html">Collection</a> & </td>
<td class="paramname"><em>collection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QVariant & </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Qt::MatchFlags </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</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>Reimplement this in a subclass to return true if <code>collection</code> matches <code>value</code> with <code>flags</code> in the AmazingCompletionRole. </p>
<p>Definition at line <a class="el" href="entitytreemodel_8cpp_source.html#l00942">942</a> of file <a class="el" href="entitytreemodel_8cpp_source.html">entitytreemodel.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="abeb4419c518dafbf2ebccdbe891955d4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool EntityTreeModel::includeRootCollection </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns whether the root collection is provided by the model. </p>
<p>Definition at line <a class="el" href="entitytreemodel_8cpp_source.html#l01119">1119</a> of file <a class="el" href="entitytreemodel_8cpp_source.html">entitytreemodel.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a7db8b3ef8a9818ebc8e604810d9c3bcf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool EntityTreeModel::includeUnsubscribed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns whether unsubscribed entities will be included in the listing. </p>
<dl class="section since"><dt>Since</dt><dd>4.5 </dd></dl>
<p>Definition at line <a class="el" href="entitytreemodel_8cpp_source.html#l00091">91</a> of file <a class="el" href="entitytreemodel_8cpp_source.html">entitytreemodel.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6556915c2836499793d08c18d2a56178"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool EntityTreeModel::isCollectionTreeFetched </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns whether the collection tree has been fetched at initialisation. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classAkonadi_1_1EntityTreeModel.html#a3512513e1fb86ce0b226fa95728f7658" title="Signal emitted when the collection tree has been fetched for the first time.">collectionTreeFetched</a> </dd></dl>
<dl class="section since"><dt>Since</dt><dd>4.10 </dd></dl>
<p>Definition at line <a class="el" href="entitytreemodel_8cpp_source.html#l00927">927</a> of file <a class="el" href="entitytreemodel_8cpp_source.html">entitytreemodel.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="acd9334dc6ed936f3f125c2d080df7063"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#a24c3ee01a13dd66eed4521a3519dad06">EntityTreeModel::ItemPopulationStrategy</a> EntityTreeModel::itemPopulationStrategy </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the item population strategy of the model. </p>
<p>Definition at line <a class="el" href="entitytreemodel_8cpp_source.html#l01105">1105</a> of file <a class="el" href="entitytreemodel_8cpp_source.html">entitytreemodel.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae1835c6fed6d514c3de7ddf73e888d0b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QModelIndexList EntityTreeModel::match </td>
<td>(</td>
<td class="paramtype">const QModelIndex & </td>
<td class="paramname"><em>start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>role</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QVariant & </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>hits</em> = <code>1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Qt::MatchFlags </td>
<td class="paramname"><em>flags</em> = <code>Qt::MatchFlags( Qt::MatchStartsWith | Qt::MatchWrap )</code> </td>
</tr>
<tr>
<td></td>
<td>)</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>Reimplemented to handle the AmazingCompletionRole. </p>
<p>Definition at line <a class="el" href="entitytreemodel_8cpp_source.html#l00950">950</a> of file <a class="el" href="entitytreemodel_8cpp_source.html">entitytreemodel.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae23d286ab95beec54354e849bf506a90"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QModelIndexList EntityTreeModel::modelIndexesForItem </td>
<td>(</td>
<td class="paramtype">const QAbstractItemModel * </td>
<td class="paramname"><em>model</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classAkonadi_1_1Item.html">Item</a> & </td>
<td class="paramname"><em>item</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a QModelIndex in <code>model</code> which points to <code>item</code>. </p>
<p>This method can be used through proxy models if <code>model</code> is a proxy model.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classAkonadi_1_1EntityTreeModel.html#aed2e03092e9d43e2f41a1c6547406489" title="Returns a QModelIndex in model which points to collection.">modelIndexForCollection</a> </dd></dl>
<dl class="section since"><dt>Since</dt><dd>4.5 </dd></dl>
<p>Definition at line <a class="el" href="entitytreemodel_8cpp_source.html#l01201">1201</a> of file <a class="el" href="entitytreemodel_8cpp_source.html">entitytreemodel.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aed2e03092e9d43e2f41a1c6547406489"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QModelIndex EntityTreeModel::modelIndexForCollection </td>
<td>(</td>
<td class="paramtype">const QAbstractItemModel * </td>
<td class="paramname"><em>model</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classAkonadi_1_1Collection.html">Collection</a> & </td>
<td class="paramname"><em>collection</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a QModelIndex in <code>model</code> which points to <code>collection</code>. </p>
<p>This method can be used through proxy models if <code>model</code> is a proxy model.</p>
<div class="fragment"><div class="line"><a class="code" href="classAkonadi_1_1EntityTreeModel.html#ab105bb398739eca63df5aac3a735bebd" title="Creates a new entity tree model.">EntityTreeModel</a> *model = getEntityTreeModel();</div>
<div class="line">QSortFilterProxyModel *proxy1 = <span class="keyword">new</span> QSortFilterProxyModel;</div>
<div class="line">proxy1->setSourceModel(model);</div>
<div class="line">QSortFilterProxyModel *proxy2 = <span class="keyword">new</span> QSortFilterProxyModel;</div>
<div class="line">proxy2->setSourceModel(proxy1);</div>
<div class="line"></div>
<div class="line">...</div>
<div class="line"></div>
<div class="line">QModelIndex idx = <a class="code" href="classAkonadi_1_1EntityTreeModel.html#aed2e03092e9d43e2f41a1c6547406489" title="Returns a QModelIndex in model which points to collection.">EntityTreeModel::modelIndexForCollection</a>(proxy2, Collection(colId));</div>
<div class="line"><span class="keywordflow">if</span> (!idx.isValid())</div>
<div class="line"> <span class="comment">// Collection with id colId is not in the proxy2.</span></div>
<div class="line"> <span class="comment">// Maybe it is filtered out if proxy 2 is only showing items? Make sure you use the correct proxy.</span></div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"></div>
<div class="line">Collection collection = idx.data( <a class="code" href="classAkonadi_1_1EntityTreeModel.html#afb2cc4f8ecf57b3db2ef56068e7223c2aac18752d89491b2cfd0d5db6718abf78" title="The collection.">EntityTreeModel::CollectionRole</a> ).value<Collection>();</div>
<div class="line"><span class="comment">// collection has the id colId, and all other attributes already fetched by the model such as name, remoteId, Akonadi::Attributes etc.</span></div>
</div><!-- fragment --><p>This can be useful for example if an id is stored in a config file and needs to be used in the application.</p>
<p>Note however, that to restore view state such as scrolling, selection and expansion of items in trees, the ETMViewStateSaver can be used for convenience.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classAkonadi_1_1EntityTreeModel.html#ae23d286ab95beec54354e849bf506a90" title="Returns a QModelIndex in model which points to item.">modelIndexesForItem</a> </dd></dl>
<dl class="section since"><dt>Since</dt><dd>4.5 </dd></dl>
<p>Definition at line <a class="el" href="entitytreemodel_8cpp_source.html#l01194">1194</a> of file <a class="el" href="entitytreemodel_8cpp_source.html">entitytreemodel.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aaa794da23daddeec92983026472f17c0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString EntityTreeModel::rootCollectionDisplayName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the display name of the root collection. </p>
<p>Definition at line <a class="el" href="entitytreemodel_8cpp_source.html#l01133">1133</a> of file <a class="el" href="entitytreemodel_8cpp_source.html">entitytreemodel.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6e7fb7f5ca6c56e939b8bbb687c1531a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void EntityTreeModel::setCollectionFetchStrategy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#aaf514b1eeffd1c08e01555cc14edb072">CollectionFetchStrategy</a> </td>
<td class="paramname"><em>strategy</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the collection fetch <code>strategy</code> of the model. </p>
<p>Definition at line <a class="el" href="entitytreemodel_8cpp_source.html#l01139">1139</a> of file <a class="el" href="entitytreemodel_8cpp_source.html">entitytreemodel.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="adc2b46206706718b14d604ec9cfa8213"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void EntityTreeModel::setIncludeRootCollection </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>include</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets whether the root collection shall be provided by the model. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classAkonadi_1_1EntityTreeModel.html#a199ca669e57bdd57e8d0dcd771e7215d" title="Sets the display name of the root collection of the model.">setRootCollectionDisplayName()</a> </dd></dl>
<p>Definition at line <a class="el" href="entitytreemodel_8cpp_source.html#l01111">1111</a> of file <a class="el" href="entitytreemodel_8cpp_source.html">entitytreemodel.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a990f47f11b1013426b821e338690557a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void EntityTreeModel::setIncludeUnsubscribed </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>show</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets whether unsubscribed entities will be included in the listing. </p>
<p>By default it's true</p>
<p>Note that it is possible to change the monitor's fetchscope directly, bypassing this method, which will lead to inconsistencies. Use this method for turning on/off listing of subscribed folders.</p>
<dl class="section since"><dt>Since</dt><dd>4.5 </dd></dl>
<p>Definition at line <a class="el" href="entitytreemodel_8cpp_source.html#l00097">97</a> of file <a class="el" href="entitytreemodel_8cpp_source.html">entitytreemodel.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="acdb3543fd0cb42e1aa92b48361971cb8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void EntityTreeModel::setItemPopulationStrategy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classAkonadi_1_1EntityTreeModel.html#a24c3ee01a13dd66eed4521a3519dad06">ItemPopulationStrategy</a> </td>
<td class="paramname"><em>strategy</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the item population <code>strategy</code> of the model. </p>
<p>Definition at line <a class="el" href="entitytreemodel_8cpp_source.html#l01078">1078</a> of file <a class="el" href="entitytreemodel_8cpp_source.html">entitytreemodel.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a199ca669e57bdd57e8d0dcd771e7215d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void EntityTreeModel::setRootCollectionDisplayName </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>Sets the display <code>name</code> of the root collection of the model. </p>
<p>The default display name is "[*]".</p>
<dl class="section note"><dt>Note</dt><dd>The display name for the root collection is only used if the root collection has been included with <a class="el" href="classAkonadi_1_1EntityTreeModel.html#adc2b46206706718b14d604ec9cfa8213" title="Sets whether the root collection shall be provided by the model.">setIncludeRootCollection()</a>. </dd></dl>
<p>Definition at line <a class="el" href="entitytreemodel_8cpp_source.html#l01125">1125</a> of file <a class="el" href="entitytreemodel_8cpp_source.html">entitytreemodel.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0f74287eb50fc2c3f771e5cf2679795e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void EntityTreeModel::setShowSystemEntities </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>show</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Some Entities are hidden in the model, but exist for internal purposes, for example, custom object directories in groupware resources. </p>
<p>They are hidden by default, but can be shown by setting <code>show</code> to true.</p>
<p>Most applications will not need to use this feature. </p>
<p>Definition at line <a class="el" href="entitytreemodel_8cpp_source.html#l00113">113</a> of file <a class="el" href="entitytreemodel_8cpp_source.html">entitytreemodel.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a03547dee565f6f37cf067c71a57120de"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool EntityTreeModel::systemEntitiesShown </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns <code>true</code> if internal system entities are shown, and <code>false</code> otherwise. </p>
<p>Definition at line <a class="el" href="entitytreemodel_8cpp_source.html#l00107">107</a> of file <a class="el" href="entitytreemodel_8cpp_source.html">entitytreemodel.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="entitytreemodel_8h_source.html">entitytreemodel.h</a></li>
<li><a class="el" href="entitytreemodel_8cpp_source.html">entitytreemodel.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:01 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>
