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="ESource">
6
<refentrytitle role="top_of_page" id="ESource.top_of_page">ESource</refentrytitle>
7
<manvolnum>3</manvolnum>
13
<refname>ESource</refname>
14
<refpurpose></refpurpose>
17
<refsynopsisdiv id="ESource.synopsis" role="synopsis">
18
<title role="synopsis.title">Synopsis</title>
20
<synopsis> <link linkend="ESource-struct">ESource</link>;
21
<link linkend="ESource"><returnvalue>ESource</returnvalue></link> * <link linkend="e-source-new">e_source_new</link> (<parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>,
22
<parameter>const <link linkend="gchar"><type>gchar</type></link> *relative_uri</parameter>);
23
<link linkend="ESource"><returnvalue>ESource</returnvalue></link> * <link linkend="e-source-new-with-absolute-uri">e_source_new_with_absolute_uri</link> (<parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>,
24
<parameter>const <link linkend="gchar"><type>gchar</type></link> *absolute_uri</parameter>);
25
<link linkend="ESource"><returnvalue>ESource</returnvalue></link> * <link linkend="e-source-new-from-xml-node">e_source_new_from_xml_node</link> (<parameter><link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> node</parameter>);
26
<link linkend="ESource"><returnvalue>ESource</returnvalue></link> * <link linkend="e-source-new-from-standalone-xml">e_source_new_from_standalone_xml</link> (<parameter>const <link linkend="gchar"><type>gchar</type></link> *xml</parameter>);
27
<link linkend="ESource"><returnvalue>ESource</returnvalue></link> * <link linkend="e-source-copy">e_source_copy</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);
28
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="e-source-update-from-xml-node">e_source_update_from_xml_node</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
29
<parameter><link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> node</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-uid-from-xml-node">e_source_uid_from_xml_node</link> (<parameter><link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> node</parameter>);
32
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-source-set-group">e_source_set_group</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
33
<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>);
34
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-source-set-name">e_source_set_name</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
35
<parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>);
36
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-source-set-relative-uri">e_source_set_relative_uri</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
37
<parameter>const <link linkend="gchar"><type>gchar</type></link> *relative_uri</parameter>);
38
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-source-set-absolute-uri">e_source_set_absolute_uri</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
39
<parameter>const <link linkend="gchar"><type>gchar</type></link> *absolute_uri</parameter>);
40
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-source-set-color-spec">e_source_set_color_spec</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
41
<parameter>const <link linkend="gchar"><type>gchar</type></link> *color_spec</parameter>);
42
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-source-set-readonly">e_source_set_readonly</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
43
<parameter><link linkend="gboolean"><type>gboolean</type></link> readonly</parameter>);
44
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-source-set-color">e_source_set_color</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
45
<parameter><link linkend="guint32"><type>guint32</type></link> color</parameter>);
46
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-source-unset-color">e_source_unset_color</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);
47
<link linkend="ESourceGroup"><returnvalue>ESourceGroup</returnvalue></link> * <link linkend="e-source-peek-group">e_source_peek_group</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);
48
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-source-peek-uid">e_source_peek_uid</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);
49
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-source-peek-name">e_source_peek_name</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);
50
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-source-peek-relative-uri">e_source_peek_relative_uri</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);
51
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-source-peek-absolute-uri">e_source_peek_absolute_uri</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);
52
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-source-peek-color-spec">e_source_peek_color_spec</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);
53
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="e-source-get-readonly">e_source_get_readonly</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);
54
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="e-source-get-color">e_source_get_color</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
55
<parameter><link linkend="guint32"><type>guint32</type></link> *color_return</parameter>);
56
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-source-get-uri">e_source_get_uri</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);
57
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-source-dump-to-xml-node">e_source_dump_to_xml_node</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
58
<parameter><link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> parent_node</parameter>);
59
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-source-to-standalone-xml">e_source_to_standalone_xml</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);
60
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-source-get-property">e_source_get_property</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
61
<parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>);
62
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-source-set-property">e_source_set_property</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
63
<parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>,
64
<parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>);
65
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-source-foreach-property">e_source_foreach_property</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
66
<parameter><link linkend="GHFunc"><type>GHFunc</type></link> func</parameter>,
67
<parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>);
68
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-source-get-duped-property">e_source_get_duped_property</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
69
<parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>);
70
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-source-build-absolute-uri">e_source_build_absolute_uri</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);
71
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="e-source-equal">e_source_equal</link> (<parameter><link linkend="ESource"><type>ESource</type></link> *a</parameter>,
72
<parameter><link linkend="ESource"><type>ESource</type></link> *b</parameter>);
73
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="e-source-xmlstr-equal">e_source_xmlstr_equal</link> (<parameter>const <link linkend="gchar"><type>gchar</type></link> *a</parameter>,
74
<parameter>const <link linkend="gchar"><type>gchar</type></link> *b</parameter>);
77
<refsect1 id="ESource.object-hierarchy" role="object_hierarchy">
78
<title role="object_hierarchy.title">Object Hierarchy</title>
80
<link linkend="GObject">GObject</link>
84
<refsect1 id="ESource.signals" role="signal_proto">
85
<title role="signal_proto.title">Signals</title>
87
"<link linkend="ESource-changed">changed</link>" : Run Last
91
<refsect1 id="ESource.description" role="desc">
92
<title role="desc.title">Description</title>
96
<refsect1 id="ESource.details" role="details">
97
<title role="details.title">Details</title>
98
<refsect2 id="ESource-struct" role="struct">
99
<title>ESource</title>
100
<indexterm zone="ESource-struct"><primary>ESource</primary></indexterm>
101
<programlisting>typedef struct _ESource ESource;</programlisting>
104
<refsect2 id="e-source-new" role="function">
105
<title>e_source_new ()</title>
106
<indexterm zone="e-source-new"><primary>e_source_new</primary></indexterm>
107
<programlisting><link linkend="ESource"><returnvalue>ESource</returnvalue></link> * e_source_new (<parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>,
108
<parameter>const <link linkend="gchar"><type>gchar</type></link> *relative_uri</parameter>);</programlisting>
110
</para><variablelist role="params">
111
<varlistentry><term><parameter>name</parameter> :</term>
113
</simpara></listitem></varlistentry>
114
<varlistentry><term><parameter>relative_uri</parameter> :</term>
116
</simpara></listitem></varlistentry>
117
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
118
</simpara></listitem></varlistentry>
119
</variablelist></refsect2>
120
<refsect2 id="e-source-new-with-absolute-uri" role="function">
121
<title>e_source_new_with_absolute_uri ()</title>
122
<indexterm zone="e-source-new-with-absolute-uri"><primary>e_source_new_with_absolute_uri</primary></indexterm>
123
<programlisting><link linkend="ESource"><returnvalue>ESource</returnvalue></link> * e_source_new_with_absolute_uri (<parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>,
124
<parameter>const <link linkend="gchar"><type>gchar</type></link> *absolute_uri</parameter>);</programlisting>
126
</para><variablelist role="params">
127
<varlistentry><term><parameter>name</parameter> :</term>
129
</simpara></listitem></varlistentry>
130
<varlistentry><term><parameter>absolute_uri</parameter> :</term>
132
</simpara></listitem></varlistentry>
133
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
134
</simpara></listitem></varlistentry>
135
</variablelist></refsect2>
136
<refsect2 id="e-source-new-from-xml-node" role="function">
137
<title>e_source_new_from_xml_node ()</title>
138
<indexterm zone="e-source-new-from-xml-node"><primary>e_source_new_from_xml_node</primary></indexterm>
139
<programlisting><link linkend="ESource"><returnvalue>ESource</returnvalue></link> * e_source_new_from_xml_node (<parameter><link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> node</parameter>);</programlisting>
141
</para><variablelist role="params">
142
<varlistentry><term><parameter>node</parameter> :</term>
144
</simpara></listitem></varlistentry>
145
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
146
</simpara></listitem></varlistentry>
147
</variablelist></refsect2>
148
<refsect2 id="e-source-new-from-standalone-xml" role="function">
149
<title>e_source_new_from_standalone_xml ()</title>
150
<indexterm zone="e-source-new-from-standalone-xml"><primary>e_source_new_from_standalone_xml</primary></indexterm>
151
<programlisting><link linkend="ESource"><returnvalue>ESource</returnvalue></link> * e_source_new_from_standalone_xml (<parameter>const <link linkend="gchar"><type>gchar</type></link> *xml</parameter>);</programlisting>
153
</para><variablelist role="params">
154
<varlistentry><term><parameter>xml</parameter> :</term>
156
</simpara></listitem></varlistentry>
157
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
158
</simpara></listitem></varlistentry>
159
</variablelist></refsect2>
160
<refsect2 id="e-source-copy" role="function">
161
<title>e_source_copy ()</title>
162
<indexterm zone="e-source-copy"><primary>e_source_copy</primary></indexterm>
163
<programlisting><link linkend="ESource"><returnvalue>ESource</returnvalue></link> * e_source_copy (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);</programlisting>
165
</para><variablelist role="params">
166
<varlistentry><term><parameter>source</parameter> :</term>
168
</simpara></listitem></varlistentry>
169
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
170
</simpara></listitem></varlistentry>
171
</variablelist></refsect2>
172
<refsect2 id="e-source-update-from-xml-node" role="function">
173
<title>e_source_update_from_xml_node ()</title>
174
<indexterm zone="e-source-update-from-xml-node"><primary>e_source_update_from_xml_node</primary></indexterm>
175
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> e_source_update_from_xml_node (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
176
<parameter><link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> node</parameter>,
177
<parameter><link linkend="gboolean"><type>gboolean</type></link> *changed_return</parameter>);</programlisting>
179
Update the ESource properties from <parameter>node</parameter>.</para>
180
<variablelist role="params">
181
<varlistentry><term><parameter>source</parameter> :</term>
182
<listitem><simpara>An ESource.
183
</simpara></listitem></varlistentry>
184
<varlistentry><term><parameter>node</parameter> :</term>
185
<listitem><simpara>A pointer to the node to parse.
186
</simpara></listitem></varlistentry>
187
<varlistentry><term><parameter>changed_return</parameter> :</term>
189
</simpara></listitem></varlistentry>
190
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the data in <parameter>node</parameter> was recognized and parsed into
191
acceptable values for <parameter>source</parameter>, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
192
</simpara></listitem></varlistentry>
193
</variablelist></refsect2>
194
<refsect2 id="e-source-uid-from-xml-node" role="function">
195
<title>e_source_uid_from_xml_node ()</title>
196
<indexterm zone="e-source-uid-from-xml-node"><primary>e_source_uid_from_xml_node</primary></indexterm>
197
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_source_uid_from_xml_node (<parameter><link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> node</parameter>);</programlisting>
199
</para><variablelist role="params">
200
<varlistentry><term><parameter>node</parameter> :</term>
202
</simpara></listitem></varlistentry>
203
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
204
</simpara></listitem></varlistentry>
205
</variablelist></refsect2>
206
<refsect2 id="e-source-set-group" role="function">
207
<title>e_source_set_group ()</title>
208
<indexterm zone="e-source-set-group"><primary>e_source_set_group</primary></indexterm>
209
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_source_set_group (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
210
<parameter><link linkend="ESourceGroup"><type>ESourceGroup</type></link> *group</parameter>);</programlisting>
212
</para><variablelist role="params">
213
<varlistentry><term><parameter>source</parameter> :</term>
215
</simpara></listitem></varlistentry>
216
<varlistentry><term><parameter>group</parameter> :</term>
218
</simpara></listitem></varlistentry>
219
</variablelist></refsect2>
220
<refsect2 id="e-source-set-name" role="function">
221
<title>e_source_set_name ()</title>
222
<indexterm zone="e-source-set-name"><primary>e_source_set_name</primary></indexterm>
223
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_source_set_name (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
224
<parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>);</programlisting>
226
</para><variablelist role="params">
227
<varlistentry><term><parameter>source</parameter> :</term>
229
</simpara></listitem></varlistentry>
230
<varlistentry><term><parameter>name</parameter> :</term>
232
</simpara></listitem></varlistentry>
233
</variablelist></refsect2>
234
<refsect2 id="e-source-set-relative-uri" role="function">
235
<title>e_source_set_relative_uri ()</title>
236
<indexterm zone="e-source-set-relative-uri"><primary>e_source_set_relative_uri</primary></indexterm>
237
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_source_set_relative_uri (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
238
<parameter>const <link linkend="gchar"><type>gchar</type></link> *relative_uri</parameter>);</programlisting>
240
</para><variablelist role="params">
241
<varlistentry><term><parameter>source</parameter> :</term>
243
</simpara></listitem></varlistentry>
244
<varlistentry><term><parameter>relative_uri</parameter> :</term>
246
</simpara></listitem></varlistentry>
247
</variablelist></refsect2>
248
<refsect2 id="e-source-set-absolute-uri" role="function">
249
<title>e_source_set_absolute_uri ()</title>
250
<indexterm zone="e-source-set-absolute-uri"><primary>e_source_set_absolute_uri</primary></indexterm>
251
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_source_set_absolute_uri (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
252
<parameter>const <link linkend="gchar"><type>gchar</type></link> *absolute_uri</parameter>);</programlisting>
254
</para><variablelist role="params">
255
<varlistentry><term><parameter>source</parameter> :</term>
257
</simpara></listitem></varlistentry>
258
<varlistentry><term><parameter>absolute_uri</parameter> :</term>
260
</simpara></listitem></varlistentry>
261
</variablelist></refsect2>
262
<refsect2 id="e-source-set-color-spec" role="function" condition="since:1.10">
263
<title>e_source_set_color_spec ()</title>
264
<indexterm zone="e-source-set-color-spec" role="1.10"><primary>e_source_set_color_spec</primary></indexterm>
265
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_source_set_color_spec (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
266
<parameter>const <link linkend="gchar"><type>gchar</type></link> *color_spec</parameter>);</programlisting>
268
Store a textual representation of a color in <parameter>source</parameter>. The <parameter>color_spec</parameter>
269
string should be parsable by #<link linkend="gdk-color-parse"><function>gdk_color_parse()</function></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to unset the
270
color in <parameter>source</parameter>.</para>
271
<variablelist role="params">
272
<varlistentry><term><parameter>source</parameter> :</term>
273
<listitem><simpara>an ESource
274
</simpara></listitem></varlistentry>
275
<varlistentry><term><parameter>color_spec</parameter> :</term>
276
<listitem><simpara>a string specifying the color
277
</simpara></listitem></varlistentry>
278
</variablelist><para role="since">Since 1.10</para></refsect2>
279
<refsect2 id="e-source-set-readonly" role="function">
280
<title>e_source_set_readonly ()</title>
281
<indexterm zone="e-source-set-readonly"><primary>e_source_set_readonly</primary></indexterm>
282
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_source_set_readonly (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
283
<parameter><link linkend="gboolean"><type>gboolean</type></link> readonly</parameter>);</programlisting>
285
</para><variablelist role="params">
286
<varlistentry><term><parameter>source</parameter> :</term>
288
</simpara></listitem></varlistentry>
289
<varlistentry><term><parameter>readonly</parameter> :</term>
291
</simpara></listitem></varlistentry>
292
</variablelist></refsect2>
293
<refsect2 id="e-source-set-color" role="function" condition="deprecated:">
294
<title>e_source_set_color ()</title>
295
<indexterm zone="e-source-set-color" role="deprecated"><primary>e_source_set_color</primary></indexterm>
296
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_source_set_color (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
297
<parameter><link linkend="guint32"><type>guint32</type></link> color</parameter>);</programlisting>
298
<warning><para><literal>e_source_set_color</literal> is deprecated and should not be used in newly-written code.</para></warning>
300
</para><variablelist role="params">
301
<varlistentry><term><parameter>source</parameter> :</term>
303
</simpara></listitem></varlistentry>
304
<varlistentry><term><parameter>color</parameter> :</term>
306
</simpara></listitem></varlistentry>
307
</variablelist></refsect2>
308
<refsect2 id="e-source-unset-color" role="function" condition="deprecated:">
309
<title>e_source_unset_color ()</title>
310
<indexterm zone="e-source-unset-color" role="deprecated"><primary>e_source_unset_color</primary></indexterm>
311
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_source_unset_color (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);</programlisting>
312
<warning><para><literal>e_source_unset_color</literal> is deprecated and should not be used in newly-written code.</para></warning>
314
</para><variablelist role="params">
315
<varlistentry><term><parameter>source</parameter> :</term>
317
</simpara></listitem></varlistentry>
318
</variablelist></refsect2>
319
<refsect2 id="e-source-peek-group" role="function">
320
<title>e_source_peek_group ()</title>
321
<indexterm zone="e-source-peek-group"><primary>e_source_peek_group</primary></indexterm>
322
<programlisting><link linkend="ESourceGroup"><returnvalue>ESourceGroup</returnvalue></link> * e_source_peek_group (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);</programlisting>
324
</para><variablelist role="params">
325
<varlistentry><term><parameter>source</parameter> :</term>
327
</simpara></listitem></varlistentry>
328
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
329
</simpara></listitem></varlistentry>
330
</variablelist></refsect2>
331
<refsect2 id="e-source-peek-uid" role="function">
332
<title>e_source_peek_uid ()</title>
333
<indexterm zone="e-source-peek-uid"><primary>e_source_peek_uid</primary></indexterm>
334
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_source_peek_uid (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);</programlisting>
336
</para><variablelist role="params">
337
<varlistentry><term><parameter>source</parameter> :</term>
339
</simpara></listitem></varlistentry>
340
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
341
</simpara></listitem></varlistentry>
342
</variablelist></refsect2>
343
<refsect2 id="e-source-peek-name" role="function">
344
<title>e_source_peek_name ()</title>
345
<indexterm zone="e-source-peek-name"><primary>e_source_peek_name</primary></indexterm>
346
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_source_peek_name (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);</programlisting>
348
</para><variablelist role="params">
349
<varlistentry><term><parameter>source</parameter> :</term>
351
</simpara></listitem></varlistentry>
352
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
353
</simpara></listitem></varlistentry>
354
</variablelist></refsect2>
355
<refsect2 id="e-source-peek-relative-uri" role="function">
356
<title>e_source_peek_relative_uri ()</title>
357
<indexterm zone="e-source-peek-relative-uri"><primary>e_source_peek_relative_uri</primary></indexterm>
358
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_source_peek_relative_uri (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);</programlisting>
360
</para><variablelist role="params">
361
<varlistentry><term><parameter>source</parameter> :</term>
363
</simpara></listitem></varlistentry>
364
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
365
</simpara></listitem></varlistentry>
366
</variablelist></refsect2>
367
<refsect2 id="e-source-peek-absolute-uri" role="function">
368
<title>e_source_peek_absolute_uri ()</title>
369
<indexterm zone="e-source-peek-absolute-uri"><primary>e_source_peek_absolute_uri</primary></indexterm>
370
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_source_peek_absolute_uri (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);</programlisting>
372
</para><variablelist role="params">
373
<varlistentry><term><parameter>source</parameter> :</term>
375
</simpara></listitem></varlistentry>
376
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
377
</simpara></listitem></varlistentry>
378
</variablelist></refsect2>
379
<refsect2 id="e-source-peek-color-spec" role="function" condition="since:1.10">
380
<title>e_source_peek_color_spec ()</title>
381
<indexterm zone="e-source-peek-color-spec" role="1.10"><primary>e_source_peek_color_spec</primary></indexterm>
382
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_source_peek_color_spec (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);</programlisting>
384
Return the textual representation of the color for <parameter>source</parameter>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if it
385
has none. The returned string should be parsable by #<link linkend="gdk-color-parse"><function>gdk_color_parse()</function></link>.</para>
386
<variablelist role="params">
387
<varlistentry><term><parameter>source</parameter> :</term>
388
<listitem><simpara>an ESource
389
</simpara></listitem></varlistentry>
390
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a string specifying the color
392
</simpara></listitem></varlistentry>
393
</variablelist><para role="since">Since 1.10</para></refsect2>
394
<refsect2 id="e-source-get-readonly" role="function">
395
<title>e_source_get_readonly ()</title>
396
<indexterm zone="e-source-get-readonly"><primary>e_source_get_readonly</primary></indexterm>
397
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> e_source_get_readonly (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);</programlisting>
399
</para><variablelist role="params">
400
<varlistentry><term><parameter>source</parameter> :</term>
402
</simpara></listitem></varlistentry>
403
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
404
</simpara></listitem></varlistentry>
405
</variablelist></refsect2>
406
<refsect2 id="e-source-get-color" role="function" condition="deprecated:">
407
<title>e_source_get_color ()</title>
408
<indexterm zone="e-source-get-color" role="deprecated"><primary>e_source_get_color</primary></indexterm>
409
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> e_source_get_color (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
410
<parameter><link linkend="guint32"><type>guint32</type></link> *color_return</parameter>);</programlisting>
411
<warning><para><literal>e_source_get_color</literal> is deprecated and should not be used in newly-written code.</para></warning>
413
If <parameter>source</parameter> has an associated color, return it in *<parameter>color_return</parameter>.</para>
414
<variablelist role="params">
415
<varlistentry><term><parameter>source</parameter> :</term>
416
<listitem><simpara>An ESource
417
</simpara></listitem></varlistentry>
418
<varlistentry><term><parameter>color_return</parameter> :</term>
419
<listitem><simpara>Pointer to a variable where the returned color will be
421
</simpara></listitem></varlistentry>
422
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the <parameter>source</parameter> has a defined color (and hence
423
*<parameter>color_return</parameter> was set), <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
424
</simpara></listitem></varlistentry>
425
</variablelist></refsect2>
426
<refsect2 id="e-source-get-uri" role="function">
427
<title>e_source_get_uri ()</title>
428
<indexterm zone="e-source-get-uri"><primary>e_source_get_uri</primary></indexterm>
429
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_source_get_uri (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);</programlisting>
431
</para><variablelist role="params">
432
<varlistentry><term><parameter>source</parameter> :</term>
434
</simpara></listitem></varlistentry>
435
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
436
</simpara></listitem></varlistentry>
437
</variablelist></refsect2>
438
<refsect2 id="e-source-dump-to-xml-node" role="function">
439
<title>e_source_dump_to_xml_node ()</title>
440
<indexterm zone="e-source-dump-to-xml-node"><primary>e_source_dump_to_xml_node</primary></indexterm>
441
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_source_dump_to_xml_node (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
442
<parameter><link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> parent_node</parameter>);</programlisting>
444
</para><variablelist role="params">
445
<varlistentry><term><parameter>source</parameter> :</term>
447
</simpara></listitem></varlistentry>
448
<varlistentry><term><parameter>parent_node</parameter> :</term>
450
</simpara></listitem></varlistentry>
451
</variablelist></refsect2>
452
<refsect2 id="e-source-to-standalone-xml" role="function">
453
<title>e_source_to_standalone_xml ()</title>
454
<indexterm zone="e-source-to-standalone-xml"><primary>e_source_to_standalone_xml</primary></indexterm>
455
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_source_to_standalone_xml (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);</programlisting>
457
</para><variablelist role="params">
458
<varlistentry><term><parameter>source</parameter> :</term>
460
</simpara></listitem></varlistentry>
461
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
462
</simpara></listitem></varlistentry>
463
</variablelist></refsect2>
464
<refsect2 id="e-source-get-property" role="function">
465
<title>e_source_get_property ()</title>
466
<indexterm zone="e-source-get-property"><primary>e_source_get_property</primary></indexterm>
467
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_source_get_property (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
468
<parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>);</programlisting>
470
</para><variablelist role="params">
471
<varlistentry><term><parameter>source</parameter> :</term>
473
</simpara></listitem></varlistentry>
474
<varlistentry><term><parameter>property</parameter> :</term>
476
</simpara></listitem></varlistentry>
477
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
478
</simpara></listitem></varlistentry>
479
</variablelist></refsect2>
480
<refsect2 id="e-source-set-property" role="function">
481
<title>e_source_set_property ()</title>
482
<indexterm zone="e-source-set-property"><primary>e_source_set_property</primary></indexterm>
483
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_source_set_property (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
484
<parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>,
485
<parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>);</programlisting>
487
</para><variablelist role="params">
488
<varlistentry><term><parameter>source</parameter> :</term>
490
</simpara></listitem></varlistentry>
491
<varlistentry><term><parameter>property</parameter> :</term>
493
</simpara></listitem></varlistentry>
494
<varlistentry><term><parameter>value</parameter> :</term>
496
</simpara></listitem></varlistentry>
497
</variablelist></refsect2>
498
<refsect2 id="e-source-foreach-property" role="function">
499
<title>e_source_foreach_property ()</title>
500
<indexterm zone="e-source-foreach-property"><primary>e_source_foreach_property</primary></indexterm>
501
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_source_foreach_property (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
502
<parameter><link linkend="GHFunc"><type>GHFunc</type></link> func</parameter>,
503
<parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>);</programlisting>
505
</para><variablelist role="params">
506
<varlistentry><term><parameter>source</parameter> :</term>
508
</simpara></listitem></varlistentry>
509
<varlistentry><term><parameter>func</parameter> :</term>
511
</simpara></listitem></varlistentry>
512
<varlistentry><term><parameter>data</parameter> :</term>
514
</simpara></listitem></varlistentry>
515
</variablelist></refsect2>
516
<refsect2 id="e-source-get-duped-property" role="function">
517
<title>e_source_get_duped_property ()</title>
518
<indexterm zone="e-source-get-duped-property"><primary>e_source_get_duped_property</primary></indexterm>
519
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_source_get_duped_property (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
520
<parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>);</programlisting>
522
</para><variablelist role="params">
523
<varlistentry><term><parameter>source</parameter> :</term>
525
</simpara></listitem></varlistentry>
526
<varlistentry><term><parameter>property</parameter> :</term>
528
</simpara></listitem></varlistentry>
529
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
530
</simpara></listitem></varlistentry>
531
</variablelist></refsect2>
532
<refsect2 id="e-source-build-absolute-uri" role="function">
533
<title>e_source_build_absolute_uri ()</title>
534
<indexterm zone="e-source-build-absolute-uri"><primary>e_source_build_absolute_uri</primary></indexterm>
535
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_source_build_absolute_uri (<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);</programlisting>
537
</para><variablelist role="params">
538
<varlistentry><term><parameter>source</parameter> :</term>
540
</simpara></listitem></varlistentry>
541
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
542
</simpara></listitem></varlistentry>
543
</variablelist></refsect2>
544
<refsect2 id="e-source-equal" role="function">
545
<title>e_source_equal ()</title>
546
<indexterm zone="e-source-equal"><primary>e_source_equal</primary></indexterm>
547
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> e_source_equal (<parameter><link linkend="ESource"><type>ESource</type></link> *a</parameter>,
548
<parameter><link linkend="ESource"><type>ESource</type></link> *b</parameter>);</programlisting>
550
Compares if <parameter>a</parameter> is equivalent to <parameter>b</parameter>.</para>
551
<variablelist role="params">
552
<varlistentry><term><parameter>a</parameter> :</term>
553
<listitem><simpara>An ESource
554
</simpara></listitem></varlistentry>
555
<varlistentry><term><parameter>b</parameter> :</term>
556
<listitem><simpara>Another ESource
557
</simpara></listitem></varlistentry>
558
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>a</parameter> is equivalent to <parameter>b</parameter>,
559
<link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
560
</simpara></listitem></varlistentry>
561
</variablelist></refsect2>
562
<refsect2 id="e-source-xmlstr-equal" role="function">
563
<title>e_source_xmlstr_equal ()</title>
564
<indexterm zone="e-source-xmlstr-equal"><primary>e_source_xmlstr_equal</primary></indexterm>
565
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> e_source_xmlstr_equal (<parameter>const <link linkend="gchar"><type>gchar</type></link> *a</parameter>,
566
<parameter>const <link linkend="gchar"><type>gchar</type></link> *b</parameter>);</programlisting>
568
Compares if <parameter>a</parameter> is equivalent to <parameter>b</parameter>.</para>
569
<variablelist role="params">
570
<varlistentry><term><parameter>a</parameter> :</term>
571
<listitem><simpara>XML representation of an ESource
572
</simpara></listitem></varlistentry>
573
<varlistentry><term><parameter>b</parameter> :</term>
574
<listitem><simpara>XML representation of another ESource
575
</simpara></listitem></varlistentry>
576
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>a</parameter> is equivalent to <parameter>b</parameter>,
577
<link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
578
</simpara></listitem></varlistentry>
579
</variablelist></refsect2>
582
<refsect1 id="ESource.signal-details" role="signals">
583
<title role="signals.title">Signal Details</title>
584
<refsect2 id="ESource-changed" role="signal"><title>The <literal>"changed"</literal> signal</title>
585
<indexterm zone="ESource-changed"><primary>ESource::changed</primary></indexterm>
586
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="ESource"><type>ESource</type></link> *esource,
587
<link linkend="gpointer"><type>gpointer</type></link> user_data) : Run Last</programlisting>
589
</para><variablelist role="params">
590
<varlistentry><term><parameter>esource</parameter> :</term>
591
<listitem><simpara>the object which received the signal.
592
</simpara></listitem></varlistentry>
593
<varlistentry><term><parameter>user_data</parameter> :</term>
594
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
595
</variablelist></refsect2>
added
removed
docs/reference/libedataserver/xml/e-source.xml
