← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/calendar/libedata-cal/xml/e-data-cal-common.xml

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/calendar/libedata-cal/xml/e-data-cal-common.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
 
<refentry id="libedata-cal-e-data-cal-common">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="libedata-cal-e-data-cal-common.top_of_page">e-data-cal-common</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>
9
 
  LIBEDATA-CAL Library
10
 
</refmiscinfo>
11
 
</refmeta>
12
 
<refnamediv>
13
 
<refname>e-data-cal-common</refname>
14
 
<refpurpose></refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="libedata-cal-e-data-cal-common.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
<anchor id="ECalBackend"/><anchor id="EDataCal"/><anchor id="EDataCalView"/><anchor id="ECalBackendSExp"/>
20
 
<synopsis>                    <link linkend="ECalBackend-struct">ECalBackend</link>;
21
 
                    <link linkend="ECalBackendClass">ECalBackendClass</link>;
22
 
                    <link linkend="EDataCal-struct">EDataCal</link>;
23
 
                    <link linkend="EDataCalClass">EDataCalClass</link>;
24
 
                    <link linkend="EDataCalView-struct">EDataCalView</link>;
25
 
                    <link linkend="EDataCalViewClass">EDataCalViewClass</link>;
26
 
                    <link linkend="ECalBackendSExp-struct">ECalBackendSExp</link>;
27
 
                    <link linkend="ECalBackendSExpClass">ECalBackendSExpClass</link>;
28
 
</synopsis>
29
 
</refsynopsisdiv>
30
 
<refsect1 id="libedata-cal-e-data-cal-common.object-hierarchy" role="object_hierarchy">
31
 
<title role="object_hierarchy.title">Object Hierarchy</title>
32
 
<synopsis>
33
 
  <link linkend="GObject">GObject</link>
34
 
   +----ECalBackend
35
 
         +----<link linkend="ECalBackendSync">ECalBackendSync</link>
36
 
</synopsis>
37
 
<synopsis>
38
 
  <link linkend="GObject">GObject</link>
39
 
   +----<link linkend="BonoboObject">BonoboObject</link>
40
 
         +----EDataCal
41
 
</synopsis>
42
 
<synopsis>
43
 
  <link linkend="GObject">GObject</link>
44
 
   +----<link linkend="BonoboObject">BonoboObject</link>
45
 
         +----EDataCalView
46
 
</synopsis>
47
 
<synopsis>
48
 
  <link linkend="GObject">GObject</link>
49
 
   +----ECalBackendSExp
50
 
</synopsis>
51
 
</refsect1>
52
 
<refsect1 id="libedata-cal-e-data-cal-common.properties" role="properties">
53
 
<title role="properties.title">Properties</title>
54
 
<synopsis>
55
 
  &quot;<link linkend="ECalBackend--kind">kind</link>&quot;                     <link linkend="gulong"><type>gulong</type></link>                : Read / Write / Construct Only
56
 
  &quot;<link linkend="ECalBackend--source">source</link>&quot;                   <link linkend="ESource"><type>ESource</type></link>*              : Read / Write / Construct Only
57
 
  &quot;<link linkend="ECalBackend--uri">uri</link>&quot;                      <link linkend="gchar"><type>gchar</type></link>*                : Read / Write / Construct Only
58
 
  &quot;<link linkend="EDataCalView--backend">backend</link>&quot;                  <link linkend="ECalBackend"><type>ECalBackend</type></link>*          : Read / Write / Construct Only
59
 
  &quot;<link linkend="EDataCalView--listener">listener</link>&quot;                 <link linkend="gpointer"><type>gpointer</type></link>              : Read / Write / Construct Only
60
 
  &quot;<link linkend="EDataCalView--sexp">sexp</link>&quot;                     <link linkend="ECalBackendSExp"><type>ECalBackendSExp</type></link>*      : Read / Write / Construct Only
61
 
</synopsis>
62
 
</refsect1>
63
 
<refsect1 id="libedata-cal-e-data-cal-common.signals" role="signal_proto">
64
 
<title role="signal_proto.title">Signals</title>
65
 
<synopsis>
66
 
  &quot;<link linkend="ECalBackend-last-client-gone">last-client-gone</link>&quot;                               : Run First
67
 
  &quot;<link linkend="ECalBackend-opened">opened</link>&quot;                                         : Run First
68
 
  &quot;<link linkend="ECalBackend-removed">removed</link>&quot;                                        : Run First
69
 
  &quot;<link linkend="EDataCalView-last-listener-gone">last-listener-gone</link>&quot;                             : Run First
70
 
</synopsis>
71
 
</refsect1>
72
 
 
73
 
<refsect1 id="libedata-cal-e-data-cal-common.description" role="desc">
74
 
<title role="desc.title">Description</title>
75
 
