<!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/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 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 Pages</span></a></li> </ul> </div> <h1>iutil/binder.h</h1><a href="iutil_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 <oktal@gmx.co.uk></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_BINDER_H__</span> <a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_IUTIL_BINDER_H__</span> <a name="l00021"></a>00021 <span class="preprocessor"></span> <a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="scf__interface_8h.html" title="Crystal Space Shared Class Facility (SCF) - interface creation support.">csutil/scf_interface.h</a>"</span> <a name="l00027"></a>00027 <a name="l00028"></a>00028 <span class="keyword">struct </span><a class="code" href="structiEvent.html" title="This interface describes any system event.">iEvent</a>; <a name="l00029"></a>00029 <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="l00030"></a>00030 <span class="keyword">struct </span><a class="code" href="structiConfigFile.html" title="Configuration file interface.">iConfigFile</a>; <a name="l00031"></a>00031 <span class="keyword">class </span><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>; <a name="l00032"></a>00032 <a name="l00055"></a><a class="code" href="structiInputBinder.html">00055</a> <span class="keyword">struct </span><a class="code" href="structiInputBinder.html" title="SCF interface for csInputBinder, used to bind input events (keypress, button press...">iInputBinder</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="l00056"></a>00056 { <a name="l00057"></a>00057 SCF_INTERFACE(<a class="code" href="structiInputBinder.html" title="SCF interface for csInputBinder, used to bind input events (keypress, button press...">iInputBinder</a>, 2,0,0); <a name="l00064"></a>00064 <span class="keyword">virtual</span> <a class="code" href="structiEventHandler.html" title="This interface describes an entity that can receive events.">iEventHandler</a>* <a class="code" href="structiInputBinder.html#c03ddf7eb4385e967bec294d3a9c4d5c" title="Get a pointer to the embedded iEventHander.">QueryHandler</a> () = 0; <a name="l00065"></a>00065 <a name="l00067"></a>00067 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiInputBinder.html#82ea6bef5f334831c251fb455131665a" title="Returns the status of the given button command.">Button</a> (<span class="keywordtype">unsigned</span> cmd) = 0; <a name="l00068"></a>00068 <a name="l00070"></a>00070 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiInputBinder.html#f9c22268b61b357eb2982e8e2d163908" title="Returns the position of the given axis command.">Axis</a> (<span class="keywordtype">unsigned</span> cmd) = 0; <a name="l00071"></a>00071 <a name="l00085"></a>00085 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiInputBinder.html#88e6c7239906339309cd0c7eab82c47f" title="Bind a button event to a button command.">BindButton</a> (<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>& def, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> cmd, <a name="l00086"></a>00086 <span class="keywordtype">bool</span> toggle = <span class="keyword">false</span>) = 0; <a name="l00087"></a>00087 <a name="l00096"></a>00096 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiInputBinder.html#a7649345d9af9eca913ac1cb7e275fea" title="Bind an axis motion event to an axis command.">BindAxis</a> (<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>& def, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> cmd, <a name="l00097"></a>00097 <span class="keywordtype">int</span> sensitivity = 1) = 0; <a name="l00098"></a>00098 <a name="l00100"></a>00100 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiInputBinder.html#18e8e97320f442b0fdfa60e3b2c051cf" title="Remove a binding.">UnbindButton</a> (<span class="keywordtype">unsigned</span> cmd) = 0; <a name="l00101"></a>00101 <a name="l00103"></a>00103 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiInputBinder.html#5ade82463225ad4f90f25b7278f11074" title="Remove a binding.">UnbindAxis</a> (<span class="keywordtype">unsigned</span> cmd) = 0; <a name="l00104"></a>00104 <a name="l00106"></a>00106 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiInputBinder.html#2ec10a42410f088450765b7a8eb704f5" title="Remove all bindings.">UnbindAll</a>() = 0; <a name="l00107"></a>00107 <a name="l00109"></a>00109 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiInputBinder.html#c6e225b0c0b881ac98ad88d263b576b0" title="Load bindings from a configuration file.">LoadConfig</a> (<a class="code" href="structiConfigFile.html" title="Configuration file interface.">iConfigFile</a> *, <span class="keyword">const</span> <span class="keywordtype">char</span> *subsection = 0) = 0; <a name="l00110"></a>00110 <a name="l00112"></a>00112 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiInputBinder.html#2e7ad6cdbc829f380e9ab57b944e334f" title="Save bindings to a configuration file.">SaveConfig</a> (<a class="code" href="structiConfigFile.html" title="Configuration file interface.">iConfigFile</a> *, <span class="keyword">const</span> <span class="keywordtype">char</span> *subsection = 0) = 0; <a name="l00113"></a>00113 }; <a name="l00114"></a>00114 <a name="l00115"></a>00115 <span class="preprocessor">#endif // __CS_IUTIL_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>