← 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/libecal/xml/e-cal.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-01 22:47:15 UTC
  • mfrom: (1.1.77 upstream)
  • Revision ID: james.westby@ubuntu.com-20100301224715-drsxc2y3t8anz3c0
Tags: 2.28.3-0ubuntu1
https://launchpad.net/bugs/455020
https://launchpad.net/bugs/475147
https://launchpad.net/bugs/305428
https://launchpad.net/bugs/341909
https://launchpad.net/bugs/444177
* New upstream version:
  Bug Fixes:
  - #602723 - Contact list name doesn't get displayed in 'To' dialog 
  - #600322 - assertion failed: (reply == msg) in cs_waitinfo()
              (lp: #455020, #475147)
  - #564727 - Few memory leaks (lp: #305428)
  - #574940 - Always ref returned info from message_info_from_uid 
              (lp: #341909)
  - #429317 - Use the relative URI returned if the server 
              re-directs a request
  - #602820 - Test validity of a book_view before using it in LDAP 
  - #590762 - Recurring google calendar items are not changeable
  - #604236 - Slow GPG processing 
  - #597816 - Do not crash on incorrect parameters used in sexp to SQL 
              (lp: #444177)
  - #604544 - Try Exchange fallback authentication only once 
  - #600778 - Fix --enable-e2k-debug configure option resolution 
  - #260407 - 'endswith' address book search doesn't work 
  - #549221 - (bnc) delete, sync flags immediately
* debian/patches/99_reconfigure.patch:
  - new version update

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/calendar/libecal/xml/e-cal.xml
5
5
<refmeta>
6
6
<refentrytitle role="top_of_page" id="ECal.top_of_page">ECal</refentrytitle>
7
7
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>LIBECAL Library</refmiscinfo>
 
8
<refmiscinfo>
 
9
  LIBECAL Library
 
10
</refmiscinfo>
9
11
</refmeta>
10
 
 
11
12
<refnamediv>
12
13
<refname>ECal</refname>
13
14
<refpurpose>Permits access to a calendar or list of tasks.</refpurpose>
16
17
<refsynopsisdiv id="ECal.synopsis" role="synopsis">
17
18
<title role="synopsis.title">Synopsis</title>
18
19
 
19
 
<synopsis>
20
 
                    <link linkend="ECal-struct">ECal</link>;
21
 
#define             <link linkend="E-CAL-SET-MODE-STATUS-ENUM-TYPE--CAPS">E_CAL_SET_MODE_STATUS_ENUM_TYPE</link>
22
 
#define             <link linkend="CAL-MODE-ENUM-TYPE--CAPS">CAL_MODE_ENUM_TYPE</link>
 
20
<synopsis>                    <link linkend="ECal-struct">ECal</link>;
 
21
#define             <link linkend="E-CAL-SET-MODE-STATUS-ENUM-TYPE:CAPS">E_CAL_SET_MODE_STATUS_ENUM_TYPE</link>
 
22
#define             <link linkend="CAL-MODE-ENUM-TYPE:CAPS">CAL_MODE_ENUM_TYPE</link>
23
23
enum                <link linkend="ECalSourceType">ECalSourceType</link>;
24
24
enum                <link linkend="ECalSetModeStatus">ECalSetModeStatus</link>;
25
25
enum                <link linkend="ECalLoadState">ECalLoadState</link>;
26
 
<link linkend="gchar">gchar</link> *             (<link linkend="ECalAuthFunc">*ECalAuthFunc</link>)                     (<link linkend="ECal">ECal</link> *ecal,
27
 
                                                         const <link linkend="gchar">gchar</link> *prompt,
28
 
                                                         const <link linkend="gchar">gchar</link> *key,
29
 
                                                         <link linkend="gpointer">gpointer</link> user_data);
30
 
<link linkend="GType">GType</link>               <link linkend="e-cal-open-status-enum-get-type">e_cal_open_status_enum_get_type</link>     (void);
31
 
<link linkend="GType">GType</link>               <link linkend="e-cal-source-type-enum-get-type">e_cal_source_type_enum_get_type</link>     (void);
32
 
<link linkend="GType">GType</link>               <link linkend="e-cal-set-mode-status-enum-get-type">e_cal_set_mode_status_enum_get_type</link> (void);
33
 
<link linkend="GType">GType</link>               <link linkend="cal-mode-enum-get-type">cal_mode_enum_get_type</link>              (void);
34
 
<link linkend="ECal">ECal</link> *              <link linkend="e-cal-new">e_cal_new</link>                           (<link linkend="ESource">ESource</link> *source,
35
 
                                                         <link linkend="ECalSourceType">ECalSourceType</link> type);
36
 
<link linkend="ECal">ECal</link> *              <link linkend="e-cal-new-from-uri">e_cal_new_from_uri</link>                  (const <link linkend="gchar">gchar</link> *uri,
37
 
                                                         <link linkend="ECalSourceType">ECalSourceType</link> type);
38
 
<link linkend="ECal">ECal</link> *              <link linkend="e-cal-new-system-calendar">e_cal_new_system_calendar</link>           (void);
39
 
<link linkend="ECal">ECal</link> *              <link linkend="e-cal-new-system-tasks">e_cal_new_system_tasks</link>              (void);
40
 
<link linkend="ECal">ECal</link> *              <link linkend="e-cal-new-system-memos">e_cal_new_system_memos</link>              (void);
41
 
<link linkend="void">void</link>                <link linkend="e-cal-set-auth-func">e_cal_set_auth_func</link>                 (<link linkend="ECal">ECal</link> *ecal,
42
 
                                                         <link linkend="ECalAuthFunc">ECalAuthFunc</link> func,
43
 
                                                         <link linkend="gpointer">gpointer</link> data);
44
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-open">e_cal_open</link>                          (<link linkend="ECal">ECal</link> *ecal,
45
 
                                                         <link linkend="gboolean">gboolean</link> only_if_exists,
46
 
                                                         <link linkend="GError">GError</link> **error);
47
 
<link linkend="void">void</link>                <link linkend="e-cal-open-async">e_cal_open_async</link>                    (<link linkend="ECal">ECal</link> *ecal,
48
 
                                                         <link linkend="gboolean">gboolean</link> only_if_exists);
49
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-remove">e_cal_remove</link>                        (<link linkend="ECal">ECal</link> *ecal,
50
 
                                                         <link linkend="GError">GError</link> **error);
51
 
<link linkend="GList">GList</link> *             <link linkend="e-cal-uri-list">e_cal_uri_list</link>                      (<link linkend="ECal">ECal</link> *ecal,
52
 
                                                         <link linkend="CalMode">CalMode</link> mode);
53
 
<link linkend="ECalSourceType">ECalSourceType</link>      <link linkend="e-cal-get-source-type">e_cal_get_source_type</link>               (<link linkend="ECal">ECal</link> *ecal);
54
 
<link linkend="ECalLoadState">ECalLoadState</link>       <link linkend="e-cal-get-load-state">e_cal_get_load_state</link>                (<link linkend="ECal">ECal</link> *ecal);
55
 
<link linkend="ESource">ESource</link> *           <link linkend="e-cal-get-source">e_cal_get_source</link>                    (<link linkend="ECal">ECal</link> *ecal);
56
 
const <link linkend="gchar">gchar</link> *       <link linkend="e-cal-get-uri">e_cal_get_uri</link>                       (<link linkend="ECal">ECal</link> *ecal);
57
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-is-read-only">e_cal_is_read_only</link>                  (<link linkend="ECal">ECal</link> *ecal,
58
 
                                                         <link linkend="gboolean">gboolean</link> *read_only,
59
 
                                                         <link linkend="GError">GError</link> **error);
60
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-get-cal-address">e_cal_get_cal_address</link>               (<link linkend="ECal">ECal</link> *ecal,
61
 
                                                         <link linkend="gchar">gchar</link> **cal_address,
62
 
                                                         <link linkend="GError">GError</link> **error);
63
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-get-alarm-email-address">e_cal_get_alarm_email_address</link>       (<link linkend="ECal">ECal</link> *ecal,
64
 
                                                         <link linkend="gchar">gchar</link> **alarm_address,
65
 
                                                         <link linkend="GError">GError</link> **error);
66
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-get-ldap-attribute">e_cal_get_ldap_attribute</link>            (<link linkend="ECal">ECal</link> *ecal,
67
 
                                                         <link linkend="gchar">gchar</link> **ldap_attribute,
68
 
                                                         <link linkend="GError">GError</link> **error);
69
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-get-one-alarm-only">e_cal_get_one_alarm_only</link>            (<link linkend="ECal">ECal</link> *ecal);
70
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-get-organizer-must-attend">e_cal_get_organizer_must_attend</link>     (<link linkend="ECal">ECal</link> *ecal);
71
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-get-save-schedules">e_cal_get_save_schedules</link>            (<link linkend="ECal">ECal</link> *ecal);
72
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-get-static-capability">e_cal_get_static_capability</link>         (<link linkend="ECal">ECal</link> *ecal,
73
 
                                                         const <link linkend="gchar">gchar</link> *cap);
74
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-get-organizer-must-accept">e_cal_get_organizer_must_accept</link>     (<link linkend="ECal">ECal</link> *ecal);
75
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-set-mode">e_cal_set_mode</link>                      (<link linkend="ECal">ECal</link> *ecal,
76
 
                                                         <link linkend="CalMode">CalMode</link> mode);
77
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-get-default-object">e_cal_get_default_object</link>            (<link linkend="ECal">ECal</link> *ecal,
78
 
                                                         <link linkend="icalcomponent">icalcomponent</link> **icalcomp,
79
 
                                                         <link linkend="GError">GError</link> **error);
80
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-get-object">e_cal_get_object</link>                    (<link linkend="ECal">ECal</link> *ecal,
81
 
                                                         const <link linkend="gchar">gchar</link> *uid,
82
 
                                                         const <link linkend="gchar">gchar</link> *rid,
83
 
                                                         <link linkend="icalcomponent">icalcomponent</link> **icalcomp,
84
 
                                                         <link linkend="GError">GError</link> **error);
85
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-get-objects-for-uid">e_cal_get_objects_for_uid</link>           (<link linkend="ECal">ECal</link> *ecal,
86
 
                                                         const <link linkend="gchar">gchar</link> *uid,
87
 
                                                         <link linkend="GList">GList</link> **objects,
88
 
                                                         <link linkend="GError">GError</link> **error);
89
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-get-changes">e_cal_get_changes</link>                   (<link linkend="ECal">ECal</link> *ecal,
90
 
                                                         const <link linkend="gchar">gchar</link> *change_id,
91
 
                                                         <link linkend="GList">GList</link> **changes,
92
 
                                                         <link linkend="GError">GError</link> **error);
93
 
<link linkend="void">void</link>                <link linkend="e-cal-free-change-list">e_cal_free_change_list</link>              (<link linkend="GList">GList</link> *list);
94
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-get-object-list">e_cal_get_object_list</link>               (<link linkend="ECal">ECal</link> *ecal,
95
 
                                                         const <link linkend="gchar">gchar</link> *query,
96
 
                                                         <link linkend="GList">GList</link> **objects,
97
 
                                                         <link linkend="GError">GError</link> **error);
98
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-get-object-list-as-comp">e_cal_get_object_list_as_comp</link>       (<link linkend="ECal">ECal</link> *ecal,
99
 
                                                         const <link linkend="gchar">gchar</link> *query,
100
 
                                                         <link linkend="GList">GList</link> **objects,
101
 
                                                         <link linkend="GError">GError</link> **error);
102
 
<link linkend="void">void</link>                <link linkend="e-cal-free-object-list">e_cal_free_object_list</link>              (<link linkend="GList">GList</link> *objects);
103
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-get-free-busy">e_cal_get_free_busy</link>                 (<link linkend="ECal">ECal</link> *ecal,
104
 
                                                         <link linkend="GList">GList</link> *users,
105
 
                                                         <link linkend="time-t">time_t</link> start,
106
 
                                                         <link linkend="time-t">time_t</link> end,
107
 
                                                         <link linkend="GList">GList</link> **freebusy,
108
 
                                                         <link linkend="GError">GError</link> **error);
109
 
<link linkend="void">void</link>                <link linkend="e-cal-generate-instances">e_cal_generate_instances</link>            (<link linkend="ECal">ECal</link> *ecal,
110
 
                                                         <link linkend="time-t">time_t</link> start,
111
 
                                                         <link linkend="time-t">time_t</link> end,
112
 
                                                         <link linkend="ECalRecurInstanceFn">ECalRecurInstanceFn</link> cb,
113
 
                                                         <link linkend="gpointer">gpointer</link> cb_data);
114
 
<link linkend="void">void</link>                <link linkend="e-cal-generate-instances-for-object">e_cal_generate_instances_for_object</link> (<link linkend="ECal">ECal</link> *ecal,
115
 
                                                         <link linkend="icalcomponent">icalcomponent</link> *icalcomp,
116
 
                                                         <link linkend="time-t">time_t</link> start,
117
 
                                                         <link linkend="time-t">time_t</link> end,
118
 
                                                         <link linkend="ECalRecurInstanceFn">ECalRecurInstanceFn</link> cb,
119
 
                                                         <link linkend="gpointer">gpointer</link> cb_data);
120
 
<link linkend="GSList">GSList</link> *            <link linkend="e-cal-get-alarms-in-range">e_cal_get_alarms_in_range</link>           (<link linkend="ECal">ECal</link> *ecal,
121
 
                                                         <link linkend="time-t">time_t</link> start,
122
 
                                                         <link linkend="time-t">time_t</link> end);
123
 
<link linkend="void">void</link>                <link linkend="e-cal-free-alarms">e_cal_free_alarms</link>                   (<link linkend="GSList">GSList</link> *comp_alarms);
124
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-get-alarms-for-object">e_cal_get_alarms_for_object</link>         (<link linkend="ECal">ECal</link> *ecal,
125
 
                                                         const <link linkend="ECalComponentId">ECalComponentId</link> *id,
126
 
                                                         <link linkend="time-t">time_t</link> start,
127
 
                                                         <link linkend="time-t">time_t</link> end,
128
 
                                                         <link linkend="ECalComponentAlarms">ECalComponentAlarms</link> **alarms);
129
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-create-object">e_cal_create_object</link>                 (<link linkend="ECal">ECal</link> *ecal,
130
 
                                                         <link linkend="icalcomponent">icalcomponent</link> *icalcomp,
131
 
                                                         <link linkend="gchar">gchar</link> **uid,
132
 
                                                         <link linkend="GError">GError</link> **error);
133
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-modify-object">e_cal_modify_object</link>                 (<link linkend="ECal">ECal</link> *ecal,
134
 
                                                         <link linkend="icalcomponent">icalcomponent</link> *icalcomp,
135
 
                                                         <link linkend="CalObjModType">CalObjModType</link> mod,
136
 
                                                         <link linkend="GError">GError</link> **error);
137
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-remove-object">e_cal_remove_object</link>                 (<link linkend="ECal">ECal</link> *ecal,
138
 
                                                         const <link linkend="gchar">gchar</link> *uid,
139
 
                                                         <link linkend="GError">GError</link> **error);
140
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-remove-object-with-mod">e_cal_remove_object_with_mod</link>        (<link linkend="ECal">ECal</link> *ecal,
141
 
                                                         const <link linkend="gchar">gchar</link> *uid,
142
 
                                                         const <link linkend="gchar">gchar</link> *rid,
143
 
                                                         <link linkend="CalObjModType">CalObjModType</link> mod,
144
 
                                                         <link linkend="GError">GError</link> **error);
145
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-discard-alarm">e_cal_discard_alarm</link>                 (<link linkend="ECal">ECal</link> *ecal,
146
 
                                                         <link linkend="ECalComponent">ECalComponent</link> *comp,
147
 
                                                         const <link linkend="gchar">gchar</link> *auid,
148
 
                                                         <link linkend="GError">GError</link> **error);
149
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-receive-objects">e_cal_receive_objects</link>               (<link linkend="ECal">ECal</link> *ecal,
150
 
                                                         <link linkend="icalcomponent">icalcomponent</link> *icalcomp,
151
 
                                                         <link linkend="GError">GError</link> **error);
152
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-send-objects">e_cal_send_objects</link>                  (<link linkend="ECal">ECal</link> *ecal,
153
 
                                                         <link linkend="icalcomponent">icalcomponent</link> *icalcomp,
154
 
                                                         <link linkend="GList">GList</link> **users,
155
 
                                                         <link linkend="icalcomponent">icalcomponent</link> **modified_icalcomp,
156
 
                                                         <link linkend="GError">GError</link> **error);
157
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-get-timezone">e_cal_get_timezone</link>                  (<link linkend="ECal">ECal</link> *ecal,
158
 
                                                         const <link linkend="gchar">gchar</link> *tzid,
159
 
                                                         <link linkend="icaltimezone">icaltimezone</link> **zone,
160
 
                                                         <link linkend="GError">GError</link> **error);
161
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-add-timezone">e_cal_add_timezone</link>                  (<link linkend="ECal">ECal</link> *ecal,
162
 
                                                         <link linkend="icaltimezone">icaltimezone</link> *izone,
163
 
                                                         <link linkend="GError">GError</link> **error);
164
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-set-default-timezone">e_cal_set_default_timezone</link>          (<link linkend="ECal">ECal</link> *ecal,
165
 
                                                         <link linkend="icaltimezone">icaltimezone</link> *zone,
166
 
                                                         <link linkend="GError">GError</link> **error);
167
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-get-query">e_cal_get_query</link>                     (<link linkend="ECal">ECal</link> *ecal,
168
 
                                                         const <link linkend="gchar">gchar</link> *sexp,
169
 
                                                         <link linkend="ECalView">ECalView</link> **query,
170
 
                                                         <link linkend="GError">GError</link> **error);
171
 
<link linkend="icaltimezone">icaltimezone</link> *      <link linkend="e-cal-resolve-tzid-cb">e_cal_resolve_tzid_cb</link>               (const <link linkend="gchar">gchar</link> *tzid,
172
 
                                                         <link linkend="gpointer">gpointer</link> data);
173
 
<link linkend="gchar">gchar</link> *             <link linkend="e-cal-get-component-as-string">e_cal_get_component_as_string</link>       (<link linkend="ECal">ECal</link> *ecal,
174
 
                                                         <link linkend="icalcomponent">icalcomponent</link> *icalcomp);
175
 
const <link linkend="gchar">gchar</link> *       <link linkend="e-cal-get-error-message">e_cal_get_error_message</link>             (<link linkend="ECalendarStatus">ECalendarStatus</link> status);
176
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-open-default">e_cal_open_default</link>                  (<link linkend="ECal">ECal</link> **ecal,
177
 
                                                         <link linkend="ECalSourceType">ECalSourceType</link> type,
178
 
                                                         <link linkend="ECalAuthFunc">ECalAuthFunc</link> func,
179
 
                                                         <link linkend="gpointer">gpointer</link> data,
180
 
                                                         <link linkend="GError">GError</link> **error);
181
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-set-default">e_cal_set_default</link>                   (<link linkend="ECal">ECal</link> *ecal,
182
 
                                                         <link linkend="GError">GError</link> **error);
183
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-set-default-source">e_cal_set_default_source</link>            (<link linkend="ESource">ESource</link> *source,
184
 
                                                         <link linkend="ECalSourceType">ECalSourceType</link> type,
185
 
                                                         <link linkend="GError">GError</link> **error);
186
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-get-sources">e_cal_get_sources</link>                   (<link linkend="ESourceList">ESourceList</link> **sources,
187
 
                                                         <link linkend="ECalSourceType">ECalSourceType</link> type,
188
 
                                                         <link linkend="GError">GError</link> **error);
189
 
