/usr/share/gtk-doc/html/libebackend/EExtensible.html is in evolution-data-server-doc 3.10.4-0ubuntu1.6.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Evolution-Data-Server Manual: Backend Utilities (libebackend): EExtensible</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Backend Utilities (libebackend)">
<link rel="up" href="ch01.html" title="Base Classes for Backends">
<link rel="prev" href="EDBusServer.html" title="EDBusServer">
<link rel="next" href="EExtension.html" title="EExtension">
<meta name="generator" content="GTK-Doc V1.20 (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="10"><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="#EExtensible.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#EExtensible.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites"> <span class="dim">|</span>
<a href="#EExtensible.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations"> <span class="dim">|</span>
<a href="#EExtensible.implementations" class="shortcut">Known Implementations</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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="EDBusServer.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="EExtension.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="EExtensible"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EExtensible.top_of_page"></a>EExtensible</span></h2>
<p>EExtensible — An interface for extending objects</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="EExtensible.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="EExtensible.html#e-extensible-list-extensions" title="e_extensible_list_extensions ()">e_extensible_list_extensions</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="EExtensible.html#e-extensible-load-extensions" title="e_extensible_load_extensions ()">e_extensible_load_extensions</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EExtensible.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="EExtensible.html#EExtensible-struct" title="EExtensible">EExtensible</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EExtensible.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GInterface
<span class="lineart">╰──</span> EExtensible
</pre>
</div>
<div class="refsect1">
<a name="EExtensible.prerequisites"></a><h2>Prerequisites</h2>
<p>
EExtensible requires
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p>
</div>
<div class="refsect1">
<a name="EExtensible.implementations"></a><h2>Known Implementations</h2>
<p>
EExtensible is implemented by
<a class="link" href="EDBusServer.html" title="EDBusServer">EDBusServer</a>, <a class="link" href="EDataFactory.html" title="EDataFactory">EDataFactory</a>, <a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer">ESourceRegistryServer</a> and <a class="link" href="EUserPrompterServer.html" title="EUserPrompterServer">EUserPrompterServer</a>.</p>
</div>
<div class="refsect1">
<a name="EExtensible.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libebackend/libebackend.h>
</pre>
</div>
<div class="refsect1">
<a name="EExtensible.description"></a><h2>Description</h2>
<p><a class="link" href="EExtension.html" title="EExtension"><span class="type">EExtension</span></a> objects can be tacked on to any <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> instance that
implements the <a class="link" href="EExtensible.html" title="EExtensible"><span class="type">EExtensible</span></a> interface. A <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> type can be made
extensible in two steps:</p>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><p>Add the <a class="link" href="EExtensible.html" title="EExtensible"><span class="type">EExtensible</span></a> interface when registering the <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a>.
There are no methods to implement.</p></li></ol></div>
<div class="informalexample"><pre class="programlisting">
#include <libebackend/libebackend.h>
G_DEFINE_TYPE_WITH_CODE (
ECustomWidget, e_custom_widget, GTK_TYPE_WIDGET,
G_IMPLEMENT_INTERFACE (E_TYPE_EXTENSIBLE, NULL))
</pre></div>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><p>Load extensions for the class at some point during <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>
initialization. Generally this should be done toward the end of
the initialization code, so extensions get a fully initialized
object to work with.</p></li></ol></div>
<div class="informalexample"><pre class="programlisting">
static void
e_custom_widget_constructed (ECustomWidget *widget)
{
Construction code goes here, same as call to parent's 'constructed'...
e_extensible_load_extensions (E_EXTENSIBLE (widget));
}
</pre></div>
</div>
<div class="refsect1">
<a name="EExtensible.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-extensible-list-extensions"></a><h3>e_extensible_list_extensions ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
e_extensible_list_extensions (<em class="parameter"><code><a class="link" href="EExtensible.html" title="EExtensible"><span class="type">EExtensible</span></a> *extensible</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> extension_type</code></em>);</pre>
<p>Returns a list of <a class="link" href="EExtension.html" title="EExtension"><span class="type">EExtension</span></a> objects bound to <em class="parameter"><code>extensible</code></em>
whose
types are ancestors of <em class="parameter"><code>extension_type</code></em>
. For a complete list of
extension objects bound to <em class="parameter"><code>extensible</code></em>
, pass <code class="literal">E_TYPE_EXTENSION</code>.</p>
<p>The list itself should be freed with <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a>. The extension
objects are owned by <em class="parameter"><code>extensible</code></em>
and should not be unreferenced.</p>
<div class="refsect3">
<a name="id-1.2.6.10.2.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>extensible</p></td>
<td class="parameter_description"><p>an <a class="link" href="EExtensible.html" title="EExtensible"><span class="type">EExtensible</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>extension_type</p></td>
<td class="parameter_description"><p>the type of extensions to list</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.10.2.7"></a><h4>Returns</h4>
<p> a list of extension objects derived from <em class="parameter"><code>extension_type</code></em>
</p>
<p></p>
</div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2">
<a name="e-extensible-load-extensions"></a><h3>e_extensible_load_extensions ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_extensible_load_extensions (<em class="parameter"><code><a class="link" href="EExtensible.html" title="EExtensible"><span class="type">EExtensible</span></a> *extensible</code></em>);</pre>
<p>Creates an instance of all instantiable subtypes of <a class="link" href="EExtension.html" title="EExtension"><span class="type">EExtension</span></a> which
target the class of <em class="parameter"><code>extensible</code></em>
. The lifetimes of these newly created
<a class="link" href="EExtension.html" title="EExtension"><span class="type">EExtension</span></a> objects are bound to <em class="parameter"><code>extensible</code></em>
such that they are finalized
when <em class="parameter"><code>extensible</code></em>
is finalized.</p>
<div class="refsect3">
<a name="id-1.2.6.10.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>extensible</p></td>
<td class="parameter_description"><p>an <a class="link" href="EExtensible.html" title="EExtensible"><span class="type">EExtensible</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since 3.4</p>
</div>
</div>
<div class="refsect1">
<a name="EExtensible.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="EExtensible-struct"></a><h3>EExtensible</h3>
<pre class="programlisting">typedef struct _EExtensible EExtensible;</pre>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.20</div>
</body>
</html>
|