← Back to branch summary

~ubuntu-branches/ubuntu/trusty/glib2.0/trusty-proposed

« back to all changes in this revision

Viewing changes to docs/reference/glib/html/glib-Keyed-Data-Lists.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-09 11:28:22 UTC
  • mfrom: (3.4.8 experimental)
  • Revision ID: james.westby@ubuntu.com-20100309112822-j4n0v3xbtsup8s97
Tags: 2.23.5-1ubuntu1
* Resync on Debian
* debian/patches/01_gettext-desktopfiles.patch:
  - updated to use gettext for X-GNOME-Fullname too
* debian/patches/71_gio_launch_handler.patch:
  - new gio default launch handle feature required for wncksync
* debian/control.in, 
  debian/patches/80-gtester-subunit.patch:
  - gtester-report subunit support
* debian/libglib2.0-0.symbols:
  - updated the symbols list for the gio launcher handler
* debian/rules:
  - don't break build on test suite errors, debian recently activated this but
    the build breaks even when there is no error in the testsuite

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/glib/html/glib-Keyed-Data-Lists.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>Keyed Data Lists</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
7
7
<link rel="home" href="index.html" title="GLib Reference Manual">
8
8
<link rel="up" href="glib-data-types.html" title="GLib Data Types">
9
9
<link rel="prev" href="glib-Quarks.html" title="Quarks">
10
10
<link rel="next" href="glib-Datasets.html" title="Datasets">
11
 
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="chapter" href="glib.html" title="GLib Overview">
14
14
<link rel="chapter" href="glib-fundamentals.html" title="GLib Fundamentals">
42
42
</tr>
43
43
<tr><td colspan="5" class="shortcuts">
44
44
<a href="#glib-Keyed-Data-Lists.synopsis" class="shortcut">Top</a>
45
 
                   | 
46
 
                  <a href="#glib-Keyed-Data-Lists.description" class="shortcut">Description</a>
 
45
                 | 
 
46
                <a href="#glib-Keyed-Data-Lists.description" class="shortcut">Description</a>
47
47
</td></tr>
48
48
</table>
49
49
<div class="refentry" title="Keyed Data Lists">
59
59
<div class="refsynopsisdiv" title="Synopsis">
60
60
<a name="glib-Keyed-Data-Lists.synopsis"></a><h2>Synopsis</h2>
61
61
<pre class="synopsis">
 
62
 
62
63
#include &lt;glib.h&gt;
63
64
 
64
65
                    <a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData">GData</a>;
65
 
<span class="returnvalue">void</span>                <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-init" title="g_datalist_init ()">g_datalist_init</a>                     (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData"><span class="returnvalue">GData</span></a> **datalist);
 
66
void                <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-init" title="g_datalist_init ()">g_datalist_init</a>                     (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData">GData</a> **datalist);
66
67
 
67
68
#define             <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-id-set-data" title="g_datalist_id_set_data()">g_datalist_id_set_data</a>              (dl, q, d)
68
 
<span class="returnvalue">void</span>                <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-id-set-data-full" title="g_datalist_id_set_data_full ()">g_datalist_id_set_data_full</a>         (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData"><span class="returnvalue">GData</span></a> **datalist,
69
 
                                                         <a class="link" href="glib-Quarks.html#GQuark" title="GQuark"><span class="returnvalue">GQuark</span></a> key_id,
70
 
                                                         <a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="returnvalue">gpointer</span></a> data,
71
 
                                                         <a class="link" href="glib-Datasets.html#GDestroyNotify" title="GDestroyNotify ()"><span class="returnvalue">GDestroyNotify</span></a> destroy_func);
72
 
<a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="returnvalue">gpointer</span></a>            <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-id-get-data" title="g_datalist_id_get_data ()">g_datalist_id_get_data</a>              (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData"><span class="returnvalue">GData</span></a> **datalist,
73
 
                                                         <a class="link" href="glib-Quarks.html#GQuark" title="GQuark"><span class="returnvalue">GQuark</span></a> key_id);
 
