<html> <head><title>ClanLib Reference: CL_Timer</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_Timer</h1><p> <b> Timer signal emitter.</b><br> Contained in: <a href="global_index.html">global</a><br> Derived from: <a href="CL_KeepAlive.html">CL_KeepAlive</a> <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_Timer.html#614"><tt><font color=blue><b>CL_Timer</b></font></tt></a></td><td><tt>(<tt><font color=navy>unsigned</font></tt> <tt><font color=blue>long</font></tt> <tt><font color=blue>interval</font></tt> = 1000)</tt>;</td> <tr valign=top><td align=left><h3>Attributes:</h3></td> <tr valign=top><td align=right><tt><tt><font color=navy>unsigned</font></tt> <tt><font color=navy>long</font></tt></tt> </td><td align=right><a href="CL_Timer.html#615"><tt><font color=blue><b>get_interval</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_Timer.html#616"><tt><font color=blue><b>is_enabled</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_Timer.html#617"><tt><font color=blue><b>set_interval</b></font></tt></a></td><td><tt>(<tt><font color=navy>unsigned</font></tt> <tt><font color=blue>long</font></tt> <tt><font color=blue>interval</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_Timer.html#618"><tt><font color=blue><b>enable</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_Timer.html#619"><tt><font color=blue><b>disable</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=left><h3>Signals:</h3></td> <tr valign=top><td align=right><tt><a href="CL_Signal_v0.html"><tt><font color=navy><b>CL_Signal_v0</b></font></tt></a>&</tt> </td><td align=right><a href="CL_Timer.html#620"><tt><font color=blue><b>sig_timer</b></font></tt></a></td><td><tt>()</tt>;</td> <tr><td> </td><tr><td colspan=3><h3>private function member index:</h3></td> <tr valign=top><td align=left><h3>Implementation:</h3></td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Timer.html#621"><tt><font color=blue><b>keep_alive</b></font></tt></a></td><td><tt>()</tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> Use this class to emit a signal as a timer event.<br><p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="614"><font size=+1><b>CL_Timer::CL_Timer</b></font></a> - Constructs and registers the timer as a keep_alive listener.<br> Note that it is disabled by default, so you need to enable() it.<br><tt></tt> <a href="CL_Timer.html#614"><tt><font color=blue><b>CL_Timer</b></font></tt></a><tt>(<tt><font color=navy>unsigned</font></tt> <tt><font color=blue>long</font></tt> <tt><font color=blue>interval</font></tt> = 1000)</tt>;<br><blockquote> interval - Interval in millisecs between each signal emit.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="619"><font size=+1><b>CL_Timer::disable</b></font></a> - Call this function to disable the timer.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Timer.html#619"><tt><font color=blue><b>disable</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="618"><font size=+1><b>CL_Timer::enable</b></font></a> - Call this function to enable the timer.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Timer.html#618"><tt><font color=blue><b>enable</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="615"><font size=+1><b>CL_Timer::get_interval</b></font></a> - Returns the current time interval.<br><tt><tt><font color=navy>unsigned</font></tt> <tt><font color=navy>long</font></tt></tt> <a href="CL_Timer.html#615"><tt><font color=blue><b>get_interval</b></font></tt></a><tt>()</tt>;<br><blockquote> Returns - The current time interval.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="616"><font size=+1><b>CL_Timer::is_enabled</b></font></a> - Returns true if the timer is enabled, false otherwise.<br><tt><tt><font color=purple>bool</font></tt></tt> <a href="CL_Timer.html#616"><tt><font color=blue><b>is_enabled</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="617"><font size=+1><b>CL_Timer::set_interval</b></font></a> - Sets a new interval for the timer.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Timer.html#617"><tt><font color=blue><b>set_interval</b></font></tt></a><tt>(<tt><font color=navy>unsigned</font></tt> <tt><font color=blue>long</font></tt> <tt><font color=blue>interval</font></tt>)</tt>;<br><blockquote> interval - Interval in millisecs between each signal emit.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="620"><font size=+1><b>CL_Timer::sig_timer</b></font></a> - Signal emitted everytime the interval has elapsed.<br><tt><a href="CL_Signal_v0.html"><tt><font color=navy><b>CL_Signal_v0</b></font></tt></a>&</tt> <a href="CL_Timer.html#620"><tt><font color=blue><b>sig_timer</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>
