~ubuntu-branches/ubuntu/natty/evolution-data-server/natty

« back to all changes in this revision

Viewing changes to docs/reference/libedataserverui/html/ETreeModelGenerator.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>ETreeModelGenerator</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Graphical Utilities (libedataserverui)">
8
8
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Graphical Utilities (libedataserverui)">
9
9
<link rel="prev" href="ESourceSelectorDialog.html" title="ESourceSelectorDialog">
10
 
<link rel="next" href="ix01.html" title="Index">
 
10
<link rel="next" href="api-index-full.html" title="Index">
11
11
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
18
18
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
20
<th width="100%" align="center">Evolution-Data-Server Manual: Graphical Utilities (libedataserverui)</th>
21
 
<td><a accesskey="n" href="ix01.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
21
<td><a accesskey="n" href="api-index-full.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
22
</tr>
23
23
<tr><td colspan="5" class="shortcuts">
24
24
<a href="#ETreeModelGenerator.synopsis" class="shortcut">Top</a>
32
32
                  <a href="#ETreeModelGenerator.properties" class="shortcut">Properties</a>
33
33
</td></tr>
34
34
</table>
35
 
<div class="refentry" lang="en">
 
35
<div class="refentry" title="ETreeModelGenerator">
36
36
<a name="ETreeModelGenerator"></a><div class="titlepage"></div>
37
37
<div class="refnamediv"><table width="100%"><tr>
38
38
<td valign="top">
41
41
</td>
42
42
<td valign="top" align="right"></td>
43
43
</tr></table></div>
44
 
<div class="refsynopsisdiv">
 
44
<div class="refsynopsisdiv" title="Synopsis">
45
45
<a name="ETreeModelGenerator.synopsis"></a><h2>Synopsis</h2>
46
46
<pre class="synopsis"><span class="returnvalue">gint</span>                (<a class="link" href="ETreeModelGenerator.html#ETreeModelGeneratorGenerateFunc" title="ETreeModelGeneratorGenerateFunc ()">*ETreeModelGeneratorGenerateFunc</a>)  (<em class="parameter"><code><span class="type">GtkTreeModel</span> *model</code></em>,
47
47
                                                         <em class="parameter"><code><span class="type">GtkTreeIter</span> *child_iter</code></em>,
82
82
                                                         <em class="parameter"><code><span class="type">GtkTreeIter</span> *generator_iter</code></em>);
83
83
</pre>
84
84
</div>
85
 
<div class="refsect1" lang="en">
 
85
<div class="refsect1" title="Object Hierarchy">
86
86
<a name="ETreeModelGenerator.object-hierarchy"></a><h2>Object Hierarchy</h2>
87
87
<pre class="synopsis">
88
88
  GObject
89
89
   +----ETreeModelGenerator
90
90
</pre>
91
91
</div>
92
 
<div class="refsect1" lang="en">
 
92
<div class="refsect1" title="Implemented Interfaces">
93
93
<a name="ETreeModelGenerator.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
94
94
<p>
95
95
ETreeModelGenerator implements
96
96
 GtkTreeModel.</p>
97
97
</div>
98
 
<div class="refsect1" lang="en">
 
98
<div class="refsect1" title="Properties">
99
99
<a name="ETreeModelGenerator.properties"></a><h2>Properties</h2>
100
100
<pre class="synopsis">
101
101
  "<a class="link" href="ETreeModelGenerator.html#ETreeModelGenerator--child-model" title='The "child-model" property'>child-model</a>"              <span class="type">GObject</span>*              : Read / Write / Construct Only
102
102
</pre>
103
103
</div>
104
 
<div class="refsect1" lang="en">
 
104
<div class="refsect1" title="Description">
105
105
<a name="ETreeModelGenerator.description"></a><h2>Description</h2>
106
106
<p>
107
107
</p>
108
108
</div>
109
 
<div class="refsect1" lang="en">
 
109
<div class="refsect1" title="Details">
110
110
<a name="ETreeModelGenerator.details"></a><h2>Details</h2>
111
 
