/usr/share/gtk-doc/html/evolution-util/EEvent.html is in evolution-dev 3.10.4-0ubuntu1.
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 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EEvent</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution Utilities Reference Manual">
<link rel="up" href="ch14.html" title="Plugins (Legacy)">
<link rel="prev" href="EConfig.html" title="EConfig">
<link rel="next" href="EImport.html" title="EImport">
<meta name="generator" content="GTK-Doc V1.19 (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="EConfig.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch14.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 Utilities Reference Manual</th>
<td><a accesskey="n" href="EImport.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#EEvent.synopsis" class="shortcut">Top</a>
|
<a href="#EEvent.description" class="shortcut">Description</a>
|
<a href="#EEvent.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="EEvent"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EEvent.top_of_page"></a>EEvent</span></h2>
<p>EEvent</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="EEvent.synopsis"></a><h2>Synopsis</h2>
<a name="EEventHook"></a><pre class="synopsis">struct <a class="link" href="EEvent.html#EEvent-struct" title="struct EEvent">EEvent</a>;
enum <a class="link" href="EEvent.html#e-event-t" title="enum e_event_t">e_event_t</a>;
struct <a class="link" href="EEvent.html#EEventItem" title="struct EEventItem">EEventItem</a>;
<a class="link" href="EEvent.html#EEventFactory" title="EEventFactory">EEventFactory</a>;
struct <a class="link" href="EEvent.html#EEventTarget" title="struct EEventTarget">EEventTarget</a>;
<span class="returnvalue">void</span> (<a class="link" href="EEvent.html#EEventItemsFunc" title="EEventItemsFunc ()">*EEventItemsFunc</a>) (<em class="parameter"><code><a class="link" href="EEvent.html" title="EEvent"><span class="type">EEvent</span></a> *ee</code></em>,
<em class="parameter"><code><span class="type">GSList</span> *items</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
<span class="returnvalue">void</span> (<a class="link" href="EEvent.html#EEventFunc" title="EEventFunc ()">*EEventFunc</a>) (<em class="parameter"><code><a class="link" href="EEvent.html" title="EEvent"><span class="type">EEvent</span></a> *ee</code></em>,
<em class="parameter"><code><a class="link" href="EEvent.html#EEventItem" title="struct EEventItem"><span class="type">EEventItem</span></a> *item</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
<span class="returnvalue">void</span> (<a class="link" href="EEvent.html#EEventFactoryFunc" title="EEventFactoryFunc ()">*EEventFactoryFunc</a>) (<em class="parameter"><code><a class="link" href="EEvent.html" title="EEvent"><span class="type">EEvent</span></a> *ee</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> Param2</code></em>);
<a class="link" href="EEvent.html" title="EEvent"><span class="returnvalue">EEvent</span></a> * <a class="link" href="EEvent.html#e-event-construct" title="e_event_construct ()">e_event_construct</a> (<em class="parameter"><code><a class="link" href="EEvent.html" title="EEvent"><span class="type">EEvent</span></a> *event</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);
<span class="returnvalue">gpointer</span> <a class="link" href="EEvent.html#e-event-add-items" title="e_event_add_items ()">e_event_add_items</a> (<em class="parameter"><code><a class="link" href="EEvent.html" title="EEvent"><span class="type">EEvent</span></a> *event</code></em>,
<em class="parameter"><code><span class="type">GSList</span> *items</code></em>,
<em class="parameter"><code><a class="link" href="EEvent.html#EEventItemsFunc" title="EEventItemsFunc ()"><span class="type">EEventItemsFunc</span></a> freefunc</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EEvent.html#e-event-remove-items" title="e_event_remove_items ()">e_event_remove_items</a> (<em class="parameter"><code><a class="link" href="EEvent.html" title="EEvent"><span class="type">EEvent</span></a> *event</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> handle</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EEvent.html#e-event-emit" title="e_event_emit ()">e_event_emit</a> (<em class="parameter"><code><a class="link" href="EEvent.html" title="EEvent"><span class="type">EEvent</span></a> *event</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>,
<em class="parameter"><code><a class="link" href="EEvent.html#EEventTarget" title="struct EEventTarget"><span class="type">EEventTarget</span></a> *target</code></em>);
<span class="returnvalue">gpointer</span> <a class="link" href="EEvent.html#e-event-target-new" title="e_event_target_new ()">e_event_target_new</a> (<em class="parameter"><code><a class="link" href="EEvent.html" title="EEvent"><span class="type">EEvent</span></a> *event</code></em>,
<em class="parameter"><code><span class="type">gint</span> type</code></em>,
<em class="parameter"><code><span class="type">gsize</span> size</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EEvent.html#e-event-target-free" title="e_event_target_free ()">e_event_target_free</a> (<em class="parameter"><code><a class="link" href="EEvent.html" title="EEvent"><span class="type">EEvent</span></a> *event</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> target</code></em>);
struct <a class="link" href="EEvent.html#EEventHook-struct" title="struct EEventHook">EEventHook</a>;
typedef <a class="link" href="EEvent.html#EEventHookTargetMap" title="EEventHookTargetMap">EEventHookTargetMap</a>;
typedef <a class="link" href="EEvent.html#EEventHookTargetMask" title="EEventHookTargetMask">EEventHookTargetMask</a>;
<span class="returnvalue">void</span> (<a class="link" href="EEvent.html#EEventHookFunc" title="EEventHookFunc ()">*EEventHookFunc</a>) (<em class="parameter"><code><a class="link" href="EPlugin.html" title="EPlugin"><span class="type">EPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><a class="link" href="EEvent.html#EEventTarget" title="struct EEventTarget"><span class="type">EEventTarget</span></a> *target</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EEvent.html#e-event-hook-class-add-target-map" title="e_event_hook_class_add_target_map ()">e_event_hook_class_add_target_map</a> (<em class="parameter"><code><span class="type">EEventHookClass</span> *hook_class</code></em>,
<em class="parameter"><code>const <a class="link" href="EEvent.html#EEventHookTargetMap" title="EEventHookTargetMap"><span class="type">EEventHookTargetMap</span></a> *map</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="EEvent.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----EEvent
</pre>
<pre class="synopsis">
GObject
+----<a class="link" href="EPlugin.html#EPluginHook">EPluginHook</a>
+----EEventHook
</pre>
</div>
<div class="refsect1">
<a name="EEvent.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="EEvent.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="EEvent-struct"></a><h3>struct EEvent</h3>
<pre class="programlisting">struct EEvent;</pre>
</div>
<hr>
<div class="refsect2">
<a name="e-event-t"></a><h3>enum e_event_t</h3>
<pre class="programlisting">enum e_event_t {
E_EVENT_PASS, /* passthrough */
E_EVENT_SINK /* sink events */
};
</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="E-EVENT-PASS:CAPS"></a><span class="term"><code class="literal">E_EVENT_PASS</code></span></p></td>
<td></td>
</tr>
<tr>
<td><p><a name="E-EVENT-SINK:CAPS"></a><span class="term"><code class="literal">E_EVENT_SINK</code></span></p></td>
<td></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="EEventItem"></a><h3>struct EEventItem</h3>
<pre class="programlisting">struct EEventItem {
enum _e_event_t type;
gint priority; /* priority of event */
const gchar *id; /* event id */
gint target_type;
EEventFunc handle;
gpointer user_data;
guint32 enable; /* enable mask */
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="EEventFactory"></a><h3>EEventFactory</h3>
<pre class="programlisting">typedef struct _EEventFactory EEventFactory;</pre>
</div>
<hr>
<div class="refsect2">
<a name="EEventTarget"></a><h3>struct EEventTarget</h3>
<pre class="programlisting">struct EEventTarget {
EEvent *event; /* used for virtual methods */
guint32 type; /* targe type, for implementors */
guint32 mask; /* depends on type, enable mask */
/* implementation fields follow */
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="EEventItemsFunc"></a><h3>EEventItemsFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*EEventItemsFunc) (<em class="parameter"><code><a class="link" href="EEvent.html" title="EEvent"><span class="type">EEvent</span></a> *ee</code></em>,
<em class="parameter"><code><span class="type">GSList</span> *items</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="EEventFunc"></a><h3>EEventFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*EEventFunc) (<em class="parameter"><code><a class="link" href="EEvent.html" title="EEvent"><span class="type">EEvent</span></a> *ee</code></em>,
<em class="parameter"><code><a class="link" href="EEvent.html#EEventItem" title="struct EEventItem"><span class="type">EEventItem</span></a> *item</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="EEventFactoryFunc"></a><h3>EEventFactoryFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*EEventFactoryFunc) (<em class="parameter"><code><a class="link" href="EEvent.html" title="EEvent"><span class="type">EEvent</span></a> *ee</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> Param2</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="e-event-construct"></a><h3>e_event_construct ()</h3>
<pre class="programlisting"><a class="link" href="EEvent.html" title="EEvent"><span class="returnvalue">EEvent</span></a> * e_event_construct (<em class="parameter"><code><a class="link" href="EEvent.html" title="EEvent"><span class="type">EEvent</span></a> *event</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);</pre>
<p>
Construct the base event instance with standard parameters.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
<td>An instantiated but uninitialised EEvent.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>Event manager id.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <em class="parameter"><code>event</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-event-add-items"></a><h3>e_event_add_items ()</h3>
<pre class="programlisting"><span class="returnvalue">gpointer</span> e_event_add_items (<em class="parameter"><code><a class="link" href="EEvent.html" title="EEvent"><span class="type">EEvent</span></a> *event</code></em>,
<em class="parameter"><code><span class="type">GSList</span> *items</code></em>,
<em class="parameter"><code><a class="link" href="EEvent.html#EEventItemsFunc" title="EEventItemsFunc ()"><span class="type">EEventItemsFunc</span></a> freefunc</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<p>
Adds <em class="parameter"><code>items</code></em> to the list of events listened to on the event manager <em class="parameter"><code>event</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>event</code></em> :</span></p></td>
<td>An initialised EEvent structure.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>items</code></em> :</span></p></td>
<td>A list of EEventItems event listeners to register on this event manager.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>freefunc</code></em> :</span></p></td>
<td>A function called when the <em class="parameter"><code>items</code></em> list is no longer needed.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>callback data for <em class="parameter"><code>freefunc</code></em> and for item event handlers.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>An opaque key which can later be passed to remove_items.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-event-remove-items"></a><h3>e_event_remove_items ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_event_remove_items (<em class="parameter"><code><a class="link" href="EEvent.html" title="EEvent"><span class="type">EEvent</span></a> *event</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> handle</code></em>);</pre>
<p>
Remove items previously added. They MUST have been previously
added, and may only be removed once.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
<td>an <a class="link" href="EEvent.html" title="EEvent"><span class="type">EEvent</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>an opaque key returned by <a class="link" href="EEvent.html#e-event-add-items" title="e_event_add_items ()"><code class="function">e_event_add_items()</code></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-event-emit"></a><h3>e_event_emit ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_event_emit (<em class="parameter"><code><a class="link" href="EEvent.html" title="EEvent"><span class="type">EEvent</span></a> *event</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>,
<em class="parameter"><code><a class="link" href="EEvent.html#EEventTarget" title="struct EEventTarget"><span class="type">EEventTarget</span></a> *target</code></em>);</pre>
<p>
Emit an event. <em class="parameter"><code>target</code></em> will automatically be freed once its
emission is complete.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>Event name. This will be compared against EEventItem.id.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>target</code></em> :</span></p></td>
<td>The target describing the event context. This will be
implementation defined.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-event-target-new"></a><h3>e_event_target_new ()</h3>
<pre class="programlisting"><span class="returnvalue">gpointer</span> e_event_target_new (<em class="parameter"><code><a class="link" href="EEvent.html" title="EEvent"><span class="type">EEvent</span></a> *event</code></em>,
<em class="parameter"><code><span class="type">gint</span> type</code></em>,
<em class="parameter"><code><span class="type">gsize</span> size</code></em>);</pre>
<p>
Allocate a new event target suitable for this class. It is up to
the implementation to define the available target types and their
structure.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
<td>An initialised EEvent instance.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>type, up to implementor</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
<td>The size of memory to allocate. This must be >= sizeof(EEventTarget).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-event-target-free"></a><h3>e_event_target_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_event_target_free (<em class="parameter"><code><a class="link" href="EEvent.html" title="EEvent"><span class="type">EEvent</span></a> *event</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> target</code></em>);</pre>
<p>
Free a target. This invokes the virtual free method on the EEventClass.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
<td>An initialised EEvent instance on which this target was allocated.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>target</code></em> :</span></p></td>
<td>The target to free.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="EEventHook-struct"></a><h3>struct EEventHook</h3>
<pre class="programlisting">struct EEventHook;</pre>
</div>
<hr>
<div class="refsect2">
<a name="EEventHookTargetMap"></a><h3>EEventHookTargetMap</h3>
<pre class="programlisting">typedef struct _EPluginHookTargetMap EEventHookTargetMap;
</pre>
</div>
<hr>
<div class="refsect2">
<a name="EEventHookTargetMask"></a><h3>EEventHookTargetMask</h3>
<pre class="programlisting">typedef struct _EPluginHookTargetKey EEventHookTargetMask;
</pre>
</div>
<hr>
<div class="refsect2">
<a name="EEventHookFunc"></a><h3>EEventHookFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*EEventHookFunc) (<em class="parameter"><code><a class="link" href="EPlugin.html" title="EPlugin"><span class="type">EPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><a class="link" href="EEvent.html#EEventTarget" title="struct EEventTarget"><span class="type">EEventTarget</span></a> *target</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="e-event-hook-class-add-target-map"></a><h3>e_event_hook_class_add_target_map ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_event_hook_class_add_target_map (<em class="parameter"><code><span class="type">EEventHookClass</span> *hook_class</code></em>,
<em class="parameter"><code>const <a class="link" href="EEvent.html#EEventHookTargetMap" title="EEventHookTargetMap"><span class="type">EEventHookTargetMap</span></a> *map</code></em>);</pre>
<p>
Add a target map to a concrete derived class of EEvent. The target
map enumerates a single target type and th eenable mask bit names,
so that the type can be loaded automatically by the base EEvent class.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hook_class</code></em> :</span></p></td>
<td>The derived EEventHook class.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>map</code></em> :</span></p></td>
<td>A map used to describe a single EEventTarget type for this class.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|