← Back to branch summary

~ubuntu-branches/ubuntu/karmic/eric/karmic

« back to all changes in this revision

Viewing changes to eric/Documentation/Source/eric3doc-eric3.UI.E3Action.html

  • Committer: Bazaar Package Importer
  • Author(s): Scott Kitterman
  • Date: 2008-01-28 18:02:25 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20080128180225-6nrox6yrworh2c4v
Tags: 4.0.4-1ubuntu1
* Add python-qt3 to build-depends becuase that's where Ubuntu puts 
  pyqtconfig
* Change maintainer to MOTU

Show diffs side-by-side

added added

removed removed

Lines of Context:
eric/Documentation/Source/eric3doc-eric3.UI.E3Action.html
1
 
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
2
 
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
3
 
<html><head>
4
 
<title>eric3.UI.E3Action</title>
5
 
</head>
6
 
<body bgcolor="#FFFFFF"><a NAME="top" ID="top"></a>
7
 
<h1><font color="#0000FF">eric3.UI.E3Action</font></h1>
8
 
<p>
9
 
Module implementing an Action class substituting QAction.
10
 
</p><p>
11
 
This substitution is neccessary in order to support alternate keyboard
12
 
shortcuts.
13
 
</p>
14
 
<h3><font color="#FF0000">Classes</font></h3>
15
 
<table>
16
 
<tr>
17
 
<td><a href="#ArgumentsError">ArgumentsError</a></td>
18
 
<td>Class implementing an exception, which is raised, if the wrong number of arguments are given.</td>
19
 
</tr><tr>
20
 
<td><a href="#E3Action">E3Action</a></td>
21
 
<td>Class implementing an Action class substituting QAction.</td>
22
 
</tr><tr>
23
 
<td><a href="#E3ActionGroup">E3ActionGroup</a></td>
24
 
<td>Class implementing an ActionGroup class substituting QActionGroup.</td>
25
 
</tr>
26
 
</table>
27
 
<h3><font color="#FF0000">Functions</font></h3>
28
 
<table>
29
 
<tr><td>None</td></tr>
30
 
</table>
31
 
<hr /><hr />
32
 
<a NAME="ArgumentsError" ID="ArgumentsError"></a>
33
 
<h2><font color="#0000FF">ArgumentsError</font></h2>
34
 
<p>
35
 
    Class implementing an exception, which is raised, if the wrong number of arguments are given.
36
 
</p>
37
 
<h3><font color="#FF0000">Derived from</font></h3>
38
 
RuntimeError
39
 
<h3><font color="#FF0000">Methods</font></h3>
40
 
<table>
41
 
<tr>
42
 
<td><a href="#ArgumentsError.__init__">ArgumentsError</a></td>
43
 
<td>Constructor</td>
44
 
</tr><tr>
45
 
<td><a href="#ArgumentsError.__repr__">__repr__</a></td>
46
 
<td>Private method returning a representation of the exception.</td>
47
 
</tr><tr>
48
 
<td><a href="#ArgumentsError.__str__">__str__</a></td>
49
 
<td>Private method returning a string representation of the exception.</td>
50
 
</tr>
51
 
</table>
52
 
<p><a NAME="ArgumentsError.__init__" ID="ArgumentsError__init__"></a>
53
 
<h3><font color="#0000FF">ArgumentsError (Constructor)</font></h3>
54
 
<b>ArgumentsError</b>(<i>error</i>)
55
 
<p>
56
 
        Constructor
57
 
</p><a NAME="ArgumentsError.__repr__" ID="ArgumentsError__repr__"></a>
58
 
<h3><font color="#0000FF">ArgumentsError.__repr__</font></h3>
59
 
<b>__repr__</b>(<i></i>)
60
 
<p>
61
 
        Private method returning a representation of the exception.
62
 
</p><dl>
63
 
<dt>Returns:</dt>
64
 
<dd>
65
 
string representing the error message
66
 
</dd>
67
 
</dl><a NAME="ArgumentsError.__str__" ID="ArgumentsError__str__"></a>
68
 
<h3><font color="#0000FF">ArgumentsError.__str__</font></h3>
69
 
<b>__str__</b>(<i></i>)
70
 
<p>
71
 
        Private method returning a string representation of the exception.
72
 
</p><dl>
73
 
<dt>Returns:</dt>
74
 
<dd>
75
 
string representing the error message
76
 
</dd>
77
 
</dl></p>
78
 
<div align="right"><a href="#top">Up</a></div>
79
 
<hr /><hr />
80
 
<a NAME="E3Action" ID="E3Action"></a>
81
 
<h2><font color="#0000FF">E3Action</font></h2>
82
 
<p>
83
 
    Class implementing an Action class substituting QAction.
84
 
</p>
85
 
<h3><font color="#FF0000">Derived from</font></h3>
86
 
QObject
87
 
<h3><font color="#FF0000">Methods</font></h3>
88
 
<table>
89
 
<tr>
90
 
<td><a href="#E3Action.__init__">E3Action</a></td>
91
 
<td>Constructor</td>
92
 
</tr><tr>
93
 
<td><a href="#E3Action.accel">accel</a></td>
94
 
<td>Public method to retrieve the accelerator.</td>
95
 
</tr><tr>
96
 
<td><a href="#E3Action.addTo">addTo</a></td>
97
 
<td>Public method to add this action to a widget.</td>
98
 
</tr><tr>
99
 
<td><a href="#E3Action.alternateAccel">alternateAccel</a></td>
100
 
<td>Public method to retrieve the alternative accelerator.</td>
101
 
</tr><tr>
102
 
<td><a href="#E3Action.connectIt">connectIt</a></td>
103
 
<td>Public method to connect signals of the action to a receiver.</td>
104
 
</tr><tr>
105
 
<td><a href="#E3Action.isOn">isOn</a></td>
106
 
<td>Public slot to retrieve the toggle status.</td>
107
 
</tr><tr>
108
 
<td><a href="#E3Action.mapIt">mapIt</a></td>
109
 
<td>Public method to set a mapping for the action.</td>
110
 
</tr><tr>
111
 
<td><a href="#E3Action.menuText">menuText</a></td>
112
 
<td>Public method to retrieve the actions menu text.</td>
113
 
</tr><tr>
114
 
<td><a href="#E3Action.setAccel">setAccel</a></td>
115
 
<td>Public slot to set the accelerator.</td>
116
 
</tr><tr>
117
 
<td><a href="#E3Action.setAlternateAccel">setAlternateAccel</a></td>
118
 
<td>Public slot to set the alternative accelerator.</td>
119
 
</tr><tr>
120
 
<td><a href="#E3Action.setEnabled">setEnabled</a></td>
121
 
<td>Public slot to set the enabled status.</td>
122
 
</tr><tr>
123
 
<td><a href="#E3Action.setIconSet">setIconSet</a></td>
124
 
<td>Public slot to set the icon set.</td>
125
 
</tr><tr>
126
 
<td><a href="#E3Action.setOn">setOn</a></td>
127
 
<td>Public slot to set the toggle status.</td>
128
 
</tr><tr>
129
 
<td><a href="#E3Action.setStatusTip">setStatusTip</a></td>
130
 
<td>Public slot to set the text of the status tip.</td>
131
 
</tr><tr>
132
 
<td><a href="#E3Action.setWhatsThis">setWhatsThis</a></td>
133
 
<td>Public slot to set the text of the What's This help.</td>
134
 
</tr><tr>
135
 
<td><a href="#E3Action.statusTip">statusTip</a></td>
136
 
<td>Public method to retrieve the text for the status tip.</td>
137
 
</tr><tr>
138
 
<td><a href="#E3Action.text">text</a></td>
139
 
<td>Public method to retrieve the actions text.</td>
140
 
