← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/camel/xml/camel-vee-folder.xml

  • Committer: Bazaar Package Importer
  • Author(s): Yves-Alexis Perez
  • Date: 2010-03-08 23:15:54 UTC
  • mfrom: (1.10.5 upstream)
  • mto: (1.2.11 sid)
  • mto: This revision was merged to the branch mainline in revision 128.
  • Revision ID: james.westby@ubuntu.com-20100308231554-kqlody4h3laayg0j
Tags: 2.29.92-1
* New upstream release candidate.
* debian/control:
  - add build-dep on gperf for imapx backend.
* debian/libcamel1.2-14.shlibs: bump shlibs.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/camel/xml/camel-vee-folder.xml
 
1
<refentry id="camel-CamelVeeFolder">
 
2
<refmeta>
 
3
<refentrytitle role="top_of_page" id="camel-CamelVeeFolder.top_of_page">CamelVeeFolder</refentrytitle>
 
4
<manvolnum>3</manvolnum>
 
5
<refmiscinfo>CAMEL Library</refmiscinfo>
 
6
</refmeta>
 
7
 
 
8
<refnamediv>
 
9
<refname>CamelVeeFolder</refname>
 
10
<refpurpose></refpurpose>
 
11
</refnamediv>
 
12
 
 
13
<refsynopsisdiv id="camel-CamelVeeFolder.synopsis" role="synopsis">
 
14
<title role="synopsis.title">Synopsis</title>
 
15
 
 
16
<synopsis>
 
17
                    <link linkend="CamelVeeFolder">CamelVeeFolder</link>;
 
18
#define             <link linkend="CAMEL-UNMATCHED-NAME--CAPS">CAMEL_UNMATCHED_NAME</link>
 
19
<link linkend="CamelFolder">CamelFolder</link> *       <link linkend="camel-vee-folder-new">camel_vee_folder_new</link>                (<link linkend="CamelStore">CamelStore</link> *parent_store,
 
20
                                                         const <link linkend="gchar">gchar</link> *full,
 
21
                                                         <link linkend="guint32">guint32</link> flags);
 
22
<link linkend="void">void</link>                <link linkend="camel-vee-folder-construct">camel_vee_folder_construct</link>          (<link linkend="CamelVeeFolder">CamelVeeFolder</link> *vf,
 
23
                                                         <link linkend="CamelStore">CamelStore</link> *parent_store,
 
24
                                                         const <link linkend="gchar">gchar</link> *full,
 
25
                                                         const <link linkend="gchar">gchar</link> *name,
 
26
                                                         <link linkend="guint32">guint32</link> flags);
 
27
<link linkend="CamelFolder">CamelFolder</link> *       <link linkend="camel-vee-folder-get-location">camel_vee_folder_get_location</link>       (<link linkend="CamelVeeFolder">CamelVeeFolder</link> *vf,
 
28
                                                         const <link linkend="struct--CamelVeeMessageInfo">struct _CamelVeeMessageInfo</link> *vinfo,
 
29
                                                         <link linkend="gchar">gchar</link> **realuid);
 
30
<link linkend="void">void</link>                <link linkend="camel-vee-folder-add-folder">camel_vee_folder_add_folder</link>         (<link linkend="CamelVeeFolder">CamelVeeFolder</link> *vf,
 
31
                                                         <link linkend="CamelFolder">CamelFolder</link> *sub);
 
32
<link linkend="void">void</link>                <link linkend="camel-vee-folder-remove-folder">camel_vee_folder_remove_folder</link>      (<link linkend="CamelVeeFolder">CamelVeeFolder</link> *vf,
 
33
                                                         <link linkend="CamelFolder">CamelFolder</link> *sub);
 
34
<link linkend="void">void</link>                <link linkend="camel-vee-folder-set-folders">camel_vee_folder_set_folders</link>        (<link linkend="CamelVeeFolder">CamelVeeFolder</link> *vf,
 
35
                                                         <link linkend="GList">GList</link> *folders);
 