const <link linkend="gchar">gchar</link> *       <link linkend="e-cal-get-local-attachment-store">e_cal_get_local_attachment_store</link>    (<link linkend="ECal">ECal</link> *ecal);
190
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-get-recurrences-no-master">e_cal_get_recurrences_no_master</link>     (<link linkend="ECal">ECal</link> *ecal);
191
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-get-attachments-for-comp">e_cal_get_attachments_for_comp</link>      (<link linkend="ECal">ECal</link> *ecal,
192
 
                                                         const <link linkend="gchar">gchar</link> *uid,
193
 
                                                         const <link linkend="gchar">gchar</link> *rid,
194
 
                                                         <link linkend="GSList">GSList</link> **list,
195
 
                                                         <link linkend="GError">GError</link> **error);
 
26
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             (<link linkend="ECalAuthFunc">*ECalAuthFunc</link>)                     (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
27
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *prompt</parameter>,
 
28
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>,
 
29
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>);
 
30
<link linkend="GType"><returnvalue>GType</returnvalue></link>               <link linkend="e-cal-open-status-enum-get-type">e_cal_open_status_enum_get_type</link>     (<parameter><type>void</type></parameter>);
 
31
<link linkend="GType"><returnvalue>GType</returnvalue></link>               <link linkend="e-cal-source-type-enum-get-type">e_cal_source_type_enum_get_type</link>     (<parameter><type>void</type></parameter>);
 
32
<link linkend="GType"><returnvalue>GType</returnvalue></link>               <link linkend="e-cal-set-mode-status-enum-get-type">e_cal_set_mode_status_enum_get_type</link> (<parameter><type>void</type></parameter>);
 
33
<link linkend="GType"><returnvalue>GType</returnvalue></link>               <link linkend="cal-mode-enum-get-type">cal_mode_enum_get_type</link>              (<parameter><type>void</type></parameter>);
 
34
<link linkend="ECal"><returnvalue>ECal</returnvalue></link> *              <link linkend="e-cal-new">e_cal_new</link>                           (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
 
35
                                                         <parameter><link linkend="ECalSourceType"><type>ECalSourceType</type></link> type</parameter>);
 
36
<link linkend="ECal"><returnvalue>ECal</returnvalue></link> *              <link linkend="e-cal-new-from-uri">e_cal_new_from_uri</link>                  (<parameter>const <link linkend="gchar"><type>gchar</type></link> *uri</parameter>,
 
37
                                                         <parameter><link linkend="ECalSourceType"><type>ECalSourceType</type></link> type</parameter>);
 
38
<link linkend="ECal"><returnvalue>ECal</returnvalue></link> *              <link linkend="e-cal-new-system-calendar">e_cal_new_system_calendar</link>           (<parameter><type>void</type></parameter>);
 
39
<link linkend="ECal"><returnvalue>ECal</returnvalue></link> *              <link linkend="e-cal-new-system-tasks">e_cal_new_system_tasks</link>              (<parameter><type>void</type></parameter>);
 
40
<link linkend="ECal"><returnvalue>ECal</returnvalue></link> *              <link linkend="e-cal-new-system-memos">e_cal_new_system_memos</link>              (<parameter><type>void</type></parameter>);
 
41
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-cal-set-auth-func">e_cal_set_auth_func</link>                 (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
42
                                                         <parameter><link linkend="ECalAuthFunc"><type>ECalAuthFunc</type></link> func</parameter>,
 
43
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>);
 
44
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-open">e_cal_open</link>                          (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
45
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> only_if_exists</parameter>,
 
46
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
47
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-cal-open-async">e_cal_open_async</link>                    (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
48
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> only_if_exists</parameter>);
 
49
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-remove">e_cal_remove</link>                        (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
50
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
51
<link linkend="GList"><returnvalue>GList</returnvalue></link> *             <link linkend="e-cal-uri-list">e_cal_uri_list</link>                      (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
52
                                                         <parameter><link linkend="CalMode"><type>CalMode</type></link> mode</parameter>);
 
53
<link linkend="ECalSourceType"><returnvalue>ECalSourceType</returnvalue></link>      <link linkend="e-cal-get-source-type">e_cal_get_source_type</link>               (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>);
 
54
<link linkend="ECalLoadState"><returnvalue>ECalLoadState</returnvalue></link>       <link linkend="e-cal-get-load-state">e_cal_get_load_state</link>                (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>);
 
55
<link linkend="ESource"><returnvalue>ESource</returnvalue></link> *           <link linkend="e-cal-get-source">e_cal_get_source</link>                    (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>);
 
56
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       <link linkend="e-cal-get-uri">e_cal_get_uri</link>                       (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>);
 
57
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-is-read-only">e_cal_is_read_only</link>                  (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
58
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> *read_only</parameter>,
 
59
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
60
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-get-cal-address">e_cal_get_cal_address</link>               (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
61
                                                         <parameter><link linkend="gchar"><type>gchar</type></link> **cal_address</parameter>,
 
62
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
63
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-get-alarm-email-address">e_cal_get_alarm_email_address</link>       (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
64
                                                         <parameter><link linkend="gchar"><type>gchar</type></link> **alarm_address</parameter>,
 
65
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
66
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-get-ldap-attribute">e_cal_get_ldap_attribute</link>            (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
67
                                                         <parameter><link linkend="gchar"><type>gchar</type></link> **ldap_attribute</parameter>,
 
68
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
69
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-get-one-alarm-only">e_cal_get_one_alarm_only</link>            (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>);
 
70
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-get-organizer-must-attend">e_cal_get_organizer_must_attend</link>     (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>);
 
71
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-get-save-schedules">e_cal_get_save_schedules</link>            (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>);
 
72
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-get-static-capability">e_cal_get_static_capability</link>         (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
73
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *cap</parameter>);
 
74
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-get-organizer-must-accept">e_cal_get_organizer_must_accept</link>     (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>);
 
75
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-set-mode">e_cal_set_mode</link>                      (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
76
                                                         <parameter><link linkend="CalMode"><type>CalMode</type></link> mode</parameter>);
 
77
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-get-default-object">e_cal_get_default_object</link>            (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
78
                                                         <parameter><link linkend="icalcomponent"><type>icalcomponent</type></link> **icalcomp</parameter>,
 
79
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
80
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-get-object">e_cal_get_object</link>                    (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
81
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>,
 
82
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *rid</parameter>,
 
83
                                                         <parameter><link linkend="icalcomponent"><type>icalcomponent</type></link> **icalcomp</parameter>,
 
84
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
85
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-get-objects-for-uid">e_cal_get_objects_for_uid</link>           (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
86
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>,
 
87
                                                         <parameter><link linkend="GList"><type>GList</type></link> **objects</parameter>,
 
88
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
89
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-get-changes">e_cal_get_changes</link>                   (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
90
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *change_id</parameter>,
 
91
                                                         <parameter><link linkend="GList"><type>GList</type></link> **changes</parameter>,
 
92
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
93
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-cal-free-change-list">e_cal_free_change_list</link>              (<parameter><link linkend="GList"><type>GList</type></link> *list</parameter>);
 
94
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-get-object-list">e_cal_get_object_list</link>               (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
95
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *query</parameter>,
 
96
                                                         <parameter><link linkend="GList"><type>GList</type></link> **objects</parameter>,
 
97
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
98
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-get-object-list-as-comp">e_cal_get_object_list_as_comp</link>       (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
99
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *query</parameter>,
 
100
                                                         <parameter><link linkend="GList"><type>GList</type></link> **objects</parameter>,
 
101
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
102
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-cal-free-object-list">e_cal_free_object_list</link>              (<parameter><link linkend="GList"><type>GList</type></link> *objects</parameter>);
 
103
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-get-free-busy">e_cal_get_free_busy</link>                 (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
104
                                                         <parameter><link linkend="GList"><type>GList</type></link> *users</parameter>,
 
105
                                                         <parameter><link linkend="time-t"><type>time_t</type></link> start</parameter>,
 
106
                                                         <parameter><link linkend="time-t"><type>time_t</type></link> end</parameter>,
 
107
                                                         <parameter><link linkend="GList"><type>GList</type></link> **freebusy</parameter>,
 
108
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
109
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-cal-generate-instances">e_cal_generate_instances</link>            (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
110
                                                         <parameter><link linkend="time-t"><type>time_t</type></link> start</parameter>,
 
111
                                                         <parameter><link linkend="time-t"><type>time_t</type></link> end</parameter>,
 
112
                                                         <parameter><link linkend="ECalRecurInstanceFn"><type>ECalRecurInstanceFn</type></link> cb</parameter>,
 
113
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> cb_data</parameter>);
 
114
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-cal-generate-instances-for-object">e_cal_generate_instances_for_object</link> (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
115
                                                         <parameter><link linkend="icalcomponent"><type>icalcomponent</type></link> *icalcomp</parameter>,
 
116
                                                         <parameter><link linkend="time-t"><type>time_t</type></link> start</parameter>,
 
117
                                                         <parameter><link linkend="time-t"><type>time_t</type></link> end</parameter>,
 
118
                                                         <parameter><link linkend="ECalRecurInstanceFn"><type>ECalRecurInstanceFn</type></link> cb</parameter>,
 
119
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> cb_data</parameter>);
 
120
<link linkend="GSList"><returnvalue>GSList</returnvalue></link> *            <link linkend="e-cal-get-alarms-in-range">e_cal_get_alarms_in_range</link>           (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
121
                                                         <parameter><link linkend="time-t"><type>time_t</type></link> start</parameter>,
 
122
                                                         <parameter><link linkend="time-t"><type>time_t</type></link> end</parameter>);
 
123
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-cal-free-alarms">e_cal_free_alarms</link>                   (<parameter><link linkend="GSList"><type>GSList</type></link> *comp_alarms</parameter>);
 
124
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-get-alarms-for-object">e_cal_get_alarms_for_object</link>         (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
125
                                                         <parameter>const <link linkend="ECalComponentId"><type>ECalComponentId</type></link> *id</parameter>,
 
126
                                                         <parameter><link linkend="time-t"><type>time_t</type></link> start</parameter>,
 
127
                                                         <parameter><link linkend="time-t"><type>time_t</type></link> end</parameter>,
 
128
                                                         <parameter><link linkend="ECalComponentAlarms"><type>ECalComponentAlarms</type></link> **alarms</parameter>);
 
129
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-create-object">e_cal_create_object</link>                 (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
130
                                                         <parameter><link linkend="icalcomponent"><type>icalcomponent</type></link> *icalcomp</parameter>,
 
131
                                                         <parameter><link linkend="gchar"><type>gchar</type></link> **uid</parameter>,
 
132
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
133
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-modify-object">e_cal_modify_object</link>                 (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
134
                                                         <parameter><link linkend="icalcomponent"><type>icalcomponent</type></link> *icalcomp</parameter>,
 
135
                                                         <parameter><link linkend="CalObjModType"><type>CalObjModType</type></link> mod</parameter>,
 
136
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
137
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-remove-object">e_cal_remove_object</link>                 (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
138
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>,
 
139
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
140
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-remove-object-with-mod">e_cal_remove_object_with_mod</link>        (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
141
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>,
 
142
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *rid</parameter>,
 
143
                                                         <parameter><link linkend="CalObjModType"><type>CalObjModType</type></link> mod</parameter>,
 
144
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
145
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-discard-alarm">e_cal_discard_alarm</link>                 (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
146
                                                         <parameter><link linkend="ECalComponent"><type>ECalComponent</type></link> *comp</parameter>,
 
147
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *auid</parameter>,
 
148
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
149
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-receive-objects">e_cal_receive_objects</link>               (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
150
                                                         <parameter><link linkend="icalcomponent"><type>icalcomponent</type></link> *icalcomp</parameter>,
 
151
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
152
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-send-objects">e_cal_send_objects</link>                  (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
153
                                                         <parameter><link linkend="icalcomponent"><type>icalcomponent</type></link> *icalcomp</parameter>,
 
154
                                                         <parameter><link linkend="GList"><type>GList</type></link> **users</parameter>,
 
155
                                                         <parameter><link linkend="icalcomponent"><type>icalcomponent</type></link> **modified_icalcomp</parameter>,
 
156
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
157
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-get-timezone">e_cal_get_timezone</link>                  (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
158
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *tzid</parameter>,
 
159
                                                         <parameter><link linkend="icaltimezone"><type>icaltimezone</type></link> **zone</parameter>,
 
160
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
161
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-add-timezone">e_cal_add_timezone</link>                  (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
162
                                                         <parameter><link linkend="icaltimezone"><type>icaltimezone</type></link> *izone</parameter>,
 
163
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
164
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-set-default-timezone">e_cal_set_default_timezone</link>          (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
165
                                                         <parameter><link linkend="icaltimezone"><type>icaltimezone</type></link> *zone</parameter>,
 
166
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
167
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-get-query">e_cal_get_query</link>                     (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
168
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *sexp</parameter>,
 
169
                                                         <parameter><link linkend="ECalView"><type>ECalView</type></link> **query</parameter>,
 
170
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
171
<link linkend="icaltimezone"><returnvalue>icaltimezone</returnvalue></link> *      <link linkend="e-cal-resolve-tzid-cb">e_cal_resolve_tzid_cb</link>               (<parameter>const <link linkend="gchar"><type>gchar</type></link> *tzid</parameter>,
 
172
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>);
 
173
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             <link linkend="e-cal-get-component-as-string">e_cal_get_component_as_string</link>       (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
174
                                                         <parameter><link linkend="icalcomponent"><type>icalcomponent</type></link> *icalcomp</parameter>);
 
175
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       <link linkend="e-cal-get-error-message">e_cal_get_error_message</link>             (<parameter><link linkend="ECalendarStatus"><type>ECalendarStatus</type></link> status</parameter>);
 
176
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-open-default">e_cal_open_default</link>                  (<parameter><link linkend="ECal"><type>ECal</type></link> **ecal</parameter>,
 
177
                                                         <parameter><link linkend="ECalSourceType"><type>ECalSourceType</type></link> type</parameter>,
 
178
                                                         <parameter><link linkend="ECalAuthFunc"><type>ECalAuthFunc</type></link> func</parameter>,
 
179
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>,
 
180
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
181
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-set-default">e_cal_set_default</link>                   (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
182
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
183
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-set-default-source">e_cal_set_default_source</link>            (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
 
184
                                                         <parameter><link linkend="ECalSourceType"><type>ECalSourceType</type></link> type</parameter>,
 
185
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
186
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-get-sources">e_cal_get_sources</link>                   (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> **sources</parameter>,
 
187
                                                         <parameter><link linkend="ECalSourceType"><type>ECalSourceType</type></link> type</parameter>,
 
188
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
 
189
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       <link linkend="e-cal-get-local-attachment-store">e_cal_get_local_attachment_store</link>    (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>);
 
190
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-get-recurrences-no-master">e_cal_get_recurrences_no_master</link>     (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>);
 
191
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-cal-get-attachments-for-comp">e_cal_get_attachments_for_comp</link>      (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
192
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>,
 
193
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *rid</parameter>,
 
194
                                                         <parameter><link linkend="GSList"><type>GSList</type></link> **list</parameter>,
 
195
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
196
196
</synopsis>
197
197
</refsynopsisdiv>
198
 
 
199
198
<refsect1 id="ECal.object-hierarchy" role="object_hierarchy">
200
199
<title role="object_hierarchy.title">Object Hierarchy</title>
201
200
<synopsis>
203
202
   +----ECal
204
203
</synopsis>
205
204
</refsect1>
206
 
 
207
 
 
208
 
 
209
 
 
210
 
 
211
 
 
212
205
<refsect1 id="ECal.signals" role="signal_proto">
213
206
<title role="signal_proto.title">Signals</title>
214
207
<synopsis>
219
212
</synopsis>
220
213
</refsect1>
221
214
 
222
 
 
223
215
<refsect1 id="ECal.description" role="desc">
224
216
<title role="desc.title">Description</title>
225
217
<para>
226
218
Represents an entire calendar or task list, not individual items within them.2
227
219
</para>
228
220
</refsect1>
229
 
 
230
221
<refsect1 id="ECal.details" role="details">
231
222
<title role="details.title">Details</title>
232
223
<refsect2 id="ECal-struct" role="struct">
233
224
<title>ECal</title>
234
 
<indexterm zone="ECal-struct"><primary sortas="ECal">ECal</primary></indexterm><programlisting>typedef struct _ECal ECal;</programlisting>
 
225
<indexterm zone="ECal-struct"><primary>ECal</primary></indexterm>
 
226
<programlisting>typedef struct _ECal ECal;</programlisting>
235
227
<para>
236
228
</para></refsect2>
237
 
<refsect2 id="E-CAL-SET-MODE-STATUS-ENUM-TYPE--CAPS" role="macro">
 
229
<refsect2 id="E-CAL-SET-MODE-STATUS-ENUM-TYPE:CAPS" role="macro">
238
230
<title>E_CAL_SET_MODE_STATUS_ENUM_TYPE</title>
239
 
<indexterm zone="E-CAL-SET-MODE-STATUS-ENUM-TYPE--CAPS"><primary sortas="E_CAL_SET_MODE_STATUS_ENUM_TYPE">E_CAL_SET_MODE_STATUS_ENUM_TYPE</primary></indexterm><programlisting>#define E_CAL_SET_MODE_STATUS_ENUM_TYPE (e_cal_set_mode_status_enum_get_type ())
 
231
<indexterm zone="E-CAL-SET-MODE-STATUS-ENUM-TYPE:CAPS"><primary>E_CAL_SET_MODE_STATUS_ENUM_TYPE</primary></indexterm>
 
232
<programlisting>#define E_CAL_SET_MODE_STATUS_ENUM_TYPE (e_cal_set_mode_status_enum_get_type ())
240
233
</programlisting>
241
234
<para>
242
235
</para></refsect2>
243
 
<refsect2 id="CAL-MODE-ENUM-TYPE--CAPS" role="macro">
 
236
<refsect2 id="CAL-MODE-ENUM-TYPE:CAPS" role="macro">
244
237
<title>CAL_MODE_ENUM_TYPE</title>
245
 
<indexterm zone="CAL-MODE-ENUM-TYPE--CAPS"><primary sortas="CAL_MODE_ENUM_TYPE">CAL_MODE_ENUM_TYPE</primary></indexterm><programlisting>#define CAL_MODE_ENUM_TYPE                   (cal_mode_enum_get_type ())
 
238
<indexterm zone="CAL-MODE-ENUM-TYPE:CAPS"><primary>CAL_MODE_ENUM_TYPE</primary></indexterm>
 
239
<programlisting>#define CAL_MODE_ENUM_TYPE                   (cal_mode_enum_get_type ())
246
240
</programlisting>
247
241
<para>
248
242
</para></refsect2>
249
243
<refsect2 id="ECalSourceType" role="enum">
250
244
<title>enum ECalSourceType</title>
251
 
