Sophie

Sophie

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

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: FrameSignpost_ConsoleDebug 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&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 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&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<h1>FrameSignpost_ConsoleDebug Class Reference</h1><!-- doxytag: class="FrameSignpost_ConsoleDebug" --><!-- doxytag: inherits="scfImplementation2&lt; FrameSignpost_ConsoleDebug, iFrameEventSignpost, scfFakeInterface&lt; iEventHandler &gt; &gt;" --><div class="dynheader">
Inheritance diagram for FrameSignpost_ConsoleDebug:</div>
<div class="dynsection">
<p><center><img src="classFrameSignpost__ConsoleDebug__inherit__graph.png" border="0" usemap="#FrameSignpost__ConsoleDebug__inherit__map" alt="Inheritance graph"></center>
<map name="FrameSignpost__ConsoleDebug__inherit__map">
<area shape="rect" href="classscfImplementation2.html" title="scfImplementation2\&lt; FrameSignpost_ConsoleDebug, iFrameEventSignpost, scfFakeInterface\&lt; iEventHandler \&gt; \&gt;" alt="" coords="799,89,1559,116"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\&lt; FrameSignpost_ConsoleDebug \&gt;" alt="" coords="379,39,749,65"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="5,39,61,65"><area shape="rect" href="structiEventHandler.html" title="This interface describes an entity that can receive events." alt="" coords="164,89,276,116"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="109,39,331,65"><area shape="rect" href="structiFrameEventSignpost.html" title="iFrameEventSignpost" alt="" coords="484,89,644,116"><area shape="rect" href="classscfFakeInterface.html" title="scfFakeInterface\&lt; iEventHandler \&gt;" alt="" coords="440,140,688,167"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classFrameSignpost__ConsoleDebug-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 const <br>
<a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFrameSignpost__ConsoleDebug.html#37e653560992517d3fa2148b5a0b5f62">GenericPrec</a> (<a class="el" href="classcsRef.html">csRef</a>&lt; <a class="el" href="structiEventHandlerRegistry.html">iEventHandlerRegistry</a> &gt; &amp;, <a class="el" href="classcsRef.html">csRef</a>&lt; <a class="el" href="structiEventNameRegistry.html">iEventNameRegistry</a> &gt; &amp;, <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a>) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This function takes a csEventID as an argument and returns an array of csHandlerIDs identifying those event handlers which must, for the given event, only be called before this one (if they have been instantiated).  <a href="#37e653560992517d3fa2148b5a0b5f62"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <br>
<a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFrameSignpost__ConsoleDebug.html#4aab22de5446c98dd0f26ce0cab9fe15">GenericSucc</a> (<a class="el" href="classcsRef.html">csRef</a>&lt; <a class="el" href="structiEventHandlerRegistry.html">iEventHandlerRegistry</a> &gt; &amp;r1, <a class="el" href="classcsRef.html">csRef</a>&lt; <a class="el" href="structiEventNameRegistry.html">iEventNameRegistry</a> &gt; &amp;r2, <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> e) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This function takes a csEventID as an argument and returns an array of csHandlerIDs identifying those event handlers which must, for the given event, only be called after this one (if the have been instantiated).  <a href="#4aab22de5446c98dd0f26ce0cab9fe15"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>

<p>Definition at line <a class="el" href="csutil_2eventhandlers_8h-source.html#l00281">281</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="37e653560992517d3fa2148b5a0b5f62"></a><!-- doxytag: member="FrameSignpost_ConsoleDebug::GenericPrec" ref="37e653560992517d3fa2148b5a0b5f62" args="(csRef&lt; iEventHandlerRegistry &gt; &amp;, csRef&lt; iEventNameRegistry &gt; &amp;, csEventID) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const <a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a>* FrameSignpost_ConsoleDebug::GenericPrec           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classcsRef.html">csRef</a>&lt; <a class="el" href="structiEventHandlerRegistry.html">iEventHandlerRegistry</a> &gt; &amp;&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classcsRef.html">csRef</a>&lt; <a class="el" href="structiEventNameRegistry.html">iEventNameRegistry</a> &gt; &amp;&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a>&nbsp;</td>
          <td class="paramname"></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
This function takes a csEventID as an argument and returns an array of csHandlerIDs identifying those event handlers which must, for the given event, only be called before this one (if they have been instantiated). 
<p>
Should only return generic identifiers, not instance identifiers; in other words, every member of the array should be the result of a call to csHandlerRegistry::GetGenericID("name"), where "name" may be some class's static <a class="el" href="structiEventHandler.html#7880f6a777bc255ec58c42e4292e5071" title="This function returns a string which &quot;names&quot; this event handler generically...">GenericName()</a> function or a literal string.<p>
This should also be a "virtual static" function, but C++ doesn't have them. 
<p>Implements <a class="el" href="structiEventHandler.html#553f18803da012da45ce762ef029ee21">iEventHandler</a>.</p>

</div>
</div><p>
<a class="anchor" name="4aab22de5446c98dd0f26ce0cab9fe15"></a><!-- doxytag: member="FrameSignpost_ConsoleDebug::GenericSucc" ref="4aab22de5446c98dd0f26ce0cab9fe15" args="(csRef&lt; iEventHandlerRegistry &gt; &amp;r1, csRef&lt; iEventNameRegistry &gt; &amp;r2, csEventID e) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const <a class="el" href="group__event__handling.html#gd62f963e20f1180634a9557b392d987d">csHandlerID</a>* FrameSignpost_ConsoleDebug::GenericSucc           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classcsRef.html">csRef</a>&lt; <a class="el" href="structiEventHandlerRegistry.html">iEventHandlerRegistry</a> &gt; &amp;&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classcsRef.html">csRef</a>&lt; <a class="el" href="structiEventNameRegistry.html">iEventNameRegistry</a> &gt; &amp;&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a>&nbsp;</td>
          <td class="paramname"></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
This function takes a csEventID as an argument and returns an array of csHandlerIDs identifying those event handlers which must, for the given event, only be called after this one (if the have been instantiated). 
<p>
Should only return generic identifiers, not instance identifiers; in other words, every member of the array should be the result of a call to csHandlerRegistry::GetGenericID("name"), where "name" may be some class's static GenericString() function or a literal string.<p>
This should also be a "virtual static" function, but C++ doesn't have them. 
<p>Implements <a class="el" href="structiEventHandler.html#c0e742aaaf86a619966bd30c0751e94d">iEventHandler</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>