</tr><tr>
141
 
<td><a href="#E3Action.whatsThis">whatsThis</a></td>
142
 
<td>Public method to retrieve the text for the What's This help.</td>
143
 
</tr>
144
 
</table>
145
 
<p><a NAME="E3Action.__init__" ID="E3Action__init__"></a>
146
 
<h3><font color="#0000FF">E3Action (Constructor)</font></h3>
147
 
<b>E3Action</b>(<i>*args</i>)
148
 
<p>
149
 
        Constructor
150
 
</p><dl>
151
 
<dt><i>args</i></dt>
152
 
<dd>
153
 
argument list of the constructor. This list is one of
154
 
            <ul>
155
 
            <li>text (string or QString), icon (QIconSet), menu text (string or QString), 
156
 
                accelarator (QKeySequence), alternative accelerator (QKeySequence), 
157
 
                parent (QObject), name (string or QString), toggle (boolean)</li>
158
 
            <li>text (string or QString), icon (QIconSet), menu text (string or QString), 
159
 
                accelarator (QKeySequence), alternative accelerator (QKeySequence), 
160
 
                parent (QObject), name (string or QString)</li>
161
 
            <li>text (string or QString), menu text (string or QString), 
162
 
                accelarator (QKeySequence), alternative accelerator (QKeySequence), 
163
 
                parent (QObject), name (string or QString), toggle (boolean)</li>
164
 
            <li>text (string or QString), menu text (string or QString), 
165
 
                accelarator (QKeySequence), alternative accelerator (QKeySequence), 
166
 
                parent (QObject), name (string or QString)</li>
167
 
            </ul>
168
 
</dd>
169
 
</dl><a NAME="E3Action.accel" ID="E3Actionaccel"></a>
170
 
<h3><font color="#0000FF">E3Action.accel</font></h3>
171
 
<b>accel</b>(<i></i>)
172
 
<p>
173
 
        Public method to retrieve the accelerator.
174
 
</p><dl>
175
 
<dt>Returns:</dt>
176
 
<dd>
177
 
the accelerator (QKeySequence)
178
 
</dd>
179
 
</dl><a NAME="E3Action.addTo" ID="E3ActionaddTo"></a>
180
 
<h3><font color="#0000FF">E3Action.addTo</font></h3>
181
 
<b>addTo</b>(<i>widget</i>)
182
 
<p>
183
 
        Public method to add this action to a widget.
184
 
</p><dl>
185
 
<dt><i>widget</i></dt>
186
 
<dd>
187
 
widget to add to (QWidget)
188
 
</dd>
189
 
</dl><a NAME="E3Action.alternateAccel" ID="E3ActionalternateAccel"></a>
190
 
<h3><font color="#0000FF">E3Action.alternateAccel</font></h3>
191
 
<b>alternateAccel</b>(<i></i>)
192
 
<p>
193
 
        Public method to retrieve the alternative accelerator.
194
 
</p><dl>
195
 
<dt>Returns:</dt>
196
 
<dd>
197
 
the alternative accelerator (QKeySequence)
198
 
</dd>
199
 
</dl><a NAME="E3Action.connectIt" ID="E3ActionconnectIt"></a>
200
 
<h3><font color="#0000FF">E3Action.connectIt</font></h3>
201
 
<b>connectIt</b>(<i>*args</i>)
202
 
<p>
203
 
        Public method to connect signals of the action to a receiver.
204
 
</p><dl>
205
 
<dt><i>args</i></dt>
206
 
<dd>
207
 
argument list. This is one of
208
 
            <ul>
209
 
            <li>signal (SIGNAL), receiving member (Python slot)</li>
210
 
            <li>signal (SIGNAL), receiver (QObject), member (SLOT)</li>
211
 
            </ul>
212
 
</dd>
213
 
</dl><a NAME="E3Action.isOn" ID="E3ActionisOn"></a>
214
 
