← Back to branch summary

~ubuntu-branches/ubuntu/lucid/rhythmbox/lucid

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-29 10:12:48 UTC
  • mfrom: (1.1.45 upstream)
  • Revision ID: james.westby@ubuntu.com-20100329101248-fu29j0q1s2dx8k99
Tags: 0.12.8-0ubuntu1
* New upstream version
* debian/patches/90_autoreconf.patch:
  - new version update

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/RBStringValueMap.html
8
8
<link rel="up" href="ch02.html" title="Lib">
9
9
<link rel="prev" href="rhythmbox-rb-builder-helpers.html" title="rb-builder-helpers">
10
10
<link rel="next" href="rhythmbox-rb-tree-dnd.html" title="rb-tree-dnd">
11
 
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="chapter" href="ch01.html" title="Backends">
14
14
<link rel="chapter" href="ch02.html" title="Lib">
29
29
</tr>
30
30
<tr><td colspan="5" class="shortcuts">
31
31
<a href="#RBStringValueMap.synopsis" class="shortcut">Top</a>
32
 
                 | 
33
 
                <a href="#RBStringValueMap.description" class="shortcut">Description</a>
34
 
                 | 
35
 
                <a href="#RBStringValueMap.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
32
                   | 
 
33
                  <a href="#RBStringValueMap.description" class="shortcut">Description</a>
 
34
                   | 
 
35
                  <a href="#RBStringValueMap.object-hierarchy" class="shortcut">Object Hierarchy</a>
36
36
</td></tr>
37
37
</table>
38
38
<div class="refentry" title="RBStringValueMap">
46
46
</tr></table></div>
47
47
<div class="refsynopsisdiv" title="Synopsis">
48
48
<a name="RBStringValueMap.synopsis"></a><h2>Synopsis</h2>
49
 
<pre class="synopsis">
50
 
                    <a class="link" href="RBStringValueMap.html#RBStringValueMap-struct" title="RBStringValueMap">RBStringValueMap</a>;
 
49
<pre class="synopsis">                    <a class="link" href="RBStringValueMap.html#RBStringValueMap-struct" title="RBStringValueMap">RBStringValueMap</a>;
51
50
                    <a class="link" href="RBStringValueMap.html#RBStringValueMapClass" title="RBStringValueMapClass">RBStringValueMapClass</a>;
52
 
<a class="link" href="RBStringValueMap.html" title="RBStringValueMap">RBStringValueMap</a> *  <a class="link" href="RBStringValueMap.html#rb-string-value-map-new" title="rb_string_value_map_new ()">rb_string_value_map_new</a>             (void);
53
 
void                <a class="link" href="RBStringValueMap.html#rb-string-value-map-set" title="rb_string_value_map_set ()">rb_string_value_map_set</a>             (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap">RBStringValueMap</a> *map,
54
 
                                                         const char *key,
55
 
                                                         const <a
56
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
57
 
>GValue</a> *value);
58
 
<a
59
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
60
 
>gboolean</a>            <a class="link" href="RBStringValueMap.html#rb-string-value-map-get" title="rb_string_value_map_get ()">rb_string_value_map_get</a>             (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap">RBStringValueMap</a> *map,
61
 
                                                         const char *key,
62
 
                                                         <a
63
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
64
 
>GValue</a> *out);
65
 
const <a
66
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
67
 
>GValue</a>*       <a class="link" href="RBStringValueMap.html#rb-string-value-map-peek" title="rb_string_value_map_peek ()">rb_string_value_map_peek</a>            (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap">RBStringValueMap</a> *map,
68
 
                                                         const char *key);
69
 
<a
70
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
71
 
>gboolean</a>            <a class="link" href="RBStringValueMap.html#rb-string-value-map-remove" title="rb_string_value_map_remove ()">rb_string_value_map_remove</a>          (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap">RBStringValueMap</a> *map,
72
 
                                                         const char *key);
73
 
<a
74
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
75
 
