~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to docs/reference/camel/html/camel-CamelVeeFolder.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>CamelVeeFolder</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="Camel Reference Manual">
8
 
<link rel="up" href="SearchFolders.html" title="Search Folders">
9
 
<link rel="prev" href="SearchFolders.html" title="Search Folders">
 
8
<link rel="up" href="Search-Folders.html" title="Search Folders">
 
9
<link rel="prev" href="Search-Folders.html" title="Search Folders">
10
10
<link rel="next" href="camel-CamelVeeStore.html" title="CamelVeeStore">
11
11
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
16
<tr valign="middle">
17
 
<td><a accesskey="p" href="SearchFolders.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
 
<td><a accesskey="u" href="SearchFolders.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
17
<td><a accesskey="p" href="Search-Folders.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="Search-Folders.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">Camel Reference Manual</th>
21
21
<td><a accesskey="n" href="camel-CamelVeeStore.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
26
26
                  <a href="#camel-CamelVeeFolder.description" class="shortcut">Description</a>
27
27
</td></tr>
28
28
</table>
29
 
<div class="refentry" lang="en">
 
29
<div class="refentry" title="CamelVeeFolder">
30
30
<a name="camel-CamelVeeFolder"></a><div class="titlepage"></div>
31
31
<div class="refnamediv"><table width="100%"><tr>
32
32
<td valign="top">
35
35
</td>
36
36
<td valign="top" align="right"></td>
37
37
</tr></table></div>
38
 
<div class="refsynopsisdiv">
 
38
<div class="refsynopsisdiv" title="Synopsis">
39
39
<a name="camel-CamelVeeFolder.synopsis"></a><h2>Synopsis</h2>
40
40
<pre class="synopsis">                    <a class="link" href="camel-CamelVeeFolder.html#CamelVeeFolder" title="CamelVeeFolder">CamelVeeFolder</a>;
41
41
#define             <a class="link" href="camel-CamelVeeFolder.html#CAMEL-UNMATCHED-NAME:CAPS" title="CAMEL_UNMATCHED_NAME">CAMEL_UNMATCHED_NAME</a>
73
73
                                                         <em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);
74
74
</pre>
75
75
</div>
76
 
<div class="refsect1" lang="en">
 
76
<div class="refsect1" title="Description">
77
77
<a name="camel-CamelVeeFolder.description"></a><h2>Description</h2>
78
78
<p>
79
79
</p>
80
80
</div>
81
 
<div class="refsect1" lang="en">
 
81
<div class="refsect1" title="Details">
82
82
<a name="camel-CamelVeeFolder.details"></a><h2>Details</h2>
83
 
<div class="refsect2" lang="en">
 