<h3><font color="#0000FF">E3Action.isOn</font></h3>
215
 
<b>isOn</b>(<i></i>)
216
 
<p>
217
 
        Public slot to retrieve the toggle status.
218
 
</p><dl>
219
 
<dt>Returns:</dt>
220
 
<dd>
221
 
the toggle status (boolean)
222
 
</dd>
223
 
</dl><a NAME="E3Action.mapIt" ID="E3ActionmapIt"></a>
224
 
<h3><font color="#0000FF">E3Action.mapIt</font></h3>
225
 
<b>mapIt</b>(<i>mapper, mapping</i>)
226
 
<p>
227
 
        Public method to set a mapping for the action.
228
 
</p><dl>
229
 
<dt><i>mapper</i></dt>
230
 
<dd>
231
 
reference to the mapper object (QSignalMapper)
232
 
</dd><dt><i>mapping</i></dt>
233
 
<dd>
234
 
identifier the id of the mapping (integer, string or QString)
235
 
</dd>
236
 
</dl><a NAME="E3Action.menuText" ID="E3ActionmenuText"></a>
237
 
<h3><font color="#0000FF">E3Action.menuText</font></h3>
238
 
<b>menuText</b>(<i></i>)
239
 
<p>
240
 
        Public method to retrieve the actions menu text.
241
 
</p><dl>
242
 
<dt>Returns:</dt>
243
 
<dd>
244
 
the menu text (QString)
245
 
</dd>
246
 
</dl><a NAME="E3Action.setAccel" ID="E3ActionsetAccel"></a>
247
 
<h3><font color="#0000FF">E3Action.setAccel</font></h3>
248
 
<b>setAccel</b>(<i>accel</i>)
249
 
<p>
250
 
        Public slot to set the accelerator.
251
 
</p><dl>
252
 
<dt><i>accel</i></dt>
253
 
<dd>
254
 
the accelerator (QKeySequence)
255
 
</dd>
256
 
</dl><a NAME="E3Action.setAlternateAccel" ID="E3ActionsetAlternateAccel"></a>
257
 
<h3><font color="#0000FF">E3Action.setAlternateAccel</font></h3>
258
 
<b>setAlternateAccel</b>(<i>accel</i>)
259
 
<p>
260
 
        Public slot to set the alternative accelerator.
261
 
</p><dl>
262
 
<dt><i>accel</i></dt>
263
 
<dd>
264
 
the alternative accelerator (QKeySequence)
265
 
</dd>
266
 
</dl><a NAME="E3Action.setEnabled" ID="E3ActionsetEnabled"></a>
267
 
<h3><font color="#0000FF">E3Action.setEnabled</font></h3>
268
 
<b>setEnabled</b>(<i>on</i>)
269
 
<p>
270
 
        Public slot to set the enabled status.
271
 
</p><dl>
272
 
<dt><i>on</i></dt>
273
 
<dd>
274
 
the enabled status (boolean)
275
 
</dd>
276
 
</dl><a NAME="E3Action.setIconSet" ID="E3ActionsetIconSet"></a>
277
 
<h3><font color="#0000FF">E3Action.setIconSet</font></h3>
278
 
<b>setIconSet</b>(<i>iconSet</i>)
279
 
<p>
280
 
        Public slot to set the icon set.
281
 
</p><dl>
282
 
<dt><i>iconSet</i></dt>
283
 
<dd>
284
 
the new icon set (QIconSet)
285
 
</dd>
286
 
</dl><a NAME="E3Action.setOn" ID="E3ActionsetOn"></a>
287
 
<h3><font color="#0000FF">E3Action.setOn</font></h3>
288
 
<b>setOn</b>(<i>on</i>)
289
 
<p>
290
 
        Public slot to set the toggle status.
291
 
</p><dl>
292
 
<dt><i>on</i></dt>
293
 
<dd>
294
 
the toggle status (boolean)
295
 
