Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 1922

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!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: iutil/eventhandlers.h Source File (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&nbsp;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><a href="classes.html"><span>Classes</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>iutil/eventhandlers.h</h1><a href="iutil_2eventhandlers_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">  Copyright (C) 2005 by Adam D. Bradley &lt;artdodge@cs.bu.edu&gt;</span>
<a name="l00003"></a>00003 <span class="comment">  </span>
<a name="l00004"></a>00004 <span class="comment">  This library is free software; you can redistribute it and/or</span>
<a name="l00005"></a>00005 <span class="comment">  modify it under the terms of the GNU Library General Public</span>
<a name="l00006"></a>00006 <span class="comment">  License as published by the Free Software Foundation; either</span>
<a name="l00007"></a>00007 <span class="comment">  version 2 of the License, or (at your option) any later version.</span>
<a name="l00008"></a>00008 <span class="comment">  </span>
<a name="l00009"></a>00009 <span class="comment">  This library is distributed in the hope that it will be useful,</span>
<a name="l00010"></a>00010 <span class="comment">  but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00011"></a>00011 <span class="comment">  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00012"></a>00012 <span class="comment">  Library General Public License for more details.</span>
<a name="l00013"></a>00013 <span class="comment">  </span>
<a name="l00014"></a>00014 <span class="comment">  You should have received a copy of the GNU Library General Public</span>
<a name="l00015"></a>00015 <span class="comment">  License along with this library; if not, write to the Free</span>
<a name="l00016"></a>00016 <span class="comment">  Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00017"></a>00017 <span class="comment">*/</span>
<a name="l00018"></a>00018 
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef __CS_IUTIL_EVENTHANDLERS_H__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_IUTIL_EVENTHANDLERS_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00022"></a>00022 <span class="preprocessor">#include "<a class="code" href="hash_8h.html" title="A generic hash table.">csutil/hash.h</a>"</span>
<a name="l00023"></a>00023 
<a name="l00032"></a><a class="code" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">00032</a> <span class="keyword">typedef</span> <a class="code" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd" title="An identifier for a string.">csStringID</a> <a class="code" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a>;
<a name="l00033"></a><a class="code" href="group__event__handling.html#gea5ee8f1eba9a0173e3a0f343b9d0603">00033</a> <span class="preprocessor">#define CS_HANDLER_INVALID csInvalidStringID</span>
<a name="l00034"></a><a class="code" href="group__event__handling.html#g9aa0e2476106e51c7a44ced844b6f20b">00034</a> <span class="preprocessor"></span><span class="preprocessor">#define CS_HANDLERLIST_END csInvalidStringID</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span>
<a name="l00036"></a>00036 <span class="preprocessor">#ifndef CSHASHCOMPUTER_EVENTENGINE_IDS</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span><span class="preprocessor">#define CSHASHCOMPUTER_EVENTENGINE_IDS</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="keyword">template</span>&lt;&gt;
<a name="l00039"></a><a class="code" href="classcsHashComputer_3_01const_01csHandlerID_01_4.html">00039</a> <span class="keyword">class </span><a class="code" href="classcsHashComputer.html" title="Template for hash value computing.">csHashComputer</a>&lt;const <a class="code" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a>&gt;
<a name="l00040"></a>00040 {
<a name="l00041"></a>00041 <span class="keyword">public</span>:
<a name="l00042"></a><a class="code" href="classcsHashComputer_3_01const_01csHandlerID_01_4.html#904ad31fbe021b9eb7a3de39b1d49903">00042</a>   <span class="keyword">static</span> <a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a> <a class="code" href="classcsHashComputer.html#28098b758683db0027dd7fafb900096b" title="Compute a hash value for key.">ComputeHash</a> (<span class="keyword">const</span> <a class="code" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> &amp;mid) 
<a name="l00043"></a>00043   {
<a name="l00044"></a>00044     <span class="keywordflow">return</span> (<a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a>) mid;
<a name="l00045"></a>00045   }
<a name="l00046"></a>00046 };
<a name="l00047"></a>00047 <span class="preprocessor">#endif // CSHASHCOMPUTER_EVENTENGINE_IDS</span>
<a name="l00048"></a>00048 <span class="preprocessor"></span>
<a name="l00049"></a>00049 <span class="keyword">struct </span><a class="code" href="structiEventHandler.html" title="This interface describes an entity that can receive events.">iEventHandler</a>;
<a name="l00050"></a>00050 
<a name="l00058"></a><a class="code" href="structiEventHandlerRegistry.html">00058</a> <span class="keyword">struct </span><a class="code" href="structiEventHandlerRegistry.html" title="This interface represents a general event handler registry/resolver.">iEventHandlerRegistry</a> : <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a>
<a name="l00059"></a>00059 {
<a name="l00060"></a>00060   SCF_INTERFACE(<a class="code" href="structiEventHandlerRegistry.html" title="This interface represents a general event handler registry/resolver.">iEventHandlerRegistry</a>, 1, 3, 0);
<a name="l00061"></a>00061 
<a name="l00067"></a>00067   <span class="keyword">virtual</span> <a class="code" href="cssysdef_8h.html#66bba4b4bdb4b6dadd37563abc499d48" title="Use the CS_CONST_METHOD macro in front of method declarations to indicate that they...">CS_CONST_METHOD</a> <a class="code" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> <a class="code" href="structiEventHandlerRegistry.html#a21b5745e5ac66739232d8968cfaeec1" title="Get a csHandlerID based upon some string.">GetGenericID</a> (<span class="keyword">const</span> <span class="keywordtype">char</span>*) = 0;
<a name="l00068"></a>00068   <span class="keyword">virtual</span> <a class="code" href="cssysdef_8h.html#66bba4b4bdb4b6dadd37563abc499d48" title="Use the CS_CONST_METHOD macro in front of method declarations to indicate that they...">CS_CONST_METHOD</a> <a class="code" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> GetGenericPreBoundID (<a class="code" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a>) = 0;
<a name="l00069"></a>00069   <span class="keyword">virtual</span> <a class="code" href="cssysdef_8h.html#66bba4b4bdb4b6dadd37563abc499d48" title="Use the CS_CONST_METHOD macro in front of method declarations to indicate that they...">CS_CONST_METHOD</a> <a class="code" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> GetGenericPostBoundID (<a class="code" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a>) = 0;
<a name="l00076"></a>00076   <span class="keyword">virtual</span> <a class="code" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> <a class="code" href="structiEventHandlerRegistry.html#513859c14a149c88f755b24c1aa297cd" title="Get the csHandlerID for a specified event handler, which provides its own name via...">GetID</a> (<a class="code" href="structiEventHandler.html" title="This interface describes an entity that can receive events.">iEventHandler</a> *) = 0;
<a name="l00082"></a>00082   <span class="keyword">virtual</span> <a class="code" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> <a class="code" href="structiEventHandlerRegistry.html#513859c14a149c88f755b24c1aa297cd" title="Get the csHandlerID for a specified event handler, which provides its own name via...">GetID</a> (<span class="keyword">const</span> <span class="keywordtype">char</span>*) = 0;
<a name="l00083"></a>00083 
<a name="l00090"></a>00090   <span class="keyword">virtual</span> <a class="code" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> <a class="code" href="structiEventHandlerRegistry.html#37489d90f8d0f9fea855150236253109" title="Register an event handler to obtain a handler ID.">RegisterID</a> (<a class="code" href="structiEventHandler.html" title="This interface describes an entity that can receive events.">iEventHandler</a> *) = 0;
<a name="l00094"></a>00094   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiEventHandlerRegistry.html#2bc501367b96d67a578fe0b88706bbf7" title="Used when an iEventHandler is destroyed to remove our reference.">ReleaseID</a> (<a class="code" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> <span class="keywordtype">id</span>) = 0;
<a name="l00098"></a>00098   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiEventHandlerRegistry.html#2bc501367b96d67a578fe0b88706bbf7" title="Used when an iEventHandler is destroyed to remove our reference.">ReleaseID</a> (<a class="code" href="structiEventHandler.html" title="This interface describes an entity that can receive events.">iEventHandler</a> *) = 0;
<a name="l00104"></a>00104   <span class="keyword">virtual</span> <a class="code" href="cssysdef_8h.html#66bba4b4bdb4b6dadd37563abc499d48" title="Use the CS_CONST_METHOD macro in front of method declarations to indicate that they...">CS_CONST_METHOD</a> <a class="code" href="structiEventHandler.html" title="This interface describes an entity that can receive events.">iEventHandler</a> *<a class="code" href="structiEventHandlerRegistry.html#362d1aea18b8b62acdad5f03fc8775cb" title="Returns the handler registered for a csHandlerID (will be NULL if csHandlerID is...">GetHandler</a> (<a class="code" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> <span class="keywordtype">id</span>) = 0;
<a name="l00110"></a>00110   <span class="keyword">virtual</span> <a class="code" href="cssysdef_8h.html#66bba4b4bdb4b6dadd37563abc499d48" title="Use the CS_CONST_METHOD macro in front of method declarations to indicate that they...">CS_CONST_METHOD</a> <span class="keywordtype">bool</span> <span class="keyword">const</span> <a class="code" href="structiEventHandlerRegistry.html#a9ba543b263b24842e4741e676c292bf" title="returns true if instanceid is a handler instance, genericid is a generic instance...">IsInstanceOf</a> (<a class="code" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> instanceid, 
<a name="l00111"></a>00111     <a class="code" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> genericid) = 0;
<a name="l00115"></a>00115   <span class="keyword">virtual</span> <a class="code" href="cssysdef_8h.html#66bba4b4bdb4b6dadd37563abc499d48" title="Use the CS_CONST_METHOD macro in front of method declarations to indicate that they...">CS_CONST_METHOD</a> <span class="keywordtype">bool</span> <span class="keyword">const</span> <a class="code" href="structiEventHandlerRegistry.html#809449b16476a08f1a979af2dee46f5f" title="returns true if id is a handler instance (i.e., not a generic name).">IsInstance</a> (<a class="code" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> <span class="keywordtype">id</span>) = 0;
<a name="l00119"></a>00119   <span class="keyword">virtual</span> <a class="code" href="cssysdef_8h.html#66bba4b4bdb4b6dadd37563abc499d48" title="Use the CS_CONST_METHOD macro in front of method declarations to indicate that they...">CS_CONST_METHOD</a> <a class="code" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> <span class="keyword">const</span> <a class="code" href="structiEventHandlerRegistry.html#434acdbf4ec1c643d0a4dc7327fbe45e" title="Returns the csHandleID for the generic name for instance name id.">GetGeneric</a> (<a class="code" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> <span class="keywordtype">id</span>) = 0;
<a name="l00123"></a>00123   <span class="keyword">virtual</span> <a class="code" href="cssysdef_8h.html#66bba4b4bdb4b6dadd37563abc499d48" title="Use the CS_CONST_METHOD macro in front of method declarations to indicate that they...">CS_CONST_METHOD</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structiEventHandlerRegistry.html#c47077eab375df1c6876d652671f41fa" title="Returns the string name for a csHandlerID.">GetString</a> (<a class="code" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> <span class="keywordtype">id</span>) = 0;
<a name="l00124"></a>00124 }; 
<a name="l00125"></a>00125 
<a name="l00128"></a>00128 <span class="preprocessor">#endif // __CS_IUTIL_EVENTHANDLERS_H__</span>
</pre></div><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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional