blob: e29fd8811f462addc415ebfb0ff54a0d487b892a (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
|
<!-- ##### SECTION Title ##### -->
CalClient
<!-- ##### SECTION Short_Description ##### -->
GTK+ object for communication with personal calendar server.
<!-- ##### SECTION Long_Description ##### -->
<para>
The #CalClient object provides a nice GTK+ wrapper for the CORBA
interfaces that are used to communicate between calendar clients
and the personal calendar server in the user's Wombat daemon. The
CORBA interfaces transfer calendar components in RFC 2445 text
format; the #CalClient object automatically converts these into
#CalComponent structures that are easier to handle.
</para>
<para>
After a #CalClient object is created with cal_client_new(), it
should be asked to send a request to the personal calendar server
to load or create a calendar based on its URI. The server will
asynchronously notify the client about completion of the request,
and will return an appropriate result code; this should be noted
by the client with the <link
linkend="CalClient--cal-loaded">cal_loaded</link> signal.
</para>
<para>
When a client asks the server to update or delete a calendar
component from the storage, the server will do so and then notify
all the clients about the update or removal. This is the core of
the model/view split between calendar clients and the storage in
the personal calendar server. Clients should watch the <link
linkend="calclient-obj-updated">obj_updated</link> and <link
linkend="calclient-obj-removed">obj_removed</link> signals on the
CalClient objects they create so that they can be notified about
changes in the storage.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#CalComponent
</para>
<!-- ##### MACRO CAL_CLIENT ##### -->
<para>
Casts a #GtkObject to a #CalClient.
</para>
@obj: A GTK+ object.
<!-- ##### ENUM CalClientOpenStatus ##### -->
<para>
</para>
@CAL_CLIENT_OPEN_SUCCESS:
@CAL_CLIENT_OPEN_ERROR:
@CAL_CLIENT_OPEN_NOT_FOUND:
@CAL_CLIENT_OPEN_METHOD_NOT_SUPPORTED:
<!-- ##### ENUM CalClientGetStatus ##### -->
<para>
These values describe the result of the cal_client_get_object()
function.
</para>
@CAL_CLIENT_GET_SUCCESS:
@CAL_CLIENT_GET_NOT_FOUND:
@CAL_CLIENT_GET_SYNTAX_ERROR:
<!-- ##### ENUM CalClientLoadState ##### -->
<para>
</para>
@CAL_CLIENT_LOAD_NOT_LOADED:
@CAL_CLIENT_LOAD_LOADING:
@CAL_CLIENT_LOAD_LOADED:
<!-- ##### ENUM CalClientChangeType ##### -->
<para>
</para>
@CAL_CLIENT_CHANGE_ADDED:
@CAL_CLIENT_CHANGE_MODIFIED:
@CAL_CLIENT_CHANGE_DELETED:
<!-- ##### FUNCTION cal_client_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION cal_client_open_calendar ##### -->
<para>
</para>
@client:
@str_uri:
@only_if_exists:
@Returns:
<!-- ##### FUNCTION cal_client_get_load_state ##### -->
<para>
</para>
@client:
@Returns:
<!-- ##### FUNCTION cal_client_get_uri ##### -->
<para>
</para>
@client:
@Returns:
<!-- ##### FUNCTION cal_client_get_n_objects ##### -->
<para>
</para>
@client:
@type:
@Returns:
<!-- ##### FUNCTION cal_client_get_uids ##### -->
<para>
</para>
@client:
@type:
@Returns:
<!-- ##### FUNCTION cal_client_get_object ##### -->
<para>
</para>
@client:
@uid:
@comp:
@Returns:
<!-- # Unused Parameters # -->
@ico:
<!-- ##### FUNCTION cal_client_get_changes ##### -->
<para>
</para>
@client:
@type:
@change_id:
@Returns:
<!-- ##### FUNCTION cal_client_change_list_free ##### -->
<para>
</para>
@list:
<!-- ##### FUNCTION cal_client_get_objects_in_range ##### -->
<para>
</para>
@client:
@type:
@start:
@end:
@Returns:
<!-- ##### FUNCTION cal_client_generate_instances ##### -->
<para>
</para>
@client:
@type:
@start:
@end:
@cb:
@cb_data:
<!-- ##### FUNCTION cal_client_get_alarms_in_range ##### -->
<para>
</para>
@client:
@start:
@end:
@Returns:
<!-- ##### FUNCTION cal_client_free_alarms ##### -->
<para>
</para>
@comp_alarms:
<!-- ##### FUNCTION cal_client_get_alarms_for_object ##### -->
<para>
</para>
@client:
@uid:
@start:
@end:
@alarms:
@Returns:
<!-- ##### FUNCTION cal_client_update_object ##### -->
<para>
</para>
@client:
@comp:
@Returns:
<!-- # Unused Parameters # -->
@ico:
<!-- ##### FUNCTION cal_client_remove_object ##### -->
<para>
</para>
@client:
@uid:
@Returns:
|
