← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/calendar/libedata-cal/xml/e-cal-backend-sexp.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2009-09-21 13:42:56 UTC
  • mfrom: (1.1.74 upstream)
  • Revision ID: james.westby@ubuntu.com-20090921134256-d6ry0bafbbw4100u
Tags: 2.28.0-0ubuntu1
* New upstream version:
  Bug Fixes:
  Calendar:
  - #494394 - Check backends with their uri too for backward compat. 
  Mailer:
  - #592310 - Adds an environment variable to skip summary check. 
  Translations

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/calendar/libedata-cal/xml/e-cal-backend-sexp.xml
7
7
<manvolnum>3</manvolnum>
8
8
<refmiscinfo>LIBEDATA-CAL Library</refmiscinfo>
9
9
</refmeta>
10
 
 
11
10
<refnamediv>
12
11
<refname>ECalBackendSExp</refname>
13
12
<refpurpose>Regular expressions for calendar searches.</refpurpose>
16
15
<refsynopsisdiv id="ECalBackendSExp.synopsis" role="synopsis">
17
16
<title role="synopsis.title">Synopsis</title>
18
17
 
19
 
<synopsis>
20
 
<link linkend="ECalBackendSExp">ECalBackendSExp</link> *   <link linkend="e-cal-backend-sexp-new">e_cal_backend_sexp_new</link>              (const <link linkend="gchar">gchar</link> *text);
 
18
<synopsis><link linkend="ECalBackendSExp">ECalBackendSExp</link> *   <link linkend="e-cal-backend-sexp-new">e_cal_backend_sexp_new</link>              (const <link linkend="gchar">gchar</link> *text);
21
19
const <link linkend="gchar">gchar</link> *       <link linkend="e-cal-backend-sexp-text">e_cal_backend_sexp_text</link>             (<link linkend="ECalBackendSExp">ECalBackendSExp</link> *sexp);
22
20
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-backend-sexp-match-object">e_cal_backend_sexp_match_object</link>     (<link linkend="ECalBackendSExp">ECalBackendSExp</link> *sexp,
23
21
                                                         const <link linkend="gchar">gchar</link> *object,
51
49
</synopsis>
52
50
</refsynopsisdiv>
53
51
 
54
 
 
55
 
 
56
 
 
57
 
 
58
 
 
59
 
 
60
 
 
61
 
 
62
52
<refsect1 id="ECalBackendSExp.description" role="desc">
63
53
<title role="desc.title">Description</title>
64
54
<para>
65
55
</para>
66
56
</refsect1>
67
 
 
68
57
<refsect1 id="ECalBackendSExp.details" role="details">
69
58
<title role="details.title">Details</title>
70
59
<refsect2 id="e-cal-backend-sexp-new" role="function">
71
60
<title>e_cal_backend_sexp_new ()</title>
72
 
<indexterm zone="e-cal-backend-sexp-new"><primary sortas="e_cal_backend_sexp_new">e_cal_backend_sexp_new</primary></indexterm><programlisting><link linkend="ECalBackendSExp">ECalBackendSExp</link> *   e_cal_backend_sexp_new              (const <link linkend="gchar">gchar</link> *text);</programlisting>
 
61
<indexterm zone="e-cal-backend-sexp-new"><primary>e_cal_backend_sexp_new</primary></indexterm>
 
62
<programlisting><link linkend="ECalBackendSExp">ECalBackendSExp</link> *   e_cal_backend_sexp_new              (const <link linkend="gchar">gchar</link> *text);</programlisting>
73
63
<para>
74
64
</para><variablelist role="params">
75
65
<varlistentry><term><parameter>text</parameter>&#160;:</term>
80
70
</variablelist></refsect2>
81
71
<refsect2 id="e-cal-backend-sexp-text" role="function">
82
72
<title>e_cal_backend_sexp_text ()</title>
83
 