<para>
76
 
</para>
77
 
</refsect1>
78
 
<refsect1 id="libedata-cal-e-data-cal-common.details" role="details">
79
 
<title role="details.title">Details</title>
80
 
<refsect2 id="ECalBackend-struct" role="struct">
81
 
<title>ECalBackend</title>
82
 
<indexterm zone="ECalBackend-struct"><primary>ECalBackend</primary></indexterm>
83
 
<programlisting>typedef struct _ECalBackend ECalBackend;</programlisting>
84
 
<para>
85
 
</para></refsect2>
86
 
<refsect2 id="ECalBackendClass" role="struct">
87
 
<title>ECalBackendClass</title>
88
 
<indexterm zone="ECalBackendClass"><primary>ECalBackendClass</primary></indexterm>
89
 
<programlisting>typedef struct {
90
 
        GObjectClass parent_class;
91
 
 
92
 
        /* Notification signals */
93
 
        void (* last_client_gone) (ECalBackend *backend);
94
 
        void (* cal_added) (ECalBackend *backend, EDataCal *cal);
95
 
 
96
 
        gboolean (* is_loaded) (ECalBackend *backend);
97
 
 
98
 
        /* FIXME What to pass back here */
99
 
        void (* opened) (ECalBackend *backend, gint status);
100
 
        void (* removed) (ECalBackend *backend, gint status);
101
 
        void (* obj_updated) (ECalBackend *backend, const gchar *uid);
102
 
 
103
 
        /* Virtual methods */
104
 
        void (* is_read_only) (ECalBackend *backend, EDataCal *cal);
105
 
        void (* get_cal_address) (ECalBackend *backend, EDataCal *cal);
106
 
        void (* get_alarm_email_address) (ECalBackend *backend, EDataCal *cal);
107
 
        void (* get_ldap_attribute) (ECalBackend *backend, EDataCal *cal);
108
 
        void (* get_static_capabilities) (ECalBackend *backend, EDataCal *cal);
109
 
 
110
 
        void (* open) (ECalBackend *backend, EDataCal *cal, gboolean only_if_exists, const gchar *username, const gchar *password);
111
 
        void (* remove) (ECalBackend *backend, EDataCal *cal);
112
 
 
113
 
        /* Object related virtual methods */
114
 
        void (* create_object) (ECalBackend *backend, EDataCal *cal, const gchar *calobj);
115
 
        void (* modify_object) (ECalBackend *backend, EDataCal *cal, const gchar *calobj, CalObjModType mod);
116
 
        void (* remove_object) (ECalBackend *backend, EDataCal *cal, const gchar *uid, const gchar *rid, CalObjModType mod);
117
 
 
118
 
        void (* discard_alarm) (ECalBackend *backend, EDataCal *cal, const gchar *uid, const gchar *auid);
119
 
 
120
 
        void (* receive_objects) (ECalBackend *backend, EDataCal *cal, const gchar *calobj);
121
 
        void (* send_objects) (ECalBackend *backend, EDataCal *cal, const gchar *calobj);
122
 
 
123
 
        void (* get_default_object) (ECalBackend *backend, EDataCal *cal);
124
 
        void (* get_object) (ECalBackend *backend, EDataCal *cal, const gchar *uid, const gchar *rid);
125
 
        void (* get_object_list) (ECalBackend *backend, EDataCal *cal, const gchar *sexp);
126
 
 
127
 
        void (* get_attachment_list) (ECalBackend *backend, EDataCal *cal, const gchar *uid, const gchar *rid);
128
 
 
129
 
        /* Timezone related virtual methods */
130
 
        void (* get_timezone) (ECalBackend *backend, EDataCal *cal, const gchar *tzid);
131
 
        void (* add_timezone) (ECalBackend *backend, EDataCal *cal, const gchar *object);
132
 
        void (* set_default_zone) (ECalBackend *backend, EDataCal *cal, const gchar *tzobj);
133
 
        void (* set_default_timezone) (ECalBackend *backend, EDataCal *cal, const gchar *tzid);
134
 
 
135
 
        void (* start_query) (ECalBackend *backend, EDataCalView *query);
136
 
 
137
 
        /* Mode relate virtual methods */
138
 
        CalMode (* get_mode) (ECalBackend *backend);
139
 
        void    (* set_mode) (ECalBackend *backend, CalMode mode);
140
 
 
141
 
        void (* get_free_busy) (ECalBackend *backend, EDataCal *cal, GList *users, time_t start, time_t end);
142
 
        void (* get_changes) (ECalBackend *backend, EDataCal *cal, const gchar *change_id);
143
 
 
144
 
        /* Internal methods for use only in the pcs */
145
 
        icaltimezone *(* internal_get_default_timezone) (ECalBackend *backend);
146
 
        icaltimezone *(* internal_get_timezone) (ECalBackend *backend, const gchar *tzid);
147
 
} ECalBackendClass;
148
 