36
<link linkend="gint">gint</link>                <link linkend="camel-vee-folder-rebuild-folder">camel_vee_folder_rebuild_folder</link>     (<link linkend="CamelVeeFolder">CamelVeeFolder</link> *vf,
 
37
                                                         <link linkend="CamelFolder">CamelFolder</link> *sub,
 
38
                                                         <link linkend="CamelException">CamelException</link> *ex);
 
39
<link linkend="void">void</link>                <link linkend="camel-vee-folder-set-expression">camel_vee_folder_set_expression</link>     (<link linkend="CamelVeeFolder">CamelVeeFolder</link> *vf,
 
40
                                                         const <link linkend="gchar">gchar</link> *expr);
 
41
<link linkend="void">void</link>                <link linkend="camel-vee-folder-mask-event-folder-changed">camel_vee_folder_mask_event_folder_changed</link>
 
42
                                                        (<link linkend="CamelVeeFolder">CamelVeeFolder</link> *vf,
 
43
                                                         <link linkend="CamelFolder">CamelFolder</link> *sub);
 
44
<link linkend="void">void</link>                <link linkend="camel-vee-folder-unmask-event-folder-changed">camel_vee_folder_unmask_event_folder_changed</link>
 
45
                                                        (<link linkend="CamelVeeFolder">CamelVeeFolder</link> *vf,
 
46
                                                         <link linkend="CamelFolder">CamelFolder</link> *sub);
 
47
<link linkend="void">void</link>                <link linkend="camel-vee-folder-hash-folder">camel_vee_folder_hash_folder</link>        (<link linkend="CamelFolder">CamelFolder</link> *folder,
 
48
                                                         <link linkend="gchar">gchar</link> buffer[8]);
 
49
<link linkend="void">void</link>                <link linkend="camel-vee-folder-sync-headers">camel_vee_folder_sync_headers</link>       (<link linkend="CamelFolder">CamelFolder</link> *vf,
 
50
                                                         <link linkend="CamelException">CamelException</link> *ex);
 
51
</synopsis>
 
52
</refsynopsisdiv>
 
53
 
 
54
 
 
55
 
 
56
 
 
57
 
 
58
 
 
59
 
 
60
 
 
61
 
 
62
<refsect1 id="camel-CamelVeeFolder.description" role="desc">
 
63
<title role="desc.title">Description</title>
 
64
<para>
 
65
</para>
 
66
</refsect1>
 
67
 
 
68
<refsect1 id="camel-CamelVeeFolder.details" role="details">
 
69
<title role="details.title">Details</title>
 
70
<refsect2 id="CamelVeeFolder" role="struct">
 
71
<title>CamelVeeFolder</title>
 
72
<indexterm zone="CamelVeeFolder"><primary sortas="CamelVeeFolder">CamelVeeFolder</primary></indexterm><programlisting>typedef struct {
 
73
        CamelFolder parent;
 
74
 
 
75
        struct _CamelVeeFolderPrivate *priv;
 
76
 
 
77
        gchar *expression;      /* query expression */
 
78
 
 
79
        guint32 flags;          /* folder open flags */
 
80
 
 
81
        CamelFolderChangeInfo *changes;
 
82
        CamelFolderSearch *search;
 
83
 
 
84
        /* only set-up if our parent is a vee-store, used also as a flag to
 
85
         * say that this folder is part of the unmatched folder */
 
86
        struct _CamelVeeStore *parent_vee_store;
 
87
        GHashTable *hashes;
 
88
        GHashTable *loaded;
 
89
        gboolean deleted;
 
90
} CamelVeeFolder;
 
91
</programlisting>
 
92
<para>
 
93
</para></refsect2>
 
94
<refsect2 id="CAMEL-UNMATCHED-NAME--CAPS" role="macro">
 
95
<title>CAMEL_UNMATCHED_NAME</title>
 
