← 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-group.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-group.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="ESourceGroup">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="ESourceGroup.top_of_page">ESourceGroup</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>
9
 
  LIBEDATASERVER Library
10
 
</refmiscinfo>
11
 
</refmeta>
12
 
<refnamediv>
13
 
<refname>ESourceGroup</refname>
14
 
<refpurpose></refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="ESourceGroup.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>                    <link linkend="ESourceGroup-struct">ESourceGroup</link>;
21
 
<link linkend="ESourceGroup"><returnvalue>ESourceGroup</returnvalue></link> *      <link linkend="e-source-group-new">e_source_group_new</link>                  (<parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>,
22
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *base_uri</parameter>);
23
 
<link linkend="ESourceGroup"><returnvalue>ESourceGroup</returnvalue></link> *      <link linkend="e-source-group-new-from-xml">e_source_group_new_from_xml</link>         (<parameter>const <link linkend="gchar"><type>gchar</type></link> *xml</parameter>);
24
 
<link linkend="ESourceGroup"><returnvalue>ESourceGroup</returnvalue></link> *      <link linkend="e-source-group-new-from-xmldoc">e_source_group_new_from_xmldoc</link>      (<parameter><link linkend="xmlDocPtr"><type>xmlDocPtr</type></link> doc</parameter>);
25
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-source-group-update-from-xml">e_source_group_update_from_xml</link>      (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>,
26
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *xml</parameter>,
27
 
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> *changed_return</parameter>);
28
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-source-group-update-from-xmldoc">e_source_group_update_from_xmldoc</link>   (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>,
29
 
                                                         <parameter><link linkend="xmlDocPtr"><type>xmlDocPtr</type></link> doc</parameter>,
30
 
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> *changed_return</parameter>);
31
 
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             <link linkend="e-source-group-uid-from-xmldoc">e_source_group_uid_from_xmldoc</link>      (<parameter><link linkend="xmlDocPtr"><type>xmlDocPtr</type></link> doc</parameter>);
32
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-source-group-set-name">e_source_group_set_name</link>             (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>,
33
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>);
34
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-source-group-set-base-uri">e_source_group_set_base_uri</link>         (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>,
35
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *base_uri</parameter>);
36
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-source-group-set-readonly">e_source_group_set_readonly</link>         (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>,
37
 
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> readonly</parameter>);
38
 
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       <link linkend="e-source-group-peek-uid">e_source_group_peek_uid</link>             (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>);
39
 
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       <link linkend="e-source-group-peek-name">e_source_group_peek_name</link>            (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>);
40
 
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       <link linkend="e-source-group-peek-base-uri">e_source_group_peek_base_uri</link>        (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>);
41
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-source-group-get-readonly">e_source_group_get_readonly</link>         (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>);
42
 
<link linkend="GSList"><returnvalue>GSList</returnvalue></link> *            <link linkend="e-source-group-peek-sources">e_source_group_peek_sources</link>         (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>);
43
 
<link linkend="ESource"><returnvalue>ESource</returnvalue></link> *           <link linkend="e-source-group-peek-source-by-uid">e_source_group_peek_source_by_uid</link>   (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>,
44
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *source_uid</parameter>);
45
 
<link linkend="ESource"><returnvalue>ESource</returnvalue></link> *           <link linkend="e-source-group-peek-source-by-name">e_source_group_peek_source_by_name</link>  (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>,
46
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *source_name</parameter>);
47
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-source-group-add-source">e_source_group_add_source</link>           (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>,
48
 
                                                         <parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
49
 
                                                         <parameter><link linkend="gint"><type>gint</type></link> position</parameter>);
50
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-source-group-remove-source">e_source_group_remove_source</link>        (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>,
51
 
                                                         <parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);