</dd>
296
 
</dl><a NAME="E3Action.setStatusTip" ID="E3ActionsetStatusTip"></a>
297
 
<h3><font color="#0000FF">E3Action.setStatusTip</font></h3>
298
 
<b>setStatusTip</b>(<i>text</i>)
299
 
<p>
300
 
        Public slot to set the text of the status tip.
301
 
</p><dl>
302
 
<dt><i>text</i></dt>
303
 
<dd>
304
 
text to be shown (string or QString)
305
 
</dd>
306
 
</dl><a NAME="E3Action.setWhatsThis" ID="E3ActionsetWhatsThis"></a>
307
 
<h3><font color="#0000FF">E3Action.setWhatsThis</font></h3>
308
 
<b>setWhatsThis</b>(<i>text</i>)
309
 
<p>
310
 
        Public slot to set the text of the What's This help.
311
 
</p><dl>
312
 
<dt><i>text</i></dt>
313
 
<dd>
314
 
text to be shown (string or QString)
315
 
</dd>
316
 
</dl><a NAME="E3Action.statusTip" ID="E3ActionstatusTip"></a>
317
 
<h3><font color="#0000FF">E3Action.statusTip</font></h3>
318
 
<b>statusTip</b>(<i></i>)
319
 
<p>
320
 
        Public method to retrieve the text for the status tip.
321
 
</p><dl>
322
 
<dt>Returns:</dt>
323
 
<dd>
324
 
text for the status tip (QString)
325
 
</dd>
326
 
</dl><a NAME="E3Action.text" ID="E3Actiontext"></a>
327
 
<h3><font color="#0000FF">E3Action.text</font></h3>
328
 
<b>text</b>(<i></i>)
329
 
<p>
330
 
        Public method to retrieve the actions text.
331
 
</p><dl>
332
 
<dt>Returns:</dt>
333
 
<dd>
334
 
the actions text (QString)
335
 
</dd>
336
 
</dl><a NAME="E3Action.whatsThis" ID="E3ActionwhatsThis"></a>
337
 
<h3><font color="#0000FF">E3Action.whatsThis</font></h3>
338
 
<b>whatsThis</b>(<i></i>)
339
 
<p>
340
 
        Public method to retrieve the text for the What's This help.
341
 
</p><dl>
342
 
<dt>Returns:</dt>
343
 
<dd>
344
 
text for the What's This help (QString)
345
 
</dd>
346
 
</dl></p>
347
 
<div align="right"><a href="#top">Up</a></div>
348
 
<hr /><hr />
349
 
<a NAME="E3ActionGroup" ID="E3ActionGroup"></a>
350
 
<h2><font color="#0000FF">E3ActionGroup</font></h2>
351
 
<p>
352
 
    Class implementing an ActionGroup class substituting QActionGroup.
353
 
</p>
354
 
<h3><font color="#FF0000">Derived from</font></h3>
355
 
QObject
356
 
<h3><font color="#FF0000">Methods</font></h3>
357
 
<table>
358
 
<tr>
359
 
<td><a href="#E3ActionGroup.__init__">E3ActionGroup</a></td>
360
 
<td>Constructor</td>
361
 
</tr><tr>
362
 
<td><a href="#E3ActionGroup.addTo">addTo</a></td>
363
 
<td>Public method to add this action group to a widget.</td>
364
 
</tr><tr>
365
 
<td><a href="#E3ActionGroup.getActionGroups">getActionGroups</a></td>
366
 
<td>Public method to retrieve the underlying action group objects.</td>
367
 
</tr><tr>
368
 
<td><a href="#E3ActionGroup.getAlternateActionGroup">getAlternateActionGroup</a></td>
369
 
<td>Public method to retrieve the alternative action group object.</td>
370
 
</tr><tr>
371
 
<td><a href="#E3ActionGroup.getMainActionGroup">getMainActionGroup</a></td>
372
 
