<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: iEventTimer Struct Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>iEventTimer Struct Reference</h1><!-- doxytag: class="iEventTimer" --><!-- doxytag: inherits="iBase" -->A timer.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="iutil_2timer_8h-source.html">iutil/timer.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iEventTimer:</div>
<div class="dynsection">
<p><center><img src="structiEventTimer__inherit__graph.png" border="0" usemap="#iEventTimer__inherit__map" alt="Inheritance graph"></center>
<map name="iEventTimer__inherit__map">
<area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csEventTimer, iEventTimer \>" alt="" coords="5,161,357,188"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="153,7,209,33"><area shape="rect" href="classcsEventTimer.html" title="This class implements a timer." alt="" coords="127,239,236,265"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiEventTimer-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiEventTimer.html#689d3bb68f963d5b46f4dc792b6aab8c">AddTimerEvent</a> (<a class="el" href="structiTimerEvent.html">iTimerEvent</a> *ev, <a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> delay)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a timer event to be scheduled later. <a href="#689d3bb68f963d5b46f4dc792b6aab8c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structiEventTimer.html#fbf95af9a411c1619c1e5621d5874031">GetEventCount</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query the number of events still in the queue. <a href="#fbf95af9a411c1619c1e5621d5874031"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structiEventTimer.html#bf08937e06ff5cd93776d17695917035">GetTimeLeft</a> (size_t idx) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query the number of ticks before the specified event fires. <a href="#bf08937e06ff5cd93776d17695917035"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiEventTimer.html#e991d51aefa5393acac16471a207ba60">RemoveAllTimerEvents</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear all timer events. <a href="#e991d51aefa5393acac16471a207ba60"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiEventTimer.html#ab1a6f17c931a1dbcc0926a3ff70a8ab">RemoveTimerEvent</a> (<a class="el" href="structiTimerEvent.html">iTimerEvent</a> *ev)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a timer event. <a href="#ab1a6f17c931a1dbcc0926a3ff70a8ab"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A timer.
<p>
You can add operations to it and they will be performed at the dedicated time.
<p>Definition at line <a class="el" href="iutil_2timer_8h-source.html#l00047">47</a> of file <a class="el" href="iutil_2timer_8h-source.html">timer.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="689d3bb68f963d5b46f4dc792b6aab8c"></a><!-- doxytag: member="iEventTimer::AddTimerEvent" ref="689d3bb68f963d5b46f4dc792b6aab8c" args="(iTimerEvent *ev, csTicks delay)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iEventTimer::AddTimerEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiTimerEvent.html">iTimerEvent</a> * </td>
<td class="paramname"> <em>ev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> </td>
<td class="paramname"> <em>delay</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a timer event to be scheduled later.
<p>
<p>Implemented in <a class="el" href="classcsEventTimer.html#5ec1cfeb085f70a266ef0f20ae55ef92">csEventTimer</a>.</p>
</div>
</div><p>
<a class="anchor" name="fbf95af9a411c1619c1e5621d5874031"></a><!-- doxytag: member="iEventTimer::GetEventCount" ref="fbf95af9a411c1619c1e5621d5874031" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t iEventTimer::GetEventCount </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query the number of events still in the queue.
<p>
<p>Implemented in <a class="el" href="classcsEventTimer.html#dbe80cf32749062636d9816f4a596b20">csEventTimer</a>.</p>
</div>
</div><p>
<a class="anchor" name="bf08937e06ff5cd93776d17695917035"></a><!-- doxytag: member="iEventTimer::GetTimeLeft" ref="bf08937e06ff5cd93776d17695917035" args="(size_t idx) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> iEventTimer::GetTimeLeft </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>idx</em> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query the number of ticks before the specified event fires.
<p>
<p>Implemented in <a class="el" href="classcsEventTimer.html#88daf685b1df8016b92749b7fdfc4004">csEventTimer</a>.</p>
</div>
</div><p>
<a class="anchor" name="e991d51aefa5393acac16471a207ba60"></a><!-- doxytag: member="iEventTimer::RemoveAllTimerEvents" ref="e991d51aefa5393acac16471a207ba60" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iEventTimer::RemoveAllTimerEvents </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clear all timer events.
<p>
<p>Implemented in <a class="el" href="classcsEventTimer.html#4c62c5d635f309d9fb15d0a9f19b35cb">csEventTimer</a>.</p>
</div>
</div><p>
<a class="anchor" name="ab1a6f17c931a1dbcc0926a3ff70a8ab"></a><!-- doxytag: member="iEventTimer::RemoveTimerEvent" ref="ab1a6f17c931a1dbcc0926a3ff70a8ab" args="(iTimerEvent *ev)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iEventTimer::RemoveTimerEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiTimerEvent.html">iTimerEvent</a> * </td>
<td class="paramname"> <em>ev</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove a timer event.
<p>
<p>Implemented in <a class="el" href="classcsEventTimer.html#3f8a23d8204ce11a3e89ac2ef4de1f33">csEventTimer</a>.</p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>iutil/<a class="el" href="iutil_2timer_8h-source.html">timer.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
3006