52
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-source-group-remove-source-by-uid">e_source_group_remove_source_by_uid</link> (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>,
53
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>);
54
 
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             <link linkend="e-source-group-get-property">e_source_group_get_property</link>         (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *source</parameter>,
55
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>);
56
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-source-group-set-property">e_source_group_set_property</link>         (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *source</parameter>,
57
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>,
58
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>);
59
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-source-group-foreach-property">e_source_group_foreach_property</link>     (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *source</parameter>,
60
 
                                                         <parameter><link linkend="GHFunc"><type>GHFunc</type></link> func</parameter>,
61
 
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>);
62
 
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             <link linkend="e-source-group-to-xml">e_source_group_to_xml</link>               (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>);
63
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-source-group-equal">e_source_group_equal</link>                (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *a</parameter>,
64
 
                                                         <parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *b</parameter>);
65
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-source-group-xmlstr-equal">e_source_group_xmlstr_equal</link>         (<parameter>const <link linkend="gchar"><type>gchar</type></link> *a</parameter>,
66
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *b</parameter>);
67
 
</synopsis>
68
 
</refsynopsisdiv>
69
 
<refsect1 id="ESourceGroup.object-hierarchy" role="object_hierarchy">
70
 
<title role="object_hierarchy.title">Object Hierarchy</title>
71
 
<synopsis>
72
 
  <link linkend="GObject">GObject</link>
73
 
   +----ESourceGroup
74
 
</synopsis>
75
 
</refsect1>
76
 
<refsect1 id="ESourceGroup.signals" role="signal_proto">
77
 
<title role="signal_proto.title">Signals</title>
78
 
<synopsis>
79
 
  &quot;<link linkend="ESourceGroup-changed">changed</link>&quot;                                        : Run Last
80
 
  &quot;<link linkend="ESourceGroup-source-added">source-added</link>&quot;                                   : Run Last
81
 
  &quot;<link linkend="ESourceGroup-source-removed">source-removed</link>&quot;                                 : Run Last
82
 
</synopsis>
83
 
</refsect1>
84
 
 
85
 
<refsect1 id="ESourceGroup.description" role="desc">
86
 
<title role="desc.title">Description</title>
87
 
<para>
88
 
</para>
89
 
</refsect1>
90
 
<refsect1 id="ESourceGroup.details" role="details">
91
 
<title role="details.title">Details</title>
92
 
<refsect2 id="ESourceGroup-struct" role="struct">
93
 
<title>ESourceGroup</title>
94
 
<indexterm zone="ESourceGroup-struct"><primary>ESourceGroup</primary></indexterm>
95
 
<programlisting>typedef struct _ESourceGroup ESourceGroup;</programlisting>
96
 
<para>
97
 
</para></refsect2>
98
 
<refsect2 id="e-source-group-new" role="function">
99
 
<title>e_source_group_new ()</title>
100
 
<indexterm zone="e-source-group-new"><primary>e_source_group_new</primary></indexterm>
101
 
<programlisting><link linkend="ESourceGroup"><returnvalue>ESourceGroup</returnvalue></link> *      e_source_group_new                  (<parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>,
102
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *base_uri</parameter>);</programlisting>
103
 
<para>
104
 
</para><variablelist role="params">
105
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
106
 
<listitem><simpara>
107
 
</simpara></listitem></varlistentry>
108
 
<varlistentry><term><parameter>base_uri</parameter>&#160;:</term>
109
 
<listitem><simpara>
110
 
</simpara></listitem></varlistentry>
111
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
112
 
</simpara></listitem></varlistentry>
113
 
</variablelist></refsect2>
114
 
<refsect2 id="e-source-group-new-from-xml" role="function">
115
 
<title>e_source_group_new_from_xml ()</title>
116
 
<indexterm zone="e-source-group-new-from-xml"><primary>e_source_group_new_from_xml</primary></indexterm>
117
 
<programlisting><link linkend="ESourceGroup"><returnvalue>ESourceGroup</returnvalue></link> *      e_source_group_new_from_xml         (<parameter>const <link linkend="gchar"><type>gchar</type></link> *xml</parameter>);</programlisting>
118
 
