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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="RBSourceHeader">
<refmeta>
<refentrytitle role="top_of_page" id="RBSourceHeader.top_of_page">rb-source-header</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>rb-source-header</refname>
<refpurpose>container for search box and toolbar</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="RBSourceHeader.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="RBSourceHeader-struct">RBSourceHeader</link>;
<link linkend="RBSourceHeaderClass">RBSourceHeaderClass</link>;
<link linkend="RBSourceHeader">RBSourceHeader</link>* <link linkend="rb-source-header-new">rb_source_header_new</link> (<link linkend="GtkUIManager">GtkUIManager</link> *mgr,
<link linkend="GtkActionGroup">GtkActionGroup</link> *actiongroup);
<link linkend="void">void</link> <link linkend="rb-source-header-set-source">rb_source_header_set_source</link> (<link linkend="RBSourceHeader">RBSourceHeader</link> *header,
<link linkend="RBSource">RBSource</link> *source);
<link linkend="void">void</link> <link linkend="rb-source-header-clear-search">rb_source_header_clear_search</link> (<link linkend="RBSourceHeader">RBSourceHeader</link> *header);
<link linkend="void">void</link> <link linkend="rb-source-header-sync-control-state">rb_source_header_sync_control_state</link> (<link linkend="RBSourceHeader">RBSourceHeader</link> *header);
<link linkend="void">void</link> <link linkend="rb-source-header-focus-search-box">rb_source_header_focus_search_box</link> (<link linkend="RBSourceHeader">RBSourceHeader</link> *header);
</synopsis>
</refsynopsisdiv>
<refsect1 id="RBSourceHeader.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
+----<link linkend="GtkObject">GtkObject</link>
+----<link linkend="GtkWidget">GtkWidget</link>
+----<link linkend="GtkContainer">GtkContainer</link>
+----<link linkend="GtkTable">GtkTable</link>
+----RBSourceHeader
</synopsis>
</refsect1>
<refsect1 id="RBSourceHeader.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
RBSourceHeader implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="GtkBuildable">GtkBuildable</link>.</para>
</refsect1>
<refsect1 id="RBSourceHeader.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="RBSourceHeader--action-group">action-group</link>" <link linkend="GtkActionGroup">GtkActionGroup</link>* : Read / Write / Construct Only
"<link linkend="RBSourceHeader--source">source</link>" <link linkend="RBSource">RBSource</link>* : Read / Write
"<link linkend="RBSourceHeader--ui-manager">ui-manager</link>" <link linkend="GtkUIManager">GtkUIManager</link>* : Read / Write / Construct Only
</synopsis>
</refsect1>
<refsect1 id="RBSourceHeader.description" role="desc">
<title role="desc.title">Description</title>
<para>
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.
</para>
<para>
The search bar contains a set of actions determined by the
selected source. The source is responsible for tracking
which search action is active.</para>
<para>
</para>
</refsect1>
<refsect1 id="RBSourceHeader.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="RBSourceHeader-struct" role="struct">
<title>RBSourceHeader</title>
<indexterm zone="RBSourceHeader-struct"><primary>RBSourceHeader</primary></indexterm><programlisting>typedef struct _RBSourceHeader RBSourceHeader;</programlisting>
<para>
</para></refsect2>
<refsect2 id="RBSourceHeaderClass" role="struct">
<title>RBSourceHeaderClass</title>
<indexterm zone="RBSourceHeaderClass"><primary>RBSourceHeaderClass</primary></indexterm><programlisting>typedef struct {
GtkTableClass parent_class;
} RBSourceHeaderClass;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="rb-source-header-new" role="function">
<title>rb_source_header_new ()</title>
<indexterm zone="rb-source-header-new"><primary>rb_source_header_new</primary></indexterm><programlisting><link linkend="RBSourceHeader">RBSourceHeader</link>* rb_source_header_new (<link linkend="GtkUIManager">GtkUIManager</link> *mgr,
<link linkend="GtkActionGroup">GtkActionGroup</link> *actiongroup);</programlisting>
<para>
Creates the <link linkend="RBSourceHeader"><type>RBSourceHeader</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mgr</parameter> :</term>
<listitem><simpara> the <link linkend="GtkUIManager"><type>GtkUIManager</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>actiongroup</parameter> :</term>
<listitem><simpara> the <link linkend="GtkActionGroup"><type>GtkActionGroup</type></link> to add actions to
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the <link linkend="RBSourceHeader"><type>RBSourceHeader</type></link> instance
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-header-set-source" role="function">
<title>rb_source_header_set_source ()</title>
<indexterm zone="rb-source-header-set-source"><primary>rb_source_header_set_source</primary></indexterm><programlisting><link linkend="void">void</link> rb_source_header_set_source (<link linkend="RBSourceHeader">RBSourceHeader</link> *header,
<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
Updates the source header when a new source is selected.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>header</parameter> :</term>
<listitem><simpara> the <link linkend="RBSourceHeader"><type>RBSourceHeader</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> the new selected <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-header-clear-search" role="function">
<title>rb_source_header_clear_search ()</title>
<indexterm zone="rb-source-header-clear-search"><primary>rb_source_header_clear_search</primary></indexterm><programlisting><link linkend="void">void</link> rb_source_header_clear_search (<link linkend="RBSourceHeader">RBSourceHeader</link> *header);</programlisting>
<para>
Clears the search box and resets all search state for the
current selected source.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>header</parameter> :</term>
<listitem><simpara> the <link linkend="RBSourceHeader"><type>RBSourceHeader</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-header-sync-control-state" role="function">
<title>rb_source_header_sync_control_state ()</title>
<indexterm zone="rb-source-header-sync-control-state"><primary>rb_source_header_sync_control_state</primary></indexterm><programlisting><link linkend="void">void</link> rb_source_header_sync_control_state (<link linkend="RBSourceHeader">RBSourceHeader</link> *header);</programlisting>
<para>
Updates the sensitivity and active state of various actions
related to the source header.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>header</parameter> :</term>
<listitem><simpara> the <link linkend="RBSourceHeader"><type>RBSourceHeader</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-source-header-focus-search-box" role="function">
<title>rb_source_header_focus_search_box ()</title>
<indexterm zone="rb-source-header-focus-search-box"><primary>rb_source_header_focus_search_box</primary></indexterm><programlisting><link linkend="void">void</link> rb_source_header_focus_search_box (<link linkend="RBSourceHeader">RBSourceHeader</link> *header);</programlisting>
<para>
Grabs input focus for the search box.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>header</parameter> :</term>
<listitem><simpara> the <link linkend="RBSourceHeader"><type>RBSourceHeader</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="RBSourceHeader.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="RBSourceHeader--action-group"><title>The <literal>"action-group"</literal> property</title>
<indexterm zone="RBSourceHeader--action-group"><primary>RBSourceHeader:action-group</primary></indexterm><programlisting> "action-group" <link linkend="GtkActionGroup">GtkActionGroup</link>* : Read / Write / Construct Only</programlisting>
<para>
The <link linkend="GtkActionGroup"><type>GtkActionGroup</type></link> to add actions to.</para>
<para>
</para></refsect2>
<refsect2 id="RBSourceHeader--source"><title>The <literal>"source"</literal> property</title>
<indexterm zone="RBSourceHeader--source"><primary>RBSourceHeader:source</primary></indexterm><programlisting> "source" <link linkend="RBSource">RBSource</link>* : Read / Write</programlisting>
<para>
The currently selected <link linkend="RBSource"><type>RBSource</type></link>.</para>
<para>
</para></refsect2>
<refsect2 id="RBSourceHeader--ui-manager"><title>The <literal>"ui-manager"</literal> property</title>
<indexterm zone="RBSourceHeader--ui-manager"><primary>RBSourceHeader:ui-manager</primary></indexterm><programlisting> "ui-manager" <link linkend="GtkUIManager">GtkUIManager</link>* : Read / Write / Construct Only</programlisting>
<para>
The <link linkend="GtkUIManager"><type>GtkUIManager</type></link> instance.</para>
<para>
</para></refsect2>
</refsect1>
</refentry>
|
