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.

341 lines
28KB

  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.8.17"/>
  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.8.17 -->
  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');
  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="#friends">Friends</a> &#124;
  65. <a href="classTopLevelWidget-members.html">List of all members</a> </div>
  66. <div class="headertitle">
  67. <div class="title">TopLevelWidget Class Reference</div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <p><code>#include &lt;<a class="el" href="TopLevelWidget_8hpp_source.html">TopLevelWidget.hpp</a>&gt;</code></p>
  71. <div class="dynheader">
  72. Inheritance diagram for TopLevelWidget:</div>
  73. <div class="dyncontent">
  74. <div class="center">
  75. <img src="classTopLevelWidget.png" usemap="#TopLevelWidget_map" alt=""/>
  76. <map id="TopLevelWidget_map" name="TopLevelWidget_map">
  77. <area href="classWidget.html" alt="Widget" shape="rect" coords="0,0,235,24"/>
  78. <area href="classStandaloneWindow.html" alt="StandaloneWindow" shape="rect" coords="0,112,235,136"/>
  79. <area href="classImageBaseAboutWindow.html" alt="ImageBaseAboutWindow&lt; ImageType &gt;" shape="rect" coords="0,168,235,192"/>
  80. </map>
  81. </div></div>
  82. <table class="memberdecls">
  83. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  84. Public Member Functions</h2></td></tr>
  85. <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>
  86. <tr class="separator:a3cdeec5e7b144cc48d89e748a37f538e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a73c0ee0ce1e84c9e18d0f6dcdcb9104a"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#a73c0ee0ce1e84c9e18d0f6dcdcb9104a">~TopLevelWidget</a> ()</td></tr>
  88. <tr class="separator:a73c0ee0ce1e84c9e18d0f6dcdcb9104a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <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>
  90. <tr class="separator:af5c5c403ba231c14b3a41684bef45648"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <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>
  92. <tr class="separator:a3ceb7af6e9372a139d40a5859dfd0e4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a5569262e4859b2b59832af4fb8409ddc"><td class="memItemLeft" align="right" valign="top"><a id="a5569262e4859b2b59832af4fb8409ddc"></a>
  94. 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>
  95. <tr class="separator:a5569262e4859b2b59832af4fb8409ddc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a4cf1a5a0ea4f266fde337e9756c82c41"><td class="memItemLeft" align="right" valign="top"><a id="a4cf1a5a0ea4f266fde337e9756c82c41"></a>
  97. bool&#160;</td><td class="memItemRight" valign="bottom"><b>removeIdleCallback</b> (<a class="el" href="structIdleCallback.html">IdleCallback</a> *callback)</td></tr>
  98. <tr class="separator:a4cf1a5a0ea4f266fde337e9756c82c41"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:a8f8c6b72513abeb782cdbed5b24c6fb8"><td class="memItemLeft" align="right" valign="top"><a id="a8f8c6b72513abeb782cdbed5b24c6fb8"></a>
  100. double&#160;</td><td class="memItemRight" valign="bottom"><b>getScaleFactor</b> () const noexcept</td></tr>
  101. <tr class="separator:a8f8c6b72513abeb782cdbed5b24c6fb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:ad03702ffcbafa87ec546994891d4cd8a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#ad03702ffcbafa87ec546994891d4cd8a">repaint</a> () noexcept</td></tr>
  103. <tr class="separator:ad03702ffcbafa87ec546994891d4cd8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a4a9b2d040ba36825fd95f966bb4d9e36"><td class="memItemLeft" align="right" valign="top"><a id="a4a9b2d040ba36825fd95f966bb4d9e36"></a>
  105. void&#160;</td><td class="memItemRight" valign="bottom"><b>repaint</b> (const <a class="el" href="classRectangle.html">Rectangle</a>&lt; uint &gt; &amp;rect) noexcept</td></tr>
  106. <tr class="separator:a4a9b2d040ba36825fd95f966bb4d9e36"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a017b8d4994d1df395497cbbba22152ef"><td class="memItemLeft" align="right" valign="top"><a id="a017b8d4994d1df395497cbbba22152ef"></a>
  108. void&#160;</td><td class="memItemRight" valign="bottom"><b>setGeometryConstraints</b> (uint minimumWidth, uint minimumHeight, bool keepAspectRatio=false, bool automaticallyScale=false)</td></tr>
  109. <tr class="separator:a017b8d4994d1df395497cbbba22152ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a608102a97b9b66636d947d029cbc87ac"><td class="memItemLeft" align="right" valign="top"><a id="a608102a97b9b66636d947d029cbc87ac"></a>
  111. <a class="el" href="classApplication.html">Application</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>getParentApp</b> () const noexcept</td></tr>
  112. <tr class="separator:a608102a97b9b66636d947d029cbc87ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:a5eaf5a87cf735945a40945523b3f1fbb"><td class="memItemLeft" align="right" valign="top"><a id="a5eaf5a87cf735945a40945523b3f1fbb"></a>
  114. <a class="el" href="classWindow.html">Window</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>getParentWindow</b> () const noexcept</td></tr>
  115. <tr class="separator:a5eaf5a87cf735945a40945523b3f1fbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <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>
  117. <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>
  118. <tr class="separator:a714cf798aadb4d615f6f60a355382c02 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <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>
  120. <tr class="separator:a234a8ee8a685dc211ad11f492f0dbc71 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <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>
  122. <tr class="separator:a66088a03691f9c643ff335fa826576ba inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <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>
  124. <tr class="separator:a25ff178539e226b5f30ef0335d060f2b inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <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>
  126. <tr class="separator:a4a2f8eebacdd20db505b838f1a118c6b inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <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>
  128. <tr class="separator:a169c317caf734c6664494a573e427b40 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <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>
  130. <tr class="separator:aa20f6dc096a8836706173f31324c4db8 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <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>
  132. <tr class="separator:a9044d42c20ead27dba983b710c94f8d6 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <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>
  134. <tr class="separator:aed80a9cbc4a13c01641f35dd3d8688ea inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <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>
  136. <tr class="separator:ac6d2e6cbb2ff96f3645493d804af07f7 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <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>
  138. <tr class="separator:ab4d9e0156e455db3ff23730f82544daa inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <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>
  140. <tr class="separator:afce784b204902c0f11e9ed02bc692362 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <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>
  142. <tr class="separator:a3ee6b2824e3f3719c1c9b3d070385f49 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <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>
  144. <tr class="separator:abfba3652559de84ba1ae9ccbd3d35e31 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <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>
  146. <tr class="separator:a373419bc6353abf50a502cdbebd736e7 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <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>
  148. <tr class="separator:a0ef05695aec704b0eb1eb91c2e8af07d inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <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>
  150. <tr class="separator:ae23d09ec0e5f0397a3451b603b407182 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <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>
  152. <tr class="separator:a607b153f7d3187ca60bf21004efc1314 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:aa514fb1c20038ba9793e4409e9b18876 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top"><a id="aa514fb1c20038ba9793e4409e9b18876"></a>
  154. <a class="el" href="classApplication.html">Application</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>getParentApp</b> () const noexcept</td></tr>
  155. <tr class="separator:aa514fb1c20038ba9793e4409e9b18876 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <tr class="memitem:a0e0b0b2293bb63b2d84774542cc6a421 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top"><a id="a0e0b0b2293bb63b2d84774542cc6a421"></a>
  157. <a class="el" href="classWindow.html">Window</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>getParentWindow</b> () const noexcept</td></tr>
  158. <tr class="separator:a0e0b0b2293bb63b2d84774542cc6a421 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. </table><table class="memberdecls">
  160. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  161. Friends</h2></td></tr>
  162. <tr class="memitem:a553f958a25683445088050a69d3de8e9"><td class="memItemLeft" align="right" valign="top"><a id="a553f958a25683445088050a69d3de8e9"></a>
  163. class&#160;</td><td class="memItemRight" valign="bottom"><b>Window</b></td></tr>
  164. <tr class="separator:a553f958a25683445088050a69d3de8e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. </table><table class="memberdecls">
  166. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  167. Additional Inherited Members</h2></td></tr>
  168. <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>
  169. <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>
  170. <tr class="separator:ae1554f348fe3b2f9d4c3c5c4f9ec55bd inherit pro_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  171. <tr class="memitem:a9fa874aede538b41348f1029524aea11 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#a9fa874aede538b41348f1029524aea11">onKeyboard</a> (const <a class="el" href="structWidget_1_1KeyboardEvent.html">KeyboardEvent</a> &amp;)</td></tr>
  172. <tr class="separator:a9fa874aede538b41348f1029524aea11 inherit pro_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  173. <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 <a class="el" href="structWidget_1_1SpecialEvent.html">SpecialEvent</a> &amp;)</td></tr>
  174. <tr class="separator:a3b42652fcb2f95c6f86bdd43a1727507 inherit pro_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  175. <tr class="memitem:ad7fb24de24d8809305b04ff3750f0dea 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#ad7fb24de24d8809305b04ff3750f0dea">onCharacterInput</a> (const <a class="el" href="structWidget_1_1CharacterInputEvent.html">CharacterInputEvent</a> &amp;)</td></tr>
  176. <tr class="separator:ad7fb24de24d8809305b04ff3750f0dea inherit pro_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  177. <tr class="memitem:a097ec1d56a06bdc9e0a4e54880def378 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#a097ec1d56a06bdc9e0a4e54880def378">onMouse</a> (const <a class="el" href="structWidget_1_1MouseEvent.html">MouseEvent</a> &amp;)</td></tr>
  178. <tr class="separator:a097ec1d56a06bdc9e0a4e54880def378 inherit pro_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  179. <tr class="memitem:a655569fb78a598652e9f24cefa1fe4a5 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#a655569fb78a598652e9f24cefa1fe4a5">onMotion</a> (const <a class="el" href="structWidget_1_1MotionEvent.html">MotionEvent</a> &amp;)</td></tr>
  180. <tr class="separator:a655569fb78a598652e9f24cefa1fe4a5 inherit pro_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  181. <tr class="memitem:a0d78d28bd4a98c3a016a38091b2d4185 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#a0d78d28bd4a98c3a016a38091b2d4185">onScroll</a> (const <a class="el" href="structWidget_1_1ScrollEvent.html">ScrollEvent</a> &amp;)</td></tr>
  182. <tr class="separator:a0d78d28bd4a98c3a016a38091b2d4185 inherit pro_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  183. <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>
  184. <tr class="separator:acc0365ec4b9245bdffb8d0285be55dea inherit pro_methods_classWidget"><td class="memSeparator" colspan="2">&#160;</td></tr>
  185. </table>
  186. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  187. <div class="textblock"><p>Top-Level <a class="el" href="classWidget.html">Widget</a> class.</p>
  188. <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>
  189. <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>
  190. <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>
  191. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  192. <a id="a3cdeec5e7b144cc48d89e748a37f538e"></a>
  193. <h2 class="memtitle"><span class="permalink"><a href="#a3cdeec5e7b144cc48d89e748a37f538e">&#9670;&nbsp;</a></span>TopLevelWidget()</h2>
  194. <div class="memitem">
  195. <div class="memproto">
  196. <table class="mlabels">
  197. <tr>
  198. <td class="mlabels-left">
  199. <table class="memname">
  200. <tr>
  201. <td class="memname">TopLevelWidget::TopLevelWidget </td>
  202. <td>(</td>
  203. <td class="paramtype"><a class="el" href="classWindow.html">Window</a> &amp;&#160;</td>
  204. <td class="paramname"><em>windowToMapTo</em></td><td>)</td>
  205. <td></td>
  206. </tr>
  207. </table>
  208. </td>
  209. <td class="mlabels-right">
  210. <span class="mlabels"><span class="mlabel">explicit</span></span> </td>
  211. </tr>
  212. </table>
  213. </div><div class="memdoc">
  214. <p>Constructor. </p>
  215. </div>
  216. </div>
  217. <a id="a73c0ee0ce1e84c9e18d0f6dcdcb9104a"></a>
  218. <h2 class="memtitle"><span class="permalink"><a href="#a73c0ee0ce1e84c9e18d0f6dcdcb9104a">&#9670;&nbsp;</a></span>~TopLevelWidget()</h2>
  219. <div class="memitem">
  220. <div class="memproto">
  221. <table class="mlabels">
  222. <tr>
  223. <td class="mlabels-left">
  224. <table class="memname">
  225. <tr>
  226. <td class="memname">virtual TopLevelWidget::~TopLevelWidget </td>
  227. <td>(</td>
  228. <td class="paramname"></td><td>)</td>
  229. <td></td>
  230. </tr>
  231. </table>
  232. </td>
  233. <td class="mlabels-right">
  234. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  235. </tr>
  236. </table>
  237. </div><div class="memdoc">
  238. <p>Destructor. </p>
  239. </div>
  240. </div>
  241. <h2 class="groupheader">Member Function Documentation</h2>
  242. <a id="af5c5c403ba231c14b3a41684bef45648"></a>
  243. <h2 class="memtitle"><span class="permalink"><a href="#af5c5c403ba231c14b3a41684bef45648">&#9670;&nbsp;</a></span>getApp()</h2>
  244. <div class="memitem">
  245. <div class="memproto">
  246. <table class="mlabels">
  247. <tr>
  248. <td class="mlabels-left">
  249. <table class="memname">
  250. <tr>
  251. <td class="memname"><a class="el" href="classApplication.html">Application</a>&amp; TopLevelWidget::getApp </td>
  252. <td>(</td>
  253. <td class="paramname"></td><td>)</td>
  254. <td> const</td>
  255. </tr>
  256. </table>
  257. </td>
  258. <td class="mlabels-right">
  259. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  260. </tr>
  261. </table>
  262. </div><div class="memdoc">
  263. <p>Get the application associated with this top-level widget's window. </p>
  264. </div>
  265. </div>
  266. <a id="a3ceb7af6e9372a139d40a5859dfd0e4d"></a>
  267. <h2 class="memtitle"><span class="permalink"><a href="#a3ceb7af6e9372a139d40a5859dfd0e4d">&#9670;&nbsp;</a></span>getWindow()</h2>
  268. <div class="memitem">
  269. <div class="memproto">
  270. <table class="mlabels">
  271. <tr>
  272. <td class="mlabels-left">
  273. <table class="memname">
  274. <tr>
  275. <td class="memname"><a class="el" href="classWindow.html">Window</a>&amp; TopLevelWidget::getWindow </td>
  276. <td>(</td>
  277. <td class="paramname"></td><td>)</td>
  278. <td> const</td>
  279. </tr>
  280. </table>
  281. </td>
  282. <td class="mlabels-right">
  283. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  284. </tr>
  285. </table>
  286. </div><div class="memdoc">
  287. <p>Get the window associated with this top-level widget. </p>
  288. </div>
  289. </div>
  290. <a id="ad03702ffcbafa87ec546994891d4cd8a"></a>
  291. <h2 class="memtitle"><span class="permalink"><a href="#ad03702ffcbafa87ec546994891d4cd8a">&#9670;&nbsp;</a></span>repaint()</h2>
  292. <div class="memitem">
  293. <div class="memproto">
  294. <table class="mlabels">
  295. <tr>
  296. <td class="mlabels-left">
  297. <table class="memname">
  298. <tr>
  299. <td class="memname">void TopLevelWidget::repaint </td>
  300. <td>(</td>
  301. <td class="paramname"></td><td>)</td>
  302. <td></td>
  303. </tr>
  304. </table>
  305. </td>
  306. <td class="mlabels-right">
  307. <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">noexcept</span></span> </td>
  308. </tr>
  309. </table>
  310. </div><div class="memdoc">
  311. <p>Request repaint of this widget's area to the window this widget belongs to. On the raw <a class="el" href="classWidget.html">Widget</a> class this function does nothing. </p>
  312. <p>Reimplemented from <a class="el" href="classWidget.html#abe8cfe0aaae71dd011cf9a86e930fd12">Widget</a>.</p>
  313. </div>
  314. </div>
  315. <hr/>The documentation for this class was generated from the following file:<ul>
  316. <li>dgl/<a class="el" href="TopLevelWidget_8hpp_source.html">TopLevelWidget.hpp</a></li>
  317. </ul>
  318. </div><!-- contents -->
  319. <!-- start footer part -->
  320. <hr class="footer"/><address class="footer"><small>
  321. Generated on Tue May 18 2021 11:21:12 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">
  322. <img class="footer" src="doxygen.png" alt="doxygen"/>
  323. </a> 1.8.17
  324. </small></address>
  325. </body>
  326. </html>