<html> <head><title>ClanLib Reference: CL_EventTrigger</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_EventTrigger</h1><p> <b> ClanLib Event trigger.</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_EventTrigger.html#988"><tt><font color=blue><b>CL_EventTrigger</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_EventTrigger.html#989"><tt><font color=blue><b>CL_EventTrigger</b></font></tt></a></td><td><tt>(<tt>const</tt> <a href="CL_EventTrigger.html#989"><tt><font color=blue><b>CL_EventTrigger</b></font></tt></a>& <tt><font color=blue>copy</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="CL_EventTrigger.html#990"><tt><font color=blue><b>~CL_EventTrigger</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=left><h3>Attributes:</h3></td> <tr valign=top><td align=right><tt><tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_EventTrigger.html#991"><tt><font color=blue><b>get_flag</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=left><h3>Operations:</h3></td> <tr valign=top><td align=right><tt><a href="CL_EventTrigger.html#989"><tt><font color=blue><b>CL_EventTrigger</b></font></tt></a>&</tt> </td><td align=right><a href="CL_EventTrigger.html#992"><tt><font color=black><b>operator</b></font></tt><tt> =</tt></a></td><td><tt>(<tt>const</tt> <a href="CL_EventTrigger.html#989"><tt><font color=blue><b>CL_EventTrigger</b></font></tt></a>& <tt><font color=blue>copy</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_EventTrigger.html#993"><tt><font color=blue><b>reset</b></font></tt></a></td><td><tt>() <tt>const</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_EventTrigger.html#994"><tt><font color=blue><b>set_flag</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_EventTrigger.html#995"><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> This class represents an event that can be triggered.<br> Collect several triggers together using the <a href="CL_EventListener.html">CL_EventListener</a> class, and then call the CL_EventListener::wait function to sleep until one of the events are triggered.<br><p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="988"><font size=+1><b>CL_EventTrigger::CL_EventTrigger</b></font></a> - Constructs an event trigger object.<br><tt></tt> <a href="CL_EventTrigger.html#988"><tt><font color=blue><b>CL_EventTrigger</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="989"><font size=+1><b>CL_EventTrigger::CL_EventTrigger</b></font></a> - Copy constructor.<br><tt></tt> <a href="CL_EventTrigger.html#989"><tt><font color=blue><b>CL_EventTrigger</b></font></tt></a><tt>(<tt>const</tt> <a href="CL_EventTrigger.html#989"><tt><font color=blue><b>CL_EventTrigger</b></font></tt></a>& <tt><font color=blue>copy</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="991"><font size=+1><b>CL_EventTrigger::get_flag</b></font></a> - Returns true if the trigger flag has been raised.<br><tt><tt><font color=purple>bool</font></tt></tt> <a href="CL_EventTrigger.html#991"><tt><font color=blue><b>get_flag</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="993"><font size=+1><b>CL_EventTrigger::reset</b></font></a> - Reset trigger flag.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_EventTrigger.html#993"><tt><font color=blue><b>reset</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="994"><font size=+1><b>CL_EventTrigger::set_flag</b></font></a> - Raise trigger flag.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_EventTrigger.html#994"><tt><font color=blue><b>set_flag</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="995"><font size=+1><b>CL_EventTrigger::wait</b></font></a> - Wait until one of the event triggers.<br> The timeout is in milliseconds.<br><tt><tt><font color=purple>bool</font></tt></tt> <a href="CL_EventTrigger.html#995"><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 the event triggered, false if it timed out.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="990"><font size=+1><b>CL_EventTrigger::~CL_EventTrigger</b></font></a> - Event Trigger Destructor<br><tt><tt>virtual</tt> </tt> <a href="CL_EventTrigger.html#990"><tt><font color=blue><b>~CL_EventTrigger</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>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
554fa56029a60daf7aab25253fdab3d8
>
files
>
70
