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
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RBStringValueMap</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="index.html" title="Rhythmbox Development Reference Manual">
<link rel="up" href="ch02.html" title="Lib">
<link rel="prev" href="rhythmbox-rb-builder-helpers.html" title="rb-builder-helpers">
<link rel="next" href="rhythmbox-rb-tree-dnd.html" title="rb-tree-dnd">
<meta name="generator" content="GTK-Doc V1.11 (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-builder-helpers.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.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-tree-dnd.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#RBStringValueMap.synopsis" class="shortcut">Top</a>
|
<a href="#RBStringValueMap.description" class="shortcut">Description</a>
|
<a href="#RBStringValueMap.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry" title="RBStringValueMap">
<a name="RBStringValueMap"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="RBStringValueMap.top_of_page"></a>RBStringValueMap</span></h2>
<p>RBStringValueMap — specialized hash table for storing string to GValue mappings</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="RBStringValueMap.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="RBStringValueMap.html#RBStringValueMap-struct" title="RBStringValueMap">RBStringValueMap</a>;
<a class="link" href="RBStringValueMap.html#RBStringValueMapClass" title="RBStringValueMapClass">RBStringValueMapClass</a>;
<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);
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,
const char *key,
const <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a> *value);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>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,
const char *key,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a> *out);
const <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>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,
const char *key);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>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,
const char *key);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>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);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"
>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);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="RBStringValueMap.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----RBStringValueMap
</pre>
</div>
<div class="refsect1" title="Description">
<a name="RBStringValueMap.description"></a><h2>Description</h2>
<p>
Simplifies the use of string:GValue maps with respect to copying of the values
inserted into the map. Except for rb_string_value_map_peek, the caller retains
ownership of values passed in, and assumes ownership of all values returned.</p>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="RBStringValueMap.details"></a><h2>Details</h2>
<div class="refsect2" title="RBStringValueMap">
<a name="RBStringValueMap-struct"></a><h3>RBStringValueMap</h3>
<pre class="programlisting">typedef struct _RBStringValueMap RBStringValueMap;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="RBStringValueMapClass">
<a name="RBStringValueMapClass"></a><h3>RBStringValueMapClass</h3>
<pre class="programlisting">typedef struct {
GObjectClass parent;
} RBStringValueMapClass;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="rb_string_value_map_new ()">
<a name="rb-string-value-map-new"></a><h3>rb_string_value_map_new ()</h3>
<pre class="programlisting"><a class="link" href="RBStringValueMap.html" title="RBStringValueMap">RBStringValueMap</a> * rb_string_value_map_new (void);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> new empty <a class="link" href="RBStringValueMap.html" title="RBStringValueMap"><span class="type">RBStringValueMap</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="rb_string_value_map_set ()">
<a name="rb-string-value-map-set"></a><h3>rb_string_value_map_set ()</h3>
<pre class="programlisting">void rb_string_value_map_set (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap">RBStringValueMap</a> *map,
const char *key,
const <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a> *value);</pre>
<p>
Inserts a value into the map. The value is copied.</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>map</code></em> :</span></p></td>
<td> a <a class="link" href="RBStringValueMap.html" title="RBStringValueMap"><span class="type">RBStringValueMap</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td> key to set
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td> value to store
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="rb_string_value_map_get ()">
<a name="rb-string-value-map-get"></a><h3>rb_string_value_map_get ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> rb_string_value_map_get (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap">RBStringValueMap</a> *map,
const char *key,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a> *out);</pre>
<p>
Locates and copies the value associated with the key.</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>map</code></em> :</span></p></td>
<td> a <a class="link" href="RBStringValueMap.html" title="RBStringValueMap"><span class="type">RBStringValueMap</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td> key to retrieve
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>out</code></em> :</span></p></td>
<td> returns a copy of the value in the map
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<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
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="rb_string_value_map_peek ()">
<a name="rb-string-value-map-peek"></a><h3>rb_string_value_map_peek ()</h3>
<pre class="programlisting">const <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a>* rb_string_value_map_peek (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap">RBStringValueMap</a> *map,
const char *key);</pre>
<p>
Locates the value associated with the key. This returns the
GValue stored in the map, so it cannot be modified.</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>map</code></em> :</span></p></td>
<td> a <a class="link" href="RBStringValueMap.html" title="RBStringValueMap"><span class="type">RBStringValueMap</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td> key to retrieve
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the GValue associated with the key
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="rb_string_value_map_remove ()">
<a name="rb-string-value-map-remove"></a><h3>rb_string_value_map_remove ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> rb_string_value_map_remove (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap">RBStringValueMap</a> *map,
const char *key);</pre>
<p>
Removes a value from the map.</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>map</code></em> :</span></p></td>
<td> a <a class="link" href="RBStringValueMap.html" title="RBStringValueMap"><span class="type">RBStringValueMap</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td> key to remove
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<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
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="rb_string_value_map_size ()">
<a name="rb-string-value-map-size"></a><h3>rb_string_value_map_size ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> rb_string_value_map_size (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap">RBStringValueMap</a> *map);</pre>
<p>
</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>map</code></em> :</span></p></td>
<td> a <a class="link" href="RBStringValueMap.html" title="RBStringValueMap"><span class="type">RBStringValueMap</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the number of entries in the map
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="rb_string_value_map_steal_hashtable ()">
<a name="rb-string-value-map-steal-hashtable"></a><h3>rb_string_value_map_steal_hashtable ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"
>GHashTable</a>* rb_string_value_map_steal_hashtable (<a class="link" href="RBStringValueMap.html" title="RBStringValueMap">RBStringValueMap</a> *map);</pre>
<p>
Extracts and returns the underlying hash table from the map,
and creates a new empty map.</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>map</code></em> :</span></p></td>
<td> a <a class="link" href="RBStringValueMap.html" title="RBStringValueMap"><span class="type">RBStringValueMap</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a
href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"
><span class="type">GHashTable</span></a> from the map
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>
|