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
|
<?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>PolkitQt.ActionButton</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>ActionButton Class Reference</h1>
<code>from PyKDE4.polkitqt import *</code>
<p>
Inherits: <a href="../polkitqt/PolkitQt.Action.html">PolkitQt.Action</a> → QAction → QObject<br />
Namespace: <a href="../polkitqt/PolkitQt.html">PolkitQt</a><br />
<h2>Detailed Description</h2>
<p>\class ActionButton actionbutton.h ActionButton
<dl class="author" compact><dt><b>Author:</b></dt><dd> Daniel Nicoletti <dantti85-pk@yahoo.com.br> </dd></dl>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Dario Freddi <drf54321@gmail.com> </dd></dl>
</p>
<p>
Class used to hold and update a QAbstractButton
</p>
<p>
This class allows you to associate QAbstractButtons
(i.e. QPushButton) to a PolicyKit Action. It will update the
button properties according to the PolicyKit Action automatically.
</p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> You should connect the activated() signal to receive
a notification when the user clicked the button and gets
permission to perform the given action. If you set 'noEnabled'
to true it will be emitted when PolKitResult is NO.
</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="#clicked">clicked</a> (QAbstractButton button, bool checked=0)</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="#ActionButton">__init__</a> (self, QAbstractButton button, QString actionId=QString(), QObject parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#activate">activate</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QAbstractButton </td><td class="memItemRight" valign="bottom"><a class="el" href="#button">button</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setButton">setButton</a> (self, QAbstractButton button)</td></tr>
</table>
<hr><h2>Signal Documentation</h2><a class="anchor" name="clicked"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> clicked</td>
<td>(</td>
<td class="paramtype">QAbstractButton </td>
<td class="paramname"><em>button</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>checked=0</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 abstract button clicked(bool) signal
is emitted. This allows you to use qobject_cast<ActionButton*>(sender())
in a slot connected to this signal and call activate() on it.
</p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> you will normally want to connect this signal
to the activate slot.
</dd></dl> </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>button</em> </td><td> the button that has been clicked
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>checked</em> </td><td> the checked state, if applicable. Otherwise false
</td></tr>
</table></dl>
<p>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("clicked(QAbstractButton*, bool)"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="ActionButton"></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">QAbstractButton </td>
<td class="paramname"><em>button</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>actionId=QString()</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 new ActionButton. You need to pass this
constructor an existing QAbstractButton, whose properties
will be modified according to the underlying Action
object. As ActionButton inherits from Action, you can
define your button's behavior right through this wrapper.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> Action
</dd></dl> </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>button</em> </td><td> the QAbstractButton to associate to this ActionButton
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>actionId</em> </td><td> the action Id to create the underlying Action
</td></tr> </table></dl>
<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 object
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="activate"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool activate</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>Connect clicked() signals to this slot. This should be
manually done, as in some cases we might want
to manually call this. Calling this will emit activated().
</p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> This slot is reentrant which is likely to only be a problem
if you are creating an interface to setup PolicyKit policies.
</dd></dl> <dl class="note" compact><dt><b>Note:</b></dt><dd> If you have a checkbox, connect to its' clicked() signal
to avoid an infinite loop as this function internally calls setChecked().
You can always use the clicked(bool) signal in this class to
connect to here.
</dd></dl> <dl class="warning" compact><dt><b>Warning:</b></dt><dd> if you use this class take care to not call Action.activate
otherwise your checkable buttons won't be properly updated.
</dd></dl>
</p></div></div><a class="anchor" name="button"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QAbstractButton button</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 the current button
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the button currently associated with the underlying action
</dd></dl>
</p></div></div><a class="anchor" name="setButton"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setButton</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">QAbstractButton </td>
<td class="paramname"><em>button</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the button associated to the underlying action.
</p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> If you are calling this function, you're probably
changing the button the action is referring to. If this
is the case, please note that Polkit-Qt does not handle
the previous button's memory, so you should take care of
deleting it yourself (if needed). You can retrieve it by
using button()
</dd></dl> </p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> button
</dd></dl> </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>button</em> </td><td> the new button associated with the underlying action
</td></tr>
</table></dl>
<p>
</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>
|