69
void                <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-id-set-data-full" title="g_datalist_id_set_data_full ()">g_datalist_id_set_data_full</a>         (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData">GData</a> **datalist,
 
70
                                                         <a class="link" href="glib-Quarks.html#GQuark" title="GQuark">GQuark</a> key_id,
 
71
                                                         <a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer">gpointer</a> data,
 
72
                                                         <a class="link" href="glib-Datasets.html#GDestroyNotify" title="GDestroyNotify ()">GDestroyNotify</a> destroy_func);
 
73
<a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer">gpointer</a>            <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-id-get-data" title="g_datalist_id_get_data ()">g_datalist_id_get_data</a>              (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData">GData</a> **datalist,
 
74
                                                         <a class="link" href="glib-Quarks.html#GQuark" title="GQuark">GQuark</a> key_id);
74
75
#define             <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-id-remove-data" title="g_datalist_id_remove_data()">g_datalist_id_remove_data</a>           (dl, q)
75
 
<a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="returnvalue">gpointer</span></a>            <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-id-remove-no-notify" title="g_datalist_id_remove_no_notify ()">g_datalist_id_remove_no_notify</a>      (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData"><span class="returnvalue">GData</span></a> **datalist,
76
 
                                                         <a class="link" href="glib-Quarks.html#GQuark" title="GQuark"><span class="returnvalue">GQuark</span></a> key_id);
 
76
<a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer">gpointer</a>            <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-id-remove-no-notify" title="g_datalist_id_remove_no_notify ()">g_datalist_id_remove_no_notify</a>      (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData">GData</a> **datalist,
 
77
                                                         <a class="link" href="glib-Quarks.html#GQuark" title="GQuark">GQuark</a> key_id);
77
78
 
78
79
#define             <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-set-data" title="g_datalist_set_data()">g_datalist_set_data</a>                 (dl, k, d)
79
80
#define             <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-set-data-full" title="g_datalist_set_data_full()">g_datalist_set_data_full</a>            (dl, k, d, f)
81
82
#define             <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-remove-data" title="g_datalist_remove_data()">g_datalist_remove_data</a>              (dl, k)
82
83
#define             <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-remove-no-notify" title="g_datalist_remove_no_notify()">g_datalist_remove_no_notify</a>         (dl, k)
83
84
 
84
 
<span class="returnvalue">void</span>                <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-foreach" title="g_datalist_foreach ()">g_datalist_foreach</a>                  (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData"><span class="returnvalue">GData</span></a> **datalist,
85
 
                                                         <a class="link" href="glib-Datasets.html#GDataForeachFunc" title="GDataForeachFunc ()"><span class="returnvalue">GDataForeachFunc</span></a> func,
86
 
                                                         <a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="returnvalue">gpointer</span></a> user_data);
87
 
<span class="returnvalue">void</span>                <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-clear" title="g_datalist_clear ()">g_datalist_clear</a>                    (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData"><span class="returnvalue">GData</span></a> **datalist);
88
 
<span class="returnvalue">void</span>                <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-set-flags" title="g_datalist_set_flags ()">g_datalist_set_flags</a>                (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData"><span class="returnvalue">GData</span></a> **datalist,
89
 
                                                         <a class="link" href="glib-Basic-Types.html#guint" title="guint"><span class="returnvalue">guint</span></a> flags);
90
 
<span class="returnvalue">void</span>                <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-unset-flags" title="g_datalist_unset_flags ()">g_datalist_unset_flags</a>              (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData"><span class="returnvalue">GData</span></a> **datalist,
91
 
                                                         <a class="link" href="glib-Basic-Types.html#guint" title="guint"><span class="returnvalue">guint</span></a> flags);
92
 
<a class="link" href="glib-Basic-Types.html#guint" title="guint"><span class="returnvalue">guint</span></a>               <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-get-flags" title="g_datalist_get_flags ()">g_datalist_get_flags</a>                (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData"><span class="returnvalue">GData</span></a> **datalist);
93
 
#define             <a class="link" href="glib-Keyed-Data-Lists.html#G-DATALIST-FLAGS-MASK:CAPS" title="G_DATALIST_FLAGS_MASK">G_DATALIST_FLAGS_MASK</a>
 
