diff options
Diffstat (limited to 'docs/doxygen/nel/structNLMISC_1_1IMouseDevice.html')
| -rw-r--r-- | docs/doxygen/nel/structNLMISC_1_1IMouseDevice.html | 703 |
1 files changed, 703 insertions, 0 deletions
diff --git a/docs/doxygen/nel/structNLMISC_1_1IMouseDevice.html b/docs/doxygen/nel/structNLMISC_1_1IMouseDevice.html new file mode 100644 index 00000000..223292f8 --- /dev/null +++ b/docs/doxygen/nel/structNLMISC_1_1IMouseDevice.html @@ -0,0 +1,703 @@ +<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd"> +<HTML> +<HEAD> + <TITLE>nevrax.org : docs</TITLE> + <LINK REL=stylesheet TYPE="text/css" HREF="http://www.nevrax.org/inc/css/nevrax.css"> + <link href="doxygen.css" rel="stylesheet" type="text/css"> +</HEAD> +<BODY MARGINHEIGHT="0" MARGINWIDTH="0"> + +<!-- uplinks --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A> </TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A> </TD> + </TR> +</TABLE> + +<!-- banner Nevrax --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 WIDTH=100%> + <TR><TD BGCOLOR="#000000" BACKGROUND="http://www.nevrax.org/inc/img/black_banner.jpg"><A HREF="http://www.nevrax.org"><IMG SRC="http://www.nevrax.org/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR> +</TABLE> + +<!-- main table --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 height=100%> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + + <!------ Begin Box ------> + <TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0 cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black> + <FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td colspan=2 bgcolor=#FFFFFF> + <TABLE cellspacing=0 cellpadding=1 border=0> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="Rubrique news"><img width=13 height=15 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-news.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="News">News</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Rubrique mail"><img width=15 height=11 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-mail.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Rubrique docs"><img width=14 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-docs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Documentation">Documentation</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="Rubrique cvs"><img width=13 height=17 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-cvs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="CVS Web">CVS</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Rubrique bugs"><img width=20 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-bugs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Bugtracking">Bugs</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="Rubrique license"><img width=18 height=12 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-gpl.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="License">License</a></td></tr> + </TABLE> + </TD></TR></TABLE></TD></TR></TABLE> + <!------ End Box ------> + + </TD> + <TD WIDTH=15><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD ALIGN=left valign=top><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + +<!-- title --> +<TABLE background="http://www.nevrax.org/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td> +<A HREF="http://www.nevrax.org/docs/"><img src="http://www.nevrax.org/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A> +</td><td><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT=""> +</td></tr></table> + + +<!-- block --> +<TABLE bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="http://www.nevrax.org/inc/img/reddots.gif"></TD> + <TD><B>Documentation</B></TD> + <TD ALIGN=RIGHT> </td> +</tr></table> +<!-- Generated by Doxygen 1.2.14 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindexRef" doxygen="_cgi:http://www.nevrax.org/cgi-bin/nel-search.cgi" href="http://www.nevrax.org/cgi-bin/nel-search.cgi">Search</a> </center> +<hr><h1>NLMISC::IMouseDevice Struct Reference</h1>An interface to a low level mouse device. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="mouse__device_8h-source.html">mouse_device.h</a>></code> +<p> +<p>Inheritance diagram for NLMISC::IMouseDevice: +<p><center><img src="structNLMISC_1_1IMouseDevice.gif" usemap="#NLMISC::IMouseDevice_map" border="0"></center> +<map name="NLMISC::IMouseDevice_map"> +<area href="structNLMISC_1_1IInputDevice.html" alt="NLMISC::IInputDevice" shape="rect" coords="0,0,146,24"> +</map> +<a href="structNLMISC_1_1IMouseDevice-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Types</h2></td></tr> +<tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="structNLMISC_1_1IMouseDevice.html#s9">TAxisMode</a> { <a class="el" href="structNLMISC_1_1IMouseDevice.html#s9s0">Raw</a>, +<a class="el" href="structNLMISC_1_1IMouseDevice.html#s9s1">Clamped</a>, +<a class="el" href="structNLMISC_1_1IMouseDevice.html#s9s2">AxisModeLast</a> + }</td></tr> +<tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="structNLMISC_1_1IMouseDevice.html#s10">TAxis</a> { <a class="el" href="structNLMISC_1_1IMouseDevice.html#s10s3">XAxis</a> = 0, +<a class="el" href="structNLMISC_1_1IMouseDevice.html#s10s4">YAxis</a> = 1, +<a class="el" href="structNLMISC_1_1IMouseDevice.html#s10s5">AxisLast</a> + }</td></tr> +<tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="structNLMISC_1_1IMouseDevice.html#s11">TMessageMode</a> { <a class="el" href="structNLMISC_1_1IMouseDevice.html#s11s6">NormalMode</a>, +<a class="el" href="structNLMISC_1_1IMouseDevice.html#s11s7">RawMode</a>, +<a class="el" href="structNLMISC_1_1IMouseDevice.html#s11s8">MessageModeLast</a> + }</td></tr> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>virtual const <a class="el" href="classNLMISC_1_1CRect.html">CRect</a> & </td><td valign=bottom><a class="el" href="structNLMISC_1_1IMouseDevice.html#a0">getMouseFrame</a> () const=0</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="structNLMISC_1_1IMouseDevice.html#a1">setDoubleClickDelay</a> (<a class="el" href="memory__common_8h.html#a15">uint</a> ms)=0</td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="memory__common_8h.html#a15">uint</a> </td><td valign=bottom><a class="el" href="structNLMISC_1_1IMouseDevice.html#a2">getDoubleClickDelay</a> () const=0</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="structNLMISC_1_1IMouseDevice.html#a3">setMousePos</a> (float <a class="el" href="driver__opengl__extension__def_8h.html#a364">x</a>, float <a class="el" href="driver__opengl__extension__def_8h.html#a365">y</a>)=0</td></tr> +<tr><td colspan="2"><div class="groupHeader">Messages</div></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="structNLMISC_1_1IMouseDevice.html#z298_0">setMessagesMode</a> (<a class="el" href="structNLMISC_1_1IMouseDevice.html#s11">TMessageMode</a> mode)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Tells what messages should be sent : DEFAULT is 'raw' messages Raw messages : - no clamping nor frames applied no speed apllied no factor applied <a class="el" href="classNLMISC_1_1CGDMouseMove.html">CGDMouseMove</a> messages are sent Coordinates expressed in mickeys Normal messages : - <a class="el" href="classNLMISC_1_1CEventMouseMove.html">CEventMouseMove</a> messages are sent A frame may clamp one or both axis The mouse speed can be changed.</em> <a href="#z298_0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="structNLMISC_1_1IMouseDevice.html#s11">TMessageMode</a> </td><td valign=bottom><a class="el" href="structNLMISC_1_1IMouseDevice.html#z298_1">getMessagesMode</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>retrieve what kinds of messages are sent.</em> <a href="#z298_1">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan="2"><div class="groupHeader">Mouse MOVE, valid only</div></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="structNLMISC_1_1IMouseDevice.html#z299_0">setMouseMode</a> (<a class="el" href="structNLMISC_1_1IMouseDevice.html#s10">TAxis</a> axis, <a class="el" href="structNLMISC_1_1IMouseDevice.html#s9">TAxisMode</a> axisMode)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set the mode of axis of the mouse.</em> <a href="#z299_0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="structNLMISC_1_1IMouseDevice.html#s9">TAxisMode</a> </td><td valign=bottom><a class="el" href="structNLMISC_1_1IMouseDevice.html#z299_1">getMouseMode</a> (<a class="el" href="structNLMISC_1_1IMouseDevice.html#s10">TAxis</a> axis) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>returns the mode of the mouse for the given axis.</em> <a href="#z299_1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="structNLMISC_1_1IMouseDevice.html#z299_2">setMouseSpeed</a> (float speed)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set the mouse speed.</em> <a href="#z299_2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual float </td><td valign=bottom><a class="el" href="structNLMISC_1_1IMouseDevice.html#z299_3">getMouseSpeed</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get the mouse speed.</em> <a href="#z299_3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="structNLMISC_1_1IMouseDevice.html#z299_4">setMouseFrame</a> (const <a class="el" href="classNLMISC_1_1CRect.html">CRect</a> &rect)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set the current frame in which the mouse can move, expressed in pixels.</em> <a href="#z299_4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="structNLMISC_1_1IMouseDevice.html#z299_5">setFactors</a> (float xFactor, float yFactor)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Gives factor by which the mouse coordinates must be multiplied before an event is sent.</em> <a href="#z299_5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual float </td><td valign=bottom><a class="el" href="structNLMISC_1_1IMouseDevice.html#z299_6">getXFactor</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get the x factor, use to multiply the mouse position before an event is sent.</em> <a href="#z299_6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual float </td><td valign=bottom><a class="el" href="structNLMISC_1_1IMouseDevice.html#z299_7">getYFactor</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get the y factor, use to multiply the mouse position before an event is sent.</em> <a href="#z299_7">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +An interface to a low level mouse device. +<p> + +<p> +Definition at line <a class="el" href="mouse__device_8h-source.html#l00040">40</a> of file <a class="el" href="mouse__device_8h-source.html">mouse_device.h</a>.<hr><h2>Member Enumeration Documentation</h2> +<a name="s10" doxytag="NLMISC::IMouseDevice::TAxis"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> enum NLMISC::IMouseDevice::TAxis + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<dl compact><dt><b> +Enumeration values:</b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em><a name="s10s3" doxytag="XAxis"></a><em>XAxis</em></em> </td><td> +</td></tr> +<tr><td valign=top><em><a name="s10s4" doxytag="YAxis"></a><em>YAxis</em></em> </td><td> +</td></tr> +<tr><td valign=top><em><a name="s10s5" doxytag="AxisLast"></a><em>AxisLast</em></em> </td><td> +</td></tr> +</table> +</dl> + +<p> +Definition at line <a class="el" href="mouse__device_8h-source.html#l00043">43</a> of file <a class="el" href="mouse__device_8h-source.html">mouse_device.h</a>. </td> + </tr> +</table> +<a name="s9" doxytag="NLMISC::IMouseDevice::TAxisMode"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> enum NLMISC::IMouseDevice::TAxisMode + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<dl compact><dt><b> +Enumeration values:</b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em><a name="s9s0" doxytag="Raw"></a><em>Raw</em></em> </td><td> +</td></tr> +<tr><td valign=top><em><a name="s9s1" doxytag="Clamped"></a><em>Clamped</em></em> </td><td> +</td></tr> +<tr><td valign=top><em><a name="s9s2" doxytag="AxisModeLast"></a><em>AxisModeLast</em></em> </td><td> +</td></tr> +</table> +</dl> + +<p> +Definition at line <a class="el" href="mouse__device_8h-source.html#l00042">42</a> of file <a class="el" href="mouse__device_8h-source.html">mouse_device.h</a>. </td> + </tr> +</table> +<a name="s11" doxytag="NLMISC::IMouseDevice::TMessageMode"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> enum NLMISC::IMouseDevice::TMessageMode + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<dl compact><dt><b> +Enumeration values:</b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em><a name="s11s6" doxytag="NormalMode"></a><em>NormalMode</em></em> </td><td> +</td></tr> +<tr><td valign=top><em><a name="s11s7" doxytag="RawMode"></a><em>RawMode</em></em> </td><td> +</td></tr> +<tr><td valign=top><em><a name="s11s8" doxytag="MessageModeLast"></a><em>MessageModeLast</em></em> </td><td> +</td></tr> +</table> +</dl> + +<p> +Definition at line <a class="el" href="mouse__device_8h-source.html#l00044">44</a> of file <a class="el" href="mouse__device_8h-source.html">mouse_device.h</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a2" doxytag="NLMISC::IMouseDevice::getDoubleClickDelay"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="memory__common_8h.html#a15">uint</a> NLMISC::IMouseDevice::getDoubleClickDelay </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a name="z298_1" doxytag="NLMISC::IMouseDevice::getMessagesMode"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="structNLMISC_1_1IMouseDevice.html#s11">TMessageMode</a> NLMISC::IMouseDevice::getMessagesMode </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +retrieve what kinds of messages are sent. +<p> + </td> + </tr> +</table> +<a name="a0" doxytag="NLMISC::IMouseDevice::getMouseFrame"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual const <a class="el" href="classNLMISC_1_1CRect.html">CRect</a>& NLMISC::IMouseDevice::getMouseFrame </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a name="z299_1" doxytag="NLMISC::IMouseDevice::getMouseMode"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="structNLMISC_1_1IMouseDevice.html#s9">TAxisMode</a> NLMISC::IMouseDevice::getMouseMode </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="structNLMISC_1_1IMouseDevice.html#s10">TAxis</a> </td> + <td class="mdname1" valign="top" nowrap> <em>axis</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +returns the mode of the mouse for the given axis. +<p> +NB : invalid in raw message mode </td> + </tr> +</table> +<a name="z299_3" doxytag="NLMISC::IMouseDevice::getMouseSpeed"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual float NLMISC::IMouseDevice::getMouseSpeed </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the mouse speed. +<p> +NB : invalid in raw message mode </td> + </tr> +</table> +<a name="z299_6" doxytag="NLMISC::IMouseDevice::getXFactor"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual float NLMISC::IMouseDevice::getXFactor </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the x factor, use to multiply the mouse position before an event is sent. +<p> +NB : invalid in raw message mode. <dl compact><dt><b> +See also: </b><dd> +<a class="el" href="structNLMISC_1_1IMouseDevice.html#z299_5">setFactors</a>() </dl> </td> + </tr> +</table> +<a name="z299_7" doxytag="NLMISC::IMouseDevice::getYFactor"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual float NLMISC::IMouseDevice::getYFactor </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the y factor, use to multiply the mouse position before an event is sent. +<p> +NB : invalid in raw message mode. <dl compact><dt><b> +See also: </b><dd> +<a class="el" href="structNLMISC_1_1IMouseDevice.html#z299_5">setFactors</a>() </dl> </td> + </tr> +</table> +<a name="a1" doxytag="NLMISC::IMouseDevice::setDoubleClickDelay"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLMISC::IMouseDevice::setDoubleClickDelay </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a15">uint</a> </td> + <td class="mdname1" valign="top" nowrap> <em>ms</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a name="z299_5" doxytag="NLMISC::IMouseDevice::setFactors"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLMISC::IMouseDevice::setFactors </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float </td> + <td class="mdname" nowrap> <em>xFactor</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>yFactor</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Gives factor by which the mouse coordinates must be multiplied before an event is sent. +<p> +The default factor is 1. NB : invalid in raw message mode. +<p> +Example : this set a frame of 800x600 and reports event in the [0, 1] range. <div class="fragment"><pre> mouse->setMouseFrame(800, 600); + mouse->setMouseMode(<a class="code" href="structNLMISC_1_1IMouseDevice.html#s10s3">XAxis</a>, IMouseDevice::Clamped); + mouse->setMouseMode(<a class="code" href="structNLMISC_1_1IMouseDevice.html#s10s4">YAxis</a>, IMouseDevice::Clamped); + mouse->setFactors(1.f / 800, 1.f / 600); +</pre></div> </td> + </tr> +</table> +<a name="z298_0" doxytag="NLMISC::IMouseDevice::setMessagesMode"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLMISC::IMouseDevice::setMessagesMode </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="structNLMISC_1_1IMouseDevice.html#s11">TMessageMode</a> </td> + <td class="mdname1" valign="top" nowrap> <em>mode</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Tells what messages should be sent : DEFAULT is 'raw' messages Raw messages : - no clamping nor frames applied no speed apllied no factor applied <a class="el" href="classNLMISC_1_1CGDMouseMove.html">CGDMouseMove</a> messages are sent Coordinates expressed in mickeys Normal messages : - <a class="el" href="classNLMISC_1_1CEventMouseMove.html">CEventMouseMove</a> messages are sent A frame may clamp one or both axis The mouse speed can be changed. +<p> +<ul> +<li>* - * - * - * - * - </ul> + </td> + </tr> +</table> +<a name="z299_4" doxytag="NLMISC::IMouseDevice::setMouseFrame"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLMISC::IMouseDevice::setMouseFrame </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CRect.html">CRect</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>rect</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the current frame in which the mouse can move, expressed in pixels. +<p> +NB do not forget to call setMouseFactors if you want the results to be reported in the 0-1 range. NB : invalid in raw message mode. <dl compact><dt><b> +See also: </b><dd> +setMouseFactors </dl> </td> + </tr> +</table> +<a name="z299_0" doxytag="NLMISC::IMouseDevice::setMouseMode"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLMISC::IMouseDevice::setMouseMode </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="structNLMISC_1_1IMouseDevice.html#s10">TAxis</a> </td> + <td class="mdname" nowrap> <em>axis</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="structNLMISC_1_1IMouseDevice.html#s9">TAxisMode</a> </td> + <td class="mdname" nowrap> <em>axisMode</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the mode of axis of the mouse. +<p> +This can be raw, or clamped. In clamped mode, a frame is used to limit the move. NB : invalid in raw message mode <dl compact><dt><b> +See also: </b><dd> +<a class="el" href="structNLMISC_1_1IMouseDevice.html#z299_4">setMouseFrame</a>(const CRect &rect) </dl> </td> + </tr> +</table> +<a name="a3" doxytag="NLMISC::IMouseDevice::setMousePos"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLMISC::IMouseDevice::setMousePos </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float </td> + <td class="mdname" nowrap> <em>x</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>y</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a name="z299_2" doxytag="NLMISC::IMouseDevice::setMouseSpeed"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLMISC::IMouseDevice::setMouseSpeed </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float </td> + <td class="mdname1" valign="top" nowrap> <em>speed</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the mouse speed. +<p> +It must be in the ]0, +inf] range, 1 gives the natural mouse speed. NB : invalid in raw message mode </td> + </tr> +</table> +<hr>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="mouse__device_8h-source.html">mouse_device.h</a></ul> + + +<!-- footer --> +<BR><FONT Size=+5> </FONT> +</TD> +<TD WIDTH=15><IMG SRC=http://www.nevrax.org/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD> +</TR> +</TABLE> +</BODY> +</HTML> |