<para>
119
 
</para><variablelist role="params">
120
 
<varlistentry><term><parameter>xml</parameter>&#160;:</term>
121
 
<listitem><simpara>
122
 
</simpara></listitem></varlistentry>
123
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
124
 
</simpara></listitem></varlistentry>
125
 
</variablelist></refsect2>
126
 
<refsect2 id="e-source-group-new-from-xmldoc" role="function">
127
 
<title>e_source_group_new_from_xmldoc ()</title>
128
 
<indexterm zone="e-source-group-new-from-xmldoc"><primary>e_source_group_new_from_xmldoc</primary></indexterm>
129
 
<programlisting><link linkend="ESourceGroup"><returnvalue>ESourceGroup</returnvalue></link> *      e_source_group_new_from_xmldoc      (<parameter><link linkend="xmlDocPtr"><type>xmlDocPtr</type></link> doc</parameter>);</programlisting>
130
 
<para>
131
 
</para><variablelist role="params">
132
 
<varlistentry><term><parameter>doc</parameter>&#160;:</term>
133
 
<listitem><simpara>
134
 
</simpara></listitem></varlistentry>
135
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
136
 
</simpara></listitem></varlistentry>
137
 
</variablelist></refsect2>
138
 
<refsect2 id="e-source-group-update-from-xml" role="function">
139
 
<title>e_source_group_update_from_xml ()</title>
140
 
<indexterm zone="e-source-group-update-from-xml"><primary>e_source_group_update_from_xml</primary></indexterm>
141
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_source_group_update_from_xml      (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>,
142
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *xml</parameter>,
143
 
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> *changed_return</parameter>);</programlisting>
144
 
<para>
145
 
</para><variablelist role="params">
146
 
<varlistentry><term><parameter>group</parameter>&#160;:</term>
147
 
<listitem><simpara>
148
 
</simpara></listitem></varlistentry>
149
 
<varlistentry><term><parameter>xml</parameter>&#160;:</term>
150
 
<listitem><simpara>
151
 
</simpara></listitem></varlistentry>
152
 
<varlistentry><term><parameter>changed_return</parameter>&#160;:</term>
153
 
<listitem><simpara>
154
 
</simpara></listitem></varlistentry>
155
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
156
 
</simpara></listitem></varlistentry>
157
 
</variablelist></refsect2>
158
 
<refsect2 id="e-source-group-update-from-xmldoc" role="function">
159
 
<title>e_source_group_update_from_xmldoc ()</title>
160
 
<indexterm zone="e-source-group-update-from-xmldoc"><primary>e_source_group_update_from_xmldoc</primary></indexterm>
161
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_source_group_update_from_xmldoc   (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>,
162
 
                                                         <parameter><link linkend="xmlDocPtr"><type>xmlDocPtr</type></link> doc</parameter>,
163
 
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> *changed_return</parameter>);</programlisting>
164
 
<para>
165
 
</para><variablelist role="params">
166
 
<varlistentry><term><parameter>group</parameter>&#160;:</term>
167
 
<listitem><simpara>
168
 
</simpara></listitem></varlistentry>
169
 
<varlistentry><term><parameter>doc</parameter>&#160;:</term>
170
 
<listitem><simpara>
171
 
</simpara></listitem></varlistentry>
172
 
<varlistentry><term><parameter>changed_return</parameter>&#160;:</term>
173
 
<listitem><simpara>
174
 
</simpara></listitem></varlistentry>
175
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
176
 
</simpara></listitem></varlistentry>
177
 
</variablelist></refsect2>
178
 
<refsect2 id="e-source-group-uid-from-xmldoc" role="function">
179
 
<title>e_source_group_uid_from_xmldoc ()</title>
180
 