<td>Public method to retrieve the primary action group object.</td>
373
 
</tr><tr>
374
 
<td><a href="#E3ActionGroup.setEnabled">setEnabled</a></td>
375
 
<td>Public slot to set the enabled status.</td>
376
 
</tr>
377
 
</table>
378
 
<p><a NAME="E3ActionGroup.__init__" ID="E3ActionGroup__init__"></a>
379
 
<h3><font color="#0000FF">E3ActionGroup (Constructor)</font></h3>
380
 
<b>E3ActionGroup</b>(<i>parent, name = None, exclusive = 0</i>)
381
 
<p>
382
 
        Constructor
383
 
</p><dl>
384
 
<dt><i>parent</i></dt>
385
 
<dd>
386
 
parent object of the action group (QObject)
387
 
</dd><dt><i>name</i></dt>
388
 
<dd>
389
 
name of the action group object (string or QString)
390
 
</dd><dt><i>exclusive</i></dt>
391
 
<dd>
392
 
flag indicating an exclusive action group (boolean)
393
 
</dd>
394
 
</dl><a NAME="E3ActionGroup.addTo" ID="E3ActionGroupaddTo"></a>
395
 
<h3><font color="#0000FF">E3ActionGroup.addTo</font></h3>
396
 
<b>addTo</b>(<i>widget</i>)
397
 
<p>
398
 
        Public method to add this action group to a widget.
399
 
</p><dl>
400
 
<dt><i>widget</i></dt>
401
 
<dd>
402
 
widget to add to (QWidget)
403
 
</dd>
404
 
</dl><a NAME="E3ActionGroup.getActionGroups" ID="E3ActionGroupgetActionGroups"></a>
405
 
<h3><font color="#0000FF">E3ActionGroup.getActionGroups</font></h3>
406
 
<b>getActionGroups</b>(<i></i>)
407
 
<p>
408
 
        Public method to retrieve the underlying action group objects.
409
 
</p><dl>
410
 
<dt>Returns:</dt>
411
 
<dd>
412
 
tuple containing the underlying action groups
413
 
            (tuple of two QActionGroup)
414
 
</dd>
415
 
</dl><a NAME="E3ActionGroup.getAlternateActionGroup" ID="E3ActionGroupgetAlternateActionGroup"></a>
416
 
<h3><font color="#0000FF">E3ActionGroup.getAlternateActionGroup</font></h3>
417
 
<b>getAlternateActionGroup</b>(<i></i>)
418
 
<p>
419
 
        Public method to retrieve the alternative action group object.
420
 
</p><dl>
421
 
<dt>Returns:</dt>
422
 
<dd>
423
 
alternative action group (QActionGroup)
424
 
</dd>
425
 
</dl><a NAME="E3ActionGroup.getMainActionGroup" ID="E3ActionGroupgetMainActionGroup"></a>
426
 
<h3><font color="#0000FF">E3ActionGroup.getMainActionGroup</font></h3>
427
 
<b>getMainActionGroup</b>(<i></i>)
428
 
<p>
429
 
        Public method to retrieve the primary action group object.
430
 
</p><dl>
431
 
<dt>Returns:</dt>
432
 
<dd>
433
 
primary action group (QActionGroup)
434
 
</dd>
435
 
</dl><a NAME="E3ActionGroup.setEnabled" ID="E3ActionGroupsetEnabled"></a>
436
 
<h3><font color="#0000FF">E3ActionGroup.setEnabled</font></h3>
437
 
<b>setEnabled</b>(<i>on</i>)
438
 
<p>
439
 
        Public slot to set the enabled status.
440
 
</p><dl>
441
 
<dt><i>on</i></dt>
442
 
<dd>
443
 
the enabled status (boolean)
444
 
</dd>
445
 
</dl></p>
446
 
<div align="right"><a href="#top">Up</a></div>
447
 
<hr />
448
 
</body></html>
 
 
b'\\ No newline at end of file'