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
|
<?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>KUniqueApplication</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>KUniqueApplication Class Reference</h1>
<code>from PyKDE4.kdeui import *</code>
<p>
Inherits: <a href="../kdeui/KApplication.html">KApplication</a> → QApplication → QCoreApplication → QObject<br />
<h2>Detailed Description</h2>
<p>KUniqueApplication is a KApplication which only uses a single process. When
a KUniqueApplication is started, it attempts to contact an existing copy
of the application. If successful, the program asks the
existing process to create a new instance by calling its newInstance() method
and then exits. If there is no existing process then the program forks and
calls the newInstance() method. When newInstance() is called, the application
will typically create a new window or activate an existing one.
</p>
<p>
Instances of KUniqueApplication can be made to behave like a normal application by passing
the StartFlag.NonUniqueInstance flag to start().
</p>
<p>
Please note that this supports only one process per KDE session. If
your application can only be opened once per user or once per host, you
need to ensure this independently of KUniqueApplication.
</p>
<p>
The .desktop file for the application should state X-DBUS-StartupType=Unique,
see ktoolinvocation.h
</p>
<p>
If you use command line options before start() is called, you MUST call addCmdLineOptions()
so that the KUniqueApplication-specific command-line options can still work.
</p>
<p>
If your application is used to open files, it should also support the --tempfile
option (see KCmdLineArgs.addTempFileOption()), to delete tempfiles after use.
Add X-KDE-HasTempFileOption=true to the .desktop file to indicate this.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> KApplication
</dd></dl>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Preston Brown <pbrown@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="#StartFlag">StartFlag</a> </td><td class="memItemRight" valign="bottom">{ NonUniqueInstance }</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="#KUniqueApplication">__init__</a> (self, bool GUIenabled=1, bool configUnique=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KUniqueApplication">__init__</a> (self, Display display, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::HANDLE</a> visual=0, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::HANDLE</a> colormap=0, bool configUnique=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#newInstance">newInstance</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#restoringSession">restoringSession</a> (self)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#addCmdLineOptions">addCmdLineOptions</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setHandleAutoStarted">setHandleAutoStarted</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#start">start</a> (<a href="../kdeui/KUniqueApplication.html">KUniqueApplication.StartFlags</a> flags)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#start">start</a> ()</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="KUniqueApplication"></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">bool </td>
<td class="paramname"><em>GUIenabled=1</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>configUnique=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. Takes command line arguments from KCmdLineArgs
</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>GUIenabled</em> </td><td> Set to false to disable all GUI stuff. This implies
no styles either.
<tr><td></td><td valign="top"><em>configUnique</em> </td><td> If true, the uniqueness of the application will
depend on the value of the "MultipleInstances"
key in the "KDE" group of the application config file.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="KUniqueApplication"></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">Display </td>
<td class="paramname"><em>display</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::HANDLE</a> </td>
<td class="paramname"><em>visual=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::HANDLE</a> </td>
<td class="paramname"><em>colormap=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>configUnique=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. Takes command line arguments from KCmdLineArgs
</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>display</em> </td><td> Will be passed to Qt as the X display. The display
must be valid and already opened.
</td></tr>
<tr><td></td><td valign="top"><em>visual</em> </td><td> Pointer to the X11 visual that should be used by the
application. If NULL, the default visual will be used instead.
</td></tr>
<tr><td></td><td valign="top"><em>colormap</em> </td><td> The colormap that should be used by the application.
If 0, the default colormap will be used instead.
</td></tr>
<tr><td></td><td valign="top"><em>configUnique</em> </td><td> If true, the uniqueness of the application will
depend on the value of the "MultipleInstances"
key in the "KDE" group of the application config file.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="newInstance"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int newInstance</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>Creates a new "instance" of the application.
</p>
<p>
Usually this will involve making some calls into the GUI portion of your
application asking for a new window to be created, possibly with
some data already loaded based on the arguments received.
</p>
<p>
Command line arguments have been passed to KCmdLineArgs before this
function is called and can be checked in the usual way.
</p>
<p>
The default implementation ensures the mainwindow of the already
running instance is shown and activated if necessary. If your
application has only one mainwindow, you should call this default
implementation and only add your special handling if needed.
</p>
<p>
Note that newInstance() is called also in the first started
application process.
</p>
<p>
For applications that share one process for several mainwindows,
the reimplementation could be:
<pre class="fragment">
int MyApp.newInstance()
{
KCmdLineArgs.setCwd(QDir.currentPath().toUtf8());
KCmdLineArgs* args = KCmdLineArgs.parsedArgs();
static bool first = true;
if (args->count() > 0) {
for (int i = 0; i < args->count(); ++i) {
openWindow(args->url(i));
}
} else if( !first || !isSessionRestored()) {
openWindow(KUrl()); // create a new window
}
first = false;
args->clear();
return 0;
}
</pre>
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> An exit value. The calling process will exit with this value.
</dd></dl>
</p></div></div><a class="anchor" name="restoringSession"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool restoringSession</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 newInstance() is being called while session
restoration is in progress.
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="addCmdLineOptions"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> addCmdLineOptions</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Adds command line options specific for KUniqueApplication.
</p>
<p>
Should be called before calling KUniqueApplication constructor
and / or start().
</p></div></div><a class="anchor" name="setHandleAutoStarted"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setHandleAutoStarted</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</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="start"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool start</td>
<td>(</td>
<td class="paramtype"><a href="../kdeui/KUniqueApplication.html">KUniqueApplication.StartFlags</a> </td>
<td class="paramname"><em>flags</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Forks and registers with D-Bus.
</p>
<p>
The command line arguments are being sent via D-Bus to newInstance()
and will be received once the application enters the event loop.
</p>
<p>
Typically this is used like:
<pre class="fragment">
int main(int argc, char **argv) {
KAboutData about("myappname", 0, ki18n("myAppName"), .....);
KCmdLineArgs.init(argc, argv, &about);
KCmdLineArgs.addCmdLineOptions( myCmdOptions );
KUniqueApplication.addCmdLineOptions();
if (!KUniqueApplication.start()) {
fprintf(stderr, "myAppName is already running!\n");
return 0;
}
KUniqueApplication a;
return a.exec();
}
</pre>
Note that it's not necessary to call start() explicitly. It will be
called automatically before creating KUniqueApplication if it hasn't
been called yet, without any performance impact.
</p>
<p>
Also note that you MUST call KUniqueApplication.addCmdLineOptions(),
if you use command line options before start() is 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>flags</em> </td><td> Optional flags which control how a new instance
of the application is started.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if registration is successful.
false if another process was already running.
</dd></dl>
</p></div></div><a class="anchor" name="start"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool start</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Forks and registers with D-Bus.
</p>
<p>
The command line arguments are being sent via D-Bus to newInstance()
and will be received once the application enters the event loop.
</p>
<p>
Typically this is used like:
<pre class="fragment">
int main(int argc, char **argv) {
KAboutData about("myappname", 0, ki18n("myAppName"), .....);
KCmdLineArgs.init(argc, argv, &about);
KCmdLineArgs.addCmdLineOptions( myCmdOptions );
KUniqueApplication.addCmdLineOptions();
if (!KUniqueApplication.start()) {
fprintf(stderr, "myAppName is already running!\n");
return 0;
}
KUniqueApplication a;
return a.exec();
}
</pre>
Note that it's not necessary to call start() explicitly. It will be
called automatically before creating KUniqueApplication if it hasn't
been called yet, without any performance impact.
</p>
<p>
Also note that you MUST call KUniqueApplication.addCmdLineOptions(),
if you use command line options before start() is 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>flags</em> </td><td> Optional flags which control how a new instance
of the application is started.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if registration is successful.
false if another process was already running.
</dd></dl>
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="StartFlag"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">StartFlag</td>
</tr>
</table>
</div>
<div class="memdoc"><p>These flags can be used to specify how new instances of
unique applications are created.
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>NonUniqueInstance</em> = 0x1</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>
|