85
void                <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-foreach" title="g_datalist_foreach ()">g_datalist_foreach</a>                  (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData">GData</a> **datalist,
 
86
                                                         <a class="link" href="glib-Datasets.html#GDataForeachFunc" title="GDataForeachFunc ()">GDataForeachFunc</a> func,
 
87
                                                         <a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer">gpointer</a> user_data);
 
88
void                <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-clear" title="g_datalist_clear ()">g_datalist_clear</a>                    (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData">GData</a> **datalist);
 
89
void                <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-set-flags" title="g_datalist_set_flags ()">g_datalist_set_flags</a>                (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData">GData</a> **datalist,
 
90
                                                         <a class="link" href="glib-Basic-Types.html#guint" title="guint">guint</a> flags);
 
91
void                <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-unset-flags" title="g_datalist_unset_flags ()">g_datalist_unset_flags</a>              (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData">GData</a> **datalist,
 
92
                                                         <a class="link" href="glib-Basic-Types.html#guint" title="guint">guint</a> flags);
 
93
<a class="link" href="glib-Basic-Types.html#guint" title="guint">guint</a>               <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-get-flags" title="g_datalist_get_flags ()">g_datalist_get_flags</a>                (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData">GData</a> **datalist);
 
94
#define             <a class="link" href="glib-Keyed-Data-Lists.html#G-DATALIST-FLAGS-MASK--CAPS" title="G_DATALIST_FLAGS_MASK">G_DATALIST_FLAGS_MASK</a>
94
95
</pre>
95
96
</div>
96
97
<div class="refsect1" title="Description">
102
103
</p>
103
104
<p>
104
105
The <a class="link" href="glib-Quarks.html#GQuark" title="GQuark"><span class="type">GQuark</span></a> methods are quicker, since the strings have to be
105
 
converted to <a href="glib-Quarks.html#GQuark"><span class="type">GQuarks</span></a> anyway.
 
106
converted to <span class="type">GQuarks</span> anyway.
106
107
</p>
107
108
<p>
108
 
Data lists are used for associating arbitrary data with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObjects</span></a>,
109
 
using <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-set-data"><code class="function">g_object_set_data()</code></a> and related functions.
 
109
Data lists are used for associating arbitrary data with <span class="type">GObjects</span>,
 
110
using <code class="function">g_object_set_data()</code> and related functions.
110
111
</p>
111
112
<p>
112
113
To create a datalist, use <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-init" title="g_datalist_init ()"><code class="function">g_datalist_init()</code></a>.
130
131
</p>
131
132
<p>
132
133
To remove all data elements from a datalist, use <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-clear" title="g_datalist_clear ()"><code class="function">g_datalist_clear()</code></a>.</p>
 
134
<p>
 
135
</p>
133
136
</div>
134
137
<div class="refsect1" title="Details">
135
138
<a name="glib-Keyed-Data-Lists.details"></a><h2>Details</h2>
139
142
<p>
140
143
The <a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData"><span class="type">GData</span></a> struct is an opaque data structure to represent a <a class="link" href="glib-Keyed-Data-Lists.html" title="Keyed Data Lists">Keyed Data List</a>. It should
141
144
only be accessed via the following functions.</p>
 
145
<p>
 
146
</p>
142
147
</div>
143
148
<hr>
144
149
<div class="refsect2" title="g_datalist_init ()">
145
150
<a name="g-datalist-init"></a><h3>g_datalist_init ()</h3>
146
 
