libdee-doc 1.0.10-3.1 / usr / share / gtk-doc / html / dee-1.0 / dee-1.0-Model-Readers.html

This file is indexed.

/usr/share/gtk-doc/html/dee-1.0/dee-1.0-Model-Readers.html is in libdee-doc 1.0.10-3.1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Dee Reference Manual: Model Readers</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Dee Reference Manual">
<link rel="up" href="ch03.html" title="Indexes">
<link rel="prev" href="DeeIndex.html" title="DeeIndex">
<link rel="next" href="dee-1.0-DeeResultSet.html" title="DeeResultSet">
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
                  <a href="#dee-1.0-Model-Readers.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
                  <a href="#dee-1.0-Model-Readers.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="DeeIndex.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="dee-1.0-DeeResultSet.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="dee-1.0-Model-Readers"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="dee-1.0-Model-Readers.top_of_page"></a>Model Readers</span></h2>
<p>Model Readers — Extracting strings from <span class="type">DeeModel</span>s</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="dee-1.0-Model-Readers.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="dee-1.0-Model-Readers.html#DeeModelReaderFunc" title="DeeModelReaderFunc ()">*DeeModelReaderFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="dee-1.0-Model-Readers.html#dee-model-reader-destroy" title="dee_model_reader_destroy ()">dee_model_reader_destroy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="dee-1.0-Model-Readers.html#dee-model-reader-new" title="dee_model_reader_new ()">dee_model_reader_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="dee-1.0-Model-Readers.html#dee-model-reader-new-for-int32-column" title="dee_model_reader_new_for_int32_column ()">dee_model_reader_new_for_int32_column</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="dee-1.0-Model-Readers.html#dee-model-reader-new-for-string-column" title="dee_model_reader_new_for_string_column ()">dee_model_reader_new_for_string_column</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="dee-1.0-Model-Readers.html#dee-model-reader-new-for-uint32-column" title="dee_model_reader_new_for_uint32_column ()">dee_model_reader_new_for_uint32_column</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="dee-1.0-Model-Readers.html#dee-model-reader-read" title="dee_model_reader_read ()">dee_model_reader_read</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="dee-1.0-Model-Readers.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="dee-1.0-Filters.html#DeeFilter" title="DeeFilter">DeeFilter</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="dee-1.0-Model-Readers.html#DeeModelReader" title="DeeModelReader">DeeModelReader</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="dee-1.0-Model-Readers.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">
</pre>
</div>
<div class="refsect1">
<a name="dee-1.0-Model-Readers.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;dee.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="dee-1.0-Model-Readers.description"></a><h2>Description</h2>
<p>The purpose of a <a class="link" href="dee-1.0-Model-Readers.html#DeeModelReader" title="DeeModelReader"><span class="type">DeeModelReader</span></a> is to extract string from a <span class="type">DeeModel</span>.
These strings are usually passed through a <a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="type">DeeAnalyzer</span></a> on into a <a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a>.</p>
<p>Most readers will extract a value of a given type from a given column,
but it must be noted that this is not a requirement. The strings may be
built from several columns.</p>
</div>
<div class="refsect1">
<a name="dee-1.0-Model-Readers.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="DeeModelReaderFunc"></a><h3>DeeModelReaderFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
<span class="c_punctuation">(</span>*DeeModelReaderFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">DeeModel</span> *model</code></em>,
                       <em class="parameter"><code><a class="link" href="dee-1.0-DeeModel.html#DeeModelIter"><span class="type">DeeModelIter</span></a> *iter</code></em>,
                       <em class="parameter"><code><span class="type">gpointer</span> userdata</code></em>);</pre>
