16
17
<refsynopsisdiv id="ESourceGroup.synopsis" role="synopsis">
17
18
<title role="synopsis.title">Synopsis</title>
20
<link linkend="ESourceGroup-struct">ESourceGroup</link>;
21
<link linkend="ESourceGroup">ESourceGroup</link> * <link linkend="e-source-group-new">e_source_group_new</link> (const <link linkend="gchar">gchar</link> *name,
22
const <link linkend="gchar">gchar</link> *base_uri);
23
<link linkend="ESourceGroup">ESourceGroup</link> * <link linkend="e-source-group-new-from-xml">e_source_group_new_from_xml</link> (const <link linkend="gchar">gchar</link> *xml);
24
<link linkend="ESourceGroup">ESourceGroup</link> * <link linkend="e-source-group-new-from-xmldoc">e_source_group_new_from_xmldoc</link> (<link linkend="xmlDocPtr">xmlDocPtr</link> doc);
25
<link linkend="gboolean">gboolean</link> <link linkend="e-source-group-update-from-xml">e_source_group_update_from_xml</link> (<link linkend="ESourceGroup">ESourceGroup</link> *group,
26
const <link linkend="gchar">gchar</link> *xml,
27
<link linkend="gboolean">gboolean</link> *changed_return);
28
<link linkend="gboolean">gboolean</link> <link linkend="e-source-group-update-from-xmldoc">e_source_group_update_from_xmldoc</link> (<link linkend="ESourceGroup">ESourceGroup</link> *group,
29
<link linkend="xmlDocPtr">xmlDocPtr</link> doc,
30
<link linkend="gboolean">gboolean</link> *changed_return);
31
<link linkend="gchar">gchar</link> * <link linkend="e-source-group-uid-from-xmldoc">e_source_group_uid_from_xmldoc</link> (<link linkend="xmlDocPtr">xmlDocPtr</link> doc);
32
<link linkend="void">void</link> <link linkend="e-source-group-set-name">e_source_group_set_name</link> (<link linkend="ESourceGroup">ESourceGroup</link> *group,
33
const <link linkend="gchar">gchar</link> *name);
34
<link linkend="void">void</link> <link linkend="e-source-group-set-base-uri">e_source_group_set_base_uri</link> (<link linkend="ESourceGroup">ESourceGroup</link> *group,
35
const <link linkend="gchar">gchar</link> *base_uri);
36
<link linkend="void">void</link> <link linkend="e-source-group-set-readonly">e_source_group_set_readonly</link> (<link linkend="ESourceGroup">ESourceGroup</link> *group,
37
<link linkend="gboolean">gboolean</link> readonly);
38
const <link linkend="gchar">gchar</link> * <link linkend="e-source-group-peek-uid">e_source_group_peek_uid</link> (<link linkend="ESourceGroup">ESourceGroup</link> *group);
39
const <link linkend="gchar">gchar</link> * <link linkend="e-source-group-peek-name">e_source_group_peek_name</link> (<link linkend="ESourceGroup">ESourceGroup</link> *group);
40
const <link linkend="gchar">gchar</link> * <link linkend="e-source-group-peek-base-uri">e_source_group_peek_base_uri</link> (<link linkend="ESourceGroup">ESourceGroup</link> *group);
41
<link linkend="gboolean">gboolean</link> <link linkend="e-source-group-get-readonly">e_source_group_get_readonly</link> (<link linkend="ESourceGroup">ESourceGroup</link> *group);
42
<link linkend="GSList">GSList</link> * <link linkend="e-source-group-peek-sources">e_source_group_peek_sources</link> (<link linkend="ESourceGroup">ESourceGroup</link> *group);
43
<link linkend="ESource">ESource</link> * <link linkend="e-source-group-peek-source-by-uid">e_source_group_peek_source_by_uid</link> (<link linkend="ESourceGroup">ESourceGroup</link> *group,
44
const <link linkend="gchar">gchar</link> *source_uid);
45
<link linkend="ESource">ESource</link> * <link linkend="e-source-group-peek-source-by-name">e_source_group_peek_source_by_name</link> (<link linkend="ESourceGroup">ESourceGroup</link> *group,
46
const <link linkend="gchar">gchar</link> *source_name);
47
<link linkend="gboolean">gboolean</link> <link linkend="e-source-group-add-source">e_source_group_add_source</link> (<link linkend="ESourceGroup">ESourceGroup</link> *group,
48
<link linkend="ESource">ESource</link> *source,
49
<link linkend="gint">gint</link> position);
50
<link linkend="gboolean">gboolean</link> <link linkend="e-source-group-remove-source">e_source_group_remove_source</link> (<link linkend="ESourceGroup">ESourceGroup</link> *group,
51
<link linkend="ESource">ESource</link> *source);
52
<link linkend="gboolean">gboolean</link> <link linkend="e-source-group-remove-source-by-uid">e_source_group_remove_source_by_uid</link> (<link linkend="ESourceGroup">ESourceGroup</link> *group,
53
const <link linkend="gchar">gchar</link> *uid);
54
<link linkend="gchar">gchar</link> * <link linkend="e-source-group-get-property">e_source_group_get_property</link> (<link linkend="ESourceGroup">ESourceGroup</link> *source,
55
const <link linkend="gchar">gchar</link> *property);
56
<link linkend="void">void</link> <link linkend="e-source-group-set-property">e_source_group_set_property</link> (<link linkend="ESourceGroup">ESourceGroup</link> *source,
57
const <link linkend="gchar">gchar</link> *property,
58
const <link linkend="gchar">gchar</link> *value);
59
<link linkend="void">void</link> <link linkend="e-source-group-foreach-property">e_source_group_foreach_property</link> (<link linkend="ESourceGroup">ESourceGroup</link> *source,
60
<link linkend="GHFunc">GHFunc</link> func,
61
<link linkend="gpointer">gpointer</link> data);
62
<link linkend="gchar">gchar</link> * <link linkend="e-source-group-to-xml">e_source_group_to_xml</link> (<link linkend="ESourceGroup">ESourceGroup</link> *group);
63
<link linkend="gboolean">gboolean</link> <link linkend="e-source-group-equal">e_source_group_equal</link> (<link linkend="ESourceGroup">ESourceGroup</link> *a,
64
<link linkend="ESourceGroup">ESourceGroup</link> *b);
65
<link linkend="gboolean">gboolean</link> <link linkend="e-source-group-xmlstr-equal">e_source_group_xmlstr_equal</link> (const <link linkend="gchar">gchar</link> *a,
66
const <link linkend="gchar">gchar</link> *b);
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>);
70
69
<refsect1 id="ESourceGroup.object-hierarchy" role="object_hierarchy">
71
70
<title role="object_hierarchy.title">Object Hierarchy</title>
424
439
</variablelist></refsect2>
425
440
<refsect2 id="e-source-group-equal" role="function">
426
441
<title>e_source_group_equal ()</title>
427
<indexterm zone="e-source-group-equal"><primary sortas="e_source_group_equal">e_source_group_equal</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> e_source_group_equal (<link linkend="ESourceGroup">ESourceGroup</link> *a,
428
<link linkend="ESourceGroup">ESourceGroup</link> *b);</programlisting>
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>
430
446
Compares if <parameter>a</parameter> is equivalent to <parameter>b</parameter>.</para>
432
</para><variablelist role="params">
447
<variablelist role="params">
433
448
<varlistentry><term><parameter>a</parameter> :</term>
434
<listitem><simpara> An ESourceGroup
449
<listitem><simpara>An ESourceGroup
435
450
</simpara></listitem></varlistentry>
436
451
<varlistentry><term><parameter>b</parameter> :</term>
437
<listitem><simpara> Another ESourceGroup
452
<listitem><simpara>Another ESourceGroup
438
453
</simpara></listitem></varlistentry>
439
<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>,
440
<link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
454
<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>,
455
<link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
441
456
</simpara></listitem></varlistentry>
442
457
</variablelist></refsect2>
443
458
<refsect2 id="e-source-group-xmlstr-equal" role="function">
444
459
<title>e_source_group_xmlstr_equal ()</title>
445
<indexterm zone="e-source-group-xmlstr-equal"><primary sortas="e_source_group_xmlstr_equal">e_source_group_xmlstr_equal</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> e_source_group_xmlstr_equal (const <link linkend="gchar">gchar</link> *a,
446
const <link linkend="gchar">gchar</link> *b);</programlisting>
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>
448
464
Compares if <parameter>a</parameter> is equivalent to <parameter>b</parameter>.</para>
450
</para><variablelist role="params">
465
<variablelist role="params">
451
466
<varlistentry><term><parameter>a</parameter> :</term>
452
<listitem><simpara> XML representation of an ESourceGroup
467
<listitem><simpara>XML representation of an ESourceGroup
453
468
</simpara></listitem></varlistentry>
454
469
<varlistentry><term><parameter>b</parameter> :</term>
455
<listitem><simpara> XML representation of another ESourceGroup
470
<listitem><simpara>XML representation of another ESourceGroup
456
471
</simpara></listitem></varlistentry>
457
<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>,
458
<link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
472
<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>,
473
<link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
459
474
</simpara></listitem></varlistentry>
460
475
</variablelist></refsect2>
464
478
<refsect1 id="ESourceGroup.signal-details" role="signals">
465
479
<title role="signals.title">Signal Details</title>
466
480
<refsect2 id="ESourceGroup-changed" role="signal"><title>The <literal>"changed"</literal> signal</title>
467
<indexterm zone="ESourceGroup-changed"><primary sortas="ESourceGroup::changed">ESourceGroup::changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="ESourceGroup">ESourceGroup</link> *esourcegroup,
468
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
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>
470
485
</para><variablelist role="params">
471
486
<varlistentry><term><parameter>esourcegroup</parameter> :</term>