<!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"/>
<title>Wt: Wt::WKeyEvent Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Wt
 <span id="projectnumber">3.2.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.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 Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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 List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceWt.html">Wt</a> </li>
<li class="navelem"><a class="el" href="classWt_1_1WKeyEvent.html">WKeyEvent</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::WKeyEvent Class Reference<div class="ingroups"><a class="el" href="group__signalslot.html">Signal/slot system</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::WKeyEvent" -->
<p>A class providing details for a keyboard event.
<a href="classWt_1_1WKeyEvent.html#details">More...</a></p>
<p><code>#include <Wt/WEvent></code></p>
<p><a href="classWt_1_1WKeyEvent-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a93efdf1091659752a18f107f2c7612e8"></a><!-- doxytag: member="Wt::WKeyEvent::WKeyEvent" ref="a93efdf1091659752a18f107f2c7612e8" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WKeyEvent.html#a93efdf1091659752a18f107f2c7612e8">WKeyEvent</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__signalslot.html#ga34e65660d30e69c56aa636a8856aa52d">Key</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WKeyEvent.html#a1a1dd4cf1ac3cc427505c2660cbf069d">key</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the key code key that was pressed or released. <a href="#a1a1dd4cf1ac3cc427505c2660cbf069d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">WFlags< <a class="el" href="group__signalslot.html#ga50f91169486bada5931f3adc3a623091">KeyboardModifier</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WKeyEvent.html#a56601dff9d7ed5ff5ff294f7025a6908">modifiers</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns keyboard modifiers. <a href="#a56601dff9d7ed5ff5ff294f7025a6908"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WKeyEvent.html#abe057e50123becd86400abeaea8b5e9e">charCode</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the unicode character code. <a href="#abe057e50123becd86400abeaea8b5e9e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WString.html">WString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WKeyEvent.html#aef6d350c375bd06e7df8aae0898aa744">text</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The (unicode) text that this key generated. <a href="#aef6d350c375bd06e7df8aae0898aa744"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WKeyEvent.html#a313eda54335c00c80827b39cdae15ef2">keyCode</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the raw key code (<b>deprecated</b>). <a href="#a313eda54335c00c80827b39cdae15ef2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WKeyEvent.html#a7d382409feb5545edb8bb0561a144006">altKey</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the alt key is pressed (<b>deprecated</b>). <a href="#a7d382409feb5545edb8bb0561a144006"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WKeyEvent.html#afb60842e8e3797a8d0079cf774b81496">metaKey</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the meta key is pressed (<b>deprecated</b>). <a href="#afb60842e8e3797a8d0079cf774b81496"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WKeyEvent.html#a334af6e260dda1c17e5876de7405851a">ctrlKey</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the control key is pressed (<b>deprecated</b>). <a href="#a334af6e260dda1c17e5876de7405851a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WKeyEvent.html#aef80abe3417494c7ef95066859bbf4f3">shiftKey</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the shift key is pressed (<b>deprecated</b>). <a href="#aef80abe3417494c7ef95066859bbf4f3"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A class providing details for a keyboard event. </p>
<p>A key event is associated with the <a class="el" href="classWt_1_1WInteractWidget.html#a8669f2d35aad5091837b97bd00f25223" title="Event signal emitted when a keyboard key is pushed down.">WInteractWidget::keyWentDown()</a>, <a class="el" href="classWt_1_1WInteractWidget.html#a7602bfbe38090d4acca674afc02f15c8" title="Event signal emitted when a keyboard key is released.">WInteractWidget::keyWentUp()</a> and <a class="el" href="classWt_1_1WInteractWidget.html#a6d4c957a92eb6ffec59a638dd384c6c9" title="Event signal emitted when a "character" was entered.">WInteractWidget::keyPressed()</a> signals. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7d382409feb5545edb8bb0561a144006"></a><!-- doxytag: member="Wt::WKeyEvent::altKey" ref="a7d382409feb5545edb8bb0561a144006" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WKeyEvent::altKey </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether the alt key is pressed (<b>deprecated</b>). </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000034">Deprecated:</a></b></dt><dd>Use <a class="el" href="classWt_1_1WKeyEvent.html#a56601dff9d7ed5ff5ff294f7025a6908" title="Returns keyboard modifiers.">modifiers()</a> instead. </dd></dl>
</div>
</div>
<a class="anchor" id="abe057e50123becd86400abeaea8b5e9e"></a><!-- doxytag: member="Wt::WKeyEvent::charCode" ref="abe057e50123becd86400abeaea8b5e9e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Wt::WKeyEvent::charCode </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the unicode character code. </p>
<p>This is only defined for a <a class="el" href="classWt_1_1WInteractWidget.html#a6d4c957a92eb6ffec59a638dd384c6c9">keyPressed </a> event, and returns the unicode character code point of a character that is entered.</p>
<p>For the <a class="el" href="classWt_1_1WInteractWidget.html#a8669f2d35aad5091837b97bd00f25223">keyWentDown </a> and <a class="el" href="classWt_1_1WInteractWidget.html#a7602bfbe38090d4acca674afc02f15c8">keyWentUp </a> events, '0' is returned.</p>
<p>The <a class="el" href="classWt_1_1WKeyEvent.html#abe057e50123becd86400abeaea8b5e9e" title="Returns the unicode character code.">charCode()</a> may be different from <a class="el" href="classWt_1_1WKeyEvent.html#a1a1dd4cf1ac3cc427505c2660cbf069d" title="Returns the key code key that was pressed or released.">key()</a>. For example, a <a class="el" href="group__signalslot.html#gga34e65660d30e69c56aa636a8856aa52da88915645dbc4db17dfe3308fb65e9127">Key_M</a> key may correspond to 'm' or 'M' character, depending on whether the shift key is pressed simultaneously.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WKeyEvent.html#a1a1dd4cf1ac3cc427505c2660cbf069d" title="Returns the key code key that was pressed or released.">key()</a>, <a class="el" href="classWt_1_1WKeyEvent.html#aef6d350c375bd06e7df8aae0898aa744" title="The (unicode) text that this key generated.">text()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a334af6e260dda1c17e5876de7405851a"></a><!-- doxytag: member="Wt::WKeyEvent::ctrlKey" ref="a334af6e260dda1c17e5876de7405851a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WKeyEvent::ctrlKey </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether the control key is pressed (<b>deprecated</b>). </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000036">Deprecated:</a></b></dt><dd>Use <a class="el" href="classWt_1_1WKeyEvent.html#a56601dff9d7ed5ff5ff294f7025a6908" title="Returns keyboard modifiers.">modifiers()</a> instead. </dd></dl>
</div>
</div>
<a class="anchor" id="a1a1dd4cf1ac3cc427505c2660cbf069d"></a><!-- doxytag: member="Wt::WKeyEvent::key" ref="a1a1dd4cf1ac3cc427505c2660cbf069d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__signalslot.html#ga34e65660d30e69c56aa636a8856aa52d">Key</a> Wt::WKeyEvent::key </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the key code key that was pressed or released. </p>
<p>The key code corresponds to the actual key on the keyboard, rather than the generated character.</p>
<p>All three types of key events provide this information.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WKeyEvent.html#a56601dff9d7ed5ff5ff294f7025a6908" title="Returns keyboard modifiers.">modifiers()</a>, <a class="el" href="classWt_1_1WKeyEvent.html#abe057e50123becd86400abeaea8b5e9e" title="Returns the unicode character code.">charCode()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a313eda54335c00c80827b39cdae15ef2"></a><!-- doxytag: member="Wt::WKeyEvent::keyCode" ref="a313eda54335c00c80827b39cdae15ef2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Wt::WKeyEvent::keyCode </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the raw key code (<b>deprecated</b>). </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000033">Deprecated:</a></b></dt><dd>The value returned is somewhat browser-specific, and it is therefore recommended to use the <a class="el" href="classWt_1_1WKeyEvent.html#a1a1dd4cf1ac3cc427505c2660cbf069d" title="Returns the key code key that was pressed or released.">key()</a> method instead.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WKeyEvent.html#a1a1dd4cf1ac3cc427505c2660cbf069d" title="Returns the key code key that was pressed or released.">key()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="afb60842e8e3797a8d0079cf774b81496"></a><!-- doxytag: member="Wt::WKeyEvent::metaKey" ref="afb60842e8e3797a8d0079cf774b81496" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WKeyEvent::metaKey </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether the meta key is pressed (<b>deprecated</b>). </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000035">Deprecated:</a></b></dt><dd>Use <a class="el" href="classWt_1_1WKeyEvent.html#a56601dff9d7ed5ff5ff294f7025a6908" title="Returns keyboard modifiers.">modifiers()</a> instead. </dd></dl>
</div>
</div>
<a class="anchor" id="a56601dff9d7ed5ff5ff294f7025a6908"></a><!-- doxytag: member="Wt::WKeyEvent::modifiers" ref="a56601dff9d7ed5ff5ff294f7025a6908" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">WFlags<<a class="el" href="group__signalslot.html#ga50f91169486bada5931f3adc3a623091">KeyboardModifier</a>> Wt::WKeyEvent::modifiers </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns keyboard modifiers. </p>
<p>The result is a logical OR of <a class="el" href="group__signalslot.html#ga50f91169486bada5931f3adc3a623091">KeyboardModifier</a> flags.</p>
<p>All three types of key events provide this information.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WKeyEvent.html#a1a1dd4cf1ac3cc427505c2660cbf069d" title="Returns the key code key that was pressed or released.">key()</a>, <a class="el" href="classWt_1_1WKeyEvent.html#abe057e50123becd86400abeaea8b5e9e" title="Returns the unicode character code.">charCode()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aef80abe3417494c7ef95066859bbf4f3"></a><!-- doxytag: member="Wt::WKeyEvent::shiftKey" ref="aef80abe3417494c7ef95066859bbf4f3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WKeyEvent::shiftKey </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether the shift key is pressed (<b>deprecated</b>). </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000037">Deprecated:</a></b></dt><dd>Use <a class="el" href="classWt_1_1WKeyEvent.html#a56601dff9d7ed5ff5ff294f7025a6908" title="Returns keyboard modifiers.">modifiers()</a> instead. </dd></dl>
</div>
</div>
<a class="anchor" id="aef6d350c375bd06e7df8aae0898aa744"></a><!-- doxytag: member="Wt::WKeyEvent::text" ref="aef6d350c375bd06e7df8aae0898aa744" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> Wt::WKeyEvent::text </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The (unicode) text that this key generated. </p>
<p>This is only defined for a <a class="el" href="classWt_1_1WInteractWidget.html#a6d4c957a92eb6ffec59a638dd384c6c9">keyPressed </a> event, and returns a string that holds exactly one unicode character, which corresponds to <a class="el" href="classWt_1_1WKeyEvent.html#abe057e50123becd86400abeaea8b5e9e" title="Returns the unicode character code.">charCode()</a>.</p>
<p>For the <a class="el" href="classWt_1_1WInteractWidget.html#a8669f2d35aad5091837b97bd00f25223">keyWentDown </a> and <a class="el" href="classWt_1_1WInteractWidget.html#a7602bfbe38090d4acca674afc02f15c8">keyWentUp </a> events, an empty string is returned.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WKeyEvent.html#abe057e50123becd86400abeaea8b5e9e" title="Returns the unicode character code.">charCode()</a> </dd></dl>
</div>
</div>
</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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</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>
<hr size="1"><address style="text-align: right; margin: 3px"><small>
Generated on Thu Nov 1 2012 for <a href="http://www.webtoolkit.eu/wt">the
C++ Web Toolkit (Wt)</a> by <a
href="http://www.doxygen.org/index.html"><img src="doxygen.png"
alt="doxygen" border="0" style="vertical-align: middle; display:
inline-block; height: 2em"></a> 1.7.5.1</small></address>
</body>
</html>
