/
classcoverart__rb3compat_1_1_action_group.html
375 lines (350 loc) · 17 KB
/
classcoverart__rb3compat_1_1_action_group.html
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
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>CoverArt Browser: coverart_rb3compat.ActionGroup Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">CoverArt Browser
 <span id="projectnumber">v2.0</span>
</div>
<div id="projectbrief">Browse your cover-art albums in Rhythmbox</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classcoverart__rb3compat_1_1_action_group.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> </div>
<div class="headertitle">
<div class="title">coverart_rb3compat.ActionGroup Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="coverart_rb3compat::ActionGroup" -->
<p><a href="classcoverart__rb3compat_1_1_action_group-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classcoverart__rb3compat_1_1_action_group.html#a14657af4bf1aa135e51c48d5ca0d125f">__init__</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1363caf181b99e9fa442a8663e9e1326"></a><!-- doxytag: member="coverart_rb3compat::ActionGroup::name" ref="a1363caf181b99e9fa442a8663e9e1326" args="" -->
def </td><td class="memItemRight" valign="bottom"><b>name</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classcoverart__rb3compat_1_1_action_group.html#aa56dfa6a21657cac5ec9b1f5abacfe6a">remove_actions</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classcoverart__rb3compat_1_1_action_group.html#a5edba83eca9919cdf639476f844d49b0">get_action</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classcoverart__rb3compat_1_1_action_group.html#aa121d2d7803701ac2f2691765cc046dc">add_action_with_accel</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classcoverart__rb3compat_1_1_action_group.html#a5a82730dc762188907fde3ab79b1fa3e">add_action</a></td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af104211b2ddd945d2fc5245e592f87fe"></a><!-- doxytag: member="coverart_rb3compat::ActionGroup::group_name" ref="af104211b2ddd945d2fc5245e592f87fe" args="" -->
 </td><td class="memItemRight" valign="bottom"><b>group_name</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaffbc4d6ef79236f91caacbc23c358b1"></a><!-- doxytag: member="coverart_rb3compat::ActionGroup::shell" ref="aaffbc4d6ef79236f91caacbc23c358b1" args="" -->
 </td><td class="memItemRight" valign="bottom"><b>shell</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e45de9057f2b5e95df3bd5de6f75f82"></a><!-- doxytag: member="coverart_rb3compat::ActionGroup::actiongroup" ref="a0e45de9057f2b5e95df3bd5de6f75f82" args="" -->
 </td><td class="memItemRight" valign="bottom"><b>actiongroup</b></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adfa20fe4470d01c4c7914b41fc911264"></a><!-- doxytag: member="coverart_rb3compat::ActionGroup::STANDARD" ref="adfa20fe4470d01c4c7914b41fc911264" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>STANDARD</b> = 0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a17b671937eedb3f67b02d370620c3305"></a><!-- doxytag: member="coverart_rb3compat::ActionGroup::TOGGLE" ref="a17b671937eedb3f67b02d370620c3305" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>TOGGLE</b> = 1</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><div class="fragment"><pre class="fragment">
