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
|
<?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>KXmlGuiWindow</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>KXmlGuiWindow Class Reference</h1>
<code>from PyKDE4.kdeui import *</code>
<p>
Inherits: <a href="../kdeui/KMainWindow.html">KMainWindow</a> → QMainWindow → QWidget → QObject,<a href="../kdeui/KXMLGUIBuilder.html">KXMLGUIBuilder</a>,<a href="../kdeui/KXMLGUIClient.html">KXMLGUIClient</a><br />
<h2>Detailed Description</h2>
<p>KDE top level main window with predefined action layout
</p>
<p>
Instead of creating a KMainWindow manually and assigning menus, menu entries,
toolbar buttons and actions to it by hand, this class can be used to load an
rc file to manage the main window's actions.
</p>
<p>
See http://techbase.kde.org/Development/Tutorials/Using_KActions#XMLGUI
for essential information on the XML file format and usage of this class.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> KMainWindow
</dd></dl>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Reginald Stadlbauer (reggie@kde.org) Stephan Kulow (coolo@kde.org), Matthias Ettrich (ettrich@kde.org), Chris Schlaeger (cs@kde.org), Sven Radej (radej@kde.org). Maintained by Sven Radej (radej@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="#StandardWindowOption">StandardWindowOption</a> </td><td class="memItemRight" valign="bottom">{ ToolBar, Keys, StatusBar, Save, Create, Default }</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="#KXmlGuiWindow">__init__</a> (self, QWidget parent=0, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::WindowFlags</a> f=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#applyMainWindowSettings">applyMainWindowSettings</a> (self, <a href="../kdecore/KConfigGroup.html">KConfigGroup</a> config, bool force=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#configureToolbars">configureToolbars</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#createGUI">createGUI</a> (self, QString xmlfile=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#createStandardStatusBarAction">createStandardStatusBarAction</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#event">event</a> (self, QEvent event)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#finalizeGUI">finalizeGUI</a> (self, <a href="../kdeui/KXMLGUIClient.html">KXMLGUIClient</a> client)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#finalizeGUI">finalizeGUI</a> (self, bool force)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KXMLGUIFactory.html">KXMLGUIFactory</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#guiFactory">guiFactory</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isHelpMenuEnabled">isHelpMenuEnabled</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isStandardToolBarMenuEnabled">isStandardToolBarMenuEnabled</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#saveNewToolbarConfig">saveNewToolbarConfig</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setHelpMenuEnabled">setHelpMenuEnabled</a> (self, bool showHelpMenu=1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setStandardToolBarMenuEnabled">setStandardToolBarMenuEnabled</a> (self, bool enable)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setupGUI">setupGUI</a> (self, <a href="../kdeui/KXmlGuiWindow.html">KXmlGuiWindow.StandardWindowOptions</a> options=KXmlGuiWindow.Default, QString xmlfile=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setupGUI">setupGUI</a> (self, QSize defaultSize, <a href="../kdeui/KXmlGuiWindow.html">KXmlGuiWindow.StandardWindowOptions</a> options=KXmlGuiWindow.Default, QString xmlfile=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setupToolbarMenuActions">setupToolbarMenuActions</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#slotStateChanged">slotStateChanged</a> (self, QString newstate)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#slotStateChanged">slotStateChanged</a> (self, QString newstate, bool reverse)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QAction </td><td class="memItemRight" valign="bottom"><a class="el" href="#toolBarMenuAction">toolBarMenuAction</a> (self)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="KXmlGuiWindow"></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 class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::WindowFlags</a> </td>
<td class="paramname"><em>f=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Construct a main window.
</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>parent</em> </td><td> The widget parent. This is usually 0 but it may also be the window
group leader. In that case, the KMainWindow becomes sort of a
secondary window.
</td></tr>
<tr><td></td><td valign="top"><em>f</em> </td><td> Specify the widget flags. The default is
Qt.Window and Qt.WA_DeleteOnClose. Qt.Window indicates that a
main window is a toplevel window, regardless of whether it has a
parent or not. Qt.WA_DeleteOnClose indicates that a main window is
automatically destroyed when its window is closed. Pass 0 if
you do not want this behavior.
</td></tr>
</table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> http://doc.trolltech.com/qt.html#WindowType-enum
</dd></dl> </p>
<p>
KMainWindows must be created on the heap with 'new', like:
<pre class="fragment">
KMainWindow *kmw = new KMainWindow(...);
kmw->setObjectName(...);
</pre>
</p>
<p>
IMPORTANT: For session management and window management to work
properly, all main windows in the application should have a
different name. If you don't do it, KMainWindow will create
a unique name, but it's recommended to explicitly pass a window name that will
also describe the type of the window. If there can be several windows of the same
type, append '#' (hash) to the name, and KMainWindow will replace it with numbers to make
the names unique. For example, for a mail client which has one main window showing
the mails and folders, and which can also have one or more windows for composing
mails, the name for the folders window should be e.g. "mainwindow" and
for the composer windows "composer#".
</p></div></div><a class="anchor" name="applyMainWindowSettings"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> applyMainWindowSettings</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="../kdecore/KConfigGroup.html">KConfigGroup</a> </td>
<td class="paramname"><em>config</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>force=0</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="configureToolbars"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> configureToolbars</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>Show a standard configure toolbar dialog.
</p>
<p>
This slot can be connected directly to the action to configure toolbar.
This is very simple to do that by adding a single line
<pre class="fragment">
KStandardAction.configureToolbars( this, SLOT( configureToolbars() ),
actionCollection() );
</pre>
</p></div></div><a class="anchor" name="createGUI"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> createGUI</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">QString </td>
<td class="paramname"><em>xmlfile=QString()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Create a GUI given a local XML file.
</p>
<p>
If <b>xmlfile</b> is NULL,
then it will try to construct a local XML filename like
appnameui.rc where 'appname' is your app's name. If that file
does not exist, then the XML UI code will only use the global
(standard) XML file for the layout purposes.
</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>xmlfile</em> </td><td> The local xmlfile (relative or absolute)
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="createStandardStatusBarAction"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> createStandardStatusBarAction</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>Sets whether KMainWindow should provide a menu that allows showing/hiding
of the statusbar ( using KToggleStatusBarAction ).
</p>
<p>
The menu / menu item is implemented using xmlgui. It will be inserted
in your menu structure in the 'Settings' menu.
</p>
<p>
Note that you should enable this feature before calling createGUI()
( or similar ).
</p>
<p>
If an application maintains the action on its own (i.e. never calls
this function) a connection needs to be made to let KMainWindow
know when that status (hidden/shown) of the statusbar has changed.
For example:
connect(action, SIGNAL(activated()),
kmainwindow, SLOT(setSettingsDirty()));
Otherwise the status (hidden/show) of the statusbar might not be saved
by KMainWindow.
</p></div></div><a class="anchor" name="event"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool event</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">QEvent </td>
<td class="paramname"><em>event</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 catch QEvent.Polish in order to adjust the object name
if needed, once all constructor code for the main window has run.
Also reimplemented to catch when a QDockWidget is added or removed.
</p></div></div><a class="anchor" name="finalizeGUI"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> finalizeGUI</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/KXMLGUIClient.html">KXMLGUIClient</a> </td>
<td class="paramname"><em>client</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p><dl class="internal" compact><dt><b>Internal:</b></dt><dd>
</dd></dl>
</p></div></div><a class="anchor" name="finalizeGUI"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> finalizeGUI</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">bool </td>
<td class="paramname"><em>force</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p><dl class="internal" compact><dt><b>Internal:</b></dt><dd>
</dd></dl>
</p></div></div><a class="anchor" name="guiFactory"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KXMLGUIFactory.html">KXMLGUIFactory</a> guiFactory</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="isHelpMenuEnabled"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isHelpMenuEnabled</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>Return <b>true</b> when the help menu is enabled
</p></div></div><a class="anchor" name="isStandardToolBarMenuEnabled"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isStandardToolBarMenuEnabled</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="saveNewToolbarConfig"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> saveNewToolbarConfig</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>Rebuilds the GUI after KEditToolbar changed the toolbar layout.
<dl class="see" compact><dt><b>See also:</b></dt><dd> configureToolbars()
</dd></dl>
</p></div></div><a class="anchor" name="setHelpMenuEnabled"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setHelpMenuEnabled</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">bool </td>
<td class="paramname"><em>showHelpMenu=1</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Enables the build of a standard help menu when calling createGUI().
</p>
<p>
The default behavior is to build one, you must call this function
to disable it
</p></div></div><a class="anchor" name="setStandardToolBarMenuEnabled"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setStandardToolBarMenuEnabled</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">bool </td>
<td class="paramname"><em>enable</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 KMainWindow should provide a menu that allows showing/hiding
the available toolbars ( using KToggleToolBarAction ) . In case there
is only one toolbar configured a simple 'Show <toolbar name here>' menu item
is shown.
</p>
<p>
The menu / menu item is implemented using xmlgui. It will be inserted in your
menu structure in the 'Settings' menu.
</p>
<p>
If your application uses a non-standard xmlgui resource file then you can
specify the exact position of the menu / menu item by adding a
&lt;Merge name="StandardToolBarMenuHandler" /&gt;
line to the settings menu section of your resource file ( usually appname.rc ).
</p>
<p>
Note that you should enable this feature before calling createGUI() ( or similar ) .
</p></div></div><a class="anchor" name="setupGUI"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setupGUI</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/KXmlGuiWindow.html">KXmlGuiWindow.StandardWindowOptions</a> </td>
<td class="paramname"><em>options=KXmlGuiWindow.Default</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>xmlfile=QString()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Configures the current windows and its actions in the typical KDE
fashion. The options are all enabled by default but can be turned
off if desired through the params or if the prereqs don't exists.
</p>
<p>
<b>defaultSize</b> The default size of the window
</p>
<p>
Typically this function replaces createGUI().
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> StandardWindowOptions
</dd></dl> <dl class="note" compact><dt><b>Note:</b></dt><dd> Since this method will restore the state of the application (toolbar, dockwindows
positions...), you need to have added all your actions to your toolbars etc before
calling to this method. (This note is only applicable if you are using the Default or
Save flag).
</dd></dl> <dl class="warning" compact><dt><b>Warning:</b></dt><dd> If you are calling createGUI yourself, remember to remove the Create flag from
the <b>options</b> parameter. Also, call setupGUI always after you call createGUI.
</dd></dl>
</p></div></div><a class="anchor" name="setupGUI"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setupGUI</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">QSize </td>
<td class="paramname"><em>defaultSize</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KXmlGuiWindow.html">KXmlGuiWindow.StandardWindowOptions</a> </td>
<td class="paramname"><em>options=KXmlGuiWindow.Default</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>xmlfile=QString()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Configures the current windows and its actions in the typical KDE
fashion. The options are all enabled by default but can be turned
off if desired through the params or if the prereqs don't exists.
</p>
<p>
<b>defaultSize</b> The default size of the window
</p>
<p>
Typically this function replaces createGUI().
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> StandardWindowOptions
</dd></dl> <dl class="note" compact><dt><b>Note:</b></dt><dd> Since this method will restore the state of the application (toolbar, dockwindows
positions...), you need to have added all your actions to your toolbars etc before
calling to this method. (This note is only applicable if you are using the Default or
Save flag).
</dd></dl> <dl class="warning" compact><dt><b>Warning:</b></dt><dd> If you are calling createGUI yourself, remember to remove the Create flag from
the <b>options</b> parameter. Also, call setupGUI always after you call createGUI.
</dd></dl>
</p></div></div><a class="anchor" name="setupToolbarMenuActions"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setupToolbarMenuActions</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><dl class="internal" compact><dt><b>Internal:</b></dt><dd> for KToolBar
</dd></dl>
</p></div></div><a class="anchor" name="slotStateChanged"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> slotStateChanged</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">QString </td>
<td class="paramname"><em>newstate</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Apply a state change
</p>
<p>
Enable and disable actions as defined in the XML rc file,
can "reverse" the state (disable the actions which should be
enabled, and vice-versa) if specified.
</p></div></div><a class="anchor" name="slotStateChanged"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> slotStateChanged</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">QString </td>
<td class="paramname"><em>newstate</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>reverse</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Apply a state change
</p>
<p>
Enable and disable actions as defined in the XML rc file,
can "reverse" the state (disable the actions which should be
enabled, and vice-versa) if specified.
</p></div></div><a class="anchor" name="toolBarMenuAction"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QAction toolBarMenuAction</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 a pointer to the mainwindows action responsible for the toolbars menu
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="StandardWindowOption"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">StandardWindowOption</td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="see" compact><dt><b>See also:</b></dt><dd> setupGUI()
</dd></dl>
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>ToolBar</em> = 1</td><td><tr><td valign="top"><em>Keys</em> = 2</td><td><tr><td valign="top"><em>StatusBar</em> = 4</td><td><tr><td valign="top"><em>Save</em> = 8</td><td><tr><td valign="top"><em>Create</em> = 16</td><td><tr><td valign="top"><em>Default</em> = ToolBar|Keys|StatusBar|Save|Create</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>
|
