specchioriflesso/USB_Host_Shield_2.0
1
Fork 0
mirror of https://github.com/felis/USB_Host_Shield_2.0.git synced 2024-03-22 11:31:26 +01:00
Code Issues Packages Projects Releases Wiki Activity
USB_Host_Shield_2.0/class_keyboard_report_parser.html

441 lines
20 KiB
HTML
Raw Normal View History

Added Doxygen files
2013-01-30 22:00:18 +01:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>USB_Host_Shield_2.0: KeyboardReportParser Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">USB_Host_Shield_2.0
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_keyboard_report_parser-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">KeyboardReportParser Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="hidboot_8h_source.html">hidboot.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for KeyboardReportParser:</div>
<div class="dyncontent">
<div class="center"><img src="class_keyboard_report_parser__inherit__graph.png" border="0" usemap="#_keyboard_report_parser_inherit__map" alt="Inheritance graph"/></div>
<map name="_keyboard_report_parser_inherit__map" id="_keyboard_report_parser_inherit__map">
<area shape="rect" id="node2" href="class_h_i_d_report_parser.html" title="HIDReportParser" alt="" coords="15,5,99,27"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for KeyboardReportParser:</div>
<div class="dyncontent">
<div class="center"><img src="class_keyboard_report_parser__coll__graph.png" border="0" usemap="#_keyboard_report_parser_coll__map" alt="Collaboration graph"/></div>
<map name="_keyboard_report_parser_coll__map" id="_keyboard_report_parser_coll__map">
<area shape="rect" id="node2" href="class_h_i_d_report_parser.html" title="HIDReportParser" alt="" coords="5,5,88,27"/><area shape="rect" id="node3" href="struct_k_b_d_l_e_d_s.html" title="KBDLEDS" alt="" coords="113,5,172,27"/><area shape="rect" id="node4" href="struct_k_b_d_i_n_f_o.html" title="KBDINFO" alt="" coords="197,5,253,27"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa9b5c7b50c3d2b920060b15e7a5133f9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_keyboard_report_parser.html#aa9b5c7b50c3d2b920060b15e7a5133f9">KeyboardReportParser</a> ()</td></tr>
<tr class="separator:aa9b5c7b50c3d2b920060b15e7a5133f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a60d8d4d4d187ce5c0e0d69aee7cc772f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_keyboard_report_parser.html#a60d8d4d4d187ce5c0e0d69aee7cc772f">Parse</a> (<a class="el" href="class_h_i_d.html">HID</a> *hid, bool is_rpt_id, uint8_t len, uint8_t *buf)</td></tr>
<tr class="separator:a60d8d4d4d187ce5c0e0d69aee7cc772f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:aa21e9230ae4c2f068c404a9c2909a1f3"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_keyboard_report_parser.html#aa21e9230ae4c2f068c404a9c2909a1f3">OemToAscii</a> (uint8_t mod, uint8_t key)</td></tr>
<tr class="separator:aa21e9230ae4c2f068c404a9c2909a1f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a486df60a3d29f73e9052d3efb0c38de6"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_keyboard_report_parser.html#a486df60a3d29f73e9052d3efb0c38de6">HandleLockingKeys</a> (<a class="el" href="class_h_i_d.html">HID</a> *hid, uint8_t key)</td></tr>
<tr class="separator:a486df60a3d29f73e9052d3efb0c38de6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af855e596bbbb9755535f6e69f4ca2305"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_keyboard_report_parser.html#af855e596bbbb9755535f6e69f4ca2305">OnKeyDown</a> (uint8_t mod, uint8_t key)</td></tr>
<tr class="separator:af855e596bbbb9755535f6e69f4ca2305"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57710d31e5379db14779f960f5c714b2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_keyboard_report_parser.html#a57710d31e5379db14779f960f5c714b2">OnKeyUp</a> (uint8_t mod, uint8_t key)</td></tr>
<tr class="separator:a57710d31e5379db14779f960f5c714b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:afd420d44cb0a072abc3f6c88faae8454"><td class="memItemLeft" >union {</td></tr>
<tr class="memitem:a886f5fb935f62654611e7a687ba7ebdc"><td class="memItemLeft" >&#160;&#160;&#160;<a class="el" href="struct_k_b_d_i_n_f_o.html">KBDINFO</a>&#160;&#160;&#160;<a class="el" href="class_keyboard_report_parser.html#ab62ffa0e72677379d1e68538625f2f28">kbdInfo</a></td></tr>
<tr class="separator:a886f5fb935f62654611e7a687ba7ebdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3905beda807a1aa59000ac78ac02f15"><td class="memItemLeft" >&#160;&#160;&#160;uint8_t&#160;&#160;&#160;<a class="el" href="class_keyboard_report_parser.html#a65e6da24b038be3095d06e13b4a280ba">bInfo</a> [sizeof(<a class="el" href="struct_k_b_d_i_n_f_o.html">KBDINFO</a>)]</td></tr>
<tr class="separator:ab3905beda807a1aa59000ac78ac02f15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd420d44cb0a072abc3f6c88faae8454"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_keyboard_report_parser.html#afd420d44cb0a072abc3f6c88faae8454">prevState</a></td></tr>
<tr class="separator:afd420d44cb0a072abc3f6c88faae8454"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a156efc36343da91fb8bc20aa059f1435"><td class="memItemLeft" >union {</td></tr>
<tr class="memitem:ab691db6ea6733808d7d6d15f87f8691c"><td class="memItemLeft" >&#160;&#160;&#160;<a class="el" href="struct_k_b_d_l_e_d_s.html">KBDLEDS</a>&#160;&#160;&#160;<a class="el" href="class_keyboard_report_parser.html#aa867ab4b6898efa9b768bd05f275809c">kbdLeds</a></td></tr>
<tr class="separator:ab691db6ea6733808d7d6d15f87f8691c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa677f0d06c7196c115122ca771ee6aa2"><td class="memItemLeft" >&#160;&#160;&#160;uint8_t&#160;&#160;&#160;<a class="el" href="class_keyboard_report_parser.html#ae910089ecc7caff18429925affc5dc7f">bLeds</a></td></tr>
<tr class="separator:aa677f0d06c7196c115122ca771ee6aa2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a156efc36343da91fb8bc20aa059f1435"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_keyboard_report_parser.html#a156efc36343da91fb8bc20aa059f1435">kbdLockingKeys</a></td></tr>
<tr class="separator:a156efc36343da91fb8bc20aa059f1435"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aa9b5c7b50c3d2b920060b15e7a5133f9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">KeyboardReportParser::KeyboardReportParser </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a486df60a3d29f73e9052d3efb0c38de6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t KeyboardReportParser::HandleLockingKeys </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_h_i_d.html">HID</a> *&#160;</td>
<td class="paramname"><em>hid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>key</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aa21e9230ae4c2f068c404a9c2909a1f3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t KeyboardReportParser::OemToAscii </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>mod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>key</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="af855e596bbbb9755535f6e69f4ca2305"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void KeyboardReportParser::OnKeyDown </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>mod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>key</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a57710d31e5379db14779f960f5c714b2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void KeyboardReportParser::OnKeyUp </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>mod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>key</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a60d8d4d4d187ce5c0e0d69aee7cc772f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void KeyboardReportParser::Parse </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_h_i_d.html">HID</a> *&#160;</td>
<td class="paramname"><em>hid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>is_rpt_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>buf</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="class_h_i_d_report_parser.html#ad2837f3d78c7ac3f1c2b3a4815420d97">HIDReportParser</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a65e6da24b038be3095d06e13b4a280ba"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t KeyboardReportParser::bInfo[sizeof(<a class="el" href="struct_k_b_d_i_n_f_o.html">KBDINFO</a>)]</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ae910089ecc7caff18429925affc5dc7f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t KeyboardReportParser::bLeds</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ab62ffa0e72677379d1e68538625f2f28"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_k_b_d_i_n_f_o.html">KBDINFO</a> KeyboardReportParser::kbdInfo</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aa867ab4b6898efa9b768bd05f275809c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_k_b_d_l_e_d_s.html">KBDLEDS</a> KeyboardReportParser::kbdLeds</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a156efc36343da91fb8bc20aa059f1435"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">union { ... } KeyboardReportParser::kbdLockingKeys</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="afd420d44cb0a072abc3f6c88faae8454"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">union { ... } KeyboardReportParser::prevState</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/Users/Lauszus/GitHub/USB_Host_Shield_2.0/<a class="el" href="hidboot_8h_source.html">hidboot.h</a></li>
<li>/Users/Lauszus/GitHub/USB_Host_Shield_2.0/<a class="el" href="hidboot_8cpp.html">hidboot.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jan 30 2013 21:23:57 for USB_Host_Shield_2.0 by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
Reference in a new issue Copy permalink