<!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: csEvent Class 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>csEvent Class Reference</h1><!-- doxytag: class="csEvent" --><!-- doxytag: inherits="scfImplementation1< csEvent, iEvent >" -->This class represents a system event.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="csevent_8h-source.html">csutil/csevent.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for csEvent:</div>
<div class="dynsection">
<p><center><img src="classcsEvent__inherit__graph.png" border="0" usemap="#csEvent__inherit__map" alt="Inheritance graph"></center>
<map name="csEvent__inherit__map">
<area shape="rect" href="classcsPoolEvent.html" title="This class is a system event designed for the pool system." alt="" coords="149,316,251,343"><area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csEvent, iEvent \>" alt="" coords="60,161,340,188"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\< csEvent \>" alt="" coords="5,84,229,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="253,7,309,33"><area shape="rect" href="structiEvent.html" title="This interface describes any system event." alt="" coords="253,84,315,111"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="7,7,228,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classcsEvent-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 bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEvent.html#8511f51216b50c9a4adbe2b999607f3e">AttributeExists</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test whether an attribute exists. <a href="#8511f51216b50c9a4adbe2b999607f3e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEvent.html#30ece784f46d42a4186750d18797ca9b">csEvent</a> (<a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> iTime, <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> iName, bool iBroadcast)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Basic constructor. <a href="#30ece784f46d42a4186750d18797ca9b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEvent.html#372f1ea1eae355af3a50e75d90c8b878">csEvent</a> (<a class="el" href="classcsEvent.html">csEvent</a> const &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Cloning constructor. <a href="#372f1ea1eae355af3a50e75d90c8b878"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEvent.html#7201cd3fb4e4568c24e4beff5332c851">csEvent</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Empty initializer. <a href="#7201cd3fb4e4568c24e4beff5332c851"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsRef.html">csRef</a><br>
< <a class="el" href="structiEventAttributeIterator.html">iEventAttributeIterator</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEvent.html#5205f1316dcb14712547bd24c8e2bd2c">GetAttributeIterator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an iterator for all attributes. <a href="#5205f1316dcb14712547bd24c8e2bd2c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
<a class="el" href="group__event__handling.html#ge12006d83c6b873a567c93fbb4670fe1">csEventAttributeType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEvent.html#b628cbc7e69c6bd183cc7cd0fbf60501">GetAttributeType</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query the type of an attribute. <a href="#b628cbc7e69c6bd183cc7cd0fbf60501"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEvent.html#3ad72866942a33aae56fd023aef0bc47">GetName</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the event's name. <a href="#3ad72866942a33aae56fd023aef0bc47"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEvent.html#347e050262f2760d62c0571a44b82f2a">Remove</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a specific attribute. <a href="#347e050262f2760d62c0571a44b82f2a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEvent.html#901711a2bc2d9dc13cc4f94c7aec7286">RemoveAll</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove all attributes. <a href="#901711a2bc2d9dc13cc4f94c7aec7286"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="87d9fc40e174778ecc428bc153e1339b"></a><!-- doxytag: member="csEvent::Retrieve" ref="87d9fc40e174778ecc428bc153e1339b" args="(const char *name, uint64 &value) const " -->
virtual <a class="el" href="group__event__handling.html#ge069ae995b63f57fb1732075224dcfee">csEventError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEvent.html#87d9fc40e174778ecc428bc153e1339b">Retrieve</a> (const char *name, <a class="el" href="group__util.html#g058a7c8f752204f23318dc1dcab45b1c">uint64</a> &value) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e1675a238f9e349d6ad5a6018597f100"></a><!-- doxytag: member="csEvent::Retrieve" ref="e1675a238f9e349d6ad5a6018597f100" args="(const char *name, int64 &value) const " -->
virtual <a class="el" href="group__event__handling.html#ge069ae995b63f57fb1732075224dcfee">csEventError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEvent.html#e1675a238f9e349d6ad5a6018597f100">Retrieve</a> (const char *name, <a class="el" href="group__util.html#gecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> &value) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEvent.html#8372b42364aae8b30a959feeb57deab6">~csEvent</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#8372b42364aae8b30a959feeb57deab6"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ff9ae46b7659747360e242efc68a4542"></a><!-- doxytag: member="csEvent::csEventAttributeIterator" ref="ff9ae46b7659747360e242efc68a4542" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEvent.html#ff9ae46b7659747360e242efc68a4542">csEventAttributeIterator</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class represents a system event.
<p>
Events can be generated by hardware (keyboard, mouse) as well as by software. There are so much constructors of this class as much different types of events exists.
<p>Definition at line <a class="el" href="csevent_8h-source.html#l00054">54</a> of file <a class="el" href="csevent_8h-source.html">csevent.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="7201cd3fb4e4568c24e4beff5332c851"></a><!-- doxytag: member="csEvent::csEvent" ref="7201cd3fb4e4568c24e4beff5332c851" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csEvent::csEvent </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Empty initializer.
<p>
</div>
</div><p>
<a class="anchor" name="372f1ea1eae355af3a50e75d90c8b878"></a><!-- doxytag: member="csEvent::csEvent" ref="372f1ea1eae355af3a50e75d90c8b878" args="(csEvent const &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csEvent::csEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcsEvent.html">csEvent</a> const & </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Cloning constructor.
<p>
Note that for command style events, this performs only a shallow copy of the `Info' attribute.
</div>
</div><p>
<a class="anchor" name="30ece784f46d42a4186750d18797ca9b"></a><!-- doxytag: member="csEvent::csEvent" ref="30ece784f46d42a4186750d18797ca9b" args="(csTicks iTime, csEventID iName, bool iBroadcast)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csEvent::csEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> </td>
<td class="paramname"> <em>iTime</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> </td>
<td class="paramname"> <em>iName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>iBroadcast</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Basic constructor.
<p>
</div>
</div><p>
<a class="anchor" name="8372b42364aae8b30a959feeb57deab6"></a><!-- doxytag: member="csEvent::~csEvent" ref="8372b42364aae8b30a959feeb57deab6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual csEvent::~csEvent </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="8511f51216b50c9a4adbe2b999607f3e"></a><!-- doxytag: member="csEvent::AttributeExists" ref="8511f51216b50c9a4adbe2b999607f3e" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool csEvent::AttributeExists </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Test whether an attribute exists.
<p>
<p>Implements <a class="el" href="structiEvent.html#2590526b6c812964a0c9976a932f9a2d">iEvent</a>.</p>
</div>
</div><p>
<a class="anchor" name="5205f1316dcb14712547bd24c8e2bd2c"></a><!-- doxytag: member="csEvent::GetAttributeIterator" ref="5205f1316dcb14712547bd24c8e2bd2c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsRef.html">csRef</a><<a class="el" href="structiEventAttributeIterator.html">iEventAttributeIterator</a>> csEvent::GetAttributeIterator </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get an iterator for all attributes.
<p>
<p>Implements <a class="el" href="structiEvent.html#a972b09d23753f74550cf36bca4e1170">iEvent</a>.</p>
</div>
</div><p>
<a class="anchor" name="b628cbc7e69c6bd183cc7cd0fbf60501"></a><!-- doxytag: member="csEvent::GetAttributeType" ref="b628cbc7e69c6bd183cc7cd0fbf60501" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__event__handling.html#ge12006d83c6b873a567c93fbb4670fe1">csEventAttributeType</a> csEvent::GetAttributeType </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query the type of an attribute.
<p>
<p>Implements <a class="el" href="structiEvent.html#837d5af3fddbabd5af623867074934ad">iEvent</a>.</p>
</div>
</div><p>
<a class="anchor" name="3ad72866942a33aae56fd023aef0bc47"></a><!-- doxytag: member="csEvent::GetName" ref="3ad72866942a33aae56fd023aef0bc47" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> csEvent::GetName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the event's name.
<p>
<p>Implements <a class="el" href="structiEvent.html#4c72c5b000eca40e780cb506aa506020">iEvent</a>.</p>
</div>
</div><p>
<a class="anchor" name="347e050262f2760d62c0571a44b82f2a"></a><!-- doxytag: member="csEvent::Remove" ref="347e050262f2760d62c0571a44b82f2a" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool csEvent::Remove </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove a specific attribute.
<p>
<p>Implements <a class="el" href="structiEvent.html#9c439111cd078826c5d194f59247dd3f">iEvent</a>.</p>
</div>
</div><p>
<a class="anchor" name="901711a2bc2d9dc13cc4f94c7aec7286"></a><!-- doxytag: member="csEvent::RemoveAll" ref="901711a2bc2d9dc13cc4f94c7aec7286" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool csEvent::RemoveAll </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove all attributes.
<p>
<p>Implements <a class="el" href="structiEvent.html#7ff5a7d54a4937d42554c61e7d11ccb0">iEvent</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="csevent_8h-source.html">csevent.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
>
454
