← 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/libedataserver/xml/e-source-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-source-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="ESourceList">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="ESourceList.top_of_page">ESourceList</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>
9
 
  LIBEDATASERVER Library
10
 
</refmiscinfo>
11
 
</refmeta>
12
 
<refnamediv>
13
 
<refname>ESourceList</refname>
14
 
<refpurpose></refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="ESourceList.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>                    <link linkend="ESourceList-struct">ESourceList</link>;
21
 
<link linkend="ESourceList"><returnvalue>ESourceList</returnvalue></link> *       <link linkend="e-source-list-new">e_source_list_new</link>                   (<parameter><type>void</type></parameter>);
22
 
<link linkend="ESourceList"><returnvalue>ESourceList</returnvalue></link> *       <link linkend="e-source-list-new-for-gconf">e_source_list_new_for_gconf</link>         (<parameter><link linkend="GConfClient"><type>GConfClient</type></link> *client</parameter>,
23
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *path</parameter>);
24
 
<link linkend="ESourceList"><returnvalue>ESourceList</returnvalue></link> *       <link linkend="e-source-list-new-for-gconf-default">e_source_list_new_for_gconf_default</link> (<parameter>const <link linkend="gchar"><type>gchar</type></link> *path</parameter>);
25
 
<link linkend="GSList"><returnvalue>GSList</returnvalue></link> *            <link linkend="e-source-list-peek-groups">e_source_list_peek_groups</link>           (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>);
26
 
<link linkend="ESourceGroup"><returnvalue>ESourceGroup</returnvalue></link> *      <link linkend="e-source-list-peek-group-by-uid">e_source_list_peek_group_by_uid</link>     (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>,
27
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>);
28
 
<link linkend="ESourceGroup"><returnvalue>ESourceGroup</returnvalue></link> *      <link linkend="e-source-list-peek-group-by-name">e_source_list_peek_group_by_name</link>    (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>,
29
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>);
30
 
<link linkend="ESourceGroup"><returnvalue>ESourceGroup</returnvalue></link> *      <link linkend="e-source-list-peek-group-by-base-uri">e_source_list_peek_group_by_base_uri</link>
31
 
                                                        (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>,
32
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *base_uri</parameter>);
33
 
<link linkend="ESourceGroup"><returnvalue>ESourceGroup</returnvalue></link> *      <link linkend="e-source-list-peek-group-by-properties">e_source_list_peek_group_by_properties</link>
34
 
                                                        (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>,
35
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *property_name</parameter>,
36
 
                                                         <parameter>...</parameter>);
37
 
<link linkend="ESource"><returnvalue>ESource</returnvalue></link> *           <link linkend="e-source-list-peek-source-by-uid">e_source_list_peek_source_by_uid</link>    (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>,
38
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>);
39
 
<link linkend="ESource"><returnvalue>ESource</returnvalue></link> *           <link linkend="e-source-list-peek-source-any">e_source_list_peek_source_any</link>       (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>);
40
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-source-list-add-group">e_source_list_add_group</link>             (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>,
41
 
                                                         <parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>,
42
 
                                                         <parameter><link linkend="gint"><type>gint</type></link> position</parameter>);
43
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-source-list-remove-group">e_source_list_remove_group</link>          (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>,
44
 
                                                         <parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>);
45
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-source-list-remove-group-by-uid">e_source_list_remove_group_by_uid</link>   (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>,
46
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>);
47
 
<link linkend="ESourceGroup"><returnvalue>ESourceGroup</returnvalue></link> *      <link linkend="e-source-list-ensure-group">e_source_list_ensure_group</link>          (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>,
48
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>,
49
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *base_uri</parameter>,
50
 
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> ret_it</parameter>);
51
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-source-list-remove-group-by-base-uri">e_source_list_remove_group_by_base_uri</link>
52
 
                                                        (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>,
53
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *base_uri</parameter>);
54
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-source-list-remove-source-by-uid">e_source_list_remove_source_by_uid</link>  (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>,
55
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *uidj</parameter>);
56
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-source-list-sync">e_source_list_sync</link>                  (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>,
57
 
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);
58
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-source-list-is-gconf-updated">e_source_list_is_gconf_updated</link>      (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>);
59
 