96
<indexterm zone="CAMEL-UNMATCHED-NAME--CAPS"><primary sortas="CAMEL_UNMATCHED_NAME">CAMEL_UNMATCHED_NAME</primary></indexterm><programlisting>#define CAMEL_UNMATCHED_NAME "UNMATCHED"
 
97
</programlisting>
 
98
<para>
 
99
</para></refsect2>
 
100
<refsect2 id="camel-vee-folder-new" role="function">
 
101
<title>camel_vee_folder_new ()</title>
 
102
<indexterm zone="camel-vee-folder-new"><primary sortas="camel_vee_folder_new">camel_vee_folder_new</primary></indexterm><programlisting><link linkend="CamelFolder">CamelFolder</link> *       camel_vee_folder_new                (<link linkend="CamelStore">CamelStore</link> *parent_store,
 
103
                                                         const <link linkend="gchar">gchar</link> *full,
 
104
                                                         <link linkend="guint32">guint32</link> flags);</programlisting>
 
105
<para>
 
106
Create a new CamelVeeFolder object.</para>
 
107
<para>
 
108
</para><variablelist role="params">
 
109
<varlistentry><term><parameter>parent_store</parameter>&#160;:</term>
 
110
<listitem><simpara> the parent CamelVeeStore
 
111
</simpara></listitem></varlistentry>
 
112
<varlistentry><term><parameter>full</parameter>&#160;:</term>
 
113
<listitem><simpara> the full path to the vfolder.
 
114
</simpara></listitem></varlistentry>
 
115
<varlistentry><term><parameter>flags</parameter>&#160;:</term>
 
116
<listitem><simpara> flags of some kind
 
117
</simpara></listitem></varlistentry>
 
118
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A new CamelVeeFolder widget.
 
119
</simpara></listitem></varlistentry>
 
120
</variablelist></refsect2>
 
121
<refsect2 id="camel-vee-folder-construct" role="function">
 
122
<title>camel_vee_folder_construct ()</title>
 
123
<indexterm zone="camel-vee-folder-construct"><primary sortas="camel_vee_folder_construct">camel_vee_folder_construct</primary></indexterm><programlisting><link linkend="void">void</link>                camel_vee_folder_construct          (<link linkend="CamelVeeFolder">CamelVeeFolder</link> *vf,
 
124
                                                         <link linkend="CamelStore">CamelStore</link> *parent_store,
 
125
                                                         const <link linkend="gchar">gchar</link> *full,
 
126
                                                         const <link linkend="gchar">gchar</link> *name,
 
127
                                                         <link linkend="guint32">guint32</link> flags);</programlisting>
 
128
<para>
 
129
</para><variablelist role="params">
 
130
<varlistentry><term><parameter>vf</parameter>&#160;:</term>
 
131
<listitem><simpara>
 
132
</simpara></listitem></varlistentry>
 
133
<varlistentry><term><parameter>parent_store</parameter>&#160;:</term>
 
134
<listitem><simpara>
 
135
</simpara></listitem></varlistentry>
 
136
<varlistentry><term><parameter>full</parameter>&#160;:</term>
 
137
<listitem><simpara>
 
138
</simpara></listitem></varlistentry>
 
139
<varlistentry><term><parameter>name</parameter>&#160;:</term>
 
140
<listitem><simpara>
 
141
</simpara></listitem></varlistentry>
 
142
<varlistentry><term><parameter>flags</parameter>&#160;:</term>
 
143
<listitem><simpara>
 
144
</simpara></listitem></varlistentry>
 
145
</variablelist></refsect2>
 
146
<refsect2 id="camel-vee-folder-get-location" role="function">
 
147
<title>camel_vee_folder_get_location ()</title>
 
148
<indexterm zone="camel-vee-folder-get-location"><primary sortas="camel_vee_folder_get_location">camel_vee_folder_get_location</primary></indexterm><programlisting><link linkend="CamelFolder">CamelFolder</link> *       camel_vee_folder_get_location       (<link linkend="CamelVeeFolder">CamelVeeFolder</link> *vf,
 
149
                                                         const <link linkend="struct--CamelVeeMessageInfo">struct _CamelVeeMessageInfo</link> *vinfo,
 
150
                                                         <link linkend="gchar">gchar</link> **realuid);</programlisting>
 
