← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/rhythmbox/oneiric

« back to all changes in this revision

Viewing changes to doc/reference/html/RBSourceHeader.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2011-05-26 18:45:34 UTC
  • mfrom: (2.2.5 experimental)
  • Revision ID: james.westby@ubuntu.com-20110526184534-gdtl60mt1b05y06m
Tags: 2.90.1~20110329-1ubuntu1
* Resynchronize on Debian
  Remaining diffs:
* debian/control.in:
  - Build-Depends on gnome-common and liblaunchpad-integration-3.0-dev
  - Suggests rather than Recommends gstreamer universe components
  - only recommends python-mako since it's not strictly required
  - recommends the cdrecord option rather than suggests, that's something
    users probably expect to see working on the default installation
* debian/source_rhythmbox.py:
  - Apport hook
* debian/rhythmbox.install:
  - Install apport hook
* debian/rhythmbox.gconf-defaults:
  - Set the library watching option on by default
* debian/patches/01_lpi.patch:
  - Launchpad integration change
* debian/patches/02_use_escaped_podcast_uri.patch:
  - Handle podcasts that have sound files with the same basename
* debian/patches/03_magnatune_partner.patch:
  - Set Magnatune plugin partner ID to "ubuntu"
* debian/patches/04_pause_button.patch:
  - remove the play pause button label
* debian/patches/22_hide_on_quit.patch:
  - the close and ctrl<w> buttons are now mapped to hide the main window (can
    bring it back using the soundmenu). Music -> Quit should be used to really
    close rhythmbox.
* debian/rules:
  - Run autotools on build

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/RBSourceHeader.html
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html>
3
 
<head>
4
 
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>RBSourceHeader</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
 
<link rel="home" href="index.html" title="Rhythmbox Development Reference Manual">
8
 
<link rel="up" href="ch05.html" title="Shell">
9
 
<link rel="prev" href="RBShell.html" title="RBShell">
10
 
<link rel="next" href="RBStatusbar.html" title="RBStatusbar">
11
 
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
12
 
<link rel="stylesheet" href="style.css" type="text/css">
13
 
</head>
14
 
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
 
<tr valign="middle">
17
 
<td><a accesskey="p" href="RBShell.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
 
<td><a accesskey="u" href="ch05.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
 
<th width="100%" align="center">Rhythmbox Development Reference Manual</th>
21
 
<td><a accesskey="n" href="RBStatusbar.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
 
</tr>
23
 
<tr><td colspan="5" class="shortcuts">
24
 
<a href="#RBSourceHeader.synopsis" class="shortcut">Top</a>
25
 
                   | 
26
 
                  <a href="#RBSourceHeader.description" class="shortcut">Description</a>
27
 
                   | 
28
 
                  <a href="#RBSourceHeader.object-hierarchy" class="shortcut">Object Hierarchy</a>
29
 
                   | 
30
 
                  <a href="#RBSourceHeader.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
31
 
                   | 
32
 
                  <a href="#RBSourceHeader.properties" class="shortcut">Properties</a>
33
 
                   | 
34
 
                  <a href="#RBSourceHeader.signals" class="shortcut">Signals</a>
35
 
</td></tr>
36
 
</table>
37
 
<div class="refentry" title="RBSourceHeader">
38
 
<a name="RBSourceHeader"></a><div class="titlepage"></div>
39
 
<div class="refnamediv"><table width="100%"><tr>
40
 
<td valign="top">
41
 
<h2><span class="refentrytitle"><a name="RBSourceHeader.top_of_page"></a>RBSourceHeader</span></h2>
42
 
<p>RBSourceHeader — container for search box and toolbar</p>
43
 
</td>
44
 
<td valign="top" align="right"></td>
45
 
</tr></table></div>
46
 
<div class="refsynopsisdiv" title="Synopsis">
47
 
<a name="RBSourceHeader.synopsis"></a><h2>Synopsis</h2>
48
 
<pre class="synopsis">                    <a class="link" href="RBSourceHeader.html#RBSourceHeader-struct" title="RBSourceHeader">RBSourceHeader</a>;
49
 
                    <a class="link" href="RBSourceHeader.html#RBSourceHeaderClass" title="RBSourceHeaderClass">RBSourceHeaderClass</a>;