</programlisting>
149
 
<para>
150
 
</para></refsect2>
151
 
<refsect2 id="EDataCal-struct" role="struct">
152
 
<title>EDataCal</title>
153
 
<indexterm zone="EDataCal-struct"><primary>EDataCal</primary></indexterm>
154
 
<programlisting>typedef struct _EDataCal EDataCal;</programlisting>
155
 
<para>
156
 
</para></refsect2>
157
 
<refsect2 id="EDataCalClass" role="struct">
158
 
<title>EDataCalClass</title>
159
 
<indexterm zone="EDataCalClass"><primary>EDataCalClass</primary></indexterm>
160
 
<programlisting>typedef struct {
161
 
        BonoboObjectClass parent_class;
162
 
 
163
 
        POA_GNOME_Evolution_Calendar_Cal__epv epv;
164
 
} EDataCalClass;
165
 
</programlisting>
166
 
<para>
167
 
</para></refsect2>
168
 
<refsect2 id="EDataCalView-struct" role="struct">
169
 
<title>EDataCalView</title>
170
 
<indexterm zone="EDataCalView-struct"><primary>EDataCalView</primary></indexterm>
171
 
<programlisting>typedef struct _EDataCalView EDataCalView;</programlisting>
172
 
<para>
173
 
</para></refsect2>
174
 
<refsect2 id="EDataCalViewClass" role="struct">
175
 
<title>EDataCalViewClass</title>
176
 
<indexterm zone="EDataCalViewClass"><primary>EDataCalViewClass</primary></indexterm>
177
 
<programlisting>typedef struct {
178
 
        BonoboObjectClass parent_class;
179
 
 
180
 
        POA_GNOME_Evolution_Calendar_CalView__epv epv;
181
 
 
182
 
        /* Notification signals */
183
 
        void (* last_listener_gone) (EDataCalView *query);
184
 
} EDataCalViewClass;
185
 
</programlisting>
186
 
<para>
187
 
</para></refsect2>
188
 
<refsect2 id="ECalBackendSExp-struct" role="struct">
189
 
<title>ECalBackendSExp</title>
190
 
<indexterm zone="ECalBackendSExp-struct"><primary>ECalBackendSExp</primary></indexterm>
191
 
<programlisting>typedef struct _ECalBackendSExp ECalBackendSExp;</programlisting>
192
 
<para>
193
 
</para></refsect2>
194
 
<refsect2 id="ECalBackendSExpClass" role="struct">
195
 
<title>ECalBackendSExpClass</title>
196
 
<indexterm zone="ECalBackendSExpClass"><primary>ECalBackendSExpClass</primary></indexterm>
197
 
<programlisting>typedef struct {
198
 
        GObjectClass parent_class;
199
 
} ECalBackendSExpClass;
200
 
</programlisting>
201
 
<para>
202
 
</para></refsect2>
203
 
 
204
 
</refsect1>
205
 
<refsect1 id="libedata-cal-e-data-cal-common.property-details" role="property_details">
206
 
<title role="property_details.title">Property Details</title>
207
 
<refsect2 id="ECalBackend--kind" role="property"><title>The <literal>&quot;kind&quot;</literal> property</title>
208
 
<indexterm zone="ECalBackend--kind"><primary>ECalBackend:kind</primary></indexterm>
209
 
<programlisting>  &quot;kind&quot;                     <link linkend="gulong"><type>gulong</type></link>                : Read / Write / Construct Only</programlisting>
210
 
<para></para><para>Allowed values: &lt;= 25</para>
211
 
</refsect2>
212
 
<refsect2 id="ECalBackend--source" role="property"><title>The <literal>&quot;source&quot;</literal> property</title>
213
 
<indexterm zone="ECalBackend--source"><primary>ECalBackend:source</primary></indexterm>
214
 
<programlisting>  &quot;source&quot;                   <link linkend="ESource"><type>ESource</type></link>*              : Read / Write / Construct Only</programlisting>
215
 
<para></para></refsect2>
216
 
<refsect2 id="ECalBackend--uri" role="property"><title>The <literal>&quot;uri&quot;</literal> property</title>
217
 
<indexterm zone="ECalBackend--uri"><primary>ECalBackend:uri</primary></indexterm>
218
 
<programlisting>  &quot;uri&quot;                      <link linkend="gchar"><type>gchar</type></link>*                : Read / Write / Construct Only</programlisting>
219
 
<para></para><para>Default value: ""</para>
220
 
</refsect2>
221
 
<refsect2 id="EDataCalView--backend" role="property"><title>The <literal>&quot;backend&quot;</literal> property</title>
222
 