151
<para>
 
152
Find the real folder (and uid)</para>
 
153
<para>
 
154
</para><variablelist role="params">
 
155
<varlistentry><term><parameter>vf</parameter>&#160;:</term>
 
156
<listitem><simpara>
 
157
</simpara></listitem></varlistentry>
 
158
<varlistentry><term><parameter>vinfo</parameter>&#160;:</term>
 
159
<listitem><simpara>
 
160
</simpara></listitem></varlistentry>
 
161
<varlistentry><term><parameter>realuid</parameter>&#160;:</term>
 
162
<listitem><simpara> if not NULL, set to the uid of the real message, must be
 
163
g_free'd by caller.
 
164
</simpara></listitem></varlistentry>
 
165
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
 
166
</simpara></listitem></varlistentry>
 
167
</variablelist></refsect2>
 
168
<refsect2 id="camel-vee-folder-add-folder" role="function">
 
169
<title>camel_vee_folder_add_folder ()</title>
 
170
<indexterm zone="camel-vee-folder-add-folder"><primary sortas="camel_vee_folder_add_folder">camel_vee_folder_add_folder</primary></indexterm><programlisting><link linkend="void">void</link>                camel_vee_folder_add_folder         (<link linkend="CamelVeeFolder">CamelVeeFolder</link> *vf,
 
171
                                                         <link linkend="CamelFolder">CamelFolder</link> *sub);</programlisting>
 
172
<para>
 
173
Adds <parameter>sub</parameter> as a source folder to <parameter>vf</parameter>.</para>
 
174
<para>
 
175
</para><variablelist role="params">
 
176
<varlistentry><term><parameter>vf</parameter>&#160;:</term>
 
177
<listitem><simpara> Virtual Folder object
 
178
</simpara></listitem></varlistentry>
 
179
<varlistentry><term><parameter>sub</parameter>&#160;:</term>
 
180
<listitem><simpara> source CamelFolder to add to <parameter>vf</parameter>
 
181
</simpara></listitem></varlistentry>
 
182
</variablelist></refsect2>
 
183
<refsect2 id="camel-vee-folder-remove-folder" role="function">
 
184
<title>camel_vee_folder_remove_folder ()</title>
 
185
<indexterm zone="camel-vee-folder-remove-folder"><primary sortas="camel_vee_folder_remove_folder">camel_vee_folder_remove_folder</primary></indexterm><programlisting><link linkend="void">void</link>                camel_vee_folder_remove_folder      (<link linkend="CamelVeeFolder">CamelVeeFolder</link> *vf,
 
186
                                                         <link linkend="CamelFolder">CamelFolder</link> *sub);</programlisting>
 
187
<para>
 
188
Removed the source folder, <parameter>sub</parameter>, from the virtual folder, <parameter>vf</parameter>.</para>
 
189
<para>
 
190
</para><variablelist role="params">
 
191
<varlistentry><term><parameter>vf</parameter>&#160;:</term>
 
192
<listitem><simpara> Virtual Folder object
 
193
</simpara></listitem></varlistentry>
 
194
<varlistentry><term><parameter>sub</parameter>&#160;:</term>
 
195
<listitem><simpara> source CamelFolder to remove from <parameter>vf</parameter>
 
196
</simpara></listitem></varlistentry>
 
197
</variablelist></refsect2>
 
198
<refsect2 id="camel-vee-folder-set-folders" role="function">
 
199
<title>camel_vee_folder_set_folders ()</title>
 
200
<indexterm zone="camel-vee-folder-set-folders"><primary sortas="camel_vee_folder_set_folders">camel_vee_folder_set_folders</primary></indexterm><programlisting><link linkend="void">void</link>                camel_vee_folder_set_folders        (<link linkend="CamelVeeFolder">CamelVeeFolder</link> *vf,
 
201
                                                         <link linkend="GList">GList</link> *folders);</programlisting>
 