<indexterm zone="e-source-group-uid-from-xmldoc"><primary>e_source_group_uid_from_xmldoc</primary></indexterm>
181
 
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             e_source_group_uid_from_xmldoc      (<parameter><link linkend="xmlDocPtr"><type>xmlDocPtr</type></link> doc</parameter>);</programlisting>
182
 
<para>
183
 
</para><variablelist role="params">
184
 
<varlistentry><term><parameter>doc</parameter>&#160;:</term>
185
 
<listitem><simpara>
186
 
</simpara></listitem></varlistentry>
187
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
188
 
</simpara></listitem></varlistentry>
189
 
</variablelist></refsect2>
190
 
<refsect2 id="e-source-group-set-name" role="function">
191
 
<title>e_source_group_set_name ()</title>
192
 
<indexterm zone="e-source-group-set-name"><primary>e_source_group_set_name</primary></indexterm>
193
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_source_group_set_name             (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>,
194
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>);</programlisting>
195
 
<para>
196
 
</para><variablelist role="params">
197
 
<varlistentry><term><parameter>group</parameter>&#160;:</term>
198
 
<listitem><simpara>
199
 
</simpara></listitem></varlistentry>
200
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
201
 
<listitem><simpara>
202
 
</simpara></listitem></varlistentry>
203
 
</variablelist></refsect2>
204
 
<refsect2 id="e-source-group-set-base-uri" role="function">
205
 
<title>e_source_group_set_base_uri ()</title>
206
 
<indexterm zone="e-source-group-set-base-uri"><primary>e_source_group_set_base_uri</primary></indexterm>
207
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_source_group_set_base_uri         (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>,
208
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *base_uri</parameter>);</programlisting>
209
 
<para>
210
 
</para><variablelist role="params">
211
 
<varlistentry><term><parameter>group</parameter>&#160;:</term>
212
 
<listitem><simpara>
213
 
</simpara></listitem></varlistentry>
214
 
<varlistentry><term><parameter>base_uri</parameter>&#160;:</term>
215
 
<listitem><simpara>
216
 
</simpara></listitem></varlistentry>
217
 
</variablelist></refsect2>
218
 
<refsect2 id="e-source-group-set-readonly" role="function">
219
 
<title>e_source_group_set_readonly ()</title>
220
 
<indexterm zone="e-source-group-set-readonly"><primary>e_source_group_set_readonly</primary></indexterm>
221
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_source_group_set_readonly         (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>,
222
 
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> readonly</parameter>);</programlisting>
223
 
<para>
224
 
</para><variablelist role="params">
225
 
<varlistentry><term><parameter>group</parameter>&#160;:</term>
226
 
<listitem><simpara>
227
 
</simpara></listitem></varlistentry>
228
 
<varlistentry><term><parameter>readonly</parameter>&#160;:</term>
229
 
<listitem><simpara>
230
 
</simpara></listitem></varlistentry>
231
 
</variablelist></refsect2>
232
 
<refsect2 id="e-source-group-peek-uid" role="function">
233
 
<title>e_source_group_peek_uid ()</title>
234
 
<indexterm zone="e-source-group-peek-uid"><primary>e_source_group_peek_uid</primary></indexterm>
235
 
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       e_source_group_peek_uid             (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>);</programlisting>
236
 
<para>
237
 
</para><variablelist role="params">
238
 
<varlistentry><term><parameter>group</parameter>&#160;:</term>
239
 
<listitem><simpara>
240
 
</simpara></listitem></varlistentry>
241
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
242
 
</simpara></listitem></varlistentry>
243
 
</variablelist></refsect2>
244
 
<refsect2 id="e-source-group-peek-name" role="function">
245
 
<title>e_source_group_peek_name ()</title>
246
 
<indexterm zone="e-source-group-peek-name"><primary>e_source_group_peek_name</primary></indexterm>
247
 
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       e_source_group_peek_name            (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>);</programlisting>
248
 
