<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qkbd_qws.cpp -->
<title>Qt 4.8: QWSKeyboardHandler Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtgui.html">QtGui</a></li>
<li>QWSKeyboardHandler</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QWSKeyboardHandler Class Reference</h1>
<!-- $$$QWSKeyboardHandler-brief -->
<p>The QWSKeyboardHandler class is a base class for keyboard drivers in Qt for Embedded Linux. <a href="#details">More...</a></p>
<!-- @@@QWSKeyboardHandler -->
<pre class="cpp"> <span class="preprocessor">#include <QWSKeyboardHandler></span></pre><ul>
<li><a href="qwskeyboardhandler-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qwskeyboardhandler.html#KeycodeAction-enum">KeycodeAction</a></b> { None, CapsLockOn, CapsLockOff, NumLockOn, ..., Reboot }</td></tr>
</table>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qwskeyboardhandler.html#QWSKeyboardHandler">QWSKeyboardHandler</a></b> ( const QString & <i>device</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qwskeyboardhandler.html#QWSKeyboardHandler-2">QWSKeyboardHandler</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qwskeyboardhandler.html#dtor.QWSKeyboardHandler">~QWSKeyboardHandler</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qwskeyboardhandler.html#processKeyEvent">processKeyEvent</a></b> ( int <i>unicode</i>, int <i>keycode</i>, Qt::KeyboardModifiers <i>modifiers</i>, bool <i>isPress</i>, bool <i>autoRepeat</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> KeycodeAction </td><td class="memItemRight bottomAlign"><b><a href="qwskeyboardhandler.html#processKeycode">processKeycode</a></b> ( quint16 <i>keycode</i>, bool <i>isPress</i>, bool <i>autoRepeat</i> )</td></tr>
</table>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwskeyboardhandler.html#beginAutoRepeat">beginAutoRepeat</a></b> ( int <i>unicode</i>, int <i>keycode</i>, Qt::KeyboardModifiers <i>modifier</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwskeyboardhandler.html#endAutoRepeat">endAutoRepeat</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qwskeyboardhandler.html#transformDirKey">transformDirKey</a></b> ( int <i>keycode</i> )</td></tr>
</table>
<a name="details"></a>
<!-- $$$QWSKeyboardHandler-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QWSKeyboardHandler class is a base class for keyboard drivers in Qt for Embedded Linux.</p>
<p>Note that this class is only available in <a href="qt-embedded-linux.html">Qt for Embedded Linux</a>.</p>
<p><a href="qt-embedded-linux.html">Qt for Embedded Linux</a> provides ready-made drivers for several keyboard protocols, see the <a href="qt-embedded-charinput.html">character input</a> documentation for details. Custom keyboard drivers can be implemented by subclassing the QWSKeyboardHandler class and creating a keyboard driver plugin (derived from <a href="qkbddriverplugin.html">QKbdDriverPlugin</a>). The default implementation of the <a href="qkbddriverfactory.html">QKbdDriverFactory</a> class will automatically detect the plugin, and load the driver into the server application at run-time using Qt's <a href="plugins-howto.html">plugin system</a>.</p>
<p>The keyboard driver receives keyboard events from the system device and encapsulates each event with an instance of the <a href="qwsevent.html">QWSEvent</a> class which it then passes to the server application (the server is responsible for propagating the event to the appropriate client). To receive keyboard events, a QWSKeyboardHandler object will usually create a <a href="qsocketnotifier.html">QSocketNotifier</a> object for the given device. The <a href="qsocketnotifier.html">QSocketNotifier</a> class provides support for monitoring activity on a file descriptor. When the socket notifier receives data, it will call the keyboard driver's <a href="qwskeyboardhandler.html#processKeyEvent">processKeyEvent</a>() function to send the event to the <a href="qt-embedded-linux.html">Qt for Embedded Linux</a> server application for relaying to clients.</p>
<p>QWSKeyboardHandler also provides functions to control auto-repetion of key sequences, <a href="qwskeyboardhandler.html#beginAutoRepeat">beginAutoRepeat</a>() and <a href="qwskeyboardhandler.html#endAutoRepeat">endAutoRepeat</a>(), and the <a href="qwskeyboardhandler.html#transformDirKey">transformDirKey</a>() function enabling transformation of arrow keys according to the display orientation.</p>
</div>
<p><b>See also </b><a href="qkbddriverplugin.html">QKbdDriverPlugin</a>, <a href="qkbddriverfactory.html">QKbdDriverFactory</a>, and <a href="qt-embedded-charinput.html">Qt for Embedded Linux Character Input</a>.</p>
<!-- @@@QWSKeyboardHandler -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$KeycodeAction$$$None$$$CapsLockOff$$$CapsLockOn$$$NumLockOff$$$NumLockOn$$$ScrollLockOff$$$ScrollLockOn$$$Reboot$$$PreviousConsole$$$NextConsole$$$SwitchConsoleFirst$$$SwitchConsoleLast$$$SwitchConsoleMask -->
<h3 class="fn"><a name="KeycodeAction-enum"></a>enum QWSKeyboardHandler::<span class="name">KeycodeAction</span></h3>
<p>This enum describes the various special actions that actual <a href="qwskeyboardhandler.html">QWSKeyboardHandler</a> implementations have to take care of.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QWSKeyboardHandler::None</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">No further action required.</td></tr>
<tr><td class="topAlign"><tt>QWSKeyboardHandler::CapsLockOn</tt></td><td class="topAlign"><tt>0x01000001</tt></td><td class="topAlign">Set the state of the Caps lock LED to on.</td></tr>
<tr><td class="topAlign"><tt>QWSKeyboardHandler::CapsLockOff</tt></td><td class="topAlign"><tt>0x01000000</tt></td><td class="topAlign">Set the state of the Caps lock LED to off.</td></tr>
<tr><td class="topAlign"><tt>QWSKeyboardHandler::NumLockOn</tt></td><td class="topAlign"><tt>0x02000001</tt></td><td class="topAlign">Set the state of the Num lock LED to on.</td></tr>
<tr><td class="topAlign"><tt>QWSKeyboardHandler::NumLockOff</tt></td><td class="topAlign"><tt>0x02000000</tt></td><td class="topAlign">Set the state of the Num lock LED to off.</td></tr>
<tr><td class="topAlign"><tt>QWSKeyboardHandler::ScrollLockOn</tt></td><td class="topAlign"><tt>0x03000001</tt></td><td class="topAlign">Set the state of the Scroll lock LED to on.</td></tr>
<tr><td class="topAlign"><tt>QWSKeyboardHandler::ScrollLockOff</tt></td><td class="topAlign"><tt>0x03000000</tt></td><td class="topAlign">Set the state of the Scroll lock LED to off.</td></tr>
<tr><td class="topAlign"><tt>QWSKeyboardHandler::PreviousConsole</tt></td><td class="topAlign"><tt>0x05000000</tt></td><td class="topAlign">Switch to the previous virtual console (by default Ctrl+Alt+Left on Linux).</td></tr>
<tr><td class="topAlign"><tt>QWSKeyboardHandler::NextConsole</tt></td><td class="topAlign"><tt>0x05000001</tt></td><td class="topAlign">Switch to the next virtual console (by default Ctrl+Alt+Right on Linux).</td></tr>
<tr><td class="topAlign"><tt>QWSKeyboardHandler::SwitchConsoleFirst</tt></td><td class="topAlign"><tt>0x06000000</tt></td><td class="topAlign">Switch to the first virtual console (0).</td></tr>
<tr><td class="topAlign"><tt>QWSKeyboardHandler::SwitchConsoleLast</tt></td><td class="topAlign"><tt>0x0600007f</tt></td><td class="topAlign">Switch to the last virtual console (255).</td></tr>
<tr><td class="topAlign"><tt>QWSKeyboardHandler::SwitchConsoleMask</tt></td><td class="topAlign"><tt>0x0000007f</tt></td><td class="topAlign">If the KeyAction value is between SwitchConsoleFirst and SwitchConsoleLast, you can use this mask to get the specific virtual console number to switch to.</td></tr>
<tr><td class="topAlign"><tt>QWSKeyboardHandler::Reboot</tt></td><td class="topAlign"><tt>0x04000000</tt></td><td class="topAlign">Reboot the machine - this is ignored in both the TTY and LinuxInput handlers though (by default Ctrl+Alt+Del on Linux).</td></tr>
</table>
<p><b>See also </b><a href="qwskeyboardhandler.html#processKeycode">processKeycode</a>().</p>
<!-- @@@KeycodeAction -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QWSKeyboardHandler[overload1]$$$QWSKeyboardHandlerconstQString& -->
<h3 class="fn"><a name="QWSKeyboardHandler"></a>QWSKeyboardHandler::<span class="name">QWSKeyboardHandler</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>device</i> )</h3>
<p>Constructs a keyboard driver. The <i>device</i> argument is passed by the <a href="qt-embedded-envvars.html#qws-keyboard">QWS_KEYBOARD</a> environment variable.</p>
<p>Call the <a href="qwsserver.html#setKeyboardHandler">QWSServer::setKeyboardHandler</a>() function to make the newly created keyboard driver, the primary driver. Note that the primary driver is controlled by the system, i.e., the system will delete it upon exit.</p>
<!-- @@@QWSKeyboardHandler -->
<!-- $$$QWSKeyboardHandler$$$QWSKeyboardHandler -->
<h3 class="fn"><a name="QWSKeyboardHandler-2"></a>QWSKeyboardHandler::<span class="name">QWSKeyboardHandler</span> ()</h3>
<p>This is an overloaded function.</p>
<!-- @@@QWSKeyboardHandler -->
<!-- $$$~QWSKeyboardHandler[overload1]$$$~QWSKeyboardHandler -->
<h3 class="fn"><a name="dtor.QWSKeyboardHandler"></a>QWSKeyboardHandler::<span class="name">~QWSKeyboardHandler</span> ()<tt> [virtual]</tt></h3>
<p>Destroys this keyboard driver.</p>
<p>Do not call this function if this driver is the primary keyboard handler, i.e., if <a href="qwsserver.html#setKeyboardHandler">QWSServer::setKeyboardHandler</a>() function has been called passing this driver as argument. The primary keyboard driver is deleted by the system.</p>
<!-- @@@~QWSKeyboardHandler -->
<!-- $$$beginAutoRepeat[overload1]$$$beginAutoRepeatintintQt::KeyboardModifiers -->
<h3 class="fn"><a name="beginAutoRepeat"></a><span class="type">void</span> QWSKeyboardHandler::<span class="name">beginAutoRepeat</span> ( <span class="type">int</span> <i>unicode</i>, <span class="type">int</span> <i>keycode</i>, <span class="type"><a href="qt.html#KeyboardModifier-enum">Qt::KeyboardModifiers</a></span> <i>modifier</i> )<tt> [protected]</tt></h3>
<p>Begins auto-repeating the specified key press; after a short delay the key press is sent periodically until the <a href="qwskeyboardhandler.html#endAutoRepeat">endAutoRepeat</a>() function is called.</p>
<p>The key press is specified by its <i>unicode</i>, <i>keycode</i> and <i>modifier</i> state.</p>
<p><b>See also </b><a href="qwskeyboardhandler.html#endAutoRepeat">endAutoRepeat</a>() and <a href="qwskeyboardhandler.html#processKeyEvent">processKeyEvent</a>().</p>
<!-- @@@beginAutoRepeat -->
<!-- $$$endAutoRepeat[overload1]$$$endAutoRepeat -->
<h3 class="fn"><a name="endAutoRepeat"></a><span class="type">void</span> QWSKeyboardHandler::<span class="name">endAutoRepeat</span> ()<tt> [protected]</tt></h3>
<p>Stops auto-repeating a key press.</p>
<p><b>See also </b><a href="qwskeyboardhandler.html#beginAutoRepeat">beginAutoRepeat</a>() and <a href="qwskeyboardhandler.html#processKeyEvent">processKeyEvent</a>().</p>
<!-- @@@endAutoRepeat -->
<!-- $$$processKeyEvent[overload1]$$$processKeyEventintintQt::KeyboardModifiersboolbool -->
<h3 class="fn"><a name="processKeyEvent"></a><span class="type">void</span> QWSKeyboardHandler::<span class="name">processKeyEvent</span> ( <span class="type">int</span> <i>unicode</i>, <span class="type">int</span> <i>keycode</i>, <span class="type"><a href="qt.html#KeyboardModifier-enum">Qt::KeyboardModifiers</a></span> <i>modifiers</i>, <span class="type">bool</span> <i>isPress</i>, <span class="type">bool</span> <i>autoRepeat</i> )<tt> [virtual]</tt></h3>
<p>Sends a key event to the <a href="qt-embedded-linux.html">Qt for Embedded Linux</a> server application.</p>
<p>The key event is identified by its <i>unicode</i> value and the <i>keycode</i>, <i>modifiers</i>, <i>isPress</i> and <i>autoRepeat</i> parameters.</p>
<p>The <i>keycode</i> parameter is the Qt keycode value as defined by the <a href="qt.html#Key-enum">Qt::Key</a> enum. The <i>modifiers</i> is an OR combination of <a href="qt.html#KeyboardModifier-enum">Qt::KeyboardModifier</a> values, indicating whether <b>Shift/Alt/Ctrl</b> keys are pressed. The <i>isPress</i> parameter is true if the event is a key press event and <i>autoRepeat</i> is true if the event is caused by an auto-repeat mechanism and not an actual key press.</p>
<p>Note that this function does not handle key mapping. Please use <a href="qwskeyboardhandler.html#processKeycode">processKeycode</a>() if you need that functionality.</p>
<p><b>See also </b><a href="qwskeyboardhandler.html#processKeycode">processKeycode</a>(), <a href="qwskeyboardhandler.html#beginAutoRepeat">beginAutoRepeat</a>(), <a href="qwskeyboardhandler.html#endAutoRepeat">endAutoRepeat</a>(), and <a href="qwskeyboardhandler.html#transformDirKey">transformDirKey</a>().</p>
<!-- @@@processKeyEvent -->
<!-- $$$processKeycode[overload1]$$$processKeycodequint16boolbool -->
<h3 class="fn"><a name="processKeycode"></a><span class="type"><a href="qwskeyboardhandler.html#KeycodeAction-enum">KeycodeAction</a></span> QWSKeyboardHandler::<span class="name">processKeycode</span> ( <span class="type"><a href="qtglobal.html#quint16-typedef">quint16</a></span> <i>keycode</i>, <span class="type">bool</span> <i>isPress</i>, <span class="type">bool</span> <i>autoRepeat</i> )</h3>
<p>Maps <i>keycode</i> according to a keymap and sends that key event to the <a href="qt-embedded-linux.html">Qt for Embedded Linux</a> server application.</p>
<p>Please see the <a href="qt-embedded-charinput.html">Qt for Embedded Linux Character Input</a> and the <a href="qt-embedded-kmap2qmap.html">kmap2qmap</a> documentations for a description on how to create and use keymap files.</p>
<p>The key event is identified by its <i>keycode</i> value and the <i>isPress</i> and <i>autoRepeat</i> parameters.</p>
<p>The <i>keycode</i> parameter is <b>NOT</b> the Qt keycode value as defined by the <a href="qt.html#Key-enum">Qt::Key</a> enum. This functions expects a standard Linux 16 bit kernel keycode as it is used in the Linux Input Event sub-system. This <i>keycode</i> is transformed to a <a href="qt.html#Key-enum">Qt::Key</a> code by using either a compiled-in US keyboard layout or by dynamically loading a keymap at startup which can be specified via the <a href="qt-embedded-envvars.html#qws-keyboard">QWS_KEYBOARD</a> environment variable.</p>
<p>The <i>isPress</i> parameter is true if the event is a key press event and <i>autoRepeat</i> is true if the event is caused by an auto-repeat mechanism and not an actual key press.</p>
<p>The return value indicates if the actual <a href="qwskeyboardhandler.html">QWSKeyboardHandler</a> implementation needs to take care of a special action, like console switching or LED handling.</p>
<p>If standard Linux console keymaps are used, <i>keycode</i> must be one of the standardized values defined in <tt>/usr/include/linux/input.h</tt></p>
<p>This function was introduced in Qt 4.6.</p>
<p><b>See also </b><a href="qwskeyboardhandler.html#processKeyEvent">processKeyEvent</a>() and <a href="qwskeyboardhandler.html#KeycodeAction-enum">KeycodeAction</a>.</p>
<!-- @@@processKeycode -->
<!-- $$$transformDirKey[overload1]$$$transformDirKeyint -->
<h3 class="fn"><a name="transformDirKey"></a><span class="type">int</span> QWSKeyboardHandler::<span class="name">transformDirKey</span> ( <span class="type">int</span> <i>keycode</i> )<tt> [protected]</tt></h3>
<p>Transforms the arrow key specified by the given <i>keycode</i>, to the orientation of the display and returns the transformed keycode.</p>
<p>The <i>keycode</i> is a <a href="qt.html#Key-enum">Qt::Key</a> value. The values identifying arrow keys are:</p>
<ul>
<li><a href="qt.html#Key-enum">Qt::Key_Left</a></li>
<li><a href="qt.html#Key-enum">Qt::Key_Up</a></li>
<li><a href="qt.html#Key-enum">Qt::Key_Right</a></li>
<li><a href="qt.html#Key-enum">Qt::Key_Down</a></li>
</ul>
<p><b>See also </b><a href="qwskeyboardhandler.html#processKeyEvent">processKeyEvent</a>().</p>
<!-- @@@transformDirKey -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Qt and respective logos are trademarks of The Qt Company Ltd
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