</synopsis>
60
 
</refsynopsisdiv>
61
 
<refsect1 id="ESourceList.object-hierarchy" role="object_hierarchy">
62
 
<title role="object_hierarchy.title">Object Hierarchy</title>
63
 
<synopsis>
64
 
  <link linkend="GObject">GObject</link>
65
 
   +----ESourceList
66
 
</synopsis>
67
 
</refsect1>
68
 
<refsect1 id="ESourceList.signals" role="signal_proto">
69
 
<title role="signal_proto.title">Signals</title>
70
 
<synopsis>
71
 
  &quot;<link linkend="ESourceList-changed">changed</link>&quot;                                        : Run Last
72
 
  &quot;<link linkend="ESourceList-group-added">group-added</link>&quot;                                    : Run Last
73
 
  &quot;<link linkend="ESourceList-group-removed">group-removed</link>&quot;                                  : Run Last
74
 
</synopsis>
75
 
</refsect1>
76
 
 
77
 
<refsect1 id="ESourceList.description" role="desc">
78
 
<title role="desc.title">Description</title>
79
 
<para>
80
 
</para>
81
 
</refsect1>
82
 
<refsect1 id="ESourceList.details" role="details">
83
 
<title role="details.title">Details</title>
84
 
<refsect2 id="ESourceList-struct" role="struct">
85
 
<title>ESourceList</title>
86
 
<indexterm zone="ESourceList-struct"><primary>ESourceList</primary></indexterm>
87
 
<programlisting>typedef struct _ESourceList ESourceList;</programlisting>
88
 
<para>
89
 
</para></refsect2>
90
 
<refsect2 id="e-source-list-new" role="function">
91
 
<title>e_source_list_new ()</title>
92
 
<indexterm zone="e-source-list-new"><primary>e_source_list_new</primary></indexterm>
93
 
<programlisting><link linkend="ESourceList"><returnvalue>ESourceList</returnvalue></link> *       e_source_list_new                   (<parameter><type>void</type></parameter>);</programlisting>
94
 
<para>
95
 
</para><variablelist role="params">
96
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
97
 
</simpara></listitem></varlistentry>
98
 
</variablelist></refsect2>
99
 
<refsect2 id="e-source-list-new-for-gconf" role="function">
100
 
<title>e_source_list_new_for_gconf ()</title>
101
 
<indexterm zone="e-source-list-new-for-gconf"><primary>e_source_list_new_for_gconf</primary></indexterm>
102
 
<programlisting><link linkend="ESourceList"><returnvalue>ESourceList</returnvalue></link> *       e_source_list_new_for_gconf         (<parameter><link linkend="GConfClient"><type>GConfClient</type></link> *client</parameter>,
103
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *path</parameter>);</programlisting>
104
 
<para>
105
 
</para><variablelist role="params">
106
 
<varlistentry><term><parameter>client</parameter>&#160;:</term>
107
 
<listitem><simpara>
108
 
</simpara></listitem></varlistentry>
109
 
<varlistentry><term><parameter>path</parameter>&#160;:</term>
110
 
<listitem><simpara>
111
 
</simpara></listitem></varlistentry>
112
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
113
 
</simpara></listitem></varlistentry>
114
 
</variablelist></refsect2>
115
 
<refsect2 id="e-source-list-new-for-gconf-default" role="function">
116
 
<title>e_source_list_new_for_gconf_default ()</title>
117
 
<indexterm zone="e-source-list-new-for-gconf-default"><primary>e_source_list_new_for_gconf_default</primary></indexterm>
118
 
<programlisting><link linkend="ESourceList"><returnvalue>ESourceList</returnvalue></link> *       e_source_list_new_for_gconf_default (<parameter>const <link linkend="gchar"><type>gchar</type></link> *path</parameter>);</programlisting>
119
 
