← Back to branch summary

~ubuntu-branches/ubuntu/natty/evolution-data-server/natty

« back to all changes in this revision

Viewing changes to docs/reference/libedataserver/xml/e-list.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/libedataserver/xml/e-list.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="EList">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="EList.top_of_page">EList</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>
9
 
  LIBEDATASERVER Library
10
 
</refmiscinfo>
11
 
</refmeta>
12
 
<refnamediv>
13
 
<refname>EList</refname>
14
 
<refpurpose></refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="EList.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>                    <link linkend="EList-struct">EList</link>;
21
 
<link linkend="gpointer"><returnvalue>gpointer</returnvalue></link>            (<link linkend="EListCopyFunc">*EListCopyFunc</link>)                    (<parameter><link linkend="gconstpointer"><type>gconstpointer</type></link> data</parameter>,
22
 
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> closure</parameter>);
23
 
<link linkend="void"><returnvalue>void</returnvalue></link>                (<link linkend="EListFreeFunc">*EListFreeFunc</link>)                    (<parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>,
24
 
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> closure</parameter>);
25
 
<link linkend="EList"><returnvalue>EList</returnvalue></link> *             <link linkend="e-list-new">e_list_new</link>                          (<parameter><link linkend="EListCopyFunc"><type>EListCopyFunc</type></link> copy</parameter>,
26
 
                                                         <parameter><link linkend="EListFreeFunc"><type>EListFreeFunc</type></link> free</parameter>,
27
 
                                                         <parameter><link linkend="void"><type>void</type></link> *closure</parameter>);
28
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-list-construct">e_list_construct</link>                    (<parameter><link linkend="EList"><type>EList</type></link> *list</parameter>,
29
 
                                                         <parameter><link linkend="EListCopyFunc"><type>EListCopyFunc</type></link> copy</parameter>,
30
 
                                                         <parameter><link linkend="EListFreeFunc"><type>EListFreeFunc</type></link> free</parameter>,
31
 
                                                         <parameter><link linkend="void"><type>void</type></link> *closure</parameter>);
32
 
<link linkend="EList"><returnvalue>EList</returnvalue></link> *             <link linkend="e-list-duplicate">e_list_duplicate</link>                    (<parameter><link linkend="EList"><type>EList</type></link> *list</parameter>);
33
 
<link linkend="EIterator"><returnvalue>EIterator</returnvalue></link> *         <link linkend="e-list-get-iterator">e_list_get_iterator</link>                 (<parameter><link linkend="EList"><type>EList</type></link> *list</parameter>);
34
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-list-append">e_list_append</link>                       (<parameter><link linkend="EList"><type>EList</type></link> *list</parameter>,
35
 
                                                         <parameter>const <link linkend="void"><type>void</type></link> *data</parameter>);
36
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-list-remove">e_list_remove</link>                       (<parameter><link linkend="EList"><type>EList</type></link> *list</parameter>,
37
 
                                                         <parameter>const <link linkend="void"><type>void</type></link> *data</parameter>);
38
 
<link linkend="gint"><returnvalue>gint</returnvalue></link>                <link linkend="e-list-length">e_list_length</link>                       (<parameter><link linkend="EList"><type>EList</type></link> *list</parameter>);
39
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-list-remove-link">e_list_remove_link</link>                  (<parameter><link linkend="EList"><type>EList</type></link> *list</parameter>,
40
 
                                                         <parameter><link linkend="GList"><type>GList</type></link> *link</parameter>);
41
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-list-remove-iterator">e_list_remove_iterator</link>              (<parameter><link linkend="EList"><type>EList</type></link> *list</parameter>,
42
 
                                                         <parameter><link linkend="EIterator"><type>EIterator</type></link> *iterator</parameter>);
43
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-list-invalidate-iterators">e_list_invalidate_iterators</link>         (<parameter><link linkend="EList"><type>EList</type></link> *list</parameter>,
44
 
                                                         <parameter><link linkend="EIterator"><type>EIterator</type></link> *skip</parameter>);
