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
|
<?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="RBStringValueMap">
<refmeta>
<refentrytitle role="top_of_page" id="RBStringValueMap.top_of_page">RBStringValueMap</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>RBStringValueMap</refname>
<refpurpose>specialized hash table for storing string to GValue mappings</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="RBStringValueMap.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="RBStringValueMap-struct">RBStringValueMap</link>;
<link linkend="RBStringValueMapClass">RBStringValueMapClass</link>;
<link linkend="RBStringValueMap">RBStringValueMap</link>* <link linkend="rb-string-value-map-new">rb_string_value_map_new</link> (void);
<link linkend="void">void</link> <link linkend="rb-string-value-map-set">rb_string_value_map_set</link> (<link linkend="RBStringValueMap">RBStringValueMap</link> *map,
const <link linkend="char">char</link> *key,
const <link linkend="GValue">GValue</link> *value);
<link linkend="gboolean">gboolean</link> <link linkend="rb-string-value-map-get">rb_string_value_map_get</link> (<link linkend="RBStringValueMap">RBStringValueMap</link> *map,
const <link linkend="char">char</link> *key,
<link linkend="GValue">GValue</link> *out);
const <link linkend="GValue">GValue</link>* <link linkend="rb-string-value-map-peek">rb_string_value_map_peek</link> (<link linkend="RBStringValueMap">RBStringValueMap</link> *map,
const <link linkend="char">char</link> *key);
<link linkend="gboolean">gboolean</link> <link linkend="rb-string-value-map-remove">rb_string_value_map_remove</link> (<link linkend="RBStringValueMap">RBStringValueMap</link> *map,
const <link linkend="char">char</link> *key);
<link linkend="guint">guint</link> <link linkend="rb-string-value-map-size">rb_string_value_map_size</link> (<link linkend="RBStringValueMap">RBStringValueMap</link> *map);
<link linkend="GHashTable">GHashTable</link>* <link linkend="rb-string-value-map-steal-hashtable">rb_string_value_map_steal_hashtable</link> (<link linkend="RBStringValueMap">RBStringValueMap</link> *map);
</synopsis>
</refsynopsisdiv>
<refsect1 id="RBStringValueMap.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----RBStringValueMap
</synopsis>
</refsect1>
<refsect1 id="RBStringValueMap.description" role="desc">
<title role="desc.title">Description</title>
<para>
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.</para>
<para>
</para>
</refsect1>
<refsect1 id="RBStringValueMap.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="RBStringValueMap-struct" role="struct">
<title>RBStringValueMap</title>
<indexterm zone="RBStringValueMap-struct"><primary>RBStringValueMap</primary></indexterm><programlisting>typedef struct _RBStringValueMap RBStringValueMap;</programlisting>
<para>
</para></refsect2>
<refsect2 id="RBStringValueMapClass" role="struct">
<title>RBStringValueMapClass</title>
<indexterm zone="RBStringValueMapClass"><primary>RBStringValueMapClass</primary></indexterm><programlisting>typedef struct {
GObjectClass parent;
} RBStringValueMapClass;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="rb-string-value-map-new" role="function">
<title>rb_string_value_map_new ()</title>
<indexterm zone="rb-string-value-map-new"><primary>rb_string_value_map_new</primary></indexterm><programlisting><link linkend="RBStringValueMap">RBStringValueMap</link>* rb_string_value_map_new (void);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> new empty <link linkend="RBStringValueMap"><type>RBStringValueMap</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-string-value-map-set" role="function">
<title>rb_string_value_map_set ()</title>
<indexterm zone="rb-string-value-map-set"><primary>rb_string_value_map_set</primary></indexterm><programlisting><link linkend="void">void</link> rb_string_value_map_set (<link linkend="RBStringValueMap">RBStringValueMap</link> *map,
const <link linkend="char">char</link> *key,
const <link linkend="GValue">GValue</link> *value);</programlisting>
<para>
Inserts a value into the map. The value is copied.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>map</parameter> :</term>
<listitem><simpara> a <link linkend="RBStringValueMap"><type>RBStringValueMap</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>key</parameter> :</term>
<listitem><simpara> key to set
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> value to store
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-string-value-map-get" role="function">
<title>rb_string_value_map_get ()</title>
<indexterm zone="rb-string-value-map-get"><primary>rb_string_value_map_get</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_string_value_map_get (<link linkend="RBStringValueMap">RBStringValueMap</link> *map,
const <link linkend="char">char</link> *key,
<link linkend="GValue">GValue</link> *out);</programlisting>
<para>
Locates and copies the value associated with the key.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>map</parameter> :</term>
<listitem><simpara> a <link linkend="RBStringValueMap"><type>RBStringValueMap</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>key</parameter> :</term>
<listitem><simpara> key to retrieve
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>out</parameter> :</term>
<listitem><simpara> returns a copy of the value in the map
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the value was found
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-string-value-map-peek" role="function">
<title>rb_string_value_map_peek ()</title>
<indexterm zone="rb-string-value-map-peek"><primary>rb_string_value_map_peek</primary></indexterm><programlisting>const <link linkend="GValue">GValue</link>* rb_string_value_map_peek (<link linkend="RBStringValueMap">RBStringValueMap</link> *map,
const <link linkend="char">char</link> *key);</programlisting>
<para>
Locates the value associated with the key. This returns the
GValue stored in the map, so it cannot be modified.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>map</parameter> :</term>
<listitem><simpara> a <link linkend="RBStringValueMap"><type>RBStringValueMap</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>key</parameter> :</term>
<listitem><simpara> key to retrieve
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the GValue associated with the key
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-string-value-map-remove" role="function">
<title>rb_string_value_map_remove ()</title>
<indexterm zone="rb-string-value-map-remove"><primary>rb_string_value_map_remove</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_string_value_map_remove (<link linkend="RBStringValueMap">RBStringValueMap</link> *map,
const <link linkend="char">char</link> *key);</programlisting>
<para>
Removes a value from the map.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>map</parameter> :</term>
<listitem><simpara> a <link linkend="RBStringValueMap"><type>RBStringValueMap</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>key</parameter> :</term>
<listitem><simpara> key to remove
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the value was found and removed
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-string-value-map-size" role="function">
<title>rb_string_value_map_size ()</title>
<indexterm zone="rb-string-value-map-size"><primary>rb_string_value_map_size</primary></indexterm><programlisting><link linkend="guint">guint</link> rb_string_value_map_size (<link linkend="RBStringValueMap">RBStringValueMap</link> *map);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>map</parameter> :</term>
<listitem><simpara> a <link linkend="RBStringValueMap"><type>RBStringValueMap</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the number of entries in the map
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-string-value-map-steal-hashtable" role="function">
<title>rb_string_value_map_steal_hashtable ()</title>
<indexterm zone="rb-string-value-map-steal-hashtable"><primary>rb_string_value_map_steal_hashtable</primary></indexterm><programlisting><link linkend="GHashTable">GHashTable</link>* rb_string_value_map_steal_hashtable (<link linkend="RBStringValueMap">RBStringValueMap</link> *map);</programlisting>
<para>
Extracts and returns the underlying hash table from the map,
and creates a new empty map.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>map</parameter> :</term>
<listitem><simpara> a <link linkend="RBStringValueMap"><type>RBStringValueMap</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="GHashTable"><type>GHashTable</type></link> from the map
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
