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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>rb-source-header</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="Rhythmbox Development Reference Manual">
<link rel="up" href="ch05.html" title="Shell">
<link rel="prev" href="rhythmbox-rb-shell.html" title="rb-shell">
<link rel="next" href="rhythmbox-rb-statusbar.html" title="rb-statusbar">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Backends">
<link rel="chapter" href="ch02.html" title="Lib">
<link rel="chapter" href="ch03.html" title="Metadata">
<link rel="chapter" href="ch04.html" title="RhythmDB">
<link rel="chapter" href="ch05.html" title="Shell">
<link rel="chapter" href="ch06.html" title="Sources">
<link rel="chapter" href="ch07.html" title="Widgets">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="rhythmbox-rb-shell.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch05.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Rhythmbox Development Reference Manual</th>
<td><a accesskey="n" href="rhythmbox-rb-statusbar.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#RBSourceHeader.synopsis" class="shortcut">Top</a>
|
<a href="#RBSourceHeader.description" class="shortcut">Description</a>
|
<a href="#RBSourceHeader.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#RBSourceHeader.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#RBSourceHeader.properties" class="shortcut">Properties</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="RBSourceHeader"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="RBSourceHeader.top_of_page"></a>rb-source-header</span></h2>
<p>rb-source-header — container for search box and toolbar</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="RBSourceHeader.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="RBSourceHeader.html#RBSourceHeader-struct" title="RBSourceHeader">RBSourceHeader</a>;
<a class="link" href="RBSourceHeader.html#RBSourceHeaderClass" title="RBSourceHeaderClass">RBSourceHeaderClass</a>;
<a class="link" href="RBSourceHeader.html" title="rb-source-header">RBSourceHeader</a>* <a class="link" href="RBSourceHeader.html#rb-source-header-new" title="rb_source_header_new ()">rb_source_header_new</a> (<a
href="/usr/share/gtk-doc/html/gtk/GtkUIManager.html"
>GtkUIManager</a> *mgr,
<a
href="/usr/share/gtk-doc/html/gtk/GtkActionGroup.html"
>GtkActionGroup</a> *actiongroup);
void <a class="link" href="RBSourceHeader.html#rb-source-header-set-source" title="rb_source_header_set_source ()">rb_source_header_set_source</a> (<a class="link" href="RBSourceHeader.html" title="rb-source-header">RBSourceHeader</a> *header,
<a class="link" href="RBSource.html" title="RBSource">RBSource</a> *source);
void <a class="link" href="RBSourceHeader.html#rb-source-header-clear-search" title="rb_source_header_clear_search ()">rb_source_header_clear_search</a> (<a class="link" href="RBSourceHeader.html" title="rb-source-header">RBSourceHeader</a> *header);
void <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> (<a class="link" href="RBSourceHeader.html" title="rb-source-header">RBSourceHeader</a> *header);
void <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> (<a class="link" href="RBSourceHeader.html" title="rb-source-header">RBSourceHeader</a> *header);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="RBSourceHeader.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkObject.html"
>GtkObject</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkContainer.html"
>GtkContainer</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkTable.html"
>GtkTable</a>
+----RBSourceHeader
</pre>
</div>
<div class="refsect1" lang="en">
<a name="RBSourceHeader.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
RBSourceHeader implements
AtkImplementorIface and <a
href="/usr/share/gtk-doc/html/gtk/gtk-gtkbuildable.html#GtkBuildable"
>GtkBuildable</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="RBSourceHeader.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="RBSourceHeader.html#RBSourceHeader--action-group" title='The "action-group" property'>action-group</a>" <a
href="/usr/share/gtk-doc/html/gtk/GtkActionGroup.html"
>GtkActionGroup</a>* : Read / Write / Construct Only
"<a class="link" href="RBSourceHeader.html#RBSourceHeader--source" title='The "source" property'>source</a>" <a class="link" href="RBSource.html" title="RBSource">RBSource</a>* : Read / Write
"<a class="link" href="RBSourceHeader.html#RBSourceHeader--ui-manager" title='The "ui-manager" property'>ui-manager</a>" <a
href="/usr/share/gtk-doc/html/gtk/GtkUIManager.html"
>GtkUIManager</a>* : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1" lang="en">
<a name="RBSourceHeader.description"></a><h2>Description</h2>
<p>
The source header contains the search box and the search
action toolbar. It remembers the search text and browser
visibility state for each source, applying the stored state
for the newly selected source when the source selection changes.
</p>
<p>
The search bar contains a set of actions determined by the
selected source. The source is responsible for tracking
which search action is active.</p>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="RBSourceHeader.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="RBSourceHeader-struct"></a><h3>RBSourceHeader</h3>
<pre class="programlisting">typedef struct _RBSourceHeader RBSourceHeader;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="RBSourceHeaderClass"></a><h3>RBSourceHeaderClass</h3>
<pre class="programlisting">typedef struct {
GtkTableClass parent_class;
} RBSourceHeaderClass;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rb-source-header-new"></a><h3>rb_source_header_new ()</h3>
<pre class="programlisting"><a class="link" href="RBSourceHeader.html" title="rb-source-header">RBSourceHeader</a>* rb_source_header_new (<a
href="/usr/share/gtk-doc/html/gtk/GtkUIManager.html"
>GtkUIManager</a> *mgr,
<a
href="/usr/share/gtk-doc/html/gtk/GtkActionGroup.html"
>GtkActionGroup</a> *actiongroup);</pre>
<p>
Creates the <a class="link" href="RBSourceHeader.html" title="rb-source-header"><span class="type">RBSourceHeader</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mgr</code></em> :</span></p></td>
<td> the <a
href="/usr/share/gtk-doc/html/gtk/GtkUIManager.html"
><span class="type">GtkUIManager</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>actiongroup</code></em> :</span></p></td>
<td> the <a
href="/usr/share/gtk-doc/html/gtk/GtkActionGroup.html"
><span class="type">GtkActionGroup</span></a> to add actions to
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the <a class="link" href="RBSourceHeader.html" title="rb-source-header"><span class="type">RBSourceHeader</span></a> instance
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rb-source-header-set-source"></a><h3>rb_source_header_set_source ()</h3>
<pre class="programlisting">void rb_source_header_set_source (<a class="link" href="RBSourceHeader.html" title="rb-source-header">RBSourceHeader</a> *header,
<a class="link" href="RBSource.html" title="RBSource">RBSource</a> *source);</pre>
<p>
Updates the source header when a new source is selected.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
<td> the <a class="link" href="RBSourceHeader.html" title="rb-source-header"><span class="type">RBSourceHeader</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
<td> the new selected <a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rb-source-header-clear-search"></a><h3>rb_source_header_clear_search ()</h3>
<pre class="programlisting">void rb_source_header_clear_search (<a class="link" href="RBSourceHeader.html" title="rb-source-header">RBSourceHeader</a> *header);</pre>
<p>
Clears the search box and resets all search state for the
current selected source.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
<td> the <a class="link" href="RBSourceHeader.html" title="rb-source-header"><span class="type">RBSourceHeader</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rb-source-header-sync-control-state"></a><h3>rb_source_header_sync_control_state ()</h3>
<pre class="programlisting">void rb_source_header_sync_control_state (<a class="link" href="RBSourceHeader.html" title="rb-source-header">RBSourceHeader</a> *header);</pre>
<p>
Updates the sensitivity and active state of various actions
related to the source header.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
<td> the <a class="link" href="RBSourceHeader.html" title="rb-source-header"><span class="type">RBSourceHeader</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rb-source-header-focus-search-box"></a><h3>rb_source_header_focus_search_box ()</h3>
<pre class="programlisting">void rb_source_header_focus_search_box (<a class="link" href="RBSourceHeader.html" title="rb-source-header">RBSourceHeader</a> *header);</pre>
<p>
Grabs input focus for the search box.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
<td> the <a class="link" href="RBSourceHeader.html" title="rb-source-header"><span class="type">RBSourceHeader</span></a>
</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="RBSourceHeader.property-details"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="RBSourceHeader--action-group"></a><h3>The <code class="literal">"action-group"</code> property</h3>
<pre class="programlisting"> "action-group" <a
href="/usr/share/gtk-doc/html/gtk/GtkActionGroup.html"
>GtkActionGroup</a>* : Read / Write / Construct Only</pre>
<p>
The <a
href="/usr/share/gtk-doc/html/gtk/GtkActionGroup.html"
><span class="type">GtkActionGroup</span></a> to add actions to.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="RBSourceHeader--source"></a><h3>The <code class="literal">"source"</code> property</h3>
<pre class="programlisting"> "source" <a class="link" href="RBSource.html" title="RBSource">RBSource</a>* : Read / Write</pre>
<p>
The currently selected <a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a>.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="RBSourceHeader--ui-manager"></a><h3>The <code class="literal">"ui-manager"</code> property</h3>
<pre class="programlisting"> "ui-manager" <a
href="/usr/share/gtk-doc/html/gtk/GtkUIManager.html"
>GtkUIManager</a>* : Read / Write / Construct Only</pre>
<p>
The <a
href="/usr/share/gtk-doc/html/gtk/GtkUIManager.html"
><span class="type">GtkUIManager</span></a> instance.</p>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.10</div>
</body>
</html>
|
