← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/libedataserver/xml/e-sexp.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2006-02-27 22:17:31 UTC
  • mfrom: (1.1.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20060227221731-8qmgp0o0d2ooncle
Tags: 1.5.92-0ubuntu1
* New upstream version
* debian/patches/01_weather_calendar_fix.patch:
  - fixed with the new version
* debian/patches/04_external_libdb_autoconf.patch:
  - updated

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libedataserver/xml/e-sexp.xml
3
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
4
<refentry id="libedataserver-ESExp">
5
5
<refmeta>
6
 
<refentrytitle id="top_of_page">ESExp</refentrytitle>
 
6
<refentrytitle>ESExp</refentrytitle>
7
7
<manvolnum>3</manvolnum>
8
8
<refmiscinfo>LIBEDATASERVER Library</refmiscinfo>
9
9
</refmeta>
10
10
 
11
11
<refnamediv>
12
 
<refname>ESExp</refname>
13
 
<refpurpose></refpurpose>
14
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
12
<refname>ESExp</refname><refpurpose></refpurpose>
15
13
</refnamediv>
16
14
 
17
 
<refsynopsisdiv id="synopsis">
18
 
<title id="synopsis.title">Synopsis</title>
 
15
<refsynopsisdiv><title>Synopsis</title>
19
16
 
20
17
<synopsis>
21
18
 
88
85
 
89
86
 
90
87
 
91
 
<refsect1 id="desc">
92
 
<title id="desc.title">Description</title>
 
88
<refsect1>
 
89
<title>Description</title>
93
90
<para>
94
91
 
95
92
</para>
96
93
</refsect1>
97
94
 
98
 
<refsect1 id="details">
99
 
<title id="details.title">Details</title>
 
95
<refsect1>
 
96
<title>Details</title>
100
97
<refsect2>
101
 
<title><anchor id="E-TYPE-SEXP:CAPS" role="macro"/>E_TYPE_SEXP</title>
 
98
<title><anchor id="E-TYPE-SEXP:CAPS"/>E_TYPE_SEXP</title>
102
99
<indexterm><primary>E_TYPE_SEXP</primary></indexterm><programlisting>#define     E_TYPE_SEXP</programlisting>
103
100
<para>
104
101
 
105
102
</para></refsect2>
106
103
<refsect2>
107
 
<title><anchor id="E-SEXP:CAPS" role="macro"/>E_SEXP()</title>
 
104
<title><anchor id="E-SEXP:CAPS"/>E_SEXP()</title>
108
105
<indexterm><primary>E_SEXP</primary></indexterm><programlisting>#define     E_SEXP(obj)</programlisting>
109
106
<para>
110
107
 
116
113
</simpara></listitem></varlistentry>
117
114
</variablelist></refsect2>
118
115
<refsect2>
119
 
<title><anchor id="E-SEXP-CLASS:CAPS" role="macro"/>E_SEXP_CLASS()</title>
 
116
<title><anchor id="E-SEXP-CLASS:CAPS"/>E_SEXP_CLASS()</title>
120
117
<indexterm><primary>E_SEXP_CLASS</primary></indexterm><programlisting>#define     E_SEXP_CLASS(klass)</programlisting>
121
118
<para>
122
119
 
128
125
</simpara></listitem></varlistentry>
129
126
</variablelist></refsect2>
130
127
<refsect2>
131
 
<title><anchor id="IS-E-SEXP:CAPS" role="macro"/>IS_E_SEXP()</title>
 
128
<title><anchor id="IS-E-SEXP:CAPS"/>IS_E_SEXP()</title>
132
129
<indexterm><primary>IS_E_SEXP</primary></indexterm><programlisting>#define     IS_E_SEXP(obj)</programlisting>
133
130
<para>
134
131
 
140
137
</simpara></listitem></varlistentry>
141
138
</variablelist></refsect2>
142
139
<refsect2>
143
 
<title><anchor id="IS-E-SEXP-CLASS:CAPS" role="macro"/>IS_E_SEXP_CLASS()</title>
 
140
<title><anchor id="IS-E-SEXP-CLASS:CAPS"/>IS_E_SEXP_CLASS()</title>
144
141
<indexterm><primary>IS_E_SEXP_CLASS</primary></indexterm><programlisting>#define     IS_E_SEXP_CLASS(klass)</programlisting>
145
142
<para>
146
143
 
152
149
</simpara></listitem></varlistentry>
153
150
</variablelist></refsect2>
154
151
<refsect2>
155
 
<title><anchor id="E-SEXP-GET-CLASS:CAPS" role="macro"/>E_SEXP_GET_CLASS()</title>
 
152
<title><anchor id="E-SEXP-GET-CLASS:CAPS"/>E_SEXP_GET_CLASS()</title>
156
153
<indexterm><primary>E_SEXP_GET_CLASS</primary></indexterm><programlisting>#define     E_SEXP_GET_CLASS(obj)</programlisting>
157
154
<para>
158
155
 
164
161
</simpara></listitem></varlistentry>
165
162
</variablelist></refsect2>
166
163
<refsect2>
167
 
<title><anchor id="ESExpSymbol" role="struct"/>ESExpSymbol</title>
 
164
<title><anchor id="ESExpSymbol"/>ESExpSymbol</title>
168
165
<indexterm><primary>ESExpSymbol</primary></indexterm><programlisting>typedef struct {
169
166
        int type;               /* ESEXP_TERM_FUNC or ESEXP_TERM_VAR */
170
167
        char *name;
179
176
 
180
177
</para></refsect2>
181
178
<refsect2>
182
 
<title><anchor id="ESExpResult" role="struct"/>ESExpResult</title>
 
179
<title><anchor id="ESExpResult"/>ESExpResult</title>
183
180
<indexterm><primary>ESExpResult</primary></indexterm><programlisting>typedef struct {
184
181
        enum _ESExpResultType type;
185
182
        union {
195
192
 
196
193
</para></refsect2>
197
194
<refsect2>
198
 
<title><anchor id="ESExpTerm" role="struct"/>ESExpTerm</title>
 
195
<title><anchor id="ESExpTerm"/>ESExpTerm</title>
199
196
<indexterm><primary>ESExpTerm</primary></indexterm><programlisting>typedef struct {
200
197
        enum _ESExpTermType type;
201
198
        union {
216
213
 
217
214
</para></refsect2>
218
215
<refsect2>
219
 
<title><anchor id="e-sexp-get-type" role="function"/>e_sexp_get_type ()</title>
 
216
<title><anchor id="e-sexp-get-type"/>e_sexp_get_type ()</title>
220
217
<indexterm><primary>e_sexp_get_type</primary></indexterm><programlisting><link linkend="GType">GType</link>       e_sexp_get_type                 (void);</programlisting>
221
218
<para>
222
219
 
227
224
</simpara></listitem></varlistentry>
228
225
</variablelist></refsect2>
229
226
<refsect2>
230
 
<title><anchor id="e-sexp-new" role="function"/>e_sexp_new ()</title>
 
227
<title><anchor id="e-sexp-new"/>e_sexp_new ()</title>
231
228
<indexterm><primary>e_sexp_new</primary></indexterm><programlisting><link linkend="ESExp">ESExp</link>*      e_sexp_new                      (void);</programlisting>
232
229
<para>
233
230
 
238
235
</simpara></listitem></varlistentry>
239
236
</variablelist></refsect2>
240
237
<refsect2>
241
 
<title><anchor id="e-sexp-ref" role="function"/>e_sexp_ref ()</title>
 
238
<title><anchor id="e-sexp-ref"/>e_sexp_ref ()</title>
242
239
<indexterm><primary>e_sexp_ref</primary></indexterm><programlisting><link linkend="void">void</link>        e_sexp_ref                      (<link linkend="ESExp">ESExp</link> *f);</programlisting>
243
240
<para>
244
241
 
250
247
</simpara></listitem></varlistentry>
251
248
</variablelist></refsect2>
252
249
<refsect2>
253
 
<title><anchor id="e-sexp-unref" role="function"/>e_sexp_unref ()</title>
 
250
<title><anchor id="e-sexp-unref"/>e_sexp_unref ()</title>
254
251
<indexterm><primary>e_sexp_unref</primary></indexterm><programlisting><link linkend="void">void</link>        e_sexp_unref                    (<link linkend="ESExp">ESExp</link> *f);</programlisting>
255
252
<para>
256
253
 
262
259
</simpara></listitem></varlistentry>
263
260
</variablelist></refsect2>
264
261
<refsect2>
265
 
<title><anchor id="e-sexp-add-function" role="function"/>e_sexp_add_function ()</title>
 
262
<title><anchor id="e-sexp-add-function"/>e_sexp_add_function ()</title>
266
263
<indexterm><primary>e_sexp_add_function</primary></indexterm><programlisting><link linkend="void">void</link>        e_sexp_add_function             (<link linkend="ESExp">ESExp</link> *f,
267
264
                                             <link linkend="int">int</link> scope,
268
265
                                             <link linkend="char">char</link> *name,
290
287
</simpara></listitem></varlistentry>
291
288
</variablelist></refsect2>
292
289
<refsect2>
293
 
<title><anchor id="e-sexp-add-ifunction" role="function"/>e_sexp_add_ifunction ()</title>
 
290
<title><anchor id="e-sexp-add-ifunction"/>e_sexp_add_ifunction ()</title>
294
291
<indexterm><primary>e_sexp_add_ifunction</primary></indexterm><programlisting><link linkend="void">void</link>        e_sexp_add_ifunction            (<link linkend="ESExp">ESExp</link> *f,
295
292
                                             <link linkend="int">int</link> scope,
296
293
                                             <link linkend="char">char</link> *name,
318
315
</simpara></listitem></varlistentry>
319
316
</variablelist></refsect2>
320
317
<refsect2>
321
 
<title><anchor id="e-sexp-add-variable" role="function"/>e_sexp_add_variable ()</title>
 
318
<title><anchor id="e-sexp-add-variable"/>e_sexp_add_variable ()</title>
322
319
<indexterm><primary>e_sexp_add_variable</primary></indexterm><programlisting><link linkend="void">void</link>        e_sexp_add_variable             (<link linkend="ESExp">ESExp</link> *f,
323
320
                                             <link linkend="int">int</link> scope,
324
321
                                             <link linkend="char">char</link> *name,
342
339
</simpara></listitem></varlistentry>
343
340
</variablelist></refsect2>
344
341
<refsect2>
345
 
<title><anchor id="e-sexp-remove-symbol" role="function"/>e_sexp_remove_symbol ()</title>
 
342
<title><anchor id="e-sexp-remove-symbol"/>e_sexp_remove_symbol ()</title>
346
343
<indexterm><primary>e_sexp_remove_symbol</primary></indexterm><programlisting><link linkend="void">void</link>        e_sexp_remove_symbol            (<link linkend="ESExp">ESExp</link> *f,
347
344
                                             <link linkend="int">int</link> scope,
348
345
                                             <link linkend="char">char</link> *name);</programlisting>
362
359
</simpara></listitem></varlistentry>
363
360
</variablelist></refsect2>
364
361
<refsect2>
365
 
<title><anchor id="e-sexp-set-scope" role="function"/>e_sexp_set_scope ()</title>
 
362
<title><anchor id="e-sexp-set-scope"/>e_sexp_set_scope ()</title>
366
363
<indexterm><primary>e_sexp_set_scope</primary></indexterm><programlisting><link linkend="int">int</link>         e_sexp_set_scope                (<link linkend="ESExp">ESExp</link> *f,
367
364
                                             <link linkend="int">int</link> scope);</programlisting>
368
365
<para>
380
377
</simpara></listitem></varlistentry>
381
378
</variablelist></refsect2>
382
379
<refsect2>
383
 
<title><anchor id="e-sexp-input-text" role="function"/>e_sexp_input_text ()</title>
 
380
<title><anchor id="e-sexp-input-text"/>e_sexp_input_text ()</title>
384
381
<indexterm><primary>e_sexp_input_text</primary></indexterm><programlisting><link linkend="void">void</link>        e_sexp_input_text               (<link linkend="ESExp">ESExp</link> *f,
385
382
                                             const <link linkend="char">char</link> *text,
386
383
                                             <link linkend="int">int</link> len);</programlisting>
400
397
</simpara></listitem></varlistentry>
401
398
</variablelist></refsect2>
402
399
<refsect2>
403
 
<title><anchor id="e-sexp-input-file" role="function"/>e_sexp_input_file ()</title>
 
400
<title><anchor id="e-sexp-input-file"/>e_sexp_input_file ()</title>
404
401
<indexterm><primary>e_sexp_input_file</primary></indexterm><programlisting><link linkend="void">void</link>        e_sexp_input_file               (<link linkend="ESExp">ESExp</link> *f,
405
402
                                             <link linkend="int">int</link> fd);</programlisting>
406
403
<para>
416
413
</simpara></listitem></varlistentry>
417
414
</variablelist></refsect2>
418
415
<refsect2>
419
 
<title><anchor id="e-sexp-parse" role="function"/>e_sexp_parse ()</title>
 
416
<title><anchor id="e-sexp-parse"/>e_sexp_parse ()</title>
420
417
<indexterm><primary>e_sexp_parse</primary></indexterm><programlisting><link linkend="int">int</link>         e_sexp_parse                    (<link linkend="ESExp">ESExp</link> *f);</programlisting>
421
418
<para>
422
419
 
430
427
</simpara></listitem></varlistentry>
431
428
</variablelist></refsect2>
432
429
<refsect2>
433
 
<title><anchor id="e-sexp-eval" role="function"/>e_sexp_eval ()</title>
 
430
<title><anchor id="e-sexp-eval"/>e_sexp_eval ()</title>
434
431
<indexterm><primary>e_sexp_eval</primary></indexterm><programlisting><link linkend="ESExpResult">ESExpResult</link>* e_sexp_eval                    (<link linkend="ESExp">ESExp</link> *f);</programlisting>
435
432
<para>
436
433
 
444
441
</simpara></listitem></varlistentry>
445
442
</variablelist></refsect2>
446
443
<refsect2>
447
 
<title><anchor id="e-sexp-term-eval" role="function"/>e_sexp_term_eval ()</title>
 
444
<title><anchor id="e-sexp-term-eval"/>e_sexp_term_eval ()</title>
448
445
<indexterm><primary>e_sexp_term_eval</primary></indexterm><programlisting><link linkend="ESExpResult">ESExpResult</link>* e_sexp_term_eval               (struct <link linkend="ESExp">_ESExp</link> *f,
449
446
                                             struct <link linkend="ESExpTerm">_ESExpTerm</link> *t);</programlisting>
450
447
<para>
462
459
</simpara></listitem></varlistentry>
463
460
</variablelist></refsect2>
464
461
<refsect2>
465
 
<title><anchor id="e-sexp-result-new" role="function"/>e_sexp_result_new ()</title>
 
462
<title><anchor id="e-sexp-result-new"/>e_sexp_result_new ()</title>
466
463
<indexterm><primary>e_sexp_result_new</primary></indexterm><programlisting><link linkend="ESExpResult">ESExpResult</link>* e_sexp_result_new              (struct <link linkend="ESExp">_ESExp</link> *f,
467
464
                                             <link linkend="int">int</link> type);</programlisting>
468
465
<para>
480
477
</simpara></listitem></varlistentry>
481
478
</variablelist></refsect2>
482
479
<refsect2>
483
 
<title><anchor id="e-sexp-result-free" role="function"/>e_sexp_result_free ()</title>
 
480
<title><anchor id="e-sexp-result-free"/>e_sexp_result_free ()</title>
484
481
<indexterm><primary>e_sexp_result_free</primary></indexterm><programlisting><link linkend="void">void</link>        e_sexp_result_free              (struct <link linkend="ESExp">_ESExp</link> *f,
485
482
                                             struct <link linkend="ESExpResult">_ESExpResult</link> *t);</programlisting>
486
483
<para>
496
493
</simpara></listitem></varlistentry>
497
494
</variablelist></refsect2>
498
495
<refsect2>
499
 
<title><anchor id="e-sexp-resultv-free" role="function"/>e_sexp_resultv_free ()</title>
 
496
<title><anchor id="e-sexp-resultv-free"/>e_sexp_resultv_free ()</title>
500
497
<indexterm><primary>e_sexp_resultv_free</primary></indexterm><programlisting><link linkend="void">void</link>        e_sexp_resultv_free             (struct <link linkend="ESExp">_ESExp</link> *f,
501
498
                                             <link linkend="int">int</link> argc,
502
499
                                             struct <link linkend="ESExpResult">_ESExpResult</link> **argv);</programlisting>
516
513
</simpara></listitem></varlistentry>
517
514
</variablelist></refsect2>
518
515
<refsect2>
519
 
<title><anchor id="e-sexp-encode-bool" role="function"/>e_sexp_encode_bool ()</title>
 
516
<title><anchor id="e-sexp-encode-bool"/>e_sexp_encode_bool ()</title>
520
517
<indexterm><primary>e_sexp_encode_bool</primary></indexterm><programlisting><link linkend="void">void</link>        e_sexp_encode_bool              (<link linkend="GString">GString</link> *s,
521
518
                                             <link linkend="gboolean">gboolean</link> state);</programlisting>
522
519
<para>
533
530
</simpara></listitem></varlistentry>
534
531
</variablelist></refsect2>
535
532
<refsect2>
536
 
<title><anchor id="e-sexp-encode-string" role="function"/>e_sexp_encode_string ()</title>
 
533
<title><anchor id="e-sexp-encode-string"/>e_sexp_encode_string ()</title>
537
534
<indexterm><primary>e_sexp_encode_string</primary></indexterm><programlisting><link linkend="void">void</link>        e_sexp_encode_string            (<link linkend="GString">GString</link> *s,
538
535
                                             const <link linkend="char">char</link> *string);</programlisting>
539
536
<para>
551
548
</simpara></listitem></varlistentry>
552
549
</variablelist></refsect2>
553
550
<refsect2>
554
 
<title><anchor id="e-sexp-fatal-error" role="function"/>e_sexp_fatal_error ()</title>
 
551
<title><anchor id="e-sexp-fatal-error"/>e_sexp_fatal_error ()</title>
555
552
<indexterm><primary>e_sexp_fatal_error</primary></indexterm><programlisting><link linkend="void">void</link>        e_sexp_fatal_error              (struct <link linkend="ESExp">_ESExp</link> *f,
556
553
                                             <link linkend="char">char</link> *why,
557
554
                                             ...);</programlisting>
571
568
</simpara></listitem></varlistentry>
572
569
</variablelist></refsect2>
573
570
<refsect2>
574
 
<title><anchor id="e-sexp-error" role="function"/>e_sexp_error ()</title>
 
571
<title><anchor id="e-sexp-error"/>e_sexp_error ()</title>
575
572
<indexterm><primary>e_sexp_error</primary></indexterm><programlisting>const <link linkend="char">char</link>* e_sexp_error                    (struct <link linkend="ESExp">_ESExp</link> *f);</programlisting>
576
573
<para>
577
574