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
|
<?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>KWidgetItemDelegate</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"> </div>
<h1>KWidgetItemDelegate Class Reference</h1>
<code>from PyKDE4.kdeui import *</code>
<p>
Inherits: QAbstractItemDelegate → QObject<br />
<h2>Detailed Description</h2>
<p>This class allows to create item delegates embedding simple widgets to interact
with items. For instance you can add push buttons, line edits, etc. to your delegate
and use them to modify the state of your model.
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.1
</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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KWidgetItemDelegate">__init__</a> (self, QAbstractItemView itemView, QObject parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[QEvent::Type] </td><td class="memItemRight" valign="bottom"><a class="el" href="#blockedEventTypes">blockedEventTypes</a> (self, QWidget widget)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[QWidget] </td><td class="memItemRight" valign="bottom"><a class="el" href="#createItemWidgets">createItemWidgets</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QPersistentModelIndex </td><td class="memItemRight" valign="bottom"><a class="el" href="#focusedIndex">focusedIndex</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QAbstractItemView </td><td class="memItemRight" valign="bottom"><a class="el" href="#itemView">itemView</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#paintWidgets">paintWidgets</a> (self, QPainter painter, QStyleOptionViewItem option, QPersistentModelIndex index)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setBlockedEventTypes">setBlockedEventTypes</a> (self, QWidget widget, [QEvent::Type] types)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#updateItemWidgets">updateItemWidgets</a> (self, [QWidget] widgets, QStyleOptionViewItem option, QPersistentModelIndex index)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="KWidgetItemDelegate"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QAbstractItemView </td>
<td class="paramname"><em>itemView</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QObject </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 ItemDelegate to be used with a given itemview.
</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>itemView</em> </td><td> the item view the new delegate will monitor
<tr><td></td><td valign="top"><em>parent</em> </td><td> the parent of this delegate
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="blockedEventTypes"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[QEvent::Type] blockedEventTypes</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>widget</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Retrieves the list of blocked event types for the given widget.
</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>widget</em> </td><td> the specified widget.
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the list of blocked event types, can be empty if no events are blocked.
</dd></dl>
</p></div></div><a class="anchor" name="createItemWidgets"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[QWidget] createItemWidgets</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Creates the list of widgets needed for an item.
</p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> No initialization of the widgets is supposed to happen here.
The widgets will be initialized based on needs for a given item.
</dd></dl> </p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> If you want to connect some widget signals to any slot, you should
do it here.
</dd></dl> </p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> If you want to know the index for which you are creating widgets, it is
available as a QModelIndex Q_PROPERTY called "goya:creatingWidgetsForIndex".
Ensure to add Q_DECLARE_METATYPE(QModelIndex) before your method definition
to tell QVariant about QModelIndex.
</dd></dl> </p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the list of newly created widgets which will be used to interact with an item.
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> updateItemWidgets()
</dd></dl>
</p></div></div><a class="anchor" name="focusedIndex"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QPersistentModelIndex focusedIndex</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Retrieves the currently focused index. An invalid index if none is focused.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the current focused index, or QPersistentModelIndex() if none is focused.
</dd></dl>
</p></div></div><a class="anchor" name="itemView"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QAbstractItemView itemView</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Retrieves the item view this delegate is monitoring.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the item view this delegate is monitoring
</dd></dl>
</p></div></div><a class="anchor" name="paintWidgets"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> paintWidgets</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QPainter </td>
<td class="paramname"><em>painter</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QStyleOptionViewItem </td>
<td class="paramname"><em>option</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QPersistentModelIndex </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"><p>Paint the widgets of the item. This method is meant to be used in the paint()
method of your item delegate implementation.
</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>painter</em> </td><td> the painter the widgets will be painted on.
<tr><td></td><td valign="top"><em>option</em> </td><td> the current set of style options for the view.
<tr><td></td><td valign="top"><em>index</em> </td><td> the model index of the item currently painted.
</td></tr>
</table></dl>
<p> <dl class="warning" compact><dt><b>Warning:</b></dt><dd> since 4.2 this method is not longer needed to be called. All widgets will kept
updated without the need of calling paintWidgets() in your paint() event. For the
widgets of a certain index to be updated your model has to emit dataChanged() on the
indexes that want to be updated.
</dd></dl>
</p></div></div><a class="anchor" name="setBlockedEventTypes"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setBlockedEventTypes</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>widget</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">[QEvent::Type] </td>
<td class="paramname"><em>types</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 list of event <b>types</b> that a <b>widget</b> will block.
</p>
<p>
Blocked events are not passed to the view. This way you can prevent an item
from being selected when a button is clicked for instance.
</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>widget</em> </td><td> the widget which must block events
<tr><td></td><td valign="top"><em>types</em> </td><td> the list of event types the widget must block
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="updateItemWidgets"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> updateItemWidgets</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">[QWidget] </td>
<td class="paramname"><em>widgets</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QStyleOptionViewItem </td>
<td class="paramname"><em>option</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QPersistentModelIndex </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"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Updates a list of widgets for its use inside of the delegate (painting or
event handling).
</p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> All the positioning and sizing should be done in item coordinates.
</dd></dl> </p>
<p>
<dl class="warning" compact><dt><b>Warning:</b></dt><dd> Do not make widget connections in here, since this method will
be called very regularly.
</dd></dl> </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>widgets</em> </td><td> the widgets to update
<tr><td></td><td valign="top"><em>option</em> </td><td> the current set of style options for the view.
<tr><td></td><td valign="top"><em>index</em> </td><td> the model index of the item currently manipulated.
</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="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../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>
</div></div>
</body>
</html>
|
