File: Akonadi.EntityTreeModel.html

package info (click to toggle)
pykde4 4%3A4.8.4-1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 29,376 kB
  • sloc: python: 2,056; cpp: 290; makefile: 41; sh: 5
file content (1578 lines) | stat: -rw-r--r-- 61,549 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
<?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</title>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <meta http-equiv="Content-Style-Type" content="text/css" />
  <link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
  <link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
  <div id="header_top">
    <div>
      <div>
        <img alt ="" src="../common/top-kde.jpg"/>
        KDE 4.7 PyKDE API Reference
      </div>
    </div>
  </div>
  <div id="header_bottom">
    <div id="location">
      <ul>
        <li>KDE's Python API</li>
      </ul>
    </div>

    <div id="menu">
      <ul>
        <li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
    </div>
  </div>
</div>

<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer">&nbsp;</div>

<h1>EntityTreeModel Class Reference</h1>
<code>from PyKDE4.akonadi import *</code>
<p>
Inherits: QAbstractItemModel &#x2192; QObject<br />

Namespace: <a href="../akonadi/Akonadi.html">Akonadi</a><br />
<h2>Detailed Description</h2>

<p>A model for collections and items together.
</p>
<p>
Akonadi 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>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> The EntityTreeModel should be used with the EntityTreeView or the EntityListView class
either directly or indirectly via proxy models.
</dd></dl> </p>
<p>
&lt;h3&gt;Retrieving Collections and Items from the model&lt;/h3&gt;
</p>
<p>
If you want to retrieve and Item or Collection from the model, and already have a valid
QModelIndex for the correct row, the Collection can be retrieved like this:
</p>
<p>
<pre class="fragment">
 Collection col = index.data( EntityTreeModel.CollectionRole ).value&lt;Collection&gt;();
</pre>
</p>
<p>
And similarly for Items. This works even if there is a proxy model between the calling code
and the EntityTreeModel.
</p>
<p>
If you want to retrieve a Collection for a particular Collection.Id and you do not yet
have a valid QModelIndex, use modelIndexForCollection.
</p>
<p>
&lt;h3&gt;Using EntityTreeModel in your application&lt;/h3&gt;
</p>
<p>
The responsibilities which fall to the application developer are
- Configuring the ChangeRecorder and EntityTreeModel
- Making use of this class via proxy models
- Subclassing for type specific display information
</p>
<p>
&lt;h3&gt;Creating and configuring the EntityTreeModel&lt;/h3&gt;
</p>
<p>
This class is a wrapper around a Akonadi.ChangeRecorder object. The model represents a
part of the collection and item tree configured in the ChangeRecorder. 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>
<p>
<pre class="fragment">

   ChangeRecorder *changeRecorder = new ChangeRecorder( this );
   changeRecorder-&gt;setCollectionMonitored( Collection.root() );
   changeRecorder-&gt;setMimeTypeMonitored( KABC.addresseeMimeType() );
   changeRecorder-&gt;setSession( session );

   EntityTreeModel *model = new EntityTreeModel( changeRecorder, this );

   EntityTreeView *view = new EntityTreeView( this );
   view-&gt;setModel( model );

</pre>
</p>
<p>
The EntityTreeModel will show items of a different type by changing the line
</p>
<p>
<pre class="fragment">
 changeRecorder-&gt;setMimeTypeMonitored( KABC.addresseeMimeType() );
</pre>
</p>
<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>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> The EntityTreeModel does some extra configuration on the Monitor, such as setting itemFetchScope() and collectionFetchScope()
to retrieve all ancestors. This is necessary for proper function of the model.
</dd></dl> </p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> Akonadi.ItemFetchScope.AncestorRetrieval.
</dd></dl> </p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> akonadi-mimetypes.
</dd></dl> </p>
<p>
The EntityTreeModel 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>
<p>
<pre class="fragment">
 entityTreeModel-&gt;setItemPopulationStrategy( EntityTreeModel.NoItemPopulation );
</pre>
</p>
<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 Collection tree is always built immediately if Collections are to be fetched.
</p>
<p>
<pre class="fragment">
 entityTreeModel-&gt;setItemPopulationStrategy( EntityTreeModel.LazyPopulation );