<p>Extracts a string from a row in a model.</p>
<div class="refsect3">
<a name="id-1.4.5.8.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>model</p></td>
<td class="parameter_description"><p>The model being indexed</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>The row to extract terms for</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>userdata</p></td>
<td class="parameter_description"><p>The data set when registering the reader. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.5.8.2.6"></a><h4>Returns</h4>
<p> A newly allocated string with the row data to be indexed.
Free with <code class="function">g_free()</code>.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-model-reader-destroy"></a><h3>dee_model_reader_destroy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dee_model_reader_destroy (<em class="parameter"><code><a class="link" href="dee-1.0-Model-Readers.html#DeeModelReader" title="DeeModelReader"><span class="type">DeeModelReader</span></a> *reader</code></em>);</pre>
<p>Release resources associated with <em class="parameter"><code>reader</code></em>
, but does not free the
<a class="link" href="dee-1.0-Model-Readers.html#DeeModelReader" title="DeeModelReader"><span class="type">DeeModelReader</span></a> structure itself.</p>
<p>This will call the <code class="function">destroy()</code> function registered with the reader
if it is set.</p>
<div class="refsect3">
<a name="id-1.4.5.8.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>reader</p></td>
<td class="parameter_description"><p>The reader to destroy</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-model-reader-new"></a><h3>dee_model_reader_new ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dee_model_reader_new (<em class="parameter"><code><a class="link" href="dee-1.0-Model-Readers.html#DeeModelReaderFunc" title="DeeModelReaderFunc ()"><span class="type">DeeModelReaderFunc</span></a> reader_func</code></em>,
                      <em class="parameter"><code><span class="type">gpointer</span> userdata</code></em>,
                      <em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>,
                      <em class="parameter"><code><a class="link" href="dee-1.0-Model-Readers.html#DeeModelReader" title="DeeModelReader"><span class="type">DeeModelReader</span></a> *out_reader</code></em>);</pre>
<p>Create a new <a class="link" href="dee-1.0-Model-Readers.html#DeeModelReader" title="DeeModelReader"><span class="type">DeeModelReader</span></a> with the given parameters. This call will zero
the <em class="parameter"><code>out_reader</code></em>
 struct.</p>
<div class="refsect3">
<a name="id-1.4.5.8.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>reader_func</p></td>
<td class="parameter_description"><p> The <a class="link" href="dee-1.0-Model-Readers.html#DeeModelReaderFunc" title="DeeModelReaderFunc ()"><span class="type">DeeModelReaderFunc</span></a> to use for the reader. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>userdata</p></td>
<td class="parameter_description"><p> The user data to pass to <em class="parameter"><code>reader_func</code></em>
. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>destroy</p></td>
<td class="parameter_description"><p> The <span class="type">GDestroyNotify</span> to call on
<em class="parameter"><code>userdata</code></em>
when disposing of the reader. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>out_reader</p></td>
<td class="parameter_description"><p> A pointer to an uninitialized <a class="link" href="dee-1.0-Model-Readers.html#DeeModelReader" title="DeeModelReader"><span class="type">DeeModelReader</span></a> struct. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-model-reader-new-for-int32-column"></a><h3>dee_model_reader_new_for_int32_column ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dee_model_reader_new_for_int32_column (<em class="parameter"><code><span class="type">guint</span> column</code></em>,
                                       <em class="parameter"><code><a class="link" href="dee-1.0-Model-Readers.html#DeeModelReader" title="DeeModelReader"><span class="type">DeeModelReader</span></a> *out_reader</code></em>);</pre>
<p>A <a class="link" href="dee-1.0-Model-Readers.html#DeeModelReader" title="DeeModelReader"><span class="type">DeeModelReader</span></a> reading a <code class="literal">gint32</code> from a <span class="type">DeeModel</span> at a given column</p>
<div class="refsect3">
<a name="id-1.4.5.8.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>column</p></td>
<td class="parameter_description"><p>The column index to read a <code class="literal">gint32</code> from</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out_reader</p></td>
<td class="parameter_description"><p> A pointer to a <a class="link" href="dee-1.0-Model-Readers.html#DeeModelReader" title="DeeModelReader"><span class="type">DeeModelReader</span></a> instance which will have
all fields initialized appropriately. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-model-reader-new-for-string-column"></a><h3>dee_model_reader_new_for_string_column ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dee_model_reader_new_for_string_column
                               (<em class="parameter"><code><span class="type">guint</span> column</code></em>,
                                <em class="parameter"><code><a class="link" href="dee-1.0-Model-Readers.html#DeeModelReader" title="DeeModelReader"><span class="type">DeeModelReader</span></a> *out_reader</code></em>);</pre>
<p>A <a class="link" href="dee-1.0-Model-Readers.html#DeeModelReader" title="DeeModelReader"><span class="type">DeeModelReader</span></a> reading a string from a <span class="type">DeeModel</span> at a given column</p>
<div class="refsect3">
<a name="id-1.4.5.8.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>column</p></td>
<td class="parameter_description"><p>The column index to read a string from</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out_reader</p></td>
<td class="parameter_description"><p> A pointer to a <a class="link" href="dee-1.0-Model-Readers.html#DeeModelReader" title="DeeModelReader"><span class="type">DeeModelReader</span></a> instance which will have
all fields initialized appropriately. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-model-reader-new-for-uint32-column"></a><h3>dee_model_reader_new_for_uint32_column ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dee_model_reader_new_for_uint32_column
                               (<em class="parameter"><code><span class="type">guint</span> column</code></em>,
                                <em class="parameter"><code><a class="link" href="dee-1.0-Model-Readers.html#DeeModelReader" title="DeeModelReader"><span class="type">DeeModelReader</span></a> *out_reader</code></em>);</pre>
