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
|
<?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>KHelpMenu</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>KHelpMenu Class Reference</h1>
<code>from PyKDE4.kdeui import *</code>
<p>
Inherits: QObject<br />
<h2>Detailed Description</h2>
<p>Standard KDE help menu with dialog boxes.
</p>
<p>
This class provides the standard KDE help menu with the default "about"
dialog boxes and help entry.
</p>
<p>
This class is used in KMainWindow so
normally you don't need to use this class yourself. However, if you
need the help menu or any of its dialog boxes in your code that is
not subclassed from KMainWindow you should use this class.
</p>
<p>
The usage is simple:
</p>
<p>
<pre class="fragment">
mHelpMenu = new KHelpMenu( this, <someText> );
kmenubar->addMenu(mHelpMenu->menu() );
</pre>
</p>
<p>
or if you just want to open a dialog box:
</p>
<p>
<pre class="fragment">
mHelpMenu = new KHelpMenu( this, <someText> );
connect( this, SIGNAL(someSignal()), mHelpMenu,SLOT(aboutKDE()));
</pre>
</p>
<p>
IMPORTANT:
The first time you use KHelpMenu.menu(), a KMenu object is
allocated. Only one object is created by the class so if you call
KHelpMenu.menu() twice or more, the same pointer is returned. The class
will destroy the popupmenu in the destructor so do not delete this
pointer yourself.
</p>
<p>
The KHelpMenu object will be deleted when its parent is destroyed but you
can delete it yourself if you want. The code below will always work.
</p>
<p>
<pre class="fragment">
MyClass.~MyClass()
{
delete mHelpMenu;
}
</pre>
</p>
<p>
Using your own "about application" dialog box:
</p>
<p>
The standard "about application" dialog box is quite simple. If you
need a dialog box with more functionality you must design that one
yourself. When you want to display the dialog, you simply need to
connect the help menu signal showAboutApplication() to your slot.
</p>
<p>
<pre class="fragment">
void MyClass.myFunc()
{
..
KHelpMenu *helpMenu = new KHelpMenu( this );
connect( helpMenu, SIGNAL(showAboutApplication()),
this, SLOT(myDialogSlot()));
..
}
void MyClass.myDialogSlot()
{
<activate your custom dialog>
}
</pre>
</p>
<p>
<div align="center"><img src="../images/khelpmenu.png" /><p><strong> "KDE Help Menu" </strong></p></div>
</p>
<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Espen Sand (espen@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="#MenuId">MenuId</a> </td><td class="memItemRight" valign="bottom">{ menuHelpContents, menuWhatsThis, menuAboutApp, menuAboutKDE, menuReportBug, menuSwitchLanguage }</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="#showAboutApplication">showAboutApplication</a> ()</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="#KHelpMenu">__init__</a> (self, QWidget parent=0, QString aboutAppText=QString(), bool showWhatsThis=1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KHelpMenu">__init__</a> (self, QWidget parent, <a href="../kdecore/KAboutData.html">KAboutData</a> aboutData, bool showWhatsThis=1, <a href="../kdeui/KActionCollection.html">KActionCollection</a> actions=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aboutApplication">aboutApplication</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aboutKDE">aboutKDE</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QAction </td><td class="memItemRight" valign="bottom"><a class="el" href="#action">action</a> (self, <a href="../kdeui/KHelpMenu.html#MenuId">KHelpMenu.MenuId</a> id)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#appHelpActivated">appHelpActivated</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#contextHelpActivated">contextHelpActivated</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KMenu.html">KMenu</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#menu">menu</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#reportBug">reportBug</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#switchApplicationLanguage">switchApplicationLanguage</a> (self)</td></tr>
</table>
<hr><h2>Signal Documentation</h2><a class="anchor" name="showAboutApplication"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> showAboutApplication</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>This signal is emitted from aboutApplication() if no
"about application" string has been defined. The standard
application specific dialog box that is normally activated in
aboutApplication() will not be displayed when this signal
is emitted.
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("showAboutApplication()"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="KHelpMenu"></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">QString </td>
<td class="paramname"><em>aboutAppText=QString()</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>showWhatsThis=1</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Constructor.
</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 parent of the dialog boxes. The boxes are modeless
and will be centered with respect to the parent.
<tr><td></td><td valign="top"><em>aboutAppText</em> </td><td> User definable string that is used in the
default application dialog box.
<tr><td></td><td valign="top"><em>showWhatsThis</em> </td><td> Decides whether a "Whats this" entry will be
added to the dialog.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="KHelpMenu"></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</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KAboutData.html">KAboutData</a> </td>
<td class="paramname"><em>aboutData</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>showWhatsThis=1</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KActionCollection.html">KActionCollection</a> </td>
<td class="paramname"><em>actions=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Constructor.
</p>
<p>
This alternative constructor is mainly useful if you want to
overide the standard actions (aboutApplication(), aboutKDE(),
helpContents(), reportBug, and optionally whatsThis).
</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 parent of the dialog boxes. The boxes are modeless
and will be centered with respect to the parent.
<tr><td></td><td valign="top"><em>aboutData</em> </td><td> User and app data used in the About app dialog
<tr><td></td><td valign="top"><em>showWhatsThis</em> </td><td> Decides whether a "Whats this" entry will be
added to the dialog.
<tr><td></td><td valign="top"><em>actions</em> </td><td> KActionCollection that is used instead of the
standard actions.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="aboutApplication"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> aboutApplication</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>Opens an application specific dialog box.
</p>
<p>
The method will try to open the about box using the following steps:
- If the showAboutApplication() signal is connected, then it will be called.
This means there is an application defined aboutBox.
- If the aboutData was set in the constructor a KAboutApplicationDialog will be created.
- Else a default about box using the aboutAppText from the constructor will be created.
</p></div></div><a class="anchor" name="aboutKDE"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> aboutKDE</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>Opens the standard "About KDE" dialog box.
</p></div></div><a class="anchor" name="action"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QAction action</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/KHelpMenu.html#MenuId">KHelpMenu.MenuId</a> </td>
<td class="paramname"><em>id</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns the QAction * associated with the given parameter
Will return NULL pointers if menu() has not been called
</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>id</em> </td><td> The id of the action of which you want to get QAction *
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="appHelpActivated"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> appHelpActivated</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>Opens the help page for the application. The application name is
used as a key to determine what to display and the system will attempt
to open <appName>/index.html.
</p></div></div><a class="anchor" name="contextHelpActivated"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> contextHelpActivated</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>Activates What's This help for the application.
</p></div></div><a class="anchor" name="menu"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KMenu.html">KMenu</a> menu</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 popup menu you can use in the menu bar or where you
need it.
</p>
<p>
The returned menu is configured with an icon, a title and
menu entries. Therefore adding the returned pointer to your menu
is enougth to have access to the help menu.
</p>
<p>
Note: This method will only create one instance of the menu. If
you call this method twice or more the same pointer is returned.
</p></div></div><a class="anchor" name="reportBug"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> reportBug</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>Opens the standard "Report Bugs" dialog box.
</p></div></div><a class="anchor" name="switchApplicationLanguage"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> switchApplicationLanguage</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>Opens the changing default application language dialog box.
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="MenuId"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">MenuId</td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>menuHelpContents</em> = 0</td><td><tr><td valign="top"><em>menuWhatsThis</em> = 1</td><td><tr><td valign="top"><em>menuAboutApp</em> = 2</td><td><tr><td valign="top"><em>menuAboutKDE</em> = 3</td><td><tr><td valign="top"><em>menuReportBug</em> = 4</td><td><tr><td valign="top"><em>menuSwitchLanguage</em> = 5</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>
|