<para>
249
 
</para><variablelist role="params">
250
 
<varlistentry><term><parameter>group</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-group-peek-base-uri" role="function">
257
 
<title>e_source_group_peek_base_uri ()</title>
258
 
<indexterm zone="e-source-group-peek-base-uri"><primary>e_source_group_peek_base_uri</primary></indexterm>
259
 
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       e_source_group_peek_base_uri        (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>);</programlisting>
260
 
<para>
261
 
</para><variablelist role="params">
262
 
<varlistentry><term><parameter>group</parameter>&#160;:</term>
263
 
<listitem><simpara>
264
 
</simpara></listitem></varlistentry>
265
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
266
 
</simpara></listitem></varlistentry>
267
 
</variablelist></refsect2>
268
 
<refsect2 id="e-source-group-get-readonly" role="function">
269
 
<title>e_source_group_get_readonly ()</title>
270
 
<indexterm zone="e-source-group-get-readonly"><primary>e_source_group_get_readonly</primary></indexterm>
271
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_source_group_get_readonly         (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>);</programlisting>
272
 
<para>
273
 
</para><variablelist role="params">
274
 
<varlistentry><term><parameter>group</parameter>&#160;:</term>
275
 
<listitem><simpara>
276
 
</simpara></listitem></varlistentry>
277
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
278
 
</simpara></listitem></varlistentry>
279
 
</variablelist></refsect2>
280
 
<refsect2 id="e-source-group-peek-sources" role="function">
281
 
<title>e_source_group_peek_sources ()</title>
282
 
<indexterm zone="e-source-group-peek-sources"><primary>e_source_group_peek_sources</primary></indexterm>
283
 
<programlisting><link linkend="GSList"><returnvalue>GSList</returnvalue></link> *            e_source_group_peek_sources         (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>);</programlisting>
284
 
<para>
285
 
</para><variablelist role="params">
286
 
<varlistentry><term><parameter>group</parameter>&#160;:</term>
287
 
<listitem><simpara>
288
 
</simpara></listitem></varlistentry>
289
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
290
 
</simpara></listitem></varlistentry>
291
 
</variablelist></refsect2>
292
 
<refsect2 id="e-source-group-peek-source-by-uid" role="function">
293
 
<title>e_source_group_peek_source_by_uid ()</title>
294
 
<indexterm zone="e-source-group-peek-source-by-uid"><primary>e_source_group_peek_source_by_uid</primary></indexterm>
295
 
<programlisting><link linkend="ESource"><returnvalue>ESource</returnvalue></link> *           e_source_group_peek_source_by_uid   (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>,
296
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *source_uid</parameter>);</programlisting>
297
 
<para>
298
 
</para><variablelist role="params">
299
 
<varlistentry><term><parameter>group</parameter>&#160;:</term>
300
 
<listitem><simpara>
301
 
</simpara></listitem></varlistentry>
302
 
<varlistentry><term><parameter>source_uid</parameter>&#160;:</term>
303
 
<listitem><simpara>
304
 
</simpara></listitem></varlistentry>
305
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
306
 
</simpara></listitem></varlistentry>
307
 
</variablelist></refsect2>
308
 
<refsect2 id="e-source-group-peek-source-by-name" role="function">
309
 
<title>e_source_group_peek_source_by_name ()</title>
310
 
<indexterm zone="e-source-group-peek-source-by-name"><primary>e_source_group_peek_source_by_name</primary></indexterm>
311
 
<programlisting><link linkend="ESource"><returnvalue>ESource</returnvalue></link> *           e_source_group_peek_source_by_name  (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>,
312
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *source_name</parameter>);</programlisting>
313
 
<para>
314
 
</para><variablelist role="params">
315
 
<varlistentry><term><parameter>group</parameter>&#160;:</term>
316
 
<listitem><simpara>
317
 
</simpara></listitem></varlistentry>
318
 