45
 
</synopsis>
46
 
</refsynopsisdiv>
47
 
<refsect1 id="EList.object-hierarchy" role="object_hierarchy">
48
 
<title role="object_hierarchy.title">Object Hierarchy</title>
49
 
<synopsis>
50
 
  <link linkend="GObject">GObject</link>
51
 
   +----EList
52
 
         +----<link linkend="EAccountList">EAccountList</link>
53
 
</synopsis>
54
 
</refsect1>
55
 
 
56
 
<refsect1 id="EList.description" role="desc">
57
 
<title role="desc.title">Description</title>
58
 
<para>
59
 
</para>
60
 
</refsect1>
61
 
<refsect1 id="EList.details" role="details">
62
 
<title role="details.title">Details</title>
63
 
<refsect2 id="EList-struct" role="struct">
64
 
<title>EList</title>
65
 
<indexterm zone="EList-struct"><primary>EList</primary></indexterm>
66
 
<programlisting>typedef struct _EList EList;</programlisting>
67
 
<para>
68
 
</para></refsect2>
69
 
<refsect2 id="EListCopyFunc" role="function">
70
 
<title>EListCopyFunc ()</title>
71
 
<indexterm zone="EListCopyFunc"><primary>EListCopyFunc</primary></indexterm>
72
 
<programlisting><link linkend="gpointer"><returnvalue>gpointer</returnvalue></link>            (*EListCopyFunc)                    (<parameter><link linkend="gconstpointer"><type>gconstpointer</type></link> data</parameter>,
73
 
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> closure</parameter>);</programlisting>
74
 
<para>
75
 
</para><variablelist role="params">
76
 
<varlistentry><term><parameter>data</parameter>&#160;:</term>
77
 
<listitem><simpara>
78
 
</simpara></listitem></varlistentry>
79
 
<varlistentry><term><parameter>closure</parameter>&#160;:</term>
80
 
<listitem><simpara>
81
 
</simpara></listitem></varlistentry>
82
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
83
 
</simpara></listitem></varlistentry>
84
 
</variablelist></refsect2>
85
 
<refsect2 id="EListFreeFunc" role="function">
86
 
<title>EListFreeFunc ()</title>
87
 
<indexterm zone="EListFreeFunc"><primary>EListFreeFunc</primary></indexterm>
88
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                (*EListFreeFunc)                    (<parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>,
89
 
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> closure</parameter>);</programlisting>
90
 
<para>
91
 
</para><variablelist role="params">
92
 
<varlistentry><term><parameter>data</parameter>&#160;:</term>
93
 
<listitem><simpara>
94
 
</simpara></listitem></varlistentry>
95
 
<varlistentry><term><parameter>closure</parameter>&#160;:</term>
96
 
<listitem><simpara>
97
 
</simpara></listitem></varlistentry>
98
 
</variablelist></refsect2>
99
 
<refsect2 id="e-list-new" role="function">
100
 
<title>e_list_new ()</title>
101
 
<indexterm zone="e-list-new"><primary>e_list_new</primary></indexterm>
102
 
<programlisting><link linkend="EList"><returnvalue>EList</returnvalue></link> *             e_list_new                          (<parameter><link linkend="EListCopyFunc"><type>EListCopyFunc</type></link> copy</parameter>,
103
 
                                                         <parameter><link linkend="EListFreeFunc"><type>EListFreeFunc</type></link> free</parameter>,
104
 
                                                         <parameter><link linkend="void"><type>void</type></link> *closure</parameter>);</programlisting>
105
 
<para>
106
 
</para><variablelist role="params">
107
 
<varlistentry><term><parameter>copy</parameter>&#160;:</term>
108
 
<listitem><simpara>
109
 
</simpara></listitem></varlistentry>
110
 
<varlistentry><term><parameter>free</parameter>&#160;:</term>
111
 
<listitem><simpara>
112
 
</simpara></listitem></varlistentry>
113
 