<p>A <a class="link" href="dee-1.0-Model-Readers.html#DeeModelReader" title="DeeModelReader"><span class="type">DeeModelReader</span></a> reading a <code class="literal">guint32</code> from a <span class="type">DeeModel</span> at a given column</p>
<div class="refsect3">
<a name="id-1.4.5.8.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>column</p></td>
<td class="parameter_description"><p>The column index to read a <code class="literal">guint32</code> from</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out_reader</p></td>
<td class="parameter_description"><p> A pointer to a <a class="link" href="dee-1.0-Model-Readers.html#DeeModelReader" title="DeeModelReader"><span class="type">DeeModelReader</span></a> instance which will have
all fields initialized appropriately. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-model-reader-read"></a><h3>dee_model_reader_read ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
dee_model_reader_read (<em class="parameter"><code><a class="link" href="dee-1.0-Model-Readers.html#DeeModelReader" title="DeeModelReader"><span class="type">DeeModelReader</span></a> *self</code></em>,
                       <em class="parameter"><code><span class="type">DeeModel</span> *model</code></em>,
                       <em class="parameter"><code><a class="link" href="dee-1.0-DeeModel.html#DeeModelIter"><span class="type">DeeModelIter</span></a> *iter</code></em>);</pre>
<p>Read data from a row in a <span class="type">DeeModel</span> and extract a string representation from
it.</p>
<p>Note that generally a <a class="link" href="dee-1.0-Model-Readers.html#DeeModelReader" title="DeeModelReader"><span class="type">DeeModelReader</span></a> need not be confined to reading from
one specific column, although in practice most are.</p>
<div class="refsect3">
<a name="id-1.4.5.8.8.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The <a class="link" href="dee-1.0-Model-Readers.html#DeeModelReader" title="DeeModelReader"><span class="type">DeeModelReader</span></a> used to read <em class="parameter"><code>model</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>model</p></td>
<td class="parameter_description"><p>The <span class="type">DeeModel</span> to read a string from</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>The row to read a string from</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.5.8.8.7"></a><h4>Returns</h4>
<p> A newly allocated string. Free with <code class="function">g_free()</code>.</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="dee-1.0-Model-Readers.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="DeeFilter"></a><h3>DeeFilter</h3>
<pre class="programlisting">typedef struct {
  DeeFilterMapFunc   map_func;
  DeeFilterMapNotify map_notify;
  GDestroyNotify     destroy;
  gpointer           userdata;
} DeeFilter;
</pre>
<p>Structure encapsulating the mapping logic used to construct a <a class="link" href="DeeFilterModel.html" title="DeeFilterModel"><span class="type">DeeFilterModel</span></a></p>
</div>
<hr>
<div class="refsect2">
<a name="DeeModelReader"></a><h3>DeeModelReader</h3>
<pre class="programlisting">typedef struct {
  DeeModelReaderFunc reader_func;
  gpointer           userdata;
  GDestroyNotify     destroy;
} DeeModelReader;
</pre>
<p>Structure encapsulating the information needed to read strings from a
model. Used for example by <a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a>.</p>
<div class="refsect3">
<a name="id-1.4.5.9.3.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a class="link" href="dee-1.0-Model-Readers.html#DeeModelReaderFunc" title="DeeModelReaderFunc ()"><span class="type">DeeModelReaderFunc</span></a> <em class="structfield"><code><a name="DeeModelReader.reader-func"></a>reader_func</code></em>;</p></td>
<td class="struct_member_description"><p> The <a class="link" href="dee-1.0-Model-Readers.html#DeeModelReaderFunc" title="DeeModelReaderFunc ()"><span class="type">DeeModelReaderFunc</span></a> used to extract
string from a model. </p></td>
<td class="struct_member_annotations"><span class="annotation">[<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>]</span></td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gpointer</span> <em class="structfield"><code><a name="DeeModelReader.userdata"></a>userdata</code></em>;</p></td>
<td class="struct_member_description"><p> user data to pass to <em class="parameter"><code>reader_func</code></em>
. </p></td>
<td class="struct_member_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">GDestroyNotify</span> <em class="structfield"><code><a name="DeeModelReader.destroy"></a>destroy</code></em>;</p></td>
<td class="struct_member_description"><p>Called when the reader is destroyed</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.20</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.