/usr/share/gtk-doc/html/camel/CamelSettings.html is in libcamel1.2-dev 3.2.3-0ubuntu6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelSettings</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Services.html" title="Services">
<link rel="prev" href="CamelTransport.html" title="CamelTransport">
<link rel="next" href="CamelNetworkSettings.html" title="CamelNetworkSettings">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="CamelTransport.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Services.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Camel Reference Manual</th>
<td><a accesskey="n" href="CamelNetworkSettings.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#CamelSettings.synopsis" class="shortcut">Top</a>
|
<a href="#CamelSettings.description" class="shortcut">Description</a>
|
<a href="#CamelSettings.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="CamelSettings"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CamelSettings.top_of_page"></a>CamelSettings</span></h2>
<p>CamelSettings</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="CamelSettings.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="CamelSettings.html#CamelSettings-struct" title="struct CamelSettings">CamelSettings</a>;
<span class="returnvalue">GParamSpec</span> ** <a class="link" href="CamelSettings.html#camel-settings-class-list-settings" title="camel_settings_class_list_settings ()">camel_settings_class_list_settings</a> (<em class="parameter"><code><span class="type">CamelSettingsClass</span> *klass</code></em>,
<em class="parameter"><code><span class="type">guint</span> *n_settings</code></em>);
<a class="link" href="CamelSettings.html" title="CamelSettings"><span class="returnvalue">CamelSettings</span></a> * <a class="link" href="CamelSettings.html#camel-settings-clone" title="camel_settings_clone ()">camel_settings_clone</a> (<em class="parameter"><code><a class="link" href="CamelSettings.html" title="CamelSettings"><span class="type">CamelSettings</span></a> *settings</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="CamelSettings.html#camel-settings-equal" title="camel_settings_equal ()">camel_settings_equal</a> (<em class="parameter"><code><a class="link" href="CamelSettings.html" title="CamelSettings"><span class="type">CamelSettings</span></a> *settings_a</code></em>,
<em class="parameter"><code><a class="link" href="CamelSettings.html" title="CamelSettings"><span class="type">CamelSettings</span></a> *settings_b</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelSettings.html#camel-settings-load-from-url" title="camel_settings_load_from_url ()">camel_settings_load_from_url</a> (<em class="parameter"><code><a class="link" href="CamelSettings.html" title="CamelSettings"><span class="type">CamelSettings</span></a> *settings</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-url.html#CamelURL" title="struct CamelURL"><span class="type">CamelURL</span></a> *url</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelSettings.html#camel-settings-save-to-url" title="camel_settings_save_to_url ()">camel_settings_save_to_url</a> (<em class="parameter"><code><a class="link" href="CamelSettings.html" title="CamelSettings"><span class="type">CamelSettings</span></a> *settings</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-url.html#CamelURL" title="struct CamelURL"><span class="type">CamelURL</span></a> *url</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="CamelSettings.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----CamelSettings
+----<a class="link" href="CamelStoreSettings.html" title="CamelStoreSettings">CamelStoreSettings</a>
</pre>
</div>
<div class="refsect1">
<a name="CamelSettings.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="CamelSettings.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CamelSettings-struct"></a><h3>struct CamelSettings</h3>
<pre class="programlisting">struct CamelSettings;</pre>
<p>
Contains only private data that should be read and manipulated using the
functions below.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-settings-class-list-settings"></a><h3>camel_settings_class_list_settings ()</h3>
<pre class="programlisting"><span class="returnvalue">GParamSpec</span> ** camel_settings_class_list_settings (<em class="parameter"><code><span class="type">CamelSettingsClass</span> *klass</code></em>,
<em class="parameter"><code><span class="type">guint</span> *n_settings</code></em>);</pre>
<p>
Returns an array of <span class="type">GParamSpec</span> for properties of <em class="parameter"><code>class</code></em> which are
considered to be settings. By default all properties are considered
to be settings, but subclasses may wish to exclude certain properties.
Free the returned array with <code class="function">g_free()</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>n_settings</code></em> :</span></p></td>
<td>return location for the length of the returned array</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an array of <span class="type">GParamSpec</span> which should be freed after use</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-settings-clone"></a><h3>camel_settings_clone ()</h3>
<pre class="programlisting"><a class="link" href="CamelSettings.html" title="CamelSettings"><span class="returnvalue">CamelSettings</span></a> * camel_settings_clone (<em class="parameter"><code><a class="link" href="CamelSettings.html" title="CamelSettings"><span class="type">CamelSettings</span></a> *settings</code></em>);</pre>
<p>
Creates an copy of <em class="parameter"><code>settings</code></em>, such that passing <em class="parameter"><code>settings</code></em> and the
copied instance to <a class="link" href="CamelSettings.html#camel-settings-equal" title="camel_settings_equal ()"><code class="function">camel_settings_equal()</code></a> would return <code class="literal">TRUE</code>.
</p>
<p>
By default, this creates a new settings instance with the same <span class="type">GType</span>
as <em class="parameter"><code>settings</code></em>, and copies all <span class="type">GObject</span> property values from <em class="parameter"><code>settings</code></em>
to the new instance.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSettings.html" title="CamelSettings"><span class="type">CamelSettings</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly-created copy of <em class="parameter"><code>settings</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-settings-equal"></a><h3>camel_settings_equal ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> camel_settings_equal (<em class="parameter"><code><a class="link" href="CamelSettings.html" title="CamelSettings"><span class="type">CamelSettings</span></a> *settings_a</code></em>,
<em class="parameter"><code><a class="link" href="CamelSettings.html" title="CamelSettings"><span class="type">CamelSettings</span></a> *settings_b</code></em>);</pre>
<p>
Returns <code class="literal">TRUE</code> if <em class="parameter"><code>settings_a</code></em> and <em class="parameter"><code>settings_b</code></em> are equal.
</p>
<p>
By default, equality requires both instances to have the same <span class="type">GType</span>
with the same set of <span class="type">GObject</span> properties, and each property value in
<em class="parameter"><code>settings_a</code></em> is equal to the corresponding value in <em class="parameter"><code>settings_b</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings_a</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSettings.html" title="CamelSettings"><span class="type">CamelSettings</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings_b</code></em> :</span></p></td>
<td>another <a class="link" href="CamelSettings.html" title="CamelSettings"><span class="type">CamelSettings</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if <em class="parameter"><code>settings_a</code></em> and <em class="parameter"><code>settings_b</code></em> are equal</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-settings-load-from-url"></a><h3>camel_settings_load_from_url ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_settings_load_from_url (<em class="parameter"><code><a class="link" href="CamelSettings.html" title="CamelSettings"><span class="type">CamelSettings</span></a> *settings</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-url.html#CamelURL" title="struct CamelURL"><span class="type">CamelURL</span></a> *url</code></em>);</pre>
<p>
Populates <em class="parameter"><code>settings</code></em> with parameters from <em class="parameter"><code>url</code></em>. The <em class="parameter"><code>url</code></em> parameter value
is converted according to the <span class="type">GParamSpec</span> for the corresponding property
name in <em class="parameter"><code>settings</code></em>.
</p>
<p>
This function is highly Evolution-centric and is only temporary.
Expect this function to be removed as early as version 3.4.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSettings.html" title="CamelSettings"><span class="type">CamelSettings</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>url</code></em> :</span></p></td>
<td>a <a class="link" href="camel-camel-url.html#CamelURL" title="struct CamelURL"><span class="type">CamelURL</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-settings-save-to-url"></a><h3>camel_settings_save_to_url ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_settings_save_to_url (<em class="parameter"><code><a class="link" href="CamelSettings.html" title="CamelSettings"><span class="type">CamelSettings</span></a> *settings</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-url.html#CamelURL" title="struct CamelURL"><span class="type">CamelURL</span></a> *url</code></em>);</pre>
<p>
Writes the values of all properties of <em class="parameter"><code>settings</code></em> to <em class="parameter"><code>url</code></em> as parameter
strings. The parameter name in <em class="parameter"><code>url</code></em> matches the corresponding property
in <em class="parameter"><code>settings</code></em>.
</p>
<p>
This function is highly Evolution-centric and is only temporary.
Expect this function to be removed as early as version 3.4.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSettings.html" title="CamelSettings"><span class="type">CamelSettings</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>url</code></em> :</span></p></td>
<td>a <a class="link" href="camel-camel-url.html#CamelURL" title="struct CamelURL"><span class="type">CamelURL</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|