202
<para>
 
203
Set the whole list of folder sources on a vee folder.</para>
 
204
<para>
 
205
</para><variablelist role="params">
 
206
<varlistentry><term><parameter>vf</parameter>&#160;:</term>
 
207
<listitem><simpara>
 
208
</simpara></listitem></varlistentry>
 
209
<varlistentry><term><parameter>folders</parameter>&#160;:</term>
 
210
<listitem><simpara>
 
211
</simpara></listitem></varlistentry>
 
212
</variablelist></refsect2>
 
213
<refsect2 id="camel-vee-folder-rebuild-folder" role="function">
 
214
<title>camel_vee_folder_rebuild_folder ()</title>
 
215
<indexterm zone="camel-vee-folder-rebuild-folder"><primary sortas="camel_vee_folder_rebuild_folder">camel_vee_folder_rebuild_folder</primary></indexterm><programlisting><link linkend="gint">gint</link>                camel_vee_folder_rebuild_folder     (<link linkend="CamelVeeFolder">CamelVeeFolder</link> *vf,
 
216
                                                         <link linkend="CamelFolder">CamelFolder</link> *sub,
 
217
                                                         <link linkend="CamelException">CamelException</link> *ex);</programlisting>
 
218
<para>
 
219
Rebuild the folder <parameter>sub</parameter>, if it should be.</para>
 
220
<para>
 
221
</para><variablelist role="params">
 
222
<varlistentry><term><parameter>vf</parameter>&#160;:</term>
 
223
<listitem><simpara> Virtual Folder object
 
224
</simpara></listitem></varlistentry>
 
225
<varlistentry><term><parameter>sub</parameter>&#160;:</term>
 
226
<listitem><simpara> source CamelFolder to add to <parameter>vf</parameter>
 
227
</simpara></listitem></varlistentry>
 
228
<varlistentry><term><parameter>ex</parameter>&#160;:</term>
 
229
<listitem><simpara> Exception.
 
230
</simpara></listitem></varlistentry>
 
231
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
 
232
</simpara></listitem></varlistentry>
 
233
</variablelist></refsect2>
 
234
<refsect2 id="camel-vee-folder-set-expression" role="function">
 
235
<title>camel_vee_folder_set_expression ()</title>
 
236
<indexterm zone="camel-vee-folder-set-expression"><primary sortas="camel_vee_folder_set_expression">camel_vee_folder_set_expression</primary></indexterm><programlisting><link linkend="void">void</link>                camel_vee_folder_set_expression     (<link linkend="CamelVeeFolder">CamelVeeFolder</link> *vf,
 
237
                                                         const <link linkend="gchar">gchar</link> *expr);</programlisting>
 
238
<para>
 
239
</para><variablelist role="params">
 
240
<varlistentry><term><parameter>vf</parameter>&#160;:</term>
 
241
<listitem><simpara>
 
242
</simpara></listitem></varlistentry>
 
243
<varlistentry><term><parameter>expr</parameter>&#160;:</term>
 
244
<listitem><simpara>
 
245
</simpara></listitem></varlistentry>
 
246
</variablelist></refsect2>
 
247
<refsect2 id="camel-vee-folder-mask-event-folder-changed" role="function">
 
248
<title>camel_vee_folder_mask_event_folder_changed ()</title>
 
249
<indexterm zone="camel-vee-folder-mask-event-folder-changed"><primary sortas="camel_vee_folder_mask_event_folder_changed">camel_vee_folder_mask_event_folder_changed</primary></indexterm><programlisting><link linkend="void">void</link>                camel_vee_folder_mask_event_folder_changed
 
250
                                                        (<link linkend="CamelVeeFolder">CamelVeeFolder</link> *vf,
 
251
                                                         <link linkend="CamelFolder">CamelFolder</link> *sub);</programlisting>
 
