<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>BrlAPI: Reading key presses</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.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Reading key presses</h1>How to read key presses from the braille terminal.
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__expandedKeyCode__t.html">brlapi_expandedKeyCode_t</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__describedKeyCode__t.html">brlapi_describedKeyCode_t</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__range__t.html">brlapi_range_t</a></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__keys.html#gbdb9c75bc336c166b41d6b820e7e242c">brlapi_ignoreAllKeys</a>() brlapi_ignoreKeys(brlapi_rangeType_all, NULL, 0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__keys.html#geecd40e9a62ec7b2726f16c859b7b01c">brlapi_acceptAllKeys</a>() brlapi_acceptKeys(brlapi_rangeType_all, NULL, 0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__keys.html#gf17304a5f4afe60a423fd3f922d9f9b7">BRLAPI_UC_ROW</a> 0x2800UL</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__keys.html#g153ea2355180cb7cc0b35f8bfa71071b">brlapi__ignoreAllKeys</a>(handle) brlapi__ignoreKeys(handle, brlapi_rangeType_all, NULL, 0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__keys.html#g3c001392e34af461c5ba8b2940e66fa4">brlapi__acceptAllKeys</a>(handle) brlapi__acceptKeys(handle, brlapi_rangeType_all, NULL, 0)</td></tr>
<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__keys.html#g04da4d59bcca169be939b8ebfc274bd2">brlapi_rangeType_t</a> { <br>
<a class="el" href="group__brlapi__keys.html#gg04da4d59bcca169be939b8ebfc274bd234074d26f350d14b438c402d7ff51b8b">brlapi_rangeType_all</a>,
<a class="el" href="group__brlapi__keys.html#gg04da4d59bcca169be939b8ebfc274bd2740dd33effeed51f37cb29bb4fe5d6b8">brlapi_rangeType_type</a>,
<a class="el" href="group__brlapi__keys.html#gg04da4d59bcca169be939b8ebfc274bd26c5a9cea072b66fe0e5ad3e9d52b03e7">brlapi_rangeType_command</a>,
<a class="el" href="group__brlapi__keys.html#gg04da4d59bcca169be939b8ebfc274bd23ea0b1512b6fc33cab1e9d5726a4e4de">brlapi_rangeType_key</a>,
<br>
<a class="el" href="group__brlapi__keys.html#gg04da4d59bcca169be939b8ebfc274bd2805970686b12dbcc77c2e1c4f12a635b">brlapi_rangeType_code</a>
<br>
}</td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int BRLAPI_STDCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__keys.html#gfdac75a70de34360e62bd17cddaecb5d">brlapi_expandKeyCode</a> (<a class="el" href="group__brlapi__keycodes.html#g956fddb34f9b399e884b1fafdb037b6a">brlapi_keyCode_t</a> code, <a class="el" href="structbrlapi__expandedKeyCode__t.html">brlapi_expandedKeyCode_t</a> *expansion)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int BRLAPI_STDCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__keys.html#g27cd6a123ab9c8685055b72e0481067d">brlapi_describeKeyCode</a> (<a class="el" href="group__brlapi__keycodes.html#g956fddb34f9b399e884b1fafdb037b6a">brlapi_keyCode_t</a> code, <a class="el" href="structbrlapi__describedKeyCode__t.html">brlapi_describedKeyCode_t</a> *description)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int BRLAPI_STDCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__keys.html#g3b5ba0c43d48792e7071e772b50b9cbe">brlapi_readKey</a> (int wait, <a class="el" href="group__brlapi__keycodes.html#g956fddb34f9b399e884b1fafdb037b6a">brlapi_keyCode_t</a> *code)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int BRLAPI_STDCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__keys.html#g557d77c4e1bf70a0d01b619aea152120">brlapi__readKey</a> (<a class="el" href="group__brlapi__handles.html#g57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *handle, int wait, <a class="el" href="group__brlapi__keycodes.html#g956fddb34f9b399e884b1fafdb037b6a">brlapi_keyCode_t</a> *code)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int BRLAPI_STDCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__keys.html#g51f541d3e9e1a797a4e4c5ef884f02cb">brlapi_ignoreKeys</a> (<a class="el" href="group__brlapi__keys.html#g04da4d59bcca169be939b8ebfc274bd2">brlapi_rangeType_t</a> type, const <a class="el" href="group__brlapi__keycodes.html#g956fddb34f9b399e884b1fafdb037b6a">brlapi_keyCode_t</a> keys[], unsigned int count)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int BRLAPI_STDCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__keys.html#g6bd1a8af2c1d1b09a55d5647fbc9e035">brlapi__ignoreKeys</a> (<a class="el" href="group__brlapi__handles.html#g57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *handle, <a class="el" href="group__brlapi__keys.html#g04da4d59bcca169be939b8ebfc274bd2">brlapi_rangeType_t</a> type, const <a class="el" href="group__brlapi__keycodes.html#g956fddb34f9b399e884b1fafdb037b6a">brlapi_keyCode_t</a> keys[], unsigned int count)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int BRLAPI_STDCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__keys.html#g15399581e093fc1635c53f4815fae551">brlapi_acceptKeys</a> (<a class="el" href="group__brlapi__keys.html#g04da4d59bcca169be939b8ebfc274bd2">brlapi_rangeType_t</a> type, const <a class="el" href="group__brlapi__keycodes.html#g956fddb34f9b399e884b1fafdb037b6a">brlapi_keyCode_t</a> keys[], unsigned int count)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int BRLAPI_STDCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__keys.html#g0e76fb5ffa4547ccbe54e1a09d562b0a">brlapi__acceptKeys</a> (<a class="el" href="group__brlapi__handles.html#g57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *handle, <a class="el" href="group__brlapi__keys.html#g04da4d59bcca169be939b8ebfc274bd2">brlapi_rangeType_t</a> type, const <a class="el" href="group__brlapi__keycodes.html#g956fddb34f9b399e884b1fafdb037b6a">brlapi_keyCode_t</a> keys[], unsigned int count)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int BRLAPI_STDCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__keys.html#ge0bc6b3628c42fa6387f3a398e424932">brlapi__ignoreAllKeys</a> (<a class="el" href="group__brlapi__handles.html#g57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *handle)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int BRLAPI_STDCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__keys.html#gfd425b67454237b5d35b4b5e5f5d92d9">brlapi__acceptAllKeys</a> (<a class="el" href="group__brlapi__handles.html#g57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *handle)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int BRLAPI_STDCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__keys.html#g3ccaf06f70f11b9364a4610752f26c9e">brlapi_ignoreKeyRanges</a> (<a class="el" href="structbrlapi__range__t.html">brlapi_range_t</a> ranges[], unsigned int count)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int BRLAPI_STDCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__keys.html#gd4de372b84bf12ec74cda2e59da31b8f">brlapi__ignoreKeyRanges</a> (<a class="el" href="group__brlapi__handles.html#g57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *handle, <a class="el" href="structbrlapi__range__t.html">brlapi_range_t</a> ranges[], unsigned int count)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int BRLAPI_STDCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__keys.html#gfef1d9fd59fed736d1cdc50e0352aabb">brlapi_acceptKeyRanges</a> (<a class="el" href="structbrlapi__range__t.html">brlapi_range_t</a> ranges[], unsigned int count)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int BRLAPI_STDCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__keys.html#gc131789506dfaa26094496dfe52358e4">brlapi__acceptKeyRanges</a> (<a class="el" href="group__brlapi__handles.html#g57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *handle, <a class="el" href="structbrlapi__range__t.html">brlapi_range_t</a> ranges[], unsigned int count)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Once <a class="el" href="group__brlapi__tty.html#g6d8ae822fa87d9bfb1fb15ecf2bbcaac">brlapi_enterTtyMode()</a> has been called, the application can call <a class="el" href="group__brlapi__keys.html#g3b5ba0c43d48792e7071e772b50b9cbe">brlapi_readKey()</a> to read key presses. Either key codes (see <a class="el" href="group__brlapi__keycodes.html">Types and Defines fore BrlAPI Key Codes</a>) or commands will be returned, depending on parameters given to <a class="el" href="group__brlapi__tty.html#g6d8ae822fa87d9bfb1fb15ecf2bbcaac">brlapi_enterTtyMode()</a>.<p>
Key presses are buffered, so that calling <a class="el" href="group__brlapi__keys.html#g3b5ba0c43d48792e7071e772b50b9cbe">brlapi_readKey()</a> in non-blocking mode from time to time should suffice. <hr><h2>Define Documentation</h2>
<a class="anchor" name="g3c001392e34af461c5ba8b2940e66fa4"></a><!-- doxytag: member="brlapi.h::brlapi__acceptAllKeys" ref="g3c001392e34af461c5ba8b2940e66fa4" args="(handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define brlapi__acceptAllKeys </td>
<td>(</td>
<td class="paramtype">handle </td>
<td class="paramname"> </td>
<td> ) </td>
<td> brlapi__acceptKeys(handle, brlapi_rangeType_all, NULL, 0)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="g153ea2355180cb7cc0b35f8bfa71071b"></a><!-- doxytag: member="brlapi.h::brlapi__ignoreAllKeys" ref="g153ea2355180cb7cc0b35f8bfa71071b" args="(handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define brlapi__ignoreAllKeys </td>
<td>(</td>
<td class="paramtype">handle </td>
<td class="paramname"> </td>
<td> ) </td>
<td> brlapi__ignoreKeys(handle, brlapi_rangeType_all, NULL, 0)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="geecd40e9a62ec7b2726f16c859b7b01c"></a><!-- doxytag: member="brlapi.h::brlapi_acceptAllKeys" ref="geecd40e9a62ec7b2726f16c859b7b01c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi_acceptAllKeys </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td> brlapi_acceptKeys(brlapi_rangeType_all, NULL, 0)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Accept all key presses from the braille keyboard<p>
This function asks the server to give all keys to the application, and not give them to <em>brltty</em>.<p>
Warning: after calling this function, make sure to call <a class="el" href="group__brlapi__keys.html#g51f541d3e9e1a797a4e4c5ef884f02cb">brlapi_ignoreKeys()</a> for ignoring important keys like BRL_CMD_SWITCHVT_PREV/NEXT and such.
</div>
</div><p>
<a class="anchor" name="gbdb9c75bc336c166b41d6b820e7e242c"></a><!-- doxytag: member="brlapi.h::brlapi_ignoreAllKeys" ref="gbdb9c75bc336c166b41d6b820e7e242c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi_ignoreAllKeys </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td> brlapi_ignoreKeys(brlapi_rangeType_all, NULL, 0)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Ignore all key presses from the braille keyboard<p>
This function asks the server to give all keys to <em>brltty</em>, rather than returning them to the application via <a class="el" href="group__brlapi__keys.html#g3b5ba0c43d48792e7071e772b50b9cbe">brlapi_readKey()</a>.
</div>
</div><p>
<a class="anchor" name="gf17304a5f4afe60a423fd3f922d9f9b7"></a><!-- doxytag: member="brlapi.h::BRLAPI_UC_ROW" ref="gf17304a5f4afe60a423fd3f922d9f9b7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BRLAPI_UC_ROW 0x2800UL </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Unicode braille row
</div>
</div><p>
<hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="g04da4d59bcca169be939b8ebfc274bd2"></a><!-- doxytag: member="brlapi.h::brlapi_rangeType_t" ref="g04da4d59bcca169be939b8ebfc274bd2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__brlapi__keys.html#g04da4d59bcca169be939b8ebfc274bd2">brlapi_rangeType_t</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
types of key ranges <dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="gg04da4d59bcca169be939b8ebfc274bd234074d26f350d14b438c402d7ff51b8b"></a><!-- doxytag: member="brlapi_rangeType_all" ref="gg04da4d59bcca169be939b8ebfc274bd234074d26f350d14b438c402d7ff51b8b" args="" -->brlapi_rangeType_all</em> </td><td>
all keys, code must be 0 </td></tr>
<tr><td valign="top"><em><a class="anchor" name="gg04da4d59bcca169be939b8ebfc274bd2740dd33effeed51f37cb29bb4fe5d6b8"></a><!-- doxytag: member="brlapi_rangeType_type" ref="gg04da4d59bcca169be939b8ebfc274bd2740dd33effeed51f37cb29bb4fe5d6b8" args="" -->brlapi_rangeType_type</em> </td><td>
all keys of a given type </td></tr>
<tr><td valign="top"><em><a class="anchor" name="gg04da4d59bcca169be939b8ebfc274bd26c5a9cea072b66fe0e5ad3e9d52b03e7"></a><!-- doxytag: member="brlapi_rangeType_command" ref="gg04da4d59bcca169be939b8ebfc274bd26c5a9cea072b66fe0e5ad3e9d52b03e7" args="" -->brlapi_rangeType_command</em> </td><td>
all keys of a given command block, i.e. matching the key type and command parts </td></tr>
<tr><td valign="top"><em><a class="anchor" name="gg04da4d59bcca169be939b8ebfc274bd23ea0b1512b6fc33cab1e9d5726a4e4de"></a><!-- doxytag: member="brlapi_rangeType_key" ref="gg04da4d59bcca169be939b8ebfc274bd23ea0b1512b6fc33cab1e9d5726a4e4de" args="" -->brlapi_rangeType_key</em> </td><td>
a given key with any flags </td></tr>
<tr><td valign="top"><em><a class="anchor" name="gg04da4d59bcca169be939b8ebfc274bd2805970686b12dbcc77c2e1c4f12a635b"></a><!-- doxytag: member="brlapi_rangeType_code" ref="gg04da4d59bcca169be939b8ebfc274bd2805970686b12dbcc77c2e1c4f12a635b" args="" -->brlapi_rangeType_code</em> </td><td>
a given key code </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="gfd425b67454237b5d35b4b5e5f5d92d9"></a><!-- doxytag: member="brlapi.h::brlapi__acceptAllKeys" ref="gfd425b67454237b5d35b4b5e5f5d92d9" args="(brlapi_handle_t *handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi__acceptAllKeys </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__brlapi__handles.html#g57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> * </td>
<td class="paramname"> <em>handle</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="gc131789506dfaa26094496dfe52358e4"></a><!-- doxytag: member="brlapi.h::brlapi__acceptKeyRanges" ref="gc131789506dfaa26094496dfe52358e4" args="(brlapi_handle_t *handle, brlapi_range_t ranges[], unsigned int count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi__acceptKeyRanges </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__brlapi__handles.html#g57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> * </td>
<td class="paramname"> <em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structbrlapi__range__t.html">brlapi_range_t</a> </td>
<td class="paramname"> <em>ranges</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>count</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="g0e76fb5ffa4547ccbe54e1a09d562b0a"></a><!-- doxytag: member="brlapi.h::brlapi__acceptKeys" ref="g0e76fb5ffa4547ccbe54e1a09d562b0a" args="(brlapi_handle_t *handle, brlapi_rangeType_t type, const brlapi_keyCode_t keys[], unsigned int count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi__acceptKeys </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__brlapi__handles.html#g57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> * </td>
<td class="paramname"> <em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__brlapi__keys.html#g04da4d59bcca169be939b8ebfc274bd2">brlapi_rangeType_t</a> </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__brlapi__keycodes.html#g956fddb34f9b399e884b1fafdb037b6a">brlapi_keyCode_t</a> </td>
<td class="paramname"> <em>keys</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>count</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="ge0bc6b3628c42fa6387f3a398e424932"></a><!-- doxytag: member="brlapi.h::brlapi__ignoreAllKeys" ref="ge0bc6b3628c42fa6387f3a398e424932" args="(brlapi_handle_t *handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi__ignoreAllKeys </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__brlapi__handles.html#g57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> * </td>
<td class="paramname"> <em>handle</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="gd4de372b84bf12ec74cda2e59da31b8f"></a><!-- doxytag: member="brlapi.h::brlapi__ignoreKeyRanges" ref="gd4de372b84bf12ec74cda2e59da31b8f" args="(brlapi_handle_t *handle, brlapi_range_t ranges[], unsigned int count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi__ignoreKeyRanges </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__brlapi__handles.html#g57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> * </td>
<td class="paramname"> <em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structbrlapi__range__t.html">brlapi_range_t</a> </td>
<td class="paramname"> <em>ranges</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>count</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="g6bd1a8af2c1d1b09a55d5647fbc9e035"></a><!-- doxytag: member="brlapi.h::brlapi__ignoreKeys" ref="g6bd1a8af2c1d1b09a55d5647fbc9e035" args="(brlapi_handle_t *handle, brlapi_rangeType_t type, const brlapi_keyCode_t keys[], unsigned int count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi__ignoreKeys </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__brlapi__handles.html#g57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> * </td>
<td class="paramname"> <em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__brlapi__keys.html#g04da4d59bcca169be939b8ebfc274bd2">brlapi_rangeType_t</a> </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__brlapi__keycodes.html#g956fddb34f9b399e884b1fafdb037b6a">brlapi_keyCode_t</a> </td>
<td class="paramname"> <em>keys</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>count</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="g557d77c4e1bf70a0d01b619aea152120"></a><!-- doxytag: member="brlapi.h::brlapi__readKey" ref="g557d77c4e1bf70a0d01b619aea152120" args="(brlapi_handle_t *handle, int wait, brlapi_keyCode_t *code)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi__readKey </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__brlapi__handles.html#g57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> * </td>
<td class="paramname"> <em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>wait</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__brlapi__keycodes.html#g956fddb34f9b399e884b1fafdb037b6a">brlapi_keyCode_t</a> * </td>
<td class="paramname"> <em>code</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="gfef1d9fd59fed736d1cdc50e0352aabb"></a><!-- doxytag: member="brlapi.h::brlapi_acceptKeyRanges" ref="gfef1d9fd59fed736d1cdc50e0352aabb" args="(brlapi_range_t ranges[], unsigned int count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi_acceptKeyRanges </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structbrlapi__range__t.html">brlapi_range_t</a> </td>
<td class="paramname"> <em>ranges</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>count</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Accept some key presses from the braille keyboard<p>
This function asks the server to return the provided key ranges (inclusive) to the application, and not give them to <em>brltty</em>.<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>ranges</em> </td><td>key ranges, which are inclusive </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>number of ranges</td></tr>
</table>
</dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>The given codes should be raw keycodes (i.e. some driver name was given to <a class="el" href="group__brlapi__tty.html#g6d8ae822fa87d9bfb1fb15ecf2bbcaac">brlapi_enterTtyMode()</a>) </dd></dl>
</div>
</div><p>
<a class="anchor" name="g15399581e093fc1635c53f4815fae551"></a><!-- doxytag: member="brlapi.h::brlapi_acceptKeys" ref="g15399581e093fc1635c53f4815fae551" args="(brlapi_rangeType_t type, const brlapi_keyCode_t keys[], unsigned int count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi_acceptKeys </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__brlapi__keys.html#g04da4d59bcca169be939b8ebfc274bd2">brlapi_rangeType_t</a> </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__brlapi__keycodes.html#g956fddb34f9b399e884b1fafdb037b6a">brlapi_keyCode_t</a> </td>
<td class="paramname"> <em>keys</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>count</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Accept some key presses from the braille keyboard<p>
This function asks the server to give the provided keys to the application, and not give them to <em>brltty</em>.<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>type of keys to be ignored </td></tr>
<tr><td valign="top"></td><td valign="top"><em>keys</em> </td><td>array of keys to be ignored </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>number of keys</td></tr>
</table>
</dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>The given codes should be <em>brltty</em> commands (NULL or "" was given to <a class="el" href="group__brlapi__tty.html#g6d8ae822fa87d9bfb1fb15ecf2bbcaac">brlapi_enterTtyMode()</a>) </dd></dl>
</div>
</div><p>
<a class="anchor" name="g27cd6a123ab9c8685055b72e0481067d"></a><!-- doxytag: member="brlapi.h::brlapi_describeKeyCode" ref="g27cd6a123ab9c8685055b72e0481067d" args="(brlapi_keyCode_t code, brlapi_describedKeyCode_t *description)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi_describeKeyCode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__brlapi__keycodes.html#g956fddb34f9b399e884b1fafdb037b6a">brlapi_keyCode_t</a> </td>
<td class="paramname"> <em>code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structbrlapi__describedKeyCode__t.html">brlapi_describedKeyCode_t</a> * </td>
<td class="paramname"> <em>description</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Describe the components of a key code.<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>code</em> </td><td>the keycode to be described </td></tr>
<tr><td valign="top"></td><td valign="top"><em>description</em> </td><td>pointer to the structure that receives the description</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, -1 on error </dd></dl>
</div>
</div><p>
<a class="anchor" name="gfdac75a70de34360e62bd17cddaecb5d"></a><!-- doxytag: member="brlapi.h::brlapi_expandKeyCode" ref="gfdac75a70de34360e62bd17cddaecb5d" args="(brlapi_keyCode_t code, brlapi_expandedKeyCode_t *expansion)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi_expandKeyCode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__brlapi__keycodes.html#g956fddb34f9b399e884b1fafdb037b6a">brlapi_keyCode_t</a> </td>
<td class="paramname"> <em>code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structbrlapi__expandedKeyCode__t.html">brlapi_expandedKeyCode_t</a> * </td>
<td class="paramname"> <em>expansion</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Expand the components of a key code<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>code</em> </td><td>the key code to be expanded </td></tr>
<tr><td valign="top"></td><td valign="top"><em>expansion</em> </td><td>pointer to the structure that receives the components</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, -1 on error </dd></dl>
</div>
</div><p>
<a class="anchor" name="g3ccaf06f70f11b9364a4610752f26c9e"></a><!-- doxytag: member="brlapi.h::brlapi_ignoreKeyRanges" ref="g3ccaf06f70f11b9364a4610752f26c9e" args="(brlapi_range_t ranges[], unsigned int count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi_ignoreKeyRanges </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structbrlapi__range__t.html">brlapi_range_t</a> </td>
<td class="paramname"> <em>ranges</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>count</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Ignore some key presses from the braille keyboard<p>
This function asks the server to give the provided key ranges to <em>brltty</em>, rather than returning them to the application via <a class="el" href="group__brlapi__keys.html#g3b5ba0c43d48792e7071e772b50b9cbe">brlapi_readKey()</a>.<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>ranges</em> </td><td>key ranges, which are inclusive </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>number of ranges</td></tr>
</table>
</dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>The given codes should be raw keycodes (i.e. some driver name was given to <a class="el" href="group__brlapi__tty.html#g6d8ae822fa87d9bfb1fb15ecf2bbcaac">brlapi_enterTtyMode()</a>) </dd></dl>
</div>
</div><p>
<a class="anchor" name="g51f541d3e9e1a797a4e4c5ef884f02cb"></a><!-- doxytag: member="brlapi.h::brlapi_ignoreKeys" ref="g51f541d3e9e1a797a4e4c5ef884f02cb" args="(brlapi_rangeType_t type, const brlapi_keyCode_t keys[], unsigned int count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi_ignoreKeys </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__brlapi__keys.html#g04da4d59bcca169be939b8ebfc274bd2">brlapi_rangeType_t</a> </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__brlapi__keycodes.html#g956fddb34f9b399e884b1fafdb037b6a">brlapi_keyCode_t</a> </td>
<td class="paramname"> <em>keys</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>count</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Ignore some key presses from the braille keyboard<p>
This function asks the server to give the provided keys to <em>brltty</em>, rather than returning them to the application via <a class="el" href="group__brlapi__keys.html#g3b5ba0c43d48792e7071e772b50b9cbe">brlapi_readKey()</a>.<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>type of keys to be ignored </td></tr>
<tr><td valign="top"></td><td valign="top"><em>keys</em> </td><td>array of keys to be ignored </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>number of keys</td></tr>
</table>
</dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>The given codes should be <em>brltty</em> commands (NULL or "" was given to <a class="el" href="group__brlapi__tty.html#g6d8ae822fa87d9bfb1fb15ecf2bbcaac">brlapi_enterTtyMode()</a>) </dd></dl>
</div>
</div><p>
<a class="anchor" name="g3b5ba0c43d48792e7071e772b50b9cbe"></a><!-- doxytag: member="brlapi.h::brlapi_readKey" ref="g3b5ba0c43d48792e7071e772b50b9cbe" args="(int wait, brlapi_keyCode_t *code)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BRLAPI_STDCALL brlapi_readKey </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>wait</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__brlapi__keycodes.html#g956fddb34f9b399e884b1fafdb037b6a">brlapi_keyCode_t</a> * </td>
<td class="paramname"> <em>code</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Read a key from the braille keyboard<p>
This function returns one key press's code.<p>
If NULL or "" was given to <a class="el" href="group__brlapi__tty.html#g6d8ae822fa87d9bfb1fb15ecf2bbcaac">brlapi_enterTtyMode()</a>, a <em>brltty</em> command is returned, as described in <code><brltty/brldefs.h></code> . It is hence pretty driver-independent, and should be used by default when no other option is possible.<p>
By default, all commands but those which restart drivers and switch virtual terminals are returned to the application and not to brltty. If the application doesn't want to see some command events, it should call <a class="el" href="group__brlapi__keys.html#g51f541d3e9e1a797a4e4c5ef884f02cb">brlapi_ignoreKeys()</a><p>
If some driver name was given to <a class="el" href="group__brlapi__tty.html#g6d8ae822fa87d9bfb1fb15ecf2bbcaac">brlapi_enterTtyMode()</a>, a raw keycode is returned, as specified by the terminal driver, usually in <brltty/brldefs-xy> where xy is the driver's code. It generally corresponds to the very code that the terminal tells to the driver. This should only be used by applications which are dedicated to a particular braille terminal. Hence, checking the terminal type thanks to a call to <a class="el" href="group__brlapi__info.html#g2dcd2285e75571a861c1f9c27a44bd0f">brlapi_getDriverName()</a> before getting tty control is a pretty good idea.<p>
By default, all the keypresses will be passed to the client, none will go through brltty, so the application will have to handle console switching itself for instance.<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>wait</em> </td><td>tells whether the call should block until a key is pressed (1) or should only probe key presses (0); </td></tr>
<tr><td valign="top"></td><td valign="top"><em>code</em> </td><td>holds the key code if a key press is indeed read.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>-1 on error or signal interrupt and *code is then undefined, 0 if block was 0 and no key was pressed so far, or 1 and *code holds the key code.</dd></dl>
Programming hints:<p>
If your application is only driven by braille command keypresses, you can just call brlapi_readKey(1, &code) so that it keeps blocking, waiting for keypresses.<p>
Else, you'll probably want to use the file descriptor returned by <a class="el" href="group__brlapi__connection.html#gcd26dc42640bdad09a389be10b9e3618">brlapi_openConnection()</a> in your "big polling loop". For instance:<p>
<ul>
<li>in a <code>select()</code> loop, just add it to the <code>readfds</code> and <code>exceptfds</code> file descriptor sets;</li><li>in a gtk or atspi application, use <code>g_io_add_watch</code>(fileDescriptor, <code>G_IO_IN|G_IO_ERR|G_IO_HUP</code>, <code>f</code>, <code>data</code>) for adding a callback called <code>f</code>;</li><li>in an Xt/Xaw/motif-based application, use <code>XtAppAddInput</code>(app_context, <code>fileDescriptor</code>, <code>XtInputReadMask|XtInputExceptMask</code>, <code>f</code>, <code>data</code>)</li><li>etc.</li></ul>
<p>
and then, when you detect inbound trafic on the file descriptor, do something like this:<p>
while (brlapi_readKey(0, &code) { // process keycode code // ... }<p>
The <code>while</code> loop is needed for processing <em>all</em> pending key presses, else some of them may be left in libbrlapi's internal key buffer and you wouldn't get them immediately.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>If the read is interrupted by a signal, <a class="el" href="group__brlapi__keys.html#g3b5ba0c43d48792e7071e772b50b9cbe">brlapi_readKey()</a> will return -1, brlapi_errno will be BRLAPI_ERROR_LIBCERR and errno will be EINTR. </dd></dl>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 7 22:37:56 2009 for BrlAPI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
78cff6a8ec39f0e621e35b5f5c351f9d
>
files
>
47
