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.

219 lines
9.8KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>DISTRHO Plugin Framework: Widget::BaseEvent Struct Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">DISTRHO Plugin Framework
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.9.1 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','Search');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. <div id="nav-path" class="navpath">
  61. <ul>
  62. <li class="navelem"><a class="el" href="classWidget.html">Widget</a></li><li class="navelem"><a class="el" href="structWidget_1_1BaseEvent.html">BaseEvent</a></li> </ul>
  63. </div>
  64. </div><!-- top -->
  65. <div class="header">
  66. <div class="summary">
  67. <a href="#pub-methods">Public Member Functions</a> &#124;
  68. <a href="#pub-attribs">Public Attributes</a> &#124;
  69. <a href="structWidget_1_1BaseEvent-members.html">List of all members</a> </div>
  70. <div class="headertitle">
  71. <div class="title">Widget::BaseEvent Struct Reference</div> </div>
  72. </div><!--header-->
  73. <div class="contents">
  74. <p><code>#include &lt;<a class="el" href="Widget_8hpp_source.html">Widget.hpp</a>&gt;</code></p>
  75. <div class="dynheader">
  76. Inheritance diagram for Widget::BaseEvent:</div>
  77. <div class="dyncontent">
  78. <div class="center">
  79. <img src="structWidget_1_1BaseEvent.png" usemap="#Widget::BaseEvent_map" alt=""/>
  80. <map id="Widget::BaseEvent_map" name="Widget::BaseEvent_map">
  81. <area href="structWidget_1_1CharacterInputEvent.html" alt="Widget::CharacterInputEvent" shape="rect" coords="0,56,172,80"/>
  82. <area href="structWidget_1_1KeyboardEvent.html" alt="Widget::KeyboardEvent" shape="rect" coords="182,56,354,80"/>
  83. <area href="structWidget_1_1MotionEvent.html" alt="Widget::MotionEvent" shape="rect" coords="364,56,536,80"/>
  84. <area href="structWidget_1_1MouseEvent.html" alt="Widget::MouseEvent" shape="rect" coords="546,56,718,80"/>
  85. <area href="structWidget_1_1ScrollEvent.html" alt="Widget::ScrollEvent" shape="rect" coords="728,56,900,80"/>
  86. </map>
  87. </div></div>
  88. <table class="memberdecls">
  89. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  90. Public Member Functions</h2></td></tr>
  91. <tr class="memitem:a18c1114caca474cadefd9a13e2d9c693"><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>
  92. <tr class="separator:a18c1114caca474cadefd9a13e2d9c693"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a58da172316b49f6d79b879b74ce5792a"><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>
  94. <tr class="separator:a58da172316b49f6d79b879b74ce5792a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. </table><table class="memberdecls">
  96. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  97. Public Attributes</h2></td></tr>
  98. <tr class="memitem:a227a57d145561c7d07596a702f20d448"><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>
  99. <tr class="separator:a227a57d145561c7d07596a702f20d448"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:ae134a6bdbd16a59218b5b4f0ee3a154c"><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>
  101. <tr class="separator:ae134a6bdbd16a59218b5b4f0ee3a154c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a52bcdb90972ffb30a223d358e64f723f"><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>
  103. <tr class="separator:a52bcdb90972ffb30a223d358e64f723f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. </table>
  105. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  106. <div class="textblock"><p>Base event data. These are the fields present on all <a class="el" href="classWidget.html">Widget</a> events. </p>
  107. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  108. <a id="a18c1114caca474cadefd9a13e2d9c693"></a>
  109. <h2 class="memtitle"><span class="permalink"><a href="#a18c1114caca474cadefd9a13e2d9c693">&#9670;&nbsp;</a></span>BaseEvent()</h2>
  110. <div class="memitem">
  111. <div class="memproto">
  112. <table class="mlabels">
  113. <tr>
  114. <td class="mlabels-left">
  115. <table class="memname">
  116. <tr>
  117. <td class="memname">Widget::BaseEvent::BaseEvent </td>
  118. <td>(</td>
  119. <td class="paramname"></td><td>)</td>
  120. <td></td>
  121. </tr>
  122. </table>
  123. </td>
  124. <td class="mlabels-right">
  125. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
  126. </tr>
  127. </table>
  128. </div><div class="memdoc">
  129. <p>Constructor for default/null values </p>
  130. </div>
  131. </div>
  132. <a id="a58da172316b49f6d79b879b74ce5792a"></a>
  133. <h2 class="memtitle"><span class="permalink"><a href="#a58da172316b49f6d79b879b74ce5792a">&#9670;&nbsp;</a></span>~BaseEvent()</h2>
  134. <div class="memitem">
  135. <div class="memproto">
  136. <table class="mlabels">
  137. <tr>
  138. <td class="mlabels-left">
  139. <table class="memname">
  140. <tr>
  141. <td class="memname">virtual Widget::BaseEvent::~BaseEvent </td>
  142. <td>(</td>
  143. <td class="paramname"></td><td>)</td>
  144. <td></td>
  145. </tr>
  146. </table>
  147. </td>
  148. <td class="mlabels-right">
  149. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">noexcept</span></span> </td>
  150. </tr>
  151. </table>
  152. </div><div class="memdoc">
  153. <p>Destuctor </p>
  154. </div>
  155. </div>
  156. <h2 class="groupheader">Member Data Documentation</h2>
  157. <a id="a227a57d145561c7d07596a702f20d448"></a>
  158. <h2 class="memtitle"><span class="permalink"><a href="#a227a57d145561c7d07596a702f20d448">&#9670;&nbsp;</a></span>mod</h2>
  159. <div class="memitem">
  160. <div class="memproto">
  161. <table class="memname">
  162. <tr>
  163. <td class="memname">uint Widget::BaseEvent::mod</td>
  164. </tr>
  165. </table>
  166. </div><div class="memdoc">
  167. <p>Currently active keyboard modifiers. </p><dl class="section see"><dt>See also</dt><dd>Modifier </dd></dl>
  168. </div>
  169. </div>
  170. <a id="ae134a6bdbd16a59218b5b4f0ee3a154c"></a>
  171. <h2 class="memtitle"><span class="permalink"><a href="#ae134a6bdbd16a59218b5b4f0ee3a154c">&#9670;&nbsp;</a></span>flags</h2>
  172. <div class="memitem">
  173. <div class="memproto">
  174. <table class="memname">
  175. <tr>
  176. <td class="memname">uint Widget::BaseEvent::flags</td>
  177. </tr>
  178. </table>
  179. </div><div class="memdoc">
  180. <p>Event flags. </p><dl class="section see"><dt>See also</dt><dd>EventFlag </dd></dl>
  181. </div>
  182. </div>
  183. <a id="a52bcdb90972ffb30a223d358e64f723f"></a>
  184. <h2 class="memtitle"><span class="permalink"><a href="#a52bcdb90972ffb30a223d358e64f723f">&#9670;&nbsp;</a></span>time</h2>
  185. <div class="memitem">
  186. <div class="memproto">
  187. <table class="memname">
  188. <tr>
  189. <td class="memname">uint Widget::BaseEvent::time</td>
  190. </tr>
  191. </table>
  192. </div><div class="memdoc">
  193. <p>Event timestamp in milliseconds (if any). </p>
  194. </div>
  195. </div>
  196. <hr/>The documentation for this struct was generated from the following file:<ul>
  197. <li>dgl/<a class="el" href="Widget_8hpp_source.html">Widget.hpp</a></li>
  198. </ul>
  199. </div><!-- contents -->
  200. <!-- start footer part -->
  201. <hr class="footer"/><address class="footer"><small>
  202. 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
  203. </small></address>
  204. </body>
  205. </html>