<varlistentry><term><parameter>source_name</parameter>&#160;:</term>
319
 
<listitem><simpara>
320
 
</simpara></listitem></varlistentry>
321
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
322
 
</simpara></listitem></varlistentry>
323
 
</variablelist></refsect2>
324
 
<refsect2 id="e-source-group-add-source" role="function">
325
 
<title>e_source_group_add_source ()</title>
326
 
<indexterm zone="e-source-group-add-source"><primary>e_source_group_add_source</primary></indexterm>
327
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_source_group_add_source           (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>,
328
 
                                                         <parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
329
 
                                                         <parameter><link linkend="gint"><type>gint</type></link> position</parameter>);</programlisting>
330
 
<para>
331
 
</para><variablelist role="params">
332
 
<varlistentry><term><parameter>group</parameter>&#160;:</term>
333
 
<listitem><simpara>
334
 
</simpara></listitem></varlistentry>
335
 
<varlistentry><term><parameter>source</parameter>&#160;:</term>
336
 
<listitem><simpara>
337
 
</simpara></listitem></varlistentry>
338
 
<varlistentry><term><parameter>position</parameter>&#160;:</term>
339
 
<listitem><simpara>
340
 
</simpara></listitem></varlistentry>
341
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
342
 
</simpara></listitem></varlistentry>
343
 
</variablelist></refsect2>
344
 
<refsect2 id="e-source-group-remove-source" role="function">
345
 
<title>e_source_group_remove_source ()</title>
346
 
<indexterm zone="e-source-group-remove-source"><primary>e_source_group_remove_source</primary></indexterm>
347
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_source_group_remove_source        (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>,
348
 
                                                         <parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);</programlisting>
349
 
<para>
350
 
</para><variablelist role="params">
351
 
<varlistentry><term><parameter>group</parameter>&#160;:</term>
352
 
<listitem><simpara>
353
 
</simpara></listitem></varlistentry>
354
 
<varlistentry><term><parameter>source</parameter>&#160;:</term>
355
 
<listitem><simpara>
356
 
</simpara></listitem></varlistentry>
357
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
358
 
</simpara></listitem></varlistentry>
359
 
</variablelist></refsect2>
360
 
<refsect2 id="e-source-group-remove-source-by-uid" role="function">
361
 
<title>e_source_group_remove_source_by_uid ()</title>
362
 
<indexterm zone="e-source-group-remove-source-by-uid"><primary>e_source_group_remove_source_by_uid</primary></indexterm>
363
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_source_group_remove_source_by_uid (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>,
364
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *uid</parameter>);</programlisting>
365
 
<para>
366
 
</para><variablelist role="params">
367
 
<varlistentry><term><parameter>group</parameter>&#160;:</term>
368
 
<listitem><simpara>
369
 
</simpara></listitem></varlistentry>
370
 
<varlistentry><term><parameter>uid</parameter>&#160;:</term>
371
 
<listitem><simpara>
372
 
</simpara></listitem></varlistentry>
373
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
374
 
</simpara></listitem></varlistentry>
375
 
</variablelist></refsect2>
376
 
<refsect2 id="e-source-group-get-property" role="function">
377
 
<title>e_source_group_get_property ()</title>
378
 
<indexterm zone="e-source-group-get-property"><primary>e_source_group_get_property</primary></indexterm>
379
 
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             e_source_group_get_property         (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *source</parameter>,
380
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>);</programlisting>
381
 
<para>
382
 
</para><variablelist role="params">
383
 
<varlistentry><term><parameter>source</parameter>&#160;:</term>
384
 
<listitem><simpara>
385
 
</simpara></listitem></varlistentry>
386
 
<varlistentry><term><parameter>property</parameter>&#160;:</term>
387
 
<listitem><simpara>
388
 
</simpara></listitem></varlistentry>
389
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
390
 
</simpara></listitem></varlistentry>
391
 