<pre class="programlisting"><span class="returnvalue">void</span>                g_datalist_init                     (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData"><span class="returnvalue">GData</span></a> **datalist);</pre>
 
151
<pre class="programlisting">void                g_datalist_init                     (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData">GData</a> **datalist);</pre>
147
152
<p>
148
 
Resets the datalist to <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. It does not free any memory or call
 
153
Resets the datalist to <a class="link" href="glib-Standard-Macros.html#NULL--CAPS" title="NULL"><code class="literal">NULL</code></a>. It does not free any memory or call
149
154
any destroy functions.</p>
 
155
<p>
 
156
</p>
150
157
<div class="variablelist"><table border="0">
151
158
<col align="left" valign="top">
152
159
<tbody><tr>
164
171
Sets the data corresponding to the given <a class="link" href="glib-Quarks.html#GQuark" title="GQuark"><span class="type">GQuark</span></a> id. Any previous
165
172
data with the same key is removed, and its destroy function is
166
173
called.</p>
 
174
<p>
 
175
</p>
167
176
<div class="variablelist"><table border="0">
168
177
<col align="left" valign="top">
169
178
<tbody>
179
188
</tr>
180
189
<tr>
181
190
<td><p><span class="term"><em class="parameter"><code>d</code></em> :</span></p></td>
182
 
<td> the data element, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> to remove any previous element
 
191
<td> the data element, or <a class="link" href="glib-Standard-Macros.html#NULL--CAPS" title="NULL"><code class="literal">NULL</code></a> to remove any previous element
183
192
    corresponding to <em class="parameter"><code>q</code></em>.
184
193
</td>
185
194
</tr>
189
198
<hr>
190
199
<div class="refsect2" title="g_datalist_id_set_data_full ()">
191
200
<a name="g-datalist-id-set-data-full"></a><h3>g_datalist_id_set_data_full ()</h3>
192
 
<pre class="programlisting"><span class="returnvalue">void</span>                g_datalist_id_set_data_full         (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData"><span class="returnvalue">GData</span></a> **datalist,
193
 
                                                         <a class="link" href="glib-Quarks.html#GQuark" title="GQuark"><span class="returnvalue">GQuark</span></a> key_id,
194
 
                                                         <a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="returnvalue">gpointer</span></a> data,
195
 
                                                         <a class="link" href="glib-Datasets.html#GDestroyNotify" title="GDestroyNotify ()"><span class="returnvalue">GDestroyNotify</span></a> destroy_func);</pre>
 
201
<pre class="programlisting">void                g_datalist_id_set_data_full         (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData">GData</a> **datalist,
 
202
                                                         <a class="link" href="glib-Quarks.html#GQuark" title="GQuark">GQuark</a> key_id,
 
203
                                                         <a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer">gpointer</a> data,
 
204
                                                         <a class="link" href="glib-Datasets.html#GDestroyNotify" title="GDestroyNotify ()">GDestroyNotify</a> destroy_func);</pre>
196
205
<p>
197
206
Sets the data corresponding to the given <a class="link" href="glib-Quarks.html#GQuark" title="GQuark"><span class="type">GQuark</span></a> id, and the
198
207
function to be called when the element is removed from the datalist.
199
208
Any previous data with the same key is removed, and its destroy
200
209
function is called.</p>
 
210
<p>
 
211
</p>
201
212
<div class="variablelist"><table border="0">
202
213
<col align="left" valign="top">
203
214
<tbody>
213
224
</tr>
214
225
<tr>
215
226
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
216
 
<td> the data element or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> to remove any previous element
 
227
<td> the data element or <a class="link" href="glib-Standard-Macros.html#NULL--CAPS" title="NULL"><code class="literal">NULL</code></a> to remove any previous element
217
228
       corresponding to <em class="parameter"><code>key_id</code></em>.
218
229
</td>
219
230
</tr>
222
233
<td> the function to call when the data element is
223
234
               removed. This function will be called with the data
224
235
               element and can be used to free any memory allocated
225
 
               for it. If <em class="parameter"><code>data</code></em> is <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>, then <em class="parameter"><code>destroy_func</code></em> must
226
 
               also be <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>.
 
236
               for it. If <em class="parameter"><code>data</code></em> is <a class="link" href="glib-Standard-Macros.html#NULL--CAPS" title="NULL"><code class="literal">NULL</code></a>, then <em class="parameter"><code>destroy_func</code></em> must
 
237
               also be <a class="link" href="glib-Standard-Macros.html#NULL--CAPS" title="NULL"><code class="literal">NULL</code></a>.
227
238
</td>
228
239
</tr>
229
240
</tbody>
232
243
<hr>
233
244
<div class="refsect2" title="g_datalist_id_get_data ()">
234
245
<a name="g-datalist-id-get-data"></a><h3>g_datalist_id_get_data ()</h3>
235
 
<pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="returnvalue">gpointer</span></a>            g_datalist_id_get_data              (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData"><span class="returnvalue">GData</span></a> **datalist,
236
 
                                                         <a class="link" href="glib-Quarks.html#GQuark" title="GQuark"><span class="returnvalue">GQuark</span></a> key_id);</pre>
 
246
<pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer">gpointer</a>            g_datalist_id_get_data              (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData">GData</a> **datalist,
 
247
                                                         <a class="link" href="glib-Quarks.html#GQuark" title="GQuark">GQuark</a> key_id);</pre>
237
248
<p>
238
249
Retrieves the data element corresponding to <em class="parameter"><code>key_id</code></em>.</p>
 
250
<p>
 
251
</p>
239
252
<div class="variablelist"><table border="0">
240
253
<col align="left" valign="top">
241
254
<tbody>
251
264
</tr>
252
265
<tr>
253
266
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
254
 
<td> the data element, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if it is not found.
 
267
<td> the data element, or <a class="link" href="glib-Standard-Macros.html#NULL--CAPS" title="NULL"><code class="literal">NULL</code></a> if it is not found.
255
268
</td>
256
269
</tr>
257
270
</tbody>
263
276
<pre class="programlisting">#define             g_datalist_id_remove_data(dl, q)</pre>
264
277
<p>
265
278
Removes an element, using its <a class="link" href="glib-Quarks.html#GQuark" title="GQuark"><span class="type">GQuark</span></a> identifier.</p>
 
279
<p>
 
280
</p>
266
281
<div class="variablelist"><table border="0">
267
282
<col align="left" valign="top">
268
283
<tbody>
282
297
<hr>
283
298
<div class="refsect2" title="g_datalist_id_remove_no_notify ()">
284
299
<a name="g-datalist-id-remove-no-notify"></a><h3>g_datalist_id_remove_no_notify ()</h3>
285
 
<pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="returnvalue">gpointer</span></a>            g_datalist_id_remove_no_notify      (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData"><span class="returnvalue">GData</span></a> **datalist,
286
 
                                                         <a class="link" href="glib-Quarks.html#GQuark" title="GQuark"><span class="returnvalue">GQuark</span></a> key_id);</pre>
 
300
<pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer">gpointer</a>            g_datalist_id_remove_no_notify      (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData">GData</a> **datalist,
 
301
                                                         <a class="link" href="glib-Quarks.html#GQuark" title="GQuark">GQuark</a> key_id);</pre>
