← Back to branch summary

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

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Rico Tzschichholz
  • Date: 2011-07-29 16:41:38 UTC
  • mto: This revision was merged to the branch mainline in revision 191.
  • Revision ID: james.westby@ubuntu.com-20110729164138-wwicy8nqalm18ck7
Tags: upstream-2.90.1~20110802
Import upstream version 2.90.1~20110802

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/RBSearchEntry.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>RBSearchEntry</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="ch07.html" title="Widgets">
 
9
<link rel="prev" href="RBRating.html" title="RBRating">
 
10
<link rel="next" href="RBSongInfo.html" title="RBSongInfo">
 
11
<meta name="generator" content="GTK-Doc V1.17 (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="RBRating.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch07.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="RBSongInfo.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="#RBSearchEntry.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#RBSearchEntry.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#RBSearchEntry.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#RBSearchEntry.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
31
                   | 
 
32
                  <a href="#RBSearchEntry.signals" class="shortcut">Signals</a>
 
33
</td></tr>
 
34
</table>
 
35
<div class="refentry">
 
36
<a name="RBSearchEntry"></a><div class="titlepage"></div>
 
37
<div class="refnamediv"><table width="100%"><tr>
 
38
<td valign="top">
 
39
<h2><span class="refentrytitle"><a name="RBSearchEntry.top_of_page"></a>RBSearchEntry</span></h2>
 
40
<p>RBSearchEntry — text entry widget for the search box</p>
 
41
</td>
 
42
<td valign="top" align="right"></td>
 
43
</tr></table></div>
 
44
<div class="refsynopsisdiv">
 
45
<a name="RBSearchEntry.synopsis"></a><h2>Synopsis</h2>
 
46
<pre class="synopsis">struct              <a class="link" href="RBSearchEntry.html#RBSearchEntry-struct" title="struct RBSearchEntry">RBSearchEntry</a>;
 
47
struct              <a class="link" href="RBSearchEntry.html#RBSearchEntryClass" title="struct RBSearchEntryClass">RBSearchEntryClass</a>;
 
48
<a class="link" href="RBSearchEntry.html" title="RBSearchEntry"><span class="returnvalue">RBSearchEntry</span></a> *        <a class="link" href="RBSearchEntry.html#rb-search-entry-new" title="rb_search_entry_new ()">rb_search_entry_new</a>                 (<em class="parameter"><code><span class="type">void</span></code></em>);
 
49
<span class="returnvalue">void</span>                <a class="link" href="RBSearchEntry.html#rb-search-entry-clear" title="rb_search_entry_clear ()">rb_search_entry_clear</a>               (<em class="parameter"><code><a class="link" href="RBSearchEntry.html" title="RBSearchEntry"><span class="type">RBSearchEntry</span></a> *entry</code></em>);
 
50
<span class="returnvalue">void</span>                <a class="link" href="RBSearchEntry.html#rb-search-entry-set-text" title="rb_search_entry_set_text ()">rb_search_entry_set_text</a>            (<em class="parameter"><code><a class="link" href="RBSearchEntry.html" title="RBSearchEntry"><span class="type">RBSearchEntry</span></a> *entry</code></em>,
 
51
                                                         <em class="parameter"><code>const <span class="type">char</span> *text</code></em>);
 
52
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="RBSearchEntry.html#rb-search-entry-searching" title="rb_search_entry_searching ()">rb_search_entry_searching</a>           (<em class="parameter"><code><a class="link" href="RBSearchEntry.html" title="RBSearchEntry"><span class="type">RBSearchEntry</span></a> *entry</code></em>);
 
53
<span class="returnvalue">void</span>                <a class="link" href="RBSearchEntry.html#rb-search-entry-grab-focus" title="rb_search_entry_grab_focus ()">rb_search_entry_grab_focus</a>          (<em class="parameter"><code><a class="link" href="RBSearchEntry.html" title="RBSearchEntry"><span class="type">RBSearchEntry</span></a> *entry</code></em>);
 
54
</pre>
 
55
</div>
 
56
<div class="refsect1">
 
57
<a name="RBSearchEntry.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
58
<pre class="synopsis">
 
59
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
60
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 
61
         +----<a href="http://library.gnome.org/devel/gtk/GtkWidget.html">GtkWidget</a>
 
62
               +----<a href="http://library.gnome.org/devel/gtk/GtkContainer.html">GtkContainer</a>
 
63
                     +----<a href="http://library.gnome.org/devel/gtk/GtkBox.html">GtkBox</a>
 
64
                           +----<a href="http://library.gnome.org/devel/gtk/GtkHBox.html">GtkHBox</a>
 
65
                                 +----RBSearchEntry
 
66
</pre>
 
67
</div>
 
68
<div class="refsect1">
 
69
<a name="RBSearchEntry.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
 
70
<p>
 
71
RBSearchEntry implements
 
72
 AtkImplementorIface,  <a href="http://library.gnome.org/devel/gtk/GtkBuildable.html">GtkBuildable</a> and  <a href="http://library.gnome.org/devel/gtk/gtk3-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
 