<varlistentry><term><parameter>closure</parameter>&#160;:</term>
114
 
<listitem><simpara>
115
 
</simpara></listitem></varlistentry>
116
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
117
 
</simpara></listitem></varlistentry>
118
 
</variablelist></refsect2>
119
 
<refsect2 id="e-list-construct" role="function">
120
 
<title>e_list_construct ()</title>
121
 
<indexterm zone="e-list-construct"><primary>e_list_construct</primary></indexterm>
122
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_list_construct                    (<parameter><link linkend="EList"><type>EList</type></link> *list</parameter>,
123
 
                                                         <parameter><link linkend="EListCopyFunc"><type>EListCopyFunc</type></link> copy</parameter>,
124
 
                                                         <parameter><link linkend="EListFreeFunc"><type>EListFreeFunc</type></link> free</parameter>,
125
 
                                                         <parameter><link linkend="void"><type>void</type></link> *closure</parameter>);</programlisting>
126
 
<para>
127
 
</para><variablelist role="params">
128
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
129
 
<listitem><simpara>
130
 
</simpara></listitem></varlistentry>
131
 
<varlistentry><term><parameter>copy</parameter>&#160;:</term>
132
 
<listitem><simpara>
133
 
</simpara></listitem></varlistentry>
134
 
<varlistentry><term><parameter>free</parameter>&#160;:</term>
135
 
<listitem><simpara>
136
 
</simpara></listitem></varlistentry>
137
 
<varlistentry><term><parameter>closure</parameter>&#160;:</term>
138
 
<listitem><simpara>
139
 
</simpara></listitem></varlistentry>
140
 
</variablelist></refsect2>
141
 
<refsect2 id="e-list-duplicate" role="function">
142
 
<title>e_list_duplicate ()</title>
143
 
<indexterm zone="e-list-duplicate"><primary>e_list_duplicate</primary></indexterm>
144
 
<programlisting><link linkend="EList"><returnvalue>EList</returnvalue></link> *             e_list_duplicate                    (<parameter><link linkend="EList"><type>EList</type></link> *list</parameter>);</programlisting>
145
 
<para>
146
 
</para><variablelist role="params">
147
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
148
 
<listitem><simpara>
149
 
</simpara></listitem></varlistentry>
150
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
151
 
</simpara></listitem></varlistentry>
152
 
</variablelist></refsect2>
153
 
<refsect2 id="e-list-get-iterator" role="function">
154
 
<title>e_list_get_iterator ()</title>
155
 
<indexterm zone="e-list-get-iterator"><primary>e_list_get_iterator</primary></indexterm>
156
 
<programlisting><link linkend="EIterator"><returnvalue>EIterator</returnvalue></link> *         e_list_get_iterator                 (<parameter><link linkend="EList"><type>EList</type></link> *list</parameter>);</programlisting>
157
 
<para>
158
 
</para><variablelist role="params">
159
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
160
 
<listitem><simpara>
161
 
</simpara></listitem></varlistentry>
162
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
163
 
</simpara></listitem></varlistentry>
164
 
</variablelist></refsect2>
165
 
<refsect2 id="e-list-append" role="function">
166
 
<title>e_list_append ()</title>
167
 
<indexterm zone="e-list-append"><primary>e_list_append</primary></indexterm>
168
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_list_append                       (<parameter><link linkend="EList"><type>EList</type></link> *list</parameter>,
169
 
                                                         <parameter>const <link linkend="void"><type>void</type></link> *data</parameter>);</programlisting>
170
 
<para>
171
 
</para><variablelist role="params">
172
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
173
 
<listitem><simpara>
174
 
</simpara></listitem></varlistentry>
175
 
<varlistentry><term><parameter>data</parameter>&#160;:</term>
176
 
<listitem><simpara>
177
 
</simpara></listitem></varlistentry>
178
 
</variablelist></refsect2>
179
 
<refsect2 id="e-list-remove" role="function">
180
 
<title>e_list_remove ()</title>
181
 
