/usr/share/gtk-doc/html/evolution-data-server/evolution-data-server-ESourceExtension.html is in evolution-data-server-doc 3.28.1-1ubuntu1.
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>ESourceExtension: Evolution-Data-Server Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Reference Manual">
<link rel="up" href="ch02.html" title="Data Source Extensions">
<link rel="prev" href="evolution-data-server-ESourceAutoconfig.html" title="ESourceAutoconfig">
<link rel="next" href="evolution-data-server-ESourceBackend.html" title="ESourceBackend">
<meta name="generator" content="GTK-Doc V1.27 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#evolution-data-server-ESourceExtension.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="evolution-data-server-ESourceAutoconfig.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="evolution-data-server-ESourceBackend.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="evolution-data-server-ESourceExtension"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="evolution-data-server-ESourceExtension.top_of_page"></a>ESourceExtension</span></h2>
<p>ESourceExtension — Base class for <a class="link" href="evolution-data-server-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> extensions</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="evolution-data-server-ESourceExtension.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="evolution-data-server-ESource.html#ESource" title="struct ESource"><span class="returnvalue">ESource</span></a> *
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ESourceExtension.html#e-source-extension-ref-source" title="e_source_extension_ref_source ()">e_source_extension_ref_source</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ESourceExtension.html#e-source-extension-property-lock" title="e_source_extension_property_lock ()">e_source_extension_property_lock</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ESourceExtension.html#e-source-extension-property-unlock" title="e_source_extension_property_unlock ()">e_source_extension_property_unlock</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="evolution-data-server-ESource.html#ESource" title="struct ESource"><span class="returnvalue">ESource</span></a> *
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ESourceExtension.html#e-source-extension-get-source" title="e_source_extension_get_source ()">e_source_extension_get_source</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-data-server-ESourceExtension.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="evolution-data-server-ESourceExtension.html#ESourceExtension" title="struct ESourceExtension">ESourceExtension</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-data-server-ESourceExtension.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libedataserver/libedataserver.h>
</pre>
</div>
<div class="refsect1">
<a name="evolution-data-server-ESourceExtension.description"></a><h2>Description</h2>
<p><a class="link" href="evolution-data-server-ESourceExtension.html#ESourceExtension" title="struct ESourceExtension"><span class="type">ESourceExtension</span></a> is an abstract base class for <a class="link" href="evolution-data-server-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> extension
objects. An <a class="link" href="evolution-data-server-ESourceExtension.html#ESourceExtension" title="struct ESourceExtension"><span class="type">ESourceExtension</span></a> object basically just maps the keys in
a key file group to a set of <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a> properties. The name of the key
file group doubles as the name of the <a class="link" href="evolution-data-server-ESourceExtension.html#ESourceExtension" title="struct ESourceExtension"><span class="type">ESourceExtension</span></a> object.</p>
<p><a class="link" href="evolution-data-server-ESourceExtension.html#ESourceExtension" title="struct ESourceExtension"><span class="type">ESourceExtension</span></a> objects are accessed through <a class="link" href="evolution-data-server-ESource.html#e-source-get-extension" title="e_source_get_extension ()"><code class="function">e_source_get_extension()</code></a>.</p>
</div>
<div class="refsect1">
<a name="evolution-data-server-ESourceExtension.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-source-extension-ref-source"></a><h3>e_source_extension_ref_source ()</h3>
<pre class="programlisting"><a class="link" href="evolution-data-server-ESource.html#ESource" title="struct ESource"><span class="returnvalue">ESource</span></a> *
e_source_extension_ref_source (<em class="parameter"><code><a class="link" href="evolution-data-server-ESourceExtension.html#ESourceExtension" title="struct ESourceExtension"><span class="type">ESourceExtension</span></a> *extension</code></em>);</pre>
<p>Returns the <a class="link" href="evolution-data-server-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> instance to which the <em class="parameter"><code>extension</code></em>
belongs.</p>
<p>The returned <a class="link" href="evolution-data-server-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> is referenced for thread-safety. Unreference
the <a class="link" href="evolution-data-server-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.</p>
<div class="refsect3">
<a name="e-source-extension-ref-source.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>extension</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-data-server-ESourceExtension.html#ESourceExtension" title="struct ESourceExtension"><span class="type">ESourceExtension</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-source-extension-ref-source.returns"></a><h4>Returns</h4>
<p>the <a class="link" href="evolution-data-server-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> instance. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-8.html#api-index-3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-extension-property-lock"></a><h3>e_source_extension_property_lock ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_source_extension_property_lock (<em class="parameter"><code><a class="link" href="evolution-data-server-ESourceExtension.html#ESourceExtension" title="struct ESourceExtension"><span class="type">ESourceExtension</span></a> *extension</code></em>);</pre>
<p>Acquires a property lock, thus no other thread can change properties
of the <em class="parameter"><code>extension</code></em>
until the lock is released.</p>
<div class="refsect3">
<a name="e-source-extension-property-lock.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>extension</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-data-server-ESourceExtension.html#ESourceExtension" title="struct ESourceExtension"><span class="type">ESourceExtension</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-18.html#api-index-3.18">3.18</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-extension-property-unlock"></a><h3>e_source_extension_property_unlock ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_source_extension_property_unlock (<em class="parameter"><code><a class="link" href="evolution-data-server-ESourceExtension.html#ESourceExtension" title="struct ESourceExtension"><span class="type">ESourceExtension</span></a> *extension</code></em>);</pre>
<p>Releases a property lock, previously acquired with <a class="link" href="evolution-data-server-ESourceExtension.html#e-source-extension-property-lock" title="e_source_extension_property_lock ()"><code class="function">e_source_extension_property_lock()</code></a>,
thus other threads can change properties of the <em class="parameter"><code>extension</code></em>
.</p>
<div class="refsect3">
<a name="e-source-extension-property-unlock.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>extension</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-data-server-ESourceExtension.html#ESourceExtension" title="struct ESourceExtension"><span class="type">ESourceExtension</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-18.html#api-index-3.18">3.18</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-extension-get-source"></a><h3>e_source_extension_get_source ()</h3>
<pre class="programlisting"><a class="link" href="evolution-data-server-ESource.html#ESource" title="struct ESource"><span class="returnvalue">ESource</span></a> *
e_source_extension_get_source (<em class="parameter"><code><a class="link" href="evolution-data-server-ESourceExtension.html#ESourceExtension" title="struct ESourceExtension"><span class="type">ESourceExtension</span></a> *extension</code></em>);</pre>
<div class="warning">
<p><code class="literal">e_source_extension_get_source</code> has been deprecated since version 3.8 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="evolution-data-server-ESourceExtension.html#e-source-extension-ref-source" title="e_source_extension_ref_source ()"><code class="function">e_source_extension_ref_source()</code></a> instead.</p>
</div>
<p>Returns the <a class="link" href="evolution-data-server-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> instance to which <em class="parameter"><code>extension</code></em>
belongs.</p>
<p>Note this function is not thread-safe. The returned <a class="link" href="evolution-data-server-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> could
be finalized by another thread while the caller is still using it.</p>
<div class="refsect3">
<a name="e-source-extension-get-source.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>extension</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-data-server-ESourceExtension.html#ESourceExtension" title="struct ESourceExtension"><span class="type">ESourceExtension</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-source-extension-get-source.returns"></a><h4>Returns</h4>
<p>the <a class="link" href="evolution-data-server-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> instance. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-6.html#api-index-3.6">3.6</a></p>
</div>
</div>
<div class="refsect1">
<a name="evolution-data-server-ESourceExtension.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ESourceExtension"></a><h3>struct ESourceExtension</h3>
<pre class="programlisting">struct ESourceExtension {
};
</pre>
<p>Contains only private data that should be read and manipulated using the
functions below.</p>
<p class="since">Since: <a class="link" href="api-index-3-6.html#api-index-3.6">3.6</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|