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
|
<?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>KXMLGUIFactory</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>KXMLGUIFactory Class Reference</h1>
<code>from PyKDE4.kdeui import *</code>
<p>
Inherits: QObject<br />
<h2>Detailed Description</h2>
<p>KXMLGUIFactory, together with KXMLGUIClient objects, can be used to create
a GUI of container widgets (like menus, toolbars, etc.) and container items
(menu items, toolbar buttons, etc.) from an XML document and action objects.
</p>
<p>
Each KXMLGUIClient represents a part of the GUI, composed from containers and
actions. KXMLGUIFactory takes care of building (with the help of a KXMLGUIBuilder)
and merging the GUI from an unlimited number of clients.
</p>
<p>
Each client provides XML through a QDomDocument and actions through a
KActionCollection . The XML document contains the rules for how to merge the
GUI.
</p>
<p>
KXMLGUIFactory processes the DOM tree provided by a client and plugs in the client's actions,
according to the XML and the merging rules of previously inserted clients. Container widgets
are built via a KXMLGUIBuilder , which has to be provided with the KXMLGUIFactory constructor.
</p>
<table border="0" cellpadding="0" cellspacing="0"><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="#clientAdded">clientAdded</a> (<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="#clientRemoved">clientRemoved</a> (<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="#makingChanges">makingChanges</a> (bool a0)</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="#KXMLGUIFactory">__init__</a> (self, <a href="../kdeui/KXMLGUIBuilder.html">KXMLGUIBuilder</a> builder, QObject parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#addClient">addClient</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="#changeShortcutScheme">changeShortcutScheme</a> (self, QString scheme)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../kdeui/KXMLGUIClient.html">KXMLGUIClient</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#clients">clients</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#configureShortcuts">configureShortcuts</a> (self, bool bAllowLetterShortcuts=1, bool bSaveSettings=1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QWidget </td><td class="memItemRight" valign="bottom"><a class="el" href="#container">container</a> (self, QString containerName, <a href="../kdeui/KXMLGUIClient.html">KXMLGUIClient</a> client, bool useTagName=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[QWidget] </td><td class="memItemRight" valign="bottom"><a class="el" href="#containers">containers</a> (self, QString tagName)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#plugActionList">plugActionList</a> (self, <a href="../kdeui/KXMLGUIClient.html">KXMLGUIClient</a> client, QString name, [QAction] actionList)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#refreshActionProperties">refreshActionProperties</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#removeClient">removeClient</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="#reset">reset</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#resetContainer">resetContainer</a> (self, QString containerName, bool useTagName=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#unplugActionList">unplugActionList</a> (self, <a href="../kdeui/KXMLGUIClient.html">KXMLGUIClient</a> client, QString name)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QDomElement </td><td class="memItemRight" valign="bottom"><a class="el" href="#actionPropertiesElement">actionPropertiesElement</a> (QDomDocument doc)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QDomElement </td><td class="memItemRight" valign="bottom"><a class="el" href="#findActionByName">findActionByName</a> (QDomElement elem, QString sName, bool create)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#readConfigFile">readConfigFile</a> (QString filename, <a href="../kdecore/KComponentData.html">KComponentData</a> componentData=KComponentData())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#saveConfigFile">saveConfigFile</a> (QDomDocument doc, QString filename, <a href="../kdecore/KComponentData.html">KComponentData</a> componentData=KComponentData())</td></tr>
</table>
<hr><h2>Signal Documentation</h2><a class="anchor" name="clientAdded"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> clientAdded</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"><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("clientAdded(KXMLGUIClient*)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="clientRemoved"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> clientRemoved</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"><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("clientRemoved(KXMLGUIClient*)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="makingChanges"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> makingChanges</td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>a0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Emitted when the factory is currently making changes to the GUI,
i.e. adding or removing clients.
makingChanges(true) is emitted before any change happens, and
makingChanges(false) is emitted after the change is done.
This allows e.g. KMainWindow to know that the GUI is
being changed programmatically and not by the user (so there is no reason to
save toolbar settings afterwards).
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.1.3
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("makingChanges(bool)"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="KXMLGUIFactory"></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"><a href="../kdeui/KXMLGUIBuilder.html">KXMLGUIBuilder</a> </td>
<td class="paramname"><em>builder</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>Constructs a KXMLGUIFactory. The provided <b>builder</b> KXMLGUIBuilder will be called
for creating and removing container widgets, when clients are added/removed from the GUI.
</p>
<p>
Note that the ownership of the given KXMLGUIBuilder object won't be transferred to this
KXMLGUIFactory, so you have to take care of deleting it properly.
</p></div></div><a class="anchor" name="addClient"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> addClient</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>Creates the GUI described by the QDomDocument of the client,
using the client's actions, and merges it with the previously
created GUI.
This also means that the order in which clients are added to the factory
is relevant; assuming that your application supports plugins, you should
first add your application to the factory and then the plugin, so that the
plugin's UI is merged into the UI of your application, and not the other
way round.
</p></div></div><a class="anchor" name="changeShortcutScheme"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> changeShortcutScheme</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>scheme</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="clients"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[<a href="../kdeui/KXMLGUIClient.html">KXMLGUIClient</a>] clients</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 list of all clients currently added to this factory
</p></div></div><a class="anchor" name="configureShortcuts"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int configureShortcuts</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>bAllowLetterShortcuts=1</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>bSaveSettings=1</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Show a standard configure shortcut for every action in this factory.
</p>
<p>
This slot can be connected directly to the action to configure shortcuts. This is very simple to
do that by adding a single line
<pre class="fragment">
KStandardAction.keyBindings( guiFactory(), SLOT( configureShortcuts() ), actionCollection() );
</pre>
</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>bAllowLetterShortcuts</em> </td><td> Set to false if unmodified alphanumeric
keys ('A', '1', etc.) are not permissible shortcuts.
<tr><td></td><td valign="top"><em>bSaveSettings</em> </td><td> if true, the settings will also be saved back to
the *uirc file which they were intially read from.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="container"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QWidget container</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>containerName</em>, </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 class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>useTagName=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Use this method to get access to a container widget with the name specified with <b>containerName</b>
and which is owned by the <b>client.</b> The container name is specified with a "name" attribute in the
XML document.
</p>
<p>
This function is particularly useful for getting hold of a popupmenu defined in an XMLUI file.
For instance:
<pre class="fragment">
QMenu *popup = static_cast<QMenu*>(guiFactory()->container("my_popup",this));
</pre>
where <b>"my_popup"</b> is the name of the menu in the XMLUI file, and
<b>"this"</b> is XMLGUIClient which owns the popupmenu (e.g. the mainwindow, or the part, or the plugin...)
</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>containerName</em> </td><td> Name of the container widget
<tr><td></td><td valign="top"><em>client</em> </td><td> Owner of the container widget
<tr><td></td><td valign="top"><em>useTagName</em> </td><td> Specifies whether to compare the specified name with the name attribute or
the tag name.
</td></tr>
</table></dl>
<p> This method may return 0 if no container with the given name exists or is not owned by the client.
</p></div></div><a class="anchor" name="containers"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[QWidget] containers</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>tagName</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="plugActionList"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> plugActionList</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 class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">[QAction] </td>
<td class="paramname"><em>actionList</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="refreshActionProperties"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> refreshActionProperties</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>Use this method to reset and reread action properties (shortcuts, etc.) for all actions.
This is needed, for example, when you change shortcuts scheme at runtime.
</p></div></div><a class="anchor" name="removeClient"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> removeClient</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>Removes the GUI described by the client, by unplugging all
provided actions and removing all owned containers (and storing
container state information in the given client)
</p></div></div><a class="anchor" name="reset"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> reset</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>Use this method to free all memory allocated by the KXMLGUIFactory. This deletes the internal node
tree and therefore resets the internal state of the class. Please note that the actual GUI is
NOT touched at all, meaning no containers are deleted nor any actions unplugged. That is
something you have to do on your own. So use this method only if you know what you are doing :-)
</p>
<p>
(also note that this will call KXMLGUIClient.setFactory( 0 ) for all inserted clients)
</p></div></div><a class="anchor" name="resetContainer"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> resetContainer</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>containerName</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>useTagName=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Use this method to free all memory allocated by the KXMLGUIFactory for a specific container,
including all child containers and actions. This deletes the internal node subtree for the
specified container. The actual GUI is not touched, no containers are deleted or any actions
unplugged. Use this method only if you know what you are doing :-)
</p>
<p>
(also note that this will call KXMLGUIClient.setFactory( 0 ) for all clients of the
container)
</p></div></div><a class="anchor" name="unplugActionList"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> unplugActionList</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 class="memname"></td>
<td></td>
<td class="paramtype">QString </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"></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="actionPropertiesElement"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QDomElement actionPropertiesElement</td>
<td>(</td>
<td class="paramtype">QDomDocument </td>
<td class="paramname"><em>doc</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>
Find or create the ActionProperties element, used when saving custom action properties
</dd></dl>
</p></div></div><a class="anchor" name="findActionByName"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QDomElement findActionByName</td>
<td>(</td>
<td class="paramtype">QDomElement </td>
<td class="paramname"><em>elem</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>sName</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>create</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>
Find or create the element for a given action, by name.
Used when saving custom action properties
</dd></dl>
</p></div></div><a class="anchor" name="readConfigFile"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString readConfigFile</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KComponentData.html">KComponentData</a> </td>
<td class="paramname"><em>componentData=KComponentData()</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="saveConfigFile"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool saveConfigFile</td>
<td>(</td>
<td class="paramtype">QDomDocument </td>
<td class="paramname"><em>doc</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KComponentData.html">KComponentData</a> </td>
<td class="paramname"><em>componentData=KComponentData()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></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>
|
