diff options
| author | Daniel Caujolle-Bert <f1rmb@users.sourceforge.net> | 2001-07-26 11:12:25 +0000 |
|---|---|---|
| committer | Daniel Caujolle-Bert <f1rmb@users.sourceforge.net> | 2001-07-26 11:12:25 +0000 |
| commit | a101b38dea6890fa1dbf5b8560665826b69fa4ae (patch) | |
| tree | 2615e691684c22951ebb881d6a5009257aad2f97 /doc/xine-lib-API/html/group__event__group.html | |
| parent | 4042284ccba79fe453dfca7b4d45edba31d36d48 (diff) | |
| download | xine-lib-a101b38dea6890fa1dbf5b8560665826b69fa4ae.tar.gz xine-lib-a101b38dea6890fa1dbf5b8560665826b69fa4ae.tar.bz2 | |
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
Diffstat (limited to 'doc/xine-lib-API/html/group__event__group.html')
| -rw-r--r-- | doc/xine-lib-API/html/group__event__group.html | 286 |
1 files changed, 286 insertions, 0 deletions
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 @@ +<HTML> +<HEAD> +<TITLE>XINE, A Free Video Player Project - API reference</TITLE> +<IMG SRC="xine_logo.png" alt="xine logo" ALIGN=CENTER WIDTH=100% CELLPADDING=0 BORDER=0> +</HEAD> +<BODY BGCOLOR=#000000 TEXT=#ccccFF LINK=#a0a0FF VLINK=#40ddff ALINK=#ffffff leftmargin="0" topmargin="0" marginwidth="0" marginheight="0"> + +<!-- Generated by Doxygen 1.2.8 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> +<hr><h1>Sending events</h1><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Typedefs</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="event_group::event_t"></a> +typedef void </td><td valign=bottom><a class="el" href="group__event__group.html#a0">event_t</a></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="event_group::event_listener_t"></a> +typedef void (* </td><td valign=bottom><a class="el" href="group__event__group.html#a1">event_listener_t</a> )(<a class="el" href="structxine__t.html">xine_t</a> *xine, <a class="el" href="group__event__group.html#a0">event_t</a> *event, void *data)</td></tr> +<tr><td colspan=2><br><h2>Functions</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="event_group::xine_register_event_listener"></a> +int </td><td valign=bottom><a class="el" href="group__event__group.html#a2">xine_register_event_listener</a> (<a class="el" href="structxine__t.html">xine_t</a> *self, <a class="el" href="group__event__group.html#a1">event_listener_t</a> listener)</td></tr> +<tr><td> </td><td><font size=-1><em>registers an event listener callback.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="event_group::xine_remove_event_listener"></a> +int </td><td valign=bottom><a class="el" href="group__event__group.html#a3">xine_remove_event_listener</a> (<a class="el" href="structxine__t.html">xine_t</a> *self, <a class="el" href="group__event__group.html#a1">event_listener_t</a> listener)</td></tr> +<tr><td> </td><td><font size=-1><em>Attempts to remove a registered event listener.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="event_group::xine_send_event"></a> +void </td><td valign=bottom><a class="el" href="group__event__group.html#a4">xine_send_event</a> (<a class="el" href="structxine__t.html">xine_t</a> *self, <a class="el" href="group__event__group.html#a0">event_t</a> *event, void *data)</td></tr> +<tr><td> </td><td><font size=-1><em>sends an event to all listeners.</em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Event dispatcher mechanism <hr><h2>Typedef Documentation</h2> +<a name="a1" doxytag="xine.h::event_listener_t"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +typedef void(* event_listener_t)(<a class="el" href="structxine__t.html">xine_t</a> *xine, <a class="el" href="group__event__group.html#a0">event_t</a> *event, void *data) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Event listener callback. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="group__event__group.html#a2">xine_register_event_listener</a>, <a class="el" href="group__event__group.html#a3">xine_remove_event_listener</a> </dl> </td> + </tr> +</table> +<a name="a0" doxytag="xine.h::event_t"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +typedef void event_t + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Opaque data type. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="group__event__group.html#a1">event_listener_t</a>, <a class="el" href="group__event__group.html#a4">xine_send_event</a> </dl> </td> + </tr> +</table> +<hr><h2>Function Documentation</h2> +<a name="a2" doxytag="xine.h::xine_register_event_listener"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +int xine_register_event_listener ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structxine__t.html">xine_t</a> * <em>self</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="group__event__group.html#a1">event_listener_t</a> <em>listener</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +registers an event listener callback. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> +Current xine engine configuration ( see <a class="el" href="xine_8h.html#a1">xine_init</a>() ) </td></tr> +<tr><td valign=top><em>listener</em> + </td><td> +callback function. </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 if the listener was registerd, non-zero if it could not. </dl><dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="group__event__group.html#a1">event_listener_t</a> </dl><dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> + </td></tr> +<tr><td valign=top><em>listener</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a3" doxytag="xine.h::xine_remove_event_listener"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +int xine_remove_event_listener ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structxine__t.html">xine_t</a> * <em>self</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="group__event__group.html#a1">event_listener_t</a> <em>listener</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Attempts to remove a registered event listener. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> +Current xine engine configuration ( see <a class="el" href="xine_8h.html#a1">xine_init</a>() ) </td></tr> +<tr><td valign=top><em>listener</em> + </td><td> +callback function. </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 if the listener was removes, non-zero if it wasn't (e.g. not found). </dl><dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="group__event__group.html#a1">event_listener_t</a> </dl><dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> + </td></tr> +<tr><td valign=top><em>listener</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a4" doxytag="xine.h::xine_send_event"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void xine_send_event ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structxine__t.html">xine_t</a> * <em>self</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="group__event__group.html#a0">event_t</a> * <em>event</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +void * <em>data</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +sends an event to all listeners. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> +Current xine engine configuration ( see <a class="el" href="xine_8h.html#a1">xine_init</a>() ) </td></tr> +<tr><td valign=top><em>event</em> + </td><td> +FILLME </td></tr> +<tr><td valign=top><em>data</em> + </td><td> +FILLME. </td></tr> +</table> +</dl><dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="group__event__group.html#a0">event_t</a> </dl><dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>self</em> + </td><td> + </td></tr> +<tr><td valign=top><em>event</em> + </td><td> + </td></tr> +<tr><td valign=top><em>data</em> + </td><td> + </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><address><small>Generated at Thu Jul 26 11:29:46 2001 for XINE, A Free Video Player Project - API reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> |