File: EExtensible.html

package info (click to toggle)
evolution-data-server 3.4.4-3%2Bdeb7u1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 47,788 kB
  • sloc: ansic: 248,622; sh: 12,008; makefile: 2,874; xml: 428; perl: 204; python: 30
file content (185 lines) | stat: -rw-r--r-- 10,246 bytes parent folder | download 
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
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EExtensible</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Backend Utilities (libebackend)">
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Backend Utilities (libebackend)">
<link rel="prev" href="EDBusServer.html" title="EDBusServer">
<link rel="next" href="EExtension.html" title="EExtension">
<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="EDBusServer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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">Evolution-Data-Server Manual: Backend Utilities (libebackend)</th>
<td><a accesskey="n" href="EExtension.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#EExtensible.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#EExtensible.description" class="shortcut">Description</a>
                   | 
                  <a href="#EExtensible.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#EExtensible.prerequisites" class="shortcut">Prerequisites</a>
                   | 
                  <a href="#EExtensible.implementations" class="shortcut">Known Implementations</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 valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="EExtensible.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libebackend/e-extensible.h&gt;

                    <a class="link" href="EExtensible.html#EExtensible-struct" title="EExtensible">EExtensible</a>;
<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="EExtensible.html#e-extensible-list-extensions" title="e_extensible_list_extensions ()">e_extensible_list_extensions</a>        (<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="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> extension_type</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="EExtensible.html#e-extensible-load-extensions" title="e_extensible_load_extensions ()">e_extensible_load_extensions</a>        (<em class="parameter"><code><a class="link" href="EExtensible.html" title="EExtensible"><span class="type">EExtensible</span></a> *extensible</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="EExtensible.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GInterface
   +----EExtensible
</pre>
</div>
<div class="refsect1">
<a name="EExtensible.prerequisites"></a><h2>Prerequisites</h2>
<p>
EExtensible requires
 <a href="http://library.gnome.org/devel/gobject/unstable/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> and  <a class="link" href="EDataFactory.html" title="EDataFactory">EDataFactory</a>.</p>
</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="http://library.gnome.org/devel/gobject/unstable/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="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> type can be made
extensible in two steps:
</p>
<p>
1. Add the <a class="link" href="EExtensible.html" title="EExtensible"><span class="type">EExtensible</span></a> interface when registering the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a>.
   There are no methods to implement.
</p>
<p>
&lt;informalexample&gt;
&lt;programlisting&gt;
#include &lt;libebackend/e-extensible.h&gt;
</p>
<p>
G_DEFINE_TYPE_WITH_CODE (
        ECustomWidget, e_custom_widget, GTK_TYPE_WIDGET,
        G_IMPLEMENT_INTERFACE (E_TYPE_EXTENSIBLE, NULL))
&lt;/programlisting&gt;
&lt;/informalexample&gt;
</p>
<p>
2. Load extensions for the class at some point during <a href="http://library.gnome.org/devel/gobject/unstable/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>
<p>
&lt;informalexample&gt;
&lt;programlisting&gt;
static void
e_custom_widget_init (ECustomWidget *widget)
{
        Initialization code goes here...
</p>
<p>
        e_extensible_load_extensions (E_EXTENSIBLE (widget));
}
&lt;/programlisting&gt;
&lt;/informalexample&gt;
</p>
</div>
<div class="refsect1">
<a name="EExtensible.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="EExtensible-struct"></a><h3>EExtensible</h3>
<pre class="programlisting">typedef struct _EExtensible EExtensible;</pre>
</div>
<hr>
<div class="refsect2">
<a name="e-extensible-list-extensions"></a><h3>e_extensible_list_extensions ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/gobject/unstable/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="http://library.gnome.org/devel/glib/unstable/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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>extensible</code></em> :</span></p></td>
<td>an <a class="link" href="EExtensible.html" title="EExtensible"><span class="type">EExtensible</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>extension_type</code></em> :</span></p></td>
<td>the type of extensions to list</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a list of extension objects derived from <em class="parameter"><code>extension_type</code></em>
</td>
</tr>
</tbody>
</table></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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>extensible</code></em> :</span></p></td>
<td>an <a class="link" href="EExtensible.html" title="EExtensible"><span class="type">EExtensible</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>