DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF


			
				
					
						
						
							
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>DISTRHO Plugin Framework: Widget::KeyboardEvent Struct 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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">DISTRHO Plugin Framework
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</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 id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="classWidget.html">Widget</a></li><li class="navelem"><a class="el" href="structWidget_1_1KeyboardEvent.html">KeyboardEvent</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structWidget_1_1KeyboardEvent-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Widget::KeyboardEvent Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="Widget_8hpp_source.html">Widget.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Widget::KeyboardEvent:</div>
<div class="dyncontent">
 <div class="center">
  <img src="structWidget_1_1KeyboardEvent.png" usemap="#Widget::KeyboardEvent_map" alt=""/>
  <map id="Widget::KeyboardEvent_map" name="Widget::KeyboardEvent_map">
<area href="structWidget_1_1BaseEvent.html" alt="Widget::BaseEvent" shape="rect" coords="0,0,143,24"/>
  </map>
</div></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:a5a55a296264b9999a7915f2633eacb10"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1KeyboardEvent.html#a5a55a296264b9999a7915f2633eacb10">KeyboardEvent</a> () noexcept</td></tr>
<tr class="separator:a5a55a296264b9999a7915f2633eacb10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structWidget_1_1BaseEvent"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structWidget_1_1BaseEvent')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structWidget_1_1BaseEvent.html">Widget::BaseEvent</a></td></tr>
<tr class="memitem:a18c1114caca474cadefd9a13e2d9c693 inherit pub_methods_structWidget_1_1BaseEvent"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1BaseEvent.html#a18c1114caca474cadefd9a13e2d9c693">BaseEvent</a> () noexcept</td></tr>
<tr class="separator:a18c1114caca474cadefd9a13e2d9c693 inherit pub_methods_structWidget_1_1BaseEvent"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58da172316b49f6d79b879b74ce5792a inherit pub_methods_structWidget_1_1BaseEvent"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1BaseEvent.html#a58da172316b49f6d79b879b74ce5792a">~BaseEvent</a> () noexcept</td></tr>
<tr class="separator:a58da172316b49f6d79b879b74ce5792a inherit pub_methods_structWidget_1_1BaseEvent"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a8169fe04d78fb7bb4052ec7bc820da43"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1KeyboardEvent.html#a8169fe04d78fb7bb4052ec7bc820da43">press</a></td></tr>
<tr class="separator:a8169fe04d78fb7bb4052ec7bc820da43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a46cdbf1f69912c93deb649f756ec24f4"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1KeyboardEvent.html#a46cdbf1f69912c93deb649f756ec24f4">key</a></td></tr>
<tr class="separator:a46cdbf1f69912c93deb649f756ec24f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0db51894bdbda766c9596b226d04d8c3"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1KeyboardEvent.html#a0db51894bdbda766c9596b226d04d8c3">keycode</a></td></tr>
<tr class="separator:a0db51894bdbda766c9596b226d04d8c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_attribs_structWidget_1_1BaseEvent"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structWidget_1_1BaseEvent')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="structWidget_1_1BaseEvent.html">Widget::BaseEvent</a></td></tr>
<tr class="memitem:a227a57d145561c7d07596a702f20d448 inherit pub_attribs_structWidget_1_1BaseEvent"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1BaseEvent.html#a227a57d145561c7d07596a702f20d448">mod</a></td></tr>
<tr class="separator:a227a57d145561c7d07596a702f20d448 inherit pub_attribs_structWidget_1_1BaseEvent"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae134a6bdbd16a59218b5b4f0ee3a154c inherit pub_attribs_structWidget_1_1BaseEvent"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1BaseEvent.html#ae134a6bdbd16a59218b5b4f0ee3a154c">flags</a></td></tr>
<tr class="separator:ae134a6bdbd16a59218b5b4f0ee3a154c inherit pub_attribs_structWidget_1_1BaseEvent"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52bcdb90972ffb30a223d358e64f723f inherit pub_attribs_structWidget_1_1BaseEvent"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1BaseEvent.html#a52bcdb90972ffb30a223d358e64f723f">time</a></td></tr>
<tr class="separator:a52bcdb90972ffb30a223d358e64f723f inherit pub_attribs_structWidget_1_1BaseEvent"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Keyboard event.</p>
<p>This event represents low-level key presses and releases. This can be used for "direct" keyboard handing like key bindings, but must not be interpreted as text input.</p>
<p>Keys are represented portably as Unicode code points, using the "natural" code point for the key. The <em>key</em> field is the code for the pressed key, without any modifiers applied. For example, a press or release of the 'A' key will have <code>key</code> 97 ('a') regardless of whether shift or control are being held.</p>
<p>Alternatively, the raw <em>keycode</em> can be used to work directly with physical keys, but note that this value is not portable and differs between platforms and hardware.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classWidget.html#a9fa874aede538b41348f1029524aea11">onKeyboard</a> </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5a55a296264b9999a7915f2633eacb10"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a55a296264b9999a7915f2633eacb10">&#9670;&nbsp;</a></span>KeyboardEvent()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Widget::KeyboardEvent::KeyboardEvent </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 class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Constructor for default/null values </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a8169fe04d78fb7bb4052ec7bc820da43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8169fe04d78fb7bb4052ec7bc820da43">&#9670;&nbsp;</a></span>press</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Widget::KeyboardEvent::press</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>True if the key was pressed, false if released. </p>

</div>
</div>
<a id="a46cdbf1f69912c93deb649f756ec24f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46cdbf1f69912c93deb649f756ec24f4">&#9670;&nbsp;</a></span>key</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint Widget::KeyboardEvent::key</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Unicode point of the key pressed. </p>

</div>
</div>
<a id="a0db51894bdbda766c9596b226d04d8c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0db51894bdbda766c9596b226d04d8c3">&#9670;&nbsp;</a></span>keycode</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint Widget::KeyboardEvent::keycode</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Raw keycode. </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>dgl/<a class="el" href="Widget_8hpp_source.html">Widget.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>