</pre>
</p>
<p>
This will typically be used with a EntityMimeTypeFilterModel 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 Collection to monitor.
</p>
<p>
<pre class="fragment">
 // Get an collection id from a config file.
 Collection.Id id;
 monitor-&gt;setCollectionMonitored( Collection( id ) );
 // ... Other initialization code.
 entityTree-&gt;setCollectionFetchStrategy( FetchNoCollections );
</pre>
</p>
<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 ItemModel.
By using FetchFirstLevelCollections instead, a mixed list of entities can be created.
</p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> It is important that you set only one Collection 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 SelectionProxyModel.
</dd></dl> </p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> lazy-model-population
</dd></dl> </p>
<p>
It is also possible to show the root Collection as part of the selectable model:
</p>
<p>
<pre class="fragment">
 entityTree-&gt;setIncludeRootCollection( true );
</pre>
</p>
<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>
<p>
<pre class="fragment">
 entityTree-&gt;setIncludeRootCollection( true );
 entityTree-&gt;setRootCollectionDisplayName( i18nc( "Name of top level for all addressbooks in the application", "[All AddressBooks]" ) )
</pre>
</p>
<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 ItemFetchScope class. By default, only the basic metadata is
fetched. To fetch all item data, including all attributes:
</p>
<p>
<pre class="fragment">
 changeRecorder-&gt;itemFetchScope().fetchFullPayload();
 changeRecorder-&gt;itemFetchScope().fetchAllAttributes();
</pre>
</p>
<p>
&lt;h2&gt;Using EntityTreeModel with Proxy models&lt;/h2&gt;
</p>
<p>
An Akonadi.SelectionProxyModel 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>
<p>
<pre class="fragment">
 // ... create an EntityTreeModel

 collectionTree = new EntityMimeTypeFilterModel( this );
 collectionTree-&gt;setSourceModel( entityTreeModel );

 // Include only collections in this proxy model.
 collectionTree-&gt;addMimeTypeInclusionFilter( Collection.mimeType() );
 collectionTree-&gt;setHeaderGroup( EntityTreeModel.CollectionTreeHeaders );

 treeview-&gt;setModel(collectionTree);

 // SelectionProxyModel can handle complex selections:
 treeview-&gt;setSelectionMode( QAbstractItemView.ExtendedSelection );

 SelectionProxyModel *selProxy = new SelectionProxyModel( treeview-&gt;selectionModel(), this );
 selProxy-&gt;setSourceModel( entityTreeModel );

 itemList = new EntityMimeTypeFilterModel( this );
 itemList-&gt;setSourceModel( selProxy );

 // Filter out collections. Show only items.
 itemList-&gt;addMimeTypeExclusionFilter( Collection.mimeType() );
 itemList-&gt;setHeaderGroup( EntityTreeModel.ItemListHeaders );

 EntityTreeView *itemView = new EntityTreeView( splitter );
 itemView-&gt;setModel( itemList );
</pre>
</p>
<p>
The SelectionProxyModel can handle complex selections.
</p>
<p>
See the KSelectionProxyModel documentation for the valid configurations of a Akonadi.SelectionProxyModel.
</p>
<p>
Obviously, the SelectionProxyModel 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 EntityTreeModel with the SelectionProxyModel, 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 Collection in a list:
<pre class="fragment">
 collectionTree = new EntityMimeTypeFilterModel( this );
 collectionTree-&gt;setSourceModel( entityTreeModel );

 // Include only collections in this proxy model.
 collectionTree-&gt;addMimeTypeInclusionFilter( Collection.mimeType() );
 collectionTree-&gt;setHeaderGroup( EntityTreeModel.CollectionTreeHeaders );

 treeview-&gt;setModel( collectionTree );

 SelectionProxyModel *selProxy = new SelectionProxyModel( treeview-&gt;selectionModel(), this );
 selProxy-&gt;setSourceModel( entityTreeModel );

 descendedList = new DescendantEntitiesProxyModel( this );
 descendedList-&gt;setSourceModel( selProxy );

 itemList = new EntityMimeTypeFilterModel( this );
 itemList-&gt;setSourceModel( descendedList );

 // Exclude collections from the list view.
 itemList-&gt;addMimeTypeExclusionFilter( Collection.mimeType() );
 itemList-&gt;setHeaderGroup( EntityTreeModel.ItemListHeaders );

 listView = new EntityTreeView( this );
 listView-&gt;setModel( itemList );
