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
|
<?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>KFileItemActions</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>KFileItemActions Class Reference</h1>
<code>from PyKDE4.kio import *</code>
<p>
Inherits: QObject<br />
<h2>Detailed Description</h2>
<p>This class creates and handles the actions for a url (or urls) in a popupmenu.
</p>
<p>
This includes:
<li> "open with <application>" actions, but also </li>
<li> builtin services like mount/unmount for old-style device desktop files </li>
<li> user-defined actions for a .desktop file, defined in the file itself (see the desktop entry standard) </li>
<li> servicemenus actions, defined in .desktop files and selected based on the mimetype of the url </li>
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
</dd></dl>
</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="#openWithDialogAboutToBeShown">openWithDialogAboutToBeShown</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="#KFileItemActions">__init__</a> (self, QObject parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#addOpenWithActionsTo">addOpenWithActionsTo</a> (self, QMenu menu, QString traderConstraint=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#addServiceActionsTo">addServiceActionsTo</a> (self, QMenu menu)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KAction.html">KAction</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#preferredOpenWithAction">preferredOpenWithAction</a> (self, QString traderConstraint)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#runPreferredApplications">runPreferredApplications</a> (self, <a href="../kio/KFileItemList.html">KFileItemList</a> fileOpenList, QString traderConstraint)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setItemListProperties">setItemListProperties</a> (self, <a href="../kio/KFileItemListProperties.html">KFileItemListProperties</a> itemList)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setParentWidget">setParentWidget</a> (self, QWidget widget)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[KSharedPtr<KService>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#associatedApplications">associatedApplications</a> (QStringList mimeTypeList, QString traderConstraint)</td></tr>
</table>
<hr><h2>Signal Documentation</h2><a class="anchor" name="openWithDialogAboutToBeShown"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> openWithDialogAboutToBeShown</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Emitted before the "Open With" dialog is shown
This is used e.g in folderview to close the folder peek popups on invoking the "Open With" menu action
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.8.2
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("openWithDialogAboutToBeShown()"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="KFileItemActions"></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">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>Creates a KFileItemActions instance.
Note that this instance must stay alive for at least as long as the popupmenu;
it has the slots for the actions created by addOpenWithActionsTo/addServiceActionsTo.
</p></div></div><a class="anchor" name="addOpenWithActionsTo"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> addOpenWithActionsTo</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">QMenu </td>
<td class="paramname"><em>menu</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>traderConstraint=QString()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Generate the "Open With <Application>" actions, and adds them to the <b>menu.</b>
All actions are created as children of the menu.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>menu</em> </td><td> the QMenu where to add actions
<tr><td></td><td valign="top"><em>traderConstraint</em> </td><td> this constraint allows to exclude the current application
from the "open with" list. Example: "DesktopEntryName != 'kfmclient'".
(Default value added in kdelibs-4.5, pass QString() explicitely for earlier versions).
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="addServiceActionsTo"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int addServiceActionsTo</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">QMenu </td>
<td class="paramname"><em>menu</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Generate the user-defined actions and submenus, and adds them to the <b>menu.</b>
User-defined actions include:
- builtin services like mount/unmount for old-style device desktop files
- user-defined actions for a .desktop file, defined in the file itself (see the desktop entry standard)
- servicemenus actions, defined in .desktop files and selected based on the mimetype of the url
</p>
<p>
When KFileItemListProperties.supportsWriting() is false, actions that modify the files are not shown.
This is controlled by Require=Write in the servicemenu desktop files.
</p>
<p>
All actions are created as children of the menu.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the number of actions added
</dd></dl>
</p></div></div><a class="anchor" name="preferredOpenWithAction"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KAction.html">KAction</a> preferredOpenWithAction</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>traderConstraint</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns an action for the preferred application only.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>traderConstraint</em> </td><td> this constraint allows to exclude the current application
from the "open with" list. Example: "DesktopEntryName != 'kfmclient'".
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the action - or 0 if no application was found.
</dd></dl>
</p></div></div><a class="anchor" name="runPreferredApplications"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> runPreferredApplications</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="../kio/KFileItemList.html">KFileItemList</a> </td>
<td class="paramname"><em>fileOpenList</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>traderConstraint</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Slot used to execute a list of files in their respective preferred application.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>fileOpenList</em> </td><td> the list of KFileItems to open.
<tr><td></td><td valign="top"><em>traderConstraint</em> </td><td> this optional constraint allows to exclude the current application
</td></tr> </table></dl>
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</dd></dl>
</p></div></div><a class="anchor" name="setItemListProperties"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setItemListProperties</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="../kio/KFileItemListProperties.html">KFileItemListProperties</a> </td>
<td class="paramname"><em>itemList</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets all the data for the next instance of the popupmenu.
<dl class="see" compact><dt><b>See also:</b></dt><dd> KFileItemListProperties
</dd></dl>
</p></div></div><a class="anchor" name="setParentWidget"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setParentWidget</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>widget</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set the parent widget for any dialogs being shown.
</p>
<p>
This should normally be your mainwindow, not a popup menu,
so that it still exists even after the popup is closed
(e.g. error message from KRun) and so that QAction.setStatusTip
can find a statusbar, too.
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="associatedApplications"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[KSharedPtr<KService>] associatedApplications</td>
<td>(</td>
<td class="paramtype">QStringList </td>
<td class="paramname"><em>mimeTypeList</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>traderConstraint</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Helper method used internally, can also be used for similar GUIs that
show the list of associated applications.
Used in KParts.BrowserOpenOrSaveQuestion for example.
</p>
<p>
This is basically a KMimeTypeTrader.query, but it supports multiple mimetypes, and
also cleans up "apparent" duplicates, such as the kde3 and kde4 applications with the same name.
</p>
<p>
The list is sorted according to the user preferences for the given mimetype(s).
In case multiple mimetypes appear in the url list, the logic is:
applications that on average appear earlier on the associated applications
list for the given mimetypes also appear earlier on the final applications list.
</p>
<p>
Note that for a single mimetype there is no need to use this, you should use
KMimeTypeTrader instead, e.g. query() or preferredService().
</p>
<p>
Returns the applications associated with all the given mimetypes.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>mimeTypeList</em> </td><td> the mimetypes
<tr><td></td><td valign="top"><em>traderConstraint</em> </td><td> this optional constraint allows to exclude the current application
from the "open with" list. Example: "DesktopEntryName != 'kfmclient'".
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the sorted list of services.
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
</dd></dl>
</p></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>
|