<indexterm zone="EDataCalView--backend"><primary>EDataCalView:backend</primary></indexterm>
223
 
<programlisting>  &quot;backend&quot;                  <link linkend="ECalBackend"><type>ECalBackend</type></link>*          : Read / Write / Construct Only</programlisting>
224
 
<para></para></refsect2>
225
 
<refsect2 id="EDataCalView--listener" role="property"><title>The <literal>&quot;listener&quot;</literal> property</title>
226
 
<indexterm zone="EDataCalView--listener"><primary>EDataCalView:listener</primary></indexterm>
227
 
<programlisting>  &quot;listener&quot;                 <link linkend="gpointer"><type>gpointer</type></link>              : Read / Write / Construct Only</programlisting>
228
 
<para></para></refsect2>
229
 
<refsect2 id="EDataCalView--sexp" role="property"><title>The <literal>&quot;sexp&quot;</literal> property</title>
230
 
<indexterm zone="EDataCalView--sexp"><primary>EDataCalView:sexp</primary></indexterm>
231
 
<programlisting>  &quot;sexp&quot;                     <link linkend="ECalBackendSExp"><type>ECalBackendSExp</type></link>*      : Read / Write / Construct Only</programlisting>
232
 
<para></para></refsect2>
233
 
</refsect1>
234
 
<refsect1 id="libedata-cal-e-data-cal-common.signal-details" role="signals">
235
 
<title role="signals.title">Signal Details</title>
236
 
<refsect2 id="ECalBackend-last-client-gone" role="signal"><title>The <literal>&quot;last-client-gone&quot;</literal> signal</title>
237
 
<indexterm zone="ECalBackend-last-client-gone"><primary>ECalBackend::last-client-gone</primary></indexterm>
238
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="ECalBackend"><type>ECalBackend</type></link> *ecalbackend,
239
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>     user_data)        : Run First</programlisting>
240
 
<para>
241
 
</para><variablelist role="params">
242
 
<varlistentry><term><parameter>ecalbackend</parameter>&#160;:</term>
243
 
<listitem><simpara>the object which received the signal.
244
 
</simpara></listitem></varlistentry>
245
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
246
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
247
 
</variablelist></refsect2><refsect2 id="ECalBackend-opened" role="signal"><title>The <literal>&quot;opened&quot;</literal> signal</title>
248
 
<indexterm zone="ECalBackend-opened"><primary>ECalBackend::opened</primary></indexterm>
249
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="ECalBackend"><type>ECalBackend</type></link> *ecalbackend,
250
 
                                                        <link linkend="gint"><type>gint</type></link>         arg1,
251
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>     user_data)        : Run First</programlisting>
252
 
<para>
253
 
</para><variablelist role="params">
254
 
<varlistentry><term><parameter>ecalbackend</parameter>&#160;:</term>
255
 
<listitem><simpara>the object which received the signal.
256
 
</simpara></listitem></varlistentry>
257
 
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
258
 
<listitem><simpara>
259
 
</simpara></listitem></varlistentry>
260
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
261
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
262
 
</variablelist></refsect2><refsect2 id="ECalBackend-removed" role="signal"><title>The <literal>&quot;removed&quot;</literal> signal</title>
263
 
<indexterm zone="ECalBackend-removed"><primary>ECalBackend::removed</primary></indexterm>
264
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="ECalBackend"><type>ECalBackend</type></link> *ecalbackend,
265
 
                                                        <link linkend="gint"><type>gint</type></link>         arg1,
266
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>     user_data)        : Run First</programlisting>
267
 
<para>
268
 
</para><variablelist role="params">
269
 
<varlistentry><term><parameter>ecalbackend</parameter>&#160;:</term>
270
 
<listitem><simpara>the object which received the signal.
271
 
</simpara></listitem></varlistentry>
272
 
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
273
 
<listitem><simpara>
274
 
</simpara></listitem></varlistentry>
275
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
276
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
277
 
</variablelist></refsect2><refsect2 id="EDataCalView-last-listener-gone" role="signal"><title>The <literal>&quot;last-listener-gone&quot;</literal> signal</title>
278
 
<indexterm zone="EDataCalView-last-listener-gone"><primary>EDataCalView::last-listener-gone</primary></indexterm>
279
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="EDataCalView"><type>EDataCalView</type></link> *edatacalview,
280
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>      user_data)         : Run First</programlisting>
281
 
<para>
282
 
</para><variablelist role="params">
283
 
<varlistentry><term><parameter>edatacalview</parameter>&#160;:</term>
284
 
<listitem><simpara>the object which received the signal.
285
 
</simpara></listitem></varlistentry>
286
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
287
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
288
 
</variablelist></refsect2>
289
 
</refsect1>
290
 
 
291
 
</refentry>