diff options
Diffstat (limited to 'docs/doxygen/nel/a03860.html')
| -rw-r--r-- | docs/doxygen/nel/a03860.html | 528 |
1 files changed, 528 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03860.html b/docs/doxygen/nel/a03860.html new file mode 100644 index 00000000..8dec0027 --- /dev/null +++ b/docs/doxygen/nel/a03860.html @@ -0,0 +1,528 @@ +<!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>NeL: NLMISC::IKeyboardDevice struct Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.3.6 --> +<div class="qindex"> <form class="search" action="search.php" method="get"> +<a class="qindex" href="main.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">Data Structures</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">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a> | <span class="search"><u>S</u>earch for <input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div> +<h1>NLMISC::IKeyboardDevice Struct Reference</h1><code>#include <<a class="el" href="a05861.html">keyboard_device.h</a>></code> +<p> +<p>Inheritance diagram for NLMISC::IKeyboardDevice: +<p><center><img src="a03860.png" usemap="#NLMISC::IKeyboardDevice_map" border="0" alt=""></center> +<map name="NLMISC::IKeyboardDevice_map"> +<area href="a03855.html" alt="NLMISC::IInputDevice" shape="rect" coords="0,0,163,24"> +</map> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Gives access to low level keyboard parameters<ul> +<li>'Shift' messages are replaced by RShift and LShift msg.</li><li>'Control' messages are replaced by 'RControl' and 'LControl' msg.</li><li>'Menu' (alternate) messages are replaced by 'RMenu' and 'LMenu' msg. </li></ul> + +<p> + +<p> +Definition at line <a class="el" href="a05861.html#l00043">43</a> of file <a class="el" href="a05861.html">keyboard_device.h</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>enum </td><td class="memItemRight" valign=bottom>{ <a class="el" href="a03860.html#NLMISC_1_1IKeyboardDevicew0NLMISC_1_1IKeyboardDevicew1">NumKeys</a> = 256 + }</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Max number of supported keys. <a href="#NLMISC_1_1IKeyboardDevicew0">More...</a><br><br></td></tr> +<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03860.html#NLMISC_1_1IKeyboardDevicea0">disableRepetition</a> (const <a class="el" href="a05378.html#a442">TKey</a> *keyTab, <a class="el" href="a04558.html#a15">uint</a> numKey)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a set of keys for which repetition is disabled. <a href="#NLMISC_1_1IKeyboardDevicea0"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a04558.html#a15">uint</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03855.html#NLMISC_1_1IMouseDevicea0">getBufferSize</a> () const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the buffer size for this device. <a href="#NLMISC_1_1IMouseDevicea0"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03860.html#NLMISC_1_1IKeyboardDevicea2">getDisabledRepetitions</a> (<a class="el" href="a05378.html#a442">TKey</a> *destTab) const=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a04558.html#a15">uint</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03860.html#NLMISC_1_1IKeyboardDevicea3">getKeyRepeatDelay</a> () const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the delay before key repeat, in milliseconds. <a href="#NLMISC_1_1IKeyboardDevicea3"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a04558.html#a15">uint</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03860.html#NLMISC_1_1IKeyboardDevicea4">getKeyRepeatPeriod</a> () const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the period before key repeat, in milliseconds. <a href="#NLMISC_1_1IKeyboardDevicea4"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a04558.html#a15">uint</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03860.html#NLMISC_1_1IKeyboardDevicea5">getNumDisabledRepetition</a> () const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of disabled keys. <a href="#NLMISC_1_1IKeyboardDevicea5"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="a03855.html#NLMISC_1_1IMouseDevicea3">setBufferSize</a> (<a class="el" href="a04558.html#a15">uint</a> <a class="el" href="a04223.html#a587">size</a>)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03860.html#NLMISC_1_1IKeyboardDevicea7">setKeyRepeatDelay</a> (<a class="el" href="a04558.html#a15">uint</a> delay)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the delay before key repeat, in milliseconds. <a href="#NLMISC_1_1IKeyboardDevicea7"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03860.html#NLMISC_1_1IKeyboardDevicea8">setKeyRepeatPeriod</a> (<a class="el" href="a04558.html#a15">uint</a> period)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the period before key repeat, in milliseconds. <a href="#NLMISC_1_1IKeyboardDevicea8"></a><br><br></td></tr> +</table> +<hr><h2>Member Enumeration Documentation</h2> +<a class="anchor" name="NLMISC_1_1IKeyboardDevicew0" doxytag="NLMISC::IKeyboardDevice::@80" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> anonymous enum + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Max number of supported keys. +<p> +<dl compact><dt><b>Enumeration values: </b></dt><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em><a class="anchor" name="NLMISC_1_1IKeyboardDevicew0NLMISC_1_1IKeyboardDevicew1" doxytag="NumKeys" ></a>NumKeys</em> </td><td> +</td></tr> +</table> +</dl> + +<p> +Definition at line <a class="el" href="a05861.html#l00046">46</a> of file <a class="el" href="a05861.html">keyboard_device.h</a>. +<p> +<div class="fragment"><pre>00046 { <a class="code" href="a03860.html#NLMISC_1_1IKeyboardDevicew0NLMISC_1_1IKeyboardDevicew1">NumKeys</a> = 256 }; +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NLMISC_1_1IMouseDevicez1957_0" doxytag="NLMISC::IKeyboardDevice::begin" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <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="a02479.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, inherited]</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. 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="a05818.html#l00064">64</a> of file <a class="el" href="a05818.html">input_device.h</a>. +<p> +<div class="fragment"><pre>00064 {} +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1IKeyboardDevicea0" doxytag="NLMISC::IKeyboardDevice::disableRepetition" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLMISC::IKeyboardDevice::disableRepetition </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="a05378.html#a442">TKey</a> * </td> + <td class="mdname" nowrap> <em>keyTab</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a04558.html#a15">uint</a> </td> + <td class="mdname" nowrap> <em>numKey</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 a set of keys for which repetition is disabled. +<p> + </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1IMouseDevicea0" doxytag="NLMISC::IKeyboardDevice::getBufferSize" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="a04558.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, inherited]</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 class="anchor" name="NLMISC_1_1IKeyboardDevicea2" doxytag="NLMISC::IKeyboardDevice::getDisabledRepetitions" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLMISC::IKeyboardDevice::getDisabledRepetitions </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a05378.html#a442">TKey</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>destTab</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> +Get the disabled keys and stores in the given tab. NB: must ensure the destination table has the right size <dl compact><dt><b>See also:</b></dt><dd>getNumDisabledKeys()</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1IKeyboardDevicea3" doxytag="NLMISC::IKeyboardDevice::getKeyRepeatDelay" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="a04558.html#a15">uint</a> NLMISC::IKeyboardDevice::getKeyRepeatDelay </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 delay before key repeat, in milliseconds. +<p> + </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1IKeyboardDevicea4" doxytag="NLMISC::IKeyboardDevice::getKeyRepeatPeriod" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="a04558.html#a15">uint</a> NLMISC::IKeyboardDevice::getKeyRepeatPeriod </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 period before key repeat, in milliseconds. +<p> + </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1IKeyboardDevicea5" doxytag="NLMISC::IKeyboardDevice::getNumDisabledRepetition" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="a04558.html#a15">uint</a> NLMISC::IKeyboardDevice::getNumDisabledRepetition </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 number of disabled keys. +<p> + </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1IMouseDevicez1957_1" doxytag="NLMISC::IKeyboardDevice::poll" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <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="a02669.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, inherited]</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. This retrieves messages, but do not process them. </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1IMouseDevicea3" doxytag="NLMISC::IKeyboardDevice::setBufferSize" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <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="a04558.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, inherited]</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). This return true if the size could be set </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1IKeyboardDevicea7" doxytag="NLMISC::IKeyboardDevice::setKeyRepeatDelay" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLMISC::IKeyboardDevice::setKeyRepeatDelay </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a04558.html#a15">uint</a> </td> + <td class="mdname1" valign="top" nowrap> <em>delay</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> +Get the delay before key repeat, in milliseconds. +<p> + </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1IKeyboardDevicea8" doxytag="NLMISC::IKeyboardDevice::setKeyRepeatPeriod" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLMISC::IKeyboardDevice::setKeyRepeatPeriod </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a04558.html#a15">uint</a> </td> + <td class="mdname1" valign="top" nowrap> <em>period</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> +Get the period before key repeat, in milliseconds. +<p> + </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1IMouseDevicez1957_2" doxytag="NLMISC::IKeyboardDevice::submit" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <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="a03857.html">IInputDeviceEvent</a> * </td> + <td class="mdname" nowrap> <em>deviceEvent</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a02479.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, inherited]</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 </td> + </tr> +</table> +<a class="anchor" name="NLMISC_1_1IMouseDevicez1957_3" doxytag="NLMISC::IKeyboardDevice::transitionOccured" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <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="a02479.html">CEventServer</a> * </td> + <td class="mdname" nowrap> <em>server</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>const <a class="el" href="a03857.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, inherited]</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. 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="a05818.html#l00081">81</a> of file <a class="el" href="a05818.html">input_device.h</a>. +<p> +Referenced by <a class="el" href="a05820.html#l00067">NLMISC::CInputDeviceServer::poll()</a>. +<p> +<div class="fragment"><pre>00081 {} +</pre></div> </td> + </tr> +</table> +<hr>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="a05861.html">keyboard_device.h</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 13:46:26 2004 for NeL by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border=0 > +</a>1.3.6 </small></address> +</body> +</html> |