DISTRHO Plugin Framework
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

174 lines
11KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.8"/>
  7. <title>DISTRHO Plugin Framework: Widget::SpecialEvent Struct Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr style="height: 56px;">
  24. <td style="padding-left: 0.5em;">
  25. <div id="projectname">DISTRHO Plugin Framework
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.8 -->
  34. <script type="text/javascript">
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. </script>
  37. <div id="navrow1" class="tabs">
  38. <ul class="tablist">
  39. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  40. <li><a href="modules.html"><span>Modules</span></a></li>
  41. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  42. <li><a href="files.html"><span>Files</span></a></li>
  43. <li>
  44. <div id="MSearchBox" class="MSearchBoxInactive">
  45. <span class="left">
  46. <img id="MSearchSelect" src="search/mag_sel.png"
  47. onmouseover="return searchBox.OnSearchSelectShow()"
  48. onmouseout="return searchBox.OnSearchSelectHide()"
  49. alt=""/>
  50. <input type="text" id="MSearchField" value="Search" accesskey="S"
  51. onfocus="searchBox.OnSearchFieldFocus(true)"
  52. onblur="searchBox.OnSearchFieldFocus(false)"
  53. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  54. </span><span class="right">
  55. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  56. </span>
  57. </div>
  58. </li>
  59. </ul>
  60. </div>
  61. <div id="navrow2" class="tabs2">
  62. <ul class="tablist">
  63. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  64. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  65. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  66. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  67. </ul>
  68. </div>
  69. <!-- window showing the filter options -->
  70. <div id="MSearchSelectWindow"
  71. onmouseover="return searchBox.OnSearchSelectShow()"
  72. onmouseout="return searchBox.OnSearchSelectHide()"
  73. onkeydown="return searchBox.OnSearchSelectKey(event)">
  74. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  75. <!-- iframe showing the search results (closed by default) -->
  76. <div id="MSearchResultsWindow">
  77. <iframe src="javascript:void(0)" frameborder="0"
  78. name="MSearchResults" id="MSearchResults">
  79. </iframe>
  80. </div>
  81. <div id="nav-path" class="navpath">
  82. <ul>
  83. <li class="navelem"><a class="el" href="classWidget.html">Widget</a></li><li class="navelem"><a class="el" href="structWidget_1_1SpecialEvent.html">SpecialEvent</a></li> </ul>
  84. </div>
  85. </div><!-- top -->
  86. <div class="header">
  87. <div class="summary">
  88. <a href="#pub-methods">Public Member Functions</a> &#124;
  89. <a href="#pub-attribs">Public Attributes</a> &#124;
  90. <a href="structWidget_1_1SpecialEvent-members.html">List of all members</a> </div>
  91. <div class="headertitle">
  92. <div class="title">Widget::SpecialEvent Struct Reference</div> </div>
  93. </div><!--header-->
  94. <div class="contents">
  95. <p><code>#include &lt;<a class="el" href="Widget_8hpp_source.html">Widget.hpp</a>&gt;</code></p>
  96. <div class="dynheader">
  97. Inheritance diagram for Widget::SpecialEvent:</div>
  98. <div class="dyncontent">
  99. <div class="center">
  100. <img src="structWidget_1_1SpecialEvent.png" usemap="#Widget::SpecialEvent_map" alt=""/>
  101. <map id="Widget::SpecialEvent_map" name="Widget::SpecialEvent_map">
  102. <area href="structWidget_1_1BaseEvent.html" alt="Widget::BaseEvent" shape="rect" coords="0,0,130,24"/>
  103. </map>
  104. </div></div>
  105. <table class="memberdecls">
  106. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  107. Public Member Functions</h2></td></tr>
  108. <tr class="memitem:aabddc200eb8494dccac663b83248b14b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1SpecialEvent.html#aabddc200eb8494dccac663b83248b14b">SpecialEvent</a> () noexcept</td></tr>
  109. <tr class="separator:aabddc200eb8494dccac663b83248b14b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <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>
  111. <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>
  112. <tr class="separator:a18c1114caca474cadefd9a13e2d9c693 inherit pub_methods_structWidget_1_1BaseEvent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <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>
  114. <tr class="separator:a58da172316b49f6d79b879b74ce5792a inherit pub_methods_structWidget_1_1BaseEvent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. </table><table class="memberdecls">
  116. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  117. Public Attributes</h2></td></tr>
  118. <tr class="memitem:a06a29e8dd7f66b49d7ba520d2b8a691b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a06a29e8dd7f66b49d7ba520d2b8a691b"></a>
  119. bool&#160;</td><td class="memItemRight" valign="bottom"><b>press</b></td></tr>
  120. <tr class="separator:a06a29e8dd7f66b49d7ba520d2b8a691b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:ae2f8e6a216cb09f7f73a3797a7de487e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae2f8e6a216cb09f7f73a3797a7de487e"></a>
  122. Key&#160;</td><td class="memItemRight" valign="bottom"><b>key</b></td></tr>
  123. <tr class="separator:ae2f8e6a216cb09f7f73a3797a7de487e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <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>
  125. <tr class="memitem:a227a57d145561c7d07596a702f20d448 inherit pub_attribs_structWidget_1_1BaseEvent"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a227a57d145561c7d07596a702f20d448"></a>
  126. uint&#160;</td><td class="memItemRight" valign="bottom"><b>mod</b></td></tr>
  127. <tr class="separator:a227a57d145561c7d07596a702f20d448 inherit pub_attribs_structWidget_1_1BaseEvent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a8428061b58dd7c9737476b4146616f04 inherit pub_attribs_structWidget_1_1BaseEvent"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8428061b58dd7c9737476b4146616f04"></a>
  129. uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>time</b></td></tr>
  130. <tr class="separator:a8428061b58dd7c9737476b4146616f04 inherit pub_attribs_structWidget_1_1BaseEvent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. </table>
  132. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  133. <div class="textblock"><p>Special keyboard event. <em>press</em> True if the key was pressed, false if released. <em>key</em> The key pressed. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classWidget.html#a3b42652fcb2f95c6f86bdd43a1727507">onSpecial</a> </dd></dl>
  134. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  135. <a class="anchor" id="aabddc200eb8494dccac663b83248b14b"></a>
  136. <div class="memitem">
  137. <div class="memproto">
  138. <table class="mlabels">
  139. <tr>
  140. <td class="mlabels-left">
  141. <table class="memname">
  142. <tr>
  143. <td class="memname">Widget::SpecialEvent::SpecialEvent </td>
  144. <td>(</td>
  145. <td class="paramname"></td><td>)</td>
  146. <td></td>
  147. </tr>
  148. </table>
  149. </td>
  150. <td class="mlabels-right">
  151. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
  152. </tr>
  153. </table>
  154. </div><div class="memdoc">
  155. <p>Constuctor </p>
  156. </div>
  157. </div>
  158. <hr/>The documentation for this struct was generated from the following file:<ul>
  159. <li>dgl/<a class="el" href="Widget_8hpp_source.html">Widget.hpp</a></li>
  160. </ul>
  161. </div><!-- contents -->
  162. <!-- start footer part -->
  163. <hr class="footer"/><address class="footer"><small>
  164. Generated on Sun Apr 26 2015 15:47:57 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">
  165. <img class="footer" src="doxygen.png" alt="doxygen"/>
  166. </a> 1.8.8
  167. </small></address>
  168. </body>
  169. </html>