<!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: csEventHandlerRegistry 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>csEventHandlerRegistry Class Reference<br>
<small>
[<a class="el" href="group__event__handling.html">Event handling</a>]</small>
</h1><!-- doxytag: class="csEventHandlerRegistry" --><!-- doxytag: inherits="scfImplementation1< csEventHandlerRegistry, iEventHandlerRegistry >" -->The <a class="el" href="classcsEventHandlerRegistry.html" title="The csEventHandlerRegistry maintains a global one-to-one mapping from strings to...">csEventHandlerRegistry</a> maintains a global one-to-one mapping from strings to csHandlerIDs, and a one-to-(zero or one) mapping from csHandlerIDs to <a class="el" href="structiEventHandler.html" title="This interface describes an entity that can receive events.">iEventHandler</a> pointers.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="csutil_2eventhandlers_8h-source.html">csutil/eventhandlers.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for csEventHandlerRegistry:</div>
<div class="dynsection">
<p><center><img src="classcsEventHandlerRegistry__inherit__graph.png" border="0" usemap="#csEventHandlerRegistry__inherit__map" alt="Inheritance graph"></center>
<map name="csEventHandlerRegistry__inherit__map">
<area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csEventHandlerRegistry, iEventHandlerRegistry \>" alt="" coords="60,161,548,188"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\< csEventHandlerRegistry \>" alt="" coords="5,84,333,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="357,7,413,33"><area shape="rect" href="structiEventHandlerRegistry.html" title="This interface represents a general event handler registry/resolver." alt="" coords="357,84,523,111"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="59,7,280,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classcsEventHandlerRegistry-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"><a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> const </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventHandlerRegistry.html#e2f41ce295347a02c73dfb23cd632ac9">GetGeneric</a> (<a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the csHandleID for the generic name for instance name id. <a href="#e2f41ce295347a02c73dfb23cd632ac9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventHandlerRegistry.html#13e54a3eed5c8579c38c0186ef3327c0">GetGenericID</a> (const char *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a csHandlerID based upon some string. <a href="#13e54a3eed5c8579c38c0186ef3327c0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structiEventHandler.html">iEventHandler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventHandlerRegistry.html#0236dc2ad7b9cb80c80006ab3b626ed9">GetHandler</a> (<a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the handler registered for a csHandlerID (will be 0 if csHandlerID is a generic name, i.e., if (!csEventHandlerRegistry->IsInstance(id)). <a href="#0236dc2ad7b9cb80c80006ab3b626ed9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventHandlerRegistry.html#564f227fe5baabdb3687300cbc0d05a0">GetID</a> (const char *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the ID for a given event handler name. <a href="#564f227fe5baabdb3687300cbc0d05a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventHandlerRegistry.html#d3d7ce1a59e00e1c322e07eb61cb7bc4">GetID</a> (<a class="el" href="structiEventHandler.html">iEventHandler</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the csHandlerID for a specified event handler, which provides its own name via the iEventHandler::GetInstanceName() method. <a href="#d3d7ce1a59e00e1c322e07eb61cb7bc4"></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="classcsEventHandlerRegistry.html#a8f4638595ce6b61d6f28f1532606465">GetString</a> (<a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the string name for a csHandlerID. <a href="#a8f4638595ce6b61d6f28f1532606465"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool const </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventHandlerRegistry.html#989bbe3abaedec3af0563a262b66de38">IsInstance</a> (<a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns true if id is a handler instance (i.e., not a generic name). <a href="#989bbe3abaedec3af0563a262b66de38"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool const </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventHandlerRegistry.html#b702c3d93cea03a437c8249e1b2eb891">IsInstanceOf</a> (<a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> instanceid, <a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> genericid)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns true if instanceid is a handler instance, genericid is a generic instance, and instanceid is an instance of genericid in particular. <a href="#b702c3d93cea03a437c8249e1b2eb891"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventHandlerRegistry.html#b87efdee85136c0fc3342d18d3d0bfa1">RegisterID</a> (<a class="el" href="structiEventHandler.html">iEventHandler</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register an event handler to obtain a handler ID. <a href="#b87efdee85136c0fc3342d18d3d0bfa1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventHandlerRegistry.html#898dce89e3daffa5fd438a84175de6d6">ReleaseID</a> (<a class="el" href="structiEventHandler.html">iEventHandler</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used when an <a class="el" href="structiEventHandler.html" title="This interface describes an entity that can receive events.">iEventHandler</a> is destroyed to remove our reference. <a href="#898dce89e3daffa5fd438a84175de6d6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventHandlerRegistry.html#ccba3e42ee457f987169ddcb987259ec">ReleaseID</a> (<a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used when an <a class="el" href="structiEventHandler.html" title="This interface describes an entity that can receive events.">iEventHandler</a> is desroyed to remove our reference. <a href="#ccba3e42ee457f987169ddcb987259ec"></a><br></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="f396640f3c3303313d9a7d8204bed34c"></a><!-- doxytag: member="csEventHandlerRegistry::GetGeneric" ref="f396640f3c3303313d9a7d8204bed34c" args="(iObjectRegistry *reg, csHandlerID id)" -->
static <a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventHandlerRegistry.html#f396640f3c3303313d9a7d8204bed34c">GetGeneric</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *reg, <a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> id)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aa085ce0ef055eaf2bd7b5e035bc1884"></a><!-- doxytag: member="csEventHandlerRegistry::GetGenericID" ref="aa085ce0ef055eaf2bd7b5e035bc1884" args="(iObjectRegistry *reg, const char *name)" -->
static <a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventHandlerRegistry.html#aa085ce0ef055eaf2bd7b5e035bc1884">GetGenericID</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *reg, const char *name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="09009b0bb896b3ec715d1b63523de41f"></a><!-- doxytag: member="csEventHandlerRegistry::GetGenericPostBoundID" ref="09009b0bb896b3ec715d1b63523de41f" args="(iObjectRegistry *reg, csHandlerID id)" -->
static <a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventHandlerRegistry.html#09009b0bb896b3ec715d1b63523de41f">GetGenericPostBoundID</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *reg, <a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> id)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="25eef7161c634d0077dcea1a717aa108"></a><!-- doxytag: member="csEventHandlerRegistry::GetGenericPreBoundID" ref="25eef7161c634d0077dcea1a717aa108" args="(iObjectRegistry *reg, csHandlerID id)" -->
static <a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventHandlerRegistry.html#25eef7161c634d0077dcea1a717aa108">GetGenericPreBoundID</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *reg, <a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> id)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0f2bfa20b578168abd16be64d38dd3c4"></a><!-- doxytag: member="csEventHandlerRegistry::GetHandler" ref="0f2bfa20b578168abd16be64d38dd3c4" args="(iObjectRegistry *reg, csHandlerID id)" -->
static <a class="el" href="structiEventHandler.html">iEventHandler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventHandlerRegistry.html#0f2bfa20b578168abd16be64d38dd3c4">GetHandler</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *reg, <a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> id)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="794eaac60521ba0a9964893b9c89626b"></a><!-- doxytag: member="csEventHandlerRegistry::GetID" ref="794eaac60521ba0a9964893b9c89626b" args="(iObjectRegistry *reg, const char *name)" -->
static <a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventHandlerRegistry.html#794eaac60521ba0a9964893b9c89626b">GetID</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *reg, const char *name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1fe2ebe24f0691e7c0b213e8caede8ac"></a><!-- doxytag: member="csEventHandlerRegistry::GetID" ref="1fe2ebe24f0691e7c0b213e8caede8ac" args="(iObjectRegistry *reg, iEventHandler *h)" -->
static <a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventHandlerRegistry.html#1fe2ebe24f0691e7c0b213e8caede8ac">GetID</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *reg, <a class="el" href="structiEventHandler.html">iEventHandler</a> *h)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="96aef0cc38a8eb28f84bfe27a861a5a1"></a><!-- doxytag: member="csEventHandlerRegistry::GetString" ref="96aef0cc38a8eb28f84bfe27a861a5a1" args="(iObjectRegistry *reg, csHandlerID id)" -->
static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventHandlerRegistry.html#96aef0cc38a8eb28f84bfe27a861a5a1">GetString</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *reg, <a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> id)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="06c77243a6825514e08b37bc15ff9405"></a><!-- doxytag: member="csEventHandlerRegistry::IsInstance" ref="06c77243a6825514e08b37bc15ff9405" args="(iObjectRegistry *reg, csHandlerID id)" -->
static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventHandlerRegistry.html#06c77243a6825514e08b37bc15ff9405">IsInstance</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *reg, <a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> id)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="17e5d9b9490c922244035e6e5fb36e61"></a><!-- doxytag: member="csEventHandlerRegistry::IsInstanceOf" ref="17e5d9b9490c922244035e6e5fb36e61" args="(iObjectRegistry *reg, csHandlerID instanceid, csHandlerID genericid)" -->
static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventHandlerRegistry.html#17e5d9b9490c922244035e6e5fb36e61">IsInstanceOf</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *reg, <a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> instanceid, <a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> genericid)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f647c57b7ec8f8eaa566752f19ec48fc"></a><!-- doxytag: member="csEventHandlerRegistry::RegisterID" ref="f647c57b7ec8f8eaa566752f19ec48fc" args="(iObjectRegistry *reg, iEventHandler *h)" -->
static <a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventHandlerRegistry.html#f647c57b7ec8f8eaa566752f19ec48fc">RegisterID</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *reg, <a class="el" href="structiEventHandler.html">iEventHandler</a> *h)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4d47d5b897f22db9a78b72754b1847f1"></a><!-- doxytag: member="csEventHandlerRegistry::ReleaseID" ref="4d47d5b897f22db9a78b72754b1847f1" args="(iObjectRegistry *reg, iEventHandler *h)" -->
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventHandlerRegistry.html#4d47d5b897f22db9a78b72754b1847f1">ReleaseID</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *reg, <a class="el" href="structiEventHandler.html">iEventHandler</a> *h)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d0d9e870c0125f3579fb011657093092"></a><!-- doxytag: member="csEventHandlerRegistry::ReleaseID" ref="d0d9e870c0125f3579fb011657093092" args="(iObjectRegistry *reg, csHandlerID id)" -->
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventHandlerRegistry.html#d0d9e870c0125f3579fb011657093092">ReleaseID</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *reg, <a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> id)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="classcsEventHandlerRegistry.html" title="The csEventHandlerRegistry maintains a global one-to-one mapping from strings to...">csEventHandlerRegistry</a> maintains a global one-to-one mapping from strings to csHandlerIDs, and a one-to-(zero or one) mapping from csHandlerIDs to <a class="el" href="structiEventHandler.html" title="This interface describes an entity that can receive events.">iEventHandler</a> pointers.
<p>Definition at line <a class="el" href="csutil_2eventhandlers_8h-source.html#l00051">51</a> of file <a class="el" href="csutil_2eventhandlers_8h-source.html">eventhandlers.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e2f41ce295347a02c73dfb23cd632ac9"></a><!-- doxytag: member="csEventHandlerRegistry::GetGeneric" ref="e2f41ce295347a02c73dfb23cd632ac9" args="(csHandlerID id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> const csEventHandlerRegistry::GetGeneric </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</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>
Returns the csHandleID for the generic name for instance name id.
<p>
<p>Implements <a class="el" href="structiEventHandlerRegistry.html#434acdbf4ec1c643d0a4dc7327fbe45e">iEventHandlerRegistry</a>.</p>
</div>
</div><p>
<a class="anchor" name="13e54a3eed5c8579c38c0186ef3327c0"></a><!-- doxytag: member="csEventHandlerRegistry::GetGenericID" ref="13e54a3eed5c8579c38c0186ef3327c0" args="(const char *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> csEventHandlerRegistry::GetGenericID </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a csHandlerID based upon some string.
<p>
This should only ever be done to reference generic (non-instantiated) handler names or single-instance handlers.
<p>Implements <a class="el" href="structiEventHandlerRegistry.html#a21b5745e5ac66739232d8968cfaeec1">iEventHandlerRegistry</a>.</p>
</div>
</div><p>
<a class="anchor" name="0236dc2ad7b9cb80c80006ab3b626ed9"></a><!-- doxytag: member="csEventHandlerRegistry::GetHandler" ref="0236dc2ad7b9cb80c80006ab3b626ed9" args="(csHandlerID id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structiEventHandler.html">iEventHandler</a>* csEventHandlerRegistry::GetHandler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</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>
Returns the handler registered for a csHandlerID (will be 0 if csHandlerID is a generic name, i.e., if (!csEventHandlerRegistry->IsInstance(id)).
<p>
<p>Implements <a class="el" href="structiEventHandlerRegistry.html#362d1aea18b8b62acdad5f03fc8775cb">iEventHandlerRegistry</a>.</p>
</div>
</div><p>
<a class="anchor" name="564f227fe5baabdb3687300cbc0d05a0"></a><!-- doxytag: member="csEventHandlerRegistry::GetID" ref="564f227fe5baabdb3687300cbc0d05a0" args="(const char *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> csEventHandlerRegistry::GetID </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the ID for a given event handler name.
<p>
This should usually not be used, since it does not handle magic creation of ":pre" and ":post" signpost handlers or any other such bookkeeping magic.
<p>Implements <a class="el" href="structiEventHandlerRegistry.html#dcc43f92420a5cc0e0873f2edc917e08">iEventHandlerRegistry</a>.</p>
</div>
</div><p>
<a class="anchor" name="d3d7ce1a59e00e1c322e07eb61cb7bc4"></a><!-- doxytag: member="csEventHandlerRegistry::GetID" ref="d3d7ce1a59e00e1c322e07eb61cb7bc4" args="(iEventHandler *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> csEventHandlerRegistry::GetID </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiEventHandler.html">iEventHandler</a> * </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the csHandlerID for a specified event handler, which provides its own name via the iEventHandler::GetInstanceName() method.
<p>
<p>Implements <a class="el" href="structiEventHandlerRegistry.html#513859c14a149c88f755b24c1aa297cd">iEventHandlerRegistry</a>.</p>
</div>
</div><p>
<a class="anchor" name="a8f4638595ce6b61d6f28f1532606465"></a><!-- doxytag: member="csEventHandlerRegistry::GetString" ref="a8f4638595ce6b61d6f28f1532606465" args="(csHandlerID id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* csEventHandlerRegistry::GetString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</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>
Returns the string name for a csHandlerID.
<p>
<p>Implements <a class="el" href="structiEventHandlerRegistry.html#c47077eab375df1c6876d652671f41fa">iEventHandlerRegistry</a>.</p>
</div>
</div><p>
<a class="anchor" name="989bbe3abaedec3af0563a262b66de38"></a><!-- doxytag: member="csEventHandlerRegistry::IsInstance" ref="989bbe3abaedec3af0563a262b66de38" args="(csHandlerID id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool const csEventHandlerRegistry::IsInstance </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</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>
returns true if id is a handler instance (i.e., not a generic name).
<p>
<p>Implements <a class="el" href="structiEventHandlerRegistry.html#809449b16476a08f1a979af2dee46f5f">iEventHandlerRegistry</a>.</p>
</div>
</div><p>
<a class="anchor" name="b702c3d93cea03a437c8249e1b2eb891"></a><!-- doxytag: member="csEventHandlerRegistry::IsInstanceOf" ref="b702c3d93cea03a437c8249e1b2eb891" args="(csHandlerID instanceid, csHandlerID genericid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool const csEventHandlerRegistry::IsInstanceOf </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> </td>
<td class="paramname"> <em>instanceid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> </td>
<td class="paramname"> <em>genericid</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>
returns true if instanceid is a handler instance, genericid is a generic instance, and instanceid is an instance of genericid in particular.
<p>
<p>Implements <a class="el" href="structiEventHandlerRegistry.html#a9ba543b263b24842e4741e676c292bf">iEventHandlerRegistry</a>.</p>
</div>
</div><p>
<a class="anchor" name="b87efdee85136c0fc3342d18d3d0bfa1"></a><!-- doxytag: member="csEventHandlerRegistry::RegisterID" ref="b87efdee85136c0fc3342d18d3d0bfa1" args="(iEventHandler *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> csEventHandlerRegistry::RegisterID </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiEventHandler.html">iEventHandler</a> * </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Register an event handler to obtain a handler ID.
<p>
<dl class="remark" compact><dt><b>Remarks:</b></dt><dd>Every call must be balanced with a call to <a class="el" href="classcsEventHandlerRegistry.html#ccba3e42ee457f987169ddcb987259ec" title="Used when an iEventHandler is desroyed to remove our reference.">ReleaseID()</a> to ensure proper housekeeping. Otherwise, event handler instances may be leaking. </dd></dl>
<p>Implements <a class="el" href="structiEventHandlerRegistry.html#37489d90f8d0f9fea855150236253109">iEventHandlerRegistry</a>.</p>
</div>
</div><p>
<a class="anchor" name="898dce89e3daffa5fd438a84175de6d6"></a><!-- doxytag: member="csEventHandlerRegistry::ReleaseID" ref="898dce89e3daffa5fd438a84175de6d6" args="(iEventHandler *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csEventHandlerRegistry::ReleaseID </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiEventHandler.html">iEventHandler</a> * </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Used when an <a class="el" href="structiEventHandler.html" title="This interface describes an entity that can receive events.">iEventHandler</a> is destroyed to remove our reference.
<p>
<p>Implements <a class="el" href="structiEventHandlerRegistry.html#3ceb78db4f88a043a72dabce8830d298">iEventHandlerRegistry</a>.</p>
</div>
</div><p>
<a class="anchor" name="ccba3e42ee457f987169ddcb987259ec"></a><!-- doxytag: member="csEventHandlerRegistry::ReleaseID" ref="ccba3e42ee457f987169ddcb987259ec" args="(csHandlerID id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csEventHandlerRegistry::ReleaseID </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</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>
Used when an <a class="el" href="structiEventHandler.html" title="This interface describes an entity that can receive events.">iEventHandler</a> is desroyed to remove our reference.
<p>
<p>Implements <a class="el" href="structiEventHandlerRegistry.html#2bc501367b96d67a578fe0b88706bbf7">iEventHandlerRegistry</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_2eventhandlers_8h-source.html">eventhandlers.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
>
464