<indexterm zone="ECalSourceType"><primary sortas="ECalSourceType">ECalSourceType</primary></indexterm><programlisting>typedef enum {
 
245
<indexterm zone="ECalSourceType"><primary>ECalSourceType</primary></indexterm>
 
246
<programlisting>typedef enum {
252
247
        E_CAL_SOURCE_TYPE_EVENT,
253
248
        E_CAL_SOURCE_TYPE_TODO,
254
249
        E_CAL_SOURCE_TYPE_JOURNAL,
259
254
</para></refsect2>
260
255
<refsect2 id="ECalSetModeStatus" role="enum">
261
256
<title>enum ECalSetModeStatus</title>
262
 
<indexterm zone="ECalSetModeStatus"><primary sortas="ECalSetModeStatus">ECalSetModeStatus</primary></indexterm><programlisting>typedef enum {
 
257
<indexterm zone="ECalSetModeStatus"><primary>ECalSetModeStatus</primary></indexterm>
 
258
<programlisting>typedef enum {
263
259
        E_CAL_SET_MODE_SUCCESS,
264
260
        E_CAL_SET_MODE_ERROR,
265
261
        E_CAL_SET_MODE_NOT_SUPPORTED
269
265
</para></refsect2>
270
266
<refsect2 id="ECalLoadState" role="enum">
271
267
<title>enum ECalLoadState</title>
272
 
<indexterm zone="ECalLoadState"><primary sortas="ECalLoadState">ECalLoadState</primary></indexterm><programlisting>typedef enum {
 
268
<indexterm zone="ECalLoadState"><primary>ECalLoadState</primary></indexterm>
 
269
<programlisting>typedef enum {
273
270
        E_CAL_LOAD_NOT_LOADED,
274
271
        E_CAL_LOAD_AUTHENTICATING,
275
272
        E_CAL_LOAD_LOADING,
280
277
</para></refsect2>
281
278
<refsect2 id="ECalAuthFunc" role="function">
282
279
<title>ECalAuthFunc ()</title>
283
 
<indexterm zone="ECalAuthFunc"><primary sortas="ECalAuthFunc">ECalAuthFunc</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             (*ECalAuthFunc)                     (<link linkend="ECal">ECal</link> *ecal,
284
 
                                                         const <link linkend="gchar">gchar</link> *prompt,
285
 
                                                         const <link linkend="gchar">gchar</link> *key,
286
 
                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
280
<indexterm zone="ECalAuthFunc"><primary>ECalAuthFunc</primary></indexterm>
 
281
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             (*ECalAuthFunc)                     (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
282
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *prompt</parameter>,
 
283
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>,
 
284
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>);</programlisting>
287
285
<para>
288
286
</para><variablelist role="params">
289
287
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
303
301
</variablelist></refsect2>
304
302
<refsect2 id="e-cal-open-status-enum-get-type" role="function">
305
303
<title>e_cal_open_status_enum_get_type ()</title>
306
 
<indexterm zone="e-cal-open-status-enum-get-type"><primary sortas="e_cal_open_status_enum_get_type">e_cal_open_status_enum_get_type</primary></indexterm><programlisting><link linkend="GType">GType</link>               e_cal_open_status_enum_get_type     (void);</programlisting>
 
304
<indexterm zone="e-cal-open-status-enum-get-type"><primary>e_cal_open_status_enum_get_type</primary></indexterm>
 
305
<programlisting><link linkend="GType"><returnvalue>GType</returnvalue></link>               e_cal_open_status_enum_get_type     (<parameter><type>void</type></parameter>);</programlisting>
307
306
<para>
308
307
</para><variablelist role="params">
309
308
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
311
310
</variablelist></refsect2>
312
311
<refsect2 id="e-cal-source-type-enum-get-type" role="function">
313
312
<title>e_cal_source_type_enum_get_type ()</title>
314
 
<indexterm zone="e-cal-source-type-enum-get-type"><primary sortas="e_cal_source_type_enum_get_type">e_cal_source_type_enum_get_type</primary></indexterm><programlisting><link linkend="GType">GType</link>               e_cal_source_type_enum_get_type     (void);</programlisting>
 
313
<indexterm zone="e-cal-source-type-enum-get-type"><primary>e_cal_source_type_enum_get_type</primary></indexterm>
 
314
<programlisting><link linkend="GType"><returnvalue>GType</returnvalue></link>               e_cal_source_type_enum_get_type     (<parameter><type>void</type></parameter>);</programlisting>
315
315
<para>
316
316
Registers the <link linkend="ECalSourceTypeEnum"><type>ECalSourceTypeEnum</type></link> type with glib.</para>
317
 
<para>
318
 
</para><variablelist role="params">
 
317
<variablelist role="params">
319
318
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the ID of the <link linkend="ECalSourceTypeEnum"><type>ECalSourceTypeEnum</type></link> type.
320
319
</simpara></listitem></varlistentry>
321
320
</variablelist></refsect2>
322
321
<refsect2 id="e-cal-set-mode-status-enum-get-type" role="function">
323
322
<title>e_cal_set_mode_status_enum_get_type ()</title>
324
 
<indexterm zone="e-cal-set-mode-status-enum-get-type"><primary sortas="e_cal_set_mode_status_enum_get_type">e_cal_set_mode_status_enum_get_type</primary></indexterm><programlisting><link linkend="GType">GType</link>               e_cal_set_mode_status_enum_get_type (void);</programlisting>
 
323
<indexterm zone="e-cal-set-mode-status-enum-get-type"><primary>e_cal_set_mode_status_enum_get_type</primary></indexterm>
 
324
<programlisting><link linkend="GType"><returnvalue>GType</returnvalue></link>               e_cal_set_mode_status_enum_get_type (<parameter><type>void</type></parameter>);</programlisting>
325
325
<para>
326
326
Registers the <link linkend="ECalSetModeStatusEnum"><type>ECalSetModeStatusEnum</type></link> type with glib.</para>
327
 
<para>
328
 
</para><variablelist role="params">
 
327
<variablelist role="params">
329
328
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the ID of the <link linkend="ECalSetModeStatusEnum"><type>ECalSetModeStatusEnum</type></link> type.
330
329
</simpara></listitem></varlistentry>
331
330
</variablelist></refsect2>
332
331
<refsect2 id="cal-mode-enum-get-type" role="function">
333
332
<title>cal_mode_enum_get_type ()</title>
334
 
<indexterm zone="cal-mode-enum-get-type"><primary sortas="cal_mode_enum_get_type">cal_mode_enum_get_type</primary></indexterm><programlisting><link linkend="GType">GType</link>               cal_mode_enum_get_type              (void);</programlisting>
 
333
<indexterm zone="cal-mode-enum-get-type"><primary>cal_mode_enum_get_type</primary></indexterm>
 
334
<programlisting><link linkend="GType"><returnvalue>GType</returnvalue></link>               cal_mode_enum_get_type              (<parameter><type>void</type></parameter>);</programlisting>
335
335
<para>
336
336
Registers the <link linkend="CalModeEnum"><type>CalModeEnum</type></link> type with glib.</para>
337
 
<para>
338
 
</para><variablelist role="params">
 
337
<variablelist role="params">
339
338
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the ID of the <link linkend="CalModeEnum"><type>CalModeEnum</type></link> type.
340
339
</simpara></listitem></varlistentry>
341
340
</variablelist></refsect2>
342
341
<refsect2 id="e-cal-new" role="function">
343
342
<title>e_cal_new ()</title>
344
 
<indexterm zone="e-cal-new"><primary sortas="e_cal_new">e_cal_new</primary></indexterm><programlisting><link linkend="ECal">ECal</link> *              e_cal_new                           (<link linkend="ESource">ESource</link> *source,
345
 
                                                         <link linkend="ECalSourceType">ECalSourceType</link> type);</programlisting>
 
343
<indexterm zone="e-cal-new"><primary>e_cal_new</primary></indexterm>
 
344
<programlisting><link linkend="ECal"><returnvalue>ECal</returnvalue></link> *              e_cal_new                           (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
 
345
                                                         <parameter><link linkend="ECalSourceType"><type>ECalSourceType</type></link> type</parameter>);</programlisting>
346
346
<para>
347
347
Creates a new calendar client. This does not open the calendar itself,
348
348
for that, <link linkend="e-cal-open"><type>e_cal_open</type></link> or <link linkend="e-cal-open-async"><type>e_cal_open_async</type></link> needs to be called.</para>
349
 
<para>
350
 
</para><variablelist role="params">
 
349
<variablelist role="params">
351
350
<varlistentry><term><parameter>source</parameter>&#160;:</term>
352
 
<listitem><simpara> An <link linkend="ESource"><type>ESource</type></link> to be used for the client.
 
351
<listitem><simpara>An <link linkend="ESource"><type>ESource</type></link> to be used for the client.
353
352
</simpara></listitem></varlistentry>
354
353
<varlistentry><term><parameter>type</parameter>&#160;:</term>
355
 
<listitem><simpara> Type of the client.
 
354
<listitem><simpara>Type of the client.
356
355
</simpara></listitem></varlistentry>
357
356
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A newly-created calendar client, or NULL if the client could
358
357
not be constructed because it could not contact the calendar server.
360
359
</variablelist></refsect2>
361
360
<refsect2 id="e-cal-new-from-uri" role="function">
362
361
<title>e_cal_new_from_uri ()</title>
363
 
<indexterm zone="e-cal-new-from-uri"><primary sortas="e_cal_new_from_uri">e_cal_new_from_uri</primary></indexterm><programlisting><link linkend="ECal">ECal</link> *              e_cal_new_from_uri                  (const <link linkend="gchar">gchar</link> *uri,
364
 
                                                         <link linkend="ECalSourceType">ECalSourceType</link> type);</programlisting>
 
362
<indexterm zone="e-cal-new-from-uri"><primary>e_cal_new_from_uri</primary></indexterm>
 
363
<programlisting><link linkend="ECal"><returnvalue>ECal</returnvalue></link> *              e_cal_new_from_uri                  (<parameter>const <link linkend="gchar"><type>gchar</type></link> *uri</parameter>,
 
364
                                                         <parameter><link linkend="ECalSourceType"><type>ECalSourceType</type></link> type</parameter>);</programlisting>
365
365
<para>
366
366
Creates a new calendar client. This does not open the calendar itself,
367
367
for that, <link linkend="e-cal-open"><type>e_cal_open</type></link> or <link linkend="e-cal-open-async"><type>e_cal_open_async</type></link> needs to be called.</para>
368
 
<para>
369
 
</para><variablelist role="params">
 
368
<variablelist role="params">
370
369
<varlistentry><term><parameter>uri</parameter>&#160;:</term>
371
 
<listitem><simpara> The URI pointing to the calendar to open.
 
370
<listitem><simpara>The URI pointing to the calendar to open.
372
371
</simpara></listitem></varlistentry>
373
372
<varlistentry><term><parameter>type</parameter>&#160;:</term>
374
 
<listitem><simpara> Type of the client.
 
373
<listitem><simpara>Type of the client.
375
374
</simpara></listitem></varlistentry>
376
375
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A newly-created calendar client, or NULL if the client could
377
376
not be constructed because it could not contact the calendar server.
379
378
</variablelist></refsect2>
380
379
<refsect2 id="e-cal-new-system-calendar" role="function">
381
380
<title>e_cal_new_system_calendar ()</title>
382
 
<indexterm zone="e-cal-new-system-calendar"><primary sortas="e_cal_new_system_calendar">e_cal_new_system_calendar</primary></indexterm><programlisting><link linkend="ECal">ECal</link> *              e_cal_new_system_calendar           (void);</programlisting>
 
381
<indexterm zone="e-cal-new-system-calendar"><primary>e_cal_new_system_calendar</primary></indexterm>
 
382
<programlisting><link linkend="ECal"><returnvalue>ECal</returnvalue></link> *              e_cal_new_system_calendar           (<parameter><type>void</type></parameter>);</programlisting>
383
383
<para>
384
384
Create a calendar client for the system calendar, which should always be present in
385
385
all Evolution installations. This does not open the calendar itself,
386
386
for that, <link linkend="e-cal-open"><type>e_cal_open</type></link> or <link linkend="e-cal-open-async"><type>e_cal_open_async</type></link> needs to be called.</para>
387
 
<para>
388
 
</para><variablelist role="params">
 
387
<variablelist role="params">
389
388
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A newly-created calendar client, or NULL if the client could
390
389
not be constructed.
391
390
</simpara></listitem></varlistentry>
392
391
</variablelist></refsect2>
393
392
<refsect2 id="e-cal-new-system-tasks" role="function">
394
393
<title>e_cal_new_system_tasks ()</title>
395
 
<indexterm zone="e-cal-new-system-tasks"><primary sortas="e_cal_new_system_tasks">e_cal_new_system_tasks</primary></indexterm><programlisting><link linkend="ECal">ECal</link> *              e_cal_new_system_tasks              (void);</programlisting>
 
394
<indexterm zone="e-cal-new-system-tasks"><primary>e_cal_new_system_tasks</primary></indexterm>
 
395
<programlisting><link linkend="ECal"><returnvalue>ECal</returnvalue></link> *              e_cal_new_system_tasks              (<parameter><type>void</type></parameter>);</programlisting>
396
396
<para>
397
397
Create a calendar client for the system task list, which should always be present in
398
398
all Evolution installations. This does not open the tasks list itself,
399
399
for that, <link linkend="e-cal-open"><type>e_cal_open</type></link> or <link linkend="e-cal-open-async"><type>e_cal_open_async</type></link> needs to be called.</para>
400
 
<para>
401
 
</para><variablelist role="params">
 
400
<variablelist role="params">
402
401
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A newly-created calendar client, or NULL if the client could
403
402
not be constructed.
404
403
</simpara></listitem></varlistentry>
405
404
</variablelist></refsect2>
406
405
<refsect2 id="e-cal-new-system-memos" role="function">
407
406
<title>e_cal_new_system_memos ()</title>
408
 
<indexterm zone="e-cal-new-system-memos"><primary sortas="e_cal_new_system_memos">e_cal_new_system_memos</primary></indexterm><programlisting><link linkend="ECal">ECal</link> *              e_cal_new_system_memos              (void);</programlisting>
 
407
<indexterm zone="e-cal-new-system-memos"><primary>e_cal_new_system_memos</primary></indexterm>
 
408
<programlisting><link linkend="ECal"><returnvalue>ECal</returnvalue></link> *              e_cal_new_system_memos              (<parameter><type>void</type></parameter>);</programlisting>
409
409
<para>
410
410
Create a calendar client for the system memos, which should always be present
411
411
in all Evolution installations. This does not open the memos itself, for
412
412
that, <link linkend="e-cal-open"><type>e_cal_open</type></link> or <link linkend="e-cal-open-async"><type>e_cal_open_async</type></link> needs to be called.</para>
413
 
<para>
414
 
</para><variablelist role="params">
 
413
<variablelist role="params">
415
414
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A newly-created calendar client, or NULL if the client could
416
415
not be constructed.
417
416
</simpara></listitem></varlistentry>
418
417
</variablelist></refsect2>
419
418
<refsect2 id="e-cal-set-auth-func" role="function">
420
419
<title>e_cal_set_auth_func ()</title>
421
 
<indexterm zone="e-cal-set-auth-func"><primary sortas="e_cal_set_auth_func">e_cal_set_auth_func</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_set_auth_func                 (<link linkend="ECal">ECal</link> *ecal,
422
 
                                                         <link linkend="ECalAuthFunc">ECalAuthFunc</link> func,
423
 
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
 
420
<indexterm zone="e-cal-set-auth-func"><primary>e_cal_set_auth_func</primary></indexterm>
 
421
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_cal_set_auth_func                 (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
422
                                                         <parameter><link linkend="ECalAuthFunc"><type>ECalAuthFunc</type></link> func</parameter>,
 
423
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>);</programlisting>
424
424
<para>
425
425
Sets the given authentication function on the calendar client. This
426
426
function will be called any time the calendar server needs a
443
443
                  const gchar *prompt,
444
444
                  const gchar *key,
445
445
                  gpointer user_data)</para>
446
 
<para>
447
 
</para><variablelist role="params">
 
446
<variablelist role="params">
448
447
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
449
 
<listitem><simpara> A calendar client.
 
448
<listitem><simpara>A calendar client.
450
449
</simpara></listitem></varlistentry>
451
450
<varlistentry><term><parameter>func</parameter>&#160;:</term>
452
 
<listitem><simpara> The authentication function
 
451
<listitem><simpara>The authentication function
453
452
</simpara></listitem></varlistentry>
454
453
<varlistentry><term><parameter>data</parameter>&#160;:</term>
455
 
<listitem><simpara> User data to be used when calling the authentication function
 
454
<listitem><simpara>User data to be used when calling the authentication function
456
455
</simpara></listitem></varlistentry>
457
456
</variablelist></refsect2>
458
457
<refsect2 id="e-cal-open" role="function">
459
458
<title>e_cal_open ()</title>
460
 
<indexterm zone="e-cal-open"><primary sortas="e_cal_open">e_cal_open</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_open                          (<link linkend="ECal">ECal</link> *ecal,
461
 
                                                         <link linkend="gboolean">gboolean</link> only_if_exists,
462
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
459
<indexterm zone="e-cal-open"><primary>e_cal_open</primary></indexterm>
 
460
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_open                          (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
461
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> only_if_exists</parameter>,
 
462
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
463
463
<para>
464
464
Makes a calendar client initiate a request to open a calendar.  The calendar
465
465
client will emit the "cal_opened" signal when the response from the server is
466
466
received.</para>
467
 
<para>
468
 
</para><variablelist role="params">
 
467
<variablelist role="params">
469
468
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
470
 
<listitem><simpara> A calendar client.
 
469
<listitem><simpara>A calendar client.
471
470
</simpara></listitem></varlistentry>
472
471
<varlistentry><term><parameter>only_if_exists</parameter>&#160;:</term>
473
 
<listitem><simpara> FALSE if the calendar should be opened even if there
 
472
<listitem><simpara>FALSE if the calendar should be opened even if there
474
473
was no storage for it, i.e. to create a new calendar or load an existing
475
474
one if it already exists.  TRUE if it should only try to load calendars
476
475
that already exist.
477
476
</simpara></listitem></varlistentry>
478
477
<varlistentry><term><parameter>error</parameter>&#160;:</term>
479
 
<listitem><simpara> Placeholder for error information.
 
478
<listitem><simpara>Placeholder for error information.
480
479
</simpara></listitem></varlistentry>
481
480
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success, FALSE on failure to issue the open request.
482
481
</simpara></listitem></varlistentry>
483
482
</variablelist></refsect2>
484
483
<refsect2 id="e-cal-open-async" role="function">
485
484
<title>e_cal_open_async ()</title>
486
 
<indexterm zone="e-cal-open-async"><primary sortas="e_cal_open_async">e_cal_open_async</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_open_async                    (<link linkend="ECal">ECal</link> *ecal,
487
 
                                                         <link linkend="gboolean">gboolean</link> only_if_exists);</programlisting>
 
485
<indexterm zone="e-cal-open-async"><primary>e_cal_open_async</primary></indexterm>
 
486
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_cal_open_async                    (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
487
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> only_if_exists</parameter>);</programlisting>
488
488
<para>
489
489
Open the calendar asynchronously.  The calendar will emit the
490
490
"cal_opened" signal when the operation has completed.
493
493
Because this operation runs in another thread, any authentication
494
494
callback set on the calendar will be called from this other thread.
495
495
See #<link linkend="e-cal-set-auth-func"><function>e_cal_set_auth_func()</function></link> for details.</para>
496
 
<para>
497
 
</para><variablelist role="params">
 
496
<variablelist role="params">
498
497
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
499
 
<listitem><simpara> A calendar client.
 
498
<listitem><simpara>A calendar client.
500
499
</simpara></listitem></varlistentry>
501
500
<varlistentry><term><parameter>only_if_exists</parameter>&#160;:</term>
502
 
<listitem><simpara> If TRUE, then only open the calendar if it already
 
501
<listitem><simpara>If TRUE, then only open the calendar if it already
503
502
exists.  If FALSE, then create a new calendar if it doesn't already
504
503
exist.
505
504
</simpara></listitem></varlistentry>
506
505
</variablelist></refsect2>
507
506
<refsect2 id="e-cal-remove" role="function">
508
507
<title>e_cal_remove ()</title>
509
 
<indexterm zone="e-cal-remove"><primary sortas="e_cal_remove">e_cal_remove</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_remove                        (<link linkend="ECal">ECal</link> *ecal,
510
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
508
<indexterm zone="e-cal-remove"><primary>e_cal_remove</primary></indexterm>
 
509
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_remove                        (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
510
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
511
511
<para>
512
512
Removes a calendar.</para>
513
 
<para>
514
 
</para><variablelist role="params">
 
513
<variablelist role="params">
515
514
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
516
 
<listitem><simpara> A calendar client.
 
515
<listitem><simpara>A calendar client.
517
516
</simpara></listitem></varlistentry>
518
517
<varlistentry><term><parameter>error</parameter>&#160;:</term>
519
 
<listitem><simpara> Placeholder for error information.
 
518
<listitem><simpara>Placeholder for error information.
520
519
</simpara></listitem></varlistentry>
521
520
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the calendar was removed, FALSE if there was an error.
522
521
</simpara></listitem></varlistentry>
523
522
</variablelist></refsect2>
524
523
<refsect2 id="e-cal-uri-list" role="function">
525
524
<title>e_cal_uri_list ()</title>
526
 
<indexterm zone="e-cal-uri-list"><primary sortas="e_cal_uri_list">e_cal_uri_list</primary></indexterm><programlisting><link linkend="GList">GList</link> *             e_cal_uri_list                      (<link linkend="ECal">ECal</link> *ecal,
527
 
                                                         <link linkend="CalMode">CalMode</link> mode);</programlisting>
 
525
<indexterm zone="e-cal-uri-list"><primary>e_cal_uri_list</primary></indexterm>
 
526
<programlisting><link linkend="GList"><returnvalue>GList</returnvalue></link> *             e_cal_uri_list                      (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
527
                                                         <parameter><link linkend="CalMode"><type>CalMode</type></link> mode</parameter>);</programlisting>
528
528
<para>
529
529
Retrieves a list of all calendar clients for the given mode.</para>
530
 
<para>
531
 
</para><variablelist role="params">
 
530
<variablelist role="params">
532
531
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
533
 
<listitem><simpara> A calendar client.
 
532
<listitem><simpara>A calendar client.
534
533
</simpara></listitem></varlistentry>
535
534
<varlistentry><term><parameter>mode</parameter>&#160;:</term>
536
 
<listitem><simpara> Mode of the URIs to get.
 
535
<listitem><simpara>Mode of the URIs to get.
537
536
</simpara></listitem></varlistentry>
538
537
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> list of uris.
539
538
</simpara></listitem></varlistentry>
540
539
</variablelist></refsect2>
541
540
<refsect2 id="e-cal-get-source-type" role="function">
542
541
<title>e_cal_get_source_type ()</title>
543
 
<indexterm zone="e-cal-get-source-type"><primary sortas="e_cal_get_source_type">e_cal_get_source_type</primary></indexterm><programlisting><link linkend="ECalSourceType">ECalSourceType</link>      e_cal_get_source_type               (<link linkend="ECal">ECal</link> *ecal);</programlisting>
 
542
<indexterm zone="e-cal-get-source-type"><primary>e_cal_get_source_type</primary></indexterm>
 
543
<programlisting><link linkend="ECalSourceType"><returnvalue>ECalSourceType</returnvalue></link>      e_cal_get_source_type               (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>);</programlisting>
544
544
<para>
545
545
Gets the type of the calendar client.</para>
546
 
<para>
547
 
</para><variablelist role="params">
 
546
<variablelist role="params">
548
547
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
549
 
<listitem><simpara> A calendar client.
 
548
<listitem><simpara>A calendar client.
550
549
</simpara></listitem></varlistentry>
551
550
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> an <link linkend="ECalSourceType"><type>ECalSourceType</type></link> value corresponding to the type
552
551
of the calendar client.
554
553
</variablelist></refsect2>
555
554
<refsect2 id="e-cal-get-load-state" role="function">
556
555
<title>e_cal_get_load_state ()</title>
557
 
<indexterm zone="e-cal-get-load-state"><primary sortas="e_cal_get_load_state">e_cal_get_load_state</primary></indexterm><programlisting><link linkend="ECalLoadState">ECalLoadState</link>       e_cal_get_load_state                (<link linkend="ECal">ECal</link> *ecal);</programlisting>
 
556
<indexterm zone="e-cal-get-load-state"><primary>e_cal_get_load_state</primary></indexterm>
 
557
<programlisting><link linkend="ECalLoadState"><returnvalue>ECalLoadState</returnvalue></link>       e_cal_get_load_state                (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>);</programlisting>
558
558
<para>
559
559
Queries the state of loading of a calendar client.</para>
560
 
<para>
561
 
</para><variablelist role="params">
 
560
<variablelist role="params">
562
561
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
563
 
<listitem><simpara> A calendar client.
 
562
<listitem><simpara>A calendar client.
564
563
</simpara></listitem></varlistentry>
565
564
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A <link linkend="ECalLoadState"><type>ECalLoadState</type></link> value indicating whether the client has
566
565
not been loaded with <link linkend="e-cal-open"><type>e_cal_open</type></link> yet, whether it is being
569
568
</variablelist></refsect2>
570
569
<refsect2 id="e-cal-get-source" role="function">
571
570
<title>e_cal_get_source ()</title>
572
 
<indexterm zone="e-cal-get-source"><primary sortas="e_cal_get_source">e_cal_get_source</primary></indexterm><programlisting><link linkend="ESource">ESource</link> *           e_cal_get_source                    (<link linkend="ECal">ECal</link> *ecal);</programlisting>
 
571
<indexterm zone="e-cal-get-source"><primary>e_cal_get_source</primary></indexterm>
 
572
<programlisting><link linkend="ESource"><returnvalue>ESource</returnvalue></link> *           e_cal_get_source                    (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>);</programlisting>
573
573
<para>
574
574
Queries the source that is open in a calendar client.</para>
575
 
<para>
576
 
</para><variablelist role="params">
 
575
<variablelist role="params">
577
576
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
578
 
<listitem><simpara> A calendar client.
 
577
<listitem><simpara>A calendar client.
579
578
</simpara></listitem></varlistentry>
580
579
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The source of the calendar that is already loaded or is being
581
580
loaded, or NULL if the ecal has not started a load request yet.
583
582
</variablelist></refsect2>
584
583
<refsect2 id="e-cal-get-uri" role="function">
585
584
<title>e_cal_get_uri ()</title>
586
 
<indexterm zone="e-cal-get-uri"><primary sortas="e_cal_get_uri">e_cal_get_uri</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       e_cal_get_uri                       (<link linkend="ECal">ECal</link> *ecal);</programlisting>
 
585
<indexterm zone="e-cal-get-uri"><primary>e_cal_get_uri</primary></indexterm>
 
586
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       e_cal_get_uri                       (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>);</programlisting>
587
587
<para>
588
588
Queries the URI that is open in a calendar client.</para>
589
 
<para>
590
 
</para><variablelist role="params">
 
589
<variablelist role="params">
591
590
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
592
 
<listitem><simpara> A calendar client.
 
591
<listitem><simpara>A calendar client.
593
592
</simpara></listitem></varlistentry>
594
593
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The URI of the calendar that is already loaded or is being
595
594
loaded, or NULL if the client has not started a load request yet.
597
596
</variablelist></refsect2>
598
597
<refsect2 id="e-cal-is-read-only" role="function">
599
598
<title>e_cal_is_read_only ()</title>
600
 
<indexterm zone="e-cal-is-read-only"><primary sortas="e_cal_is_read_only">e_cal_is_read_only</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_is_read_only                  (<link linkend="ECal">ECal</link> *ecal,
601
 
                                                         <link linkend="gboolean">gboolean</link> *read_only,
602
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
599
<indexterm zone="e-cal-is-read-only"><primary>e_cal_is_read_only</primary></indexterm>
 
600
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_is_read_only                  (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
601
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> *read_only</parameter>,
 
602
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
603
603
<para>
604
604
Queries whether the calendar client can perform modifications
605
605
on the calendar or not. Whether the backend is read only or not
606
606
is specified, on exit, in the <parameter>read_only</parameter> argument.</para>
607
 
<para>
608
 
</para><variablelist role="params">
 
607
<variablelist role="params">
609
608
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
610
 
<listitem><simpara> A calendar client.
 
609
<listitem><simpara>A calendar client.
611
610
</simpara></listitem></varlistentry>
612
611
<varlistentry><term><parameter>read_only</parameter>&#160;:</term>
613
 
<listitem><simpara> Return value for read only status.
 
612
<listitem><simpara>Return value for read only status.
614
613
</simpara></listitem></varlistentry>
615
614
<varlistentry><term><parameter>error</parameter>&#160;:</term>
616
 
<listitem><simpara> Placeholder for error information.
 
615
<listitem><simpara>Placeholder for error information.
617
616
</simpara></listitem></varlistentry>
618
617
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the call was successful, FALSE if there was an error.
619
618
</simpara></listitem></varlistentry>
620
619
</variablelist></refsect2>
621
620
<refsect2 id="e-cal-get-cal-address" role="function">
622
621
<title>e_cal_get_cal_address ()</title>
623
 
<indexterm zone="e-cal-get-cal-address"><primary sortas="e_cal_get_cal_address">e_cal_get_cal_address</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_get_cal_address               (<link linkend="ECal">ECal</link> *ecal,
624
 
                                                         <link linkend="gchar">gchar</link> **cal_address,
625
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
622
<indexterm zone="e-cal-get-cal-address"><primary>e_cal_get_cal_address</primary></indexterm>
 
623
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_get_cal_address               (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
624
                                                         <parameter><link linkend="gchar"><type>gchar</type></link> **cal_address</parameter>,
 
625
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
626
626
<para>
627
627
Queries the calendar address associated with a calendar client.</para>
628
 
<para>
629
 
</para><variablelist role="params">
 
628
<variablelist role="params">
630
629
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
631
 
<listitem><simpara> A calendar client.
 
630
<listitem><simpara>A calendar client.
632
631
</simpara></listitem></varlistentry>
633
632
<varlistentry><term><parameter>cal_address</parameter>&#160;:</term>
634
 
<listitem><simpara> Return value for address information.
 
633
<listitem><simpara>Return value for address information.
635
634
</simpara></listitem></varlistentry>
636
635
<varlistentry><term><parameter>error</parameter>&#160;:</term>
637
 
<listitem><simpara> Placeholder for error information.
 
636
<listitem><simpara>Placeholder for error information.
638
637
</simpara></listitem></varlistentry>
639
638
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the operation was successful, FALSE if there
640
639
was an error.
642
641
</variablelist></refsect2>
643
642
<refsect2 id="e-cal-get-alarm-email-address" role="function">
644
643
<title>e_cal_get_alarm_email_address ()</title>
645
 
<indexterm zone="e-cal-get-alarm-email-address"><primary sortas="e_cal_get_alarm_email_address">e_cal_get_alarm_email_address</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_get_alarm_email_address       (<link linkend="ECal">ECal</link> *ecal,
646
 
                                                         <link linkend="gchar">gchar</link> **alarm_address,
647
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
644
<indexterm zone="e-cal-get-alarm-email-address"><primary>e_cal_get_alarm_email_address</primary></indexterm>
 
645
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_get_alarm_email_address       (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
646
                                                         <parameter><link linkend="gchar"><type>gchar</type></link> **alarm_address</parameter>,
 
647
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
648
648
<para>
649
649
Queries the address to be used for alarms in a calendar client.</para>
650
 
<para>
651
 
</para><variablelist role="params">
 
650
<variablelist role="params">
652
651
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
653
 
<listitem><simpara> A calendar client.
 
652
<listitem><simpara>A calendar client.
654
653
</simpara></listitem></varlistentry>
655
654
<varlistentry><term><parameter>alarm_address</parameter>&#160;:</term>
656
 
<listitem><simpara> Return value for alarm address.
 
655
<listitem><simpara>Return value for alarm address.
657
656
</simpara></listitem></varlistentry>
658
657
<varlistentry><term><parameter>error</parameter>&#160;:</term>
659
 
<listitem><simpara> Placeholder for error information.
 
658
<listitem><simpara>Placeholder for error information.
660
659
</simpara></listitem></varlistentry>
661
660
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the operation was successful, FALSE if there was
662
661
an error while contacting the backend.
664
663
</variablelist></refsect2>
665
664
<refsect2 id="e-cal-get-ldap-attribute" role="function">
666
665
<title>e_cal_get_ldap_attribute ()</title>
667
 
<indexterm zone="e-cal-get-ldap-attribute"><primary sortas="e_cal_get_ldap_attribute">e_cal_get_ldap_attribute</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_get_ldap_attribute            (<link linkend="ECal">ECal</link> *ecal,
668
 
                                                         <link linkend="gchar">gchar</link> **ldap_attribute,
669
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
666
<indexterm zone="e-cal-get-ldap-attribute"><primary>e_cal_get_ldap_attribute</primary></indexterm>
 
667
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_get_ldap_attribute            (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
668
                                                         <parameter><link linkend="gchar"><type>gchar</type></link> **ldap_attribute</parameter>,
 
669
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
670
670
<para>
671
671
Queries the LDAP attribute for a calendar client.</para>
672
 
<para>
673
 
</para><variablelist role="params">
 
672
<variablelist role="params">
674
673
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
675
 
<listitem><simpara> A calendar client.
 
674
<listitem><simpara>A calendar client.
676
675
</simpara></listitem></varlistentry>
677
676
<varlistentry><term><parameter>ldap_attribute</parameter>&#160;:</term>
678
 
<listitem><simpara> Return value for the LDAP attribute.
 
677
<listitem><simpara>Return value for the LDAP attribute.
679
678
</simpara></listitem></varlistentry>
680
679
<varlistentry><term><parameter>error</parameter>&#160;:</term>
681
 
<listitem><simpara> Placeholder for error information.
 
680
<listitem><simpara>Placeholder for error information.
682
681
</simpara></listitem></varlistentry>
683
682
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the call was successful, FALSE if there was an
684
683
error contacting the backend.
686
685
</variablelist></refsect2>
687
686
<refsect2 id="e-cal-get-one-alarm-only" role="function">
688
687
<title>e_cal_get_one_alarm_only ()</title>
689
 
<indexterm zone="e-cal-get-one-alarm-only"><primary sortas="e_cal_get_one_alarm_only">e_cal_get_one_alarm_only</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_get_one_alarm_only            (<link linkend="ECal">ECal</link> *ecal);</programlisting>
 
688
<indexterm zone="e-cal-get-one-alarm-only"><primary>e_cal_get_one_alarm_only</primary></indexterm>
 
689
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_get_one_alarm_only            (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>);</programlisting>
690
690
<para>
691
691
Checks if a calendar supports only one alarm per component.</para>
692
 
<para>
693
 
</para><variablelist role="params">
 
692
<variablelist role="params">
694
693
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
695
 
<listitem><simpara> A calendar client.
 
694
<listitem><simpara>A calendar client.
696
695
</simpara></listitem></varlistentry>
697
696
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the calendar allows only one alarm, FALSE otherwise.
698
697
</simpara></listitem></varlistentry>
699
698
</variablelist></refsect2>
700
699
<refsect2 id="e-cal-get-organizer-must-attend" role="function">
701
700
<title>e_cal_get_organizer_must_attend ()</title>
702
 
<indexterm zone="e-cal-get-organizer-must-attend"><primary sortas="e_cal_get_organizer_must_attend">e_cal_get_organizer_must_attend</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_get_organizer_must_attend     (<link linkend="ECal">ECal</link> *ecal);</programlisting>
 
701
<indexterm zone="e-cal-get-organizer-must-attend"><primary>e_cal_get_organizer_must_attend</primary></indexterm>
 
702
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_get_organizer_must_attend     (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>);</programlisting>
703
703
<para>
704
704
Checks if a calendar forces organizers of meetings to be also attendees.</para>
705
 
<para>
706
 
</para><variablelist role="params">
 
705
<variablelist role="params">
707
706
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
708
 
<listitem><simpara> A calendar client.
 
707
<listitem><simpara>A calendar client.
709
708
</simpara></listitem></varlistentry>
710
709
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the calendar forces organizers to attend meetings,
711
710
FALSE otherwise.
713
712
</variablelist></refsect2>
714
713
<refsect2 id="e-cal-get-save-schedules" role="function">
715
714
<title>e_cal_get_save_schedules ()</title>
716
 
<indexterm zone="e-cal-get-save-schedules"><primary sortas="e_cal_get_save_schedules">e_cal_get_save_schedules</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_get_save_schedules            (<link linkend="ECal">ECal</link> *ecal);</programlisting>
 
715
<indexterm zone="e-cal-get-save-schedules"><primary>e_cal_get_save_schedules</primary></indexterm>
 
716
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_get_save_schedules            (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>);</programlisting>
717
717
<para>
718
718
Checks whether the calendar saves schedules.</para>
719
 
<para>
720
 
</para><variablelist role="params">
 
719
<variablelist role="params">
721
720
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
722
 
<listitem><simpara> A calendar client.
 
721
<listitem><simpara>A calendar client.
723
722
</simpara></listitem></varlistentry>
724
723
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if it saves schedules, FALSE otherwise.
725
724
</simpara></listitem></varlistentry>
726
725
</variablelist></refsect2>
727
726
<refsect2 id="e-cal-get-static-capability" role="function">
728
727
<title>e_cal_get_static_capability ()</title>
729
 
<indexterm zone="e-cal-get-static-capability"><primary sortas="e_cal_get_static_capability">e_cal_get_static_capability</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_get_static_capability         (<link linkend="ECal">ECal</link> *ecal,
730
 
                                                         const <link linkend="gchar">gchar</link> *cap);</programlisting>
 
728
<indexterm zone="e-cal-get-static-capability"><primary>e_cal_get_static_capability</primary></indexterm>
 
729
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_get_static_capability         (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
730
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *cap</parameter>);</programlisting>
731
731
<para>
732
732
Queries the calendar for static capabilities.</para>
733
 
<para>
734
 
</para><variablelist role="params">
 
733
<variablelist role="params">
735
734
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
736
 
<listitem><simpara> A calendar client.
 
735
<listitem><simpara>A calendar client.
737
736
</simpara></listitem></varlistentry>
738
737
<varlistentry><term><parameter>cap</parameter>&#160;:</term>
739
 
<listitem><simpara> Name of the static capability to check.
 
738
<listitem><simpara>Name of the static capability to check.
740
739
</simpara></listitem></varlistentry>
741
740
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the capability is supported, FALSE otherwise.
742
741
</simpara></listitem></varlistentry>
743
742
</variablelist></refsect2>
744
743
<refsect2 id="e-cal-get-organizer-must-accept" role="function">
745
744
<title>e_cal_get_organizer_must_accept ()</title>
746
 
<indexterm zone="e-cal-get-organizer-must-accept"><primary sortas="e_cal_get_organizer_must_accept">e_cal_get_organizer_must_accept</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_get_organizer_must_accept     (<link linkend="ECal">ECal</link> *ecal);</programlisting>
 
745
<indexterm zone="e-cal-get-organizer-must-accept"><primary>e_cal_get_organizer_must_accept</primary></indexterm>
 
746
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_get_organizer_must_accept     (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>);</programlisting>
747
747
<para>
748
748
Checks whether a calendar requires organizer to accept their attendance to
749
749
meetings.</para>
750
 
<para>
751
 
</para><variablelist role="params">
 
750
<variablelist role="params">
752
751
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
753
 
<listitem><simpara> A calendar client.
 
752
<listitem><simpara>A calendar client.
754
753
</simpara></listitem></varlistentry>
755
754
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the calendar requires organizers to accept, FALSE
756
755
otherwise.
758
757
</variablelist></refsect2>
759
758
<refsect2 id="e-cal-set-mode" role="function">
760
759
<title>e_cal_set_mode ()</title>
761
 
<indexterm zone="e-cal-set-mode"><primary sortas="e_cal_set_mode">e_cal_set_mode</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_set_mode                      (<link linkend="ECal">ECal</link> *ecal,
762
 
                                                         <link linkend="CalMode">CalMode</link> mode);</programlisting>
 
760
<indexterm zone="e-cal-set-mode"><primary>e_cal_set_mode</primary></indexterm>
 
761
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_set_mode                      (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
762
                                                         <parameter><link linkend="CalMode"><type>CalMode</type></link> mode</parameter>);</programlisting>
763
763
<para>
764
764
Switches online/offline mode on the calendar.</para>
765
 
<para>
766
 
</para><variablelist role="params">
 
765
<variablelist role="params">
767
766
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
768
 
<listitem><simpara> A calendar client.
 
767
<listitem><simpara>A calendar client.
769
768
</simpara></listitem></varlistentry>
770
769
<varlistentry><term><parameter>mode</parameter>&#160;:</term>
771
 
<listitem><simpara> Mode to switch to.
 
770
<listitem><simpara>Mode to switch to.
772
771
</simpara></listitem></varlistentry>
773
772
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the switch was successful, FALSE if there was an error.
774
773
</simpara></listitem></varlistentry>
775
774
</variablelist></refsect2>
776
775
<refsect2 id="e-cal-get-default-object" role="function">
777
776
<title>e_cal_get_default_object ()</title>
778
 
<indexterm zone="e-cal-get-default-object"><primary sortas="e_cal_get_default_object">e_cal_get_default_object</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_get_default_object            (<link linkend="ECal">ECal</link> *ecal,
779
 
                                                         <link linkend="icalcomponent">icalcomponent</link> **icalcomp,
780
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
777
<indexterm zone="e-cal-get-default-object"><primary>e_cal_get_default_object</primary></indexterm>
 
778
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_get_default_object            (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
779
                                                         <parameter><link linkend="icalcomponent"><type>icalcomponent</type></link> **icalcomp</parameter>,
 
780
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
781
781
<para>
782
782
Retrives an <link linkend="icalcomponent"><type>icalcomponent</type></link> from the backend that contains the default
783
783
values for properties needed.</para>
784
 
<para>
785
 
</para><variablelist role="params">
 
784
<variablelist role="params">
786
785
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
787
 
<listitem><simpara> A calendar client.
 
786
<listitem><simpara>A calendar client.
788
787
</simpara></listitem></varlistentry>
789
788
<varlistentry><term><parameter>icalcomp</parameter>&#160;:</term>
790
 
<listitem><simpara> Return value for the default object.
 
789
<listitem><simpara>Return value for the default object.
791
790
</simpara></listitem></varlistentry>
792
791
<varlistentry><term><parameter>error</parameter>&#160;:</term>
793
 
<listitem><simpara> Placeholder for error information.
 
792
<listitem><simpara>Placeholder for error information.
794
793
</simpara></listitem></varlistentry>
795
794
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the call was successful, FALSE otherwise.
796
795
</simpara></listitem></varlistentry>
797
796
</variablelist></refsect2>
798
797
<refsect2 id="e-cal-get-object" role="function">
799
798
<title>e_cal_get_object ()</title>
800
 
<indexterm zone="e-cal-get-object"><primary sortas="e_cal_get_object">e_cal_get_object</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_get_object                    (<link linkend="ECal">ECal</link> *ecal,
801
 
                                                         const <link linkend="gchar">gchar</link> *uid,
802
 
                                                         const <link linkend="gchar">gchar</link> *rid,
803
 
                                                         <link linkend="icalcomponent">icalcomponent</link> **icalcomp,
804
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
799
<indexterm zone="e-cal-get-object"><primary>e_cal_get_object</primary></indexterm>
 
800
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_get_object                    (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
801
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>,
 
802
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *rid</parameter>,
 
803
                                                         <parameter><link linkend="icalcomponent"><type>icalcomponent</type></link> **icalcomp</parameter>,
 
804
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
805
805
<para>
806
806
Queries a calendar for a calendar component object based on its unique
807
807
identifier.</para>
808
 
<para>
809
 
</para><variablelist role="params">
 
808
<variablelist role="params">
810
809
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
811
 
<listitem><simpara> A calendar client.
 
810
<listitem><simpara>A calendar client.
812
811
</simpara></listitem></varlistentry>
813
812
<varlistentry><term><parameter>uid</parameter>&#160;:</term>
814
 
<listitem><simpara> Unique identifier for a calendar component.
 
813
<listitem><simpara>Unique identifier for a calendar component.
815
814
</simpara></listitem></varlistentry>
816
815
<varlistentry><term><parameter>rid</parameter>&#160;:</term>
817
 
<listitem><simpara> Recurrence identifier.
 
816
<listitem><simpara>Recurrence identifier.
818
817
</simpara></listitem></varlistentry>
819
818
<varlistentry><term><parameter>icalcomp</parameter>&#160;:</term>
820
 
<listitem><simpara> Return value for the calendar component object.
 
819
<listitem><simpara>Return value for the calendar component object.
821
820
</simpara></listitem></varlistentry>
822
821
<varlistentry><term><parameter>error</parameter>&#160;:</term>
823
 
<listitem><simpara> Placeholder for error information.
 
822
<listitem><simpara>Placeholder for error information.
824
823
</simpara></listitem></varlistentry>
825
824
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the call was successful, FALSE otherwise.
826
825
</simpara></listitem></varlistentry>
827
826
</variablelist></refsect2>
828
827
<refsect2 id="e-cal-get-objects-for-uid" role="function">
829
828
<title>e_cal_get_objects_for_uid ()</title>
830
 
<indexterm zone="e-cal-get-objects-for-uid"><primary sortas="e_cal_get_objects_for_uid">e_cal_get_objects_for_uid</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_get_objects_for_uid           (<link linkend="ECal">ECal</link> *ecal,
831
 
                                                         const <link linkend="gchar">gchar</link> *uid,
832
 
                                                         <link linkend="GList">GList</link> **objects,
833
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
829
<indexterm zone="e-cal-get-objects-for-uid"><primary>e_cal_get_objects_for_uid</primary></indexterm>
 
830
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_get_objects_for_uid           (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
831
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>,
 
832
                                                         <parameter><link linkend="GList"><type>GList</type></link> **objects</parameter>,
 
833
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
834
834
<para>
835
835
Queries a calendar for all calendar components with the given unique
836
836
ID. This will return any recurring event and all its detached recurrences.
837
837
For non-recurring events, it will just return the object with that ID.</para>
838
 
<para>
839
 
</para><variablelist role="params">
 
838
<variablelist role="params">
840
839
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
841
 
<listitem><simpara> A calendar client.
 
840
<listitem><simpara>A calendar client.
842
841
</simpara></listitem></varlistentry>
843
842
<varlistentry><term><parameter>uid</parameter>&#160;:</term>
844
 
<listitem><simpara> Unique identifier for a calendar component.
 
843
<listitem><simpara>Unique identifier for a calendar component.
845
844
</simpara></listitem></varlistentry>
846
845
<varlistentry><term><parameter>objects</parameter>&#160;:</term>
847
 
<listitem><simpara> Return value for the list of objects obtained from the backend.
 
846
<listitem><simpara>Return value for the list of objects obtained from the backend.
848
847
</simpara></listitem></varlistentry>
849
848
<varlistentry><term><parameter>error</parameter>&#160;:</term>
850
 
<listitem><simpara> Placeholder for error information.
 
849
<listitem><simpara>Placeholder for error information.
851
850
</simpara></listitem></varlistentry>
852
851
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the call was successful, FALSE otherwise.
853
852
</simpara></listitem></varlistentry>
854
853
</variablelist></refsect2>
855
854
<refsect2 id="e-cal-get-changes" role="function">
856
855
<title>e_cal_get_changes ()</title>
857
 
<indexterm zone="e-cal-get-changes"><primary sortas="e_cal_get_changes">e_cal_get_changes</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_get_changes                   (<link linkend="ECal">ECal</link> *ecal,
858
 
                                                         const <link linkend="gchar">gchar</link> *change_id,
859
 
                                                         <link linkend="GList">GList</link> **changes,
860
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
856
<indexterm zone="e-cal-get-changes"><primary>e_cal_get_changes</primary></indexterm>
 
857
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_get_changes                   (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
858
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *change_id</parameter>,
 
859
                                                         <parameter><link linkend="GList"><type>GList</type></link> **changes</parameter>,
 
860
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
861
861
<para>
862
862
Returns a list of changes made to the calendar since a specific time. That time
863
863
is identified by the <parameter>change_id</parameter> argument, which is used by the backend to
864
864
compute the changes done.</para>
865
 
<para>
866
 
</para><variablelist role="params">
 
865
<variablelist role="params">
867
866
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
868
 
<listitem><simpara> A calendar client.
 
867
<listitem><simpara>A calendar client.
869
868
</simpara></listitem></varlistentry>
870
869
<varlistentry><term><parameter>change_id</parameter>&#160;:</term>
871
 
<listitem><simpara> ID to use for comparing changes.
 
870
<listitem><simpara>ID to use for comparing changes.
872
871
</simpara></listitem></varlistentry>
873
872
<varlistentry><term><parameter>changes</parameter>&#160;:</term>
874
 
<listitem><simpara> Return value for the list of changes.
 
873
<listitem><simpara>Return value for the list of changes.
875
874
</simpara></listitem></varlistentry>
876
875
<varlistentry><term><parameter>error</parameter>&#160;:</term>
877
 
<listitem><simpara> Placeholder for error information.
 
876
<listitem><simpara>Placeholder for error information.
878
877
</simpara></listitem></varlistentry>
879
878
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the call was successful, FALSE otherwise.
880
879
</simpara></listitem></varlistentry>
881
880
</variablelist></refsect2>
882
881
<refsect2 id="e-cal-free-change-list" role="function">
883
882
<title>e_cal_free_change_list ()</title>
884
 
<indexterm zone="e-cal-free-change-list"><primary sortas="e_cal_free_change_list">e_cal_free_change_list</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_free_change_list              (<link linkend="GList">GList</link> *list);</programlisting>
 
883
<indexterm zone="e-cal-free-change-list"><primary>e_cal_free_change_list</primary></indexterm>
 
884
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_cal_free_change_list              (<parameter><link linkend="GList"><type>GList</type></link> *list</parameter>);</programlisting>
885
885
<para>
886
886
Free a list of changes as returned by <link linkend="e-cal-get-changes"><type>e_cal_get_changes</type></link>.</para>
887
 
<para>
888
 
</para><variablelist role="params">
 
887
<variablelist role="params">
889
888
<varlistentry><term><parameter>list</parameter>&#160;:</term>
890
 
<listitem><simpara> List of changes to be freed.
 
889
<listitem><simpara>List of changes to be freed.
891
890
</simpara></listitem></varlistentry>
892
891
</variablelist></refsect2>
893
892
<refsect2 id="e-cal-get-object-list" role="function">
894
893
<title>e_cal_get_object_list ()</title>
895
 
<indexterm zone="e-cal-get-object-list"><primary sortas="e_cal_get_object_list">e_cal_get_object_list</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_get_object_list               (<link linkend="ECal">ECal</link> *ecal,
896
 
                                                         const <link linkend="gchar">gchar</link> *query,
897
 
                                                         <link linkend="GList">GList</link> **objects,
898
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
894
<indexterm zone="e-cal-get-object-list"><primary>e_cal_get_object_list</primary></indexterm>
 
895
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_get_object_list               (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
896
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *query</parameter>,
 
897
                                                         <parameter><link linkend="GList"><type>GList</type></link> **objects</parameter>,
 
898
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
899
899
<para>
900
900
Gets a list of objects from the calendar that match the query specified
901
901
by the <parameter>query</parameter> argument. The objects will be returned in the <parameter>objects</parameter>
902
902
argument, which is a list of <link linkend="icalcomponent"><type>icalcomponent</type></link>. When done, this list
903
903
should be freed by using the <link linkend="e-cal-free-object-list"><type>e_cal_free_object_list</type></link> function.</para>
904
 
<para>
905
 
</para><variablelist role="params">
 
904
<variablelist role="params">
906
905
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
907
 
<listitem><simpara> A calendar client.
 
906
<listitem><simpara>A calendar client.
908
907
</simpara></listitem></varlistentry>
909
908
<varlistentry><term><parameter>query</parameter>&#160;:</term>
910
 
<listitem><simpara> Query string.
 
909
<listitem><simpara>Query string.
911
910
</simpara></listitem></varlistentry>
912
911
<varlistentry><term><parameter>objects</parameter>&#160;:</term>
913
 
<listitem><simpara> Return value for list of objects.
 
912
<listitem><simpara>Return value for list of objects.
914
913
</simpara></listitem></varlistentry>
915
914
<varlistentry><term><parameter>error</parameter>&#160;:</term>
916
 
<listitem><simpara> Placeholder for error information.
 
915
<listitem><simpara>Placeholder for error information.
917
916
</simpara></listitem></varlistentry>
918
917
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the operation was successful, FALSE otherwise.
919
918
</simpara></listitem></varlistentry>
920
919
</variablelist></refsect2>
921
920
<refsect2 id="e-cal-get-object-list-as-comp" role="function">
922
921
<title>e_cal_get_object_list_as_comp ()</title>
923
 
<indexterm zone="e-cal-get-object-list-as-comp"><primary sortas="e_cal_get_object_list_as_comp">e_cal_get_object_list_as_comp</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_get_object_list_as_comp       (<link linkend="ECal">ECal</link> *ecal,
924
 
                                                         const <link linkend="gchar">gchar</link> *query,
925
 
                                                         <link linkend="GList">GList</link> **objects,
926
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
922
<indexterm zone="e-cal-get-object-list-as-comp"><primary>e_cal_get_object_list_as_comp</primary></indexterm>
 
923
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_get_object_list_as_comp       (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
924
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *query</parameter>,
 
925
                                                         <parameter><link linkend="GList"><type>GList</type></link> **objects</parameter>,
 
926
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
927
927
<para>
928
928
Gets a list of objects from the calendar that match the query specified
929
929
by the <parameter>query</parameter> argument. The objects will be returned in the <parameter>objects</parameter>
930
930
argument, which is a list of <link linkend="ECalComponent"><type>ECalComponent</type></link>.</para>
931
 
<para>
932
 
</para><variablelist role="params">
 
931
<variablelist role="params">
933
932
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
934
 
<listitem><simpara> A calendar client.
 
933
<listitem><simpara>A calendar client.
935
934
</simpara></listitem></varlistentry>
936
935
<varlistentry><term><parameter>query</parameter>&#160;:</term>
937
 
<listitem><simpara> Query string.
 
936
<listitem><simpara>Query string.
938
937
</simpara></listitem></varlistentry>
939
938
<varlistentry><term><parameter>objects</parameter>&#160;:</term>
940
 
<listitem><simpara> Return value for list of objects.
 
939
<listitem><simpara>Return value for list of objects.
941
940
</simpara></listitem></varlistentry>
942
941
<varlistentry><term><parameter>error</parameter>&#160;:</term>
943
 
<listitem><simpara> Placeholder for error information.
 
942
<listitem><simpara>Placeholder for error information.
944
943
</simpara></listitem></varlistentry>
945
944
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the operation was successful, FALSE otherwise.
946
945
</simpara></listitem></varlistentry>
947
946
</variablelist></refsect2>
948
947
<refsect2 id="e-cal-free-object-list" role="function">
949
948
<title>e_cal_free_object_list ()</title>
950
 
<indexterm zone="e-cal-free-object-list"><primary sortas="e_cal_free_object_list">e_cal_free_object_list</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_free_object_list              (<link linkend="GList">GList</link> *objects);</programlisting>
 
949
<indexterm zone="e-cal-free-object-list"><primary>e_cal_free_object_list</primary></indexterm>
 
950
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_cal_free_object_list              (<parameter><link linkend="GList"><type>GList</type></link> *objects</parameter>);</programlisting>
951
951
<para>
952
952
Frees a list of objects as returned by <link linkend="e-cal-get-object-list"><type>e_cal_get_object_list</type></link>.</para>
953
 
<para>
954
 
</para><variablelist role="params">
 
953
<variablelist role="params">
955
954
<varlistentry><term><parameter>objects</parameter>&#160;:</term>
956
 
<listitem><simpara> List of objects to be freed.
 
955
<listitem><simpara>List of objects to be freed.
957
956
</simpara></listitem></varlistentry>
958
957
</variablelist></refsect2>
959
958
<refsect2 id="e-cal-get-free-busy" role="function">
960
959
<title>e_cal_get_free_busy ()</title>
961
 
<indexterm zone="e-cal-get-free-busy"><primary sortas="e_cal_get_free_busy">e_cal_get_free_busy</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_get_free_busy                 (<link linkend="ECal">ECal</link> *ecal,
962
 
                                                         <link linkend="GList">GList</link> *users,
963
 
                                                         <link linkend="time-t">time_t</link> start,
964
 
                                                         <link linkend="time-t">time_t</link> end,
965
 
                                                         <link linkend="GList">GList</link> **freebusy,
966
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
960
<indexterm zone="e-cal-get-free-busy"><primary>e_cal_get_free_busy</primary></indexterm>
 
961
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_get_free_busy                 (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
962
                                                         <parameter><link linkend="GList"><type>GList</type></link> *users</parameter>,
 
963
                                                         <parameter><link linkend="time-t"><type>time_t</type></link> start</parameter>,
 
964
                                                         <parameter><link linkend="time-t"><type>time_t</type></link> end</parameter>,
 
965
                                                         <parameter><link linkend="GList"><type>GList</type></link> **freebusy</parameter>,
 
966
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
967
967
<para>
968
968
Gets free/busy information from the calendar server.</para>
969
 
<para>
970
 
</para><variablelist role="params">
 
969
<variablelist role="params">
971
970
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
972
 
<listitem><simpara> A calendar client.
 
971
<listitem><simpara>A calendar client.
973
972
</simpara></listitem></varlistentry>
974
973
<varlistentry><term><parameter>users</parameter>&#160;:</term>
975
 
<listitem><simpara> List of users to retrieve free/busy information for.
 
974
<listitem><simpara>List of users to retrieve free/busy information for.
976
975
</simpara></listitem></varlistentry>
977
976
<varlistentry><term><parameter>start</parameter>&#160;:</term>
978
 
<listitem><simpara> Start time for query.
 
977
<listitem><simpara>Start time for query.
979
978
</simpara></listitem></varlistentry>
980
979
<varlistentry><term><parameter>end</parameter>&#160;:</term>
981
 
<listitem><simpara> End time for query.
 
980
<listitem><simpara>End time for query.
982
981
</simpara></listitem></varlistentry>
983
982
<varlistentry><term><parameter>freebusy</parameter>&#160;:</term>
984
 
<listitem><simpara> Return value for VFREEBUSY objects.
 
983
<listitem><simpara>Return value for VFREEBUSY objects.
985
984
</simpara></listitem></varlistentry>
986
985
<varlistentry><term><parameter>error</parameter>&#160;:</term>
987
 
<listitem><simpara> Placeholder for error information.
 
986
<listitem><simpara>Placeholder for error information.
988
987
</simpara></listitem></varlistentry>
989
988
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the operation was successful, FALSE otherwise.
990
989
</simpara></listitem></varlistentry>
991
990
</variablelist></refsect2>
992
991
<refsect2 id="e-cal-generate-instances" role="function">
993
992
<title>e_cal_generate_instances ()</title>
994
 
<indexterm zone="e-cal-generate-instances"><primary sortas="e_cal_generate_instances">e_cal_generate_instances</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_generate_instances            (<link linkend="ECal">ECal</link> *ecal,
995
 
                                                         <link linkend="time-t">time_t</link> start,
996
 
                                                         <link linkend="time-t">time_t</link> end,
997
 
                                                         <link linkend="ECalRecurInstanceFn">ECalRecurInstanceFn</link> cb,
998
 
                                                         <link linkend="gpointer">gpointer</link> cb_data);</programlisting>
 
993
<indexterm zone="e-cal-generate-instances"><primary>e_cal_generate_instances</primary></indexterm>
 
994
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_cal_generate_instances            (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
995
                                                         <parameter><link linkend="time-t"><type>time_t</type></link> start</parameter>,
 
996
                                                         <parameter><link linkend="time-t"><type>time_t</type></link> end</parameter>,
 
997
                                                         <parameter><link linkend="ECalRecurInstanceFn"><type>ECalRecurInstanceFn</type></link> cb</parameter>,
 
998
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> cb_data</parameter>);</programlisting>
999
999
<para>
1000
1000
Does a combination of #<link linkend="e-cal-get-object-list"><function>e_cal_get_object_list()</function></link> and
1001
1001
#<link linkend="e-cal-recur-generate-instances"><function>e_cal_recur_generate_instances()</function></link>.
1004
1004
The callback function should do a <link linkend="g-object-ref"><function>g_object_ref()</function></link> of the calendar component
1005
1005
it gets passed if it intends to keep it around, since it will be unref'ed
1006
1006
as soon as the callback returns.</para>
1007
 
<para>
1008
 
</para><variablelist role="params">
 
1007
<variablelist role="params">
1009
1008
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
1010
 
<listitem><simpara> A calendar client.
 
1009
<listitem><simpara>A calendar client.
1011
1010
</simpara></listitem></varlistentry>
1012
1011
<varlistentry><term><parameter>start</parameter>&#160;:</term>
1013
 
<listitem><simpara> Start time for query.
 
1012
<listitem><simpara>Start time for query.
1014
1013
</simpara></listitem></varlistentry>
1015
1014
<varlistentry><term><parameter>end</parameter>&#160;:</term>
1016
 
<listitem><simpara> End time for query.
 
1015
<listitem><simpara>End time for query.
1017
1016
</simpara></listitem></varlistentry>
1018
1017
<varlistentry><term><parameter>cb</parameter>&#160;:</term>
1019
 
<listitem><simpara> Callback for each generated instance.
 
1018
<listitem><simpara>Callback for each generated instance.
1020
1019
</simpara></listitem></varlistentry>
1021
1020
<varlistentry><term><parameter>cb_data</parameter>&#160;:</term>
1022
 
<listitem><simpara> Closure data for the callback.
 
1021
<listitem><simpara>Closure data for the callback.
1023
1022
</simpara></listitem></varlistentry>
1024
1023
</variablelist></refsect2>
1025
1024
<refsect2 id="e-cal-generate-instances-for-object" role="function">
1026
1025
<title>e_cal_generate_instances_for_object ()</title>
1027
 
<indexterm zone="e-cal-generate-instances-for-object"><primary sortas="e_cal_generate_instances_for_object">e_cal_generate_instances_for_object</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_generate_instances_for_object (<link linkend="ECal">ECal</link> *ecal,
1028
 
                                                         <link linkend="icalcomponent">icalcomponent</link> *icalcomp,
1029
 
                                                         <link linkend="time-t">time_t</link> start,
1030
 
                                                         <link linkend="time-t">time_t</link> end,
1031
 
                                                         <link linkend="ECalRecurInstanceFn">ECalRecurInstanceFn</link> cb,
1032
 
                                                         <link linkend="gpointer">gpointer</link> cb_data);</programlisting>
 
1026
<indexterm zone="e-cal-generate-instances-for-object"><primary>e_cal_generate_instances_for_object</primary></indexterm>
 
1027
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_cal_generate_instances_for_object (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
1028
                                                         <parameter><link linkend="icalcomponent"><type>icalcomponent</type></link> *icalcomp</parameter>,
 
1029
                                                         <parameter><link linkend="time-t"><type>time_t</type></link> start</parameter>,
 
1030
                                                         <parameter><link linkend="time-t"><type>time_t</type></link> end</parameter>,
 
1031
                                                         <parameter><link linkend="ECalRecurInstanceFn"><type>ECalRecurInstanceFn</type></link> cb</parameter>,
 
1032
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> cb_data</parameter>);</programlisting>
1033
1033
<para>
1034
1034
Does a combination of #<link linkend="e-cal-get-object-list"><function>e_cal_get_object_list()</function></link> and
1035
1035
#<link linkend="e-cal-recur-generate-instances"><function>e_cal_recur_generate_instances()</function></link>, like #<link linkend="e-cal-generate-instances"><function>e_cal_generate_instances()</function></link>, but
1039
1039
The callback function should do a <link linkend="g-object-ref"><function>g_object_ref()</function></link> of the calendar component
1040
1040
it gets passed if it intends to keep it around, since it will be unref'ed
1041
1041
as soon as the callback returns.</para>
1042
 
<para>
1043
 
</para><variablelist role="params">
 
1042
<variablelist role="params">
1044
1043
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
1045
 
<listitem><simpara> A calendar client.
 
1044
<listitem><simpara>A calendar client.
1046
1045
</simpara></listitem></varlistentry>
1047
1046
<varlistentry><term><parameter>icalcomp</parameter>&#160;:</term>
1048
 
<listitem><simpara> Object to generate instances from.
 
1047
<listitem><simpara>Object to generate instances from.
1049
1048
</simpara></listitem></varlistentry>
1050
1049
<varlistentry><term><parameter>start</parameter>&#160;:</term>
1051
 
<listitem><simpara> Start time for query.
 
1050
<listitem><simpara>Start time for query.
1052
1051
</simpara></listitem></varlistentry>
1053
1052
<varlistentry><term><parameter>end</parameter>&#160;:</term>
1054
 
<listitem><simpara> End time for query.
 
1053
<listitem><simpara>End time for query.
1055
1054
</simpara></listitem></varlistentry>
1056
1055
<varlistentry><term><parameter>cb</parameter>&#160;:</term>
1057
 
<listitem><simpara> Callback for each generated instance.
 
1056
<listitem><simpara>Callback for each generated instance.
1058
1057
</simpara></listitem></varlistentry>
1059
1058
<varlistentry><term><parameter>cb_data</parameter>&#160;:</term>
1060
 
<listitem><simpara> Closure data for the callback.
 
1059
<listitem><simpara>Closure data for the callback.
1061
1060
</simpara></listitem></varlistentry>
1062
1061
</variablelist></refsect2>
1063
1062
<refsect2 id="e-cal-get-alarms-in-range" role="function">
1064
1063
<title>e_cal_get_alarms_in_range ()</title>
1065
 
<indexterm zone="e-cal-get-alarms-in-range"><primary sortas="e_cal_get_alarms_in_range">e_cal_get_alarms_in_range</primary></indexterm><programlisting><link linkend="GSList">GSList</link> *            e_cal_get_alarms_in_range           (<link linkend="ECal">ECal</link> *ecal,
1066
 
                                                         <link linkend="time-t">time_t</link> start,
1067
 
                                                         <link linkend="time-t">time_t</link> end);</programlisting>
 
1064
<indexterm zone="e-cal-get-alarms-in-range"><primary>e_cal_get_alarms_in_range</primary></indexterm>
 
1065
<programlisting><link linkend="GSList"><returnvalue>GSList</returnvalue></link> *            e_cal_get_alarms_in_range           (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
1066
                                                         <parameter><link linkend="time-t"><type>time_t</type></link> start</parameter>,
 
1067
                                                         <parameter><link linkend="time-t"><type>time_t</type></link> end</parameter>);</programlisting>
1068
1068
<para>
1069
1069
Queries a calendar for the alarms that trigger in the specified range of
1070
1070
time.</para>
1071
 
<para>
1072
 
</para><variablelist role="params">
 
1071
<variablelist role="params">
1073
1072
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
1074
 
<listitem><simpara> A calendar client.
 
1073
<listitem><simpara>A calendar client.
1075
1074
</simpara></listitem></varlistentry>
1076
1075
<varlistentry><term><parameter>start</parameter>&#160;:</term>
1077
 
<listitem><simpara> Start time for query.
 
1076
<listitem><simpara>Start time for query.
1078
1077
</simpara></listitem></varlistentry>
1079
1078
<varlistentry><term><parameter>end</parameter>&#160;:</term>
1080
 
<listitem><simpara> End time for query.
 
1079
<listitem><simpara>End time for query.
1081
1080
</simpara></listitem></varlistentry>
1082
1081
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A list of <link linkend="ECalComponentAlarms"><type>ECalComponentAlarms</type></link> structures.  This should be freed
1083
1082
using the #<link linkend="e-cal-free-alarms"><function>e_cal_free_alarms()</function></link> function, or by freeing each element
1087
1086
</variablelist></refsect2>
1088
1087
<refsect2 id="e-cal-free-alarms" role="function">
1089
1088
<title>e_cal_free_alarms ()</title>
1090
 
<indexterm zone="e-cal-free-alarms"><primary sortas="e_cal_free_alarms">e_cal_free_alarms</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_free_alarms                   (<link linkend="GSList">GSList</link> *comp_alarms);</programlisting>
 
1089
<indexterm zone="e-cal-free-alarms"><primary>e_cal_free_alarms</primary></indexterm>
 
1090
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_cal_free_alarms                   (<parameter><link linkend="GSList"><type>GSList</type></link> *comp_alarms</parameter>);</programlisting>
1091
1091
<para>
1092
1092
Frees a list of <link linkend="ECalComponentAlarms"><type>ECalComponentAlarms</type></link> structures as returned by
1093
1093
<link linkend="e-cal-get-alarms-in-range"><function>e_cal_get_alarms_in_range()</function></link>.</para>
1094
 
<para>
1095
 
</para><variablelist role="params">
 
1094
<variablelist role="params">
1096
1095
<varlistentry><term><parameter>comp_alarms</parameter>&#160;:</term>
1097
 
<listitem><simpara> A list of <link linkend="ECalComponentAlarms"><type>ECalComponentAlarms</type></link> structures.
 
1096
<listitem><simpara>A list of <link linkend="ECalComponentAlarms"><type>ECalComponentAlarms</type></link> structures.
1098
1097
</simpara></listitem></varlistentry>
1099
1098
</variablelist></refsect2>
1100
1099
<refsect2 id="e-cal-get-alarms-for-object" role="function">
1101
1100
<title>e_cal_get_alarms_for_object ()</title>
1102
 
<indexterm zone="e-cal-get-alarms-for-object"><primary sortas="e_cal_get_alarms_for_object">e_cal_get_alarms_for_object</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_get_alarms_for_object         (<link linkend="ECal">ECal</link> *ecal,
1103
 
                                                         const <link linkend="ECalComponentId">ECalComponentId</link> *id,
1104
 
                                                         <link linkend="time-t">time_t</link> start,
1105
 
                                                         <link linkend="time-t">time_t</link> end,
1106
 
                                                         <link linkend="ECalComponentAlarms">ECalComponentAlarms</link> **alarms);</programlisting>
 
1101
<indexterm zone="e-cal-get-alarms-for-object"><primary>e_cal_get_alarms_for_object</primary></indexterm>
 
1102
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_get_alarms_for_object         (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
1103
                                                         <parameter>const <link linkend="ECalComponentId"><type>ECalComponentId</type></link> *id</parameter>,
 
1104
                                                         <parameter><link linkend="time-t"><type>time_t</type></link> start</parameter>,
 
1105
                                                         <parameter><link linkend="time-t"><type>time_t</type></link> end</parameter>,
 
1106
                                                         <parameter><link linkend="ECalComponentAlarms"><type>ECalComponentAlarms</type></link> **alarms</parameter>);</programlisting>
1107
1107
<para>
1108
1108
Queries a calendar for the alarms of a particular object that trigger in the
1109
1109
specified range of time.</para>
1110
 
<para>
1111
 
</para><variablelist role="params">
 
1110
<variablelist role="params">
1112
1111
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
1113
 
<listitem><simpara> A calendar client.
 
1112
<listitem><simpara>A calendar client.
1114
1113
</simpara></listitem></varlistentry>
1115
1114
<varlistentry><term><parameter>id</parameter>&#160;:</term>
1116
 
<listitem><simpara> Unique identifier for a calendar component.
 
1115
<listitem><simpara>Unique identifier for a calendar component.
1117
1116
</simpara></listitem></varlistentry>
1118
1117
<varlistentry><term><parameter>start</parameter>&#160;:</term>
1119
 
<listitem><simpara> Start time for query.
 
1118
<listitem><simpara>Start time for query.
1120
1119
</simpara></listitem></varlistentry>
1121
1120
<varlistentry><term><parameter>end</parameter>&#160;:</term>
1122
 
<listitem><simpara> End time for query.
 
1121
<listitem><simpara>End time for query.
1123
1122
</simpara></listitem></varlistentry>
1124
1123
<varlistentry><term><parameter>alarms</parameter>&#160;:</term>
1125
 
<listitem><simpara> Return value for the component's alarm instances.  Will return NULL
 
1124
<listitem><simpara>Return value for the component's alarm instances.  Will return NULL
1126
1125
if no instances occur within the specified time range.  This should be freed
1127
1126
using the <link linkend="e-cal-component-alarms-free"><function>e_cal_component_alarms_free()</function></link> function.
1128
1127
</simpara></listitem></varlistentry>
1131
1130
</variablelist></refsect2>
1132
1131
<refsect2 id="e-cal-create-object" role="function">
1133
1132
<title>e_cal_create_object ()</title>
1134
 
<indexterm zone="e-cal-create-object"><primary sortas="e_cal_create_object">e_cal_create_object</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_create_object                 (<link linkend="ECal">ECal</link> *ecal,
1135
 
                                                         <link linkend="icalcomponent">icalcomponent</link> *icalcomp,
1136
 
                                                         <link linkend="gchar">gchar</link> **uid,
1137
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
1133
<indexterm zone="e-cal-create-object"><primary>e_cal_create_object</primary></indexterm>
 
1134
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_create_object                 (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
1135
                                                         <parameter><link linkend="icalcomponent"><type>icalcomponent</type></link> *icalcomp</parameter>,
 
1136
                                                         <parameter><link linkend="gchar"><type>gchar</type></link> **uid</parameter>,
 
1137
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
1138
1138
<para>
1139
1139
Requests the calendar backend to create the object specified by the <parameter>icalcomp</parameter>
1140
1140
argument. Some backends would assign a specific UID to the newly created object,
1141
1141
in those cases that UID would be returned in the <parameter>uid</parameter> argument.</para>
1142
 
<para>
1143
 
</para><variablelist role="params">
 
1142
<variablelist role="params">
1144
1143
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
1145
 
<listitem><simpara> A calendar client.
 
1144
<listitem><simpara>A calendar client.
1146
1145
</simpara></listitem></varlistentry>
1147
1146
<varlistentry><term><parameter>icalcomp</parameter>&#160;:</term>
1148
 
<listitem><simpara> The component to create.
 
1147
<listitem><simpara>The component to create.
1149
1148
</simpara></listitem></varlistentry>
1150
1149
<varlistentry><term><parameter>uid</parameter>&#160;:</term>
1151
 
<listitem><simpara> Return value for the UID assigned to the new component by the calendar backend.
 
1150
<listitem><simpara>Return value for the UID assigned to the new component by the calendar backend.
1152
1151
</simpara></listitem></varlistentry>
1153
1152
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1154
 
<listitem><simpara> Placeholder for error information.
 
1153
<listitem><simpara>Placeholder for error information.
1155
1154
</simpara></listitem></varlistentry>
1156
1155
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the operation was successful, FALSE otherwise.
1157
1156
</simpara></listitem></varlistentry>
1158
1157
</variablelist></refsect2>
1159
1158
<refsect2 id="e-cal-modify-object" role="function">
1160
1159
<title>e_cal_modify_object ()</title>
1161
 
<indexterm zone="e-cal-modify-object"><primary sortas="e_cal_modify_object">e_cal_modify_object</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_modify_object                 (<link linkend="ECal">ECal</link> *ecal,
1162
 
                                                         <link linkend="icalcomponent">icalcomponent</link> *icalcomp,
1163
 
                                                         <link linkend="CalObjModType">CalObjModType</link> mod,
1164
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
1160
<indexterm zone="e-cal-modify-object"><primary>e_cal_modify_object</primary></indexterm>
 
1161
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_modify_object                 (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
1162
                                                         <parameter><link linkend="icalcomponent"><type>icalcomponent</type></link> *icalcomp</parameter>,
 
1163
                                                         <parameter><link linkend="CalObjModType"><type>CalObjModType</type></link> mod</parameter>,
 
1164
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
1165
1165
<para>
1166
1166
Requests the calendar backend to modify an existing object. If the object
1167
1167
does not exist on the calendar, an error will be returned.
1171
1171
if all instances (CALOBJ_MOD_ALL), a single instance (CALOBJ_MOD_THIS),
1172
1172
or a specific set of instances (CALOBJ_MOD_THISNADPRIOR and
1173
1173
CALOBJ_MOD_THISANDFUTURE).</para>
1174
 
<para>
1175
 
</para><variablelist role="params">
 
1174
<variablelist role="params">
1176
1175
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
1177
 
<listitem><simpara> A calendar client.
 
1176
<listitem><simpara>A calendar client.
1178
1177
</simpara></listitem></varlistentry>
1179
1178
<varlistentry><term><parameter>icalcomp</parameter>&#160;:</term>
1180
 
<listitem><simpara> Component to modify.
 
1179
<listitem><simpara>Component to modify.
1181
1180
</simpara></listitem></varlistentry>
1182
1181
<varlistentry><term><parameter>mod</parameter>&#160;:</term>
1183
 
<listitem><simpara> Type of modification.
 
1182
<listitem><simpara>Type of modification.
1184
1183
</simpara></listitem></varlistentry>
1185
1184
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1186
 
<listitem><simpara> Placeholder for error information.
 
1185
<listitem><simpara>Placeholder for error information.
1187
1186
</simpara></listitem></varlistentry>
1188
1187
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the operation was successful, FALSE otherwise.
1189
1188
</simpara></listitem></varlistentry>
1190
1189
</variablelist></refsect2>
1191
1190
<refsect2 id="e-cal-remove-object" role="function">
1192
1191
<title>e_cal_remove_object ()</title>
1193
 
<indexterm zone="e-cal-remove-object"><primary sortas="e_cal_remove_object">e_cal_remove_object</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_remove_object                 (<link linkend="ECal">ECal</link> *ecal,
1194
 
                                                         const <link linkend="gchar">gchar</link> *uid,
1195
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
1192
<indexterm zone="e-cal-remove-object"><primary>e_cal_remove_object</primary></indexterm>
 
1193
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_remove_object                 (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
1194
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>,
 
1195
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
1196
1196
<para>
1197
1197
Asks a calendar to remove a component.  If the server is able to remove the
1198
1198
component, all clients will be notified and they will emit the "obj_removed"
1199
1199
signal.</para>
1200
 
<para>
1201
 
</para><variablelist role="params">
 
1200
<variablelist role="params">
1202
1201
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
1203
 
<listitem><simpara>  A calendar client.
 
1202
<listitem><simpara>A calendar client.
1204
1203
</simpara></listitem></varlistentry>
1205
1204
<varlistentry><term><parameter>uid</parameter>&#160;:</term>
1206
 
<listitem><simpara> Unique identifier of the calendar component to remove.
 
1205
<listitem><simpara>Unique identifier of the calendar component to remove.
1207
1206
</simpara></listitem></varlistentry>
1208
1207
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1209
 
<listitem><simpara> Placeholder for error information.
 
1208
<listitem><simpara>Placeholder for error information.
1210
1209
</simpara></listitem></varlistentry>
1211
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if successful, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
 
1210
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if successful, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
1212
1211
</simpara></listitem></varlistentry>
1213
1212
</variablelist></refsect2>
1214
1213
<refsect2 id="e-cal-remove-object-with-mod" role="function">
1215
1214
<title>e_cal_remove_object_with_mod ()</title>
1216
 
<indexterm zone="e-cal-remove-object-with-mod"><primary sortas="e_cal_remove_object_with_mod">e_cal_remove_object_with_mod</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_remove_object_with_mod        (<link linkend="ECal">ECal</link> *ecal,
1217
 
                                                         const <link linkend="gchar">gchar</link> *uid,
1218
 
                                                         const <link linkend="gchar">gchar</link> *rid,
1219
 
                                                         <link linkend="CalObjModType">CalObjModType</link> mod,
1220
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
1215
<indexterm zone="e-cal-remove-object-with-mod"><primary>e_cal_remove_object_with_mod</primary></indexterm>
 
1216
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_remove_object_with_mod        (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
1217
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>,
 
1218
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *rid</parameter>,
 
1219
                                                         <parameter><link linkend="CalObjModType"><type>CalObjModType</type></link> mod</parameter>,
 
1220
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
1221
1221
<para>
1222
1222
This function allows the removal of instances of a recurrent
1223
1223
appointment. By using a combination of the <parameter>uid</parameter>, <parameter>rid</parameter> and <parameter>mod</parameter>
1228
1228
If not all instances are removed, the client will get a "obj_modified"
1229
1229
signal, while it will get a "obj_removed" signal when all instances
1230
1230
are removed.</para>
1231
 
<para>
1232
 
</para><variablelist role="params">
 
1231
<variablelist role="params">
1233
1232
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
1234
 
<listitem><simpara> A calendar client.
 
1233
<listitem><simpara>A calendar client.
1235
1234
</simpara></listitem></varlistentry>
1236
1235
<varlistentry><term><parameter>uid</parameter>&#160;:</term>
1237
 
<listitem><simpara> UID og the object to remove.
 
1236
<listitem><simpara>UID og the object to remove.
1238
1237
</simpara></listitem></varlistentry>
1239
1238
<varlistentry><term><parameter>rid</parameter>&#160;:</term>
1240
 
<listitem><simpara> Recurrence ID of the specific recurrence to remove.
 
1239
<listitem><simpara>Recurrence ID of the specific recurrence to remove.
1241
1240
</simpara></listitem></varlistentry>
1242
1241
<varlistentry><term><parameter>mod</parameter>&#160;:</term>
1243
 
<listitem><simpara> Type of removal.
 
1242
<listitem><simpara>Type of removal.
1244
1243
</simpara></listitem></varlistentry>
1245
1244
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1246
 
<listitem><simpara> Placeholder for error information.
 
1245
<listitem><simpara>Placeholder for error information.
1247
1246
</simpara></listitem></varlistentry>
1248
1247
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the operation was successful, FALSE otherwise.
1249
1248
</simpara></listitem></varlistentry>
1250
1249
</variablelist></refsect2>
1251
1250
<refsect2 id="e-cal-discard-alarm" role="function">
1252
1251
<title>e_cal_discard_alarm ()</title>
1253
 
<indexterm zone="e-cal-discard-alarm"><primary sortas="e_cal_discard_alarm">e_cal_discard_alarm</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_discard_alarm                 (<link linkend="ECal">ECal</link> *ecal,
1254
 
                                                         <link linkend="ECalComponent">ECalComponent</link> *comp,
1255
 
                                                         const <link linkend="gchar">gchar</link> *auid,
1256
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
1252
<indexterm zone="e-cal-discard-alarm"><primary>e_cal_discard_alarm</primary></indexterm>
 
1253
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_discard_alarm                 (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
1254
                                                         <parameter><link linkend="ECalComponent"><type>ECalComponent</type></link> *comp</parameter>,
 
1255
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *auid</parameter>,
 
1256
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
1257
1257
<para>
1258
1258
Tells the calendar backend to get rid of the alarm identified by the
1259
1259
<parameter>auid</parameter> argument in <parameter>comp</parameter>. Some backends might remove the alarm or
1260
1260
update internal information about the alarm be discarded, or, like
1261
1261
the file backend does, ignore the operation.</para>
1262
 
<para>
1263
 
</para><variablelist role="params">
 
1262
<variablelist role="params">
1264
1263
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
1265
 
<listitem><simpara> A calendar ecal.
 
1264
<listitem><simpara>A calendar ecal.
1266
1265
</simpara></listitem></varlistentry>
1267
1266
<varlistentry><term><parameter>comp</parameter>&#160;:</term>
1268
 
<listitem><simpara> The component to discard the alarm from.
 
1267
<listitem><simpara>The component to discard the alarm from.
1269
1268
</simpara></listitem></varlistentry>
1270
1269
<varlistentry><term><parameter>auid</parameter>&#160;:</term>
1271
 
<listitem><simpara> Unique identifier of the alarm to be discarded.
 
1270
<listitem><simpara>Unique identifier of the alarm to be discarded.
1272
1271
</simpara></listitem></varlistentry>
1273
1272
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1274
 
<listitem><simpara> Placeholder for error information.
 
1273
<listitem><simpara>Placeholder for error information.
1275
1274
</simpara></listitem></varlistentry>
1276
1275
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the operation was successful, FALSE otherwise.
1277
1276
</simpara></listitem></varlistentry>
1278
1277
</variablelist></refsect2>
1279
1278
<refsect2 id="e-cal-receive-objects" role="function">
1280
1279
<title>e_cal_receive_objects ()</title>
1281
 
<indexterm zone="e-cal-receive-objects"><primary sortas="e_cal_receive_objects">e_cal_receive_objects</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_receive_objects               (<link linkend="ECal">ECal</link> *ecal,
1282
 
                                                         <link linkend="icalcomponent">icalcomponent</link> *icalcomp,
1283
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
1280
<indexterm zone="e-cal-receive-objects"><primary>e_cal_receive_objects</primary></indexterm>
 
1281
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_receive_objects               (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
1282
                                                         <parameter><link linkend="icalcomponent"><type>icalcomponent</type></link> *icalcomp</parameter>,
 
1283
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
1284
1284
<para>
1285
1285
Makes the backend receive the set of iCalendar objects specified in the
1286
1286
<parameter>icalcomp</parameter> argument. This is used for iTIP confirmation/cancellation
1287
1287
messages for scheduled meetings.</para>
1288
 
<para>
1289
 
</para><variablelist role="params">
 
1288
<variablelist role="params">
1290
1289
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
1291
 
<listitem><simpara>  A calendar client.
 
1290
<listitem><simpara>A calendar client.
1292
1291
</simpara></listitem></varlistentry>
1293
1292
<varlistentry><term><parameter>icalcomp</parameter>&#160;:</term>
1294
 
<listitem><simpara> An icalcomponent.
 
1293
<listitem><simpara>An icalcomponent.
1295
1294
</simpara></listitem></varlistentry>
1296
1295
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1297
 
<listitem><simpara> Placeholder for error information.
 
1296
<listitem><simpara>Placeholder for error information.
1298
1297
</simpara></listitem></varlistentry>
1299
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if successful, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
 
1298
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if successful, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
1300
1299
</simpara></listitem></varlistentry>
1301
1300
</variablelist></refsect2>
1302
1301
<refsect2 id="e-cal-send-objects" role="function">
1303
1302
<title>e_cal_send_objects ()</title>
1304
 
<indexterm zone="e-cal-send-objects"><primary sortas="e_cal_send_objects">e_cal_send_objects</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_send_objects                  (<link linkend="ECal">ECal</link> *ecal,
1305
 
                                                         <link linkend="icalcomponent">icalcomponent</link> *icalcomp,
1306
 
                                                         <link linkend="GList">GList</link> **users,
1307
 
                                                         <link linkend="icalcomponent">icalcomponent</link> **modified_icalcomp,
1308
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
1303
<indexterm zone="e-cal-send-objects"><primary>e_cal_send_objects</primary></indexterm>
 
1304
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_send_objects                  (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
1305
                                                         <parameter><link linkend="icalcomponent"><type>icalcomponent</type></link> *icalcomp</parameter>,
 
1306
                                                         <parameter><link linkend="GList"><type>GList</type></link> **users</parameter>,
 
1307
                                                         <parameter><link linkend="icalcomponent"><type>icalcomponent</type></link> **modified_icalcomp</parameter>,
 
1308
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
1309
1309
<para>
1310
1310
Requests a calendar backend to send meeting information to the specified list
1311
1311
of users.</para>
1312
 
<para>
1313
 
</para><variablelist role="params">
 
1312
<variablelist role="params">
1314
1313
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
1315
 
<listitem><simpara> A calendar client.
 
1314
<listitem><simpara>A calendar client.
1316
1315
</simpara></listitem></varlistentry>
1317
1316
<varlistentry><term><parameter>icalcomp</parameter>&#160;:</term>
1318
 
<listitem><simpara> An icalcomponent.
 
1317
<listitem><simpara>An icalcomponent.
1319
1318
</simpara></listitem></varlistentry>
1320
1319
<varlistentry><term><parameter>users</parameter>&#160;:</term>
1321
 
<listitem><simpara> List of users to send the objects to.
 
1320
<listitem><simpara>List of users to send the objects to.
1322
1321
</simpara></listitem></varlistentry>
1323
1322
<varlistentry><term><parameter>modified_icalcomp</parameter>&#160;:</term>
1324
 
<listitem><simpara> Return value for the icalcomponent after all the operations
 
1323
<listitem><simpara>Return value for the icalcomponent after all the operations
1325
1324
performed.
1326
1325
</simpara></listitem></varlistentry>
1327
1326
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1328
 
<listitem><simpara> Placeholder for error information.
 
1327
<listitem><simpara>Placeholder for error information.
1329
1328
</simpara></listitem></varlistentry>
1330
1329
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the operation was successful, FALSE otherwise.
1331
1330
</simpara></listitem></varlistentry>
1332
1331
</variablelist></refsect2>
1333
1332
<refsect2 id="e-cal-get-timezone" role="function">
1334
1333
<title>e_cal_get_timezone ()</title>
1335
 
<indexterm zone="e-cal-get-timezone"><primary sortas="e_cal_get_timezone">e_cal_get_timezone</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_get_timezone                  (<link linkend="ECal">ECal</link> *ecal,
1336
 
                                                         const <link linkend="gchar">gchar</link> *tzid,
1337
 
                                                         <link linkend="icaltimezone">icaltimezone</link> **zone,
1338
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
1334
<indexterm zone="e-cal-get-timezone"><primary>e_cal_get_timezone</primary></indexterm>
 
1335
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_get_timezone                  (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
1336
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *tzid</parameter>,
 
1337
                                                         <parameter><link linkend="icaltimezone"><type>icaltimezone</type></link> **zone</parameter>,
 
1338
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
1339
1339
<para>
1340
1340
Retrieves a timezone object from the calendar backend.</para>
1341
 
<para>
1342
 
</para><variablelist role="params">
 
1341
<variablelist role="params">
1343
1342
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
1344
 
<listitem><simpara> A calendar client.
 
1343
<listitem><simpara>A calendar client.
1345
1344
</simpara></listitem></varlistentry>
1346
1345
<varlistentry><term><parameter>tzid</parameter>&#160;:</term>
1347
 
<listitem><simpara> ID of the timezone to retrieve.
 
1346
<listitem><simpara>ID of the timezone to retrieve.
1348
1347
</simpara></listitem></varlistentry>
1349
1348
<varlistentry><term><parameter>zone</parameter>&#160;:</term>
1350
 
<listitem><simpara> Return value for the timezone.
 
1349
<listitem><simpara>Return value for the timezone.
1351
1350
</simpara></listitem></varlistentry>
1352
1351
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1353
 
<listitem><simpara> Placeholder for error information.
 
1352
<listitem><simpara>Placeholder for error information.
1354
1353
</simpara></listitem></varlistentry>
1355
1354
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the operation was successful, FALSE otherwise.
1356
1355
</simpara></listitem></varlistentry>
1357
1356
</variablelist></refsect2>
1358
1357
<refsect2 id="e-cal-add-timezone" role="function">
1359
1358
<title>e_cal_add_timezone ()</title>
1360
 
<indexterm zone="e-cal-add-timezone"><primary sortas="e_cal_add_timezone">e_cal_add_timezone</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_add_timezone                  (<link linkend="ECal">ECal</link> *ecal,
1361
 
                                                         <link linkend="icaltimezone">icaltimezone</link> *izone,
1362
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
1359
<indexterm zone="e-cal-add-timezone"><primary>e_cal_add_timezone</primary></indexterm>
 
1360
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_add_timezone                  (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
1361
                                                         <parameter><link linkend="icaltimezone"><type>icaltimezone</type></link> *izone</parameter>,
 
1362
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
1363
1363
<para>
1364
1364
Add a VTIMEZONE object to the given calendar.</para>
1365
 
<para>
1366
 
</para><variablelist role="params">
 
1365
<variablelist role="params">
1367
1366
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
1368
 
<listitem><simpara> A calendar client.
 
1367
<listitem><simpara>A calendar client.
1369
1368
</simpara></listitem></varlistentry>
1370
1369
<varlistentry><term><parameter>izone</parameter>&#160;:</term>
1371
 
<listitem><simpara> The timezone to add.
 
1370
<listitem><simpara>The timezone to add.
1372
1371
</simpara></listitem></varlistentry>
1373
1372
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1374
 
<listitem><simpara> Placeholder for error information.
 
1373
<listitem><simpara>Placeholder for error information.
1375
1374
</simpara></listitem></varlistentry>
1376
1375
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if successful, FALSE otherwise.
1377
1376
</simpara></listitem></varlistentry>
1378
1377
</variablelist></refsect2>
1379
1378
<refsect2 id="e-cal-set-default-timezone" role="function">
1380
1379
<title>e_cal_set_default_timezone ()</title>
1381
 
<indexterm zone="e-cal-set-default-timezone"><primary sortas="e_cal_set_default_timezone">e_cal_set_default_timezone</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_set_default_timezone          (<link linkend="ECal">ECal</link> *ecal,
1382
 
                                                         <link linkend="icaltimezone">icaltimezone</link> *zone,
1383
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
1380
<indexterm zone="e-cal-set-default-timezone"><primary>e_cal_set_default_timezone</primary></indexterm>
 
1381
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_set_default_timezone          (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
1382
                                                         <parameter><link linkend="icaltimezone"><type>icaltimezone</type></link> *zone</parameter>,
 
1383
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
1384
1384
<para>
1385
1385
Sets the default timezone on the calendar. This should be called before opening
1386
1386
the calendar.</para>
1387
 
<para>
1388
 
</para><variablelist role="params">
 
1387
<variablelist role="params">
1389
1388
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
1390
 
<listitem><simpara> A calendar client.
 
1389
<listitem><simpara>A calendar client.
1391
1390
</simpara></listitem></varlistentry>
1392
1391
<varlistentry><term><parameter>zone</parameter>&#160;:</term>
1393
 
<listitem><simpara> A timezone object.
 
1392
<listitem><simpara>A timezone object.
1394
1393
</simpara></listitem></varlistentry>
1395
1394
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1396
 
<listitem><simpara> Placeholder for error information.
 
1395
<listitem><simpara>Placeholder for error information.
1397
1396
</simpara></listitem></varlistentry>
1398
1397
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the operation was successful, FALSE otherwise.
1399
1398
</simpara></listitem></varlistentry>
1400
1399
</variablelist></refsect2>
1401
1400
<refsect2 id="e-cal-get-query" role="function">
1402
1401
<title>e_cal_get_query ()</title>
1403
 
<indexterm zone="e-cal-get-query"><primary sortas="e_cal_get_query">e_cal_get_query</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_get_query                     (<link linkend="ECal">ECal</link> *ecal,
1404
 
                                                         const <link linkend="gchar">gchar</link> *sexp,
1405
 
                                                         <link linkend="ECalView">ECalView</link> **query,
1406
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
1402
<indexterm zone="e-cal-get-query"><primary>e_cal_get_query</primary></indexterm>
 
1403
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_get_query                     (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
1404
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *sexp</parameter>,
 
1405
                                                         <parameter><link linkend="ECalView"><type>ECalView</type></link> **query</parameter>,
 
1406
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
1407
1407
<para>
1408
1408
Creates a live query object from a loaded calendar.</para>
1409
 
<para>
1410
 
</para><variablelist role="params">
 
1409
<variablelist role="params">
1411
1410
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
1412
 
<listitem><simpara> A calendar client.
 
1411
<listitem><simpara>A calendar client.
1413
1412
</simpara></listitem></varlistentry>
1414
1413
<varlistentry><term><parameter>sexp</parameter>&#160;:</term>
1415
 
<listitem><simpara> S-expression representing the query.
 
1414
<listitem><simpara>S-expression representing the query.
1416
1415
</simpara></listitem></varlistentry>
1417
1416
<varlistentry><term><parameter>query</parameter>&#160;:</term>
1418
 
<listitem><simpara> Return value for the new query.
 
1417
<listitem><simpara>Return value for the new query.
1419
1418
</simpara></listitem></varlistentry>
1420
1419
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1421
 
<listitem><simpara> Placeholder for error information.
 
1420
<listitem><simpara>Placeholder for error information.
1422
1421
</simpara></listitem></varlistentry>
1423
1422
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A query object that will emit notification signals as calendar
1424
1423
components are added and removed from the query in the server.
1426
1425
</variablelist></refsect2>
1427
1426
<refsect2 id="e-cal-resolve-tzid-cb" role="function">
1428
1427
<title>e_cal_resolve_tzid_cb ()</title>
1429
 
<indexterm zone="e-cal-resolve-tzid-cb"><primary sortas="e_cal_resolve_tzid_cb">e_cal_resolve_tzid_cb</primary></indexterm><programlisting><link linkend="icaltimezone">icaltimezone</link> *      e_cal_resolve_tzid_cb               (const <link linkend="gchar">gchar</link> *tzid,
1430
 
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
 
1428
<indexterm zone="e-cal-resolve-tzid-cb"><primary>e_cal_resolve_tzid_cb</primary></indexterm>
 
1429
<programlisting><link linkend="icaltimezone"><returnvalue>icaltimezone</returnvalue></link> *      e_cal_resolve_tzid_cb               (<parameter>const <link linkend="gchar"><type>gchar</type></link> *tzid</parameter>,
 
1430
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>);</programlisting>
1431
1431
<para>
1432
1432
Resolves TZIDs for the recurrence generator.</para>
1433
 
<para>
1434
 
</para><variablelist role="params">
 
1433
<variablelist role="params">
1435
1434
<varlistentry><term><parameter>tzid</parameter>&#160;:</term>
1436
 
<listitem><simpara> ID of the timezone to resolve.
 
1435
<listitem><simpara>ID of the timezone to resolve.
1437
1436
</simpara></listitem></varlistentry>
1438
1437
<varlistentry><term><parameter>data</parameter>&#160;:</term>
1439
 
<listitem><simpara> Closure data for the callback.
 
1438
<listitem><simpara>Closure data for the callback.
1440
1439
</simpara></listitem></varlistentry>
1441
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The timezone identified by the <parameter>tzid</parameter> argument, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if
 
1440
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The timezone identified by the <parameter>tzid</parameter> argument, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if
1442
1441
it could not be found.
1443
1442
</simpara></listitem></varlistentry>
1444
1443
</variablelist></refsect2>
1445
1444
<refsect2 id="e-cal-get-component-as-string" role="function">
1446
1445
<title>e_cal_get_component_as_string ()</title>
1447
 
<indexterm zone="e-cal-get-component-as-string"><primary sortas="e_cal_get_component_as_string">e_cal_get_component_as_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             e_cal_get_component_as_string       (<link linkend="ECal">ECal</link> *ecal,
1448
 
                                                         <link linkend="icalcomponent">icalcomponent</link> *icalcomp);</programlisting>
 
1446
<indexterm zone="e-cal-get-component-as-string"><primary>e_cal_get_component_as_string</primary></indexterm>
 
1447
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             e_cal_get_component_as_string       (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
1448
                                                         <parameter><link linkend="icalcomponent"><type>icalcomponent</type></link> *icalcomp</parameter>);</programlisting>
1449
1449
<para>
1450
1450
Gets a calendar component as an iCalendar string, with a toplevel
1451
1451
VCALENDAR component and all VTIMEZONEs needed for the component.</para>
1452
 
<para>
1453
 
</para><variablelist role="params">
 
1452
<variablelist role="params">
1454
1453
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
1455
 
<listitem><simpara> A calendar client.
 
1454
<listitem><simpara>A calendar client.
1456
1455
</simpara></listitem></varlistentry>
1457
1456
<varlistentry><term><parameter>icalcomp</parameter>&#160;:</term>
1458
 
<listitem><simpara> A calendar component object.
 
1457
<listitem><simpara>A calendar component object.
1459
1458
</simpara></listitem></varlistentry>
1460
1459
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the component as a complete iCalendar string, or NULL on
1461
1460
failure. The string should be freed after use.
1463
1462
</variablelist></refsect2>
1464
1463
<refsect2 id="e-cal-get-error-message" role="function">
1465
1464
<title>e_cal_get_error_message ()</title>
1466
 
<indexterm zone="e-cal-get-error-message"><primary sortas="e_cal_get_error_message">e_cal_get_error_message</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       e_cal_get_error_message             (<link linkend="ECalendarStatus">ECalendarStatus</link> status);</programlisting>
 
1465
<indexterm zone="e-cal-get-error-message"><primary>e_cal_get_error_message</primary></indexterm>
 
1466
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       e_cal_get_error_message             (<parameter><link linkend="ECalendarStatus"><type>ECalendarStatus</type></link> status</parameter>);</programlisting>
1467
1467
<para>
1468
1468
Gets an error message for the given status code.</para>
1469
 
<para>
1470
 
</para><variablelist role="params">
 
1469
<variablelist role="params">
1471
1470
<varlistentry><term><parameter>status</parameter>&#160;:</term>
1472
 
<listitem><simpara> A status code.
 
1471
<listitem><simpara>A status code.
1473
1472
</simpara></listitem></varlistentry>
1474
1473
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the error message.
1475
1474
</simpara></listitem></varlistentry>
1476
1475
</variablelist></refsect2>
1477
1476
<refsect2 id="e-cal-open-default" role="function">
1478
1477
<title>e_cal_open_default ()</title>
1479
 
<indexterm zone="e-cal-open-default"><primary sortas="e_cal_open_default">e_cal_open_default</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_open_default                  (<link linkend="ECal">ECal</link> **ecal,
1480
 
                                                         <link linkend="ECalSourceType">ECalSourceType</link> type,
1481
 
                                                         <link linkend="ECalAuthFunc">ECalAuthFunc</link> func,
1482
 
                                                         <link linkend="gpointer">gpointer</link> data,
1483
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
1478
<indexterm zone="e-cal-open-default"><primary>e_cal_open_default</primary></indexterm>
 
1479
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_open_default                  (<parameter><link linkend="ECal"><type>ECal</type></link> **ecal</parameter>,
 
1480
                                                         <parameter><link linkend="ECalSourceType"><type>ECalSourceType</type></link> type</parameter>,
 
1481
                                                         <parameter><link linkend="ECalAuthFunc"><type>ECalAuthFunc</type></link> func</parameter>,
 
1482
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>,
 
1483
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
1484
1484
<para>
1485
1485
Opens the default calendar.</para>
1486
 
<para>
1487
 
</para><variablelist role="params">
 
1486
<variablelist role="params">
1488
1487
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
1489
 
<listitem><simpara> A calendar client.
 
1488
<listitem><simpara>A calendar client.
1490
1489
</simpara></listitem></varlistentry>
1491
1490
<varlistentry><term><parameter>type</parameter>&#160;:</term>
1492
 
<listitem><simpara> Type of the calendar.
 
1491
<listitem><simpara>Type of the calendar.
1493
1492
</simpara></listitem></varlistentry>
1494
1493
<varlistentry><term><parameter>func</parameter>&#160;:</term>
1495
 
<listitem><simpara> Authentication function.
 
1494
<listitem><simpara>Authentication function.
1496
1495
</simpara></listitem></varlistentry>
1497
1496
<varlistentry><term><parameter>data</parameter>&#160;:</term>
1498
 
<listitem><simpara> Closure data for the authentication function.
 
1497
<listitem><simpara>Closure data for the authentication function.
1499
1498
</simpara></listitem></varlistentry>
1500
1499
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1501
 
<listitem><simpara> Placeholder for error information.
 
1500
<listitem><simpara>Placeholder for error information.
1502
1501
</simpara></listitem></varlistentry>
1503
1502
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if it opened correctly, FALSE otherwise.
1504
1503
</simpara></listitem></varlistentry>
1505
1504
</variablelist></refsect2>
1506
1505
<refsect2 id="e-cal-set-default" role="function">
1507
1506
<title>e_cal_set_default ()</title>
1508
 
<indexterm zone="e-cal-set-default"><primary sortas="e_cal_set_default">e_cal_set_default</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_set_default                   (<link linkend="ECal">ECal</link> *ecal,
1509
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
1507
<indexterm zone="e-cal-set-default"><primary>e_cal_set_default</primary></indexterm>
 
1508
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_set_default                   (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
1509
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
1510
1510
<para>
1511
1511
Sets a calendar as the default one.</para>
1512
 
<para>
1513
 
</para><variablelist role="params">
 
1512
<variablelist role="params">
1514
1513
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
1515
 
<listitem><simpara> A calendar client.
 
1514
<listitem><simpara>A calendar client.
1516
1515
</simpara></listitem></varlistentry>
1517
1516
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1518
 
<listitem><simpara> Placeholder for error information.
 
1517
<listitem><simpara>Placeholder for error information.
1519
1518
</simpara></listitem></varlistentry>
1520
1519
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the operation was successful, FALSE otherwise.
1521
1520
</simpara></listitem></varlistentry>
1522
1521
</variablelist></refsect2>
1523
1522
<refsect2 id="e-cal-set-default-source" role="function">
1524
1523
<title>e_cal_set_default_source ()</title>
1525
 
<indexterm zone="e-cal-set-default-source"><primary sortas="e_cal_set_default_source">e_cal_set_default_source</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_set_default_source            (<link linkend="ESource">ESource</link> *source,
1526
 
                                                         <link linkend="ECalSourceType">ECalSourceType</link> type,
1527
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
1524
<indexterm zone="e-cal-set-default-source"><primary>e_cal_set_default_source</primary></indexterm>
 
1525
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_set_default_source            (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
 
1526
                                                         <parameter><link linkend="ECalSourceType"><type>ECalSourceType</type></link> type</parameter>,
 
1527
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
1528
1528
<para>
1529
1529
Sets the default source for the specified <parameter>type</parameter>.</para>
1530
 
<para>
1531
 
</para><variablelist role="params">
 
1530
<variablelist role="params">
1532
1531
<varlistentry><term><parameter>source</parameter>&#160;:</term>
1533
 
<listitem><simpara> An <link linkend="ESource"><type>ESource</type></link>.
 
1532
<listitem><simpara>An <link linkend="ESource"><type>ESource</type></link>.
1534
1533
</simpara></listitem></varlistentry>
1535
1534
<varlistentry><term><parameter>type</parameter>&#160;:</term>
1536
 
<listitem><simpara> Type of the source.
 
1535
<listitem><simpara>Type of the source.
1537
1536
</simpara></listitem></varlistentry>
1538
1537
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1539
 
<listitem><simpara> Placeholder for error information.
 
1538
<listitem><simpara>Placeholder for error information.
1540
1539
</simpara></listitem></varlistentry>
1541
1540
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the operation was successful, FALSE otherwise.
1542
1541
</simpara></listitem></varlistentry>
1543
1542
</variablelist></refsect2>
1544
1543
<refsect2 id="e-cal-get-sources" role="function">
1545
1544
<title>e_cal_get_sources ()</title>
1546
 
<indexterm zone="e-cal-get-sources"><primary sortas="e_cal_get_sources">e_cal_get_sources</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_get_sources                   (<link linkend="ESourceList">ESourceList</link> **sources,
1547
 
                                                         <link linkend="ECalSourceType">ECalSourceType</link> type,
1548
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
1545
<indexterm zone="e-cal-get-sources"><primary>e_cal_get_sources</primary></indexterm>
 
1546
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_get_sources                   (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> **sources</parameter>,
 
1547
                                                         <parameter><link linkend="ECalSourceType"><type>ECalSourceType</type></link> type</parameter>,
 
1548
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
1549
1549
<para>
1550
1550
Gets the list of sources defined in the configuration for the given <parameter>type</parameter>.</para>
1551
 
<para>
1552
 
</para><variablelist role="params">
 
1551
<variablelist role="params">
1553
1552
<varlistentry><term><parameter>sources</parameter>&#160;:</term>
1554
 
<listitem><simpara> Return value for list of sources.
 
1553
<listitem><simpara>Return value for list of sources.
1555
1554
</simpara></listitem></varlistentry>
1556
1555
<varlistentry><term><parameter>type</parameter>&#160;:</term>
1557
 
<listitem><simpara> Type of the sources to get.
 
1556
<listitem><simpara>Type of the sources to get.
1558
1557
</simpara></listitem></varlistentry>
1559
1558
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1560
 
<listitem><simpara> Placeholder for error information.
 
1559
<listitem><simpara>Placeholder for error information.
1561
1560
</simpara></listitem></varlistentry>
1562
1561
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the operation was successful, FALSE otherwise.
1563
1562
</simpara></listitem></varlistentry>
1564
1563
</variablelist></refsect2>
1565
1564
<refsect2 id="e-cal-get-local-attachment-store" role="function">
1566
1565
<title>e_cal_get_local_attachment_store ()</title>
1567
 
<indexterm zone="e-cal-get-local-attachment-store"><primary sortas="e_cal_get_local_attachment_store">e_cal_get_local_attachment_store</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       e_cal_get_local_attachment_store    (<link linkend="ECal">ECal</link> *ecal);</programlisting>
 
1566
<indexterm zone="e-cal-get-local-attachment-store"><primary>e_cal_get_local_attachment_store</primary></indexterm>
 
1567
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       e_cal_get_local_attachment_store    (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>);</programlisting>
1568
1568
<para>
1569
1569
Queries the URL where the calendar attachments are
1570
1570
serialized in the local filesystem. This enable clients
1571
1571
to operate with the reference to attachments rather than the data itself
1572
1572
unless it specifically uses the attachments for open/sending
1573
1573
operations.</para>
1574
 
<para>
1575
 
</para><variablelist role="params">
 
1574
<variablelist role="params">
1576
1575
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
1577
 
<listitem><simpara> A calendar client.
 
1576
<listitem><simpara>A calendar client.
1578
1577
</simpara></listitem></varlistentry>
1579
1578
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The URL where the attachments are serialized in the
1580
1579
local filesystem.
1582
1581
</variablelist></refsect2>
1583
1582
<refsect2 id="e-cal-get-recurrences-no-master" role="function">
1584
1583
<title>e_cal_get_recurrences_no_master ()</title>
1585
 
<indexterm zone="e-cal-get-recurrences-no-master"><primary sortas="e_cal_get_recurrences_no_master">e_cal_get_recurrences_no_master</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_get_recurrences_no_master     (<link linkend="ECal">ECal</link> *ecal);</programlisting>
 
1584
<indexterm zone="e-cal-get-recurrences-no-master"><primary>e_cal_get_recurrences_no_master</primary></indexterm>
 
1585
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_get_recurrences_no_master     (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>);</programlisting>
1586
1586
<para>
1587
1587
Checks if the calendar has a master object for recurrences.</para>
1588
 
<para>
1589
 
</para><variablelist role="params">
 
1588
<variablelist role="params">
1590
1589
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
1591
 
<listitem><simpara> A calendar client.
 
1590
<listitem><simpara>A calendar client.
1592
1591
</simpara></listitem></varlistentry>
1593
1592
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the calendar has a master object for recurrences,
1594
1593
FALSE otherwise.
1596
1595
</variablelist></refsect2>
1597
1596
<refsect2 id="e-cal-get-attachments-for-comp" role="function">
1598
1597
<title>e_cal_get_attachments_for_comp ()</title>
1599
 
<indexterm zone="e-cal-get-attachments-for-comp"><primary sortas="e_cal_get_attachments_for_comp">e_cal_get_attachments_for_comp</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_get_attachments_for_comp      (<link linkend="ECal">ECal</link> *ecal,
1600
 
                                                         const <link linkend="gchar">gchar</link> *uid,
1601
 
                                                         const <link linkend="gchar">gchar</link> *rid,
1602
 
                                                         <link linkend="GSList">GSList</link> **list,
1603
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
 
1598
<indexterm zone="e-cal-get-attachments-for-comp"><primary>e_cal_get_attachments_for_comp</primary></indexterm>
 
1599
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_cal_get_attachments_for_comp      (<parameter><link linkend="ECal"><type>ECal</type></link> *ecal</parameter>,
 
1600
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>,
 
1601
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *rid</parameter>,
 
1602
                                                         <parameter><link linkend="GSList"><type>GSList</type></link> **list</parameter>,
 
1603
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
1604
1604
<para>
1605
1605
Queries a calendar for a calendar component object based on its unique
1606
1606
identifier and gets the attachments for the component.</para>
1607
 
<para>
1608
 
</para><variablelist role="params">
 
1607
<variablelist role="params">
1609
1608
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
1610
 
<listitem><simpara> A calendar client.
 
1609
<listitem><simpara>A calendar client.
1611
1610
</simpara></listitem></varlistentry>
1612
1611
<varlistentry><term><parameter>uid</parameter>&#160;:</term>
1613
 
<listitem><simpara> Unique identifier for a calendar component.
 
1612
<listitem><simpara>Unique identifier for a calendar component.
1614
1613
</simpara></listitem></varlistentry>
1615
1614
<varlistentry><term><parameter>rid</parameter>&#160;:</term>
1616
 
<listitem><simpara> Recurrence identifier.
 
1615
<listitem><simpara>Recurrence identifier.
1617
1616
</simpara></listitem></varlistentry>
1618
1617
<varlistentry><term><parameter>list</parameter>&#160;:</term>
1619
 
<listitem><simpara> Return the list of attachment uris.
 
1618
<listitem><simpara>Return the list of attachment uris.
1620
1619
</simpara></listitem></varlistentry>
1621
1620
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1622
 
<listitem><simpara> Placeholder for error information.
 
1621
<listitem><simpara>Placeholder for error information.
1623
1622
</simpara></listitem></varlistentry>
1624
1623
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the call was successful, FALSE otherwise.
1625
1624
</simpara></listitem></varlistentry>
1626
1625
</variablelist></refsect2>
1627
1626
 
1628
1627
</refsect1>
1629
 
 
1630
1628
<refsect1 id="ECal.signal-details" role="signals">
1631
1629
<title role="signals.title">Signal Details</title>
1632
1630
<refsect2 id="ECal-backend-died" role="signal"><title>The <literal>&quot;backend-died&quot;</literal> signal</title>
1633
 
<indexterm zone="ECal-backend-died"><primary sortas="ECal::backend-died">ECal::backend-died</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="ECal">ECal</link>    *ecal,
1634
 
                                                        <link linkend="gpointer">gpointer</link> user_data)      : Run First</programlisting>
 
1631
<indexterm zone="ECal-backend-died"><primary>ECal::backend-died</primary></indexterm>
 
1632
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="ECal"><type>ECal</type></link>    *ecal,
 
1633
                                                        <link linkend="gpointer"><type>gpointer</type></link> user_data)      : Run First</programlisting>
1635
1634
<para>
1636
1635
</para><variablelist role="params">
1637
1636
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
1640
1639
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
1641
1640
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
1642
1641
</variablelist></refsect2><refsect2 id="ECal-backend-error" role="signal"><title>The <literal>&quot;backend-error&quot;</literal> signal</title>
1643
 
<indexterm zone="ECal-backend-error"><primary sortas="ECal::backend-error">ECal::backend-error</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="ECal">ECal</link>    *ecal,
1644
 
                                                        <link linkend="gchar">gchar</link>   *arg1,
1645
 
                                                        <link linkend="gpointer">gpointer</link> user_data)      : Run First</programlisting>
 
1642
<indexterm zone="ECal-backend-error"><primary>ECal::backend-error</primary></indexterm>
 
1643
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="ECal"><type>ECal</type></link>    *ecal,
 
1644
                                                        <link linkend="gchar"><type>gchar</type></link>   *arg1,
 
1645
                                                        <link linkend="gpointer"><type>gpointer</type></link> user_data)      : Run First</programlisting>
1646
1646
<para>
1647
1647
</para><variablelist role="params">
1648
1648
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
1654
1654
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
1655
1655
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
1656
1656
</variablelist></refsect2><refsect2 id="ECal-cal-opened" role="signal"><title>The <literal>&quot;cal-opened&quot;</literal> signal</title>
1657
 
<indexterm zone="ECal-cal-opened"><primary sortas="ECal::cal-opened">ECal::cal-opened</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="ECal">ECal</link>    *ecal,
1658
 
                                                        <link linkend="gint">gint</link>     arg1,
1659
 
                                                        <link linkend="gpointer">gpointer</link> user_data)      : Run First</programlisting>
 
1657
<indexterm zone="ECal-cal-opened"><primary>ECal::cal-opened</primary></indexterm>
 
1658
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="ECal"><type>ECal</type></link>    *ecal,
 
1659
                                                        <link linkend="gint"><type>gint</type></link>     arg1,
 
1660
                                                        <link linkend="gpointer"><type>gpointer</type></link> user_data)      : Run First</programlisting>
1660
1661
<para>
1661
1662
</para><variablelist role="params">
1662
1663
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
1668
1669
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
1669
1670
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
1670
1671
</variablelist></refsect2><refsect2 id="ECal-cal-set-mode" role="signal"><title>The <literal>&quot;cal-set-mode&quot;</literal> signal</title>
1671
 
<indexterm zone="ECal-cal-set-mode"><primary sortas="ECal::cal-set-mode">ECal::cal-set-mode</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="ECal">ECal</link>                 *ecal,
1672
 
                                                        <link linkend="ECalSetModeStatusEnum">ECalSetModeStatusEnum</link> arg1,
1673
 
                                                        <link linkend="CalModeEnum">CalModeEnum</link>           arg2,
1674
 
                                                        <link linkend="gpointer">gpointer</link>              user_data)      : Run First</programlisting>
 
1672
<indexterm zone="ECal-cal-set-mode"><primary>ECal::cal-set-mode</primary></indexterm>
 
1673
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="ECal"><type>ECal</type></link>                 *ecal,
 
1674
                                                        <link linkend="ECalSetModeStatusEnum"><type>ECalSetModeStatusEnum</type></link> arg1,
 
1675
                                                        <link linkend="CalModeEnum"><type>CalModeEnum</type></link>           arg2,
 
1676
                                                        <link linkend="gpointer"><type>gpointer</type></link>              user_data)      : Run First</programlisting>
1675
1677
<para>
1676
1678
</para><variablelist role="params">
1677
1679
<varlistentry><term><parameter>ecal</parameter>&#160;:</term>
1687
1689
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
1688
1690
</variablelist></refsect2>
1689
1691
</refsect1>
1690
 
 
1691
 
 
1692
1692
<refsect1 id="ECal.see-also">
1693
1693
<title>See Also</title>
1694
1694
<para>