<!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: csEventNameRegistry 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>csEventNameRegistry Class Reference<br>
<small>
[<a class="el" href="group__event__handling.html">Event handling</a>]</small>
</h1><!-- doxytag: class="csEventNameRegistry" --><!-- doxytag: inherits="scfImplementation1< csEventNameRegistry, iEventNameRegistry >" -->The <a class="el" href="classcsEventNameRegistry.html" title="The csEventNameRegistry transforms textual event names (e.g., "crystalspace...">csEventNameRegistry</a> transforms textual event names (e.g., "crystalspace.input.joystick.3.button") into easier-to-manage csEventIDs (which, in non-debug builds, are really just csStringIDs).
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="csutil_2eventnames_8h-source.html">csutil/eventnames.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for csEventNameRegistry:</div>
<div class="dynsection">
<p><center><img src="classcsEventNameRegistry__inherit__graph.png" border="0" usemap="#csEventNameRegistry__inherit__map" alt="Inheritance graph"></center>
<map name="csEventNameRegistry__inherit__map">
<area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csEventNameRegistry, iEventNameRegistry \>" alt="" coords="60,161,527,188"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\< csEventNameRegistry \>" alt="" coords="5,84,323,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="347,7,403,33"><area shape="rect" href="structiEventNameRegistry.html" title="This interface represents a general event name resolver." alt="" coords="347,84,501,111"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="53,7,275,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classcsEventNameRegistry-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>iEventNameRegistry implementation</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventNameRegistry.html#23a4e9c3063f8fc231bcdcb3b4afc2a4">GetID</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the csEventID for an event name string (e.g., "crystalspace.input.keyboard.down"). <a href="#23a4e9c3063f8fc231bcdcb3b4afc2a4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventNameRegistry.html#21a9c15c0b28c6c27b660d00a42e35ef">GetParentID</a> (const <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the csEventID of the parent of the current event (e.g., the parent of "crystalspace.input.mouse" is "crystalspace.input"). <a href="#21a9c15c0b28c6c27b660d00a42e35ef"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventNameRegistry.html#998c19103f4eed292da56e59fec820b9">GetString</a> (const <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name represented by a csEventID. <a href="#998c19103f4eed292da56e59fec820b9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventNameRegistry.html#e79bb359fc213d4caacfeeb3429e3bef">IsImmediateChildOf</a> (const <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> child, const <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> parent)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine whether the name of the first csEventID is an immediate child of the name of the second csEventID (e.g., "crysalspace.input.mouse" is an immediate child of "crystalspace.input" but not of "crystalspace" or of ""). <a href="#e79bb359fc213d4caacfeeb3429e3bef"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventNameRegistry.html#d296e980626eec1238b1aaa7b6359a39">IsKindOf</a> (const <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> child, const <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> parent)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine whether the name of the first csEventID is equivalent to or a child of the name of the second csEventID (e.g., "crystalspace.input.mouse" is a "kind" of "crystalspace.input.mouse", "crystalspace.input", "crystalspace", and "", but not of "crystalspace.input.mouse.2"). <a href="#d296e980626eec1238b1aaa7b6359a39"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2f12bf0dd3372c86ca725312e42af3ef"></a><!-- doxytag: member="csEventNameRegistry::GetString" ref="2f12bf0dd3372c86ca725312e42af3ef" args="(iObjectRegistry *object_reg, csEventID id)" -->
static const char * </td><td class="memItemRight" valign="bottom"><b>GetString</b> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *object_reg, <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> id)</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3c34e6c6d9f713d2dff33e97cc3f1bf5"></a><!-- doxytag: member="csEventNameRegistry::GetID" ref="3c34e6c6d9f713d2dff33e97cc3f1bf5" args="(iObjectRegistry *object_reg, const char *name)" -->
static <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventNameRegistry.html#3c34e6c6d9f713d2dff33e97cc3f1bf5">GetID</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *object_reg, const char *name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="10bde97b8027839d81e8431f10b55360"></a><!-- doxytag: member="csEventNameRegistry::GetID" ref="10bde97b8027839d81e8431f10b55360" args="(iEventNameRegistry *name_reg, const char *name)" -->
static <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventNameRegistry.html#10bde97b8027839d81e8431f10b55360">GetID</a> (<a class="el" href="structiEventNameRegistry.html">iEventNameRegistry</a> *name_reg, const char *name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classcsRef.html">csRef</a><br>
< <a class="el" href="structiEventNameRegistry.html">iEventNameRegistry</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventNameRegistry.html#0617080f5f4626f72ce93449e0d88dbd">GetRegistry</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *object_reg)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the singleton <a class="el" href="structiEventNameRegistry.html" title="This interface represents a general event name resolver.">iEventNameRegistry</a> object registered in the <a class="el" href="structiObjectRegistry.html" title="This interface serves as a registry of other objects.">iObjectRegistry</a> (or create one if none yet exists). <a href="#0617080f5f4626f72ce93449e0d88dbd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d973d9716e35112ffc73f36410f97acb"></a><!-- doxytag: member="csEventNameRegistry::IsKindOf" ref="d973d9716e35112ffc73f36410f97acb" args="(iObjectRegistry *object_reg, csEventID name1, csEventID name2)" -->
static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventNameRegistry.html#d973d9716e35112ffc73f36410f97acb">IsKindOf</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *object_reg, <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> name1, <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> name2)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="747be21392e36d3843a81c314cde80aa"></a><!-- doxytag: member="csEventNameRegistry::IsKindOf" ref="747be21392e36d3843a81c314cde80aa" args="(iEventNameRegistry *name_reg, csEventID name1, csEventID name2)" -->
static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventNameRegistry.html#747be21392e36d3843a81c314cde80aa">IsKindOf</a> (<a class="el" href="structiEventNameRegistry.html">iEventNameRegistry</a> *name_reg, <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> name1, <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> name2)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="classcsEventNameRegistry.html" title="The csEventNameRegistry transforms textual event names (e.g., "crystalspace...">csEventNameRegistry</a> transforms textual event names (e.g., "crystalspace.input.joystick.3.button") into easier-to-manage csEventIDs (which, in non-debug builds, are really just csStringIDs).
<p>
Also offers easy methods for querying parentage relationships between two event names.<p>
Note that any modules across which event names will be shared need to call csEventNameRegistry::Register() on the same <a class="el" href="structiObjectRegistry.html" title="This interface serves as a registry of other objects.">iObjectRegistry</a>.
<p>Definition at line <a class="el" href="csutil_2eventnames_8h-source.html#l00063">63</a> of file <a class="el" href="csutil_2eventnames_8h-source.html">eventnames.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="23a4e9c3063f8fc231bcdcb3b4afc2a4"></a><!-- doxytag: member="csEventNameRegistry::GetID" ref="23a4e9c3063f8fc231bcdcb3b4afc2a4" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> csEventNameRegistry::GetID </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>
Get the csEventID for an event name string (e.g., "crystalspace.input.keyboard.down").
<p>
<p>Implements <a class="el" href="structiEventNameRegistry.html#f33928398843a0a1039f678bd356fafc">iEventNameRegistry</a>.</p>
</div>
</div><p>
<a class="anchor" name="21a9c15c0b28c6c27b660d00a42e35ef"></a><!-- doxytag: member="csEventNameRegistry::GetParentID" ref="21a9c15c0b28c6c27b660d00a42e35ef" args="(const csEventID id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> csEventNameRegistry::GetParentID </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the csEventID of the parent of the current event (e.g., the parent of "crystalspace.input.mouse" is "crystalspace.input").
<p>
<p>Implements <a class="el" href="structiEventNameRegistry.html#326cbb47201e4084f00a281d3264ccf7">iEventNameRegistry</a>.</p>
</div>
</div><p>
<a class="anchor" name="0617080f5f4626f72ce93449e0d88dbd"></a><!-- doxytag: member="csEventNameRegistry::GetRegistry" ref="0617080f5f4626f72ce93449e0d88dbd" args="(iObjectRegistry *object_reg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classcsRef.html">csRef</a><<a class="el" href="structiEventNameRegistry.html">iEventNameRegistry</a>> csEventNameRegistry::GetRegistry </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> * </td>
<td class="paramname"> <em>object_reg</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the singleton <a class="el" href="structiEventNameRegistry.html" title="This interface represents a general event name resolver.">iEventNameRegistry</a> object registered in the <a class="el" href="structiObjectRegistry.html" title="This interface serves as a registry of other objects.">iObjectRegistry</a> (or create one if none yet exists).
<p>
<p>Referenced by <a class="el" href="csutil_2eventnames_8h-source.html#l00406">csevCanvasOp()</a>, <a class="el" href="csutil_2eventnames_8h-source.html#l00272">csevJoystick()</a>, <a class="el" href="csutil_2eventnames_8h-source.html#l00288">csevJoystickOp()</a>, <a class="el" href="csutil_2eventnames_8h-source.html#l00197">csevMouse()</a>, and <a class="el" href="csutil_2eventnames_8h-source.html#l00213">csevMouseOp()</a>.</p>
</div>
</div><p>
<a class="anchor" name="998c19103f4eed292da56e59fec820b9"></a><!-- doxytag: member="csEventNameRegistry::GetString" ref="998c19103f4eed292da56e59fec820b9" args="(const csEventID id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* csEventNameRegistry::GetString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the name represented by a csEventID.
<p>
<p>Implements <a class="el" href="structiEventNameRegistry.html#e00e8296d4b7f433f90a3f0cd6f4d597">iEventNameRegistry</a>.</p>
</div>
</div><p>
<a class="anchor" name="e79bb359fc213d4caacfeeb3429e3bef"></a><!-- doxytag: member="csEventNameRegistry::IsImmediateChildOf" ref="e79bb359fc213d4caacfeeb3429e3bef" args="(const csEventID child, const csEventID parent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool csEventNameRegistry::IsImmediateChildOf </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> </td>
<td class="paramname"> <em>child</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> </td>
<td class="paramname"> <em>parent</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Determine whether the name of the first csEventID is an immediate child of the name of the second csEventID (e.g., "crysalspace.input.mouse" is an immediate child of "crystalspace.input" but not of "crystalspace" or of "").
<p>
<p>Implements <a class="el" href="structiEventNameRegistry.html#2b23221e3f3423ae9891616a305e6d87">iEventNameRegistry</a>.</p>
</div>
</div><p>
<a class="anchor" name="d296e980626eec1238b1aaa7b6359a39"></a><!-- doxytag: member="csEventNameRegistry::IsKindOf" ref="d296e980626eec1238b1aaa7b6359a39" args="(const csEventID child, const csEventID parent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool csEventNameRegistry::IsKindOf </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> </td>
<td class="paramname"> <em>child</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> </td>
<td class="paramname"> <em>parent</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Determine whether the name of the first csEventID is equivalent to or a child of the name of the second csEventID (e.g., "crystalspace.input.mouse" is a "kind" of "crystalspace.input.mouse", "crystalspace.input", "crystalspace", and "", but not of "crystalspace.input.mouse.2").
<p>
<p>Implements <a class="el" href="structiEventNameRegistry.html#0dcf8d2375db1a8f3905b775cfac0814">iEventNameRegistry</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="csutil_2eventnames_8h-source.html">eventnames.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
>
467