83
<div class="refsect2" title="CamelVeeFolder">
84
84
<a name="CamelVeeFolder"></a><h3>CamelVeeFolder</h3>
85
85
<pre class="programlisting">typedef struct {
86
86
        CamelFolder parent;
106
106
</p>
107
107
</div>
108
108
<hr>
109
 
<div class="refsect2" lang="en">
 
109
<div class="refsect2" title="CAMEL_UNMATCHED_NAME">
110
110
<a name="CAMEL-UNMATCHED-NAME:CAPS"></a><h3>CAMEL_UNMATCHED_NAME</h3>
111
111
<pre class="programlisting">#define CAMEL_UNMATCHED_NAME "UNMATCHED"
112
112
</pre>
114
114
</p>
115
115
</div>
116
116
<hr>
117
 
<div class="refsect2" lang="en">
 
117
<div class="refsect2" title="camel_vee_folder_new ()">
118
118
<a name="camel-vee-folder-new"></a><h3>camel_vee_folder_new ()</h3>
119
119
<pre class="programlisting"><a class="link" href="camel-CamelFolder.html#CamelFolder" title="struct CamelFolder"><span class="returnvalue">CamelFolder</span></a> *       camel_vee_folder_new                (<em class="parameter"><code><a class="link" href="camel-CamelStore.html#CamelStore" title="struct CamelStore"><span class="type">CamelStore</span></a> *parent_store</code></em>,
120
120
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *full</code></em>,
121
121
                                                         <em class="parameter"><code><span class="type">guint32</span> flags</code></em>);</pre>
122
122
<p>
123
 
Create a new CamelVeeFolder object.</p>
 
123
Create a new CamelVeeFolder object.
 
124
</p>
124
125
<div class="variablelist"><table border="0">
125
126
<col align="left" valign="top">
126
127
<tbody>
148
149
</table></div>
149
150
</div>
150
151
<hr>
151
 
<div class="refsect2" lang="en">
 
152
<div class="refsect2" title="camel_vee_folder_construct ()">
152
153
<a name="camel-vee-folder-construct"></a><h3>camel_vee_folder_construct ()</h3>
153
154
<pre class="programlisting"><span class="returnvalue">void</span>                camel_vee_folder_construct          (<em class="parameter"><code><a class="link" href="camel-CamelVeeFolder.html#CamelVeeFolder" title="CamelVeeFolder"><span class="type">CamelVeeFolder</span></a> *vf</code></em>,
154
155
                                                         <em class="parameter"><code><a class="link" href="camel-CamelStore.html#CamelStore" title="struct CamelStore"><span class="type">CamelStore</span></a> *parent_store</code></em>,
189
190
</table></div>
190
191
</div>
191
192
<hr>
192
 
<div class="refsect2" lang="en">
 
193
<div class="refsect2" title="camel_vee_folder_get_location ()">
193
194
<a name="camel-vee-folder-get-location"></a><h3>camel_vee_folder_get_location ()</h3>
194
195
<pre class="programlisting"><a class="link" href="camel-CamelFolder.html#CamelFolder" title="struct CamelFolder"><span class="returnvalue">CamelFolder</span></a> *       camel_vee_folder_get_location       (<em class="parameter"><code><a class="link" href="camel-CamelVeeFolder.html#CamelVeeFolder" title="CamelVeeFolder"><span class="type">CamelVeeFolder</span></a> *vf</code></em>,
195
196
                                                         <em class="parameter"><code>const <span class="type">struct _CamelVeeMessageInfo</span> *vinfo</code></em>,
196
197
                                                         <em class="parameter"><code><span class="type">gchar</span> **realuid</code></em>);</pre>
197
198
<p>
198
 
Find the real folder (and uid)</p>
 
199
Find the real folder (and uid)
 
200
</p>
199
201
<div class="variablelist"><table border="0">
200
202
<col align="left" valign="top">
201
203
<tbody>
214
216
</table></div>
215
217
</div>
216
218
<hr>
217
 
<div class="refsect2" lang="en">
 
219
<div class="refsect2" title="camel_vee_folder_add_folder ()">
218
220
<a name="camel-vee-folder-add-folder"></a><h3>camel_vee_folder_add_folder ()</h3>
219
221
<pre class="programlisting"><span class="returnvalue">void</span>                camel_vee_folder_add_folder         (<em class="parameter"><code><a class="link" href="camel-CamelVeeFolder.html#CamelVeeFolder" title="CamelVeeFolder"><span class="type">CamelVeeFolder</span></a> *vf</code></em>,
220
222
                                                         <em class="parameter"><code><a class="link" href="camel-CamelFolder.html#CamelFolder" title="struct CamelFolder"><span class="type">CamelFolder</span></a> *sub</code></em>);</pre>
221
223
<p>
222
 
Adds <em class="parameter"><code>sub</code></em> as a source folder to <em class="parameter"><code>vf</code></em>.</p>
 
224
Adds <em class="parameter"><code>sub</code></em> as a source folder to <em class="parameter"><code>vf</code></em>.
 
225
</p>
223
226
<div class="variablelist"><table border="0">
224
227
<col align="left" valign="top">
225
228
<tbody>
237
240
</table></div>
238
241
</div>
239
242
<hr>
240
 
<div class="refsect2" lang="en">
 
243
<div class="refsect2" title="camel_vee_folder_remove_folder ()">
241
244
<a name="camel-vee-folder-remove-folder"></a><h3>camel_vee_folder_remove_folder ()</h3>
242
245
<pre class="programlisting"><span class="returnvalue">void</span>                camel_vee_folder_remove_folder      (<em class="parameter"><code><a class="link" href="camel-CamelVeeFolder.html#CamelVeeFolder" title="CamelVeeFolder"><span class="type">CamelVeeFolder</span></a> *vf</code></em>,
243
246
                                                         <em class="parameter"><code><a class="link" href="camel-CamelFolder.html#CamelFolder" title="struct CamelFolder"><span class="type">CamelFolder</span></a> *sub</code></em>);</pre>
244
247
<p>
245
 
Removed the source folder, <em class="parameter"><code>sub</code></em>, from the virtual folder, <em class="parameter"><code>vf</code></em>.</p>
 
248
Removed the source folder, <em class="parameter"><code>sub</code></em>, from the virtual folder, <em class="parameter"><code>vf</code></em>.
 
249
</p>
246
250
<div class="variablelist"><table border="0">
247
251
<col align="left" valign="top">
248
252
<tbody>
260
264
</table></div>
261
265
</div>
262
266
<hr>
263
 
<div class="refsect2" lang="en">
 
267
<div class="refsect2" title="camel_vee_folder_set_folders ()">
264
268
<a name="camel-vee-folder-set-folders"></a><h3>camel_vee_folder_set_folders ()</h3>
265
269
<pre class="programlisting"><span class="returnvalue">void</span>                camel_vee_folder_set_folders        (<em class="parameter"><code><a class="link" href="camel-CamelVeeFolder.html#CamelVeeFolder" title="CamelVeeFolder"><span class="type">CamelVeeFolder</span></a> *vf</code></em>,
266
270
                                                         <em class="parameter"><code><span class="type">GList</span> *folders</code></em>);</pre>
267
271
<p>
268
 
Set the whole list of folder sources on a vee folder.</p>
 
272
Set the whole list of folder sources on a vee folder.
 
273
</p>
269
274
</div>
270
275
<hr>
271
 
<div class="refsect2" lang="en">
 
276
<div class="refsect2" title="camel_vee_folder_rebuild_folder ()">
272
277
<a name="camel-vee-folder-rebuild-folder"></a><h3>camel_vee_folder_rebuild_folder ()</h3>
273
278
<pre class="programlisting"><span class="returnvalue">gint</span>                camel_vee_folder_rebuild_folder     (<em class="parameter"><code><a class="link" href="camel-CamelVeeFolder.html#CamelVeeFolder" title="CamelVeeFolder"><span class="type">CamelVeeFolder</span></a> *vf</code></em>,
274
279
                                                         <em class="parameter"><code><a class="link" href="camel-CamelFolder.html#CamelFolder" title="struct CamelFolder"><span class="type">CamelFolder</span></a> *sub</code></em>,
275
280
                                                         <em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);</pre>
276
281
<p>
277
 
Rebuild the folder <em class="parameter"><code>sub</code></em>, if it should be.</p>
 
282
Rebuild the folder <em class="parameter"><code>sub</code></em>, if it should be.
 
283
</p>
278
284
<div class="variablelist"><table border="0">
279
285
<col align="left" valign="top">
280
286
<tbody>
302
308
</table></div>
303
309
</div>
304
310
<hr>
305
 
<div class="refsect2" lang="en">
 
311
<div class="refsect2" title="camel_vee_folder_set_expression ()">
306
312
<a name="camel-vee-folder-set-expression"></a><h3>camel_vee_folder_set_expression ()</h3>
307
313
<pre class="programlisting"><span class="returnvalue">void</span>                camel_vee_folder_set_expression     (<em class="parameter"><code><a class="link" href="camel-CamelVeeFolder.html#CamelVeeFolder" title="CamelVeeFolder"><span class="type">CamelVeeFolder</span></a> *vf</code></em>,
308
314
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *expr</code></em>);</pre>
325
331
</table></div>
326
332
</div>
327
333
<hr>
328
 
<div class="refsect2" lang="en">
 
334
<div class="refsect2" title="camel_vee_folder_mask_event_folder_changed ()">
329
335
<a name="camel-vee-folder-mask-event-folder-changed"></a><h3>camel_vee_folder_mask_event_folder_changed ()</h3>
330
336
<pre class="programlisting"><span class="returnvalue">void</span>                camel_vee_folder_mask_event_folder_changed
331
337
                                                        (<em class="parameter"><code><a class="link" href="camel-CamelVeeFolder.html#CamelVeeFolder" title="CamelVeeFolder"><span class="type">CamelVeeFolder</span></a> *vf</code></em>,
332
338
                                                         <em class="parameter"><code><a class="link" href="camel-CamelFolder.html#CamelFolder" title="struct CamelFolder"><span class="type">CamelFolder</span></a> *sub</code></em>);</pre>
333
 
<p>
334
 
</p>
335
339
<div class="variablelist"><table border="0">
336
340
<col align="left" valign="top">
337
341
<tbody>
347
351
</tr>
348
352
</tbody>
349
353
</table></div>
 
354
<p class="since">Since 2.26</p>
350
355
</div>
351
356
<hr>
352
 
<div class="refsect2" lang="en">
 
357
<div class="refsect2" title="camel_vee_folder_unmask_event_folder_changed ()">
353
358
<a name="camel-vee-folder-unmask-event-folder-changed"></a><h3>camel_vee_folder_unmask_event_folder_changed ()</h3>
354
359
<pre class="programlisting"><span class="returnvalue">void</span>                camel_vee_folder_unmask_event_folder_changed
355
360
                                                        (<em class="parameter"><code><a class="link" href="camel-CamelVeeFolder.html#CamelVeeFolder" title="CamelVeeFolder"><span class="type">CamelVeeFolder</span></a> *vf</code></em>,
356
361
                                                         <em class="parameter"><code><a class="link" href="camel-CamelFolder.html#CamelFolder" title="struct CamelFolder"><span class="type">CamelFolder</span></a> *sub</code></em>);</pre>
357
 
<p>
358
 
</p>
359
362
<div class="variablelist"><table border="0">
360
363
<col align="left" valign="top">
361
364
<tbody>
371
374
</tr>
372
375
</tbody>
373
376
</table></div>
 
377
<p class="since">Since 2.26</p>
374
378
</div>
375
379
<hr>
376
 
<div class="refsect2" lang="en">
 
380
<div class="refsect2" title="camel_vee_folder_hash_folder ()">
377
381
<a name="camel-vee-folder-hash-folder"></a><h3>camel_vee_folder_hash_folder ()</h3>
378
382
<pre class="programlisting"><span class="returnvalue">void</span>                camel_vee_folder_hash_folder        (<em class="parameter"><code><a class="link" href="camel-CamelFolder.html#CamelFolder" title="struct CamelFolder"><span class="type">CamelFolder</span></a> *folder</code></em>,
379
383
                                                         <em class="parameter"><code><span class="type">gchar</span> buffer[8]</code></em>);</pre>
380
384
<p>
381
385
Create a hash string representing the folder name, which should be
382
 
unique, and remain static for a given folder.</p>
 
386
unique, and remain static for a given folder.
 
387
</p>
383
388
<div class="variablelist"><table border="0">
384
389
<col align="left" valign="top">
385
390
<tbody>
397
402
</table></div>
398
403
</div>
399
404
<hr>
400
 
<div class="refsect2" lang="en">
 
405
<div class="refsect2" title="camel_vee_folder_sync_headers ()">
401
406
<a name="camel-vee-folder-sync-headers"></a><h3>camel_vee_folder_sync_headers ()</h3>
402
407
<pre class="programlisting"><span class="returnvalue">void</span>                camel_vee_folder_sync_headers       (<em class="parameter"><code><a class="link" href="camel-CamelFolder.html#CamelFolder" title="struct CamelFolder"><span class="type">CamelFolder</span></a> *vf</code></em>,
403
408
                                                         <em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);</pre>
404
 
<p>
405
 
</p>
406
409
<div class="variablelist"><table border="0">
407
410
<col align="left" valign="top">
408
411
<tbody>
418
421
</tr>
419
422
</tbody>
420
423
</table></div>
 
424
<p class="since">Since 2.24</p>
421
425
</div>
422
426
</div>
423
427
</div>