<para>
120
 
</para><variablelist role="params">
121
 
<varlistentry><term><parameter>path</parameter>&#160;:</term>
122
 
<listitem><simpara>
123
 
</simpara></listitem></varlistentry>
124
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
125
 
</simpara></listitem></varlistentry>
126
 
</variablelist></refsect2>
127
 
<refsect2 id="e-source-list-peek-groups" role="function">
128
 
<title>e_source_list_peek_groups ()</title>
129
 
<indexterm zone="e-source-list-peek-groups"><primary>e_source_list_peek_groups</primary></indexterm>
130
 
<programlisting><link linkend="GSList"><returnvalue>GSList</returnvalue></link> *            e_source_list_peek_groups           (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>);</programlisting>
131
 
<para>
132
 
</para><variablelist role="params">
133
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
134
 
<listitem><simpara>
135
 
</simpara></listitem></varlistentry>
136
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
137
 
</simpara></listitem></varlistentry>
138
 
</variablelist></refsect2>
139
 
<refsect2 id="e-source-list-peek-group-by-uid" role="function">
140
 
<title>e_source_list_peek_group_by_uid ()</title>
141
 
<indexterm zone="e-source-list-peek-group-by-uid"><primary>e_source_list_peek_group_by_uid</primary></indexterm>
142
 
<programlisting><link linkend="ESourceGroup"><returnvalue>ESourceGroup</returnvalue></link> *      e_source_list_peek_group_by_uid     (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>,
143
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>);</programlisting>
144
 
<para>
145
 
</para><variablelist role="params">
146
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
147
 
<listitem><simpara>
148
 
</simpara></listitem></varlistentry>
149
 
<varlistentry><term><parameter>uid</parameter>&#160;:</term>
150
 
<listitem><simpara>
151
 
</simpara></listitem></varlistentry>
152
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
153
 
</simpara></listitem></varlistentry>
154
 
</variablelist></refsect2>
155
 
<refsect2 id="e-source-list-peek-group-by-name" role="function" condition="deprecated:">
156
 
<title>e_source_list_peek_group_by_name ()</title>
157
 
<indexterm zone="e-source-list-peek-group-by-name" role="deprecated"><primary>e_source_list_peek_group_by_name</primary></indexterm>
158
 
<programlisting><link linkend="ESourceGroup"><returnvalue>ESourceGroup</returnvalue></link> *      e_source_list_peek_group_by_name    (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>,
159
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>);</programlisting>
160
 
<warning><para><literal>e_source_list_peek_group_by_name</literal> is deprecated and should not be used in newly-written code.</para></warning>
161
 
<para>
162
 
</para><variablelist role="params">
163
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
164
 
<listitem><simpara>
165
 
</simpara></listitem></varlistentry>
166
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
167
 
<listitem><simpara>
168
 
</simpara></listitem></varlistentry>
169
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
170
 
</simpara></listitem></varlistentry>
171
 
</variablelist></refsect2>
172
 
<refsect2 id="e-source-list-peek-group-by-base-uri" role="function">
173
 
<title>e_source_list_peek_group_by_base_uri ()</title>
174
 
<indexterm zone="e-source-list-peek-group-by-base-uri"><primary>e_source_list_peek_group_by_base_uri</primary></indexterm>
175
 
<programlisting><link linkend="ESourceGroup"><returnvalue>ESourceGroup</returnvalue></link> *      e_source_list_peek_group_by_base_uri
176
 
                                                        (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>,
177
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *base_uri</parameter>);</programlisting>
178
 
<variablelist role="params">
179
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
180
 
<listitem><simpara>
181
 
</simpara></listitem></varlistentry>
182
 
<varlistentry><term><parameter>base_uri</parameter>&#160;:</term>
183
 
<listitem><simpara>
184
 
</simpara></listitem></varlistentry>
185
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
186
 
</simpara></listitem></varlistentry>
187
 
</variablelist></refsect2>
188
 
<refsect2 id="e-source-list-peek-group-by-properties" role="function">
189
 