287
302
<p>
288
303
Removes an element, without calling its destroy notification
289
304
function.</p>
 
305
<p>
 
306
</p>
290
307
<div class="variablelist"><table border="0">
291
308
<col align="left" valign="top">
292
309
<tbody>
302
319
</tr>
303
320
<tr>
304
321
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
305
 
<td> the data previously stored at <em class="parameter"><code>key_id</code></em>, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if none.
 
322
<td> the data previously stored at <em class="parameter"><code>key_id</code></em>, or <a class="link" href="glib-Standard-Macros.html#NULL--CAPS" title="NULL"><code class="literal">NULL</code></a> if none.
306
323
</td>
307
324
</tr>
308
325
</tbody>
314
331
<pre class="programlisting">#define             g_datalist_set_data(dl, k, d)</pre>
315
332
<p>
316
333
Sets the data element corresponding to the given string identifier.</p>
 
334
<p>
 
335
</p>
317
336
<div class="variablelist"><table border="0">
318
337
<col align="left" valign="top">
319
338
<tbody>
329
348
</tr>
330
349
<tr>
331
350
<td><p><span class="term"><em class="parameter"><code>d</code></em> :</span></p></td>
332
 
<td> the data element, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> to remove any previous element
 
351
<td> the data element, or <a class="link" href="glib-Standard-Macros.html#NULL--CAPS" title="NULL"><code class="literal">NULL</code></a> to remove any previous element
333
352
    corresponding to <em class="parameter"><code>k</code></em>.