<indexterm zone="e-cal-backend-sexp-text"><primary sortas="e_cal_backend_sexp_text">e_cal_backend_sexp_text</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       e_cal_backend_sexp_text             (<link linkend="ECalBackendSExp">ECalBackendSExp</link> *sexp);</programlisting>
 
73
<indexterm zone="e-cal-backend-sexp-text"><primary>e_cal_backend_sexp_text</primary></indexterm>
 
74
<programlisting>const <link linkend="gchar">gchar</link> *       e_cal_backend_sexp_text             (<link linkend="ECalBackendSExp">ECalBackendSExp</link> *sexp);</programlisting>
84
75
<para>
85
76
Retrieve the text expression for the given ECalBackendSExp object.</para>
86
 
<para>
87
 
</para><variablelist role="params">
 
77
<variablelist role="params">
88
78
<varlistentry><term><parameter>sexp</parameter>&#160;:</term>
89
79
<listitem><simpara> An <link linkend="ECalBackendSExp"><type>ECalBackendSExp</type></link> object.
90
80
</simpara></listitem></varlistentry>
93
83
</variablelist></refsect2>
94
84
<refsect2 id="e-cal-backend-sexp-match-object" role="function">
95
85
<title>e_cal_backend_sexp_match_object ()</title>
96
 
