<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Guichan: gcn::KeyInput Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<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>
<div class="nav">
<a class="el" href="namespacegcn.html">gcn</a>::<a class="el" href="classgcn_1_1KeyInput.html">KeyInput</a></div>
<h1>gcn::KeyInput Class Reference</h1><!-- doxytag: class="gcn::KeyInput" --><code>#include <<a class="el" href="keyinput_8hpp-source.html">keyinput.hpp</a>></code>
<p>
<a href="classgcn_1_1KeyInput-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Internal class representing keyboard input.
<p>
Generally you won't have to bother using this class.
<p>
<p>
Definition at line <a class="el" href="keyinput_8hpp-source.html#l00069">69</a> of file <a class="el" href="keyinput_8hpp-source.html">keyinput.hpp</a>.<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f4f7c6649901c27373b32f778dd83de849ba1eef40dd0bbe0a0c9c7af513ba50"></a><!-- doxytag: member="gcn::KeyInput::EMPTY" ref="f4f7c6649901c27373b32f778dd83de849ba1eef40dd0bbe0a0c9c7af513ba50" args="" -->
</td><td class="memItemRight" valign="bottom"><b>EMPTY</b> = 0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f4f7c6649901c27373b32f778dd83de8bb1d2e741d75e2d5d4735c37a7f076d4"></a><!-- doxytag: member="gcn::KeyInput::PRESS" ref="f4f7c6649901c27373b32f778dd83de8bb1d2e741d75e2d5d4735c37a7f076d4" args="" -->
</td><td class="memItemRight" valign="bottom"><b>PRESS</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f4f7c6649901c27373b32f778dd83de8700c6255b1e80c8c8ed047db327d9990"></a><!-- doxytag: member="gcn::KeyInput::RELEASE" ref="f4f7c6649901c27373b32f778dd83de8700c6255b1e80c8c8ed047db327d9990" args="" -->
</td><td class="memItemRight" valign="bottom"><b>RELEASE</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom">{ <b>EMPTY</b> = 0,
<b>PRESS</b>,
<b>RELEASE</b>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enum with key input values. <br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d12092919d399e0af37fbe5714194b52"></a><!-- doxytag: member="gcn::KeyInput::KeyInput" ref="d12092919d399e0af37fbe5714194b52" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcn_1_1KeyInput.html#d12092919d399e0af37fbe5714194b52">KeyInput</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcn_1_1KeyInput.html#3442659a42ade002061c884f6d6ea87e">KeyInput</a> (const <a class="el" href="classgcn_1_1Key.html">Key</a> &key, int type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#3442659a42ade002061c884f6d6ea87e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcn_1_1KeyInput.html#033ce31e4941b269efa9dca27c186b16">setType</a> (int type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the input type. <a href="#033ce31e4941b269efa9dca27c186b16"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcn_1_1KeyInput.html#cbb9c0d8aae09728c39e1c453cd4002e">getType</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the input type. <a href="#cbb9c0d8aae09728c39e1c453cd4002e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcn_1_1KeyInput.html#889fa8c1075b3e7311aca91c21fc69bc">setKey</a> (const <a class="el" href="classgcn_1_1Key.html">Key</a> &key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the key the input concerns. <a href="#889fa8c1075b3e7311aca91c21fc69bc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classgcn_1_1Key.html">Key</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcn_1_1KeyInput.html#5a626e622a953431595ac8c454c64125">getKey</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the key the input concerns. <a href="#5a626e622a953431595ac8c454c64125"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f579abf84cd7919e596812d4dc02a9bc"></a><!-- doxytag: member="gcn::KeyInput::mKey" ref="f579abf84cd7919e596812d4dc02a9bc" args="" -->
<a class="el" href="classgcn_1_1Key.html">Key</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcn_1_1KeyInput.html#f579abf84cd7919e596812d4dc02a9bc">mKey</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a67065f8018e9c7af3790fbe76075290"></a><!-- doxytag: member="gcn::KeyInput::mType" ref="a67065f8018e9c7af3790fbe76075290" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcn_1_1KeyInput.html#a67065f8018e9c7af3790fbe76075290">mType</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="05ae4969d12ae30a5e8cbfefd5e00dd1"></a><!-- doxytag: member="gcn::KeyInput::mButton" ref="05ae4969d12ae30a5e8cbfefd5e00dd1" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcn_1_1KeyInput.html#05ae4969d12ae30a5e8cbfefd5e00dd1">mButton</a></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="3442659a42ade002061c884f6d6ea87e"></a><!-- doxytag: member="gcn::KeyInput::KeyInput" ref="3442659a42ade002061c884f6d6ea87e" args="(const Key &key, int type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcn::KeyInput::KeyInput </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgcn_1_1Key.html">Key</a> & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>type</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>the <a class="el" href="classgcn_1_1Key.html">Key</a> the input concerns. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>the type of input. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="keyinput_8cpp-source.html#l00065">65</a> of file <a class="el" href="keyinput_8cpp-source.html">keyinput.cpp</a>.
<p>
References <a class="el" href="keyinput_8hpp-source.html#l00126">mKey</a>, and <a class="el" href="keyinput_8hpp-source.html#l00127">mType</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="5a626e622a953431595ac8c454c64125"></a><!-- doxytag: member="gcn::KeyInput::getKey" ref="5a626e622a953431595ac8c454c64125" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classgcn_1_1Key.html">Key</a> & gcn::KeyInput::getKey </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the key the input concerns.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>the <a class="el" href="classgcn_1_1Key.html">Key</a> the input concerns. </dd></dl>
<p>
Definition at line <a class="el" href="keyinput_8cpp-source.html#l00086">86</a> of file <a class="el" href="keyinput_8cpp-source.html">keyinput.cpp</a>.
<p>
References <a class="el" href="keyinput_8hpp-source.html#l00126">mKey</a>.
<p>
Referenced by <a class="el" href="widget_8cpp-source.html#l00477">gcn::Widget::_keyInputMessage()</a>.
</div>
</div><p>
<a class="anchor" name="cbb9c0d8aae09728c39e1c453cd4002e"></a><!-- doxytag: member="gcn::KeyInput::getType" ref="cbb9c0d8aae09728c39e1c453cd4002e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gcn::KeyInput::getType </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the input type.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>the input type. </dd></dl>
<p>
Definition at line <a class="el" href="keyinput_8cpp-source.html#l00076">76</a> of file <a class="el" href="keyinput_8cpp-source.html">keyinput.cpp</a>.
<p>
References <a class="el" href="keyinput_8hpp-source.html#l00127">mType</a>.
<p>
Referenced by <a class="el" href="widget_8cpp-source.html#l00477">gcn::Widget::_keyInputMessage()</a>.
</div>
</div><p>
<a class="anchor" name="889fa8c1075b3e7311aca91c21fc69bc"></a><!-- doxytag: member="gcn::KeyInput::setKey" ref="889fa8c1075b3e7311aca91c21fc69bc" args="(const Key &key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gcn::KeyInput::setKey </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgcn_1_1Key.html">Key</a> & </td>
<td class="paramname"> <em>key</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the key the input concerns.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>the <a class="el" href="classgcn_1_1Key.html">Key</a> the input concerns. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="keyinput_8cpp-source.html#l00081">81</a> of file <a class="el" href="keyinput_8cpp-source.html">keyinput.cpp</a>.
<p>
References <a class="el" href="keyinput_8hpp-source.html#l00126">mKey</a>.
<p>
Referenced by <a class="el" href="sdlinput_8cpp-source.html#l00113">gcn::SDLInput::pushInput()</a>, <a class="el" href="glutinput_8cpp-source.html#l00111">gcn::GLUTInput::pushKeyDownInput()</a>, <a class="el" href="glutinput_8cpp-source.html#l00119">gcn::GLUTInput::pushKeyUpInput()</a>, <a class="el" href="glutinput_8cpp-source.html#l00127">gcn::GLUTInput::pushSpecialDownInput()</a>, and <a class="el" href="glutinput_8cpp-source.html#l00136">gcn::GLUTInput::pushSpecialUpInput()</a>.
</div>
</div><p>
<a class="anchor" name="033ce31e4941b269efa9dca27c186b16"></a><!-- doxytag: member="gcn::KeyInput::setType" ref="033ce31e4941b269efa9dca27c186b16" args="(int type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gcn::KeyInput::setType </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>type</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the input type.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>the type of input. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="keyinput_8cpp-source.html#l00071">71</a> of file <a class="el" href="keyinput_8cpp-source.html">keyinput.cpp</a>.
<p>
References <a class="el" href="keyinput_8hpp-source.html#l00127">mType</a>.
<p>
Referenced by <a class="el" href="sdlinput_8cpp-source.html#l00113">gcn::SDLInput::pushInput()</a>, <a class="el" href="glutinput_8cpp-source.html#l00111">gcn::GLUTInput::pushKeyDownInput()</a>, <a class="el" href="glutinput_8cpp-source.html#l00119">gcn::GLUTInput::pushKeyUpInput()</a>, <a class="el" href="glutinput_8cpp-source.html#l00127">gcn::GLUTInput::pushSpecialDownInput()</a>, and <a class="el" href="glutinput_8cpp-source.html#l00136">gcn::GLUTInput::pushSpecialUpInput()</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="keyinput_8hpp-source.html">keyinput.hpp</a><li><a class="el" href="keyinput_8cpp-source.html">keyinput.cpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sat Jul 29 19:38:48 2006 for Guichan by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>