container for all Actions used to associate with menu items
</pre></div>
<p>Definition at line <a class="el" href="coverart__rb3compat_8py_source.html#l00410">410</a> of file <a class="el" href="coverart__rb3compat_8py_source.html">coverart_rb3compat.py</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a14657af4bf1aa135e51c48d5ca0d125f"></a><!-- doxytag: member="coverart_rb3compat::ActionGroup::__init__" ref="a14657af4bf1aa135e51c48d5ca0d125f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def <a class="el" href="classcoverart__rb3compat_1_1_action_group.html#a14657af4bf1aa135e51c48d5ca0d125f">coverart_rb3compat.ActionGroup.__init__</a> </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>shell</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>group_name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<div class="fragment"><pre class="fragment">
constructor
:param shell: `RBShell`
:param group_name: `str` unique name for the object to create
</pre></div>
<p>Definition at line <a class="el" href="coverart__rb3compat_8py_source.html#l00419">419</a> of file <a class="el" href="coverart__rb3compat_8py_source.html">coverart_rb3compat.py</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5a82730dc762188907fde3ab79b1fa3e"></a><!-- doxytag: member="coverart_rb3compat::ActionGroup::add_action" ref="a5a82730dc762188907fde3ab79b1fa3e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def <a class="el" href="classcoverart__rb3compat_1_1_action_group.html#a5a82730dc762188907fde3ab79b1fa3e">coverart_rb3compat.ActionGroup.add_action</a> </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>action_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>args</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<div class="fragment"><pre class="fragment">
Creates an Action and adds it to the ActionGroup
:param func: function callback used when user activates the action
:param action_name: `str` unique name to associate with an action
:param args: dict of arguments - this is passed to the function callback
Notes:
key value of "label" is the visual menu label to display
key value of "action_type" is the RB2.99 Gio.Action type ("win" or "app")
by default it assumes all actions are "win" type
key value of "action_state" determines what action state to create
</pre></div>
<p>Definition at line <a class="el" href="coverart__rb3compat_8py_source.html#l00471">471</a> of file <a class="el" href="coverart__rb3compat_8py_source.html">coverart_rb3compat.py</a>.</p>
</div>
</div>
<a class="anchor" id="aa121d2d7803701ac2f2691765cc046dc"></a><!-- doxytag: member="coverart_rb3compat::ActionGroup::add_action_with_accel" ref="aa121d2d7803701ac2f2691765cc046dc" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def <a class="el" href="classcoverart__rb3compat_1_1_action_group.html#aa121d2d7803701ac2f2691765cc046dc">coverart_rb3compat.ActionGroup.add_action_with_accel</a> </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>action_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>accel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>args</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<div class="fragment"><pre class="fragment">
Creates an Action with an accelerator and adds it to the ActionGroup
:param func: function callback used when user activates the action
:param action_name: `str` unique name to associate with an action
:param accel: `str` accelerator
:param args: dict of arguments - this is passed to the function callback
Notes:
see notes for add_action
</pre></div>
<p>Definition at line <a class="el" href="coverart__rb3compat_8py_source.html#l00456">456</a> of file <a class="el" href="coverart__rb3compat_8py_source.html">coverart_rb3compat.py</a>.</p>
</div>
</div>
<a class="anchor" id="a5edba83eca9919cdf639476f844d49b0"></a><!-- doxytag: member="coverart_rb3compat::ActionGroup::get_action" ref="a5edba83eca9919cdf639476f844d49b0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def <a class="el" href="classcoverart__rb3compat_1_1_action_group.html#a5edba83eca9919cdf639476f844d49b0">coverart_rb3compat.ActionGroup.get_action</a> </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>action_name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<div class="fragment"><pre class="fragment">
utility function to obtain the Action from the ActionGroup
:param action_name: `str` is the Action unique name
</pre></div>
<p>Definition at line <a class="el" href="coverart__rb3compat_8py_source.html#l00448">448</a> of file <a class="el" href="coverart__rb3compat_8py_source.html">coverart_rb3compat.py</a>.</p>
</div>
</div>
<a class="anchor" id="aa56dfa6a21657cac5ec9b1f5abacfe6a"></a><!-- doxytag: member="coverart_rb3compat::ActionGroup::remove_actions" ref="aa56dfa6a21657cac5ec9b1f5abacfe6a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def <a class="el" href="classcoverart__rb3compat_1_1_action_group.html#aa56dfa6a21657cac5ec9b1f5abacfe6a">coverart_rb3compat.ActionGroup.remove_actions</a> </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<div class="fragment"><pre class="fragment">
utility function to remove all actions associated with the ActionGroup
</pre></div>
<p>Definition at line <a class="el" href="coverart__rb3compat_8py_source.html#l00441">441</a> of file <a class="el" href="coverart__rb3compat_8py_source.html">coverart_rb3compat.py</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/foss/Downloads/coverart-browser/<a class="el" href="coverart__rb3compat_8py_source.html">coverart_rb3compat.py</a></li>
</ul>
</div><!-- contents -->
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>coverart_rb3compat</b> </li>
<li class="navelem"><a class="el" href="classcoverart__rb3compat_1_1_action_group.html">ActionGroup</a> </li>
<li class="footer">Generated on Sat Jun 28 2014 11:18:08 for CoverArt Browser by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li>
</ul>
</div>
</body>
</html>