4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>bonobo-listener</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
7
<link rel="start" href="index.html" title="Libbonobo Reference Manual">
8
8
<link rel="up" href="property-bags.html" title="Property Bags, Events, Listeners">
9
9
<link rel="prev" href="libbonobo-bonobo-event-source.html" title="bonobo-event-source">
28
28
<th width="100%" align="center">Libbonobo Reference Manual</th>
29
29
<td><a accesskey="n" href="libbonobo-bonobo-property-bag.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
31
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2597469" class="shortcut">Top</a>
33
<a href="#id2597806" class="shortcut">Description</a>
35
<a href="#id2597746" class="shortcut">Object Hierarchy</a>
37
<a href="#id2597778" class="shortcut">Signals</a></nobr></td></tr>
31
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id3080188" class="shortcut">Top</a>
33
<a href="#id3080525" class="shortcut">Description</a>
35
<a href="#id3080465" class="shortcut">Object Hierarchy</a>
37
<a href="#id3080497" class="shortcut">Signals</a></nobr></td></tr>
39
39
<div class="refentry" lang="en">
40
40
<a name="libbonobo-bonobo-listener"></a><div class="titlepage"></div>
41
41
<div class="refnamediv"><table width="100%"><tr>
44
<a name="id2597469"></a><span class="refentrytitle">bonobo-listener</span>
44
<a name="id3080188"></a><span class="refentrytitle">bonobo-listener</span>
46
46
<p>bonobo-listener — An Event Listener (an implementation of Bonobo::Listener)</p>
56
<a href="libbonobo-bonobo-listener.html#BonoboListener-struct">BonoboListener</a>;
57
<a href="libbonobo-bonobo-listener.html#BonoboListenerClass">BonoboListenerClass</a>;
58
void (<a href="libbonobo-bonobo-listener.html#BonoboListenerCallbackFn">*BonoboListenerCallbackFn</a>) (<a href="libbonobo-bonobo-listener.html#BonoboListener">BonoboListener</a> *listener,
56
<a class="link" href="libbonobo-bonobo-listener.html#BonoboListener-struct">BonoboListener</a>;
57
<a class="link" href="libbonobo-bonobo-listener.html#BonoboListenerClass">BonoboListenerClass</a>;
58
void (<a class="link" href="libbonobo-bonobo-listener.html#BonoboListenerCallbackFn">*BonoboListenerCallbackFn</a>) (<a class="link" href="libbonobo-bonobo-listener.html#BonoboListener">BonoboListener</a> *listener,
59
59
const char *event_name,
60
60
const CORBA_any *any,
61
61
CORBA_Environment *ev,
63
<a href="libbonobo-bonobo-listener.html#BonoboListener">BonoboListener</a>* <a href="libbonobo-bonobo-listener.html#bonobo-listener-new">bonobo_listener_new</a> (<a href="libbonobo-bonobo-listener.html#BonoboListenerCallbackFn">BonoboListenerCallbackFn</a> event_cb,
65
<a href="libbonobo-bonobo-listener.html#BonoboListener">BonoboListener</a>* <a href="libbonobo-bonobo-listener.html#bonobo-listener-new-closure">bonobo_listener_new_closure</a> (GClosure *event_closure);
66
char* <a href="libbonobo-bonobo-listener.html#bonobo-event-make-name">bonobo_event_make_name</a> (const char *idl_path,
63
href="../glib/glib-Basic-Types.html#gpointer"
64
>gpointer</a> user_data);
65
<a class="link" href="libbonobo-bonobo-listener.html#BonoboListener">BonoboListener</a>* <a class="link" href="libbonobo-bonobo-listener.html#bonobo-listener-new">bonobo_listener_new</a> (<a class="link" href="libbonobo-bonobo-listener.html#BonoboListenerCallbackFn">BonoboListenerCallbackFn</a> event_cb,
67
href="../glib/glib-Basic-Types.html#gpointer"
68
>gpointer</a> user_data);
69
<a class="link" href="libbonobo-bonobo-listener.html#BonoboListener">BonoboListener</a>* <a class="link" href="libbonobo-bonobo-listener.html#bonobo-listener-new-closure">bonobo_listener_new_closure</a> (<a
70
href="../gobject/gobject-Closures.html#GClosure"
71
>GClosure</a> *event_closure);
72
char* <a class="link" href="libbonobo-bonobo-listener.html#bonobo-event-make-name">bonobo_event_make_name</a> (const char *idl_path,
68
74
const char *subtype);
69
char* <a href="libbonobo-bonobo-listener.html#bonobo-event-type">bonobo_event_type</a> (const char *event_name);
70
char* <a href="libbonobo-bonobo-listener.html#bonobo-event-subtype">bonobo_event_subtype</a> (const char *event_name);
71
char* <a href="libbonobo-bonobo-listener.html#bonobo-event-kind">bonobo_event_kind</a> (const char *event_name);
72
char* <a href="libbonobo-bonobo-listener.html#bonobo-event-idl-path">bonobo_event_idl_path</a> (const char *event_name);
75
char* <a class="link" href="libbonobo-bonobo-listener.html#bonobo-event-type">bonobo_event_type</a> (const char *event_name);
76
char* <a class="link" href="libbonobo-bonobo-listener.html#bonobo-event-subtype">bonobo_event_subtype</a> (const char *event_name);
77
char* <a class="link" href="libbonobo-bonobo-listener.html#bonobo-event-kind">bonobo_event_kind</a> (const char *event_name);
78
char* <a class="link" href="libbonobo-bonobo-listener.html#bonobo-event-idl-path">bonobo_event_idl_path</a> (const char *event_name);
77
83
<div class="refsect1" lang="en">
78
<a name="id2597746"></a><h2>Object Hierarchy</h2>
84
<a name="id3080465"></a><h2>Object Hierarchy</h2>
79
85
<pre class="synopsis">
82
+----<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>
88
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
90
+----<a class="link" href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>
83
91
+----BonoboListener
86
94
<div class="refsect1" lang="en">
87
<a name="id2597778"></a><h2>Signals</h2>
95
<a name="id3080497"></a><h2>Signals</h2>
88
96
<pre class="synopsis">
90
"<a href="libbonobo-bonobo-listener.html#BonoboListener-event-notify">event-notify</a>" : Run Last
98
"<a class="link" href="libbonobo-bonobo-listener.html#BonoboListener-event-notify">event-notify</a>" : Run Last
93
101
<div class="refsect1" lang="en">
94
<a name="id2597806"></a><h2>Description</h2>
102
<a name="id3080525"></a><h2>Description</h2>
96
104
The BonoboListener object is a CORBA server used to receive events
97
105
emitted by a remote Bonobo::EventSource server. The combination
158
166
<div class="refsect1" lang="en">
159
<a name="id2597878"></a><h2>Details</h2>
167
<a name="id3080597"></a><h2>Details</h2>
160
168
<div class="refsect2" lang="en">
161
<a name="id2597888"></a><h3>
169
<a name="id3080607"></a><h3>
162
170
<a name="BonoboListener-struct"></a>BonoboListener</h3>
163
<a class="indexterm" name="id2597902"></a><pre class="programlisting">typedef struct _BonoboListener BonoboListener;</pre>
171
<a class="indexterm" name="id3080621"></a><pre class="programlisting">typedef struct _BonoboListener BonoboListener;</pre>
165
173
Implementents Bonobo::Listener.
169
177
<div class="refsect2" lang="en">
170
<a name="id2597918"></a><h3>
178
<a name="id3080637"></a><h3>
171
179
<a name="BonoboListenerClass"></a>BonoboListenerClass</h3>
172
<a class="indexterm" name="id2597930"></a><pre class="programlisting">typedef struct {
180
<a class="indexterm" name="id3080649"></a><pre class="programlisting">typedef struct {
173
181
BonoboObjectClass parent_class;
175
183
POA_Bonobo_Listener__epv epv;
182
190
} BonoboListenerClass;
185
<a href="libbonobo-bonobo-listener.html#BonoboListener"><span class="type">BonoboListener</span></a>'s class
193
<a class="link" href="libbonobo-bonobo-listener.html#BonoboListener"><span class="type">BonoboListener</span></a>'s class
189
197
<div class="refsect2" lang="en">
190
<a name="id2597958"></a><h3>
198
<a name="id3080677"></a><h3>
191
199
<a name="BonoboListenerCallbackFn"></a>BonoboListenerCallbackFn ()</h3>
192
<a class="indexterm" name="id2597971"></a><pre class="programlisting">void (*BonoboListenerCallbackFn) (<a href="libbonobo-bonobo-listener.html#BonoboListener">BonoboListener</a> *listener,
200
<a class="indexterm" name="id3080690"></a><pre class="programlisting">void (*BonoboListenerCallbackFn) (<a class="link" href="libbonobo-bonobo-listener.html#BonoboListener">BonoboListener</a> *listener,
193
201
const char *event_name,
194
202
const CORBA_any *any,
195
203
CORBA_Environment *ev,
196
gpointer user_data);</pre>
205
href="../glib/glib-Basic-Types.html#gpointer"
206
>gpointer</a> user_data);</pre>
198
208
The signature for the callback function invoked when an event is
199
209
delivered to the BonoboListener object.
202
212
<col align="left" valign="top">
205
<td><span class="term"><em class="parameter"><code>listener</code></em> :</span></td>
215
<td><p><span class="term"><em class="parameter"><code>listener</code></em> :</span></p></td>
206
216
<td>a pointer to the BonoboListener.
210
<td><span class="term"><em class="parameter"><code>event_name</code></em> :</span></td>
220
<td><p><span class="term"><em class="parameter"><code>event_name</code></em> :</span></p></td>
211
221
<td>the event name that was emitted.
215
<td><span class="term"><em class="parameter"><code>any</code></em> :</span></td>
225
<td><p><span class="term"><em class="parameter"><code>any</code></em> :</span></p></td>
216
226
<td>The value (A CORBA Any) that was passed by the EventSource.
220
<td><span class="term"><em class="parameter"><code>ev</code></em> :</span></td>
230
<td><p><span class="term"><em class="parameter"><code>ev</code></em> :</span></p></td>
221
231
<td>Environment for returning CORBA errors.
225
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
235
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
226
236
<td>the data pointer specified when you called bonobo_listener_new
235
245
<div class="refsect2" lang="en">
236
<a name="id2598110"></a><h3>
246
<a name="id3080829"></a><h3>
237
247
<a name="bonobo-listener-new"></a>bonobo_listener_new ()</h3>
238
<a class="indexterm" name="id2598123"></a><pre class="programlisting"><a href="libbonobo-bonobo-listener.html#BonoboListener">BonoboListener</a>* bonobo_listener_new (<a href="libbonobo-bonobo-listener.html#BonoboListenerCallbackFn">BonoboListenerCallbackFn</a> event_cb,
239
gpointer user_data);</pre>
248
<a class="indexterm" name="id3080842"></a><pre class="programlisting"><a class="link" href="libbonobo-bonobo-listener.html#BonoboListener">BonoboListener</a>* bonobo_listener_new (<a class="link" href="libbonobo-bonobo-listener.html#BonoboListenerCallbackFn">BonoboListenerCallbackFn</a> event_cb,
250
href="../glib/glib-Basic-Types.html#gpointer"
251
>gpointer</a> user_data);</pre>
241
253
Creates a generic event listener. The listener calls the <em class="parameter"><code>event_callback</code></em>
242
254
function and emits an "event_notify" signal when notified of an event.
263
275
<col align="left" valign="top">
266
<td><span class="term"><em class="parameter"><code>event_cb</code></em> :</span></td>
278
<td><p><span class="term"><em class="parameter"><code>event_cb</code></em> :</span></p></td>
267
279
<td> function to be invoked when an event is emitted by the EventSource.
271
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
283
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
272
284
<td> data passed to the functioned pointed by <em class="parameter"><code>event_call</code></em>.
276
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
288
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
277
289
<td> A BonoboListener object.
284
296
<div class="refsect2" lang="en">
285
<a name="id2598243"></a><h3>
297
<a name="id3080962"></a><h3>
286
298
<a name="bonobo-listener-new-closure"></a>bonobo_listener_new_closure ()</h3>
287
<a class="indexterm" name="id2598256"></a><pre class="programlisting"><a href="libbonobo-bonobo-listener.html#BonoboListener">BonoboListener</a>* bonobo_listener_new_closure (GClosure *event_closure);</pre>
299
<a class="indexterm" name="id3080975"></a><pre class="programlisting"><a class="link" href="libbonobo-bonobo-listener.html#BonoboListener">BonoboListener</a>* bonobo_listener_new_closure (<a
300
href="../gobject/gobject-Closures.html#GClosure"
301
>GClosure</a> *event_closure);</pre>
289
303
Creates a generic event listener. The listener invokes the <em class="parameter"><code>event_closure</code></em>
290
304
closure and emits an "event_notify" signal when notified of an event.
311
325
<col align="left" valign="top">
314
<td><span class="term"><em class="parameter"><code>event_closure</code></em> :</span></td>
328
<td><p><span class="term"><em class="parameter"><code>event_closure</code></em> :</span></p></td>
315
329
<td> closure to be invoked when an event is emitted by the EventSource.
319
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
333
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
320
334
<td> A BonoboListener object.
327
341
<div class="refsect2" lang="en">
328
<a name="id2598347"></a><h3>
342
<a name="id3081066"></a><h3>
329
343
<a name="bonobo-event-make-name"></a>bonobo_event_make_name ()</h3>
330
<a class="indexterm" name="id2598361"></a><pre class="programlisting">char* bonobo_event_make_name (const char *idl_path,
344
<a class="indexterm" name="id3081080"></a><pre class="programlisting">char* bonobo_event_make_name (const char *idl_path,
331
345
const char *kind,
332
346
const char *subtype);</pre>
345
359
<col align="left" valign="top">
348
<td><span class="term"><em class="parameter"><code>idl_path</code></em> :</span></td>
362
<td><p><span class="term"><em class="parameter"><code>idl_path</code></em> :</span></p></td>
349
363
<td> the IDL part of the event name.
353
<td><span class="term"><em class="parameter"><code>kind</code></em> :</span></td>
367
<td><p><span class="term"><em class="parameter"><code>kind</code></em> :</span></p></td>
354
368
<td> the kind of the event
358
<td><span class="term"><em class="parameter"><code>subtype</code></em> :</span></td>
372
<td><p><span class="term"><em class="parameter"><code>subtype</code></em> :</span></p></td>
359
373
<td> an optional subtype
363
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
377
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
364
378
<td> A valid event_name, or NULL on error.
475
489
<div class="refsect1" lang="en">
476
<a name="id2598784"></a><h2>Signal Details</h2>
490
<a name="id3081503"></a><h2>Signal Details</h2>
477
491
<div class="refsect2" lang="en">
478
<a name="id2598795"></a><h3>
492
<a name="id3081514"></a><h3>
479
493
<a name="BonoboListener-event-notify"></a>The "event-notify" signal</h3>
480
<a class="indexterm" name="id2598806"></a><pre class="programlisting">void user_function (<a href="libbonobo-bonobo-listener.html#BonoboListener">BonoboListener</a> *bonobolistener,
494
<a class="indexterm" name="id3081525"></a><pre class="programlisting">void user_function (<a class="link" href="libbonobo-bonobo-listener.html#BonoboListener">BonoboListener</a> *bonobolistener,
496
href="../glib/glib-Basic-Types.html#gchar"
482
498
BonoboCorbaAny *arg2,
483
499
BonoboCorbaException *arg3,
484
gpointer user_data) : Run Last</pre>
501
href="../glib/glib-Basic-Types.html#gpointer"
502
>gpointer</a> user_data) : Run Last</pre>
489
507
<col align="left" valign="top">
492
<td><span class="term"><em class="parameter"><code>bonobolistener</code></em> :</span></td>
510
<td><p><span class="term"><em class="parameter"><code>bonobolistener</code></em> :</span></p></td>
493
511
<td>the object which received the signal.
497
<td><span class="term"><em class="parameter"><code>arg1</code></em> :</span></td>
502
<td><span class="term"><em class="parameter"><code>arg2</code></em> :</span></td>
507
<td><span class="term"><em class="parameter"><code>arg3</code></em> :</span></td>
515
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
520
<td><p><span class="term"><em class="parameter"><code>arg2</code></em> :</span></p></td>
525
<td><p><span class="term"><em class="parameter"><code>arg3</code></em> :</span></p></td>
513
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
531
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
514
532
<td>user data set when the signal handler was connected.</td>