>guint</a>               <a class="link" href="RBStringValueMap.html#rb-string-value-map-size" title="rb_string_value_map_size ()">rb_string_value_map_size</a>            (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap">RBStringValueMap</a> *map);
76
 
<a
77
 
href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"
78
 
>GHashTable</a>*         <a class="link" href="RBStringValueMap.html#rb-string-value-map-steal-hashtable" title="rb_string_value_map_steal_hashtable ()">rb_string_value_map_steal_hashtable</a> (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap">RBStringValueMap</a> *map);
 
51
<a class="link" href="RBStringValueMap.html" title="RBStringValueMap"><span class="returnvalue">RBStringValueMap</span></a> *  <a class="link" href="RBStringValueMap.html#rb-string-value-map-new" title="rb_string_value_map_new ()">rb_string_value_map_new</a>             (void);
 
52
<span class="returnvalue">void</span>                <a class="link" href="RBStringValueMap.html#rb-string-value-map-set" title="rb_string_value_map_set ()">rb_string_value_map_set</a>             (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap"><span class="returnvalue">RBStringValueMap</span></a> *map,
 
53
                                                         const <span class="returnvalue">char</span> *key,
 
54
                                                         const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> *value);
 
55
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="RBStringValueMap.html#rb-string-value-map-get" title="rb_string_value_map_get ()">rb_string_value_map_get</a>             (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap"><span class="returnvalue">RBStringValueMap</span></a> *map,
 
56
                                                         const <span class="returnvalue">char</span> *key,
 
57
                                                         <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> *out);
 
58
const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a>*       <a class="link" href="RBStringValueMap.html#rb-string-value-map-peek" title="rb_string_value_map_peek ()">rb_string_value_map_peek</a>            (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap"><span class="returnvalue">RBStringValueMap</span></a> *map,
 
59
                                                         const <span class="returnvalue">char</span> *key);
 
60
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="RBStringValueMap.html#rb-string-value-map-remove" title="rb_string_value_map_remove ()">rb_string_value_map_remove</a>          (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap"><span class="returnvalue">RBStringValueMap</span></a> *map,
 
61
                                                         const <span class="returnvalue">char</span> *key);
 
62
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="RBStringValueMap.html#rb-string-value-map-size" title="rb_string_value_map_size ()">rb_string_value_map_size</a>            (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap"><span class="returnvalue">RBStringValueMap</span></a> *map);
 
63
<a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a>*         <a class="link" href="RBStringValueMap.html#rb-string-value-map-steal-hashtable" title="rb_string_value_map_steal_hashtable ()">rb_string_value_map_steal_hashtable</a> (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap"><span class="returnvalue">RBStringValueMap</span></a> *map);
79
64
</pre>
80
65
</div>
81
66
<div class="refsect1" title="Object Hierarchy">
82
67
<a name="RBStringValueMap.object-hierarchy"></a><h2>Object Hierarchy</h2>
83
68
<pre class="synopsis">
84
 
  <a
85
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
86
 
>GObject</a>
 
69
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
87
70
   +----RBStringValueMap
88
71
</pre>
89
72
</div>
93
76
Simplifies the use of string:GValue maps with respect to copying of the values
94
77
inserted into the map.  Except for rb_string_value_map_peek, the caller retains
95
78
ownership of values passed in, and assumes ownership of all values returned.</p>
96
 
<p>
97
 
</p>
98
79
</div>
99
80
<div class="refsect1" title="Details">
100
81
<a name="RBStringValueMap.details"></a><h2>Details</h2>
117
98
<hr>
118
99
<div class="refsect2" title="rb_string_value_map_new ()">
119
100
<a name="rb-string-value-map-new"></a><h3>rb_string_value_map_new ()</h3>
120
 
<pre class="programlisting"><a class="link" href="RBStringValueMap.html" title="RBStringValueMap">RBStringValueMap</a> *  rb_string_value_map_new             (void);</pre>
 
101
<pre class="programlisting"><a class="link" href="RBStringValueMap.html" title="RBStringValueMap"><span class="returnvalue">RBStringValueMap</span></a> *  rb_string_value_map_new             (void);</pre>
121
102
<p>
122
103
Creates a new <a class="link" href="RBStringValueMap.html" title="RBStringValueMap"><span class="type">RBStringValueMap</span></a></p>
123
 
<p>
124
 
</p>
125
104
<div class="variablelist"><table border="0">
126
105
<col align="left" valign="top">
127
106
<tbody><tr>
134
113
<hr>
135
114
<div class="refsect2" title="rb_string_value_map_set ()">
136
115
<a name="rb-string-value-map-set"></a><h3>rb_string_value_map_set ()</h3>
137
 
<pre class="programlisting">void                rb_string_value_map_set             (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap">RBStringValueMap</a> *map,
138
 
                                                         const char *key,
139
 
                                                         const <a
140
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
141
 
>GValue</a> *value);</pre>
 
116
<pre class="programlisting"><span class="returnvalue">void</span>                rb_string_value_map_set             (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap"><span class="returnvalue">RBStringValueMap</span></a> *map,
 
117
                                                         const <span class="returnvalue">char</span> *key,
 
118
                                                         const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> *value);</pre>
142
119
<p>
143
120
Inserts a value into the map.  The value is copied.</p>
144
 
<p>
145
 
</p>
146
121
<div class="variablelist"><table border="0">
147
122
<col align="left" valign="top">
148
123
<tbody>
167
142
<hr>
168
143
<div class="refsect2" title="rb_string_value_map_get ()">
169
144
<a name="rb-string-value-map-get"></a><h3>rb_string_value_map_get ()</h3>
170
 
<pre class="programlisting"><a
171
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
172
 
>gboolean</a>            rb_string_value_map_get             (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap">RBStringValueMap</a> *map,
173
 
                                                         const char *key,
174
 
                                                         <a
175
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
176
 
>GValue</a> *out);</pre>
 
145
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_string_value_map_get             (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap"><span class="returnvalue">RBStringValueMap</span></a> *map,
 
146
                                                         const <span class="returnvalue">char</span> *key,
 
147
                                                         <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> *out);</pre>
177
148
<p>
178
149
Locates and copies the value associated with the key.</p>
179
 
<p>
180
 
</p>
181
150
<div class="variablelist"><table border="0">
182
151
<col align="left" valign="top">
183
152
<tbody>
198
167
</tr>
199
168
<tr>
200
169
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
201
 
<td> <code class="literal">TRUE</code> if the value was found
 
170
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the value was found
202
171
</td>
203
172
</tr>
204
173
</tbody>
207
176
<hr>
208
177
<div class="refsect2" title="rb_string_value_map_peek ()">
209
178
<a name="rb-string-value-map-peek"></a><h3>rb_string_value_map_peek ()</h3>
210
 
<pre class="programlisting">const <a
211
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
212
 
>GValue</a>*       rb_string_value_map_peek            (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap">RBStringValueMap</a> *map,
213
 
                                                         const char *key);</pre>
 
179
<pre class="programlisting">const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a>*       rb_string_value_map_peek            (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap"><span class="returnvalue">RBStringValueMap</span></a> *map,
 
180
                                                         const <span class="returnvalue">char</span> *key);</pre>
214
181
<p>
215
182
Locates the value associated with the key.  This returns the
216
183
GValue stored in the map, so it cannot be modified.</p>
217
 
<p>
218
 
</p>
219
184
<div class="variablelist"><table border="0">
220
185
<col align="left" valign="top">
221
186
<tbody>
240
205
<hr>
241
206
<div class="refsect2" title="rb_string_value_map_remove ()">
242
207
<a name="rb-string-value-map-remove"></a><h3>rb_string_value_map_remove ()</h3>
243
 
<pre class="programlisting"><a
244
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
245
 
>gboolean</a>            rb_string_value_map_remove          (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap">RBStringValueMap</a> *map,
246
 
                                                         const char *key);</pre>
 
208
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_string_value_map_remove          (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap"><span class="returnvalue">RBStringValueMap</span></a> *map,
 
209
                                                         const <span class="returnvalue">char</span> *key);</pre>
247
210
<p>
248
211
Removes a value from the map.</p>
249
 
<p>
250
 
</p>
251
212
<div class="variablelist"><table border="0">
252
213
<col align="left" valign="top">
253
214
<tbody>
263
224
</tr>
264
225
<tr>
265
226
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
266
 
<td> <code class="literal">TRUE</code> if the value was found and removed
 
227
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the value was found and removed
267
228
</td>
268
229
</tr>
269
230
</tbody>
272
233
<hr>
273
234
<div class="refsect2" title="rb_string_value_map_size ()">
274
235
<a name="rb-string-value-map-size"></a><h3>rb_string_value_map_size ()</h3>
275
 
<pre class="programlisting"><a
276
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
277
 
>guint</a>               rb_string_value_map_size            (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap">RBStringValueMap</a> *map);</pre>
 
236
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               rb_string_value_map_size            (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap"><span class="returnvalue">RBStringValueMap</span></a> *map);</pre>
278
237
<p>
279
238
Returns the number of entries in the map.</p>
280
 
<p>
281
 
</p>
282
239
<div class="variablelist"><table border="0">
283
240
<col align="left" valign="top">
284
241
<tbody>
298
255
<hr>
299
256
<div class="refsect2" title="rb_string_value_map_steal_hashtable ()">
300
257
<a name="rb-string-value-map-steal-hashtable"></a><h3>rb_string_value_map_steal_hashtable ()</h3>
301
 
<pre class="programlisting"><a
302
 
href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"
303
 
>GHashTable</a>*         rb_string_value_map_steal_hashtable (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap">RBStringValueMap</a> *map);</pre>
 
258
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a>*         rb_string_value_map_steal_hashtable (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap"><span class="returnvalue">RBStringValueMap</span></a> *map);</pre>
304
259
<p>
305
260
Extracts and returns the underlying hash table from the map,
306
261
and creates a new empty map.</p>
307
 
<p>
308
 
</p>
309
262
<div class="variablelist"><table border="0">
310
263
<col align="left" valign="top">
311
264
<tbody>
316
269
</tr>
317
270
<tr>
318
271
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
319
 
<td> <a
320
 
href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"
321
 
><span class="type">GHashTable</span></a> from the map
 
272
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> from the map
322
273
</td>
323
274
</tr>
324
275
</tbody>
328
279
</div>
329
280
<div class="footer">
330
281
<hr>
331
 
          Generated by GTK-Doc V1.11</div>
 
282
          Generated by GTK-Doc V1.13</div>
332
283
</body>
333
 
</html>
 
284
</html>
 
 
b'\\ No newline at end of file'