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

« back to all changes in this revision

Viewing changes to docs/reference/libedataserver/html/ESource.html

  • Committer: Bazaar Package Importer
  • Author(s): Mathieu Trudel-Lapierre
  • Date: 2011-07-27 11:45:30 UTC
  • mfrom: (1.1.90 upstream)
  • Revision ID: james.westby@ubuntu.com-20110727114530-v4ntbu728os68b0b
Tags: 3.1.4-0ubuntu1
* New upstream version.
* debian/patches/999git_EDS_3_1_3_1_to_f94a069.patch: drop, included in
  the upstream 3.1.4 tarball.

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>ESource</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7
7
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Utilities (libedataserver)">
8
8
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Utilities (libedataserver)">
9
9
<link rel="prev" href="libedataserver-ESExp.html" title="ESExp">
10
10
<link rel="next" href="ESourceGroup.html" title="ESourceGroup">
11
 
<meta name="generator" content="GTK-Doc V1.17.1 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
42
42
<div class="refsynopsisdiv">
43
43
<a name="ESource.synopsis"></a><h2>Synopsis</h2>
44
44
<pre class="synopsis">struct              <a class="link" href="ESource.html#ESource-struct" title="struct ESource">ESource</a>;
45
 
<a class="link" href="ESource.html" title="ESource"><span class="returnvalue">ESource</span></a> *           <a class="link" href="ESource.html#e-source-new" title="e_source_new ()">e_source_new</a>                        (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
 
45
<a class="link" href="ESource.html" title="ESource"><span class="returnvalue">ESource</span></a> *                <a class="link" href="ESource.html#e-source-new" title="e_source_new ()">e_source_new</a>                        (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
46
46
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *relative_uri</code></em>);
47
 
<a class="link" href="ESource.html" title="ESource"><span class="returnvalue">ESource</span></a> *           <a class="link" href="ESource.html#e-source-new-with-absolute-uri" title="e_source_new_with_absolute_uri ()">e_source_new_with_absolute_uri</a>      (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
 
47
<a class="link" href="ESource.html" title="ESource"><span class="returnvalue">ESource</span></a> *                <a class="link" href="ESource.html#e-source-new-with-absolute-uri" title="e_source_new_with_absolute_uri ()">e_source_new_with_absolute_uri</a>      (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
48
48
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *absolute_uri</code></em>);
49
 
<a class="link" href="ESource.html" title="ESource"><span class="returnvalue">ESource</span></a> *           <a class="link" href="ESource.html#e-source-new-from-xml-node" title="e_source_new_from_xml_node ()">e_source_new_from_xml_node</a>          (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>);
 
49
<a class="link" href="ESource.html" title="ESource"><span class="returnvalue">ESource</span></a> *                <a class="link" href="ESource.html#e-source-new-from-xml-node" title="e_source_new_from_xml_node ()">e_source_new_from_xml_node</a>          (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>);
50
50
<a class="link" href="ESource.html" title="ESource"><span class="returnvalue">ESource</span></a> *           <a class="link" href="ESource.html#e-source-new-from-standalone-xml" title="e_source_new_from_standalone_xml ()">e_source_new_from_standalone_xml</a>    (<em class="parameter"><code>const <span class="type">gchar</span> *xml</code></em>);
51
 
<a class="link" href="ESource.html" title="ESource"><span class="returnvalue">ESource</span></a> *           <a class="link" href="ESource.html#e-source-copy" title="e_source_copy ()">e_source_copy</a>                       (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);
 
51
<a class="link" href="ESource.html" title="ESource"><span class="returnvalue">ESource</span></a> *                <a class="link" href="ESource.html#e-source-copy" title="e_source_copy ()">e_source_copy</a>                       (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);
52
52
<span class="returnvalue">gboolean</span>            <a class="link" href="ESource.html#e-source-update-from-xml-node" title="e_source_update_from_xml_node ()">e_source_update_from_xml_node</a>       (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
53
53
                                                         <em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
54
54
                                                         <em class="parameter"><code><span class="type">gboolean</span> *changed_return</code></em>);
55
 
<span class="returnvalue">gchar</span> *             <a class="link" href="ESource.html#e-source-uid-from-xml-node" title="e_source_uid_from_xml_node ()">e_source_uid_from_xml_node</a>          (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>);
 
55
<span class="returnvalue">gchar</span> *                           <a class="link" href="ESource.html#e-source-uid-from-xml-node" title="e_source_uid_from_xml_node ()">e_source_uid_from_xml_node</a>          (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>);
56
56
<span class="returnvalue">void</span>                <a class="link" href="ESource.html#e-source-set-group" title="e_source_set_group ()">e_source_set_group</a>                  (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
57
57
                                                         <em class="parameter"><code><span class="type">struct _ESourceGroup</span> *group</code></em>);
58
58
<span class="returnvalue">void</span>                <a class="link" href="ESource.html#e-source-set-name" title="e_source_set_name ()">e_source_set_name</a>                   (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
66
66
<span class="returnvalue">void</span>                <a class="link" href="ESource.html#e-source-set-readonly" title="e_source_set_readonly ()">e_source_set_readonly</a>               (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
67
67
                                                         <em class="parameter"><code><span class="type">gboolean</span> readonly</code></em>);
68
68
struct <a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="returnvalue">_ESourceGroup</span></a> * <a class="link" href="ESource.html#e-source-peek-group" title="e_source_peek_group ()">e_source_peek_group</a>              (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);
69
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="ESource.html#e-source-peek-uid" title="e_source_peek_uid ()">e_source_peek_uid</a>                   (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);
70
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="ESource.html#e-source-peek-name" title="e_source_peek_name ()">e_source_peek_name</a>                  (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);
71
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="ESource.html#e-source-peek-relative-uri" title="e_source_peek_relative_uri ()">e_source_peek_relative_uri</a>          (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);
72
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="ESource.html#e-source-peek-absolute-uri" title="e_source_peek_absolute_uri ()">e_source_peek_absolute_uri</a>          (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);
73
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="ESource.html#e-source-peek-color-spec" title="e_source_peek_color_spec ()">e_source_peek_color_spec</a>            (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);
 
69
const <span class="returnvalue">gchar</span> *        <a class="link" href="ESource.html#e-source-peek-uid" title="e_source_peek_uid ()">e_source_peek_uid</a>                   (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);
 
70
const <span class="returnvalue">gchar</span> *        <a class="link" href="ESource.html#e-source-peek-name" title="e_source_peek_name ()">e_source_peek_name</a>                  (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);
 
71
const <span class="returnvalue">gchar</span> *        <a class="link" href="ESource.html#e-source-peek-relative-uri" title="e_source_peek_relative_uri ()">e_source_peek_relative_uri</a>          (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);
 
72
const <span class="returnvalue">gchar</span> *        <a class="link" href="ESource.html#e-source-peek-absolute-uri" title="e_source_peek_absolute_uri ()">e_source_peek_absolute_uri</a>          (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);
 
73
const <span class="returnvalue">gchar</span> *        <a class="link" href="ESource.html#e-source-peek-color-spec" title="e_source_peek_color_spec ()">e_source_peek_color_spec</a>            (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);
74
74
<span class="returnvalue">gboolean</span>            <a class="link" href="ESource.html#e-source-get-readonly" title="e_source_get_readonly ()">e_source_get_readonly</a>               (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);
75
 
<span class="returnvalue">gchar</span> *             <a class="link" href="ESource.html#e-source-get-uri" title="e_source_get_uri ()">e_source_get_uri</a>                    (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);
 
75
<span class="returnvalue">gchar</span> *                           <a class="link" href="ESource.html#e-source-get-uri" title="e_source_get_uri ()">e_source_get_uri</a>                    (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);
76
76
<span class="returnvalue">void</span>                <a class="link" href="ESource.html#e-source-dump-to-xml-node" title="e_source_dump_to_xml_node ()">e_source_dump_to_xml_node</a>           (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
77
77
                                                         <em class="parameter"><code><span class="type">xmlNodePtr</span> parent_node</code></em>);
78
 
<span class="returnvalue">gchar</span> *             <a class="link" href="ESource.html#e-source-to-standalone-xml" title="e_source_to_standalone_xml ()">e_source_to_standalone_xml</a>          (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);
79
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="ESource.html#e-source-get-property" title="e_source_get_property ()">e_source_get_property</a>               (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
 
78
<span class="returnvalue">gchar</span> *                           <a class="link" href="ESource.html#e-source-to-standalone-xml" title="e_source_to_standalone_xml ()">e_source_to_standalone_xml</a>          (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);
 
79
const <span class="returnvalue">gchar</span> *        <a class="link" href="ESource.html#e-source-get-property" title="e_source_get_property ()">e_source_get_property</a>               (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
80
80
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>);
81
81
<span class="returnvalue">void</span>                <a class="link" href="ESource.html#e-source-set-property" title="e_source_set_property ()">e_source_set_property</a>               (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
82
82
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>,
84
84
<span class="returnvalue">void</span>                <a class="link" href="ESource.html#e-source-foreach-property" title="e_source_foreach_property ()">e_source_foreach_property</a>           (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
85
85
                                                         <em class="parameter"><code><span class="type">GHFunc</span> func</code></em>,
86
86
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
87
 
<span class="returnvalue">gchar</span> *             <a class="link" href="ESource.html#e-source-get-duped-property" title="e_source_get_duped_property ()">e_source_get_duped_property</a>         (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
 
87
<span class="returnvalue">gchar</span> *                           <a class="link" href="ESource.html#e-source-get-duped-property" title="e_source_get_duped_property ()">e_source_get_duped_property</a>         (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
88
88
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>);
89
 
<span class="returnvalue">gchar</span> *             <a class="link" href="ESource.html#e-source-build-absolute-uri" title="e_source_build_absolute_uri ()">e_source_build_absolute_uri</a>         (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);
 
89
<span class="returnvalue">gchar</span> *                           <a class="link" href="ESource.html#e-source-build-absolute-uri" title="e_source_build_absolute_uri ()">e_source_build_absolute_uri</a>         (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);
90
90
<span class="returnvalue">gboolean</span>            <a class="link" href="ESource.html#e-source-equal" title="e_source_equal ()">e_source_equal</a>                      (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *a</code></em>,
91
91
                                                         <em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *b</code></em>);
92
92
<span class="returnvalue">gboolean</span>            <a class="link" href="ESource.html#e-source-xmlstr-equal" title="e_source_xmlstr_equal ()">e_source_xmlstr_equal</a>               (<em class="parameter"><code>const <span class="type">gchar</span> *a</code></em>,
124
124
<hr>
125
125
<div class="refsect2">
126
126
<a name="e-source-new"></a><h3>e_source_new ()</h3>
127
 
<pre class="programlisting"><a class="link" href="ESource.html" title="ESource"><span class="returnvalue">ESource</span></a> *           e_source_new                        (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
 
127
<pre class="programlisting"><a class="link" href="ESource.html" title="ESource"><span class="returnvalue">ESource</span></a> *            e_source_new                        (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
128
128
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *relative_uri</code></em>);</pre>
129
129
<p>
130
130
Creates a new <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> instance, and gives it a display name specified
152
152
<hr>
153
153
<div class="refsect2">
154
154
<a name="e-source-new-with-absolute-uri"></a><h3>e_source_new_with_absolute_uri ()</h3>
155
 
<pre class="programlisting"><a class="link" href="ESource.html" title="ESource"><span class="returnvalue">ESource</span></a> *           e_source_new_with_absolute_uri      (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
 
155
<pre class="programlisting"><a class="link" href="ESource.html" title="ESource"><span class="returnvalue">ESource</span></a> *            e_source_new_with_absolute_uri      (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
156
156
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *absolute_uri</code></em>);</pre>
157
157
<p>
158
158
Creates a new <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> instance, and gives it a display name specified
180
180
<hr>
181
181
<div class="refsect2">
182
182
<a name="e-source-new-from-xml-node"></a><h3>e_source_new_from_xml_node ()</h3>
183
 
<pre class="programlisting"><a class="link" href="ESource.html" title="ESource"><span class="returnvalue">ESource</span></a> *           e_source_new_from_xml_node          (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>);</pre>
 
183
<pre class="programlisting"><a class="link" href="ESource.html" title="ESource"><span class="returnvalue">ESource</span></a> *            e_source_new_from_xml_node          (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>);</pre>
184
184
<p>
185
185
Creates a new <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> instance from the XML specification in <em class="parameter"><code>node</code></em>.
186
 
If the XML specification is invalid, the function returns <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>.
 
186
If the XML specification is invalid, the function returns <code class="literal">NULL</code>.
187
187
</p>
188
188
<div class="variablelist"><table border="0">
189
189
<col align="left" valign="top">
194
194
</tr>
195
195
<tr>
196
196
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
197
 
<td>a new <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a>, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 
197
<td>a new <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a>, or <code class="literal">NULL</code>
198
198
</td>
199
199
</tr>
200
200
</tbody>
227
227
<hr>
228
228
<div class="refsect2">
229
229
<a name="e-source-copy"></a><h3>e_source_copy ()</h3>
230
 
<pre class="programlisting"><a class="link" href="ESource.html" title="ESource"><span class="returnvalue">ESource</span></a> *           e_source_copy                       (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
 
230
<pre class="programlisting"><a class="link" href="ESource.html" title="ESource"><span class="returnvalue">ESource</span></a> *            e_source_copy                       (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
231
231
<p>
232
232
Creates a new <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> instance from <em class="parameter"><code>source</code></em>, such that passing <em class="parameter"><code>source</code></em>
233
233
and the newly created instance to <a class="link" href="ESource.html#e-source-equal" title="e_source_equal ()"><code class="function">e_source_equal()</code></a> would return <code class="literal">TRUE</code>.
256
256
                                                         <em class="parameter"><code><span class="type">gboolean</span> *changed_return</code></em>);</pre>
257
257
<p>
258
258
Update the <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> attributes from <em class="parameter"><code>node</code></em>.  If <em class="parameter"><code>changed_return</code></em> is
259
 
non-<a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>, it will be set to <code class="literal">TRUE</code> if any attributes were actually
 
259
non-<code class="literal">NULL</code>, it will be set to <code class="literal">TRUE</code> if any attributes were actually
260
260
changed in the course of the update.  This will also emit the
261
261
<a class="link" href="ESource.html#ESource-changed" title='The "changed" signal'><span class="type">"changed"</span></a> signal if any attributes were actually changed.
262
262
</p>
273
273
</tr>
274
274
<tr>
275
275
<td><p><span class="term"><em class="parameter"><code>changed_return</code></em> :</span></p></td>
276
 
<td>return location for change confirmation, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 
276
<td>return location for change confirmation, or <code class="literal">NULL</code>
277
277
</td>
278
278
</tr>
279
279
<tr>
288
288
<hr>
289
289
<div class="refsect2">
290
290
<a name="e-source-uid-from-xml-node"></a><h3>e_source_uid_from_xml_node ()</h3>
291
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             e_source_uid_from_xml_node          (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>);</pre>
 
291
<pre class="programlisting"><span class="returnvalue">gchar</span> *                       e_source_uid_from_xml_node          (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>);</pre>
292
292
<p>
293
293
Assuming that <em class="parameter"><code>node</code></em> is a valid <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> specification, retrieve the
294
294
source's unique identifier string from it.  Free the returned string
304
304
<tr>
305
305
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
306
306
<td>the unique ID of the source specified by <em class="parameter"><code>node</code></em>,
307
 
or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>node</code></em> is not a valid specification</td>
 
307
or <code class="literal">NULL</code> if <em class="parameter"><code>node</code></em> is not a valid specification</td>
308
308
</tr>
309
309
</tbody>
310
310
</table></div>
418
418
<pre class="programlisting"><span class="returnvalue">void</span>                e_source_set_absolute_uri           (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
419
419
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *absolute_uri</code></em>);</pre>
420
420
<p>
421
 
Sets a custom absolute URI for <em class="parameter"><code>source</code></em>.  If <em class="parameter"><code>absolute_uri</code></em> is <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>, the
 
421
Sets a custom absolute URI for <em class="parameter"><code>source</code></em>.  If <em class="parameter"><code>absolute_uri</code></em> is <code class="literal">NULL</code>, the
422
422
custom absolute URI is cleared and <em class="parameter"><code>source</code></em> will fall back to its relative
423
423
URI plus the base URI of its containing <a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="type">ESourceGroup</span></a>.
424
424
</p>
436
436
</tr>
437
437
<tr>
438
438
<td><p><span class="term"><em class="parameter"><code>absolute_uri</code></em> :</span></p></td>
439
 
<td>an absolute URI string, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 
439
<td>an absolute URI string, or <code class="literal">NULL</code>
440
440
</td>
441
441
</tr>
442
442
</tbody>
449
449
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *color_spec</code></em>);</pre>
450
450
<p>
451
451
Store a textual representation of a color in <em class="parameter"><code>source</code></em>.  The <em class="parameter"><code>color_spec</code></em>
452
 
string should be parsable by #<code class="function">gdk_color_parse()</code>, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> to unset the
 
452
string should be parsable by #<code class="function">gdk_color_parse()</code>, or <code class="literal">NULL</code> to unset the
453
453
color in <em class="parameter"><code>source</code></em>.
454
454
</p>
455
455
<p>
506
506
<a name="e-source-peek-group"></a><h3>e_source_peek_group ()</h3>
507
507
<pre class="programlisting">struct <a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="returnvalue">_ESourceGroup</span></a> * e_source_peek_group              (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
508
508
<p>
509
 
Returns the <a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="type">ESourceGroup</span></a> to which <em class="parameter"><code>source</code></em> belongs, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if it
 
509
Returns the <a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="type">ESourceGroup</span></a> to which <em class="parameter"><code>source</code></em> belongs, or <code class="literal">NULL</code> if it
510
510
does not belong to a group.
511
511
</p>
512
512
<div class="variablelist"><table border="0">
528
528
<hr>
529
529
<div class="refsect2">
530
530
<a name="e-source-peek-uid"></a><h3>e_source_peek_uid ()</h3>
531
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       e_source_peek_uid                   (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
 
531
<pre class="programlisting">const <span class="returnvalue">gchar</span> *            e_source_peek_uid                   (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
532
532
<p>
533
533
Returns the unique identifier string for <em class="parameter"><code>source</code></em>.
534
534
</p>
550
550
<hr>
551
551
<div class="refsect2">
552
552
<a name="e-source-peek-name"></a><h3>e_source_peek_name ()</h3>
553
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       e_source_peek_name                  (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
 
553
<pre class="programlisting">const <span class="returnvalue">gchar</span> *            e_source_peek_name                  (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
554
554
<p>
555
555
Returns the display name for <em class="parameter"><code>source</code></em>.
556
556
</p>
572
572
<hr>
573
573
<div class="refsect2">
574
574
<a name="e-source-peek-relative-uri"></a><h3>e_source_peek_relative_uri ()</h3>
575
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       e_source_peek_relative_uri          (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
 
575
<pre class="programlisting">const <span class="returnvalue">gchar</span> *            e_source_peek_relative_uri          (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
576
576
<p>
577
577
Returns the relative URI for <em class="parameter"><code>source</code></em>.
578
578
</p>
594
594
<hr>
595
595
<div class="refsect2">
596
596
<a name="e-source-peek-absolute-uri"></a><h3>e_source_peek_absolute_uri ()</h3>
597
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       e_source_peek_absolute_uri          (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
 
597
<pre class="programlisting">const <span class="returnvalue">gchar</span> *            e_source_peek_absolute_uri          (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
598
598
<p>
599
 
Returns the absolute URI for <em class="parameter"><code>source</code></em> if it has one, or else <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if
 
599
Returns the absolute URI for <em class="parameter"><code>source</code></em> if it has one, or else <code class="literal">NULL</code> if
600
600
it has only a relative URI.  <a class="link" href="ESource.html#e-source-get-uri" title="e_source_get_uri ()"><code class="function">e_source_get_uri()</code></a> may be more convenient.
601
601
</p>
602
602
<div class="variablelist"><table border="0">
609
609
</tr>
610
610
<tr>
611
611
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
612
 
<td>the source's own absolute URI, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 
612
<td>the source's own absolute URI, or <code class="literal">NULL</code>
613
613
</td>
614
614
</tr>
615
615
</tbody>
618
618
<hr>
619
619
<div class="refsect2">
620
620
<a name="e-source-peek-color-spec"></a><h3>e_source_peek_color_spec ()</h3>
621
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       e_source_peek_color_spec            (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
 
621
<pre class="programlisting">const <span class="returnvalue">gchar</span> *            e_source_peek_color_spec            (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
622
622
<p>
623
 
Return the textual representation of the color for <em class="parameter"><code>source</code></em>, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if it
 
623
Return the textual representation of the color for <em class="parameter"><code>source</code></em>, or <code class="literal">NULL</code> if it
624
624
has none.  The returned string should be parsable by #<code class="function">gdk_color_parse()</code>.
625
625
</p>
626
626
<div class="variablelist"><table border="0">
665
665
<hr>
666
666
<div class="refsect2">
667
667
<a name="e-source-get-uri"></a><h3>e_source_get_uri ()</h3>
668
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             e_source_get_uri                    (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
 
668
<pre class="programlisting"><span class="returnvalue">gchar</span> *                       e_source_get_uri                    (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
669
669
<p>
670
670
Returns a newly-allocated copy of an absolute URI for <em class="parameter"><code>source</code></em>.  If
671
671
<em class="parameter"><code>source</code></em> has no absolute URI of its own, the URI is constructed from
714
714
<hr>
715
715
<div class="refsect2">
716
716
<a name="e-source-to-standalone-xml"></a><h3>e_source_to_standalone_xml ()</h3>
717
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             e_source_to_standalone_xml          (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
 
717
<pre class="programlisting"><span class="returnvalue">gchar</span> *                       e_source_to_standalone_xml          (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
718
718
<p>
719
719
Converts <em class="parameter"><code>source</code></em> to an XML string for permanent storage.
720
720
Free the returned string with <code class="function">g_free()</code>.
737
737
<hr>
738
738
<div class="refsect2">
739
739
<a name="e-source-get-property"></a><h3>e_source_get_property ()</h3>
740
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       e_source_get_property               (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
 
740
<pre class="programlisting">const <span class="returnvalue">gchar</span> *            e_source_get_property               (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
741
741
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>);</pre>
742
742
<p>
743
743
Looks up the value of a custom <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> property.  If no such
744
 
property name exists in <em class="parameter"><code>source</code></em>, the function returns <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>.
 
744
property name exists in <em class="parameter"><code>source</code></em>, the function returns <code class="literal">NULL</code>.
745
745
</p>
746
746
<div class="variablelist"><table border="0">
747
747
<col align="left" valign="top">
757
757
</tr>
758
758
<tr>
759
759
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
760
 
<td>the property value, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 
760
<td>the property value, or <code class="literal">NULL</code>
761
761
</td>
762
762
</tr>
763
763
</tbody>
771
771
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *property_value</code></em>);</pre>
772
772
<p>
773
773
Create a new custom <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> property or replaces an existing one.  If
774
 
<em class="parameter"><code>property_value</code></em> is <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>, the property is removed from <em class="parameter"><code>source</code></em>.  This
 
774
<em class="parameter"><code>property_value</code></em> is <code class="literal">NULL</code>, the property is removed from <em class="parameter"><code>source</code></em>.  This
775
775
will also emit a <a class="link" href="ESource.html#ESource-changed" title='The "changed" signal'><span class="type">"changed"</span></a> signal.
776
776
</p>
777
777
<div class="variablelist"><table border="0">
788
788
</tr>
789
789
<tr>
790
790
<td><p><span class="term"><em class="parameter"><code>property_value</code></em> :</span></p></td>
791
 
<td>a new value for the property, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 
791
<td>a new value for the property, or <code class="literal">NULL</code>
792
792
</td>
793
793
</tr>
794
794
</tbody>
828
828
<hr>
829
829
<div class="refsect2">
830
830
<a name="e-source-get-duped-property"></a><h3>e_source_get_duped_property ()</h3>
831
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             e_source_get_duped_property         (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
 
831
<pre class="programlisting"><span class="returnvalue">gchar</span> *                       e_source_get_duped_property         (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
832
832
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>);</pre>
833
833
<p>
834
834
Looks up the value of a custom <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> property and returns a
835
835
newly-allocated copy of the value.  If no such property name exists
836
 
in <em class="parameter"><code>source</code></em>, the function returns <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>.  Free the returned value
 
836
in <em class="parameter"><code>source</code></em>, the function returns <code class="literal">NULL</code>.  Free the returned value
837
837
with <code class="function">g_free()</code>.
838
838
</p>
839
839
<div class="variablelist"><table border="0">
850
850
</tr>
851
851
<tr>
852
852
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
853
 
<td>a newly-allocated copy of the property value, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 
853
<td>a newly-allocated copy of the property value, or <code class="literal">NULL</code>
854
854
</td>
855
855
</tr>
856
856
</tbody>
860
860
<hr>
861
861
<div class="refsect2">
862
862
<a name="e-source-build-absolute-uri"></a><h3>e_source_build_absolute_uri ()</h3>
863
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             e_source_build_absolute_uri         (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
 
863
<pre class="programlisting"><span class="returnvalue">gchar</span> *                       e_source_build_absolute_uri         (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
864
864
<p>
865
865
Builds an absolute URI string using the base URI of the <a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="type">ESourceGroup</span></a>
866
866
to which <em class="parameter"><code>source</code></em> belongs, and its own relative URI.  This function
969
969
</div>
970
970
<div class="footer">
971
971
<hr>
972
 
          Generated by GTK-Doc V1.17.1</div>
 
972
          Generated by GTK-Doc V1.17</div>
973
973
</body>
974
974
</html>
 
 
b'\\ No newline at end of file'