50
 
<a class="link" href="RBSourceHeader.html" title="RBSourceHeader"><span class="returnvalue">RBSourceHeader</span></a> *    <a class="link" href="RBSourceHeader.html#rb-source-header-new" title="rb_source_header_new ()">rb_source_header_new</a>                (<em class="parameter"><code><span class="type">GtkUIManager</span> *mgr</code></em>,
51
 
                                                         <em class="parameter"><code><span class="type">GtkActionGroup</span> *actiongroup</code></em>);
52
 
<span class="returnvalue">void</span>                <a class="link" href="RBSourceHeader.html#rb-source-header-set-source" title="rb_source_header_set_source ()">rb_source_header_set_source</a>         (<em class="parameter"><code><a class="link" href="RBSourceHeader.html" title="RBSourceHeader"><span class="type">RBSourceHeader</span></a> *header</code></em>,
53
 
                                                         <em class="parameter"><code><a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a> *source</code></em>);
54
 
<span class="returnvalue">void</span>                <a class="link" href="RBSourceHeader.html#rb-source-header-clear-search" title="rb_source_header_clear_search ()">rb_source_header_clear_search</a>       (<em class="parameter"><code><a class="link" href="RBSourceHeader.html" title="RBSourceHeader"><span class="type">RBSourceHeader</span></a> *header</code></em>);
55
 
<span class="returnvalue">void</span>                <a class="link" href="RBSourceHeader.html#rb-source-header-sync-control-state" title="rb_source_header_sync_control_state ()">rb_source_header_sync_control_state</a> (<em class="parameter"><code><a class="link" href="RBSourceHeader.html" title="RBSourceHeader"><span class="type">RBSourceHeader</span></a> *header</code></em>);
56
 
<span class="returnvalue">void</span>                <a class="link" href="RBSourceHeader.html#rb-source-header-focus-search-box" title="rb_source_header_focus_search_box ()">rb_source_header_focus_search_box</a>   (<em class="parameter"><code><a class="link" href="RBSourceHeader.html" title="RBSourceHeader"><span class="type">RBSourceHeader</span></a> *header</code></em>);
57
 
</pre>
58
 
</div>
59
 
<div class="refsect1" title="Object Hierarchy">
60
 
<a name="RBSourceHeader.object-hierarchy"></a><h2>Object Hierarchy</h2>
61
 
<pre class="synopsis">
62
 
  GObject
63
 
   +----GInitiallyUnowned
64
 
         +----GtkObject
65
 
               +----GtkWidget
66
 
                     +----GtkContainer
67
 
                           +----GtkTable
68
 
                                 +----RBSourceHeader
69
 
</pre>
70
 
</div>
71
 
<div class="refsect1" title="Implemented Interfaces">
72
 
<a name="RBSourceHeader.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
73
 
<p>
74
 
RBSourceHeader implements
75
 
 AtkImplementorIface and  GtkBuildable.</p>
76
 
</div>
77
 
<div class="refsect1" title="Properties">
78
 
<a name="RBSourceHeader.properties"></a><h2>Properties</h2>
79
 
<pre class="synopsis">
80
 
  "<a class="link" href="RBSourceHeader.html#RBSourceHeader--action-group" title='The "action-group" property'>action-group</a>"             <span class="type">GtkActionGroup</span>*       : Read / Write / Construct Only
81
 
  "<a class="link" href="RBSourceHeader.html#RBSourceHeader--source" title='The "source" property'>source</a>"                   <a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a>*             : Read / Write
82
 
  "<a class="link" href="RBSourceHeader.html#RBSourceHeader--ui-manager" title='The "ui-manager" property'>ui-manager</a>"               <span class="type">GtkUIManager</span>*         : Read / Write / Construct Only
83
 
</pre>
84
 
</div>
85
 
<div class="refsect1" title="Signals">
86
 
<a name="RBSourceHeader.signals"></a><h2>Signals</h2>
87
 
