<!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::MouseInput 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_1MouseInput.html">MouseInput</a></div>
<h1>gcn::MouseInput Class Reference</h1><!-- doxytag: class="gcn::MouseInput" --><code>#include <<a class="el" href="mouseinput_8hpp-source.html">mouseinput.hpp</a>></code>
<p>
<a href="classgcn_1_1MouseInput-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Internal class representing mouse input.
<p>
Generally you won't have to bother using this class.
<p>
<p>
Definition at line <a class="el" href="mouseinput_8hpp-source.html#l00069">69</a> of file <a class="el" href="mouseinput_8hpp-source.html">mouseinput.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="18b649cafc2cd7f477f6369e4d5d87e8e6ceadb0fda5de4b8033efef9f0add94"></a><!-- doxytag: member="gcn::MouseInput::EMPTY" ref="18b649cafc2cd7f477f6369e4d5d87e8e6ceadb0fda5de4b8033efef9f0add94" 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="18b649cafc2cd7f477f6369e4d5d87e8a379760adec67c5377530a1d6591234e"></a><!-- doxytag: member="gcn::MouseInput::LEFT" ref="18b649cafc2cd7f477f6369e4d5d87e8a379760adec67c5377530a1d6591234e" args="" -->
</td><td class="memItemRight" valign="bottom"><b>LEFT</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18b649cafc2cd7f477f6369e4d5d87e850a582eb8abc4c43e1d95b92562e6348"></a><!-- doxytag: member="gcn::MouseInput::RIGHT" ref="18b649cafc2cd7f477f6369e4d5d87e850a582eb8abc4c43e1d95b92562e6348" args="" -->
</td><td class="memItemRight" valign="bottom"><b>RIGHT</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18b649cafc2cd7f477f6369e4d5d87e87f45454042c7c743966c517571c6e528"></a><!-- doxytag: member="gcn::MouseInput::MIDDLE" ref="18b649cafc2cd7f477f6369e4d5d87e87f45454042c7c743966c517571c6e528" args="" -->
</td><td class="memItemRight" valign="bottom"><b>MIDDLE</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18b649cafc2cd7f477f6369e4d5d87e8088699017c9961b375c4c95f6d684ded"></a><!-- doxytag: member="gcn::MouseInput::WHEEL_UP" ref="18b649cafc2cd7f477f6369e4d5d87e8088699017c9961b375c4c95f6d684ded" args="" -->
</td><td class="memItemRight" valign="bottom"><b>WHEEL_UP</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18b649cafc2cd7f477f6369e4d5d87e84ff78dc474dda8ad387a7d900801cb1b"></a><!-- doxytag: member="gcn::MouseInput::WHEEL_DOWN" ref="18b649cafc2cd7f477f6369e4d5d87e84ff78dc474dda8ad387a7d900801cb1b" args="" -->
</td><td class="memItemRight" valign="bottom"><b>WHEEL_DOWN</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18b649cafc2cd7f477f6369e4d5d87e8a0cc731c1233a57000d70e453e1931f1"></a><!-- doxytag: member="gcn::MouseInput::PRESS" ref="18b649cafc2cd7f477f6369e4d5d87e8a0cc731c1233a57000d70e453e1931f1" 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="18b649cafc2cd7f477f6369e4d5d87e8d423b81a062eb493ea398170343a56a0"></a><!-- doxytag: member="gcn::MouseInput::RELEASE" ref="18b649cafc2cd7f477f6369e4d5d87e8d423b81a062eb493ea398170343a56a0" args="" -->
</td><td class="memItemRight" valign="bottom"><b>RELEASE</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18b649cafc2cd7f477f6369e4d5d87e82b509e6a42dda4df8af249fe16573ec7"></a><!-- doxytag: member="gcn::MouseInput::MOTION" ref="18b649cafc2cd7f477f6369e4d5d87e82b509e6a42dda4df8af249fe16573ec7" args="" -->
</td><td class="memItemRight" valign="bottom"><b>MOTION</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom">{ <br>
<b>EMPTY</b> = 0,
<b>LEFT</b>,
<b>RIGHT</b>,
<b>MIDDLE</b>,
<br>
<b>WHEEL_UP</b>,
<b>WHEEL_DOWN</b>,
<b>PRESS</b>,
<b>RELEASE</b>,
<br>
<b>MOTION</b>
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enum with mouse 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="7d53c0ea03ef800ff495fa7c4987527b"></a><!-- doxytag: member="gcn::MouseInput::MouseInput" ref="7d53c0ea03ef800ff495fa7c4987527b" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcn_1_1MouseInput.html#7d53c0ea03ef800ff495fa7c4987527b">MouseInput</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_1MouseInput.html#112346714b245dc11b410c9a9a5aa471">MouseInput</a> (int button, int type, int mousex, int mousey, int timeStamp)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#112346714b245dc11b410c9a9a5aa471"></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_1MouseInput.html#4af0cd6e991923a5a5668af53e1e7de0">setType</a> (int type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the input type. <a href="#4af0cd6e991923a5a5668af53e1e7de0"></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_1MouseInput.html#08849c13d9acb1f5591cc581beb88000">getType</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the input type. <a href="#08849c13d9acb1f5591cc581beb88000"></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_1MouseInput.html#ed9e1539183631792096bab8ae8f79f9">setButton</a> (int button)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the button pressed. <a href="#ed9e1539183631792096bab8ae8f79f9"></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_1MouseInput.html#6c0db10fc1661866046a56e26b1e8c81">getButton</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the button pressed. <a href="#6c0db10fc1661866046a56e26b1e8c81"></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_1MouseInput.html#8df252aae7be9e9e889ff8001cd460d5">setTimeStamp</a> (int timeStamp)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the timestamp for the input. <a href="#8df252aae7be9e9e889ff8001cd460d5"></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_1MouseInput.html#42469bb60341bbf318105b475fe10190">getTimeStamp</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the time stamp of the input. <a href="#42469bb60341bbf318105b475fe10190"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="352169876e97cfc87c995ca2c820416f"></a><!-- doxytag: member="gcn::MouseInput::x" ref="352169876e97cfc87c995ca2c820416f" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcn_1_1MouseInput.html#352169876e97cfc87c995ca2c820416f">x</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="25b89a8be34df20d759f2a6a8405ef1d"></a><!-- doxytag: member="gcn::MouseInput::y" ref="25b89a8be34df20d759f2a6a8405ef1d" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcn_1_1MouseInput.html#25b89a8be34df20d759f2a6a8405ef1d">y</a></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="26cf7529115d8b6a9966486a1ae4a58f"></a><!-- doxytag: member="gcn::MouseInput::mType" ref="26cf7529115d8b6a9966486a1ae4a58f" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcn_1_1MouseInput.html#26cf7529115d8b6a9966486a1ae4a58f">mType</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1d2b4430f69df5d6d75d12f810e3c1a6"></a><!-- doxytag: member="gcn::MouseInput::mButton" ref="1d2b4430f69df5d6d75d12f810e3c1a6" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcn_1_1MouseInput.html#1d2b4430f69df5d6d75d12f810e3c1a6">mButton</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="777eb4b93d70253f12da5bc36dffa409"></a><!-- doxytag: member="gcn::MouseInput::mTimeStamp" ref="777eb4b93d70253f12da5bc36dffa409" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcn_1_1MouseInput.html#777eb4b93d70253f12da5bc36dffa409">mTimeStamp</a></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="112346714b245dc11b410c9a9a5aa471"></a><!-- doxytag: member="gcn::MouseInput::MouseInput" ref="112346714b245dc11b410c9a9a5aa471" args="(int button, int type, int mousex, int mousey, int timeStamp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcn::MouseInput::MouseInput </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>button</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>mousex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>mousey</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>timeStamp</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>button</em> </td><td>the button pressed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>the type of input. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mousex</em> </td><td>the mouse x coordinate. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mousey</em> </td><td>the mouse y coordinate. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeStamp</em> </td><td>the mouse inputs time stamp. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="mouseinput_8cpp-source.html#l00065">65</a> of file <a class="el" href="mouseinput_8cpp-source.html">mouseinput.cpp</a>.
<p>
References <a class="el" href="mouseinput_8hpp-source.html#l00151">mButton</a>, <a class="el" href="mouseinput_8hpp-source.html#l00152">mTimeStamp</a>, <a class="el" href="mouseinput_8hpp-source.html#l00150">mType</a>, <a class="el" href="mouseinput_8hpp-source.html#l00147">x</a>, and <a class="el" href="mouseinput_8hpp-source.html#l00147">y</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="6c0db10fc1661866046a56e26b1e8c81"></a><!-- doxytag: member="gcn::MouseInput::getButton" ref="6c0db10fc1661866046a56e26b1e8c81" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gcn::MouseInput::getButton </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the button pressed.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>the button pressed. </dd></dl>
<p>
Definition at line <a class="el" href="mouseinput_8cpp-source.html#l00089">89</a> of file <a class="el" href="mouseinput_8cpp-source.html">mouseinput.cpp</a>.
<p>
References <a class="el" href="mouseinput_8hpp-source.html#l00151">mButton</a>.
<p>
Referenced by <a class="el" href="widget_8cpp-source.html#l00361">gcn::Widget::_mouseInputMessage()</a>.
</div>
</div><p>
<a class="anchor" name="42469bb60341bbf318105b475fe10190"></a><!-- doxytag: member="gcn::MouseInput::getTimeStamp" ref="42469bb60341bbf318105b475fe10190" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gcn::MouseInput::getTimeStamp </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the time stamp of the input.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>the time stamp of the input. </dd></dl>
<p>
Definition at line <a class="el" href="mouseinput_8cpp-source.html#l00094">94</a> of file <a class="el" href="mouseinput_8cpp-source.html">mouseinput.cpp</a>.
<p>
References <a class="el" href="mouseinput_8hpp-source.html#l00152">mTimeStamp</a>.
<p>
Referenced by <a class="el" href="widget_8cpp-source.html#l00361">gcn::Widget::_mouseInputMessage()</a>.
</div>
</div><p>
<a class="anchor" name="08849c13d9acb1f5591cc581beb88000"></a><!-- doxytag: member="gcn::MouseInput::getType" ref="08849c13d9acb1f5591cc581beb88000" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gcn::MouseInput::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="mouseinput_8cpp-source.html#l00079">79</a> of file <a class="el" href="mouseinput_8cpp-source.html">mouseinput.cpp</a>.
<p>
References <a class="el" href="mouseinput_8hpp-source.html#l00150">mType</a>.
<p>
Referenced by <a class="el" href="widget_8cpp-source.html#l00361">gcn::Widget::_mouseInputMessage()</a>.
</div>
</div><p>
<a class="anchor" name="ed9e1539183631792096bab8ae8f79f9"></a><!-- doxytag: member="gcn::MouseInput::setButton" ref="ed9e1539183631792096bab8ae8f79f9" args="(int button)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gcn::MouseInput::setButton </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>button</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the button pressed.
<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>button</em> </td><td>the button pressed. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="mouseinput_8cpp-source.html#l00084">84</a> of file <a class="el" href="mouseinput_8cpp-source.html">mouseinput.cpp</a>.
<p>
References <a class="el" href="mouseinput_8hpp-source.html#l00151">mButton</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#l00163">gcn::GLUTInput::pushMotionInput()</a>, and <a class="el" href="glutinput_8cpp-source.html#l00144">gcn::GLUTInput::pushMouseInput()</a>.
</div>
</div><p>
<a class="anchor" name="8df252aae7be9e9e889ff8001cd460d5"></a><!-- doxytag: member="gcn::MouseInput::setTimeStamp" ref="8df252aae7be9e9e889ff8001cd460d5" args="(int timeStamp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gcn::MouseInput::setTimeStamp </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>timeStamp</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the timestamp for the input.
<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>timeStamp</em> </td><td>the timestamp of the input. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="mouseinput_8cpp-source.html#l00099">99</a> of file <a class="el" href="mouseinput_8cpp-source.html">mouseinput.cpp</a>.
<p>
References <a class="el" href="mouseinput_8hpp-source.html#l00152">mTimeStamp</a>.
<p>
Referenced by <a class="el" href="sdlinput_8cpp-source.html#l00113">gcn::SDLInput::pushInput()</a>.
</div>
</div><p>
<a class="anchor" name="4af0cd6e991923a5a5668af53e1e7de0"></a><!-- doxytag: member="gcn::MouseInput::setType" ref="4af0cd6e991923a5a5668af53e1e7de0" args="(int type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gcn::MouseInput::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="mouseinput_8cpp-source.html#l00074">74</a> of file <a class="el" href="mouseinput_8cpp-source.html">mouseinput.cpp</a>.
<p>
References <a class="el" href="mouseinput_8hpp-source.html#l00150">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#l00163">gcn::GLUTInput::pushMotionInput()</a>, and <a class="el" href="glutinput_8cpp-source.html#l00144">gcn::GLUTInput::pushMouseInput()</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="mouseinput_8hpp-source.html">mouseinput.hpp</a><li><a class="el" href="mouseinput_8cpp-source.html">mouseinput.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>