334
353
</td>
335
354
</tr>
343
362
<p>
344
363
Sets the data element corresponding to the given string identifier,
345
364
and the function to be called when the data element is removed.</p>
 
365
<p>
 
366
</p>
346
367
<div class="variablelist"><table border="0">
347
368
<col align="left" valign="top">
348
369
<tbody>
358
379
</tr>
359
380
<tr>
360
381
<td><p><span class="term"><em class="parameter"><code>d</code></em> :</span></p></td>
361
 
<td> the data element, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> to remove any previous element
 
382
<td> the data element, or <a class="link" href="glib-Standard-Macros.html#NULL--CAPS" title="NULL"><code class="literal">NULL</code></a> to remove any previous element
362
383
    corresponding to <em class="parameter"><code>k</code></em>.
363
384
</td>
364
385
</tr>
366
387
<td><p><span class="term"><em class="parameter"><code>f</code></em> :</span></p></td>
367
388
<td> the function to call when the data element is removed. This
368
389
    function will be called with the data element and can be used to
369
 
    free any memory allocated for it. If <em class="parameter"><code>d</code></em> is <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>, then <em class="parameter"><code>f</code></em> must
370
 
    also be <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>.
 
390
    free any memory allocated for it. If <em class="parameter"><code>d</code></em> is <a class="link" href="glib-Standard-Macros.html#NULL--CAPS" title="NULL"><code class="literal">NULL</code></a>, then <em class="parameter"><code>f</code></em> must
 
391
    also be <a class="link" href="glib-Standard-Macros.html#NULL--CAPS" title="NULL"><code class="literal">NULL</code></a>.
371
392
</td>
372
393
</tr>
373
394
</tbody>
381
402
Gets a data element, using its string identifer. This is slower than
382
403
<a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-id-get-data" title="g_datalist_id_get_data ()"><code class="function">g_datalist_id_get_data()</code></a> because the string is first converted to a
383
404
<a class="link" href="glib-Quarks.html#GQuark" title="GQuark"><span class="type">GQuark</span></a>.</p>
 
405
<p>
 
406
</p>
384
407
<div class="variablelist"><table border="0">
385
408
<col align="left" valign="top">
386
409
<tbody>
394
417
<td> the string identifying a data element.
395
418
</td>
396
419
</tr>
397
 
<tr>
398
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
399
 
<td> the data element, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if it is not found.
400
 
</td>
401
 
</tr>
402
420
</tbody>
403
421
</table></div>
404
422
</div>
409
427
<p>
410
428
Removes an element using its string identifier. The data element's
411
429
destroy function is called if it has been set.</p>
 
430
<p>
 
431
</p>
412
432
<div class="variablelist"><table border="0">
413
433
<col align="left" valign="top">
414
434
<tbody>
431
451
<pre class="programlisting">#define             g_datalist_remove_no_notify(dl, k)</pre>
432
452
<p>
433
453
Removes an element, without calling its destroy notifier.</p>
 
454
<p>
 
455
</p>
434
456
<div class="variablelist"><table border="0">
435
457
<col align="left" valign="top">
436
458
<tbody>
450
472
<hr>
451
473
<div class="refsect2" title="g_datalist_foreach ()">
452
474
<a name="g-datalist-foreach"></a><h3>g_datalist_foreach ()</h3>
453
 
<pre class="programlisting"><span class="returnvalue">void</span>                g_datalist_foreach                  (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData"><span class="returnvalue">GData</span></a> **datalist,
454
 
                                                         <a class="link" href="glib-Datasets.html#GDataForeachFunc" title="GDataForeachFunc ()"><span class="returnvalue">GDataForeachFunc</span></a> func,
455
 
                                                         <a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="returnvalue">gpointer</span></a> user_data);</pre>
 
