<!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: iEventNameRegistry 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>iEventNameRegistry Struct Reference<br>
<small>
[<a class="el" href="group__event__handling.html">Event handling</a>]</small>
</h1><!-- doxytag: class="iEventNameRegistry" --><!-- doxytag: inherits="iBase" -->This interface represents a general event name resolver.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="iutil_2eventnames_8h-source.html">iutil/eventnames.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iEventNameRegistry:</div>
<div class="dynsection">
<p><center><img src="structiEventNameRegistry__inherit__graph.png" border="0" usemap="#iEventNameRegistry__inherit__map" alt="Inheritance graph"></center>
<map name="iEventNameRegistry__inherit__map">
<area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csEventNameRegistry, iEventNameRegistry \>" alt="" coords="5,161,472,188"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="211,7,267,33"><area shape="rect" href="classcsEventNameRegistry.html" title="The csEventNameRegistry transforms textual event names (e.g., "crystalspace..." alt="" coords="156,239,321,265"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiEventNameRegistry-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 <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structiEventNameRegistry.html#f33928398843a0a1039f678bd356fafc">GetID</a> (const char *name)=0</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="#f33928398843a0a1039f678bd356fafc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structiEventNameRegistry.html#326cbb47201e4084f00a281d3264ccf7">GetParentID</a> (const <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> id)=0</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="#326cbb47201e4084f00a281d3264ccf7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiEventNameRegistry.html#e00e8296d4b7f433f90a3f0cd6f4d597">GetString</a> (const <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> id)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name represented by a csEventID. <a href="#e00e8296d4b7f433f90a3f0cd6f4d597"></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="structiEventNameRegistry.html#2b23221e3f3423ae9891616a305e6d87">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)=0</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="#2b23221e3f3423ae9891616a305e6d87"></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="structiEventNameRegistry.html#0dcf8d2375db1a8f3905b775cfac0814">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)=0</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="#0dcf8d2375db1a8f3905b775cfac0814"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This interface represents a general event name resolver.
<p>
Event name resolvers transform string representations of event names (e.g., "crystalspace.input.joystick.2.move") into csEventIDs, which are used to key event subscription and delivery. Typically, one instance of this object is available from the shared-object registry (<a class="el" href="structiObjectRegistry.html" title="This interface serves as a registry of other objects.">iObjectRegistry</a>).<p>
Main creators of instances implementing this interface:<ul>
<li><a class="el" href="classcsInitializer.html#61494a85e1807c790070d36f5a055f10" title="Create everything needed to get a CS application operational.">csInitializer::CreateEnvironment()</a></li><li>csInitializer::CreateEventNameRegistry()</li></ul>
<p>
Main ways to get pointers to this interface:<ul>
<li><a class="el" href="iutil_2objreg_8h.html#ee5a756951eeb09857882b549a563261" title="Query an interface from the registry.">csQueryRegistry()</a> </li></ul>
<p>Definition at line <a class="el" href="iutil_2eventnames_8h-source.html#l00060">60</a> of file <a class="el" href="iutil_2eventnames_8h-source.html">eventnames.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="f33928398843a0a1039f678bd356fafc"></a><!-- doxytag: member="iEventNameRegistry::GetID" ref="f33928398843a0a1039f678bd356fafc" args="(const char *name)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> iEventNameRegistry::GetID </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td width="100%"><code> [pure 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>Implemented in <a class="el" href="classcsEventNameRegistry.html#23a4e9c3063f8fc231bcdcb3b4afc2a4">csEventNameRegistry</a>.</p>
<p>Referenced by <a class="el" href="csutil_2eventnames_8h-source.html#l00263">csevJoystick()</a>, <a class="el" href="csutil_2eventnames_8h-source.html#l00278">csevJoystickOp()</a>, <a class="el" href="csutil_2eventnames_8h-source.html#l00189">csevMouse()</a>, <a class="el" href="csutil_2eventnames_8h-source.html#l00203">csevMouseOp()</a>, and <a class="el" href="csutil_2eventnames_8h-source.html#l00096">csEventNameRegistry::GetID()</a>.</p>
</div>
</div><p>
<a class="anchor" name="326cbb47201e4084f00a281d3264ccf7"></a><!-- doxytag: member="iEventNameRegistry::GetParentID" ref="326cbb47201e4084f00a281d3264ccf7" args="(const csEventID id)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> iEventNameRegistry::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> [pure 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>Implemented in <a class="el" href="classcsEventNameRegistry.html#21a9c15c0b28c6c27b660d00a42e35ef">csEventNameRegistry</a>.</p>
</div>
</div><p>
<a class="anchor" name="e00e8296d4b7f433f90a3f0cd6f4d597"></a><!-- doxytag: member="iEventNameRegistry::GetString" ref="e00e8296d4b7f433f90a3f0cd6f4d597" args="(const csEventID id)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* iEventNameRegistry::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> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the name represented by a csEventID.
<p>
<p>Implemented in <a class="el" href="classcsEventNameRegistry.html#998c19103f4eed292da56e59fec820b9">csEventNameRegistry</a>.</p>
</div>
</div><p>
<a class="anchor" name="2b23221e3f3423ae9891616a305e6d87"></a><!-- doxytag: member="iEventNameRegistry::IsImmediateChildOf" ref="2b23221e3f3423ae9891616a305e6d87" args="(const csEventID child, const csEventID parent)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iEventNameRegistry::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> [pure 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>Implemented in <a class="el" href="classcsEventNameRegistry.html#e79bb359fc213d4caacfeeb3429e3bef">csEventNameRegistry</a>.</p>
</div>
</div><p>
<a class="anchor" name="0dcf8d2375db1a8f3905b775cfac0814"></a><!-- doxytag: member="iEventNameRegistry::IsKindOf" ref="0dcf8d2375db1a8f3905b775cfac0814" args="(const csEventID child, const csEventID parent)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iEventNameRegistry::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> [pure 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>Implemented in <a class="el" href="classcsEventNameRegistry.html#d296e980626eec1238b1aaa7b6359a39">csEventNameRegistry</a>.</p>
<p>Referenced by <a class="el" href="csutil_2eventnames_8h-source.html#l00113">csEventNameRegistry::IsKindOf()</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_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
>
2994
