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.

620 lines
42KB

  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: TopLevelWidget Class 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><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#pub-methods">Public Member Functions</a> &#124;
  64. <a href="#pro-methods">Protected Member Functions</a> &#124;
  65. <a href="#friends">Friends</a> &#124;
  66. <a href="classTopLevelWidget-members.html">List of all members</a> </div>
  67. <div class="headertitle">
  68. <div class="title">TopLevelWidget Class Reference</div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <p><code>#include &lt;<a class="el" href="TopLevelWidget_8hpp_source.html">TopLevelWidget.hpp</a>&gt;</code></p>
  72. <div class="dynheader">
  73. Inheritance diagram for TopLevelWidget:</div>
  74. <div class="dyncontent">
  75. <div class="center">
  76. <img src="classTopLevelWidget.png" usemap="#TopLevelWidget_map" alt=""/>
  77. <map id="TopLevelWidget_map" name="TopLevelWidget_map">
  78. <area href="classWidget.html" alt="Widget" shape="rect" coords="0,0,235,24"/>
  79. <area href="classStandaloneWindow.html" alt="StandaloneWindow" shape="rect" coords="0,112,235,136"/>
  80. <area href="classImageBaseAboutWindow.html" alt="ImageBaseAboutWindow&lt; ImageType &gt;" shape="rect" coords="0,168,235,192"/>
  81. </map>
  82. </div></div>
  83. <table class="memberdecls">
  84. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  85. Public Member Functions</h2></td></tr>
  86. <tr class="memitem:a3cdeec5e7b144cc48d89e748a37f538e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#a3cdeec5e7b144cc48d89e748a37f538e">TopLevelWidget</a> (<a class="el" href="classWindow.html">Window</a> &amp;windowToMapTo)</td></tr>
  87. <tr class="separator:a3cdeec5e7b144cc48d89e748a37f538e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:af60daa3513ca7f7d05575ab3feaee268"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#af60daa3513ca7f7d05575ab3feaee268">~TopLevelWidget</a> () override</td></tr>
  89. <tr class="separator:af60daa3513ca7f7d05575ab3feaee268"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:af5c5c403ba231c14b3a41684bef45648"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApplication.html">Application</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#af5c5c403ba231c14b3a41684bef45648">getApp</a> () const noexcept</td></tr>
  91. <tr class="separator:af5c5c403ba231c14b3a41684bef45648"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a3ceb7af6e9372a139d40a5859dfd0e4d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWindow.html">Window</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#a3ceb7af6e9372a139d40a5859dfd0e4d">getWindow</a> () const noexcept</td></tr>
  93. <tr class="separator:a3ceb7af6e9372a139d40a5859dfd0e4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a4a95eb3bb76704737ef9cf405e800617"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#a4a95eb3bb76704737ef9cf405e800617">setWidth</a> (uint width)</td></tr>
  95. <tr class="separator:a4a95eb3bb76704737ef9cf405e800617"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a607afeaa7fc1bd6cf52ef3138c38360f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#a607afeaa7fc1bd6cf52ef3138c38360f">setHeight</a> (uint height)</td></tr>
  97. <tr class="separator:a607afeaa7fc1bd6cf52ef3138c38360f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a41fa486da289fb082bb840aaaad72a08"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#a41fa486da289fb082bb840aaaad72a08">setSize</a> (uint width, uint height)</td></tr>
  99. <tr class="separator:a41fa486da289fb082bb840aaaad72a08"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a94f526903d739bf2e812fb785fc66aae"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#a94f526903d739bf2e812fb785fc66aae">setSize</a> (const <a class="el" href="classSize.html">Size</a>&lt; uint &gt; &amp;size)</td></tr>
  101. <tr class="separator:a94f526903d739bf2e812fb785fc66aae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a5b71bc1266aea488b1f85b83744adbfd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#a5b71bc1266aea488b1f85b83744adbfd">repaint</a> () noexcept override</td></tr>
  103. <tr class="separator:a5b71bc1266aea488b1f85b83744adbfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a4a9b2d040ba36825fd95f966bb4d9e36"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#a4a9b2d040ba36825fd95f966bb4d9e36">repaint</a> (const <a class="el" href="classRectangle.html">Rectangle</a>&lt; uint &gt; &amp;rect) noexcept</td></tr>
  105. <tr class="separator:a4a9b2d040ba36825fd95f966bb4d9e36"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a1fbfc17e10dbe06cfcf656ebd3438da0"><td class="memItemLeft" align="right" valign="top"><a id="a1fbfc17e10dbe06cfcf656ebd3438da0"></a>
  107. const void *&#160;</td><td class="memItemRight" valign="bottom"><b>getClipboard</b> (size_t &amp;dataSize)</td></tr>
  108. <tr class="separator:a1fbfc17e10dbe06cfcf656ebd3438da0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a74ed1b7de337a9d4447903644087ef32"><td class="memItemLeft" align="right" valign="top"><a id="a74ed1b7de337a9d4447903644087ef32"></a>
  110. bool&#160;</td><td class="memItemRight" valign="bottom"><b>setClipboard</b> (const char *mimeType, const void *data, size_t dataSize)</td></tr>
  111. <tr class="separator:a74ed1b7de337a9d4447903644087ef32"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a21314d0829749739ee1c438e691a5f49"><td class="memItemLeft" align="right" valign="top"><a id="a21314d0829749739ee1c438e691a5f49"></a>
  113. bool&#160;</td><td class="memItemRight" valign="bottom"><b>setCursor</b> (MouseCursor cursor)</td></tr>
  114. <tr class="separator:a21314d0829749739ee1c438e691a5f49"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a5569262e4859b2b59832af4fb8409ddc"><td class="memItemLeft" align="right" valign="top"><a id="a5569262e4859b2b59832af4fb8409ddc"></a>
  116. bool&#160;</td><td class="memItemRight" valign="bottom"><b>addIdleCallback</b> (<a class="el" href="structIdleCallback.html">IdleCallback</a> *callback, uint timerFrequencyInMs=0)</td></tr>
  117. <tr class="separator:a5569262e4859b2b59832af4fb8409ddc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a4cf1a5a0ea4f266fde337e9756c82c41"><td class="memItemLeft" align="right" valign="top"><a id="a4cf1a5a0ea4f266fde337e9756c82c41"></a>
  119. bool&#160;</td><td class="memItemRight" valign="bottom"><b>removeIdleCallback</b> (<a class="el" href="structIdleCallback.html">IdleCallback</a> *callback)</td></tr>
  120. <tr class="separator:a4cf1a5a0ea4f266fde337e9756c82c41"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a8f8c6b72513abeb782cdbed5b24c6fb8"><td class="memItemLeft" align="right" valign="top"><a id="a8f8c6b72513abeb782cdbed5b24c6fb8"></a>
  122. double&#160;</td><td class="memItemRight" valign="bottom"><b>getScaleFactor</b> () const noexcept</td></tr>
  123. <tr class="separator:a8f8c6b72513abeb782cdbed5b24c6fb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:ad096c93f5eb7b328707ee1f98c173c12"><td class="memItemLeft" align="right" valign="top"><a id="ad096c93f5eb7b328707ee1f98c173c12"></a>
  125. void&#160;</td><td class="memItemRight" valign="bottom"><b>setGeometryConstraints</b> (uint minimumWidth, uint minimumHeight, bool keepAspectRatio=false, bool automaticallyScale=false, bool resizeNowIfAutoScaling=true)</td></tr>
  126. <tr class="separator:ad096c93f5eb7b328707ee1f98c173c12"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:a608102a97b9b66636d947d029cbc87ac"><td class="memItemLeft" align="right" valign="top"><a id="a608102a97b9b66636d947d029cbc87ac"></a>
  128. <a class="el" href="classApplication.html">Application</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>getParentApp</b> () const noexcept</td></tr>
  129. <tr class="separator:a608102a97b9b66636d947d029cbc87ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a5eaf5a87cf735945a40945523b3f1fbb"><td class="memItemLeft" align="right" valign="top"><a id="a5eaf5a87cf735945a40945523b3f1fbb"></a>
  131. <a class="el" href="classWindow.html">Window</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>getParentWindow</b> () const noexcept</td></tr>
  132. <tr class="separator:a5eaf5a87cf735945a40945523b3f1fbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="inherit_header pub_methods_classWidget"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classWidget')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classWidget.html">Widget</a></td></tr>
  134. <tr class="memitem:a714cf798aadb4d615f6f60a355382c02 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a714cf798aadb4d615f6f60a355382c02">~Widget</a> ()</td></tr>
  135. <tr class="separator:a714cf798aadb4d615f6f60a355382c02 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a234a8ee8a685dc211ad11f492f0dbc71 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a234a8ee8a685dc211ad11f492f0dbc71">isVisible</a> () const noexcept</td></tr>
  137. <tr class="separator:a234a8ee8a685dc211ad11f492f0dbc71 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a66088a03691f9c643ff335fa826576ba inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a66088a03691f9c643ff335fa826576ba">setVisible</a> (bool visible)</td></tr>
  139. <tr class="separator:a66088a03691f9c643ff335fa826576ba inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:a25ff178539e226b5f30ef0335d060f2b inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a25ff178539e226b5f30ef0335d060f2b">show</a> ()</td></tr>
  141. <tr class="separator:a25ff178539e226b5f30ef0335d060f2b inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:a4a2f8eebacdd20db505b838f1a118c6b inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a4a2f8eebacdd20db505b838f1a118c6b">hide</a> ()</td></tr>
  143. <tr class="separator:a4a2f8eebacdd20db505b838f1a118c6b inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:a169c317caf734c6664494a573e427b40 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a169c317caf734c6664494a573e427b40">getWidth</a> () const noexcept</td></tr>
  145. <tr class="separator:a169c317caf734c6664494a573e427b40 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:aa20f6dc096a8836706173f31324c4db8 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#aa20f6dc096a8836706173f31324c4db8">getHeight</a> () const noexcept</td></tr>
  147. <tr class="separator:aa20f6dc096a8836706173f31324c4db8 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:a9044d42c20ead27dba983b710c94f8d6 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classSize.html">Size</a>&lt; uint &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a9044d42c20ead27dba983b710c94f8d6">getSize</a> () const noexcept</td></tr>
  149. <tr class="separator:a9044d42c20ead27dba983b710c94f8d6 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:aed80a9cbc4a13c01641f35dd3d8688ea inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#aed80a9cbc4a13c01641f35dd3d8688ea">setWidth</a> (uint width) noexcept</td></tr>
  151. <tr class="separator:aed80a9cbc4a13c01641f35dd3d8688ea inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:ac6d2e6cbb2ff96f3645493d804af07f7 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#ac6d2e6cbb2ff96f3645493d804af07f7">setHeight</a> (uint height) noexcept</td></tr>
  153. <tr class="separator:ac6d2e6cbb2ff96f3645493d804af07f7 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:ab4d9e0156e455db3ff23730f82544daa inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#ab4d9e0156e455db3ff23730f82544daa">setSize</a> (uint width, uint height) noexcept</td></tr>
  155. <tr class="separator:ab4d9e0156e455db3ff23730f82544daa inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <tr class="memitem:afce784b204902c0f11e9ed02bc692362 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#afce784b204902c0f11e9ed02bc692362">setSize</a> (const <a class="el" href="classSize.html">Size</a>&lt; uint &gt; &amp;size) noexcept</td></tr>
  157. <tr class="separator:afce784b204902c0f11e9ed02bc692362 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:a3ee6b2824e3f3719c1c9b3d070385f49 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a3ee6b2824e3f3719c1c9b3d070385f49">getId</a> () const noexcept</td></tr>
  159. <tr class="separator:a3ee6b2824e3f3719c1c9b3d070385f49 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:a70b07dbf748490e5a8c18fb9d5766c0e inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a70b07dbf748490e5a8c18fb9d5766c0e">getName</a> () const noexcept</td></tr>
  161. <tr class="separator:a70b07dbf748490e5a8c18fb9d5766c0e inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <tr class="memitem:abfba3652559de84ba1ae9ccbd3d35e31 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#abfba3652559de84ba1ae9ccbd3d35e31">setId</a> (uint id) noexcept</td></tr>
  163. <tr class="separator:abfba3652559de84ba1ae9ccbd3d35e31 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <tr class="memitem:a6303d0445f21a2a95148780b0a0afed6 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a6303d0445f21a2a95148780b0a0afed6">setName</a> (const char *name) noexcept</td></tr>
  165. <tr class="separator:a6303d0445f21a2a95148780b0a0afed6 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <tr class="memitem:a373419bc6353abf50a502cdbebd736e7 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApplication.html">Application</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a373419bc6353abf50a502cdbebd736e7">getApp</a> () const noexcept</td></tr>
  167. <tr class="separator:a373419bc6353abf50a502cdbebd736e7 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <tr class="memitem:a0ef05695aec704b0eb1eb91c2e8af07d inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWindow.html">Window</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a0ef05695aec704b0eb1eb91c2e8af07d">getWindow</a> () const noexcept</td></tr>
  169. <tr class="separator:a0ef05695aec704b0eb1eb91c2e8af07d inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. <tr class="memitem:ae23d09ec0e5f0397a3451b603b407182 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structGraphicsContext.html">GraphicsContext</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#ae23d09ec0e5f0397a3451b603b407182">getGraphicsContext</a> () const noexcept</td></tr>
  171. <tr class="separator:ae23d09ec0e5f0397a3451b603b407182 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <tr class="memitem:a607b153f7d3187ca60bf21004efc1314 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTopLevelWidget.html">TopLevelWidget</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a607b153f7d3187ca60bf21004efc1314">getTopLevelWidget</a> () const noexcept</td></tr>
  173. <tr class="separator:a607b153f7d3187ca60bf21004efc1314 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  174. <tr class="memitem:a5381d5583ba6e55fe9fed87df95d9605 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">std::list&lt; <a class="el" href="classSubWidget.html">SubWidget</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a5381d5583ba6e55fe9fed87df95d9605">getChildren</a> () const noexcept</td></tr>
  175. <tr class="separator:a5381d5583ba6e55fe9fed87df95d9605 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  176. <tr class="memitem:aa514fb1c20038ba9793e4409e9b18876 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top"><a id="aa514fb1c20038ba9793e4409e9b18876"></a>
  177. <a class="el" href="classApplication.html">Application</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>getParentApp</b> () const noexcept</td></tr>
  178. <tr class="separator:aa514fb1c20038ba9793e4409e9b18876 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  179. <tr class="memitem:a0e0b0b2293bb63b2d84774542cc6a421 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top"><a id="a0e0b0b2293bb63b2d84774542cc6a421"></a>
  180. <a class="el" href="classWindow.html">Window</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>getParentWindow</b> () const noexcept</td></tr>
  181. <tr class="separator:a0e0b0b2293bb63b2d84774542cc6a421 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  182. </table><table class="memberdecls">
  183. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  184. Protected Member Functions</h2></td></tr>
  185. <tr class="memitem:a7b182e276662bc32aa0fcd7b07dfe4d0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#a7b182e276662bc32aa0fcd7b07dfe4d0">onKeyboard</a> (const <a class="el" href="structWidget_1_1KeyboardEvent.html">KeyboardEvent</a> &amp;) override</td></tr>
  186. <tr class="separator:a7b182e276662bc32aa0fcd7b07dfe4d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  187. <tr class="memitem:a567153ae0853e56553c9569dc61ed913"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#a567153ae0853e56553c9569dc61ed913">onCharacterInput</a> (const <a class="el" href="structWidget_1_1CharacterInputEvent.html">CharacterInputEvent</a> &amp;) override</td></tr>
  188. <tr class="separator:a567153ae0853e56553c9569dc61ed913"><td class="memSeparator" colspan="2">&#160;</td></tr>
  189. <tr class="memitem:a8ceccb37de18c8e3b21fbf64ad58981c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#a8ceccb37de18c8e3b21fbf64ad58981c">onMouse</a> (const <a class="el" href="structWidget_1_1MouseEvent.html">MouseEvent</a> &amp;) override</td></tr>
  190. <tr class="separator:a8ceccb37de18c8e3b21fbf64ad58981c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  191. <tr class="memitem:ac640eb913196c9edb68e5d52df4a89cb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#ac640eb913196c9edb68e5d52df4a89cb">onMotion</a> (const <a class="el" href="structWidget_1_1MotionEvent.html">MotionEvent</a> &amp;) override</td></tr>
  192. <tr class="separator:ac640eb913196c9edb68e5d52df4a89cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  193. <tr class="memitem:a412a6ce96a4ef7f64396e312ad072f9d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#a412a6ce96a4ef7f64396e312ad072f9d">onScroll</a> (const <a class="el" href="structWidget_1_1ScrollEvent.html">ScrollEvent</a> &amp;) override</td></tr>
  194. <tr class="separator:a412a6ce96a4ef7f64396e312ad072f9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  195. <tr class="inherit_header pro_methods_classWidget"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classWidget')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classWidget.html">Widget</a></td></tr>
  196. <tr class="memitem:ae1554f348fe3b2f9d4c3c5c4f9ec55bd inherit pro_methods_classWidget"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#ae1554f348fe3b2f9d4c3c5c4f9ec55bd">onDisplay</a> ()=0</td></tr>
  197. <tr class="separator:ae1554f348fe3b2f9d4c3c5c4f9ec55bd inherit pro_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  198. <tr class="memitem:acc0365ec4b9245bdffb8d0285be55dea inherit pro_methods_classWidget"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#acc0365ec4b9245bdffb8d0285be55dea">onResize</a> (const <a class="el" href="structWidget_1_1ResizeEvent.html">ResizeEvent</a> &amp;)</td></tr>
  199. <tr class="separator:acc0365ec4b9245bdffb8d0285be55dea inherit pro_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  200. <tr class="memitem:a3b42652fcb2f95c6f86bdd43a1727507 inherit pro_methods_classWidget"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a3b42652fcb2f95c6f86bdd43a1727507">onSpecial</a> (const SpecialEvent &amp;)</td></tr>
  201. <tr class="separator:a3b42652fcb2f95c6f86bdd43a1727507 inherit pro_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  202. </table><table class="memberdecls">
  203. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  204. Friends</h2></td></tr>
  205. <tr class="memitem:a553f958a25683445088050a69d3de8e9"><td class="memItemLeft" align="right" valign="top"><a id="a553f958a25683445088050a69d3de8e9"></a>
  206. class&#160;</td><td class="memItemRight" valign="bottom"><b>Window</b></td></tr>
  207. <tr class="separator:a553f958a25683445088050a69d3de8e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  208. </table>
  209. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  210. <div class="textblock"><p>Top-Level <a class="el" href="classWidget.html">Widget</a> class.</p>
  211. <p>This is the only <a class="el" href="classWidget.html">Widget</a> class that is allowed to be used directly on a <a class="el" href="classWindow.html">Window</a>.</p>
  212. <p>This widget takes the full size of the <a class="el" href="classWindow.html">Window</a> it is mapped to. Sub-widgets can be added on top of this top-level widget, by creating them with this class as parent. Doing so allows for custom position and sizes.</p>
  213. <p>This class is used as the type for DPF <a class="el" href="classPlugin.html">Plugin</a> UIs. So anything that a plugin <a class="el" href="classUI.html">UI</a> might need that does not belong in a simple <a class="el" href="classWidget.html">Widget</a> will go here. </p>
  214. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  215. <a id="a3cdeec5e7b144cc48d89e748a37f538e"></a>
  216. <h2 class="memtitle"><span class="permalink"><a href="#a3cdeec5e7b144cc48d89e748a37f538e">&#9670;&nbsp;</a></span>TopLevelWidget()</h2>
  217. <div class="memitem">
  218. <div class="memproto">
  219. <table class="mlabels">
  220. <tr>
  221. <td class="mlabels-left">
  222. <table class="memname">
  223. <tr>
  224. <td class="memname">TopLevelWidget::TopLevelWidget </td>
  225. <td>(</td>
  226. <td class="paramtype"><a class="el" href="classWindow.html">Window</a> &amp;&#160;</td>
  227. <td class="paramname"><em>windowToMapTo</em></td><td>)</td>
  228. <td></td>
  229. </tr>
  230. </table>
  231. </td>
  232. <td class="mlabels-right">
  233. <span class="mlabels"><span class="mlabel">explicit</span></span> </td>
  234. </tr>
  235. </table>
  236. </div><div class="memdoc">
  237. <p>Constructor. </p>
  238. </div>
  239. </div>
  240. <a id="af60daa3513ca7f7d05575ab3feaee268"></a>
  241. <h2 class="memtitle"><span class="permalink"><a href="#af60daa3513ca7f7d05575ab3feaee268">&#9670;&nbsp;</a></span>~TopLevelWidget()</h2>
  242. <div class="memitem">
  243. <div class="memproto">
  244. <table class="mlabels">
  245. <tr>
  246. <td class="mlabels-left">
  247. <table class="memname">
  248. <tr>
  249. <td class="memname">TopLevelWidget::~TopLevelWidget </td>
  250. <td>(</td>
  251. <td class="paramname"></td><td>)</td>
  252. <td></td>
  253. </tr>
  254. </table>
  255. </td>
  256. <td class="mlabels-right">
  257. <span class="mlabels"><span class="mlabel">override</span></span> </td>
  258. </tr>
  259. </table>
  260. </div><div class="memdoc">
  261. <p>Destructor. </p>
  262. </div>
  263. </div>
  264. <h2 class="groupheader">Member Function Documentation</h2>
  265. <a id="af5c5c403ba231c14b3a41684bef45648"></a>
  266. <h2 class="memtitle"><span class="permalink"><a href="#af5c5c403ba231c14b3a41684bef45648">&#9670;&nbsp;</a></span>getApp()</h2>
  267. <div class="memitem">
  268. <div class="memproto">
  269. <table class="mlabels">
  270. <tr>
  271. <td class="mlabels-left">
  272. <table class="memname">
  273. <tr>
  274. <td class="memname"><a class="el" href="classApplication.html">Application</a>&amp; TopLevelWidget::getApp </td>
  275. <td>(</td>
  276. <td class="paramname"></td><td>)</td>
  277. <td> const</td>
  278. </tr>
  279. </table>
  280. </td>
  281. <td class="mlabels-right">
  282. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  283. </tr>
  284. </table>
  285. </div><div class="memdoc">
  286. <p>Get the application associated with this top-level widget's window. </p>
  287. </div>
  288. </div>
  289. <a id="a3ceb7af6e9372a139d40a5859dfd0e4d"></a>
  290. <h2 class="memtitle"><span class="permalink"><a href="#a3ceb7af6e9372a139d40a5859dfd0e4d">&#9670;&nbsp;</a></span>getWindow()</h2>
  291. <div class="memitem">
  292. <div class="memproto">
  293. <table class="mlabels">
  294. <tr>
  295. <td class="mlabels-left">
  296. <table class="memname">
  297. <tr>
  298. <td class="memname"><a class="el" href="classWindow.html">Window</a>&amp; TopLevelWidget::getWindow </td>
  299. <td>(</td>
  300. <td class="paramname"></td><td>)</td>
  301. <td> const</td>
  302. </tr>
  303. </table>
  304. </td>
  305. <td class="mlabels-right">
  306. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  307. </tr>
  308. </table>
  309. </div><div class="memdoc">
  310. <p>Get the window associated with this top-level widget. </p>
  311. </div>
  312. </div>
  313. <a id="a4a95eb3bb76704737ef9cf405e800617"></a>
  314. <h2 class="memtitle"><span class="permalink"><a href="#a4a95eb3bb76704737ef9cf405e800617">&#9670;&nbsp;</a></span>setWidth()</h2>
  315. <div class="memitem">
  316. <div class="memproto">
  317. <table class="memname">
  318. <tr>
  319. <td class="memname">void TopLevelWidget::setWidth </td>
  320. <td>(</td>
  321. <td class="paramtype">uint&#160;</td>
  322. <td class="paramname"><em>width</em></td><td>)</td>
  323. <td></td>
  324. </tr>
  325. </table>
  326. </div><div class="memdoc">
  327. <p>Set width of this widget's window. </p><dl class="section note"><dt>Note</dt><dd>This will not change the widget's size right away, but be pending on the OS resizing the window </dd></dl>
  328. </div>
  329. </div>
  330. <a id="a607afeaa7fc1bd6cf52ef3138c38360f"></a>
  331. <h2 class="memtitle"><span class="permalink"><a href="#a607afeaa7fc1bd6cf52ef3138c38360f">&#9670;&nbsp;</a></span>setHeight()</h2>
  332. <div class="memitem">
  333. <div class="memproto">
  334. <table class="memname">
  335. <tr>
  336. <td class="memname">void TopLevelWidget::setHeight </td>
  337. <td>(</td>
  338. <td class="paramtype">uint&#160;</td>
  339. <td class="paramname"><em>height</em></td><td>)</td>
  340. <td></td>
  341. </tr>
  342. </table>
  343. </div><div class="memdoc">
  344. <p>Set height of this widget's window. </p><dl class="section note"><dt>Note</dt><dd>This will not change the widget's size right away, but be pending on the OS resizing the window </dd></dl>
  345. </div>
  346. </div>
  347. <a id="a41fa486da289fb082bb840aaaad72a08"></a>
  348. <h2 class="memtitle"><span class="permalink"><a href="#a41fa486da289fb082bb840aaaad72a08">&#9670;&nbsp;</a></span>setSize() <span class="overload">[1/2]</span></h2>
  349. <div class="memitem">
  350. <div class="memproto">
  351. <table class="memname">
  352. <tr>
  353. <td class="memname">void TopLevelWidget::setSize </td>
  354. <td>(</td>
  355. <td class="paramtype">uint&#160;</td>
  356. <td class="paramname"><em>width</em>, </td>
  357. </tr>
  358. <tr>
  359. <td class="paramkey"></td>
  360. <td></td>
  361. <td class="paramtype">uint&#160;</td>
  362. <td class="paramname"><em>height</em>&#160;</td>
  363. </tr>
  364. <tr>
  365. <td></td>
  366. <td>)</td>
  367. <td></td><td></td>
  368. </tr>
  369. </table>
  370. </div><div class="memdoc">
  371. <p>Set size of this widget's window, using <em>width</em> and <em>height</em> values. </p><dl class="section note"><dt>Note</dt><dd>This will not change the widget's size right away, but be pending on the OS resizing the window </dd></dl>
  372. </div>
  373. </div>
  374. <a id="a94f526903d739bf2e812fb785fc66aae"></a>
  375. <h2 class="memtitle"><span class="permalink"><a href="#a94f526903d739bf2e812fb785fc66aae">&#9670;&nbsp;</a></span>setSize() <span class="overload">[2/2]</span></h2>
  376. <div class="memitem">
  377. <div class="memproto">
  378. <table class="memname">
  379. <tr>
  380. <td class="memname">void TopLevelWidget::setSize </td>
  381. <td>(</td>
  382. <td class="paramtype">const <a class="el" href="classSize.html">Size</a>&lt; uint &gt; &amp;&#160;</td>
  383. <td class="paramname"><em>size</em></td><td>)</td>
  384. <td></td>
  385. </tr>
  386. </table>
  387. </div><div class="memdoc">
  388. <p>Set size of this widget's window. </p><dl class="section note"><dt>Note</dt><dd>This will not change the widget's size right away, but be pending on the OS resizing the window </dd></dl>
  389. </div>
  390. </div>
  391. <a id="a5b71bc1266aea488b1f85b83744adbfd"></a>
  392. <h2 class="memtitle"><span class="permalink"><a href="#a5b71bc1266aea488b1f85b83744adbfd">&#9670;&nbsp;</a></span>repaint() <span class="overload">[1/2]</span></h2>
  393. <div class="memitem">
  394. <div class="memproto">
  395. <table class="mlabels">
  396. <tr>
  397. <td class="mlabels-left">
  398. <table class="memname">
  399. <tr>
  400. <td class="memname">void TopLevelWidget::repaint </td>
  401. <td>(</td>
  402. <td class="paramname"></td><td>)</td>
  403. <td></td>
  404. </tr>
  405. </table>
  406. </td>
  407. <td class="mlabels-right">
  408. <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span><span class="mlabel">noexcept</span></span> </td>
  409. </tr>
  410. </table>
  411. </div><div class="memdoc">
  412. <p>TODO document this. </p>
  413. <p>Reimplemented from <a class="el" href="classWidget.html#abe8cfe0aaae71dd011cf9a86e930fd12">Widget</a>.</p>
  414. </div>
  415. </div>
  416. <a id="a4a9b2d040ba36825fd95f966bb4d9e36"></a>
  417. <h2 class="memtitle"><span class="permalink"><a href="#a4a9b2d040ba36825fd95f966bb4d9e36">&#9670;&nbsp;</a></span>repaint() <span class="overload">[2/2]</span></h2>
  418. <div class="memitem">
  419. <div class="memproto">
  420. <table class="mlabels">
  421. <tr>
  422. <td class="mlabels-left">
  423. <table class="memname">
  424. <tr>
  425. <td class="memname">void TopLevelWidget::repaint </td>
  426. <td>(</td>
  427. <td class="paramtype">const <a class="el" href="classRectangle.html">Rectangle</a>&lt; uint &gt; &amp;&#160;</td>
  428. <td class="paramname"><em>rect</em></td><td>)</td>
  429. <td></td>
  430. </tr>
  431. </table>
  432. </td>
  433. <td class="mlabels-right">
  434. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  435. </tr>
  436. </table>
  437. </div><div class="memdoc">
  438. <p>TODO document this. </p>
  439. </div>
  440. </div>
  441. <a id="a7b182e276662bc32aa0fcd7b07dfe4d0"></a>
  442. <h2 class="memtitle"><span class="permalink"><a href="#a7b182e276662bc32aa0fcd7b07dfe4d0">&#9670;&nbsp;</a></span>onKeyboard()</h2>
  443. <div class="memitem">
  444. <div class="memproto">
  445. <table class="mlabels">
  446. <tr>
  447. <td class="mlabels-left">
  448. <table class="memname">
  449. <tr>
  450. <td class="memname">bool TopLevelWidget::onKeyboard </td>
  451. <td>(</td>
  452. <td class="paramtype">const <a class="el" href="structWidget_1_1KeyboardEvent.html">KeyboardEvent</a> &amp;&#160;</td>
  453. <td class="paramname"></td><td>)</td>
  454. <td></td>
  455. </tr>
  456. </table>
  457. </td>
  458. <td class="mlabels-right">
  459. <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  460. </tr>
  461. </table>
  462. </div><div class="memdoc">
  463. <p>A function called when a key is pressed or released. </p><dl class="section return"><dt>Returns</dt><dd>True to stop event propagation, false otherwise. </dd></dl>
  464. <p>Reimplemented from <a class="el" href="classWidget.html#a9fa874aede538b41348f1029524aea11">Widget</a>.</p>
  465. </div>
  466. </div>
  467. <a id="a567153ae0853e56553c9569dc61ed913"></a>
  468. <h2 class="memtitle"><span class="permalink"><a href="#a567153ae0853e56553c9569dc61ed913">&#9670;&nbsp;</a></span>onCharacterInput()</h2>
  469. <div class="memitem">
  470. <div class="memproto">
  471. <table class="mlabels">
  472. <tr>
  473. <td class="mlabels-left">
  474. <table class="memname">
  475. <tr>
  476. <td class="memname">bool TopLevelWidget::onCharacterInput </td>
  477. <td>(</td>
  478. <td class="paramtype">const <a class="el" href="structWidget_1_1CharacterInputEvent.html">CharacterInputEvent</a> &amp;&#160;</td>
  479. <td class="paramname"></td><td>)</td>
  480. <td></td>
  481. </tr>
  482. </table>
  483. </td>
  484. <td class="mlabels-right">
  485. <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  486. </tr>
  487. </table>
  488. </div><div class="memdoc">
  489. <p>A function called when an UTF-8 character is received. </p><dl class="section return"><dt>Returns</dt><dd>True to stop event propagation, false otherwise. </dd></dl>
  490. <p>Reimplemented from <a class="el" href="classWidget.html#ad7fb24de24d8809305b04ff3750f0dea">Widget</a>.</p>
  491. </div>
  492. </div>
  493. <a id="a8ceccb37de18c8e3b21fbf64ad58981c"></a>
  494. <h2 class="memtitle"><span class="permalink"><a href="#a8ceccb37de18c8e3b21fbf64ad58981c">&#9670;&nbsp;</a></span>onMouse()</h2>
  495. <div class="memitem">
  496. <div class="memproto">
  497. <table class="mlabels">
  498. <tr>
  499. <td class="mlabels-left">
  500. <table class="memname">
  501. <tr>
  502. <td class="memname">bool TopLevelWidget::onMouse </td>
  503. <td>(</td>
  504. <td class="paramtype">const <a class="el" href="structWidget_1_1MouseEvent.html">MouseEvent</a> &amp;&#160;</td>
  505. <td class="paramname"></td><td>)</td>
  506. <td></td>
  507. </tr>
  508. </table>
  509. </td>
  510. <td class="mlabels-right">
  511. <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  512. </tr>
  513. </table>
  514. </div><div class="memdoc">
  515. <p>A function called when a mouse button is pressed or released. </p><dl class="section return"><dt>Returns</dt><dd>True to stop event propagation, false otherwise. </dd></dl>
  516. <p>Reimplemented from <a class="el" href="classWidget.html#a097ec1d56a06bdc9e0a4e54880def378">Widget</a>.</p>
  517. </div>
  518. </div>
  519. <a id="ac640eb913196c9edb68e5d52df4a89cb"></a>
  520. <h2 class="memtitle"><span class="permalink"><a href="#ac640eb913196c9edb68e5d52df4a89cb">&#9670;&nbsp;</a></span>onMotion()</h2>
  521. <div class="memitem">
  522. <div class="memproto">
  523. <table class="mlabels">
  524. <tr>
  525. <td class="mlabels-left">
  526. <table class="memname">
  527. <tr>
  528. <td class="memname">bool TopLevelWidget::onMotion </td>
  529. <td>(</td>
  530. <td class="paramtype">const <a class="el" href="structWidget_1_1MotionEvent.html">MotionEvent</a> &amp;&#160;</td>
  531. <td class="paramname"></td><td>)</td>
  532. <td></td>
  533. </tr>
  534. </table>
  535. </td>
  536. <td class="mlabels-right">
  537. <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  538. </tr>
  539. </table>
  540. </div><div class="memdoc">
  541. <p>A function called when the pointer moves. </p><dl class="section return"><dt>Returns</dt><dd>True to stop event propagation, false otherwise. </dd></dl>
  542. <p>Reimplemented from <a class="el" href="classWidget.html#a655569fb78a598652e9f24cefa1fe4a5">Widget</a>.</p>
  543. </div>
  544. </div>
  545. <a id="a412a6ce96a4ef7f64396e312ad072f9d"></a>
  546. <h2 class="memtitle"><span class="permalink"><a href="#a412a6ce96a4ef7f64396e312ad072f9d">&#9670;&nbsp;</a></span>onScroll()</h2>
  547. <div class="memitem">
  548. <div class="memproto">
  549. <table class="mlabels">
  550. <tr>
  551. <td class="mlabels-left">
  552. <table class="memname">
  553. <tr>
  554. <td class="memname">bool TopLevelWidget::onScroll </td>
  555. <td>(</td>
  556. <td class="paramtype">const <a class="el" href="structWidget_1_1ScrollEvent.html">ScrollEvent</a> &amp;&#160;</td>
  557. <td class="paramname"></td><td>)</td>
  558. <td></td>
  559. </tr>
  560. </table>
  561. </td>
  562. <td class="mlabels-right">
  563. <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  564. </tr>
  565. </table>
  566. </div><div class="memdoc">
  567. <p>A function called on scrolling (e.g. mouse wheel or track pad). </p><dl class="section return"><dt>Returns</dt><dd>True to stop event propagation, false otherwise. </dd></dl>
  568. <p>Reimplemented from <a class="el" href="classWidget.html#a0d78d28bd4a98c3a016a38091b2d4185">Widget</a>.</p>
  569. </div>
  570. </div>
  571. <hr/>The documentation for this class was generated from the following file:<ul>
  572. <li>dgl/<a class="el" href="TopLevelWidget_8hpp_source.html">TopLevelWidget.hpp</a></li>
  573. </ul>
  574. </div><!-- contents -->
  575. <!-- start footer part -->
  576. <hr class="footer"/><address class="footer"><small>
  577. 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
  578. </small></address>
  579. </body>
  580. </html>