475
<pre class="programlisting">void                g_datalist_foreach                  (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData">GData</a> **datalist,
 
476
                                                         <a class="link" href="glib-Datasets.html#GDataForeachFunc" title="GDataForeachFunc ()">GDataForeachFunc</a> func,
 
477
                                                         <a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer">gpointer</a> user_data);</pre>
456
478
<p>
457
479
Calls the given function for each data element of the datalist. The
458
480
function is called with each data element's <a class="link" href="glib-Quarks.html#GQuark" title="GQuark"><span class="type">GQuark</span></a> id and data,
460
482
function is NOT thread-safe. So unless <em class="parameter"><code>datalist</code></em> can be protected
461
483
from any modifications during invocation of this function, it should
462
484
not be called.</p>
 
485
<p>
 
486
</p>
463
487
<div class="variablelist"><table border="0">
464
488
<col align="left" valign="top">
465
489
<tbody>
484
508
<hr>
485
509
<div class="refsect2" title="g_datalist_clear ()">
486
510
<a name="g-datalist-clear"></a><h3>g_datalist_clear ()</h3>
487
 
<pre class="programlisting"><span class="returnvalue">void</span>                g_datalist_clear                    (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData"><span class="returnvalue">GData</span></a> **datalist);</pre>
 
511
<pre class="programlisting">void                g_datalist_clear                    (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData">GData</a> **datalist);</pre>
488
512
<p>
489
513
Frees all the data elements of the datalist. The data elements'
490
514
destroy functions are called if they have been set.</p>
 
515
<p>
 
516
</p>
491
517
<div class="variablelist"><table border="0">
492
518
<col align="left" valign="top">
493
519
<tbody><tr>
500
526
<hr>
501
527
<div class="refsect2" title="g_datalist_set_flags ()">
502
528
<a name="g-datalist-set-flags"></a><h3>g_datalist_set_flags ()</h3>
503
 
<pre class="programlisting"><span class="returnvalue">void</span>                g_datalist_set_flags                (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData"><span class="returnvalue">GData</span></a> **datalist,
504
 
                                                         <a class="link" href="glib-Basic-Types.html#guint" title="guint"><span class="returnvalue">guint</span></a> flags);</pre>
 
529
<pre class="programlisting">void                g_datalist_set_flags                (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData">GData</a> **datalist,
 
530
                                                         <a class="link" href="glib-Basic-Types.html#guint" title="guint">guint</a> flags);</pre>
505
531
<p>
506
532
Turns on flag values for a data list. This function is used
507
533
to keep a small number of boolean flags in an object with
508
534
a data list without using any additional space. It is
509
535
not generally useful except in circumstances where space
510
 
is very tight. (It is used in the base <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> type, for
 
536
is very tight. (It is used in the base <span class="type">GObject</span> type, for
511
537
example.)</p>
 
538
<p>
 
539
</p>
512
540
<div class="variablelist"><table border="0">
513
541
<col align="left" valign="top">
514
542
<tbody>
520
548
<tr>
521
549
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
522
550
<td> the flags to turn on. The values of the flags are
523
 
  restricted by <a class="link" href="glib-Keyed-Data-Lists.html#G-DATALIST-FLAGS-MASK:CAPS" title="G_DATALIST_FLAGS_MASK"><code class="literal">G_DATALIST_FLAGS_MASK</code></a> (currently
 
551
  restricted by <a class="link" href="glib-Keyed-Data-Lists.html#G-DATALIST-FLAGS-MASK--CAPS" title="G_DATALIST_FLAGS_MASK"><code class="literal">G_DATALIST_FLAGS_MASK</code></a> (currently
524
552
  3; giving two possible boolean flags).
525
553
  A value for <em class="parameter"><code>flags</code></em> that doesn't fit within the mask is
526
554
  an error.
533
561
<hr>
534
562
<div class="refsect2" title="g_datalist_unset_flags ()">
535
563
<a name="g-datalist-unset-flags"></a><h3>g_datalist_unset_flags ()</h3>
536
 
<pre class="programlisting"><span class="returnvalue">void</span>                g_datalist_unset_flags              (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData"><span class="returnvalue">GData</span></a> **datalist,
537
 
                                                         <a class="link" href="glib-Basic-Types.html#guint" title="guint"><span class="returnvalue">guint</span></a> flags);</pre>
 
564
<pre class="programlisting">void                g_datalist_unset_flags              (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData">GData</a> **datalist,
 
565
                                                         <a class="link" href="glib-Basic-Types.html#guint" title="guint">guint</a> flags);</pre>
538
566
<p>
539
567
Turns off flag values for a data list. See <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-unset-flags" title="g_datalist_unset_flags ()"><code class="function">g_datalist_unset_flags()</code></a></p>
 
568
<p>
 
569
</p>
540
570
<div class="variablelist"><table border="0">
541
571
<col align="left" valign="top">
542
572
<tbody>
548
578
<tr>
549
579
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
550
580
<td> the flags to turn off. The values of the flags are
551
 
  restricted by <a class="link" href="glib-Keyed-Data-Lists.html#G-DATALIST-FLAGS-MASK:CAPS" title="G_DATALIST_FLAGS_MASK"><code class="literal">G_DATALIST_FLAGS_MASK</code></a> (currently
 
581
  restricted by <a class="link" href="glib-Keyed-Data-Lists.html#G-DATALIST-FLAGS-MASK--CAPS" title="G_DATALIST_FLAGS_MASK"><code class="literal">G_DATALIST_FLAGS_MASK</code></a> (currently
552
582
  3: giving two possible boolean flags).
553
583
  A value for <em class="parameter"><code>flags</code></em> that doesn't fit within the mask is
554
584
  an error.
561
591
<hr>
562
592
<div class="refsect2" title="g_datalist_get_flags ()">
563
593
<a name="g-datalist-get-flags"></a><h3>g_datalist_get_flags ()</h3>
564
 
<pre class="programlisting"><a class="link" href="glib-Basic-Types.html#guint" title="guint"><span class="returnvalue">guint</span></a>               g_datalist_get_flags                (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData"><span class="returnvalue">GData</span></a> **datalist);</pre>
 
594
<pre class="programlisting"><a class="link" href="glib-Basic-Types.html#guint" title="guint">guint</a>               g_datalist_get_flags                (<a class="link" href="glib-Keyed-Data-Lists.html#GData" title="GData">GData</a> **datalist);</pre>
565
595
<p>
566
596
Gets flags values packed in together with the datalist.
567
597
See <a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-set-flags" title="g_datalist_set_flags ()"><code class="function">g_datalist_set_flags()</code></a>.</p>
 
598
<p>
 
599
</p>
568
600
<div class="variablelist"><table border="0">
569
601
<col align="left" valign="top">
570
602
<tbody>
585
617
</div>
586
618
<hr>
587
619
<div class="refsect2" title="G_DATALIST_FLAGS_MASK">
588
 
<a name="G-DATALIST-FLAGS-MASK:CAPS"></a><h3>G_DATALIST_FLAGS_MASK</h3>
589
 
<pre class="programlisting">#define             G_DATALIST_FLAGS_MASK</pre>
 
620
<a name="G-DATALIST-FLAGS-MASK--CAPS"></a><h3>G_DATALIST_FLAGS_MASK</h3>
 
621
<pre class="programlisting">#define G_DATALIST_FLAGS_MASK 0x3
 
622
</pre>
590
623
<p>
591
624
A bitmask that restricts the possible flags passed to
592
625
<a class="link" href="glib-Keyed-Data-Lists.html#g-datalist-set-flags" title="g_datalist_set_flags ()"><code class="function">g_datalist_set_flags()</code></a>. Passing a flags value where
593
626
flags &amp; ~G_DATALIST_FLAGS_MASK != 0 is an error.</p>
 
627
<p>
 
628
</p>
594
629
</div>
595
630
</div>
596
631
</div>
597
632
<div class="footer">
598
633
<hr>
599
 
          Generated by GTK-Doc V1.13</div>
 
634
          Generated by GTK-Doc V1.11</div>
600
635
</body>
601
 
</html>
 
 
b'\\ No newline at end of file'
 
636
</html>