</pre>
</p>
<p>
Note that it is important in this case to use the DescendantEntitesProxyModel before the EntityMimeTypeFilterModel.
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>
<p>
&lt;h3&gt;Subclassing EntityTreeModel&lt;/h3&gt;
</p>
<p>
Usually an application will create a subclass of an EntityTreeModel 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 EntityTreeModel 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 EntityMimeTypeFilterModel for splitting the model into a "CollectionTree" and an "Item List"
as in the above example, and using a type-specific EntityTreeModel 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:
- 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
Collection 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.
- QVariant entityHeaderData( int section, Qt.Orientation orientation, int role, HeaderGroup headerGroup ) const;
-- 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.
- QVariant entityData( const Collection &amp;collection, int column, int role = Qt.DisplayRole ) const;
-- Implement to return data for a particular Collection. Typically this will be the name of the collection or the EntityDisplayAttribute.
- QVariant entityData( const Item &amp;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.
</p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> The entityData methods are just for convenience. the QAbstractItemMOdel.data method can be overridden if required.
</dd></dl> </p>
<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>
<p>
<pre class="fragment">
 collectionTree-&gt;setHeaderGroup( EntityTreeModel.CollectionTreeHeaders );
 itemList-&gt;setHeaderGroup( EntityTreeModel.ItemListHeaders );
</pre>
</p>
<p>
&lt;h3&gt;Progress reporting&lt;/h3&gt;
</p>
<p>
The EntityTreeModel uses asynchronous Akonadi.Job 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 EntityTreeModel makes the FetchState available. The
FetchState returned from a QModelIndex representing a Akonadi.Collection will be FetchingState if a
listing of the items in that collection is underway, otherwise the state is IdleState.
</p>
<p>

<dl class="author" compact><dt><b>Author:</b></dt><dd> Stephen Kelly &lt;steveire@gmail.com&gt; </dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
</dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#CollectionFetchStrategy">CollectionFetchStrategy</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;FetchNoCollections, FetchFirstLevelChildCollections, FetchCollectionsRecursive, InvisibleCollectionFetch&nbsp;}</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#FetchState">FetchState</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;IdleState, FetchingState&nbsp;}</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#HeaderGroup">HeaderGroup</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;EntityTreeHeaders, CollectionTreeHeaders, ItemListHeaders, UserHeaders, EndHeaderGroup&nbsp;}</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#ItemPopulationStrategy">ItemPopulationStrategy</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;NoItemPopulation, ImmediatePopulation, LazyPopulation&nbsp;}</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#Roles">Roles</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;ItemIdRole, ItemRole, MimeTypeRole, CollectionIdRole, CollectionRole, RemoteIdRole, CollectionChildOrderRole, AmazingCompletionRole, ParentCollectionRole, ColumnCountRole, LoadedPartsRole, AvailablePartsRole, SessionRole, CollectionRefRole, CollectionDerefRole, PendingCutRole, EntityUrlRole, UnreadCountRole, FetchStateRole, CollectionSyncProgressRole, UserRole, TerminalUserRole, EndRole&nbsp;}</td></tr>
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#EntityTreeModel">__init__</a> (self, <a href="../akonadi/Akonadi.ChangeRecorder.html">Akonadi.ChangeRecorder</a> monitor, QObject parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#canFetchMore">canFetchMore</a> (self, QModelIndex parent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#clearAndReset">clearAndReset</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../akonadi/Akonadi.EntityTreeModel.html#CollectionFetchStrategy">Akonadi.EntityTreeModel.CollectionFetchStrategy</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#collectionFetchStrategy">collectionFetchStrategy</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#columnCount">columnCount</a> (self, QModelIndex parent=QModelIndex())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QVariant&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#data">data</a> (self, QModelIndex index, int role=Qt.DisplayRole)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#dropMimeData">dropMimeData</a> (self, QMimeData data, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::DropAction</a> action, int row, int column, QModelIndex parent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#entityColumnCount">entityColumnCount</a> (self, <a href="../akonadi/Akonadi.EntityTreeModel.html#HeaderGroup">Akonadi.EntityTreeModel.HeaderGroup</a> headerGroup)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QVariant&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#entityData">entityData</a> (self, <a href="../akonadi/Akonadi.Item.html">Akonadi.Item</a> item, int column, int role=Qt.DisplayRole)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QVariant&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#entityData">entityData</a> (self, <a href="../akonadi/Akonadi.Collection.html">Akonadi.Collection</a> collection, int column, int role=Qt.DisplayRole)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QVariant&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#entityHeaderData">entityHeaderData</a> (self, int section, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::Orientation</a> orientation, int role, <a href="../akonadi/Akonadi.EntityTreeModel.html#HeaderGroup">Akonadi.EntityTreeModel.HeaderGroup</a> headerGroup)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#entityMatch">entityMatch</a> (self, <a href="../akonadi/Akonadi.Item.html">Akonadi.Item</a> item, QVariant value, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::MatchFlags</a> flags)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#entityMatch">entityMatch</a> (self, <a href="../akonadi/Akonadi.Collection.html">Akonadi.Collection</a> collection, QVariant value, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::MatchFlags</a> flags)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#fetchMore">fetchMore</a> (self, QModelIndex parent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::ItemFlags</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#flags">flags</a> (self, QModelIndex index)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#hasChildren">hasChildren</a> (self, QModelIndex parent=QModelIndex())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QVariant&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#headerData">headerData</a> (self, int section, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::Orientation</a> orientation, int role=Qt.DisplayRole)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#includeRootCollection">includeRootCollection</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#includeUnsubscribed">includeUnsubscribed</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QModelIndex&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#index">index</a> (self, int row, int column, QModelIndex parent=QModelIndex())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../akonadi/Akonadi.EntityTreeModel.html#ItemPopulationStrategy">Akonadi.EntityTreeModel.ItemPopulationStrategy</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#itemPopulationStrategy">itemPopulationStrategy</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[QModelIndex]&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#match">match</a> (self, QModelIndex start, int role, QVariant value, int hits=1, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::MatchFlags</a> flags=Qt.MatchFlags(Qt.MatchStartsWith|Qt.MatchWrap))</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QMimeData&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#mimeData">mimeData</a> (self, [QModelIndex] indexes)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#mimeTypes">mimeTypes</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QModelIndex&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#parent">parent</a> (self, QModelIndex index)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#rootCollectionDisplayName">rootCollectionDisplayName</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#rowCount">rowCount</a> (self, QModelIndex parent=QModelIndex())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#setCollectionFetchStrategy">setCollectionFetchStrategy</a> (self, <a href="../akonadi/Akonadi.EntityTreeModel.html#CollectionFetchStrategy">Akonadi.EntityTreeModel.CollectionFetchStrategy</a> strategy)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#setData">setData</a> (self, QModelIndex index, QVariant value, int role=Qt.EditRole)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#setIncludeRootCollection">setIncludeRootCollection</a> (self, bool include)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#setIncludeUnsubscribed">setIncludeUnsubscribed</a> (self, bool show)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#setItemPopulationStrategy">setItemPopulationStrategy</a> (self, <a href="../akonadi/Akonadi.EntityTreeModel.html#ItemPopulationStrategy">Akonadi.EntityTreeModel.ItemPopulationStrategy</a> strategy)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#setRootCollectionDisplayName">setRootCollectionDisplayName</a> (self, QString name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#setShowSystemEntities">setShowSystemEntities</a> (self, bool show)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::DropActions</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#supportedDropActions">supportedDropActions</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#systemEntitiesShown">systemEntitiesShown</a> (self)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QModelIndex&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#modelIndexForCollection">modelIndexForCollection</a> (QAbstractItemModel model, <a href="../akonadi/Akonadi.Collection.html">Akonadi.Collection</a> collection)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[QModelIndex]&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#modelIndexesForItem">modelIndexesForItem</a> (QAbstractItemModel model, <a href="../akonadi/Akonadi.Item.html">Akonadi.Item</a> item)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="EntityTreeModel"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../akonadi/Akonadi.ChangeRecorder.html">Akonadi.ChangeRecorder</a>&nbsp;</td>
<td class="paramname"><em>monitor</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QObject&nbsp;</td>
<td class="paramname"><em>parent=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Creates a new entity tree model.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>monitor</em>&nbsp;</td><td> The ChangeRecorder whose entities should be represented in the model.

<tr><td></td><td valign="top"><em>parent</em>&nbsp;</td><td> The parent object.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="canFetchMore"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool canFetchMore</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QModelIndex&nbsp;</td>
<td class="paramname"><em>parent</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="clearAndReset"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> clearAndReset</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Clears and resets the model. Always call this instead of the reset method in the superclass.
Using the reset method will not reliably clear or refill the model.
</p></div></div><a class="anchor" name="collectionFetchStrategy"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../akonadi/Akonadi.EntityTreeModel.html#CollectionFetchStrategy">Akonadi.EntityTreeModel.CollectionFetchStrategy</a> collectionFetchStrategy</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the collection fetch strategy of the model.
</p></div></div><a class="anchor" name="columnCount"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int columnCount</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QModelIndex&nbsp;</td>
<td class="paramname"><em>parent=QModelIndex()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="data"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QVariant data</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QModelIndex&nbsp;</td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>role=Qt.DisplayRole</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="dropMimeData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool dropMimeData</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QMimeData&nbsp;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::DropAction</a>&nbsp;</td>
<td class="paramname"><em>action</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>row</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>column</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QModelIndex&nbsp;</td>
<td class="paramname"><em>parent</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="entityColumnCount"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int entityColumnCount</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../akonadi/Akonadi.EntityTreeModel.html#HeaderGroup">Akonadi.EntityTreeModel.HeaderGroup</a>&nbsp;</td>
<td class="paramname"><em>headerGroup</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="entityData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QVariant entityData</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../akonadi/Akonadi.Item.html">Akonadi.Item</a>&nbsp;</td>
<td class="paramname"><em>item</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>column</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>role=Qt.DisplayRole</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Provided for convenience of subclasses.
</p></div></div><a class="anchor" name="entityData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QVariant entityData</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../akonadi/Akonadi.Collection.html">Akonadi.Collection</a>&nbsp;</td>
<td class="paramname"><em>collection</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>column</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>role=Qt.DisplayRole</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Provided for convenience of subclasses.
</p></div></div><a class="anchor" name="entityHeaderData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QVariant entityHeaderData</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>section</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::Orientation</a>&nbsp;</td>
<td class="paramname"><em>orientation</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>role</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../akonadi/Akonadi.EntityTreeModel.html#HeaderGroup">Akonadi.EntityTreeModel.HeaderGroup</a>&nbsp;</td>
<td class="paramname"><em>headerGroup</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Reimplement this to provide different header data. This is needed when using one model
with multiple proxies and views, and each should show different header data.
</p></div></div><a class="anchor" name="entityMatch"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool entityMatch</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../akonadi/Akonadi.Item.html">Akonadi.Item</a>&nbsp;</td>
<td class="paramname"><em>item</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QVariant&nbsp;</td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::MatchFlags</a>&nbsp;</td>
<td class="paramname"><em>flags</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Reimplement this in a subclass to return true if <b>collection</b> matches <b>value</b> with <b>flags</b> in the AmazingCompletionRole.
</p></div></div><a class="anchor" name="entityMatch"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool entityMatch</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../akonadi/Akonadi.Collection.html">Akonadi.Collection</a>&nbsp;</td>
<td class="paramname"><em>collection</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QVariant&nbsp;</td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::MatchFlags</a>&nbsp;</td>
<td class="paramname"><em>flags</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Reimplement this in a subclass to return true if <b>collection</b> matches <b>value</b> with <b>flags</b> in the AmazingCompletionRole.
</p></div></div><a class="anchor" name="fetchMore"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> fetchMore</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QModelIndex&nbsp;</td>
<td class="paramname"><em>parent</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="flags"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::ItemFlags</a> flags</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QModelIndex&nbsp;</td>
<td class="paramname"><em>index</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="hasChildren"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool hasChildren</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QModelIndex&nbsp;</td>
<td class="paramname"><em>parent=QModelIndex()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="headerData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QVariant headerData</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>section</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::Orientation</a>&nbsp;</td>
<td class="paramname"><em>orientation</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>role=Qt.DisplayRole</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="includeRootCollection"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool includeRootCollection</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns whether the root collection is provided by the model.
</p></div></div><a class="anchor" name="includeUnsubscribed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool includeUnsubscribed</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns whether unsubscribed entities will be included in the listing.
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</dd></dl>
</p></div></div><a class="anchor" name="index"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QModelIndex index</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>row</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>column</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QModelIndex&nbsp;</td>
<td class="paramname"><em>parent=QModelIndex()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="itemPopulationStrategy"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../akonadi/Akonadi.EntityTreeModel.html#ItemPopulationStrategy">Akonadi.EntityTreeModel.ItemPopulationStrategy</a> itemPopulationStrategy</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the item population strategy of the model.
</p></div></div><a class="anchor" name="match"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[QModelIndex] match</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QModelIndex&nbsp;</td>
<td class="paramname"><em>start</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>role</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QVariant&nbsp;</td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>hits=1</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::MatchFlags</a>&nbsp;</td>
<td class="paramname"><em>flags=Qt.MatchFlags(Qt.MatchStartsWith|Qt.MatchWrap)</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Reimplemented to handle the AmazingCompletionRole.
</p></div></div><a class="anchor" name="mimeData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QMimeData mimeData</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">[QModelIndex]&nbsp;</td>
<td class="paramname"><em>indexes</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="mimeTypes"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QStringList mimeTypes</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="parent"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QModelIndex parent</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QModelIndex&nbsp;</td>
<td class="paramname"><em>index</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="rootCollectionDisplayName"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString rootCollectionDisplayName</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the display name of the root collection.
</p></div></div><a class="anchor" name="rowCount"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int rowCount</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QModelIndex&nbsp;</td>
<td class="paramname"><em>parent=QModelIndex()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="setCollectionFetchStrategy"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setCollectionFetchStrategy</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../akonadi/Akonadi.EntityTreeModel.html#CollectionFetchStrategy">Akonadi.EntityTreeModel.CollectionFetchStrategy</a>&nbsp;</td>
<td class="paramname"><em>strategy</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the collection fetch <b>strategy</b> of the model.
</p></div></div><a class="anchor" name="setData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool setData</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QModelIndex&nbsp;</td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QVariant&nbsp;</td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>role=Qt.EditRole</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="setIncludeRootCollection"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setIncludeRootCollection</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"><em>include</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets whether the root collection shall be provided by the model.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> setRootCollectionDisplayName()
</dd></dl>
</p></div></div><a class="anchor" name="setIncludeUnsubscribed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setIncludeUnsubscribed</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"><em>show</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets whether unsubscribed entities will be included in the listing.
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>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</dd></dl>
</p></div></div><a class="anchor" name="setItemPopulationStrategy"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setItemPopulationStrategy</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../akonadi/Akonadi.EntityTreeModel.html#ItemPopulationStrategy">Akonadi.EntityTreeModel.ItemPopulationStrategy</a>&nbsp;</td>
<td class="paramname"><em>strategy</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the item population <b>strategy</b> of the model.
</p></div></div><a class="anchor" name="setRootCollectionDisplayName"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setRootCollectionDisplayName</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>name</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the display <b>name</b> of the root collection of the model.
The default display name is "[*]".
</p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> The display name for the root collection is only used if
the root collection has been included with setIncludeRootCollection().
</dd></dl>
</p></div></div><a class="anchor" name="setShowSystemEntities"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setShowSystemEntities</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"><em>show</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </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 <b>show</b> to true.
</p>
<p>
Most applications will not need to use this feature.
</p></div></div><a class="anchor" name="supportedDropActions"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::DropActions</a> supportedDropActions</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="systemEntitiesShown"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool systemEntitiesShown</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns true if internal system entities are shown, and false otherwise.
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="modelIndexForCollection"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QModelIndex modelIndexForCollection</td>
<td>(</td>
<td class="paramtype">QAbstractItemModel&nbsp;</td>
<td class="paramname"><em>model</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../akonadi/Akonadi.Collection.html">Akonadi.Collection</a>&nbsp;</td>
<td class="paramname"><em>collection</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns a QModelIndex in <b>model</b> which points to <b>collection.</b>
This method can be used through proxy models if <b>model</b> is a proxy model.
</p>
<p>
<pre class="fragment">
 EntityTreeModel *model = getEntityTreeModel();
 QSortFilterProxyModel *proxy1 = new QSortFilterProxyModel;
 proxy1-&gt;setSourceModel(model);
 QSortFilterProxyModel *proxy2 = new QSortFilterProxyModel;
 proxy2-&gt;setSourceModel(proxy1);

 ...

 QModelIndex idx = EntityTreeModel.modelIndexForCollection(proxy2, Collection(colId));
 if (!idx.isValid())
   // Collection with id colId is not in the proxy2.
   // Maybe it is filtered out if proxy 2 is only showing items? Make sure you use the correct proxy.
   return;

 Collection collection = idx.data( EntityTreeModel.CollectionRole ).value&lt;Collection&gt;();
 // collection has the id colId, and all other attributes already fetched by the model such as name, remoteId, Akonadi.Attributes etc.

</pre>
</p>
<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>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> modelIndexesForItem
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</dd></dl>
</p></div></div><a class="anchor" name="modelIndexesForItem"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[QModelIndex] modelIndexesForItem</td>
<td>(</td>
<td class="paramtype">QAbstractItemModel&nbsp;</td>
<td class="paramname"><em>model</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../akonadi/Akonadi.Item.html">Akonadi.Item</a>&nbsp;</td>
<td class="paramname"><em>item</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns a QModelIndex in <b>model</b> which points to <b>item.</b>
This method can be used through proxy models if <b>model</b> is a proxy model.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> modelIndexForCollection
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</dd></dl>
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="CollectionFetchStrategy"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">CollectionFetchStrategy</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Describes what collections shall be fetched by and represent in the model.
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>FetchNoCollections</em>&nbsp;</td><td><tr><td valign="top"><em>FetchFirstLevelChildCollections</em>&nbsp;</td><td><tr><td valign="top"><em>FetchCollectionsRecursive</em>&nbsp;</td><td><tr><td valign="top"><em>InvisibleCollectionFetch</em>&nbsp;</td><td></table>
</dl>
</div></div><p><a class="anchor" name="FetchState"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">FetchState</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Describes the state of fetch jobs related to particular collections.
</p>
<p>
<pre class="fragment">
   QModelIndex collectionIndex = getIndex();
   if (collectionIndex.data(EntityTreeModel.FetchStateRole).toLongLong() == FetchingState) {
     // There is a fetch underway
   } else {
     // There is no fetch underway.
   }
</pre>
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</dd></dl>
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>IdleState</em>&nbsp;</td><td><tr><td valign="top"><em>FetchingState</em>&nbsp;</td><td></table>
</dl>
</div></div><p><a class="anchor" name="HeaderGroup"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">HeaderGroup</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Describes what header information the model shall return.
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>EntityTreeHeaders</em>&nbsp;</td><td><tr><td valign="top"><em>CollectionTreeHeaders</em>&nbsp;</td><td><tr><td valign="top"><em>ItemListHeaders</em>&nbsp;</td><td><tr><td valign="top"><em>UserHeaders</em>&nbsp;=&nbsp;10</td><td><tr><td valign="top"><em>EndHeaderGroup</em>&nbsp;=&nbsp;32</td><td></table>
</dl>
</div></div><p><a class="anchor" name="ItemPopulationStrategy"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">ItemPopulationStrategy</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Describes how the model should populated its items.
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>NoItemPopulation</em>&nbsp;</td><td><tr><td valign="top"><em>ImmediatePopulation</em>&nbsp;</td><td><tr><td valign="top"><em>LazyPopulation</em>&nbsp;</td><td></table>
</dl>
</div></div><p><a class="anchor" name="Roles"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">Roles</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Describes the roles for items. Roles for collections are defined by the superclass.
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>IdRole</em>&nbsp;=&nbsp;Qt::UserRole+1</td><td><tr><td valign="top"><em>ItemRole</em>&nbsp;</td><td><tr><td valign="top"><em>MimeTypeRole</em>&nbsp;</td><td><tr><td valign="top"><em>UserRole</em>&nbsp;=&nbsp;Qt::UserRole+42</td><td></table>
</dl>
</div></div><p>
</div>
</div>
</div>

<div id="left">

<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>

<a name="cp-menu" /><div class="menutitle"><div>
  <h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>

</div>

</div>
  <div class="clearer"/>
</div>

<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="&#109;&#97;&#105;&#108;&#116;&#111;&#58;simon&#64;simonzone&#46;com">Simon Edwards</a>.<br />
        KDE<sup>&#174;</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>&#174;</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>
    </div></div>
</body>
</html>