<pre class="synopsis">
88
 
  "<a class="link" href="RBSourceHeader.html#RBSourceHeader-get-search-actions" title='The "get-search-actions" signal'>get-search-actions</a>"                             : Run Last
89
 
  "<a class="link" href="RBSourceHeader.html#RBSourceHeader-refresh-search-bar" title='The "refresh-search-bar" signal'>refresh-search-bar</a>"                             : Run Last
90
 
</pre>
91
 
</div>
92
 
<div class="refsect1" title="Description">
93
 
<a name="RBSourceHeader.description"></a><h2>Description</h2>
94
 
<p>
95
 
The source header contains the search box and the search
96
 
action toolbar.  It remembers the search text and browser
97
 
visibility state for each source, applying the stored state
98
 
for the newly selected source when the source selection changes.
99
 
</p>
100
 
<p>
101
 
The search bar contains a set of actions determined by the
102
 
selected source.  The source is responsible for tracking
103
 
which search action is active.
104
 
</p>
105
 
</div>
106
 
<div class="refsect1" title="Details">
107
 
<a name="RBSourceHeader.details"></a><h2>Details</h2>
108
 
<div class="refsect2" title="RBSourceHeader">
109
 
<a name="RBSourceHeader-struct"></a><h3>RBSourceHeader</h3>
110
 
<pre class="programlisting">typedef struct _RBSourceHeader RBSourceHeader;</pre>
111
 
<p>
112
 
</p>
113
 
</div>
114
 
<hr>
115
 
<div class="refsect2" title="RBSourceHeaderClass">
116
 
<a name="RBSourceHeaderClass"></a><h3>RBSourceHeaderClass</h3>
117
 
<pre class="programlisting">typedef struct {
118
 
        GtkTableClass parent_class;
119
 
 
120
 
        /* action signal */
121
 
        void (*refresh_search_bar) (RBSourceHeader *header);
122
 
} RBSourceHeaderClass;
123
 
</pre>
124
 
<p>
125
 
</p>
126
 
</div>
127
 
<hr>
128
 
<div class="refsect2" title="rb_source_header_new ()">
129
 
<a name="rb-source-header-new"></a><h3>rb_source_header_new ()</h3>
130
 
<pre class="programlisting"><a class="link" href="RBSourceHeader.html" title="RBSourceHeader"><span class="returnvalue">RBSourceHeader</span></a> *    rb_source_header_new                (<em class="parameter"><code><span class="type">GtkUIManager</span> *mgr</code></em>,
131
 
                                                         <em class="parameter"><code><span class="type">GtkActionGroup</span> *actiongroup</code></em>);</pre>
132
 
<p>
133
 
Creates the <a class="link" href="RBSourceHeader.html" title="RBSourceHeader"><span class="type">RBSourceHeader</span></a>.
134
 
</p>
135
 
<div class="variablelist"><table border="0">
136
 
<col align="left" valign="top">
137
 
<tbody>
138
 
<tr>
139
 
<td><p><span class="term"><em class="parameter"><code>mgr</code></em> :</span></p></td>
140
 
<td>the <span class="type">GtkUIManager</span>
141
 
</td>
142
 
</tr>
143
 
<tr>
144
 
<td><p><span class="term"><em class="parameter"><code>actiongroup</code></em> :</span></p></td>
145
 
<td>the <span class="type">GtkActionGroup</span> to add actions to
146
 
</td>
147
 
</tr>
148
 
<tr>
149
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
150
 
<td> the <a class="link" href="RBSourceHeader.html" title="RBSourceHeader"><span class="type">RBSourceHeader</span></a> instance
151
 
</td>
152
 
</tr>
153
 
</tbody>
154
 
</table></div>
155
 
</div>
156
 
<hr>
157
 
<div class="refsect2" title="rb_source_header_set_source ()">
158
 
<a name="rb-source-header-set-source"></a><h3>rb_source_header_set_source ()</h3>
159
 
<pre class="programlisting"><span class="returnvalue">void</span>                rb_source_header_set_source         (<em class="parameter"><code><a class="link" href="RBSourceHeader.html" title="RBSourceHeader"><span class="type">RBSourceHeader</span></a> *header</code></em>,
160
 
                                                         <em class="parameter"><code><a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a> *source</code></em>);</pre>