73
</div>
 
74
<div class="refsect1">
 
75
<a name="RBSearchEntry.signals"></a><h2>Signals</h2>
 
76
<pre class="synopsis">
 
77
  "<a class="link" href="RBSearchEntry.html#RBSearchEntry-activate" title='The "activate" signal'>activate</a>"                                       : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
78
  "<a class="link" href="RBSearchEntry.html#RBSearchEntry-search" title='The "search" signal'>search</a>"                                         : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
79
</pre>
 
80
</div>
 
81
<div class="refsect1">
 
82
<a name="RBSearchEntry.description"></a><h2>Description</h2>
 
83
<p>
 
84
The search entry contains a label and a text entry box.
 
85
The text entry box contains an icon that acts as a 'clear'
 
86
button.
 
87
</p>
 
88
<p>
 
89
Signals are emitted when the search text changes,
 
90
arbitrarily rate-limited to one every 300ms.
 
91
</p>
 
92
<p>
 
93
When the text entry widget is non-empty, its colours are
 
94
changed to display the text in black on yellow.
 
95
</p>
 
96
</div>
 
97
<div class="refsect1">
 
98
<a name="RBSearchEntry.details"></a><h2>Details</h2>
 
99
<div class="refsect2">
 
100
<a name="RBSearchEntry-struct"></a><h3>struct RBSearchEntry</h3>
 
101
<pre class="programlisting">struct RBSearchEntry;</pre>
 
102
<p>
 
103
</p>
 
104
</div>
 
105
<hr>
 
106
<div class="refsect2">
 
107
<a name="RBSearchEntryClass"></a><h3>struct RBSearchEntryClass</h3>
 
108
<pre class="programlisting">struct RBSearchEntryClass {
 
109
        GtkHBoxClass parent;
 
110
 
 
111
        void (*search) (RBSearchEntry *view, const char *text);
 
112
        void (*activate) (RBSearchEntry *entry);
 
113
};
 
114
</pre>
 
115
<p>
 
116
</p>
 
117
</div>
 
118
<hr>
 
119
<div class="refsect2">
 
120
<a name="rb-search-entry-new"></a><h3>rb_search_entry_new ()</h3>
 
