File: Akonadi.SelectionProxyModel.html

package info (click to toggle)
pykde4 4%3A4.14.0-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 30,864 kB
  • ctags: 18,431
  • sloc: python: 2,063; cpp: 327; makefile: 52; sh: 5
file content (222 lines) | stat: -rw-r--r-- 7,616 bytes parent folder | download | duplicates (2)
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
<?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.SelectionProxyModel</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.9 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>SelectionProxyModel Class Reference</h1>
<code>from PyKDE4.akonadi import *</code>
<p>
Inherits: <a href="../kdeui/KSelectionProxyModel.html">KSelectionProxyModel</a> &#x2192; QAbstractProxyModel &#x2192; QAbstractItemModel &#x2192; QObject<br />
Subclasses: <a href="../akonadi/Akonadi.FavoriteCollectionsModel.html">Akonadi.FavoriteCollectionsModel</a><br />
Namespace: <a href="../akonadi/Akonadi.html">Akonadi</a><br />
<h2>Detailed Description</h2>

<p>A proxy model used to reference count selected Akonadi.Collection in a view
</p>
<p>
Only selected Collections will be populated and monitored for changes. Unselected
Collections will be ignored.
</p>
<p>
This model extends KSelectionProxyModel to implement reference counting on the Collections
in an EntityTreeModel. The EntityTreeModel must use LazyPopulation to enable
SelectionProxyModel to work.
</p>
<p>
By selecting a Collection, its reference count will be increased. A Collection in the
EntityTreeModel which has a reference count of zero will ignore all signals from Monitor
about items changed, inserted, removed etc, which can be expensive operations.
</p>
<p>
Example:
</p>
<p>
<pre class="fragment">

 using namespace Akonadi;

 //                         itemView
 //                             ^
 //                             |
 //                         itemModel
 //                             |
 //                         flatModel
 //                             |
 //   collectionView --&gt; selectionModel
 //           ^                 ^
 //           |                 |
 //  collectionFilter           |
 //            \______________model

 EntityTreeModel *model = new EntityTreeModel( ... );

 // setup collection model
 EntityMimeTypeFilterModel *collectionFilter = new EntityMimeTypeFilterModel( this );
 collectionFilter-&gt;setSourceModel( model );
 collectionFilter-&gt;addMimeTypeInclusionFilter( Collection.mimeType() );
 collectionFilter-&gt;setHeaderGroup( EntityTreeModel.CollectionTreeHeaders );

 // setup collection view
 EntityTreeView *collectionView = new EntityTreeView( this );
 collectionView-&gt;setModel( collectionFilter );

 // setup selection model
 SelectionProxyModel *selectionModel = new SelectionProxyModel( collectionView-&gt;selectionModel(), this );
 selectionModel-&gt;setSourceModel( model );

 // setup item model
 KDescendantsProxyModel *flatModel = new KDescendantsProxyModel( this );
 flatModel-&gt;setSourceModel( selectionModel );

 EntityMimeTypeFilterModel *itemModel = new EntityMimeTypeFilterModel( this );
 itemModel-&gt;setSourceModel( flatModel );
 itemModel-&gt;setHeaderGroup( EntityTreeModel.ItemListHeaders );
 itemModel-&gt;addMimeTypeExclusionFilter( Collection.mimeType() );

 EntityListView *itemView = new EntityListView( this );
 itemView-&gt;setModel( itemModel );
</pre>
</p>
<p>
See libakonadi_integration "Integration in your Application" for further guidance on the use of this class.
</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>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#SelectionProxyModel">__init__</a> (self, QItemSelectionModel selectionModel, QObject parent=0)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="SelectionProxyModel"></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">QItemSelectionModel&nbsp;</td>
<td class="paramname"><em>selectionModel</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 selection proxy 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>selectionModel</em>&nbsp;</td><td> The selection model of the source view.

<tr><td></td><td valign="top"><em>parent</em>&nbsp;</td><td> The parent object.
</td></tr>
</table></dl>
<p>
</p></div></div>
</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>