</variablelist></refsect2>
392
 
<refsect2 id="e-source-group-set-property" role="function">
393
 
<title>e_source_group_set_property ()</title>
394
 
<indexterm zone="e-source-group-set-property"><primary>e_source_group_set_property</primary></indexterm>
395
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_source_group_set_property         (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *source</parameter>,
396
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>,
397
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>);</programlisting>
398
 
<para>
399
 
</para><variablelist role="params">
400
 
<varlistentry><term><parameter>source</parameter>&#160;:</term>
401
 
<listitem><simpara>
402
 
</simpara></listitem></varlistentry>
403
 
<varlistentry><term><parameter>property</parameter>&#160;:</term>
404
 
<listitem><simpara>
405
 
</simpara></listitem></varlistentry>
406
 
<varlistentry><term><parameter>value</parameter>&#160;:</term>
407
 
<listitem><simpara>
408
 
</simpara></listitem></varlistentry>
409
 
</variablelist></refsect2>
410
 
<refsect2 id="e-source-group-foreach-property" role="function">
411
 
<title>e_source_group_foreach_property ()</title>
412
 
<indexterm zone="e-source-group-foreach-property"><primary>e_source_group_foreach_property</primary></indexterm>
413
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_source_group_foreach_property     (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *source</parameter>,
414
 
                                                         <parameter><link linkend="GHFunc"><type>GHFunc</type></link> func</parameter>,
415
 
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>);</programlisting>
416
 
<para>
417
 
</para><variablelist role="params">
418
 
<varlistentry><term><parameter>source</parameter>&#160;:</term>
419
 
<listitem><simpara>
420
 
</simpara></listitem></varlistentry>
421
 
<varlistentry><term><parameter>func</parameter>&#160;:</term>
422
 
<listitem><simpara>
423
 
</simpara></listitem></varlistentry>
424
 
<varlistentry><term><parameter>data</parameter>&#160;:</term>
425
 
<listitem><simpara>
426
 
</simpara></listitem></varlistentry>
427
 
</variablelist></refsect2>
428
 
<refsect2 id="e-source-group-to-xml" role="function">
429
 
<title>e_source_group_to_xml ()</title>
430
 
<indexterm zone="e-source-group-to-xml"><primary>e_source_group_to_xml</primary></indexterm>
431
 
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             e_source_group_to_xml               (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>);</programlisting>
432
 
<para>
433
 
</para><variablelist role="params">
434
 
<varlistentry><term><parameter>group</parameter>&#160;:</term>
435
 
<listitem><simpara>
436
 
</simpara></listitem></varlistentry>
437
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
438
 
</simpara></listitem></varlistentry>
439
 
</variablelist></refsect2>
440
 
<refsect2 id="e-source-group-equal" role="function">
441
 
<title>e_source_group_equal ()</title>
442
 
<indexterm zone="e-source-group-equal"><primary>e_source_group_equal</primary></indexterm>
443
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_source_group_equal                (<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *a</parameter>,
444
 
                                                         <parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *b</parameter>);</programlisting>
445
 
<para>
446
 
Compares if <parameter>a</parameter> is equivalent to <parameter>b</parameter>.</para>
447
 
<variablelist role="params">
448
 
<varlistentry><term><parameter>a</parameter>&#160;:</term>
449
 
<listitem><simpara>An ESourceGroup
450
 
</simpara></listitem></varlistentry>
451
 
<varlistentry><term><parameter>b</parameter>&#160;:</term>
452
 
<listitem><simpara>Another ESourceGroup
453
 
</simpara></listitem></varlistentry>
454
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>a</parameter> is equivalent to <parameter>b</parameter>,
455
 
<link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
456
 
</simpara></listitem></varlistentry>
457
 
</variablelist></refsect2>
458
 
<refsect2 id="e-source-group-xmlstr-equal" role="function">
459
 
<title>e_source_group_xmlstr_equal ()</title>
460
 
