From a101b38dea6890fa1dbf5b8560665826b69fa4ae Mon Sep 17 00:00:00 2001 From: Daniel Caujolle-Bert Date: Thu, 26 Jul 2001 11:12:25 +0000 Subject: Updated doxy sections in xine.h.tmpl.in. Added man3. Removed french man page. Added API doc in html. Add new rpm package (doc). Fixes some little bugs in proto decl, etc... CVS patchset: 350 CVS date: 2001/07/26 11:12:25 --- doc/xine-lib-API/html/group__event__group.html | 286 +++++++++++++++++++++++++ 1 file changed, 286 insertions(+) create mode 100644 doc/xine-lib-API/html/group__event__group.html (limited to 'doc/xine-lib-API/html/group__event__group.html') diff --git a/doc/xine-lib-API/html/group__event__group.html b/doc/xine-lib-API/html/group__event__group.html new file mode 100644 index 000000000..4e4fbd6d5 --- /dev/null +++ b/doc/xine-lib-API/html/group__event__group.html @@ -0,0 +1,286 @@ + + +XINE, A Free Video Player Project - API reference +xine logo + + + + +
+Main Page   Modules   Data Structures   File List   Data Fields   Globals  
+

Sending events

+ + + + + + + + + + +

Typedefs

+typedef void event_t
+typedef void (* event_listener_t )(xine_t *xine, event_t *event, void *data)

Functions

+int xine_register_event_listener (xine_t *self, event_listener_t listener)
 registers an event listener callback.

+int xine_remove_event_listener (xine_t *self, event_listener_t listener)
 Attempts to remove a registered event listener.

+void xine_send_event (xine_t *self, event_t *event, void *data)
 sends an event to all listeners.

+

Detailed Description

+Event dispatcher mechanism

Typedef Documentation

+

+ + + + +
+ + + + + +
+typedef void(* event_listener_t)(xine_t *xine, event_t *event, void *data) +
+
+ + + + + +
+   + + +

+Event listener callback.

+See also:
+xine_register_event_listener, xine_remove_event_listener
+

+ + + + +
+ + + + + +
+typedef void event_t +
+
+ + + + + +
+   + + +

+Opaque data type.

+See also:
+event_listener_t, xine_send_event
+

Function Documentation

+

+ + + + +
+ + + + + + + + + + +
+int xine_register_event_listener ( + +xine_t * self, +
+event_listener_t listener ) +
+
+ + + + + +
+   + + +

+registers an event listener callback. +

+

+Parameters:
+ + + +
self +  +Current xine engine configuration ( see xine_init() )
listener +  +callback function.
+
+Returns:
+0 if the listener was registerd, non-zero if it could not.
+See also:
+event_listener_t
+Parameters:
+ + + +
self +  +
listener +  +
+
+

+ + + + +
+ + + + + + + + + + +
+int xine_remove_event_listener ( + +xine_t * self, +
+event_listener_t listener ) +
+
+ + + + + +
+   + + +

+Attempts to remove a registered event listener. +

+

+Parameters:
+ + + +
self +  +Current xine engine configuration ( see xine_init() )
listener +  +callback function.
+
+Returns:
+0 if the listener was removes, non-zero if it wasn't (e.g. not found).
+See also:
+event_listener_t
+Parameters:
+ + + +
self +  +
listener +  +
+
+

+ + + + +
+ + + + + + + + + + + + + + +
+void xine_send_event ( + +xine_t * self, +
+event_t * event, +
+void * data ) +
+
+ + + + + +
+   + + +

+sends an event to all listeners. +

+

+Parameters:
+ + + + +
self +  +Current xine engine configuration ( see xine_init() )
event +  +FILLME
data +  +FILLME.
+
+See also:
+event_t
+Parameters:
+ + + + +
self +  +
event +  +
data +  +
+
+

Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by + +doxygen1.2.8 written by Dimitri van Heesch, + © 1997-2001
+ + -- cgit v1.2.3