<html> <head><title>ClanLib Reference: CL_EventListener</title></head> <body text=black link=blue vlink=#800080 bgcolor=white topmargin=0 leftmargin=0> <table border=0 cellspacing=0 cellpadding=0 width=100%><tr><td><img border=0 src="../images/eyeheader-main-purple-a.gif" alt="ClanSoft logo" width=525 height=96></td></tr> <tr bgcolor=#dadada><td align=left valign=top><img border=0 src="../images/eyeheader-main-purple-b.gif" alt="ClanSoft logo" width=190 height=14></td><td align=right valign=top><img border=0 src="../images/clanlib_light.gif" width=42 height=14></td></tr></table> <table align=center border=0 cellspacing=10> <tr> <td><a href="entire_class_index.html">Entire Class Index</a></td> <td><a href="class_index.html">Main Class Index</a></td> <td><a href="cross_index.html">Cross Index</a></td> <td><a href="global_index.html">Global Index</a></td> </table><h1 align=center>Class CL_EventListener</h1><p> <b> Event Listener Class</b><br> Contained in: <a href="global_index.html">global</a><br> Derived from: <i>none</i> <br> Derived by: <i>none</i> <br>Group: Core (System) <p> #include <ClanLib/core.h> <p> <hr noshade> <table border=0> <tr><td colspan=3><h3>public function member index:</h3></td> <tr valign=top><td align=left><h3>Construction:</h3></td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_EventListener.html#627"><tt><font color=blue><b>CL_EventListener</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_EventListener.html#628"><tt><font color=blue><b>CL_EventListener</b></font></tt></a></td><td><tt>(<a href="CL_EventTrigger.html"><tt><font color=navy><b>CL_EventTrigger</b></font></tt></a>* <tt><font color=blue>trigger</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="CL_EventListener.html#629"><tt><font color=blue><b>~CL_EventListener</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=left><h3>Operations:</h3></td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_EventListener.html#630"><tt><font color=blue><b>add_trigger</b></font></tt></a></td><td><tt>(<a href="CL_EventTrigger.html"><tt><font color=navy><b>CL_EventTrigger</b></font></tt></a>* <tt><font color=blue>trigger</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_EventListener.html#631"><tt><font color=blue><b>remove_trigger</b></font></tt></a></td><td><tt>(<a href="CL_EventTrigger.html"><tt><font color=navy><b>CL_EventTrigger</b></font></tt></a>* <tt><font color=blue>trigger</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_EventListener.html#632"><tt><font color=blue><b>clear</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_EventListener.html#633"><tt><font color=blue><b>reset_all</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_EventListener.html#634"><tt><font color=blue><b>wait</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>timeout</font></tt> = -1)</tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> The event listener is used to collect a set of events, identified as <a href="CL_EventTrigger.html">CL_EventTrigger</a>, and wait for one of them to occur. This is analog to the lowlevel C socket select() function, except that this one operates on clanlib objects.<br><p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="627"><font size=+1><b>CL_EventListener::CL_EventListener</b></font></a> - Constructs an empty event listener object.<br><tt></tt> <a href="CL_EventListener.html#627"><tt><font color=blue><b>CL_EventListener</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="628"><font size=+1><b>CL_EventListener::CL_EventListener</b></font></a> - Constructs an event listener with one trigger in it.<br><tt></tt> <a href="CL_EventListener.html#628"><tt><font color=blue><b>CL_EventListener</b></font></tt></a><tt>(<a href="CL_EventTrigger.html"><tt><font color=navy><b>CL_EventTrigger</b></font></tt></a>* <tt><font color=blue>trigger</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="630"><font size=+1><b>CL_EventListener::add_trigger</b></font></a> - Adds an event trigger to the listener.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_EventListener.html#630"><tt><font color=blue><b>add_trigger</b></font></tt></a><tt>(<a href="CL_EventTrigger.html"><tt><font color=navy><b>CL_EventTrigger</b></font></tt></a>* <tt><font color=blue>trigger</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="632"><font size=+1><b>CL_EventListener::clear</b></font></a> - Removes all event triggers from the listener.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_EventListener.html#632"><tt><font color=blue><b>clear</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="631"><font size=+1><b>CL_EventListener::remove_trigger</b></font></a> - Removes an event trigger from the listener.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_EventListener.html#631"><tt><font color=blue><b>remove_trigger</b></font></tt></a><tt>(<a href="CL_EventTrigger.html"><tt><font color=navy><b>CL_EventTrigger</b></font></tt></a>* <tt><font color=blue>trigger</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="633"><font size=+1><b>CL_EventListener::reset_all</b></font></a> - Resets all event triggers added to the listener.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_EventListener.html#633"><tt><font color=blue><b>reset_all</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="634"><font size=+1><b>CL_EventListener::wait</b></font></a> - Wait until one of the events triggers.<br> The timeout is in milliseconds.<br><tt><tt><font color=purple>bool</font></tt></tt> <a href="CL_EventListener.html#634"><tt><font color=blue><b>wait</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>timeout</font></tt> = -1)</tt>;<br><blockquote> If timeout = -1, this function will not timeout.<br> Returns true if an event triggered, false if it timed out.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="629"><font size=+1><b>CL_EventListener::~CL_EventListener</b></font></a> - Event Listener Destructor<br><tt><tt>virtual</tt> </tt> <a href="CL_EventListener.html#629"><tt><font color=blue><b>~CL_EventListener</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <hr noshade> <h2>Variable Member Descriptions:</h2> <hr noshade> </body> </html>