161
 
<p>
162
 
Updates the source header when a new source is selected.
163
 
</p>
164
 
<div class="variablelist"><table border="0">
165
 
<col align="left" valign="top">
166
 
<tbody>
167
 
<tr>
168
 
<td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
169
 
<td>the <a class="link" href="RBSourceHeader.html" title="RBSourceHeader"><span class="type">RBSourceHeader</span></a>
170
 
</td>
171
 
</tr>
172
 
<tr>
173
 
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
174
 
<td>the new selected <a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a>
175
 
</td>
176
 
</tr>
177
 
</tbody>
178
 
</table></div>
179
 
</div>
180
 
<hr>
181
 
<div class="refsect2" title="rb_source_header_clear_search ()">
182
 
<a name="rb-source-header-clear-search"></a><h3>rb_source_header_clear_search ()</h3>
183
 
<pre class="programlisting"><span class="returnvalue">void</span>                rb_source_header_clear_search       (<em class="parameter"><code><a class="link" href="RBSourceHeader.html" title="RBSourceHeader"><span class="type">RBSourceHeader</span></a> *header</code></em>);</pre>
184
 
<p>
185
 
Clears the search box and resets all search state for the
186
 
current selected source.
187
 
</p>
188
 
<div class="variablelist"><table border="0">
189
 
<col align="left" valign="top">
190
 
<tbody><tr>
191
 
<td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
192
 
<td>the <a class="link" href="RBSourceHeader.html" title="RBSourceHeader"><span class="type">RBSourceHeader</span></a>
193
 
</td>
194
 
</tr></tbody>
195
 
</table></div>
196
 
</div>
197
 
<hr>
198
 
<div class="refsect2" title="rb_source_header_sync_control_state ()">
199
 
<a name="rb-source-header-sync-control-state"></a><h3>rb_source_header_sync_control_state ()</h3>
200
 
<pre class="programlisting"><span class="returnvalue">void</span>                rb_source_header_sync_control_state (<em class="parameter"><code><a class="link" href="RBSourceHeader.html" title="RBSourceHeader"><span class="type">RBSourceHeader</span></a> *header</code></em>);</pre>
201
 
<p>
202
 
Updates the sensitivity and active state of various actions
203
 
related to the source header.
204
 
</p>
205
 
<div class="variablelist"><table border="0">
206
 
<col align="left" valign="top">
207
 
<tbody><tr>
208
 
<td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
209
 
<td>the <a class="link" href="RBSourceHeader.html" title="RBSourceHeader"><span class="type">RBSourceHeader</span></a>
210
 
</td>
211
 
</tr></tbody>
212
 
</table></div>
213
 
</div>
214
 
<hr>
215
 
<div class="refsect2" title="rb_source_header_focus_search_box ()">
216
 
<a name="rb-source-header-focus-search-box"></a><h3>rb_source_header_focus_search_box ()</h3>
217
 
<pre class="programlisting"><span class="returnvalue">void</span>                rb_source_header_focus_search_box   (<em class="parameter"><code><a class="link" href="RBSourceHeader.html" title="RBSourceHeader"><span class="type">RBSourceHeader</span></a> *header</code></em>);</pre>
218
 
<p>
219
 
Grabs input focus for the search box.
220
 
</p>
221
 
<div class="variablelist"><table border="0">
222
 
<col align="left" valign="top">
223
 
<tbody><tr>
224
 
<td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
225
 
<td>the <a class="link" href="RBSourceHeader.html" title="RBSourceHeader"><span class="type">RBSourceHeader</span></a>
226
 
</td>
227
 
</tr></tbody>
228
 
</table></div>
229
 
</div>
230
 
</div>
231
 
<div class="refsect1" title="Property Details">
232
 
<a name="RBSourceHeader.property-details"></a><h2>Property Details</h2>
233
 
<div class="refsect2" title='The "action-group" property'>
234
 
<a name="RBSourceHeader--action-group"></a><h3>The <code class="literal">"action-group"</code> property</h3>
235
 
