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.

1138 lines
51KB

  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 Class 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><!-- top -->
  82. <div class="header">
  83. <div class="summary">
  84. <a href="#nested-classes">Classes</a> &#124;
  85. <a href="#pub-methods">Public Member Functions</a> &#124;
  86. <a href="#pro-methods">Protected Member Functions</a> &#124;
  87. <a href="#friends">Friends</a> &#124;
  88. <a href="classWidget-members.html">List of all members</a> </div>
  89. <div class="headertitle">
  90. <div class="title">Widget Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  91. </div><!--header-->
  92. <div class="contents">
  93. <p><code>#include &lt;<a class="el" href="Widget_8hpp_source.html">Widget.hpp</a>&gt;</code></p>
  94. <div class="dynheader">
  95. Inheritance diagram for Widget:</div>
  96. <div class="dyncontent">
  97. <div class="center">
  98. <img src="classWidget.png" usemap="#Widget_map" alt=""/>
  99. <map id="Widget_map" name="Widget_map">
  100. <area href="classImageAboutWindow.html" alt="ImageAboutWindow" shape="rect" coords="0,56,122,80"/>
  101. <area href="classImageButton.html" alt="ImageButton" shape="rect" coords="132,56,254,80"/>
  102. <area href="classImageKnob.html" alt="ImageKnob" shape="rect" coords="264,56,386,80"/>
  103. <area href="classImageSlider.html" alt="ImageSlider" shape="rect" coords="396,56,518,80"/>
  104. <area href="classImageSwitch.html" alt="ImageSwitch" shape="rect" coords="528,56,650,80"/>
  105. <area href="classNanoWidget.html" alt="NanoWidget" shape="rect" coords="660,56,782,80"/>
  106. </map>
  107. </div></div>
  108. <table class="memberdecls">
  109. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  110. Classes</h2></td></tr>
  111. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1BaseEvent.html">BaseEvent</a></td></tr>
  112. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1KeyboardEvent.html">KeyboardEvent</a></td></tr>
  114. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1MotionEvent.html">MotionEvent</a></td></tr>
  116. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1MouseEvent.html">MouseEvent</a></td></tr>
  118. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1ResizeEvent.html">ResizeEvent</a></td></tr>
  120. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1ScrollEvent.html">ScrollEvent</a></td></tr>
  122. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1SpecialEvent.html">SpecialEvent</a></td></tr>
  124. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. </table><table class="memberdecls">
  126. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  127. Public Member Functions</h2></td></tr>
  128. <tr class="memitem:a556f58c8ff8a80ae22cc4df7e5f8218c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a556f58c8ff8a80ae22cc4df7e5f8218c">Widget</a> (<a class="el" href="classWindow.html">Window</a> &amp;parent)</td></tr>
  129. <tr class="separator:a556f58c8ff8a80ae22cc4df7e5f8218c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a714cf798aadb4d615f6f60a355382c02"><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>
  131. <tr class="separator:a714cf798aadb4d615f6f60a355382c02"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a234a8ee8a685dc211ad11f492f0dbc71"><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>
  133. <tr class="separator:a234a8ee8a685dc211ad11f492f0dbc71"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a0bec84d07a6c508e069da9821993d1c2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a0bec84d07a6c508e069da9821993d1c2">setVisible</a> (bool yesNo)</td></tr>
  135. <tr class="separator:a0bec84d07a6c508e069da9821993d1c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a25ff178539e226b5f30ef0335d060f2b"><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>
  137. <tr class="separator:a25ff178539e226b5f30ef0335d060f2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a4a2f8eebacdd20db505b838f1a118c6b"><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>
  139. <tr class="separator:a4a2f8eebacdd20db505b838f1a118c6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:a169c317caf734c6664494a573e427b40"><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>
  141. <tr class="separator:a169c317caf734c6664494a573e427b40"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:aa20f6dc096a8836706173f31324c4db8"><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>
  143. <tr class="separator:aa20f6dc096a8836706173f31324c4db8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:ae375b05cd76f63c957949e9121ff56bb"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classSize.html">Size</a>&lt; uint &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#ae375b05cd76f63c957949e9121ff56bb">getSize</a> () const noexcept</td></tr>
  145. <tr class="separator:ae375b05cd76f63c957949e9121ff56bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:aed80a9cbc4a13c01641f35dd3d8688ea"><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>
  147. <tr class="separator:aed80a9cbc4a13c01641f35dd3d8688ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:ac6d2e6cbb2ff96f3645493d804af07f7"><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>
  149. <tr class="separator:ac6d2e6cbb2ff96f3645493d804af07f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:ab4d9e0156e455db3ff23730f82544daa"><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>
  151. <tr class="separator:ab4d9e0156e455db3ff23730f82544daa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:afce784b204902c0f11e9ed02bc692362"><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>
  153. <tr class="separator:afce784b204902c0f11e9ed02bc692362"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:a4e41debfe323ee307706af42818636dd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a4e41debfe323ee307706af42818636dd">getAbsoluteX</a> () const noexcept</td></tr>
  155. <tr class="separator:a4e41debfe323ee307706af42818636dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <tr class="memitem:af2ee4713e052b65e839da667aec4e05a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#af2ee4713e052b65e839da667aec4e05a">getAbsoluteY</a> () const noexcept</td></tr>
  157. <tr class="separator:af2ee4713e052b65e839da667aec4e05a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:ae952149aa2b1661ebc9712547ac5cc04"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classPoint.html">Point</a>&lt; int &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#ae952149aa2b1661ebc9712547ac5cc04">getAbsolutePos</a> () const noexcept</td></tr>
  159. <tr class="separator:ae952149aa2b1661ebc9712547ac5cc04"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:a56b6c0c92551d25bafa54be5d185e4f6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a56b6c0c92551d25bafa54be5d185e4f6">setAbsoluteX</a> (int x) noexcept</td></tr>
  161. <tr class="separator:a56b6c0c92551d25bafa54be5d185e4f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <tr class="memitem:a65f48c414326491ddb3bbb70bf783829"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a65f48c414326491ddb3bbb70bf783829">setAbsoluteY</a> (int y) noexcept</td></tr>
  163. <tr class="separator:a65f48c414326491ddb3bbb70bf783829"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <tr class="memitem:a1f58ab9f12f0e88da6bf600c504b53c5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a1f58ab9f12f0e88da6bf600c504b53c5">setAbsolutePos</a> (int x, int y) noexcept</td></tr>
  165. <tr class="separator:a1f58ab9f12f0e88da6bf600c504b53c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <tr class="memitem:a65b3a31bbf5cfbecdf5cf84ae27ae089"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a65b3a31bbf5cfbecdf5cf84ae27ae089">setAbsolutePos</a> (const <a class="el" href="classPoint.html">Point</a>&lt; int &gt; &amp;pos) noexcept</td></tr>
  167. <tr class="separator:a65b3a31bbf5cfbecdf5cf84ae27ae089"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <tr class="memitem:afa1fe45064cf9bb107fe1dcdb2384d33"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApp.html">App</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#afa1fe45064cf9bb107fe1dcdb2384d33">getParentApp</a> () const noexcept</td></tr>
  169. <tr class="separator:afa1fe45064cf9bb107fe1dcdb2384d33"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. <tr class="memitem:a0e0b0b2293bb63b2d84774542cc6a421"><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#a0e0b0b2293bb63b2d84774542cc6a421">getParentWindow</a> () const noexcept</td></tr>
  171. <tr class="separator:a0e0b0b2293bb63b2d84774542cc6a421"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <tr class="memitem:a655f9dac3838b52a3deec1a4b9e6001b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a655f9dac3838b52a3deec1a4b9e6001b">contains</a> (int x, int y) const noexcept</td></tr>
  173. <tr class="separator:a655f9dac3838b52a3deec1a4b9e6001b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  174. <tr class="memitem:a9dc3a8c1c7fe1dd0ffa28577f1eaa5fd"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a9dc3a8c1c7fe1dd0ffa28577f1eaa5fd">contains</a> (const <a class="el" href="classPoint.html">Point</a>&lt; int &gt; &amp;pos) const noexcept</td></tr>
  175. <tr class="separator:a9dc3a8c1c7fe1dd0ffa28577f1eaa5fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  176. <tr class="memitem:a808fa28a78ec9e850d5e86f63b3be26d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a808fa28a78ec9e850d5e86f63b3be26d">repaint</a> () noexcept</td></tr>
  177. <tr class="separator:a808fa28a78ec9e850d5e86f63b3be26d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  178. <tr class="memitem:a3ee6b2824e3f3719c1c9b3d070385f49"><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>
  179. <tr class="separator:a3ee6b2824e3f3719c1c9b3d070385f49"><td class="memSeparator" colspan="2">&#160;</td></tr>
  180. <tr class="memitem:abfba3652559de84ba1ae9ccbd3d35e31"><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>
  181. <tr class="separator:abfba3652559de84ba1ae9ccbd3d35e31"><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:ae1554f348fe3b2f9d4c3c5c4f9ec55bd"><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>
  186. <tr class="separator:ae1554f348fe3b2f9d4c3c5c4f9ec55bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  187. <tr class="memitem:a9fa874aede538b41348f1029524aea11"><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>
  188. <tr class="separator:a9fa874aede538b41348f1029524aea11"><td class="memSeparator" colspan="2">&#160;</td></tr>
  189. <tr class="memitem:a3b42652fcb2f95c6f86bdd43a1727507"><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>
  190. <tr class="separator:a3b42652fcb2f95c6f86bdd43a1727507"><td class="memSeparator" colspan="2">&#160;</td></tr>
  191. <tr class="memitem:a097ec1d56a06bdc9e0a4e54880def378"><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>
  192. <tr class="separator:a097ec1d56a06bdc9e0a4e54880def378"><td class="memSeparator" colspan="2">&#160;</td></tr>
  193. <tr class="memitem:a655569fb78a598652e9f24cefa1fe4a5"><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>
  194. <tr class="separator:a655569fb78a598652e9f24cefa1fe4a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  195. <tr class="memitem:a0d78d28bd4a98c3a016a38091b2d4185"><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>
  196. <tr class="separator:a0d78d28bd4a98c3a016a38091b2d4185"><td class="memSeparator" colspan="2">&#160;</td></tr>
  197. <tr class="memitem:acc0365ec4b9245bdffb8d0285be55dea"><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>
  198. <tr class="separator:acc0365ec4b9245bdffb8d0285be55dea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  199. <tr class="memitem:aa92462db80ed1dc8334910038cd262cc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#aa92462db80ed1dc8334910038cd262cc">setNeedsFullViewport</a> (bool yesNo) noexcept</td></tr>
  200. <tr class="separator:aa92462db80ed1dc8334910038cd262cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  201. <tr class="memitem:a2ce358088e8f3b65621afd02c675bad8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a2ce358088e8f3b65621afd02c675bad8">setNeedsScaling</a> (bool yesNo) noexcept</td></tr>
  202. <tr class="separator:a2ce358088e8f3b65621afd02c675bad8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  203. </table><table class="memberdecls">
  204. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  205. Friends</h2></td></tr>
  206. <tr class="memitem:a553f958a25683445088050a69d3de8e9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a553f958a25683445088050a69d3de8e9"></a>
  207. class&#160;</td><td class="memItemRight" valign="bottom"><b>Window</b></td></tr>
  208. <tr class="separator:a553f958a25683445088050a69d3de8e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  209. <tr class="memitem:a46d8d52b6ee3f8a662192a4b4775cb3e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a46d8d52b6ee3f8a662192a4b4775cb3e"></a>
  210. class&#160;</td><td class="memItemRight" valign="bottom"><b>StandaloneWindow</b></td></tr>
  211. <tr class="separator:a46d8d52b6ee3f8a662192a4b4775cb3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  212. </table>
  213. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  214. <div class="textblock"><p>Base DGL <a class="el" href="classWidget.html">Widget</a> class.</p>
  215. <p>This is the base <a class="el" href="classWidget.html">Widget</a> class, from which all widgets are built.</p>
  216. <p>All widgets have a parent <a class="el" href="classWindow.html">Window</a> where they'll be drawn. This parent is never changed during the widget lifetime.</p>
  217. <p>Widgets receive events in relative coordinates. (0, 0) means its top-left position.</p>
  218. <p>Windows paint widgets in the order they are constructed. Early widgets are drawn first, at the bottom, then newer ones on top. Events are sent in the inverse order so that the top-most widget gets a chance to catch the event and stop its propagation.</p>
  219. <p>All widget event callbacks do nothing by default. </p>
  220. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  221. <a class="anchor" id="a556f58c8ff8a80ae22cc4df7e5f8218c"></a>
  222. <div class="memitem">
  223. <div class="memproto">
  224. <table class="mlabels">
  225. <tr>
  226. <td class="mlabels-left">
  227. <table class="memname">
  228. <tr>
  229. <td class="memname">Widget::Widget </td>
  230. <td>(</td>
  231. <td class="paramtype"><a class="el" href="classWindow.html">Window</a> &amp;&#160;</td>
  232. <td class="paramname"><em>parent</em></td><td>)</td>
  233. <td></td>
  234. </tr>
  235. </table>
  236. </td>
  237. <td class="mlabels-right">
  238. <span class="mlabels"><span class="mlabel">explicit</span></span> </td>
  239. </tr>
  240. </table>
  241. </div><div class="memdoc">
  242. <p>Constructor. </p>
  243. </div>
  244. </div>
  245. <a class="anchor" id="a714cf798aadb4d615f6f60a355382c02"></a>
  246. <div class="memitem">
  247. <div class="memproto">
  248. <table class="mlabels">
  249. <tr>
  250. <td class="mlabels-left">
  251. <table class="memname">
  252. <tr>
  253. <td class="memname">virtual Widget::~Widget </td>
  254. <td>(</td>
  255. <td class="paramname"></td><td>)</td>
  256. <td></td>
  257. </tr>
  258. </table>
  259. </td>
  260. <td class="mlabels-right">
  261. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  262. </tr>
  263. </table>
  264. </div><div class="memdoc">
  265. <p>Destructor. </p>
  266. </div>
  267. </div>
  268. <h2 class="groupheader">Member Function Documentation</h2>
  269. <a class="anchor" id="a234a8ee8a685dc211ad11f492f0dbc71"></a>
  270. <div class="memitem">
  271. <div class="memproto">
  272. <table class="mlabels">
  273. <tr>
  274. <td class="mlabels-left">
  275. <table class="memname">
  276. <tr>
  277. <td class="memname">bool Widget::isVisible </td>
  278. <td>(</td>
  279. <td class="paramname"></td><td>)</td>
  280. <td> const</td>
  281. </tr>
  282. </table>
  283. </td>
  284. <td class="mlabels-right">
  285. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  286. </tr>
  287. </table>
  288. </div><div class="memdoc">
  289. <p>Check if this widget is visible within its parent window. Invisible widgets do not receive events except resize. </p>
  290. </div>
  291. </div>
  292. <a class="anchor" id="a0bec84d07a6c508e069da9821993d1c2"></a>
  293. <div class="memitem">
  294. <div class="memproto">
  295. <table class="memname">
  296. <tr>
  297. <td class="memname">void Widget::setVisible </td>
  298. <td>(</td>
  299. <td class="paramtype">bool&#160;</td>
  300. <td class="paramname"><em>yesNo</em></td><td>)</td>
  301. <td></td>
  302. </tr>
  303. </table>
  304. </div><div class="memdoc">
  305. <p>Set widget visible (or not) according to <em>yesNo</em>. </p>
  306. </div>
  307. </div>
  308. <a class="anchor" id="a25ff178539e226b5f30ef0335d060f2b"></a>
  309. <div class="memitem">
  310. <div class="memproto">
  311. <table class="memname">
  312. <tr>
  313. <td class="memname">void Widget::show </td>
  314. <td>(</td>
  315. <td class="paramname"></td><td>)</td>
  316. <td></td>
  317. </tr>
  318. </table>
  319. </div><div class="memdoc">
  320. <p>Show widget. This is the same as calling setVisible(true). </p>
  321. </div>
  322. </div>
  323. <a class="anchor" id="a4a2f8eebacdd20db505b838f1a118c6b"></a>
  324. <div class="memitem">
  325. <div class="memproto">
  326. <table class="memname">
  327. <tr>
  328. <td class="memname">void Widget::hide </td>
  329. <td>(</td>
  330. <td class="paramname"></td><td>)</td>
  331. <td></td>
  332. </tr>
  333. </table>
  334. </div><div class="memdoc">
  335. <p>Hide widget. This is the same as calling setVisible(false). </p>
  336. </div>
  337. </div>
  338. <a class="anchor" id="a169c317caf734c6664494a573e427b40"></a>
  339. <div class="memitem">
  340. <div class="memproto">
  341. <table class="mlabels">
  342. <tr>
  343. <td class="mlabels-left">
  344. <table class="memname">
  345. <tr>
  346. <td class="memname">uint Widget::getWidth </td>
  347. <td>(</td>
  348. <td class="paramname"></td><td>)</td>
  349. <td> const</td>
  350. </tr>
  351. </table>
  352. </td>
  353. <td class="mlabels-right">
  354. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  355. </tr>
  356. </table>
  357. </div><div class="memdoc">
  358. <p>Get width. </p>
  359. </div>
  360. </div>
  361. <a class="anchor" id="aa20f6dc096a8836706173f31324c4db8"></a>
  362. <div class="memitem">
  363. <div class="memproto">
  364. <table class="mlabels">
  365. <tr>
  366. <td class="mlabels-left">
  367. <table class="memname">
  368. <tr>
  369. <td class="memname">uint Widget::getHeight </td>
  370. <td>(</td>
  371. <td class="paramname"></td><td>)</td>
  372. <td> const</td>
  373. </tr>
  374. </table>
  375. </td>
  376. <td class="mlabels-right">
  377. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  378. </tr>
  379. </table>
  380. </div><div class="memdoc">
  381. <p>Get height. </p>
  382. </div>
  383. </div>
  384. <a class="anchor" id="ae375b05cd76f63c957949e9121ff56bb"></a>
  385. <div class="memitem">
  386. <div class="memproto">
  387. <table class="mlabels">
  388. <tr>
  389. <td class="mlabels-left">
  390. <table class="memname">
  391. <tr>
  392. <td class="memname">const <a class="el" href="classSize.html">Size</a>&lt;uint&gt;&amp; Widget::getSize </td>
  393. <td>(</td>
  394. <td class="paramname"></td><td>)</td>
  395. <td> const</td>
  396. </tr>
  397. </table>
  398. </td>
  399. <td class="mlabels-right">
  400. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  401. </tr>
  402. </table>
  403. </div><div class="memdoc">
  404. <p>Get size. </p>
  405. </div>
  406. </div>
  407. <a class="anchor" id="aed80a9cbc4a13c01641f35dd3d8688ea"></a>
  408. <div class="memitem">
  409. <div class="memproto">
  410. <table class="mlabels">
  411. <tr>
  412. <td class="mlabels-left">
  413. <table class="memname">
  414. <tr>
  415. <td class="memname">void Widget::setWidth </td>
  416. <td>(</td>
  417. <td class="paramtype">uint&#160;</td>
  418. <td class="paramname"><em>width</em></td><td>)</td>
  419. <td></td>
  420. </tr>
  421. </table>
  422. </td>
  423. <td class="mlabels-right">
  424. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  425. </tr>
  426. </table>
  427. </div><div class="memdoc">
  428. <p>Set width. </p>
  429. </div>
  430. </div>
  431. <a class="anchor" id="ac6d2e6cbb2ff96f3645493d804af07f7"></a>
  432. <div class="memitem">
  433. <div class="memproto">
  434. <table class="mlabels">
  435. <tr>
  436. <td class="mlabels-left">
  437. <table class="memname">
  438. <tr>
  439. <td class="memname">void Widget::setHeight </td>
  440. <td>(</td>
  441. <td class="paramtype">uint&#160;</td>
  442. <td class="paramname"><em>height</em></td><td>)</td>
  443. <td></td>
  444. </tr>
  445. </table>
  446. </td>
  447. <td class="mlabels-right">
  448. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  449. </tr>
  450. </table>
  451. </div><div class="memdoc">
  452. <p>Set height. </p>
  453. </div>
  454. </div>
  455. <a class="anchor" id="ab4d9e0156e455db3ff23730f82544daa"></a>
  456. <div class="memitem">
  457. <div class="memproto">
  458. <table class="mlabels">
  459. <tr>
  460. <td class="mlabels-left">
  461. <table class="memname">
  462. <tr>
  463. <td class="memname">void Widget::setSize </td>
  464. <td>(</td>
  465. <td class="paramtype">uint&#160;</td>
  466. <td class="paramname"><em>width</em>, </td>
  467. </tr>
  468. <tr>
  469. <td class="paramkey"></td>
  470. <td></td>
  471. <td class="paramtype">uint&#160;</td>
  472. <td class="paramname"><em>height</em>&#160;</td>
  473. </tr>
  474. <tr>
  475. <td></td>
  476. <td>)</td>
  477. <td></td><td></td>
  478. </tr>
  479. </table>
  480. </td>
  481. <td class="mlabels-right">
  482. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  483. </tr>
  484. </table>
  485. </div><div class="memdoc">
  486. <p>Set size using <em>width</em> and <em>height</em> values. </p>
  487. </div>
  488. </div>
  489. <a class="anchor" id="afce784b204902c0f11e9ed02bc692362"></a>
  490. <div class="memitem">
  491. <div class="memproto">
  492. <table class="mlabels">
  493. <tr>
  494. <td class="mlabels-left">
  495. <table class="memname">
  496. <tr>
  497. <td class="memname">void Widget::setSize </td>
  498. <td>(</td>
  499. <td class="paramtype">const <a class="el" href="classSize.html">Size</a>&lt; uint &gt; &amp;&#160;</td>
  500. <td class="paramname"><em>size</em></td><td>)</td>
  501. <td></td>
  502. </tr>
  503. </table>
  504. </td>
  505. <td class="mlabels-right">
  506. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  507. </tr>
  508. </table>
  509. </div><div class="memdoc">
  510. <p>Set size. </p>
  511. </div>
  512. </div>
  513. <a class="anchor" id="a4e41debfe323ee307706af42818636dd"></a>
  514. <div class="memitem">
  515. <div class="memproto">
  516. <table class="mlabels">
  517. <tr>
  518. <td class="mlabels-left">
  519. <table class="memname">
  520. <tr>
  521. <td class="memname">int Widget::getAbsoluteX </td>
  522. <td>(</td>
  523. <td class="paramname"></td><td>)</td>
  524. <td> const</td>
  525. </tr>
  526. </table>
  527. </td>
  528. <td class="mlabels-right">
  529. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  530. </tr>
  531. </table>
  532. </div><div class="memdoc">
  533. <p>Get absolute X. </p>
  534. </div>
  535. </div>
  536. <a class="anchor" id="af2ee4713e052b65e839da667aec4e05a"></a>
  537. <div class="memitem">
  538. <div class="memproto">
  539. <table class="mlabels">
  540. <tr>
  541. <td class="mlabels-left">
  542. <table class="memname">
  543. <tr>
  544. <td class="memname">int Widget::getAbsoluteY </td>
  545. <td>(</td>
  546. <td class="paramname"></td><td>)</td>
  547. <td> const</td>
  548. </tr>
  549. </table>
  550. </td>
  551. <td class="mlabels-right">
  552. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  553. </tr>
  554. </table>
  555. </div><div class="memdoc">
  556. <p>Get absolute Y. </p>
  557. </div>
  558. </div>
  559. <a class="anchor" id="ae952149aa2b1661ebc9712547ac5cc04"></a>
  560. <div class="memitem">
  561. <div class="memproto">
  562. <table class="mlabels">
  563. <tr>
  564. <td class="mlabels-left">
  565. <table class="memname">
  566. <tr>
  567. <td class="memname">const <a class="el" href="classPoint.html">Point</a>&lt;int&gt;&amp; Widget::getAbsolutePos </td>
  568. <td>(</td>
  569. <td class="paramname"></td><td>)</td>
  570. <td> const</td>
  571. </tr>
  572. </table>
  573. </td>
  574. <td class="mlabels-right">
  575. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  576. </tr>
  577. </table>
  578. </div><div class="memdoc">
  579. <p>Get absolute position. </p>
  580. </div>
  581. </div>
  582. <a class="anchor" id="a56b6c0c92551d25bafa54be5d185e4f6"></a>
  583. <div class="memitem">
  584. <div class="memproto">
  585. <table class="mlabels">
  586. <tr>
  587. <td class="mlabels-left">
  588. <table class="memname">
  589. <tr>
  590. <td class="memname">void Widget::setAbsoluteX </td>
  591. <td>(</td>
  592. <td class="paramtype">int&#160;</td>
  593. <td class="paramname"><em>x</em></td><td>)</td>
  594. <td></td>
  595. </tr>
  596. </table>
  597. </td>
  598. <td class="mlabels-right">
  599. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  600. </tr>
  601. </table>
  602. </div><div class="memdoc">
  603. <p>Set absolute X. </p>
  604. </div>
  605. </div>
  606. <a class="anchor" id="a65f48c414326491ddb3bbb70bf783829"></a>
  607. <div class="memitem">
  608. <div class="memproto">
  609. <table class="mlabels">
  610. <tr>
  611. <td class="mlabels-left">
  612. <table class="memname">
  613. <tr>
  614. <td class="memname">void Widget::setAbsoluteY </td>
  615. <td>(</td>
  616. <td class="paramtype">int&#160;</td>
  617. <td class="paramname"><em>y</em></td><td>)</td>
  618. <td></td>
  619. </tr>
  620. </table>
  621. </td>
  622. <td class="mlabels-right">
  623. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  624. </tr>
  625. </table>
  626. </div><div class="memdoc">
  627. <p>Set absolute Y. </p>
  628. </div>
  629. </div>
  630. <a class="anchor" id="a1f58ab9f12f0e88da6bf600c504b53c5"></a>
  631. <div class="memitem">
  632. <div class="memproto">
  633. <table class="mlabels">
  634. <tr>
  635. <td class="mlabels-left">
  636. <table class="memname">
  637. <tr>
  638. <td class="memname">void Widget::setAbsolutePos </td>
  639. <td>(</td>
  640. <td class="paramtype">int&#160;</td>
  641. <td class="paramname"><em>x</em>, </td>
  642. </tr>
  643. <tr>
  644. <td class="paramkey"></td>
  645. <td></td>
  646. <td class="paramtype">int&#160;</td>
  647. <td class="paramname"><em>y</em>&#160;</td>
  648. </tr>
  649. <tr>
  650. <td></td>
  651. <td>)</td>
  652. <td></td><td></td>
  653. </tr>
  654. </table>
  655. </td>
  656. <td class="mlabels-right">
  657. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  658. </tr>
  659. </table>
  660. </div><div class="memdoc">
  661. <p>Set absolute position using <em>x</em> and <em>y</em> values. </p>
  662. </div>
  663. </div>
  664. <a class="anchor" id="a65b3a31bbf5cfbecdf5cf84ae27ae089"></a>
  665. <div class="memitem">
  666. <div class="memproto">
  667. <table class="mlabels">
  668. <tr>
  669. <td class="mlabels-left">
  670. <table class="memname">
  671. <tr>
  672. <td class="memname">void Widget::setAbsolutePos </td>
  673. <td>(</td>
  674. <td class="paramtype">const <a class="el" href="classPoint.html">Point</a>&lt; int &gt; &amp;&#160;</td>
  675. <td class="paramname"><em>pos</em></td><td>)</td>
  676. <td></td>
  677. </tr>
  678. </table>
  679. </td>
  680. <td class="mlabels-right">
  681. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  682. </tr>
  683. </table>
  684. </div><div class="memdoc">
  685. <p>Set absolute position. </p>
  686. </div>
  687. </div>
  688. <a class="anchor" id="afa1fe45064cf9bb107fe1dcdb2384d33"></a>
  689. <div class="memitem">
  690. <div class="memproto">
  691. <table class="mlabels">
  692. <tr>
  693. <td class="mlabels-left">
  694. <table class="memname">
  695. <tr>
  696. <td class="memname"><a class="el" href="classApp.html">App</a>&amp; Widget::getParentApp </td>
  697. <td>(</td>
  698. <td class="paramname"></td><td>)</td>
  699. <td> const</td>
  700. </tr>
  701. </table>
  702. </td>
  703. <td class="mlabels-right">
  704. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  705. </tr>
  706. </table>
  707. </div><div class="memdoc">
  708. <p>Get this widget's window application. Same as calling <a class="el" href="classWidget.html#a0e0b0b2293bb63b2d84774542cc6a421">getParentWindow()</a>.getApp(). </p>
  709. </div>
  710. </div>
  711. <a class="anchor" id="a0e0b0b2293bb63b2d84774542cc6a421"></a>
  712. <div class="memitem">
  713. <div class="memproto">
  714. <table class="mlabels">
  715. <tr>
  716. <td class="mlabels-left">
  717. <table class="memname">
  718. <tr>
  719. <td class="memname"><a class="el" href="classWindow.html">Window</a>&amp; Widget::getParentWindow </td>
  720. <td>(</td>
  721. <td class="paramname"></td><td>)</td>
  722. <td> const</td>
  723. </tr>
  724. </table>
  725. </td>
  726. <td class="mlabels-right">
  727. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  728. </tr>
  729. </table>
  730. </div><div class="memdoc">
  731. <p>Get parent window, as passed in the constructor. </p>
  732. </div>
  733. </div>
  734. <a class="anchor" id="a655f9dac3838b52a3deec1a4b9e6001b"></a>
  735. <div class="memitem">
  736. <div class="memproto">
  737. <table class="mlabels">
  738. <tr>
  739. <td class="mlabels-left">
  740. <table class="memname">
  741. <tr>
  742. <td class="memname">bool Widget::contains </td>
  743. <td>(</td>
  744. <td class="paramtype">int&#160;</td>
  745. <td class="paramname"><em>x</em>, </td>
  746. </tr>
  747. <tr>
  748. <td class="paramkey"></td>
  749. <td></td>
  750. <td class="paramtype">int&#160;</td>
  751. <td class="paramname"><em>y</em>&#160;</td>
  752. </tr>
  753. <tr>
  754. <td></td>
  755. <td>)</td>
  756. <td></td><td> const</td>
  757. </tr>
  758. </table>
  759. </td>
  760. <td class="mlabels-right">
  761. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  762. </tr>
  763. </table>
  764. </div><div class="memdoc">
  765. <p>Check if this widget contains the point defined by <em>x</em> and <em>y</em>. </p>
  766. </div>
  767. </div>
  768. <a class="anchor" id="a9dc3a8c1c7fe1dd0ffa28577f1eaa5fd"></a>
  769. <div class="memitem">
  770. <div class="memproto">
  771. <table class="mlabels">
  772. <tr>
  773. <td class="mlabels-left">
  774. <table class="memname">
  775. <tr>
  776. <td class="memname">bool Widget::contains </td>
  777. <td>(</td>
  778. <td class="paramtype">const <a class="el" href="classPoint.html">Point</a>&lt; int &gt; &amp;&#160;</td>
  779. <td class="paramname"><em>pos</em></td><td>)</td>
  780. <td> const</td>
  781. </tr>
  782. </table>
  783. </td>
  784. <td class="mlabels-right">
  785. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  786. </tr>
  787. </table>
  788. </div><div class="memdoc">
  789. <p>Check if this widget contains the point <em>pos</em>. </p>
  790. </div>
  791. </div>
  792. <a class="anchor" id="a808fa28a78ec9e850d5e86f63b3be26d"></a>
  793. <div class="memitem">
  794. <div class="memproto">
  795. <table class="mlabels">
  796. <tr>
  797. <td class="mlabels-left">
  798. <table class="memname">
  799. <tr>
  800. <td class="memname">void Widget::repaint </td>
  801. <td>(</td>
  802. <td class="paramname"></td><td>)</td>
  803. <td></td>
  804. </tr>
  805. </table>
  806. </td>
  807. <td class="mlabels-right">
  808. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  809. </tr>
  810. </table>
  811. </div><div class="memdoc">
  812. <p>Tell this widget's window to repaint itself. </p>
  813. </div>
  814. </div>
  815. <a class="anchor" id="a3ee6b2824e3f3719c1c9b3d070385f49"></a>
  816. <div class="memitem">
  817. <div class="memproto">
  818. <table class="mlabels">
  819. <tr>
  820. <td class="mlabels-left">
  821. <table class="memname">
  822. <tr>
  823. <td class="memname">uint Widget::getId </td>
  824. <td>(</td>
  825. <td class="paramname"></td><td>)</td>
  826. <td> const</td>
  827. </tr>
  828. </table>
  829. </td>
  830. <td class="mlabels-right">
  831. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  832. </tr>
  833. </table>
  834. </div><div class="memdoc">
  835. <p>Get the Id associated with this widget. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classWidget.html#abfba3652559de84ba1ae9ccbd3d35e31">setId</a> </dd></dl>
  836. </div>
  837. </div>
  838. <a class="anchor" id="abfba3652559de84ba1ae9ccbd3d35e31"></a>
  839. <div class="memitem">
  840. <div class="memproto">
  841. <table class="mlabels">
  842. <tr>
  843. <td class="mlabels-left">
  844. <table class="memname">
  845. <tr>
  846. <td class="memname">void Widget::setId </td>
  847. <td>(</td>
  848. <td class="paramtype">uint&#160;</td>
  849. <td class="paramname"><em>id</em></td><td>)</td>
  850. <td></td>
  851. </tr>
  852. </table>
  853. </td>
  854. <td class="mlabels-right">
  855. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  856. </tr>
  857. </table>
  858. </div><div class="memdoc">
  859. <p>Set an Id to be associated with this widget. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classWidget.html#a3ee6b2824e3f3719c1c9b3d070385f49">getId</a> </dd></dl>
  860. </div>
  861. </div>
  862. <a class="anchor" id="ae1554f348fe3b2f9d4c3c5c4f9ec55bd"></a>
  863. <div class="memitem">
  864. <div class="memproto">
  865. <table class="mlabels">
  866. <tr>
  867. <td class="mlabels-left">
  868. <table class="memname">
  869. <tr>
  870. <td class="memname">virtual void Widget::onDisplay </td>
  871. <td>(</td>
  872. <td class="paramname"></td><td>)</td>
  873. <td></td>
  874. </tr>
  875. </table>
  876. </td>
  877. <td class="mlabels-right">
  878. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
  879. </tr>
  880. </table>
  881. </div><div class="memdoc">
  882. <p>A function called to draw the view contents with OpenGL. </p>
  883. <p>Implemented in <a class="el" href="classImageKnob.html#a7123a12c906463700df8c6f24cd0a62f">ImageKnob</a>, <a class="el" href="classImageSlider.html#a6c734dabcf0af01513fb5dec5b716831">ImageSlider</a>, <a class="el" href="classImageSwitch.html#a45cdf75bf08adf50742150f3d2029f76">ImageSwitch</a>, <a class="el" href="classImageButton.html#abb0d1081f8c794657ccbbcffb2d75efc">ImageButton</a>, and <a class="el" href="classImageAboutWindow.html#a4ebc99f9674e37ebdeeaa1ef9a71a0fc">ImageAboutWindow</a>.</p>
  884. </div>
  885. </div>
  886. <a class="anchor" id="a9fa874aede538b41348f1029524aea11"></a>
  887. <div class="memitem">
  888. <div class="memproto">
  889. <table class="mlabels">
  890. <tr>
  891. <td class="mlabels-left">
  892. <table class="memname">
  893. <tr>
  894. <td class="memname">virtual bool Widget::onKeyboard </td>
  895. <td>(</td>
  896. <td class="paramtype">const <a class="el" href="structWidget_1_1KeyboardEvent.html">KeyboardEvent</a> &amp;&#160;</td>
  897. <td class="paramname"></td><td>)</td>
  898. <td></td>
  899. </tr>
  900. </table>
  901. </td>
  902. <td class="mlabels-right">
  903. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  904. </tr>
  905. </table>
  906. </div><div class="memdoc">
  907. <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>
  908. <p>Reimplemented in <a class="el" href="classImageAboutWindow.html#a952891b12bf379fafc184abc77daef24">ImageAboutWindow</a>.</p>
  909. </div>
  910. </div>
  911. <a class="anchor" id="a3b42652fcb2f95c6f86bdd43a1727507"></a>
  912. <div class="memitem">
  913. <div class="memproto">
  914. <table class="mlabels">
  915. <tr>
  916. <td class="mlabels-left">
  917. <table class="memname">
  918. <tr>
  919. <td class="memname">virtual bool Widget::onSpecial </td>
  920. <td>(</td>
  921. <td class="paramtype">const <a class="el" href="structWidget_1_1SpecialEvent.html">SpecialEvent</a> &amp;&#160;</td>
  922. <td class="paramname"></td><td>)</td>
  923. <td></td>
  924. </tr>
  925. </table>
  926. </td>
  927. <td class="mlabels-right">
  928. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  929. </tr>
  930. </table>
  931. </div><div class="memdoc">
  932. <p>A function called when a special key is pressed or released. </p><dl class="section return"><dt>Returns</dt><dd>True to stop event propagation, false otherwise. </dd></dl>
  933. </div>
  934. </div>
  935. <a class="anchor" id="a097ec1d56a06bdc9e0a4e54880def378"></a>
  936. <div class="memitem">
  937. <div class="memproto">
  938. <table class="mlabels">
  939. <tr>
  940. <td class="mlabels-left">
  941. <table class="memname">
  942. <tr>
  943. <td class="memname">virtual bool Widget::onMouse </td>
  944. <td>(</td>
  945. <td class="paramtype">const <a class="el" href="structWidget_1_1MouseEvent.html">MouseEvent</a> &amp;&#160;</td>
  946. <td class="paramname"></td><td>)</td>
  947. <td></td>
  948. </tr>
  949. </table>
  950. </td>
  951. <td class="mlabels-right">
  952. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  953. </tr>
  954. </table>
  955. </div><div class="memdoc">
  956. <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>
  957. <p>Reimplemented in <a class="el" href="classImageKnob.html#a473247914d3751d629dd8690f74af07b">ImageKnob</a>, <a class="el" href="classImageSlider.html#a6ffe0c5b79ef8e397876154b904f0981">ImageSlider</a>, <a class="el" href="classImageSwitch.html#aa2371a540211636f96ac3a3a161ee563">ImageSwitch</a>, <a class="el" href="classImageButton.html#acea33c4a730d0dce4f87a67cc290d747">ImageButton</a>, and <a class="el" href="classImageAboutWindow.html#a5af153208057de4baf7264c9a7bd30cd">ImageAboutWindow</a>.</p>
  958. </div>
  959. </div>
  960. <a class="anchor" id="a655569fb78a598652e9f24cefa1fe4a5"></a>
  961. <div class="memitem">
  962. <div class="memproto">
  963. <table class="mlabels">
  964. <tr>
  965. <td class="mlabels-left">
  966. <table class="memname">
  967. <tr>
  968. <td class="memname">virtual bool Widget::onMotion </td>
  969. <td>(</td>
  970. <td class="paramtype">const <a class="el" href="structWidget_1_1MotionEvent.html">MotionEvent</a> &amp;&#160;</td>
  971. <td class="paramname"></td><td>)</td>
  972. <td></td>
  973. </tr>
  974. </table>
  975. </td>
  976. <td class="mlabels-right">
  977. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  978. </tr>
  979. </table>
  980. </div><div class="memdoc">
  981. <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>
  982. <p>Reimplemented in <a class="el" href="classImageKnob.html#a299a1721471747dc173633f21bd75b1f">ImageKnob</a>, <a class="el" href="classImageSlider.html#a2950b1058ae7c6d20397135615b4583c">ImageSlider</a>, and <a class="el" href="classImageButton.html#a53676b7a0cc31f78a371ef363344f7ba">ImageButton</a>.</p>
  983. </div>
  984. </div>
  985. <a class="anchor" id="a0d78d28bd4a98c3a016a38091b2d4185"></a>
  986. <div class="memitem">
  987. <div class="memproto">
  988. <table class="mlabels">
  989. <tr>
  990. <td class="mlabels-left">
  991. <table class="memname">
  992. <tr>
  993. <td class="memname">virtual bool Widget::onScroll </td>
  994. <td>(</td>
  995. <td class="paramtype">const <a class="el" href="structWidget_1_1ScrollEvent.html">ScrollEvent</a> &amp;&#160;</td>
  996. <td class="paramname"></td><td>)</td>
  997. <td></td>
  998. </tr>
  999. </table>
  1000. </td>
  1001. <td class="mlabels-right">
  1002. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  1003. </tr>
  1004. </table>
  1005. </div><div class="memdoc">
  1006. <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>
  1007. <p>Reimplemented in <a class="el" href="classImageKnob.html#a2cdc26028611554458a74b32740ac33b">ImageKnob</a>.</p>
  1008. </div>
  1009. </div>
  1010. <a class="anchor" id="acc0365ec4b9245bdffb8d0285be55dea"></a>
  1011. <div class="memitem">
  1012. <div class="memproto">
  1013. <table class="mlabels">
  1014. <tr>
  1015. <td class="mlabels-left">
  1016. <table class="memname">
  1017. <tr>
  1018. <td class="memname">virtual void Widget::onResize </td>
  1019. <td>(</td>
  1020. <td class="paramtype">const <a class="el" href="structWidget_1_1ResizeEvent.html">ResizeEvent</a> &amp;&#160;</td>
  1021. <td class="paramname"></td><td>)</td>
  1022. <td></td>
  1023. </tr>
  1024. </table>
  1025. </td>
  1026. <td class="mlabels-right">
  1027. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  1028. </tr>
  1029. </table>
  1030. </div><div class="memdoc">
  1031. <p>A function called when the widget is resized. </p>
  1032. </div>
  1033. </div>
  1034. <a class="anchor" id="aa92462db80ed1dc8334910038cd262cc"></a>
  1035. <div class="memitem">
  1036. <div class="memproto">
  1037. <table class="mlabels">
  1038. <tr>
  1039. <td class="mlabels-left">
  1040. <table class="memname">
  1041. <tr>
  1042. <td class="memname">void Widget::setNeedsFullViewport </td>
  1043. <td>(</td>
  1044. <td class="paramtype">bool&#160;</td>
  1045. <td class="paramname"><em>yesNo</em></td><td>)</td>
  1046. <td></td>
  1047. </tr>
  1048. </table>
  1049. </td>
  1050. <td class="mlabels-right">
  1051. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">noexcept</span></span> </td>
  1052. </tr>
  1053. </table>
  1054. </div><div class="memdoc">
  1055. <p>Tell the parent window this widget needs the full viewport. When enabled, the local widget coordinates are ignored. </p><dl class="section note"><dt>Note</dt><dd>: This is an internal function; You do not need it under normal circumstances. </dd></dl>
  1056. </div>
  1057. </div>
  1058. <a class="anchor" id="a2ce358088e8f3b65621afd02c675bad8"></a>
  1059. <div class="memitem">
  1060. <div class="memproto">
  1061. <table class="mlabels">
  1062. <tr>
  1063. <td class="mlabels-left">
  1064. <table class="memname">
  1065. <tr>
  1066. <td class="memname">void Widget::setNeedsScaling </td>
  1067. <td>(</td>
  1068. <td class="paramtype">bool&#160;</td>
  1069. <td class="paramname"><em>yesNo</em></td><td>)</td>
  1070. <td></td>
  1071. </tr>
  1072. </table>
  1073. </td>
  1074. <td class="mlabels-right">
  1075. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">noexcept</span></span> </td>
  1076. </tr>
  1077. </table>
  1078. </div><div class="memdoc">
  1079. <p>Tell the parent window this widget needs scaling. When enabled, the widget viewport is scaled to match width and height. </p><dl class="section note"><dt>Note</dt><dd>: This is an internal function; You do not need it under normal circumstances. </dd></dl>
  1080. </div>
  1081. </div>
  1082. <hr/>The documentation for this class was generated from the following file:<ul>
  1083. <li>dgl/<a class="el" href="Widget_8hpp_source.html">Widget.hpp</a></li>
  1084. </ul>
  1085. </div><!-- contents -->
  1086. <!-- start footer part -->
  1087. <hr class="footer"/><address class="footer"><small>
  1088. Generated on Sun Apr 26 2015 15:47:57 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">
  1089. <img class="footer" src="doxygen.png" alt="doxygen"/>
  1090. </a> 1.8.8
  1091. </small></address>
  1092. </body>
  1093. </html>