<indexterm zone="e-list-remove"><primary>e_list_remove</primary></indexterm>
182
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_list_remove                       (<parameter><link linkend="EList"><type>EList</type></link> *list</parameter>,
183
 
                                                         <parameter>const <link linkend="void"><type>void</type></link> *data</parameter>);</programlisting>
184
 
<para>
185
 
</para><variablelist role="params">
186
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
187
 
<listitem><simpara>
188
 
</simpara></listitem></varlistentry>
189
 
<varlistentry><term><parameter>data</parameter>&#160;:</term>
190
 
<listitem><simpara>
191
 
</simpara></listitem></varlistentry>
192
 
</variablelist></refsect2>
193
 
<refsect2 id="e-list-length" role="function">
194
 
<title>e_list_length ()</title>
195
 
<indexterm zone="e-list-length"><primary>e_list_length</primary></indexterm>
196
 
<programlisting><link linkend="gint"><returnvalue>gint</returnvalue></link>                e_list_length                       (<parameter><link linkend="EList"><type>EList</type></link> *list</parameter>);</programlisting>
197
 
<para>
198
 
</para><variablelist role="params">
199
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
200
 
<listitem><simpara>
201
 
</simpara></listitem></varlistentry>
202
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
203
 
</simpara></listitem></varlistentry>
204
 
</variablelist></refsect2>
205
 
<refsect2 id="e-list-remove-link" role="function">
206
 
<title>e_list_remove_link ()</title>
207
 
<indexterm zone="e-list-remove-link"><primary>e_list_remove_link</primary></indexterm>
208
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_list_remove_link                  (<parameter><link linkend="EList"><type>EList</type></link> *list</parameter>,
209
 
                                                         <parameter><link linkend="GList"><type>GList</type></link> *link</parameter>);</programlisting>
210
 
<para>
211
 
</para><variablelist role="params">
212
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
213
 
<listitem><simpara>
214
 
</simpara></listitem></varlistentry>
215
 
<varlistentry><term><parameter>link</parameter>&#160;:</term>
216
 
<listitem><simpara>
217
 
</simpara></listitem></varlistentry>
218
 
</variablelist></refsect2>
219
 
<refsect2 id="e-list-remove-iterator" role="function">
220
 
<title>e_list_remove_iterator ()</title>
221
 
<indexterm zone="e-list-remove-iterator"><primary>e_list_remove_iterator</primary></indexterm>
222
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_list_remove_iterator              (<parameter><link linkend="EList"><type>EList</type></link> *list</parameter>,
223
 
                                                         <parameter><link linkend="EIterator"><type>EIterator</type></link> *iterator</parameter>);</programlisting>
224
 
<para>
225
 
</para><variablelist role="params">
226
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
227
 
<listitem><simpara>
228
 
</simpara></listitem></varlistentry>
229
 
<varlistentry><term><parameter>iterator</parameter>&#160;:</term>
230
 
<listitem><simpara>
231
 
</simpara></listitem></varlistentry>
232
 
</variablelist></refsect2>
233
 
<refsect2 id="e-list-invalidate-iterators" role="function">
234
 
<title>e_list_invalidate_iterators ()</title>
235
 
<indexterm zone="e-list-invalidate-iterators"><primary>e_list_invalidate_iterators</primary></indexterm>
236
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_list_invalidate_iterators         (<parameter><link linkend="EList"><type>EList</type></link> *list</parameter>,
237
 
                                                         <parameter><link linkend="EIterator"><type>EIterator</type></link> *skip</parameter>);</programlisting>
238
 
<para>
239
 
</para><variablelist role="params">
240
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
241
 
<listitem><simpara>
242
 
</simpara></listitem></varlistentry>
243
 
<varlistentry><term><parameter>skip</parameter>&#160;:</term>
244
 
<listitem><simpara>
245
 
</simpara></listitem></varlistentry>
246
 
</variablelist></refsect2>
247
 
 
248
 
</refsect1>
249
 
 
250
 
</refentry>