252
<para>
 
253
</para><variablelist role="params">
 
254
<varlistentry><term><parameter>vf</parameter>&#160;:</term>
 
255
<listitem><simpara>
 
256
</simpara></listitem></varlistentry>
 
257
<varlistentry><term><parameter>sub</parameter>&#160;:</term>
 
258
<listitem><simpara>
 
259
</simpara></listitem></varlistentry>
 
260
</variablelist></refsect2>
 
261
<refsect2 id="camel-vee-folder-unmask-event-folder-changed" role="function">
 
262
<title>camel_vee_folder_unmask_event_folder_changed ()</title>
 
263
<indexterm zone="camel-vee-folder-unmask-event-folder-changed"><primary sortas="camel_vee_folder_unmask_event_folder_changed">camel_vee_folder_unmask_event_folder_changed</primary></indexterm><programlisting><link linkend="void">void</link>                camel_vee_folder_unmask_event_folder_changed
 
264
                                                        (<link linkend="CamelVeeFolder">CamelVeeFolder</link> *vf,
 
265
                                                         <link linkend="CamelFolder">CamelFolder</link> *sub);</programlisting>
 
266
<para>
 
267
</para><variablelist role="params">
 
268
<varlistentry><term><parameter>vf</parameter>&#160;:</term>
 
269
<listitem><simpara>
 
270
</simpara></listitem></varlistentry>
 
271
<varlistentry><term><parameter>sub</parameter>&#160;:</term>
 
272
<listitem><simpara>
 
273
</simpara></listitem></varlistentry>
 
274
</variablelist></refsect2>
 
275
<refsect2 id="camel-vee-folder-hash-folder" role="function">
 
276
<title>camel_vee_folder_hash_folder ()</title>
 
277
<indexterm zone="camel-vee-folder-hash-folder"><primary sortas="camel_vee_folder_hash_folder">camel_vee_folder_hash_folder</primary></indexterm><programlisting><link linkend="void">void</link>                camel_vee_folder_hash_folder        (<link linkend="CamelFolder">CamelFolder</link> *folder,
 
278
                                                         <link linkend="gchar">gchar</link> buffer[8]);</programlisting>
 
279
<para>
 
280
Create a hash string representing the folder name, which should be
 
281
unique, and remain static for a given folder.</para>
 
282
<para>
 
283
</para><variablelist role="params">
 
284
<varlistentry><term><parameter>folder</parameter>&#160;:</term>
 
285
<listitem><simpara>
 
286
@:
 
287
</simpara></listitem></varlistentry>
 
288
<varlistentry><term><parameter>buffer</parameter>&#160;:</term>
 
289
<listitem><simpara>
 
290
</simpara></listitem></varlistentry>
 
291
</variablelist></refsect2>
 
292
<refsect2 id="camel-vee-folder-sync-headers" role="function">
 
293
<title>camel_vee_folder_sync_headers ()</title>
 
294
<indexterm zone="camel-vee-folder-sync-headers"><primary sortas="camel_vee_folder_sync_headers">camel_vee_folder_sync_headers</primary></indexterm><programlisting><link linkend="void">void</link>                camel_vee_folder_sync_headers       (<link linkend="CamelFolder">CamelFolder</link> *vf,
 
295
                                                         <link linkend="CamelException">CamelException</link> *ex);</programlisting>
 
296
<para>
 
297
</para><variablelist role="params">
 
298
<varlistentry><term><parameter>vf</parameter>&#160;:</term>
 
299
<listitem><simpara>
 
300
</simpara></listitem></varlistentry>
 
301
<varlistentry><term><parameter>ex</parameter>&#160;:</term>
 
302
<listitem><simpara>
 
303
</simpara></listitem></varlistentry>
 
304
</variablelist></refsect2>
 
305
 
 
306
</refsect1>
 
307
 
 
308
 
 
309
 
 
310
 
 
311
</refentry>