Sophie

Sophie

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

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/binder.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/binder.h</h1><a href="csutil_2binder_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) 2003, 04 by Mathew Sutcliffe &lt;oktal@gmx.co.uk&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_UTIL_BINDER_H__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_UTIL_BINDER_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "csextern.h"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="csutil_2array_8h.html" title="Generic Array Template.">csutil/array.h</a>"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="hash_8h.html" title="A generic hash table.">csutil/hash.h</a>"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="inputdef_8h.html" title="Crystal Space input library.">csutil/inputdef.h</a>"</span>
<a name="l00030"></a>00030 <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="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="iutil_2binder_8h.html" title="Input binder interface.">iutil/binder.h</a>"</span>
<a name="l00032"></a>00032 <span class="preprocessor">#include "<a class="code" href="evdefs_8h.html" title="Event system related interfaces.">iutil/evdefs.h</a>"</span>
<a name="l00033"></a>00033 <span class="preprocessor">#include "<a class="code" href="iutil_2event_8h.html" title="Event system related interfaces.">iutil/event.h</a>"</span>
<a name="l00034"></a>00034 <span class="preprocessor">#include "<a class="code" href="eventh_8h.html" title="Event handler interface.">iutil/eventh.h</a>"</span>
<a name="l00035"></a>00035 
<a name="l00057"></a><a class="code" href="classcsInputBinder.html">00057</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsInputBinder.html" title="Use this class to bind input events (keypress, button press, mouse move, etc.">csInputBinder</a> :
<a name="l00058"></a>00058   <span class="keyword">public</span> <a class="code" href="classscfImplementation2.html">scfImplementation2</a>&lt;csInputBinder, iInputBinder, iEventHandler&gt;
<a name="l00059"></a>00059 {
<a name="l00060"></a>00060     <a class="code" href="group__event__handling.html#g4f7b2a21cfb5997a2bb258920fafc61f" title="Macro to create default GenericName and GenericName methods.">CS_EVENTHANDLER_NAMES</a>(<span class="stringliteral">"crystalspace.inputbinder"</span>)
<a name="l00061"></a>00061     <a class="code" href="group__event__handling.html#gfa413bca2b161c7d43cb38f46ec73a7b" title="Macro to create &amp;quot;nil&amp;quot; generic and instance constraints.">CS_EVENTHANDLER_NIL_CONSTRAINTS</a>
<a name="l00062"></a>00062 
<a name="l00063"></a>00063   <a class="code" href="structiObjectRegistry.html" title="This interface serves as a registry of other objects.">iObjectRegistry</a> *object_reg;
<a name="l00064"></a>00064   <a class="code" href="classcsRef.html" title="A smart pointer.">csRef&lt;iEventNameRegistry&gt;</a> name_reg;
<a name="l00065"></a>00065   <span class="keyword">struct </span>AxisCmd
<a name="l00066"></a>00066   {
<a name="l00067"></a>00067     <span class="keywordtype">unsigned</span> cmd;
<a name="l00068"></a>00068     <span class="keywordtype">int</span> val, sens;
<a name="l00069"></a>00069     <span class="keywordtype">bool</span> wrap;
<a name="l00070"></a>00070     AxisCmd (<span class="keywordtype">unsigned</span> cmd0, <span class="keywordtype">int</span> sens0)
<a name="l00071"></a>00071     : cmd (cmd0), val (0), sens (sens0) {}
<a name="l00072"></a>00072   };
<a name="l00073"></a>00073   <span class="keyword">typedef</span> <a class="code" href="classcsHash.html" title="A generic hash table class, which grows dynamically and whose buckets are unsorted...">csHash&lt;AxisCmd *, csInputDefinition&gt;</a> <a class="code" href="classcsHash.html" title="A generic hash table class, which grows dynamically and whose buckets are unsorted...">AxisHash</a>;
<a name="l00074"></a>00074   <a class="code" href="classcsHash.html" title="A generic hash table class, which grows dynamically and whose buckets are unsorted...">AxisHash</a> axisHash;
<a name="l00075"></a>00075   <a class="code" href="classcsArray.html" title="A templated array class.">csArray&lt;AxisCmd *&gt;</a> axisArray;
<a name="l00076"></a>00076 
<a name="l00077"></a>00077   <span class="keyword">struct </span>BtnCmd
<a name="l00078"></a>00078   {
<a name="l00079"></a>00079     <span class="keywordtype">unsigned</span> cmd;
<a name="l00080"></a>00080     <span class="keywordtype">bool</span> down, toggle;
<a name="l00081"></a>00081     BtnCmd (<span class="keywordtype">unsigned</span> cmd0, <span class="keywordtype">bool</span> toggle0)
<a name="l00082"></a>00082     : cmd (cmd0), down (<span class="keyword">false</span>), toggle (toggle0) {}
<a name="l00083"></a>00083   };
<a name="l00084"></a>00084   <span class="keyword">typedef</span> <a class="code" href="classcsHash.html" title="A generic hash table class, which grows dynamically and whose buckets are unsorted...">csHash&lt;BtnCmd *, csInputDefinition&gt;</a> <a class="code" href="classcsHash.html" title="A generic hash table class, which grows dynamically and whose buckets are unsorted...">BtnHash</a>;
<a name="l00085"></a>00085   <a class="code" href="classcsHash.html" title="A generic hash table class, which grows dynamically and whose buckets are unsorted...">BtnHash</a> btnHash;
<a name="l00086"></a>00086   <a class="code" href="classcsArray.html" title="A templated array class.">csArray&lt;BtnCmd *&gt;</a> btnArray;
<a name="l00087"></a>00087 
<a name="l00088"></a>00088 <span class="keyword">protected</span>:
<a name="l00089"></a>00089   <span class="keywordtype">bool</span> HandleEvent (<a class="code" href="structiEvent.html" title="This interface describes any system event.">iEvent</a>&amp;);
<a name="l00090"></a>00090 
<a name="l00091"></a>00091 <span class="keyword">public</span>:
<a name="l00092"></a>00092 
<a name="l00097"></a>00097   <a class="code" href="classcsInputBinder.html" title="Use this class to bind input events (keypress, button press, mouse move, etc.">csInputBinder</a> (<a class="code" href="structiObjectRegistry.html" title="This interface serves as a registry of other objects.">iObjectRegistry</a> *, <a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a> *parent = 0, <span class="keywordtype">int</span> btnSize = 127, <span class="keywordtype">int</span> axisSize = 13);
<a name="l00098"></a>00098   <span class="keyword">virtual</span> ~<a class="code" href="classcsInputBinder.html" title="Use this class to bind input events (keypress, button press, mouse move, etc.">csInputBinder</a> ();
<a name="l00099"></a>00099 
<a name="l00100"></a><a class="code" href="classcsInputBinder.html#ea9c59b1df9fb94c1b52e98fedb96e36">00100</a>   <span class="keyword">virtual</span> <a class="code" href="structiEventHandler.html" title="This interface describes an entity that can receive events.">iEventHandler</a>* QueryHandler () { <span class="keywordflow">return</span> <span class="keyword">this</span>; }
<a name="l00101"></a>00101 
<a name="l00102"></a>00102   <span class="keyword">virtual</span> <span class="keywordtype">int</span> Axis (<span class="keywordtype">unsigned</span> cmd);
<a name="l00103"></a>00103   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Button (<span class="keywordtype">unsigned</span> cmd);
<a name="l00104"></a>00104 
<a name="l00105"></a>00105   <span class="keyword">virtual</span> <span class="keywordtype">void</span> BindButton (<a class="code" href="classcsInputDefinition.html" title="This class holds a description of a physical source of input events, such as a keyboard...">csInputDefinition</a> <span class="keyword">const</span>&amp; def, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> cmd,
<a name="l00106"></a>00106     <span class="keywordtype">bool</span> toggle = <span class="keyword">false</span>);
<a name="l00107"></a>00107   <span class="keyword">virtual</span> <span class="keywordtype">void</span> BindAxis (<a class="code" href="classcsInputDefinition.html" title="This class holds a description of a physical source of input events, such as a keyboard...">csInputDefinition</a> <span class="keyword">const</span>&amp; def, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> cmd,
<a name="l00108"></a>00108     <span class="keywordtype">int</span> sensitivity = 1);
<a name="l00109"></a>00109 
<a name="l00110"></a>00110   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> UnbindAxis (<span class="keywordtype">unsigned</span> cmd);
<a name="l00111"></a>00111   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> UnbindButton (<span class="keywordtype">unsigned</span> cmd);
<a name="l00112"></a>00112   <span class="keyword">virtual</span> <span class="keywordtype">void</span> UnbindAll ();
<a name="l00113"></a>00113 
<a name="l00114"></a>00114   <span class="keyword">virtual</span> <span class="keywordtype">void</span> LoadConfig (<a class="code" href="structiConfigFile.html" title="Configuration file interface.">iConfigFile</a> *, <span class="keyword">const</span> <span class="keywordtype">char</span> *subsection);
<a name="l00115"></a>00115   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SaveConfig (<a class="code" href="structiConfigFile.html" title="Configuration file interface.">iConfigFile</a> *, <span class="keyword">const</span> <span class="keywordtype">char</span> *subsection);
<a name="l00116"></a>00116 };
<a name="l00117"></a>00117 
<a name="l00118"></a>00118 <span class="preprocessor">#endif // __CS_UTIL_BINDER_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