<pre class="programlisting">  "action-group"             <span class="type">GtkActionGroup</span>*       : Read / Write / Construct Only</pre>
236
 
<p>
237
 
The <span class="type">GtkActionGroup</span> to add actions to.
238
 
</p>
239
 
</div>
240
 
<hr>
241
 
<div class="refsect2" title='The "source" property'>
242
 
<a name="RBSourceHeader--source"></a><h3>The <code class="literal">"source"</code> property</h3>
243
 
<pre class="programlisting">  "source"                   <a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a>*             : Read / Write</pre>
244
 
<p>
245
 
The currently selected <a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a>.
246
 
</p>
247
 
</div>
248
 
<hr>
249
 
<div class="refsect2" title='The "ui-manager" property'>
250
 
<a name="RBSourceHeader--ui-manager"></a><h3>The <code class="literal">"ui-manager"</code> property</h3>
251
 
<pre class="programlisting">  "ui-manager"               <span class="type">GtkUIManager</span>*         : Read / Write / Construct Only</pre>
252
 
<p>
253
 
The <span class="type">GtkUIManager</span> instance.
254
 
</p>
255
 
</div>
256
 
</div>
257
 
<div class="refsect1" title="Signal Details">
258
 
<a name="RBSourceHeader.signal-details"></a><h2>Signal Details</h2>
259
 
<div class="refsect2" title='The "get-search-actions" signal'>
260
 
<a name="RBSourceHeader-get-search-actions"></a><h3>The <code class="literal">"get-search-actions"</code> signal</h3>
261
 
<pre class="programlisting"><span class="returnvalue">GValueArray</span>*        user_function                      (<a class="link" href="RBSourceHeader.html" title="RBSourceHeader"><span class="type">RBSourceHeader</span></a> *header,
262
 
                                                        <a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a>       *arg1,
263
 
                                                        <span class="type">gpointer</span>        user_data)      : Run Last</pre>
264
 
<p>
265
 
Allows signal handlers to add search actions to the search
266
 
bar by returning an array of search action names.
267
 
</p>
268
 
<div class="variablelist"><table border="0">
269
 
<col align="left" valign="top">
270
 
<tbody>
271
 
<tr>
272
 
<td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
273
 
<td>the <a class="link" href="RBSourceHeader.html" title="RBSourceHeader"><span class="type">RBSourceHeader</span></a>
274
 
</td>
275
 
</tr>
276
 
<tr>
277
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
278
 
<td>user data set when the signal handler was connected.</td>
279
 
</tr>
280
 
</tbody>
281
 
</table></div>
282
 
</div>
283
 
<hr>
284
 
<div class="refsect2" title='The "refresh-search-bar" signal'>
285
 
<a name="RBSourceHeader-refresh-search-bar"></a><h3>The <code class="literal">"refresh-search-bar"</code> signal</h3>
286
 
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="RBSourceHeader.html" title="RBSourceHeader"><span class="type">RBSourceHeader</span></a> *header,
287
 
                                                        <span class="type">gpointer</span>        user_data)      : Run Last</pre>
288
 
<p>
289
 
An action signal used to repopulate the search bar.
290
 
This should be called after a signal handler for
291
 
<span class="type">"get-search-actions"</span> has been connected
292
 
or disconnected.
293
 
</p>
294
 
<div class="variablelist"><table border="0">
295
 
<col align="left" valign="top">
296
 
<tbody>
297
 
<tr>
298
 
<td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
299
 
<td>the <a class="link" href="RBSourceHeader.html" title="RBSourceHeader"><span class="type">RBSourceHeader</span></a>
300
 
</td>
301
 
</tr>
302
 
<tr>
303
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
304
 
<td>user data set when the signal handler was connected.</td>
305
 
</tr>
306
 
</tbody>
307
 
</table></div>
308
 
</div>
309
 
</div>
310
 
</div>
311
 
<div class="footer">
312
 
<hr>
313
 
          Generated by GTK-Doc V1.15</div>
314
 
</body>
315
 
</html>
 
 
b'\\ No newline at end of file'