<title>e_source_list_peek_group_by_properties ()</title>
190
 
<indexterm zone="e-source-list-peek-group-by-properties"><primary>e_source_list_peek_group_by_properties</primary></indexterm>
191
 
<programlisting><link linkend="ESourceGroup"><returnvalue>ESourceGroup</returnvalue></link> *      e_source_list_peek_group_by_properties
192
 
                                                        (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>,
193
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *property_name</parameter>,
194
 
                                                         <parameter>...</parameter>);</programlisting>
195
 
<variablelist role="params">
196
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
197
 
<listitem><simpara>
198
 
</simpara></listitem></varlistentry>
199
 
<varlistentry><term><parameter>property_name</parameter>&#160;:</term>
200
 
<listitem><simpara>
201
 
</simpara></listitem></varlistentry>
202
 
<varlistentry><term><parameter>...</parameter>&#160;:</term>
203
 
<listitem><simpara>
204
 
</simpara></listitem></varlistentry>
205
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
206
 
</simpara></listitem></varlistentry>
207
 
</variablelist></refsect2>
208
 
<refsect2 id="e-source-list-peek-source-by-uid" role="function">
209
 
<title>e_source_list_peek_source_by_uid ()</title>
210
 
<indexterm zone="e-source-list-peek-source-by-uid"><primary>e_source_list_peek_source_by_uid</primary></indexterm>
211
 
<programlisting><link linkend="ESource"><returnvalue>ESource</returnvalue></link> *           e_source_list_peek_source_by_uid    (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>,
212
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>);</programlisting>
213
 
<para>
214
 
</para><variablelist role="params">
215
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
216
 
<listitem><simpara>
217
 
</simpara></listitem></varlistentry>
218
 
<varlistentry><term><parameter>uid</parameter>&#160;:</term>
219
 
<listitem><simpara>
220
 
</simpara></listitem></varlistentry>
221
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
222
 
</simpara></listitem></varlistentry>
223
 
</variablelist></refsect2>
224
 
<refsect2 id="e-source-list-peek-source-any" role="function">
225
 
<title>e_source_list_peek_source_any ()</title>
226
 
<indexterm zone="e-source-list-peek-source-any"><primary>e_source_list_peek_source_any</primary></indexterm>
227
 
<programlisting><link linkend="ESource"><returnvalue>ESource</returnvalue></link> *           e_source_list_peek_source_any       (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>);</programlisting>
228
 
<para>
229
 
</para><variablelist role="params">
230
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
231
 
<listitem><simpara>
232
 
</simpara></listitem></varlistentry>
233
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
234
 
</simpara></listitem></varlistentry>
235
 
</variablelist></refsect2>
236
 
<refsect2 id="e-source-list-add-group" role="function">
237
 
<title>e_source_list_add_group ()</title>
238
 
<indexterm zone="e-source-list-add-group"><primary>e_source_list_add_group</primary></indexterm>
239
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_source_list_add_group             (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>,
240
 
                                                         <parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>,
241
 
                                                         <parameter><link linkend="gint"><type>gint</type></link> position</parameter>);</programlisting>
242
 
<para>
243
 
</para><variablelist role="params">
244
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
245
 
<listitem><simpara>
246
 
</simpara></listitem></varlistentry>
247
 
<varlistentry><term><parameter>group</parameter>&#160;:</term>
248
 
<listitem><simpara>
249
 
</simpara></listitem></varlistentry>
250
 
<varlistentry><term><parameter>position</parameter>&#160;:</term>
251
 
<listitem><simpara>
252
 
</simpara></listitem></varlistentry>
253
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
254
 
</simpara></listitem></varlistentry>
255
 
</variablelist></refsect2>
256
 
<refsect2 id="e-source-list-remove-group" role="function">
257
 
<title>e_source_list_remove_group ()</title>
258
 
<indexterm zone="e-source-list-remove-group"><primary>e_source_list_remove_group</primary></indexterm>
259
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_source_list_remove_group          (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>,
260
 
                                                         <parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>);</programlisting>