<indexterm zone="e-cal-backend-sexp-match-object"><primary sortas="e_cal_backend_sexp_match_object">e_cal_backend_sexp_match_object</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_backend_sexp_match_object     (<link linkend="ECalBackendSExp">ECalBackendSExp</link> *sexp,
 
86
<indexterm zone="e-cal-backend-sexp-match-object"><primary>e_cal_backend_sexp_match_object</primary></indexterm>
 
87
<programlisting><link linkend="gboolean">gboolean</link>            e_cal_backend_sexp_match_object     (<link linkend="ECalBackendSExp">ECalBackendSExp</link> *sexp,
97
88
                                                         const <link linkend="gchar">gchar</link> *object,
98
89
                                                         <link linkend="ECalBackend">ECalBackend</link> *backend);</programlisting>
99
90
<para>
100
91
Match an iCalendar expression against the expression.</para>
101
 
<para>
102
 
</para><variablelist role="params">
 
92
<variablelist role="params">
103
93
<varlistentry><term><parameter>sexp</parameter>&#160;:</term>
104
94
<listitem><simpara> An <link linkend="ESExp"><type>ESExp</type></link> object.
105
95
</simpara></listitem></varlistentry>
114
104
</variablelist></refsect2>
115
105
<refsect2 id="e-cal-backend-sexp-match-comp" role="function">
116
106
<title>e_cal_backend_sexp_match_comp ()</title>
117
 
<indexterm zone="e-cal-backend-sexp-match-comp"><primary sortas="e_cal_backend_sexp_match_comp">e_cal_backend_sexp_match_comp</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_backend_sexp_match_comp       (<link linkend="ECalBackendSExp">ECalBackendSExp</link> *sexp,
 
107
<indexterm zone="e-cal-backend-sexp-match-comp"><primary>e_cal_backend_sexp_match_comp</primary></indexterm>
 
108
<programlisting><link linkend="gboolean">gboolean</link>            e_cal_backend_sexp_match_comp       (<link linkend="ECalBackendSExp">ECalBackendSExp</link> *sexp,
118
109
                                                         <link linkend="ECalComponent">ECalComponent</link> *comp,
119
110
                                                         <link linkend="ECalBackend">ECalBackend</link> *backend);</programlisting>
120
111
<para>
121
112
Matches the given ECalComponent against the expression.</para>
122
 
<para>
123
 
</para><variablelist role="params">
 
113
<variablelist role="params">
124
114
<varlistentry><term><parameter>sexp</parameter>&#160;:</term>
125
115
<listitem><simpara> An <link linkend="ESExp"><type>ESExp</type></link> object.
126
116
</simpara></listitem></varlistentry>
135
125
</variablelist></refsect2>
136
126
<refsect2 id="e-cal-backend-sexp-func-time-now" role="function">
137
127
<title>e_cal_backend_sexp_func_time_now ()</title>
138
 
<indexterm zone="e-cal-backend-sexp-func-time-now"><primary sortas="e_cal_backend_sexp_func_time_now">e_cal_backend_sexp_func_time_now</primary></indexterm><programlisting><link linkend="ESExpResult">ESExpResult</link> *       e_cal_backend_sexp_func_time_now    (<link linkend="ESExp">ESExp</link> *esexp,
 
128
<indexterm zone="e-cal-backend-sexp-func-time-now"><primary>e_cal_backend_sexp_func_time_now</primary></indexterm>
 
129
<programlisting><link linkend="ESExpResult">ESExpResult</link> *       e_cal_backend_sexp_func_time_now    (<link linkend="ESExp">ESExp</link> *esexp,
139
130
                                                         <link linkend="gint">gint</link> argc,
140
131
                                                         <link linkend="ESExpResult">ESExpResult</link> **argv,
141
132
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
142
133
<para>
143
134
Processes the (time-now) sexp expression.</para>
144
 
<para>
145
 
</para><variablelist role="params">
 
135
<variablelist role="params">
146
136
<varlistentry><term><parameter>esexp</parameter>&#160;:</term>
147
137
<listitem><simpara> An <link linkend="ESExp"><type>ESExp</type></link> object.
148
138
</simpara></listitem></varlistentry>
160
150
</variablelist></refsect2>
161
151
<refsect2 id="e-cal-backend-sexp-func-make-time" role="function">
162
152
<title>e_cal_backend_sexp_func_make_time ()</title>
163
 
<indexterm zone="e-cal-backend-sexp-func-make-time"><primary sortas="e_cal_backend_sexp_func_make_time">e_cal_backend_sexp_func_make_time</primary></indexterm><programlisting><link linkend="ESExpResult">ESExpResult</link> *       e_cal_backend_sexp_func_make_time   (<link linkend="ESExp">ESExp</link> *esexp,
 
153
<indexterm zone="e-cal-backend-sexp-func-make-time"><primary>e_cal_backend_sexp_func_make_time</primary></indexterm>
 
154
<programlisting><link linkend="ESExpResult">ESExpResult</link> *       e_cal_backend_sexp_func_make_time   (<link linkend="ESExp">ESExp</link> *esexp,
164
155
                                                         <link linkend="gint">gint</link> argc,
165
156
                                                         <link linkend="ESExpResult">ESExpResult</link> **argv,
166
157
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
170
161
</para>
171
162
<para>
172
163
Constructs a time_t value for the specified date.</para>
173
 
<para>
174
 
</para><variablelist role="params">
 
164
<variablelist role="params">
175
165
<varlistentry><term><parameter>esexp</parameter>&#160;:</term>
176
166
<listitem><simpara> An <link linkend="ESExp"><type>ESExp</type></link> object.
177
167
</simpara></listitem></varlistentry>
189
179
</variablelist></refsect2>
190
180
<refsect2 id="e-cal-backend-sexp-func-time-add-day" role="function">
191
181
<title>e_cal_backend_sexp_func_time_add_day ()</title>
192
 
<indexterm zone="e-cal-backend-sexp-func-time-add-day"><primary sortas="e_cal_backend_sexp_func_time_add_day">e_cal_backend_sexp_func_time_add_day</primary></indexterm><programlisting><link linkend="ESExpResult">ESExpResult</link> *       e_cal_backend_sexp_func_time_add_day
 
182
<indexterm zone="e-cal-backend-sexp-func-time-add-day"><primary>e_cal_backend_sexp_func_time_add_day</primary></indexterm>
 
183
<programlisting><link linkend="ESExpResult">ESExpResult</link> *       e_cal_backend_sexp_func_time_add_day
193
184
                                                        (<link linkend="ESExp">ESExp</link> *esexp,
194
185
                                                         <link linkend="gint">gint</link> argc,
195
186
                                                         <link linkend="ESExpResult">ESExpResult</link> **argv,
205
196
<para>
206
197
FIXME: TIMEZONES - need to use a timezone or daylight saving changes will
207
198
make the result incorrect.</para>
208
 
<para>
209
 
</para><variablelist role="params">
 
199
<variablelist role="params">
210
200
<varlistentry><term><parameter>esexp</parameter>&#160;:</term>
211
201
<listitem><simpara> An <link linkend="ESExp"><type>ESExp</type></link> object.
212
202
</simpara></listitem></varlistentry>
224
214
</variablelist></refsect2>
225
215
<refsect2 id="e-cal-backend-sexp-func-time-day-begin" role="function">
226
216
<title>e_cal_backend_sexp_func_time_day_begin ()</title>
227
 
<indexterm zone="e-cal-backend-sexp-func-time-day-begin"><primary sortas="e_cal_backend_sexp_func_time_day_begin">e_cal_backend_sexp_func_time_day_begin</primary></indexterm><programlisting><link linkend="ESExpResult">ESExpResult</link> *       e_cal_backend_sexp_func_time_day_begin
 
217
<indexterm zone="e-cal-backend-sexp-func-time-day-begin"><primary>e_cal_backend_sexp_func_time_day_begin</primary></indexterm>
 
218
<programlisting><link linkend="ESExpResult">ESExpResult</link> *       e_cal_backend_sexp_func_time_day_begin
228
219
                                                        (<link linkend="ESExp">ESExp</link> *esexp,
229
220
                                                         <link linkend="gint">gint</link> argc,
230
221
                                                         <link linkend="ESExpResult">ESExpResult</link> **argv,
238
229
</para>
239
230
<para>
240
231
FIXME: TIMEZONES - this uses the current Unix timezone.</para>
241
 
<para>
242
 
</para><variablelist role="params">
 
232
<variablelist role="params">
243
233
<varlistentry><term><parameter>esexp</parameter>&#160;:</term>
244
234
<listitem><simpara> An <link linkend="ESExp"><type>ESExp</type></link> object.
245
235
</simpara></listitem></varlistentry>
257
247
</variablelist></refsect2>
258
248
<refsect2 id="e-cal-backend-sexp-func-time-day-end" role="function">
259
249
<title>e_cal_backend_sexp_func_time_day_end ()</title>
260
 
<indexterm zone="e-cal-backend-sexp-func-time-day-end"><primary sortas="e_cal_backend_sexp_func_time_day_end">e_cal_backend_sexp_func_time_day_end</primary></indexterm><programlisting><link linkend="ESExpResult">ESExpResult</link> *       e_cal_backend_sexp_func_time_day_end
 
250
<indexterm zone="e-cal-backend-sexp-func-time-day-end"><primary>e_cal_backend_sexp_func_time_day_end</primary></indexterm>
 
251
<programlisting><link linkend="ESExpResult">ESExpResult</link> *       e_cal_backend_sexp_func_time_day_end
261
252
                                                        (<link linkend="ESExp">ESExp</link> *esexp,
262
253
                                                         <link linkend="gint">gint</link> argc,
263
254
                                                         <link linkend="ESExpResult">ESExpResult</link> **argv,
271
262
</para>
272
263
<para>
273
264
FIXME: TIMEZONES - this uses the current Unix timezone.</para>
274
 
<para>
275
 
</para><variablelist role="params">
 
265
<variablelist role="params">
276
266
<varlistentry><term><parameter>esexp</parameter>&#160;:</term>
277
267
<listitem><simpara> An <link linkend="ESExp"><type>ESExp</type></link> object.
278
268
</simpara></listitem></varlistentry>
291
281
 
292
282
</refsect1>
293
283
 
294
 
 
295
 
 
296
 
 
297
284
</refentry>