<div class="refsect2" lang="en">
 
111
<div class="refsect2" title="ETreeModelGeneratorGenerateFunc ()">
112
112
<a name="ETreeModelGeneratorGenerateFunc"></a><h3>ETreeModelGeneratorGenerateFunc ()</h3>
113
113
<pre class="programlisting"><span class="returnvalue">gint</span>                (*ETreeModelGeneratorGenerateFunc)  (<em class="parameter"><code><span class="type">GtkTreeModel</span> *model</code></em>,
114
114
                                                         <em class="parameter"><code><span class="type">GtkTreeIter</span> *child_iter</code></em>,
142
142
</table></div>
143
143
</div>
144
144
<hr>
145
 
<div class="refsect2" lang="en">
 
145
<div class="refsect2" title="ETreeModelGeneratorModifyFunc ()">
146
146
<a name="ETreeModelGeneratorModifyFunc"></a><h3>ETreeModelGeneratorModifyFunc ()</h3>
147
147
<pre class="programlisting"><span class="returnvalue">void</span>                (*ETreeModelGeneratorModifyFunc)    (<em class="parameter"><code><span class="type">GtkTreeModel</span> *model</code></em>,
148
148
                                                         <em class="parameter"><code><span class="type">GtkTreeIter</span> *child_iter</code></em>,
189
189
</table></div>
190
190
</div>
191
191
<hr>
192
 
<div class="refsect2" lang="en">
 
192
<div class="refsect2" title="ETreeModelGenerator">
193
193
<a name="ETreeModelGenerator-struct"></a><h3>ETreeModelGenerator</h3>
194
194
<pre class="programlisting">typedef struct _ETreeModelGenerator ETreeModelGenerator;</pre>
195
195
<p>
196
196
</p>
197
197
</div>
198
198
<hr>
199
 
<div class="refsect2" lang="en">
 
199
<div class="refsect2" title="e_tree_model_generator_new ()">
200
200
<a name="e-tree-model-generator-new"></a><h3>e_tree_model_generator_new ()</h3>
201
201
<pre class="programlisting"><a class="link" href="ETreeModelGenerator.html" title="ETreeModelGenerator"><span class="returnvalue">ETreeModelGenerator</span></a> * e_tree_model_generator_new        (<em class="parameter"><code><span class="type">GtkTreeModel</span> *child_model</code></em>);</pre>
202
202
<p>
203
 
Creates a new <a class="link" href="ETreeModelGenerator.html" title="ETreeModelGenerator"><span class="type">ETreeModelGenerator</span></a> wrapping <em class="parameter"><code>child_model</code></em>.</p>
 
203
Creates a new <a class="link" href="ETreeModelGenerator.html" title="ETreeModelGenerator"><span class="type">ETreeModelGenerator</span></a> wrapping <em class="parameter"><code>child_model</code></em>.
 
204
</p>
204
205
<div class="variablelist"><table border="0">
205
206
<col align="left" valign="top">
206
207
<tbody>
218
219
</table></div>
219
220
</div>
220
221
<hr>
221
 
<div class="refsect2" lang="en">
 
222
<div class="refsect2" title="e_tree_model_generator_get_model ()">
222
223
<a name="e-tree-model-generator-get-model"></a><h3>e_tree_model_generator_get_model ()</h3>
223
224
<pre class="programlisting"><span class="returnvalue">GtkTreeModel</span> *      e_tree_model_generator_get_model    (<em class="parameter"><code><a class="link" href="ETreeModelGenerator.html" title="ETreeModelGenerator"><span class="type">ETreeModelGenerator</span></a> *tree_model_generator</code></em>);</pre>
224
225
<p>
225
 
Gets the child model being wrapped by <em class="parameter"><code>tree_model_generator</code></em>.</p>
 
226
Gets the child model being wrapped by <em class="parameter"><code>tree_model_generator</code></em>.
 
227
</p>
226
228
<div class="variablelist"><table border="0">
227
229
<col align="left" valign="top">
228
230
<tbody>
240
242
</table></div>
241
243
</div>
242
244
<hr>
243
 
<div class="refsect2" lang="en">
 
245
<div class="refsect2" title="e_tree_model_generator_set_generate_func ()">
244
246
<a name="e-tree-model-generator-set-generate-func"></a><h3>e_tree_model_generator_set_generate_func ()</h3>
245
247
<pre class="programlisting"><span class="returnvalue">void</span>                e_tree_model_generator_set_generate_func
246
248
                                                        (<em class="parameter"><code><a class="link" href="ETreeModelGenerator.html" title="ETreeModelGenerator"><span class="type">ETreeModelGenerator</span></a> *tree_model_generator</code></em>,
254
256
used to represent the child row - 0 or more.
255
257
</p>
256
258
<p>
257
 
If <em class="parameter"><code>func</code></em> is <code class="literal">NULL</code>, a filtering/generating function will not be applied.</p>
 
259
If <em class="parameter"><code>func</code></em> is <code class="literal">NULL</code>, a filtering/generating function will not be applied.
 
260
</p>
258
261
<div class="variablelist"><table border="0">
259
262
<col align="left" valign="top">
260
263
<tbody>
277
280
</table></div>
278
281
</div>
279
282
<hr>
280
 
<div class="refsect2" lang="en">
 
283
<div class="refsect2" title="e_tree_model_generator_set_modify_func ()">
281
284
<a name="e-tree-model-generator-set-modify-func"></a><h3>e_tree_model_generator_set_modify_func ()</h3>
282
285
<pre class="programlisting"><span class="returnvalue">void</span>                e_tree_model_generator_set_modify_func
283
286
                                                        (<em class="parameter"><code><a class="link" href="ETreeModelGenerator.html" title="ETreeModelGenerator"><span class="type">ETreeModelGenerator</span></a> *tree_model_generator</code></em>,
289
292
columns and specify values for generated rows' columns.
290
293
</p>
291
294
<p>
292
 
If <em class="parameter"><code>func</code></em> is <code class="literal">NULL</code>, the child model's values will always be used.</p>
 
295
If <em class="parameter"><code>func</code></em> is <code class="literal">NULL</code>, the child model's values will always be used.
 
296
</p>
293
297
<div class="variablelist"><table border="0">
294
298
<col align="left" valign="top">
295
299
<tbody>
312
316
</table></div>
313
317
</div>
314
318
<hr>
315
 
<div class="refsect2" lang="en">
 
319
<div class="refsect2" title="e_tree_model_generator_convert_child_path_to_path ()">
316
320
<a name="e-tree-model-generator-convert-child-path-to-path"></a><h3>e_tree_model_generator_convert_child_path_to_path ()</h3>
317
321
<pre class="programlisting"><span class="returnvalue">GtkTreePath</span> *       e_tree_model_generator_convert_child_path_to_path
318
322
                                                        (<em class="parameter"><code><a class="link" href="ETreeModelGenerator.html" title="ETreeModelGenerator"><span class="type">ETreeModelGenerator</span></a> *tree_model_generator</code></em>,
319
323
                                                         <em class="parameter"><code><span class="type">GtkTreePath</span> *child_path</code></em>);</pre>
320
324
<p>
321
 
Convert a path to a child row to a path to a <em class="parameter"><code>tree_model_generator</code></em> row.</p>
 
325
Convert a path to a child row to a path to a <em class="parameter"><code>tree_model_generator</code></em> row.
 
326
</p>
322
327
<div class="variablelist"><table border="0">
323
328
<col align="left" valign="top">
324
329
<tbody>
341
346
</table></div>
342
347
</div>
343
348
<hr>
344
 
<div class="refsect2" lang="en">
 
349
<div class="refsect2" title="e_tree_model_generator_convert_child_iter_to_iter ()">
345
350
<a name="e-tree-model-generator-convert-child-iter-to-iter"></a><h3>e_tree_model_generator_convert_child_iter_to_iter ()</h3>
346
351
<pre class="programlisting"><span class="returnvalue">void</span>                e_tree_model_generator_convert_child_iter_to_iter
347
352
                                                        (<em class="parameter"><code><a class="link" href="ETreeModelGenerator.html" title="ETreeModelGenerator"><span class="type">ETreeModelGenerator</span></a> *tree_model_generator</code></em>,
349
354
                                                         <em class="parameter"><code><span class="type">GtkTreeIter</span> *child_iter</code></em>);</pre>
350
355
<p>
351
356
Convert <em class="parameter"><code>child_iter</code></em> to a corresponding <span class="type">GtkTreeIter</span> for <em class="parameter"><code>tree_model_generator</code></em>,
352
 
storing the result in <em class="parameter"><code>generator_iter</code></em>.</p>
 
357
storing the result in <em class="parameter"><code>generator_iter</code></em>.
 
358
</p>
353
359
<div class="variablelist"><table border="0">
354
360
<col align="left" valign="top">
355
361
<tbody>
372
378
</table></div>
373
379
</div>
374
380
<hr>
375
 
<div class="refsect2" lang="en">
 
381
<div class="refsect2" title="e_tree_model_generator_convert_path_to_child_path ()">
376
382
<a name="e-tree-model-generator-convert-path-to-child-path"></a><h3>e_tree_model_generator_convert_path_to_child_path ()</h3>
377
383
<pre class="programlisting"><span class="returnvalue">GtkTreePath</span> *       e_tree_model_generator_convert_path_to_child_path
378
384
                                                        (<em class="parameter"><code><a class="link" href="ETreeModelGenerator.html" title="ETreeModelGenerator"><span class="type">ETreeModelGenerator</span></a> *tree_model_generator</code></em>,
379
385
                                                         <em class="parameter"><code><span class="type">GtkTreePath</span> *generator_path</code></em>);</pre>
380
386
<p>
381
 
Converts <em class="parameter"><code>generator_path</code></em> to a corresponding <span class="type">GtkTreePath</span> in the child model.</p>
 
387
Converts <em class="parameter"><code>generator_path</code></em> to a corresponding <span class="type">GtkTreePath</span> in the child model.
 
388
</p>
382
389
<div class="variablelist"><table border="0">
383
390
<col align="left" valign="top">
384
391
<tbody>
401
408
</table></div>
402
409
</div>
403
410
<hr>
404
 
<div class="refsect2" lang="en">
 
411
<div class="refsect2" title="e_tree_model_generator_convert_iter_to_child_iter ()">
405
412
<a name="e-tree-model-generator-convert-iter-to-child-iter"></a><h3>e_tree_model_generator_convert_iter_to_child_iter ()</h3>
406
413
<pre class="programlisting"><span class="returnvalue">void</span>                e_tree_model_generator_convert_iter_to_child_iter
407
414
                                                        (<em class="parameter"><code><a class="link" href="ETreeModelGenerator.html" title="ETreeModelGenerator"><span class="type">ETreeModelGenerator</span></a> *tree_model_generator</code></em>,
411
418
<p>
412
419
Converts a <em class="parameter"><code>tree_model_generator</code></em> row into a child row and permutation index.
413
420
The permutation index is the index of the generated row based on this
414
 
child row, with the first generated row based on this child row being 0.</p>
 
421
child row, with the first generated row based on this child row being 0.
 
422
</p>
415
423
<div class="variablelist"><table border="0">
416
424
<col align="left" valign="top">
417
425
<tbody>
439
447
</table></div>
440
448
</div>
441
449
</div>
442
 
<div class="refsect1" lang="en">
 
450
<div class="refsect1" title="Property Details">
443
451
<a name="ETreeModelGenerator.property-details"></a><h2>Property Details</h2>
444
 
<div class="refsect2" lang="en">
 
452
<div class="refsect2" title='The "child-model" property'>
445
453
<a name="ETreeModelGenerator--child-model"></a><h3>The <code class="literal">"child-model"</code> property</h3>
446
454
<pre class="programlisting">  "child-model"              <span class="type">GObject</span>*              : Read / Write / Construct Only</pre>
447
455
<p>The child model to extend.</p>