261
 
<para>
262
 
</para><variablelist role="params">
263
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
264
 
<listitem><simpara>
265
 
</simpara></listitem></varlistentry>
266
 
<varlistentry><term><parameter>group</parameter>&#160;:</term>
267
 
<listitem><simpara>
268
 
</simpara></listitem></varlistentry>
269
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
270
 
</simpara></listitem></varlistentry>
271
 
</variablelist></refsect2>
272
 
<refsect2 id="e-source-list-remove-group-by-uid" role="function">
273
 
<title>e_source_list_remove_group_by_uid ()</title>
274
 
<indexterm zone="e-source-list-remove-group-by-uid"><primary>e_source_list_remove_group_by_uid</primary></indexterm>
275
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_source_list_remove_group_by_uid   (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>,
276
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>);</programlisting>
277
 
<para>
278
 
</para><variablelist role="params">
279
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
280
 
<listitem><simpara>
281
 
</simpara></listitem></varlistentry>
282
 
<varlistentry><term><parameter>uid</parameter>&#160;:</term>
283
 
<listitem><simpara>
284
 
</simpara></listitem></varlistentry>
285
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
286
 
</simpara></listitem></varlistentry>
287
 
</variablelist></refsect2>
288
 
<refsect2 id="e-source-list-ensure-group" role="function">
289
 
<title>e_source_list_ensure_group ()</title>
290
 
<indexterm zone="e-source-list-ensure-group"><primary>e_source_list_ensure_group</primary></indexterm>
291
 
<programlisting><link linkend="ESourceGroup"><returnvalue>ESourceGroup</returnvalue></link> *      e_source_list_ensure_group          (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>,
292
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>,
293
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *base_uri</parameter>,
294
 
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> ret_it</parameter>);</programlisting>
295
 
<variablelist role="params">
296
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
297
 
<listitem><simpara>
298
 
</simpara></listitem></varlistentry>
299
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
300
 
<listitem><simpara>
301
 
</simpara></listitem></varlistentry>
302
 
<varlistentry><term><parameter>base_uri</parameter>&#160;:</term>
303
 
<listitem><simpara>
304
 
</simpara></listitem></varlistentry>
305
 
<varlistentry><term><parameter>ret_it</parameter>&#160;:</term>
306
 
<listitem><simpara>
307
 
</simpara></listitem></varlistentry>
308
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
309
 
</simpara></listitem></varlistentry>
310
 
</variablelist></refsect2>
311
 
<refsect2 id="e-source-list-remove-group-by-base-uri" role="function">
312
 
<title>e_source_list_remove_group_by_base_uri ()</title>
313
 
<indexterm zone="e-source-list-remove-group-by-base-uri"><primary>e_source_list_remove_group_by_base_uri</primary></indexterm>
314
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_source_list_remove_group_by_base_uri
315
 
                                                        (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>,
316
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *base_uri</parameter>);</programlisting>
317
 
<variablelist role="params">
318
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
319
 
<listitem><simpara>
320
 
</simpara></listitem></varlistentry>
321
 
<varlistentry><term><parameter>base_uri</parameter>&#160;:</term>
322
 
<listitem><simpara>
323
 
</simpara></listitem></varlistentry>
324
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
325
 
</simpara></listitem></varlistentry>
326
 
</variablelist></refsect2>
327
 
<refsect2 id="e-source-list-remove-source-by-uid" role="function">
328
 
<title>e_source_list_remove_source_by_uid ()</title>
329
 
<indexterm zone="e-source-list-remove-source-by-uid"><primary>e_source_list_remove_source_by_uid</primary></indexterm>
330
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_source_list_remove_source_by_uid  (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>,
331
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *uidj</parameter>);</programlisting>
332
 
<para>
333
 
</para><variablelist role="params">
334
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
335
 
<listitem><simpara>
336
 
</simpara></listitem></varlistentry>
337
 
<varlistentry><term><parameter>uidj</parameter>&#160;:</term>
338
 
