Sophie

Sophie

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

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: csutil/csevcord.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>csutil/csevcord.h</h1><a href="csevcord_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) 2000 by Jorrit Tyberghein</span>
<a name="l00003"></a>00003 <span class="comment">    Written by Michael Dale Long.</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment">    This library is free software; you can redistribute it and/or</span>
<a name="l00006"></a>00006 <span class="comment">    modify it under the terms of the GNU Library General Public</span>
<a name="l00007"></a>00007 <span class="comment">    License as published by the Free Software Foundation; either</span>
<a name="l00008"></a>00008 <span class="comment">    version 2 of the License, or (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment">    This library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00013"></a>00013 <span class="comment">    Library General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment">    You should have received a copy of the GNU Library General Public</span>
<a name="l00016"></a>00016 <span class="comment">    License along with this library; if not, write to the Free</span>
<a name="l00017"></a>00017 <span class="comment">    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00018"></a>00018 <span class="comment">*/</span>
<a name="l00019"></a>00019 
<a name="l00020"></a>00020 <span class="preprocessor">#ifndef __CS_CSEVCORD_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __CS_CSEVCORD_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "csextern.h"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="scf__implementation_8h.html" title="Crystal Space Shared Class Facility (SCF) - implementation creation support.">csutil/scf_implementation.h</a>"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="iutil_2event_8h.html" title="Event system related interfaces.">iutil/event.h</a>"</span>
<a name="l00030"></a>00030 
<a name="l00031"></a>00031 <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="l00032"></a>00032 
<a name="l00033"></a>00033 <span class="keyword">class </span><a class="code" href="classcsEventOutlet.html" title="A class which implements the iEventOutlet interface.">csEventOutlet</a>;
<a name="l00034"></a>00034 
<a name="l00038"></a><a class="code" href="classcsEventCord.html">00038</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsEventCord.html" title="Event cord.">csEventCord</a> : 
<a name="l00039"></a>00039   <span class="keyword">public</span> <a class="code" href="classscfImplementation1.html">scfImplementation1</a>&lt;csEventCord, iEventCord&gt;
<a name="l00040"></a>00040 {
<a name="l00041"></a>00041 <span class="keyword">protected</span>:
<a name="l00043"></a><a class="code" href="classcsEventCord.html#ec904cad6d38ee27b97bddcd5f00e1b2">00043</a>   <span class="keyword">volatile</span> <span class="keywordtype">bool</span> pass;
<a name="l00044"></a>00044 
<a name="l00046"></a><a class="code" href="classcsEventCord.html#d56c1e777685849b7d7fd248b41861f8">00046</a>   <a class="code" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757" title="A csEventID is a handle for a string representing an event&amp;#39;s hierarchical name...">csEventID</a> name;
<a name="l00047"></a>00047 
<a name="l00051"></a><a class="code" href="structcsEventCord_1_1PluginData.html">00051</a>   <span class="keyword">struct </span><a class="code" href="structcsEventCord_1_1PluginData.html">PluginData</a>
<a name="l00052"></a>00052   {
<a name="l00053"></a><a class="code" href="structcsEventCord_1_1PluginData.html#70986a5af686074cbae961023fcaa03c">00053</a>     <a class="code" href="structiEventHandler.html" title="This interface describes an entity that can receive events.">iEventHandler</a> *plugin;
<a name="l00054"></a><a class="code" href="structcsEventCord_1_1PluginData.html#f5555869d8571beb0ea8a0a35b3df3e1">00054</a>     <span class="keywordtype">int</span> priority;
<a name="l00055"></a><a class="code" href="structcsEventCord_1_1PluginData.html#b9889440fa5c954d4343b6029e5fe63f">00055</a>     <a class="code" href="structcsEventCord_1_1PluginData.html">PluginData</a> *next;
<a name="l00056"></a>00056   };
<a name="l00057"></a>00057 
<a name="l00059"></a><a class="code" href="classcsEventCord.html#0f02c59ad3bfe5e8ec726a6ad7a60103">00059</a>   <a class="code" href="structcsEventCord_1_1PluginData.html">PluginData</a> *plugins;
<a name="l00060"></a>00060 
<a name="l00062"></a><a class="code" href="classcsEventCord.html#25bf295a14f5006871c151d27b259557">00062</a>   <span class="keyword">volatile</span> <span class="keywordtype">int</span> SpinLock;
<a name="l00063"></a>00063 
<a name="l00065"></a><a class="code" href="classcsEventCord.html#d67209c7766361f44b4192a862e6eb97">00065</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> Lock() { <span class="keywordflow">while</span> (SpinLock) {} SpinLock++; }
<a name="l00067"></a><a class="code" href="classcsEventCord.html#2357d7434c0435fc222d5e80ac82995a">00067</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> Unlock() { SpinLock--; }
<a name="l00068"></a>00068 
<a name="l00070"></a><a class="code" href="classcsEventCord.html#045c4aa8c93411d96adb6374223fca27">00070</a>   <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classcsEventOutlet.html" title="A class which implements the iEventOutlet interface.">csEventOutlet</a>;
<a name="l00071"></a>00071   <span class="keywordtype">bool</span> <a class="code" href="classcsEventOutlet.html#6ebe91fea284f9f69ad4cb76e9ba0ddb" title="Put a previously created event into system event queue.">Post</a>(<a class="code" href="structiEvent.html" title="This interface describes any system event.">iEvent</a>*);
<a name="l00072"></a>00072 
<a name="l00073"></a>00073 <span class="keyword">public</span>:
<a name="l00075"></a>00075   <a class="code" href="classcsEventCord.html" title="Event cord.">csEventCord</a>(<a class="code" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757" title="A csEventID is a handle for a string representing an event&amp;#39;s hierarchical name...">csEventID</a>, <span class="keywordtype">bool</span>=<span class="keyword">false</span>);
<a name="l00076"></a>00076 
<a name="l00078"></a>00078   <span class="keyword">virtual</span> ~<a class="code" href="classcsEventCord.html" title="Event cord.">csEventCord</a>();
<a name="l00079"></a>00079 
<a name="l00081"></a>00081   <span class="keyword">virtual</span> <span class="keywordtype">int</span> Insert(<a class="code" href="structiEventHandler.html" title="This interface describes an entity that can receive events.">iEventHandler</a>*, <span class="keywordtype">int</span> priority);
<a name="l00082"></a>00082 
<a name="l00084"></a>00084   <span class="keyword">virtual</span> <span class="keywordtype">void</span> Remove(<a class="code" href="structiEventHandler.html" title="This interface describes an entity that can receive events.">iEventHandler</a>*);
<a name="l00085"></a>00085 
<a name="l00087"></a><a class="code" href="classcsEventCord.html#f463343c4c1c448a478a78d346a4d299">00087</a>   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> GetPass()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> pass; }
<a name="l00088"></a>00088 
<a name="l00090"></a><a class="code" href="classcsEventCord.html#fda1234510fca4c05b997e30ad5caec2">00090</a>   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetPass(<span class="keywordtype">bool</span> flag) { pass = flag; }
<a name="l00091"></a>00091 
<a name="l00093"></a><a class="code" href="classcsEventCord.html#2758ff7252a1026ee4e5f71149b3b357">00093</a>   <span class="keyword">virtual</span> <a class="code" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757" title="A csEventID is a handle for a string representing an event&amp;#39;s hierarchical name...">csEventID</a> GetName()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> name; }
<a name="l00094"></a>00094 };
<a name="l00095"></a>00095 
<a name="l00096"></a>00096 <span class="preprocessor">#endif // __CS_CSEVCORD_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>