<!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: csInputEventHelper 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 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 Pages</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="classes.html"><span>Alphabetical List</span></a></li> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <h1>csInputEventHelper Class Reference<br> <small> [<a class="el" href="group__event__handling.html">Event handling</a>]</small> </h1><!-- doxytag: class="csInputEventHelper" -->Helper class to conveniently pull generic data out of input events. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="csutil_2event_8h-source.html">csutil/event.h</a>></code> <p> <p> <a href="classcsInputEventHelper-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsInputEventHelper.html#794dd676ba79db899fca7e91f0e452c7">GetButton</a> (<a class="el" href="structiEventNameRegistry.html">iEventNameRegistry</a> *, const <a class="el" href="structiEvent.html">iEvent</a> *event)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve button number (0 on error or if keyboard event). <a href="#794dd676ba79db899fca7e91f0e452c7"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsInputEventHelper.html#c49c48792d109c07c25691c7c84f53d5">GetButtonState</a> (<a class="el" href="structiEventNameRegistry.html">iEventNameRegistry</a> *, const <a class="el" href="structiEvent.html">iEvent</a> *event)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve button/key state (true = press, false = release). <a href="#c49c48792d109c07c25691c7c84f53d5"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Helper class to conveniently pull generic data out of input events. <p>Definition at line <a class="el" href="csutil_2event_8h-source.html#l00200">200</a> of file <a class="el" href="csutil_2event_8h-source.html">event.h</a>.</p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="794dd676ba79db899fca7e91f0e452c7"></a><!-- doxytag: member="csInputEventHelper::GetButton" ref="794dd676ba79db899fca7e91f0e452c7" args="(iEventNameRegistry *, const iEvent *event)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> csInputEventHelper::GetButton </td> <td>(</td> <td class="paramtype"><a class="el" href="structiEventNameRegistry.html">iEventNameRegistry</a> * </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="structiEvent.html">iEvent</a> * </td> <td class="paramname"> <em>event</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Retrieve button number (0 on error or if keyboard event). <p> </div> </div><p> <a class="anchor" name="c49c48792d109c07c25691c7c84f53d5"></a><!-- doxytag: member="csInputEventHelper::GetButtonState" ref="c49c48792d109c07c25691c7c84f53d5" args="(iEventNameRegistry *, const iEvent *event)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static bool csInputEventHelper::GetButtonState </td> <td>(</td> <td class="paramtype"><a class="el" href="structiEventNameRegistry.html">iEventNameRegistry</a> * </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="structiEvent.html">iEvent</a> * </td> <td class="paramname"> <em>event</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Retrieve button/key state (true = press, false = release). <p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li>csutil/<a class="el" href="csutil_2event_8h-source.html">event.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>