121
<pre class="programlisting"><a class="link" href="RBSearchEntry.html" title="RBSearchEntry"><span class="returnvalue">RBSearchEntry</span></a> *            rb_search_entry_new                 (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
122
<p>
 
123
Creates a new search entry widget.
 
124
</p>
 
125
<div class="variablelist"><table border="0">
 
126
<col align="left" valign="top">
 
127
<tbody><tr>
 
128
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
129
<td>new search entry widget.</td>
 
130
</tr></tbody>
 
131
</table></div>
 
132
</div>
 
133
<hr>
 
134
<div class="refsect2">
 
135
<a name="rb-search-entry-clear"></a><h3>rb_search_entry_clear ()</h3>
 
136
<pre class="programlisting"><span class="returnvalue">void</span>                rb_search_entry_clear               (<em class="parameter"><code><a class="link" href="RBSearchEntry.html" title="RBSearchEntry"><span class="type">RBSearchEntry</span></a> *entry</code></em>);</pre>
 
137
<p>
 
138
Clears the search entry text.  The 'search' signal will
 
139
be emitted.
 
140
</p>
 
141
<div class="variablelist"><table border="0">
 
142
<col align="left" valign="top">
 
143
<tbody><tr>
 
144
<td><p><span class="term"><em class="parameter"><code>entry</code></em> :</span></p></td>
 
145
<td>a <a class="link" href="RBSearchEntry.html" title="RBSearchEntry"><span class="type">RBSearchEntry</span></a>
 
146
</td>
 
147
</tr></tbody>
 
148
</table></div>
 
149
</div>
 
150
<hr>
 
151
<div class="refsect2">
 
152
<a name="rb-search-entry-set-text"></a><h3>rb_search_entry_set_text ()</h3>
 
153
<pre class="programlisting"><span class="returnvalue">void</span>                rb_search_entry_set_text            (<em class="parameter"><code><a class="link" href="RBSearchEntry.html" title="RBSearchEntry"><span class="type">RBSearchEntry</span></a> *entry</code></em>,
 
154
                                                         <em class="parameter"><code>const <span class="type">char</span> *text</code></em>);</pre>
 
155
<p>
 
156
Sets the text in the search entry box.
 
157
The 'search' signal will be emitted.
 
158
</p>
 
159
<div class="variablelist"><table border="0">
 
160
<col align="left" valign="top">
 
161
<tbody>
 
162
<tr>
 
163
<td><p><span class="term"><em class="parameter"><code>entry</code></em> :</span></p></td>
 
164
<td>a <a class="link" href="RBSearchEntry.html" title="RBSearchEntry"><span class="type">RBSearchEntry</span></a>
 
165
</td>
 
166
</tr>
 
167
<tr>
 
168
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
 
169
<td>new search text</td>
 
170
</tr>
 
171
</tbody>
 
172
</table></div>
 
173
</div>
 
174
<hr>
 
175
<div class="refsect2">
 
176
<a name="rb-search-entry-searching"></a><h3>rb_search_entry_searching ()</h3>
 
177
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_search_entry_searching           (<em class="parameter"><code><a class="link" href="RBSearchEntry.html" title="RBSearchEntry"><span class="type">RBSearchEntry</span></a> *entry</code></em>);</pre>
 
178
<p>
 
179
Returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if there is search text in the entry widget.
 
180
</p>
 
181
<div class="variablelist"><table border="0">
 
182
<col align="left" valign="top">
 
183
<tbody>
 
184
<tr>
 
185
<td><p><span class="term"><em class="parameter"><code>entry</code></em> :</span></p></td>
 
186
<td>a <a class="link" href="RBSearchEntry.html" title="RBSearchEntry"><span class="type">RBSearchEntry</span></a>
 
187
</td>
 
188
</tr>
 
189
<tr>
 
190
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
191
<td>
 
192
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if searching</td>
 
193
</tr>
 
194
</tbody>
 
195
</table></div>
 
196
</div>
 
197
<hr>
 
198
<div class="refsect2">
 
199
<a name="rb-search-entry-grab-focus"></a><h3>rb_search_entry_grab_focus ()</h3>
 
200
<pre class="programlisting"><span class="returnvalue">void</span>                rb_search_entry_grab_focus          (<em class="parameter"><code><a class="link" href="RBSearchEntry.html" title="RBSearchEntry"><span class="type">RBSearchEntry</span></a> *entry</code></em>);</pre>
 
201
<p>
 
202
Grabs input focus for the text entry widget.
 
203
</p>
 
204
<div class="variablelist"><table border="0">
 
205
<col align="left" valign="top">
 
206
<tbody><tr>
 
207
<td><p><span class="term"><em class="parameter"><code>entry</code></em> :</span></p></td>
 
208
<td>a <a class="link" href="RBSearchEntry.html" title="RBSearchEntry"><span class="type">RBSearchEntry</span></a>
 
209
</td>
 
210
</tr></tbody>
 
211
</table></div>
 
212
</div>
 
213
</div>
 
214
<div class="refsect1">
 
215
<a name="RBSearchEntry.signal-details"></a><h2>Signal Details</h2>
 
216
<div class="refsect2">
 
217
<a name="RBSearchEntry-activate"></a><h3>The <code class="literal">"activate"</code> signal</h3>
 
218
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="RBSearchEntry.html" title="RBSearchEntry"><span class="type">RBSearchEntry</span></a> *entry,
 
219
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>         *text,
 
220
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>       user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
221
<p>
 
222
Emitted when the entry is activated.
 
223
</p>
 
224
<div class="variablelist"><table border="0">
 
225
<col align="left" valign="top">
 
226
<tbody>
 
227
<tr>
 
228
<td><p><span class="term"><em class="parameter"><code>entry</code></em> :</span></p></td>
 
229
<td>the <a class="link" href="RBSearchEntry.html" title="RBSearchEntry"><span class="type">RBSearchEntry</span></a>
 
230
</td>
 
231
</tr>
 
232
<tr>
 
233
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
 
234
<td>search text</td>
 
235
</tr>
 
236
<tr>
 
237
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
238
<td>user data set when the signal handler was connected.</td>
 
239
</tr>
 
240
</tbody>
 
241
</table></div>
 
242
</div>
 
243
<hr>
 
244
<div class="refsect2">
 
245
<a name="RBSearchEntry-search"></a><h3>The <code class="literal">"search"</code> signal</h3>
 
246
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="RBSearchEntry.html" title="RBSearchEntry"><span class="type">RBSearchEntry</span></a> *entry,
 
247
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>         *text,
 
248
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>       user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
249
<p>
 
250
Emitted when the search text changes.  A signal
 
251
handler must initiate a search on the current
 
252
source.
 
253
</p>
 
254
<div class="variablelist"><table border="0">
 
255
<col align="left" valign="top">
 
256
<tbody>
 
257
<tr>
 
258
<td><p><span class="term"><em class="parameter"><code>entry</code></em> :</span></p></td>
 
259
<td>the <a class="link" href="RBSearchEntry.html" title="RBSearchEntry"><span class="type">RBSearchEntry</span></a>
 
260
</td>
 
261
</tr>
 
262
<tr>
 
263
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
 
264
<td>search text</td>
 
265
</tr>
 
266
<tr>
 
267
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
268
<td>user data set when the signal handler was connected.</td>
 
269
</tr>
 
270
</tbody>
 
271
</table></div>
 
272
</div>
 
273
</div>
 
274
</div>
 
275
<div class="footer">
 
276
<hr>
 
277
          Generated by GTK-Doc V1.17</div>
 
278
</body>
 
279
</html>
 
 
b'\\ No newline at end of file'