diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/doxygen/nel/structNLMISC_1_1IInputDevice.html | 355 |
1 files changed, 355 insertions, 0 deletions
diff --git a/docs/doxygen/nel/structNLMISC_1_1IInputDevice.html b/docs/doxygen/nel/structNLMISC_1_1IInputDevice.html new file mode 100644 index 00000000..ec615f1f --- /dev/null +++ b/docs/doxygen/nel/structNLMISC_1_1IInputDevice.html @@ -0,0 +1,355 @@ +<!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::IInputDevice Struct Reference</h1>Base class that wrap to a device. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="input__device_8h-source.html">input_device.h</a>></code> +<p> +<p>Inheritance diagram for NLMISC::IInputDevice: +<p><center><img src="structNLMISC_1_1IInputDevice.gif" usemap="#NLMISC::IInputDevice_map" border="0"></center> +<map name="NLMISC::IInputDevice_map"> +<area href="structNLMISC_1_1IGameDevice.html" alt="NLMISC::IGameDevice" shape="rect" coords="0,56,163,80"> +<area href="structNLMISC_1_1IKeyboardDevice.html" alt="NLMISC::IKeyboardDevice" shape="rect" coords="173,56,336,80"> +<area href="structNLMISC_1_1IMouseDevice.html" alt="NLMISC::IMouseDevice" shape="rect" coords="346,56,509,80"> +</map> +<a href="structNLMISC_1_1IInputDevice-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="structNLMISC_1_1IInputDevice.html#a0">setBufferSize</a> (<a class="el" href="memory__common_8h.html#a15">uint</a> <a class="el" href="cf__lexical_8cpp.html#a94">size</a>)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set the buffer size for this device (the number of samples it can retains).</em> <a href="#a0">More...</a><em></em></font><br><br></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_1IInputDevice.html#a1">getBufferSize</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get the buffer size for this device.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="structNLMISC_1_1IInputDevice.html#a2">~IInputDevice</a> ()</td></tr> +<tr><td colspan="2"><div class="groupHeader">Device server specifics. You usually don't want to call these</div></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="structNLMISC_1_1IInputDevice.html#z288_0">begin</a> (<a class="el" href="classNLMISC_1_1CEventServer.html">CEventServer</a> *server)</td></tr> +<tr><td> </td><td><font size=-1><em>For device server usage : Called at the beginning of each events retrieval.</em> <a href="#z288_0">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_1IInputDevice.html#z288_1">poll</a> (<a class="el" href="classNLMISC_1_1CInputDeviceServer.html">CInputDeviceServer</a> *dev)=0</td></tr> +<tr><td> </td><td><font size=-1><em>For device server usage : Poll all events from that device, and notify them to the given device server, so that they can be sorted between devices.</em> <a href="#z288_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_1IInputDevice.html#z288_2">submit</a> (<a class="el" href="structNLMISC_1_1IInputDeviceEvent.html">IInputDeviceEvent</a> *deviceEvent, <a class="el" href="classNLMISC_1_1CEventServer.html">CEventServer</a> *server)=0</td></tr> +<tr><td> </td><td><font size=-1><em>For device server usage : Process an event (eventually update this device state), and translate the message to a IEventServerMessage.</em> <a href="#z288_2">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_1IInputDevice.html#z288_3">transitionOccured</a> (<a class="el" href="classNLMISC_1_1CEventServer.html">CEventServer</a> *server, const <a class="el" href="structNLMISC_1_1IInputDeviceEvent.html">IInputDeviceEvent</a> *nextMessage)</td></tr> +<tr><td> </td><td><font size=-1><em>For device server usage : Says that the next message is for another device, or that it is the last message that will be received.</em> <a href="#z288_3">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Base class that wrap to a device. +<p> +<dl compact><dt><b> +Author: </b><dd> +Nicolas Vizerie , Nevrax France </dl><dl compact><dt><b> +Date: </b><dd> +2002 </dl> +<p> + +<p> +Definition at line <a class="el" href="input__device_8h-source.html#l00048">48</a> of file <a class="el" href="input__device_8h-source.html">input_device.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a2" doxytag="NLMISC::IInputDevice::~IInputDevice"></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 NLMISC::IInputDevice::~IInputDevice </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="input__device_8h-source.html#l00085">85</a> of file <a class="el" href="input__device_8h-source.html">input_device.h</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="z288_0" doxytag="NLMISC::IInputDevice::begin"></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::IInputDevice::begin </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLMISC_1_1CEventServer.html">CEventServer</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>server</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +For device server usage : Called at the beginning of each events retrieval. +<p> +If a device doesn't support buffered datas, the state changes can be directly send to the event server. The default does nothing. +<p> +Definition at line <a class="el" href="input__device_8h-source.html#l00064">64</a> of file <a class="el" href="input__device_8h-source.html">input_device.h</a>. </td> + </tr> +</table> +<a name="a1" doxytag="NLMISC::IInputDevice::getBufferSize"></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::IInputDevice::getBufferSize </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 buffer size for this device. +<p> + </td> + </tr> +</table> +<a name="z288_1" doxytag="NLMISC::IInputDevice::poll"></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::IInputDevice::poll </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLMISC_1_1CInputDeviceServer.html">CInputDeviceServer</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>dev</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> +For device server usage : Poll all events from that device, and notify them to the given device server, so that they can be sorted between devices. +<p> +This retrieves messages, but do not process them. </td> + </tr> +</table> +<a name="a0" doxytag="NLMISC::IInputDevice::setBufferSize"></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 bool NLMISC::IInputDevice::setBufferSize </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>size</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 buffer size for this device (the number of samples it can retains). +<p> +This return true if the size could be set </td> + </tr> +</table> +<a name="z288_2" doxytag="NLMISC::IInputDevice::submit"></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::IInputDevice::submit </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="structNLMISC_1_1IInputDeviceEvent.html">IInputDeviceEvent</a> * </td> + <td class="mdname" nowrap> <em>deviceEvent</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="classNLMISC_1_1CEventServer.html">CEventServer</a> * </td> + <td class="mdname" nowrap> <em>server</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> +For device server usage : Process an event (eventually update this device state), and translate the message to a IEventServerMessage. +<p> + </td> + </tr> +</table> +<a name="z288_3" doxytag="NLMISC::IInputDevice::transitionOccured"></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::IInputDevice::transitionOccured </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLMISC_1_1CEventServer.html">CEventServer</a> * </td> + <td class="mdname" nowrap> <em>server</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>const <a class="el" href="structNLMISC_1_1IInputDeviceEvent.html">IInputDeviceEvent</a> * </td> + <td class="mdname" nowrap> <em>nextMessage</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +For device server usage : Says that the next message is for another device, or that it is the last message that will be received. +<p> +This allow to pack several messages in one (for example, to sum up mouse moves until a click occurs) The default does nothing. The next message can be used to get a time stamp for example. It may be NULL is no next message is available +<p> +Definition at line <a class="el" href="input__device_8h-source.html#l00081">81</a> of file <a class="el" href="input__device_8h-source.html">input_device.h</a>. </td> + </tr> +</table> +<hr>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="input__device_8h-source.html">input_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> |