<listitem><simpara>
339
 
</simpara></listitem></varlistentry>
340
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
341
 
</simpara></listitem></varlistentry>
342
 
</variablelist></refsect2>
343
 
<refsect2 id="e-source-list-sync" role="function">
344
 
<title>e_source_list_sync ()</title>
345
 
<indexterm zone="e-source-list-sync"><primary>e_source_list_sync</primary></indexterm>
346
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_source_list_sync                  (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>,
347
 
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
348
 
<para>
349
 
</para><variablelist role="params">
350
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
351
 
<listitem><simpara>
352
 
</simpara></listitem></varlistentry>
353
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
354
 
<listitem><simpara>
355
 
</simpara></listitem></varlistentry>
356
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
357
 
</simpara></listitem></varlistentry>
358
 
</variablelist></refsect2>
359
 
<refsect2 id="e-source-list-is-gconf-updated" role="function">
360
 
<title>e_source_list_is_gconf_updated ()</title>
361
 
<indexterm zone="e-source-list-is-gconf-updated"><primary>e_source_list_is_gconf_updated</primary></indexterm>
362
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_source_list_is_gconf_updated      (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>);</programlisting>
363
 
<para>
364
 
</para><variablelist role="params">
365
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
366
 
<listitem><simpara>
367
 
</simpara></listitem></varlistentry>
368
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
369
 
</simpara></listitem></varlistentry>
370
 
</variablelist></refsect2>
371
 
 
372
 
</refsect1>
373
 
<refsect1 id="ESourceList.signal-details" role="signals">
374
 
<title role="signals.title">Signal Details</title>
375
 
<refsect2 id="ESourceList-changed" role="signal"><title>The <literal>&quot;changed&quot;</literal> signal</title>
376
 
<indexterm zone="ESourceList-changed"><primary>ESourceList::changed</primary></indexterm>
377
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="ESourceList"><type>ESourceList</type></link> *esourcelist,
378
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>     user_data)        : Run Last</programlisting>
379
 
<para>
380
 
</para><variablelist role="params">
381
 
<varlistentry><term><parameter>esourcelist</parameter>&#160;:</term>
382
 
<listitem><simpara>the object which received the signal.
383
 
</simpara></listitem></varlistentry>
384
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
385
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
386
 
</variablelist></refsect2><refsect2 id="ESourceList-group-added" role="signal"><title>The <literal>&quot;group-added&quot;</literal> signal</title>
387
 
<indexterm zone="ESourceList-group-added"><primary>ESourceList::group-added</primary></indexterm>
388
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="ESourceList"><type>ESourceList</type></link> *esourcelist,
389
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>     arg1,
390
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>     user_data)        : Run Last</programlisting>
391
 
<para>
392
 
</para><variablelist role="params">
393
 
<varlistentry><term><parameter>esourcelist</parameter>&#160;:</term>
394
 
<listitem><simpara>the object which received the signal.
395
 
</simpara></listitem></varlistentry>
396
 
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
397
 
<listitem><simpara>
398
 
</simpara></listitem></varlistentry>
399
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
400
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
401
 
</variablelist></refsect2><refsect2 id="ESourceList-group-removed" role="signal"><title>The <literal>&quot;group-removed&quot;</literal> signal</title>
402
 
<indexterm zone="ESourceList-group-removed"><primary>ESourceList::group-removed</primary></indexterm>
403
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="ESourceList"><type>ESourceList</type></link> *esourcelist,
404
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>     arg1,
405
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>     user_data)        : Run Last</programlisting>
406
 
<para>
407
 
</para><variablelist role="params">
408
 
<varlistentry><term><parameter>esourcelist</parameter>&#160;:</term>
409
 
<listitem><simpara>the object which received the signal.
410
 
</simpara></listitem></varlistentry>
411
 
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
412
 
<listitem><simpara>
413
 
</simpara></listitem></varlistentry>
414
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
415
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
416
 
</variablelist></refsect2>
417
 
</refsect1>
418
 
 
419
 
</refentry>