<indexterm zone="e-source-group-xmlstr-equal"><primary>e_source_group_xmlstr_equal</primary></indexterm>
461
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_source_group_xmlstr_equal         (<parameter>const <link linkend="gchar"><type>gchar</type></link> *a</parameter>,
462
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *b</parameter>);</programlisting>
463
 
<para>
464
 
Compares if <parameter>a</parameter> is equivalent to <parameter>b</parameter>.</para>
465
 
<variablelist role="params">
466
 
<varlistentry><term><parameter>a</parameter>&#160;:</term>
467
 
<listitem><simpara>XML representation of an ESourceGroup
468
 
</simpara></listitem></varlistentry>
469
 
<varlistentry><term><parameter>b</parameter>&#160;:</term>
470
 
<listitem><simpara>XML representation of another ESourceGroup
471
 
</simpara></listitem></varlistentry>
472
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>a</parameter> is equivalent to <parameter>b</parameter>,
473
 
<link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
474
 
</simpara></listitem></varlistentry>
475
 
</variablelist></refsect2>
476
 
 
477
 
</refsect1>
478
 
<refsect1 id="ESourceGroup.signal-details" role="signals">
479
 
<title role="signals.title">Signal Details</title>
480
 
<refsect2 id="ESourceGroup-changed" role="signal"><title>The <literal>&quot;changed&quot;</literal> signal</title>
481
 
<indexterm zone="ESourceGroup-changed"><primary>ESourceGroup::changed</primary></indexterm>
482
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="ESourceGroup"><type>ESourceGroup</type></link> *esourcegroup,
483
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>      user_data)         : Run Last</programlisting>
484
 
<para>
485
 
</para><variablelist role="params">
486
 
<varlistentry><term><parameter>esourcegroup</parameter>&#160;:</term>
487
 
<listitem><simpara>the object which received the signal.
488
 
</simpara></listitem></varlistentry>
489
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
490
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
491
 
</variablelist></refsect2><refsect2 id="ESourceGroup-source-added" role="signal"><title>The <literal>&quot;source-added&quot;</literal> signal</title>
492
 
<indexterm zone="ESourceGroup-source-added"><primary>ESourceGroup::source-added</primary></indexterm>
493
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="ESourceGroup"><type>ESourceGroup</type></link> *esourcegroup,
494
 
                                                        <link linkend="GObject"><type>GObject</type></link>      *arg1,
495
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>      user_data)         : Run Last</programlisting>
496
 
<para>
497
 
</para><variablelist role="params">
498
 
<varlistentry><term><parameter>esourcegroup</parameter>&#160;:</term>
499
 
<listitem><simpara>the object which received the signal.
500
 
</simpara></listitem></varlistentry>
501
 
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
502
 
<listitem><simpara>
503
 
</simpara></listitem></varlistentry>
504
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
505
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
506
 
</variablelist></refsect2><refsect2 id="ESourceGroup-source-removed" role="signal"><title>The <literal>&quot;source-removed&quot;</literal> signal</title>
507
 
<indexterm zone="ESourceGroup-source-removed"><primary>ESourceGroup::source-removed</primary></indexterm>
508
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="ESourceGroup"><type>ESourceGroup</type></link> *esourcegroup,
509
 
                                                        <link linkend="GObject"><type>GObject</type></link>      *arg1,
510
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>      user_data)         : Run Last</programlisting>
511
 
<para>
512
 
</para><variablelist role="params">
513
 
<varlistentry><term><parameter>esourcegroup</parameter>&#160;:</term>
514
 
<listitem><simpara>the object which received the signal.
515
 
</simpara></listitem></varlistentry>
516
 
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
517
 
<listitem><simpara>
518
 
</simpara></listitem></varlistentry>
519
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
520
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
521
 
</variablelist></refsect2>
522
 
</refsect1>
523
 
 
524
 
</refentry>