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
|
<?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>KPageView</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"> </div>
<h1>KPageView Class Reference</h1>
<code>from PyKDE4.kdeui import *</code>
<p>
Inherits: QWidget → QObject<br />
<h2>Detailed Description</h2>
<p>A base class which can handle multiple pages.
</p>
<p>
This class provides a widget base class which handles multiple
pages and allows the user to switch between these pages in
different ways.
</p>
<p>
Currently, <b>Auto,</b> <b>Plain,</b> <b>List,</b> <b>Tree</b> and <b>Tabbed</b> face
types are available. <dl class="see" compact><dt><b>See also:</b></dt><dd> KPageWidget
</dd></dl> </p>
<p>
<b>Example:</b>\n
</p>
<p>
<pre class="fragment">
KPageModel *model = new MyPageModel();
KPageView *view = new KPageView( this );
view->setModel( model );
view->setFaceType( KPageView.List );
</pre>
</p>
<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Tobias Koenig (tokoe@kde.org) </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="#FaceType">FaceType</a> </td><td class="memItemRight" valign="bottom">{ Auto, Plain, List, Tree, Tabbed }</td></tr>
<tr><td colspan="2"><br><h2>Signals</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#currentPageChanged">currentPageChanged</a> (QModelIndex current, QModelIndex previous)</td></tr>
<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="#KPageView">__init__</a> (self, QWidget parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QAbstractItemView </td><td class="memItemRight" valign="bottom"><a class="el" href="#createView">createView</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QModelIndex </td><td class="memItemRight" valign="bottom"><a class="el" href="#currentPage">currentPage</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KPageView.html#FaceType">KPageView.FaceType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#faceType">faceType</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QAbstractItemDelegate </td><td class="memItemRight" valign="bottom"><a class="el" href="#itemDelegate">itemDelegate</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QAbstractItemModel </td><td class="memItemRight" valign="bottom"><a class="el" href="#model">model</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setCurrentPage">setCurrentPage</a> (self, QModelIndex index)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setDefaultWidget">setDefaultWidget</a> (self, QWidget widget)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setFaceType">setFaceType</a> (self, <a href="../kdeui/KPageView.html#FaceType">KPageView.FaceType</a> faceType)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setItemDelegate">setItemDelegate</a> (self, QAbstractItemDelegate delegate)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setModel">setModel</a> (self, QAbstractItemModel model)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#showPageHeader">showPageHeader</a> (self)</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::Alignment</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#viewPosition">viewPosition</a> (self)</td></tr>
</table>
<hr><h2>Signal Documentation</h2><a class="anchor" name="currentPageChanged"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> currentPageChanged</td>
<td>(</td>
<td class="paramtype">QModelIndex </td>
<td class="paramname"><em>current</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QModelIndex </td>
<td class="paramname"><em>previous</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>This signal is emitted whenever the current page changes.
The previous page index is replaced by the current index.
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("currentPageChanged(const QModelIndex&, const QModelIndex&)"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="KPageView"></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">QWidget </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 page view with given parent.
</p></div></div><a class="anchor" name="createView"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QAbstractItemView createView</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>Returns the navigation view, depending on the current
face type.
</p>
<p>
This method can be reimplemented to provide custom
navigation views.
</p></div></div><a class="anchor" name="currentPage"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QModelIndex currentPage</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>Returns the index for the current page or an invalid index
if no current page exists.
</p></div></div><a class="anchor" name="faceType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KPageView.html#FaceType">KPageView.FaceType</a> faceType</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>Returns the face type of the page view.
</p></div></div><a class="anchor" name="itemDelegate"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QAbstractItemDelegate itemDelegate</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>Returns the item delegate of the page view.
</p></div></div><a class="anchor" name="model"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QAbstractItemModel model</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>Returns the model of the page view.
</p></div></div><a class="anchor" name="setCurrentPage"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setCurrentPage</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">QModelIndex </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>Sets the page with </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>index</em> </td><td> to be the current page and emits
the <dl class="see" compact><dt><b>See also:</b></dt><dd> currentPageChanged signal.
</dd></dl>
</p></div></div><a class="anchor" name="setDefaultWidget"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setDefaultWidget</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>Sets the <b>widget</b> which will be shown when a page is selected
that has no own widget set.
</p></div></div><a class="anchor" name="setFaceType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setFaceType</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"><a href="../kdeui/KPageView.html#FaceType">KPageView.FaceType</a> </td>
<td class="paramname"><em>faceType</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 face type of the page view.
</p></div></div><a class="anchor" name="setItemDelegate"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setItemDelegate</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">QAbstractItemDelegate </td>
<td class="paramname"><em>delegate</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 </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>delegate</em> </td><td> which can be used customize
the page view.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setModel"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setModel</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">QAbstractItemModel </td>
<td class="paramname"><em>model</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 <b>model</b> of the page view.
</p>
<p>
The model has to provide data for the roles defined in KPageModel.Role.
</p></div></div><a class="anchor" name="showPageHeader"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool showPageHeader</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>Returns whether the page header should be visible.
</p>
<p>
This method can be reimplemented for adapting custom
views.
</p></div></div><a class="anchor" name="viewPosition"></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::Alignment</a> viewPosition</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>Returns the position where the navigation view should be
located according to the page stack.
</p>
<p>
This method can be reimplemented for adapting custom
views.
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="FaceType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">FaceType</td>
</tr>
</table>
</div>
<div class="memdoc"><p>This enum is used to decide which type of navigation view
shall be used in the page view.
</p>
<p>
<li> Auto - Depending on the number of pages in the model, </li>
the Plain (one page), the List (several pages)
or the Tree face (nested pages) will be used.
This is the default face type.
<li> Plain - No navigation view will be visible and only the </li>
first page of the model will be shown.
</p>
<p>
<li> List - An icon list is used as navigation view. </li>
</p>
<p>
<li> Tree - A tree list is used as navigation view. </li>
</p>
<p>
<li> Tabbed - A tab widget is used as navigation view. </li>
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>Auto</em> </td><td><tr><td valign="top"><em>Plain</em> </td><td><tr><td valign="top"><em>List</em> </td><td><tr><td valign="top"><em>Tree</em> </td><td><tr><td valign="top"><em>Tabbed</em> </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="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>
|
