DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF
1
0
Fork 0
Code Releases 0 Activity
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.
417 Commits
7 Branches
91MB
Branch: gh-pages
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'gh-pages'
${ noResults }
DPF/classWidget.html

1008 lines
51KB
Raw Permalink Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  2. <html xmlns="http://www.w3.org/1999/xhtml">

  3. <head>

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>

  6. <meta name="generator" content="Doxygen 1.9.1"/>

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>

  8. <title>DISTRHO Plugin Framework: Widget 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. 

  55. <!-- iframe showing the search results (closed by default) -->

  56. <div id="MSearchResultsWindow">

  57. <iframe src="javascript:void(0)" frameborder="0" 

  58.         name="MSearchResults" id="MSearchResults">

  59. </iframe>

  60. </div>

  61. 

  62. </div><!-- top -->

  63. <div class="header">

  64.   <div class="summary">

  65. <a href="#nested-classes">Classes</a> &#124;

  66. <a href="#pub-methods">Public Member Functions</a> &#124;

  67. <a href="#pro-methods">Protected Member Functions</a> &#124;

  68. <a href="#friends">Friends</a> &#124;

  69. <a href="classWidget-members.html">List of all members</a>  </div>

  70.   <div class="headertitle">

  71. <div class="title">Widget Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>

  72. </div><!--header-->

  73. <div class="contents">

  74. 

  75. <p><code>#include &lt;<a class="el" href="Widget_8hpp_source.html">Widget.hpp</a>&gt;</code></p>

  76. <div class="dynheader">

  77. Inheritance diagram for Widget:</div>

  78. <div class="dyncontent">

  79.  <div class="center">

  80.   <img src="classWidget.png" usemap="#Widget_map" alt=""/>

  81.   <map id="Widget_map" name="Widget_map">

  82. <area href="classSubWidget.html" alt="SubWidget" shape="rect" coords="367,56,602,80"/>

  83. <area href="classTopLevelWidget.html" alt="TopLevelWidget" shape="rect" coords="980,56,1215,80"/>

  84. <area href="classImageBaseButton.html" alt="ImageBaseButton&lt; ImageType &gt;" shape="rect" coords="0,112,235,136"/>

  85. <area href="classImageBaseKnob.html" alt="ImageBaseKnob&lt; ImageType &gt;" shape="rect" coords="245,112,480,136"/>

  86. <area href="classImageBaseSlider.html" alt="ImageBaseSlider&lt; ImageType &gt;" shape="rect" coords="490,112,725,136"/>

  87. <area href="classImageBaseSwitch.html" alt="ImageBaseSwitch&lt; ImageType &gt;" shape="rect" coords="735,112,970,136"/>

  88. <area href="classStandaloneWindow.html" alt="StandaloneWindow" shape="rect" coords="980,112,1215,136"/>

  89. <area href="classImageBaseAboutWindow.html" alt="ImageBaseAboutWindow&lt; ImageType &gt;" shape="rect" coords="980,168,1215,192"/>

  90.   </map>

  91. </div></div>

  92. <table class="memberdecls">

  93. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>

  94. Classes</h2></td></tr>

  95. <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>

  96. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>

  97. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1CharacterInputEvent.html">CharacterInputEvent</a></td></tr>

  98. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>

  99. <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>

  100. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>

  101. <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>

  102. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>

  103. <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>

  104. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>

  105. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWidget_1_1PositionChangedEvent.html">PositionChangedEvent</a></td></tr>

  106. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>

  107. <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>

  108. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>

  109. <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>

  110. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>

  111. </table><table class="memberdecls">

  112. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>

  113. Public Member Functions</h2></td></tr>

  114. <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>

  115. <tr class="separator:a714cf798aadb4d615f6f60a355382c02"><td class="memSeparator" colspan="2">&#160;</td></tr>

  116. <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>

  117. <tr class="separator:a234a8ee8a685dc211ad11f492f0dbc71"><td class="memSeparator" colspan="2">&#160;</td></tr>

  118. <tr class="memitem:a66088a03691f9c643ff335fa826576ba"><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>

  119. <tr class="separator:a66088a03691f9c643ff335fa826576ba"><td class="memSeparator" colspan="2">&#160;</td></tr>

  120. <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>

  121. <tr class="separator:a25ff178539e226b5f30ef0335d060f2b"><td class="memSeparator" colspan="2">&#160;</td></tr>

  122. <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>

  123. <tr class="separator:a4a2f8eebacdd20db505b838f1a118c6b"><td class="memSeparator" colspan="2">&#160;</td></tr>

  124. <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>

  125. <tr class="separator:a169c317caf734c6664494a573e427b40"><td class="memSeparator" colspan="2">&#160;</td></tr>

  126. <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>

  127. <tr class="separator:aa20f6dc096a8836706173f31324c4db8"><td class="memSeparator" colspan="2">&#160;</td></tr>

  128. <tr class="memitem:a9044d42c20ead27dba983b710c94f8d6"><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>

  129. <tr class="separator:a9044d42c20ead27dba983b710c94f8d6"><td class="memSeparator" colspan="2">&#160;</td></tr>

  130. <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>

  131. <tr class="separator:aed80a9cbc4a13c01641f35dd3d8688ea"><td class="memSeparator" colspan="2">&#160;</td></tr>

  132. <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>

  133. <tr class="separator:ac6d2e6cbb2ff96f3645493d804af07f7"><td class="memSeparator" colspan="2">&#160;</td></tr>

  134. <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>

  135. <tr class="separator:ab4d9e0156e455db3ff23730f82544daa"><td class="memSeparator" colspan="2">&#160;</td></tr>

  136. <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>

  137. <tr class="separator:afce784b204902c0f11e9ed02bc692362"><td class="memSeparator" colspan="2">&#160;</td></tr>

  138. <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>

  139. <tr class="separator:a3ee6b2824e3f3719c1c9b3d070385f49"><td class="memSeparator" colspan="2">&#160;</td></tr>

  140. <tr class="memitem:a70b07dbf748490e5a8c18fb9d5766c0e"><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>

  141. <tr class="separator:a70b07dbf748490e5a8c18fb9d5766c0e"><td class="memSeparator" colspan="2">&#160;</td></tr>

  142. <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>

  143. <tr class="separator:abfba3652559de84ba1ae9ccbd3d35e31"><td class="memSeparator" colspan="2">&#160;</td></tr>

  144. <tr class="memitem:a6303d0445f21a2a95148780b0a0afed6"><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>

  145. <tr class="separator:a6303d0445f21a2a95148780b0a0afed6"><td class="memSeparator" colspan="2">&#160;</td></tr>

  146. <tr class="memitem:a373419bc6353abf50a502cdbebd736e7"><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>

  147. <tr class="separator:a373419bc6353abf50a502cdbebd736e7"><td class="memSeparator" colspan="2">&#160;</td></tr>

  148. <tr class="memitem:a0ef05695aec704b0eb1eb91c2e8af07d"><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>

  149. <tr class="separator:a0ef05695aec704b0eb1eb91c2e8af07d"><td class="memSeparator" colspan="2">&#160;</td></tr>

  150. <tr class="memitem:ae23d09ec0e5f0397a3451b603b407182"><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>

  151. <tr class="separator:ae23d09ec0e5f0397a3451b603b407182"><td class="memSeparator" colspan="2">&#160;</td></tr>

  152. <tr class="memitem:a607b153f7d3187ca60bf21004efc1314"><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>

  153. <tr class="separator:a607b153f7d3187ca60bf21004efc1314"><td class="memSeparator" colspan="2">&#160;</td></tr>

  154. <tr class="memitem:a5381d5583ba6e55fe9fed87df95d9605"><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>

  155. <tr class="separator:a5381d5583ba6e55fe9fed87df95d9605"><td class="memSeparator" colspan="2">&#160;</td></tr>

  156. <tr class="memitem:abe8cfe0aaae71dd011cf9a86e930fd12"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#abe8cfe0aaae71dd011cf9a86e930fd12">repaint</a> () noexcept</td></tr>

  157. <tr class="separator:abe8cfe0aaae71dd011cf9a86e930fd12"><td class="memSeparator" colspan="2">&#160;</td></tr>

  158. <tr class="memitem:aa514fb1c20038ba9793e4409e9b18876"><td class="memItemLeft" align="right" valign="top"><a id="aa514fb1c20038ba9793e4409e9b18876"></a>

  159. <a class="el" href="classApplication.html">Application</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>getParentApp</b> () const noexcept</td></tr>

  160. <tr class="separator:aa514fb1c20038ba9793e4409e9b18876"><td class="memSeparator" colspan="2">&#160;</td></tr>

  161. <tr class="memitem:a0e0b0b2293bb63b2d84774542cc6a421"><td class="memItemLeft" align="right" valign="top"><a id="a0e0b0b2293bb63b2d84774542cc6a421"></a>

  162. <a class="el" href="classWindow.html">Window</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>getParentWindow</b> () const noexcept</td></tr>

  163. <tr class="separator:a0e0b0b2293bb63b2d84774542cc6a421"><td class="memSeparator" colspan="2">&#160;</td></tr>

  164. </table><table class="memberdecls">

  165. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>

  166. Protected Member Functions</h2></td></tr>

  167. <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>

  168. <tr class="separator:ae1554f348fe3b2f9d4c3c5c4f9ec55bd"><td class="memSeparator" colspan="2">&#160;</td></tr>

  169. <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>

  170. <tr class="separator:a9fa874aede538b41348f1029524aea11"><td class="memSeparator" colspan="2">&#160;</td></tr>

  171. <tr class="memitem:ad7fb24de24d8809305b04ff3750f0dea"><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>

  172. <tr class="separator:ad7fb24de24d8809305b04ff3750f0dea"><td class="memSeparator" colspan="2">&#160;</td></tr>

  173. <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>

  174. <tr class="separator:a097ec1d56a06bdc9e0a4e54880def378"><td class="memSeparator" colspan="2">&#160;</td></tr>

  175. <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>

  176. <tr class="separator:a655569fb78a598652e9f24cefa1fe4a5"><td class="memSeparator" colspan="2">&#160;</td></tr>

  177. <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>

  178. <tr class="separator:a0d78d28bd4a98c3a016a38091b2d4185"><td class="memSeparator" colspan="2">&#160;</td></tr>

  179. <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>

  180. <tr class="separator:acc0365ec4b9245bdffb8d0285be55dea"><td class="memSeparator" colspan="2">&#160;</td></tr>

  181. <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 SpecialEvent &amp;)</td></tr>

  182. <tr class="separator:a3b42652fcb2f95c6f86bdd43a1727507"><td class="memSeparator" colspan="2">&#160;</td></tr>

  183. </table><table class="memberdecls">

  184. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>

  185. Friends</h2></td></tr>

  186. <tr class="memitem:a4f99c8e34152ae8f8ec244c3ea0124dd"><td class="memItemLeft" align="right" valign="top"><a id="a4f99c8e34152ae8f8ec244c3ea0124dd"></a>

  187. class&#160;</td><td class="memItemRight" valign="bottom"><b>SubWidget</b></td></tr>

  188. <tr class="separator:a4f99c8e34152ae8f8ec244c3ea0124dd"><td class="memSeparator" colspan="2">&#160;</td></tr>

  189. <tr class="memitem:a3b7e31e35ce2ea5bf70607f346496352"><td class="memItemLeft" align="right" valign="top"><a id="a3b7e31e35ce2ea5bf70607f346496352"></a>

  190. class&#160;</td><td class="memItemRight" valign="bottom"><b>TopLevelWidget</b></td></tr>

  191. <tr class="separator:a3b7e31e35ce2ea5bf70607f346496352"><td class="memSeparator" colspan="2">&#160;</td></tr>

  192. </table>

  193. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

  194. <div class="textblock"><p>Base DGL <a class="el" href="classWidget.html">Widget</a> class.</p>

  195. <p>This is the base <a class="el" href="classWidget.html">Widget</a> class, from which all widgets are built.</p>

  196. <p>All widgets have a parent widget where they'll be drawn, this can be the top-level widget or a group widget. This parent is never changed during a widget's lifetime.</p>

  197. <p>Widgets receive events in relative coordinates. (0, 0) means its top-left position.</p>

  198. <p>The top-level widget will draw subwidgets in the order they are constructed. Early subwidgets are drawn first, at the bottom, then newer ones on top. Events are sent in the inverse order so that the top-most widgets get a chance to catch the event and stop its propagation.</p>

  199. <p>All widget event callbacks do nothing by default and onDisplay MUST be reimplemented by subclasses.</p>

  200. <dl class="section note"><dt>Note</dt><dd>It is not possible to subclass this <a class="el" href="classWidget.html">Widget</a> class directly, you must use <a class="el" href="classSubWidget.html">SubWidget</a> or <a class="el" href="classTopLevelWidget.html">TopLevelWidget</a> instead. </dd></dl>

  201. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>

  202. <a id="a714cf798aadb4d615f6f60a355382c02"></a>

  203. <h2 class="memtitle"><span class="permalink"><a href="#a714cf798aadb4d615f6f60a355382c02">&#9670;&nbsp;</a></span>~Widget()</h2>

  204. 

  205. <div class="memitem">

  206. <div class="memproto">

  207. <table class="mlabels">

  208.   <tr>

  209.   <td class="mlabels-left">

  210.       <table class="memname">

  211.         <tr>

  212.           <td class="memname">virtual Widget::~Widget </td>

  213.           <td>(</td>

  214.           <td class="paramname"></td><td>)</td>

  215.           <td></td>

  216.         </tr>

  217.       </table>

  218.   </td>

  219.   <td class="mlabels-right">

  220. <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>

  221.   </tr>

  222. </table>

  223. </div><div class="memdoc">

  224. <p>Destructor. </p>

  225. 

  226. </div>

  227. </div>

  228. <h2 class="groupheader">Member Function Documentation</h2>

  229. <a id="a234a8ee8a685dc211ad11f492f0dbc71"></a>

  230. <h2 class="memtitle"><span class="permalink"><a href="#a234a8ee8a685dc211ad11f492f0dbc71">&#9670;&nbsp;</a></span>isVisible()</h2>

  231. 

  232. <div class="memitem">

  233. <div class="memproto">

  234. <table class="mlabels">

  235.   <tr>

  236.   <td class="mlabels-left">

  237.       <table class="memname">

  238.         <tr>

  239.           <td class="memname">bool Widget::isVisible </td>

  240.           <td>(</td>

  241.           <td class="paramname"></td><td>)</td>

  242.           <td> const</td>

  243.         </tr>

  244.       </table>

  245.   </td>

  246.   <td class="mlabels-right">

  247. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  248.   </tr>

  249. </table>

  250. </div><div class="memdoc">

  251. <p>Check if this widget is visible within its parent window. Invisible widgets do not receive events except resize. </p>

  252. 

  253. </div>

  254. </div>

  255. <a id="a66088a03691f9c643ff335fa826576ba"></a>

  256. <h2 class="memtitle"><span class="permalink"><a href="#a66088a03691f9c643ff335fa826576ba">&#9670;&nbsp;</a></span>setVisible()</h2>

  257. 

  258. <div class="memitem">

  259. <div class="memproto">

  260.       <table class="memname">

  261.         <tr>

  262.           <td class="memname">void Widget::setVisible </td>

  263.           <td>(</td>

  264.           <td class="paramtype">bool&#160;</td>

  265.           <td class="paramname"><em>visible</em></td><td>)</td>

  266.           <td></td>

  267.         </tr>

  268.       </table>

  269. </div><div class="memdoc">

  270. <p>Set widget visible (or not) according to <em>visible</em>. </p>

  271. 

  272. </div>

  273. </div>

  274. <a id="a25ff178539e226b5f30ef0335d060f2b"></a>

  275. <h2 class="memtitle"><span class="permalink"><a href="#a25ff178539e226b5f30ef0335d060f2b">&#9670;&nbsp;</a></span>show()</h2>

  276. 

  277. <div class="memitem">

  278. <div class="memproto">

  279.       <table class="memname">

  280.         <tr>

  281.           <td class="memname">void Widget::show </td>

  282.           <td>(</td>

  283.           <td class="paramname"></td><td>)</td>

  284.           <td></td>

  285.         </tr>

  286.       </table>

  287. </div><div class="memdoc">

  288. <p>Show widget. This is the same as calling setVisible(true). </p>

  289. 

  290. </div>

  291. </div>

  292. <a id="a4a2f8eebacdd20db505b838f1a118c6b"></a>

  293. <h2 class="memtitle"><span class="permalink"><a href="#a4a2f8eebacdd20db505b838f1a118c6b">&#9670;&nbsp;</a></span>hide()</h2>

  294. 

  295. <div class="memitem">

  296. <div class="memproto">

  297.       <table class="memname">

  298.         <tr>

  299.           <td class="memname">void Widget::hide </td>

  300.           <td>(</td>

  301.           <td class="paramname"></td><td>)</td>

  302.           <td></td>

  303.         </tr>

  304.       </table>

  305. </div><div class="memdoc">

  306. <p>Hide widget. This is the same as calling setVisible(false). </p>

  307. 

  308. </div>

  309. </div>

  310. <a id="a169c317caf734c6664494a573e427b40"></a>

  311. <h2 class="memtitle"><span class="permalink"><a href="#a169c317caf734c6664494a573e427b40">&#9670;&nbsp;</a></span>getWidth()</h2>

  312. 

  313. <div class="memitem">

  314. <div class="memproto">

  315. <table class="mlabels">

  316.   <tr>

  317.   <td class="mlabels-left">

  318.       <table class="memname">

  319.         <tr>

  320.           <td class="memname">uint Widget::getWidth </td>

  321.           <td>(</td>

  322.           <td class="paramname"></td><td>)</td>

  323.           <td> const</td>

  324.         </tr>

  325.       </table>

  326.   </td>

  327.   <td class="mlabels-right">

  328. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  329.   </tr>

  330. </table>

  331. </div><div class="memdoc">

  332. <p>Get width. </p>

  333. 

  334. </div>

  335. </div>

  336. <a id="aa20f6dc096a8836706173f31324c4db8"></a>

  337. <h2 class="memtitle"><span class="permalink"><a href="#aa20f6dc096a8836706173f31324c4db8">&#9670;&nbsp;</a></span>getHeight()</h2>

  338. 

  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::getHeight </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 height. </p>

  359. 

  360. </div>

  361. </div>

  362. <a id="a9044d42c20ead27dba983b710c94f8d6"></a>

  363. <h2 class="memtitle"><span class="permalink"><a href="#a9044d42c20ead27dba983b710c94f8d6">&#9670;&nbsp;</a></span>getSize()</h2>

  364. 

  365. <div class="memitem">

  366. <div class="memproto">

  367. <table class="mlabels">

  368.   <tr>

  369.   <td class="mlabels-left">

  370.       <table class="memname">

  371.         <tr>

  372.           <td class="memname">const <a class="el" href="classSize.html">Size</a>&lt;uint&gt; Widget::getSize </td>

  373.           <td>(</td>

  374.           <td class="paramname"></td><td>)</td>

  375.           <td> const</td>

  376.         </tr>

  377.       </table>

  378.   </td>

  379.   <td class="mlabels-right">

  380. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  381.   </tr>

  382. </table>

  383. </div><div class="memdoc">

  384. <p>Get size. </p>

  385. 

  386. </div>

  387. </div>

  388. <a id="aed80a9cbc4a13c01641f35dd3d8688ea"></a>

  389. <h2 class="memtitle"><span class="permalink"><a href="#aed80a9cbc4a13c01641f35dd3d8688ea">&#9670;&nbsp;</a></span>setWidth()</h2>

  390. 

  391. <div class="memitem">

  392. <div class="memproto">

  393. <table class="mlabels">

  394.   <tr>

  395.   <td class="mlabels-left">

  396.       <table class="memname">

  397.         <tr>

  398.           <td class="memname">void Widget::setWidth </td>

  399.           <td>(</td>

  400.           <td class="paramtype">uint&#160;</td>

  401.           <td class="paramname"><em>width</em></td><td>)</td>

  402.           <td></td>

  403.         </tr>

  404.       </table>

  405.   </td>

  406.   <td class="mlabels-right">

  407. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  408.   </tr>

  409. </table>

  410. </div><div class="memdoc">

  411. <p>Set width. </p>

  412. 

  413. </div>

  414. </div>

  415. <a id="ac6d2e6cbb2ff96f3645493d804af07f7"></a>

  416. <h2 class="memtitle"><span class="permalink"><a href="#ac6d2e6cbb2ff96f3645493d804af07f7">&#9670;&nbsp;</a></span>setHeight()</h2>

  417. 

  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 Widget::setHeight </td>

  426.           <td>(</td>

  427.           <td class="paramtype">uint&#160;</td>

  428.           <td class="paramname"><em>height</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>Set height. </p>

  439. 

  440. </div>

  441. </div>

  442. <a id="ab4d9e0156e455db3ff23730f82544daa"></a>

  443. <h2 class="memtitle"><span class="permalink"><a href="#ab4d9e0156e455db3ff23730f82544daa">&#9670;&nbsp;</a></span>setSize() <span class="overload">[1/2]</span></h2>

  444. 

  445. <div class="memitem">

  446. <div class="memproto">

  447. <table class="mlabels">

  448.   <tr>

  449.   <td class="mlabels-left">

  450.       <table class="memname">

  451.         <tr>

  452.           <td class="memname">void Widget::setSize </td>

  453.           <td>(</td>

  454.           <td class="paramtype">uint&#160;</td>

  455.           <td class="paramname"><em>width</em>, </td>

  456.         </tr>

  457.         <tr>

  458.           <td class="paramkey"></td>

  459.           <td></td>

  460.           <td class="paramtype">uint&#160;</td>

  461.           <td class="paramname"><em>height</em>&#160;</td>

  462.         </tr>

  463.         <tr>

  464.           <td></td>

  465.           <td>)</td>

  466.           <td></td><td></td>

  467.         </tr>

  468.       </table>

  469.   </td>

  470.   <td class="mlabels-right">

  471. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  472.   </tr>

  473. </table>

  474. </div><div class="memdoc">

  475. <p>Set size using <em>width</em> and <em>height</em> values. </p>

  476. 

  477. </div>

  478. </div>

  479. <a id="afce784b204902c0f11e9ed02bc692362"></a>

  480. <h2 class="memtitle"><span class="permalink"><a href="#afce784b204902c0f11e9ed02bc692362">&#9670;&nbsp;</a></span>setSize() <span class="overload">[2/2]</span></h2>

  481. 

  482. <div class="memitem">

  483. <div class="memproto">

  484. <table class="mlabels">

  485.   <tr>

  486.   <td class="mlabels-left">

  487.       <table class="memname">

  488.         <tr>

  489.           <td class="memname">void Widget::setSize </td>

  490.           <td>(</td>

  491.           <td class="paramtype">const <a class="el" href="classSize.html">Size</a>&lt; uint &gt; &amp;&#160;</td>

  492.           <td class="paramname"><em>size</em></td><td>)</td>

  493.           <td></td>

  494.         </tr>

  495.       </table>

  496.   </td>

  497.   <td class="mlabels-right">

  498. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  499.   </tr>

  500. </table>

  501. </div><div class="memdoc">

  502. <p>Set size. </p>

  503. 

  504. </div>

  505. </div>

  506. <a id="a3ee6b2824e3f3719c1c9b3d070385f49"></a>

  507. <h2 class="memtitle"><span class="permalink"><a href="#a3ee6b2824e3f3719c1c9b3d070385f49">&#9670;&nbsp;</a></span>getId()</h2>

  508. 

  509. <div class="memitem">

  510. <div class="memproto">

  511. <table class="mlabels">

  512.   <tr>

  513.   <td class="mlabels-left">

  514.       <table class="memname">

  515.         <tr>

  516.           <td class="memname">uint Widget::getId </td>

  517.           <td>(</td>

  518.           <td class="paramname"></td><td>)</td>

  519.           <td> const</td>

  520.         </tr>

  521.       </table>

  522.   </td>

  523.   <td class="mlabels-right">

  524. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  525.   </tr>

  526. </table>

  527. </div><div class="memdoc">

  528. <p>Get the Id associated with this widget. Returns 0 by default. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classWidget.html#abfba3652559de84ba1ae9ccbd3d35e31">setId</a> </dd></dl>

  529. 

  530. </div>

  531. </div>

  532. <a id="a70b07dbf748490e5a8c18fb9d5766c0e"></a>

  533. <h2 class="memtitle"><span class="permalink"><a href="#a70b07dbf748490e5a8c18fb9d5766c0e">&#9670;&nbsp;</a></span>getName()</h2>

  534. 

  535. <div class="memitem">

  536. <div class="memproto">

  537. <table class="mlabels">

  538.   <tr>

  539.   <td class="mlabels-left">

  540.       <table class="memname">

  541.         <tr>

  542.           <td class="memname">const char* Widget::getName </td>

  543.           <td>(</td>

  544.           <td class="paramname"></td><td>)</td>

  545.           <td> const</td>

  546.         </tr>

  547.       </table>

  548.   </td>

  549.   <td class="mlabels-right">

  550. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  551.   </tr>

  552. </table>

  553. </div><div class="memdoc">

  554. <p>Get the name associated with this widget. This is complately optional, mostly useful for debugging purposes. Returns an empty string by default. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classWidget.html#a6303d0445f21a2a95148780b0a0afed6">setName</a> </dd></dl>

  555. 

  556. </div>

  557. </div>

  558. <a id="abfba3652559de84ba1ae9ccbd3d35e31"></a>

  559. <h2 class="memtitle"><span class="permalink"><a href="#abfba3652559de84ba1ae9ccbd3d35e31">&#9670;&nbsp;</a></span>setId()</h2>

  560. 

  561. <div class="memitem">

  562. <div class="memproto">

  563. <table class="mlabels">

  564.   <tr>

  565.   <td class="mlabels-left">

  566.       <table class="memname">

  567.         <tr>

  568.           <td class="memname">void Widget::setId </td>

  569.           <td>(</td>

  570.           <td class="paramtype">uint&#160;</td>

  571.           <td class="paramname"><em>id</em></td><td>)</td>

  572.           <td></td>

  573.         </tr>

  574.       </table>

  575.   </td>

  576.   <td class="mlabels-right">

  577. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  578.   </tr>

  579. </table>

  580. </div><div class="memdoc">

  581. <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>

  582. 

  583. </div>

  584. </div>

  585. <a id="a6303d0445f21a2a95148780b0a0afed6"></a>

  586. <h2 class="memtitle"><span class="permalink"><a href="#a6303d0445f21a2a95148780b0a0afed6">&#9670;&nbsp;</a></span>setName()</h2>

  587. 

  588. <div class="memitem">

  589. <div class="memproto">

  590. <table class="mlabels">

  591.   <tr>

  592.   <td class="mlabels-left">

  593.       <table class="memname">

  594.         <tr>

  595.           <td class="memname">void Widget::setName </td>

  596.           <td>(</td>

  597.           <td class="paramtype">const char *&#160;</td>

  598.           <td class="paramname"><em>name</em></td><td>)</td>

  599.           <td></td>

  600.         </tr>

  601.       </table>

  602.   </td>

  603.   <td class="mlabels-right">

  604. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  605.   </tr>

  606. </table>

  607. </div><div class="memdoc">

  608. <p>Set a name to be associated with this widget. This is complately optional, only useful for debugging purposes. </p><dl class="section note"><dt>Note</dt><dd>name must not be null </dd></dl>

  609. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classWidget.html#a70b07dbf748490e5a8c18fb9d5766c0e">getName</a> </dd></dl>

  610. 

  611. </div>

  612. </div>

  613. <a id="a373419bc6353abf50a502cdbebd736e7"></a>

  614. <h2 class="memtitle"><span class="permalink"><a href="#a373419bc6353abf50a502cdbebd736e7">&#9670;&nbsp;</a></span>getApp()</h2>

  615. 

  616. <div class="memitem">

  617. <div class="memproto">

  618. <table class="mlabels">

  619.   <tr>

  620.   <td class="mlabels-left">

  621.       <table class="memname">

  622.         <tr>

  623.           <td class="memname"><a class="el" href="classApplication.html">Application</a>&amp; Widget::getApp </td>

  624.           <td>(</td>

  625.           <td class="paramname"></td><td>)</td>

  626.           <td> const</td>

  627.         </tr>

  628.       </table>

  629.   </td>

  630.   <td class="mlabels-right">

  631. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  632.   </tr>

  633. </table>

  634. </div><div class="memdoc">

  635. <p>Get the application associated with this widget's window. This is the same as calling <code><a class="el" href="classWidget.html#a607b153f7d3187ca60bf21004efc1314">getTopLevelWidget()</a>-&gt;<a class="el" href="classWidget.html#a373419bc6353abf50a502cdbebd736e7">getApp()</a></code>. </p>

  636. 

  637. </div>

  638. </div>

  639. <a id="a0ef05695aec704b0eb1eb91c2e8af07d"></a>

  640. <h2 class="memtitle"><span class="permalink"><a href="#a0ef05695aec704b0eb1eb91c2e8af07d">&#9670;&nbsp;</a></span>getWindow()</h2>

  641. 

  642. <div class="memitem">

  643. <div class="memproto">

  644. <table class="mlabels">

  645.   <tr>

  646.   <td class="mlabels-left">

  647.       <table class="memname">

  648.         <tr>

  649.           <td class="memname"><a class="el" href="classWindow.html">Window</a>&amp; Widget::getWindow </td>

  650.           <td>(</td>

  651.           <td class="paramname"></td><td>)</td>

  652.           <td> const</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>Get the window associated with this widget. This is the same as calling <code><a class="el" href="classWidget.html#a607b153f7d3187ca60bf21004efc1314">getTopLevelWidget()</a>-&gt;<a class="el" href="classWidget.html#a0ef05695aec704b0eb1eb91c2e8af07d">getWindow()</a></code>. </p>

  662. 

  663. </div>

  664. </div>

  665. <a id="ae23d09ec0e5f0397a3451b603b407182"></a>

  666. <h2 class="memtitle"><span class="permalink"><a href="#ae23d09ec0e5f0397a3451b603b407182">&#9670;&nbsp;</a></span>getGraphicsContext()</h2>

  667. 

  668. <div class="memitem">

  669. <div class="memproto">

  670. <table class="mlabels">

  671.   <tr>

  672.   <td class="mlabels-left">

  673.       <table class="memname">

  674.         <tr>

  675.           <td class="memname">const <a class="el" href="structGraphicsContext.html">GraphicsContext</a>&amp; Widget::getGraphicsContext </td>

  676.           <td>(</td>

  677.           <td class="paramname"></td><td>)</td>

  678.           <td> const</td>

  679.         </tr>

  680.       </table>

  681.   </td>

  682.   <td class="mlabels-right">

  683. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  684.   </tr>

  685. </table>

  686. </div><div class="memdoc">

  687. <p>Get the graphics context associated with this widget's window. <a class="el" href="structGraphicsContext.html">GraphicsContext</a> is an empty struct and needs to be casted into a different type in order to be usable, for example <a class="el" href="structGraphicsContext.html">GraphicsContext</a>. </p><dl class="section see"><dt>See also</dt><dd>CairoSubWidget, CairoTopLevelWidget </dd></dl>

  688. 

  689. </div>

  690. </div>

  691. <a id="a607b153f7d3187ca60bf21004efc1314"></a>

  692. <h2 class="memtitle"><span class="permalink"><a href="#a607b153f7d3187ca60bf21004efc1314">&#9670;&nbsp;</a></span>getTopLevelWidget()</h2>

  693. 

  694. <div class="memitem">

  695. <div class="memproto">

  696. <table class="mlabels">

  697.   <tr>

  698.   <td class="mlabels-left">

  699.       <table class="memname">

  700.         <tr>

  701.           <td class="memname"><a class="el" href="classTopLevelWidget.html">TopLevelWidget</a>* Widget::getTopLevelWidget </td>

  702.           <td>(</td>

  703.           <td class="paramname"></td><td>)</td>

  704.           <td> const</td>

  705.         </tr>

  706.       </table>

  707.   </td>

  708.   <td class="mlabels-right">

  709. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  710.   </tr>

  711. </table>

  712. </div><div class="memdoc">

  713. <p>Get top-level widget, as passed directly in the constructor or going up the chain of group widgets until it finds the top-level one. </p>

  714. 

  715. </div>

  716. </div>

  717. <a id="a5381d5583ba6e55fe9fed87df95d9605"></a>

  718. <h2 class="memtitle"><span class="permalink"><a href="#a5381d5583ba6e55fe9fed87df95d9605">&#9670;&nbsp;</a></span>getChildren()</h2>

  719. 

  720. <div class="memitem">

  721. <div class="memproto">

  722. <table class="mlabels">

  723.   <tr>

  724.   <td class="mlabels-left">

  725.       <table class="memname">

  726.         <tr>

  727.           <td class="memname">std::list&lt;<a class="el" href="classSubWidget.html">SubWidget</a>*&gt; Widget::getChildren </td>

  728.           <td>(</td>

  729.           <td class="paramname"></td><td>)</td>

  730.           <td> const</td>

  731.         </tr>

  732.       </table>

  733.   </td>

  734.   <td class="mlabels-right">

  735. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  736.   </tr>

  737. </table>

  738. </div><div class="memdoc">

  739. <p>Get list of children (a subwidgets) that belong to this widget. </p>

  740. 

  741. </div>

  742. </div>

  743. <a id="abe8cfe0aaae71dd011cf9a86e930fd12"></a>

  744. <h2 class="memtitle"><span class="permalink"><a href="#abe8cfe0aaae71dd011cf9a86e930fd12">&#9670;&nbsp;</a></span>repaint()</h2>

  745. 

  746. <div class="memitem">

  747. <div class="memproto">

  748. <table class="mlabels">

  749.   <tr>

  750.   <td class="mlabels-left">

  751.       <table class="memname">

  752.         <tr>

  753.           <td class="memname">virtual void Widget::repaint </td>

  754.           <td>(</td>

  755.           <td class="paramname"></td><td>)</td>

  756.           <td></td>

  757.         </tr>

  758.       </table>

  759.   </td>

  760.   <td class="mlabels-right">

  761. <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">noexcept</span></span>  </td>

  762.   </tr>

  763. </table>

  764. </div><div class="memdoc">

  765. <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>

  766. 

  767. <p>Reimplemented in <a class="el" href="classTopLevelWidget.html#a5b71bc1266aea488b1f85b83744adbfd">TopLevelWidget</a>, <a class="el" href="classSubWidget.html#a13910739dc797b600502e2dfa7daef87">SubWidget</a>, and <a class="el" href="classStandaloneWindow.html#aa1475d362245c793b516a232deab70ff">StandaloneWindow</a>.</p>

  768. 

  769. </div>

  770. </div>

  771. <a id="ae1554f348fe3b2f9d4c3c5c4f9ec55bd"></a>

  772. <h2 class="memtitle"><span class="permalink"><a href="#ae1554f348fe3b2f9d4c3c5c4f9ec55bd">&#9670;&nbsp;</a></span>onDisplay()</h2>

  773. 

  774. <div class="memitem">

  775. <div class="memproto">

  776. <table class="mlabels">

  777.   <tr>

  778.   <td class="mlabels-left">

  779.       <table class="memname">

  780.         <tr>

  781.           <td class="memname">virtual void Widget::onDisplay </td>

  782.           <td>(</td>

  783.           <td class="paramname"></td><td>)</td>

  784.           <td></td>

  785.         </tr>

  786.       </table>

  787.   </td>

  788.   <td class="mlabels-right">

  789. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>

  790.   </tr>

  791. </table>

  792. </div><div class="memdoc">

  793. <p>A function called to draw the widget contents. </p>

  794. 

  795. <p>Implemented in <a class="el" href="classImageBaseSwitch.html#aee9ad32db22d06c98b37d4b62904f92b">ImageBaseSwitch&lt; ImageType &gt;</a>, <a class="el" href="classImageBaseSlider.html#ad51cf7404dd7791eaa83126f346ae6c5">ImageBaseSlider&lt; ImageType &gt;</a>, <a class="el" href="classImageBaseKnob.html#a9a4d1a1ff6fe7e51be7491148c20d1c5">ImageBaseKnob&lt; ImageType &gt;</a>, <a class="el" href="classImageBaseButton.html#a4a3eaf5367a91d43465ffca09464b8ad">ImageBaseButton&lt; ImageType &gt;</a>, and <a class="el" href="classImageBaseAboutWindow.html#a3e675bef6bb84375cb762767d216e8f7">ImageBaseAboutWindow&lt; ImageType &gt;</a>.</p>

  796. 

  797. </div>

  798. </div>

  799. <a id="a9fa874aede538b41348f1029524aea11"></a>

  800. <h2 class="memtitle"><span class="permalink"><a href="#a9fa874aede538b41348f1029524aea11">&#9670;&nbsp;</a></span>onKeyboard()</h2>

  801. 

  802. <div class="memitem">

  803. <div class="memproto">

  804. <table class="mlabels">

  805.   <tr>

  806.   <td class="mlabels-left">

  807.       <table class="memname">

  808.         <tr>

  809.           <td class="memname">virtual bool Widget::onKeyboard </td>

  810.           <td>(</td>

  811.           <td class="paramtype">const <a class="el" href="structWidget_1_1KeyboardEvent.html">KeyboardEvent</a> &amp;&#160;</td>

  812.           <td class="paramname"></td><td>)</td>

  813.           <td></td>

  814.         </tr>

  815.       </table>

  816.   </td>

  817.   <td class="mlabels-right">

  818. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>

  819.   </tr>

  820. </table>

  821. </div><div class="memdoc">

  822. <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>

  823. 

  824. <p>Reimplemented in <a class="el" href="classTopLevelWidget.html#a7b182e276662bc32aa0fcd7b07dfe4d0">TopLevelWidget</a>, and <a class="el" href="classImageBaseAboutWindow.html#a239bf25a7ac8063d2cf3d4db250396e2">ImageBaseAboutWindow&lt; ImageType &gt;</a>.</p>

  825. 

  826. </div>

  827. </div>

  828. <a id="ad7fb24de24d8809305b04ff3750f0dea"></a>

  829. <h2 class="memtitle"><span class="permalink"><a href="#ad7fb24de24d8809305b04ff3750f0dea">&#9670;&nbsp;</a></span>onCharacterInput()</h2>

  830. 

  831. <div class="memitem">

  832. <div class="memproto">

  833. <table class="mlabels">

  834.   <tr>

  835.   <td class="mlabels-left">

  836.       <table class="memname">

  837.         <tr>

  838.           <td class="memname">virtual bool Widget::onCharacterInput </td>

  839.           <td>(</td>

  840.           <td class="paramtype">const <a class="el" href="structWidget_1_1CharacterInputEvent.html">CharacterInputEvent</a> &amp;&#160;</td>

  841.           <td class="paramname"></td><td>)</td>

  842.           <td></td>

  843.         </tr>

  844.       </table>

  845.   </td>

  846.   <td class="mlabels-right">

  847. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>

  848.   </tr>

  849. </table>

  850. </div><div class="memdoc">

  851. <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>

  852. 

  853. <p>Reimplemented in <a class="el" href="classTopLevelWidget.html#a567153ae0853e56553c9569dc61ed913">TopLevelWidget</a>.</p>

  854. 

  855. </div>

  856. </div>

  857. <a id="a097ec1d56a06bdc9e0a4e54880def378"></a>

  858. <h2 class="memtitle"><span class="permalink"><a href="#a097ec1d56a06bdc9e0a4e54880def378">&#9670;&nbsp;</a></span>onMouse()</h2>

  859. 

  860. <div class="memitem">

  861. <div class="memproto">

  862. <table class="mlabels">

  863.   <tr>

  864.   <td class="mlabels-left">

  865.       <table class="memname">

  866.         <tr>

  867.           <td class="memname">virtual bool Widget::onMouse </td>

  868.           <td>(</td>

  869.           <td class="paramtype">const <a class="el" href="structWidget_1_1MouseEvent.html">MouseEvent</a> &amp;&#160;</td>

  870.           <td class="paramname"></td><td>)</td>

  871.           <td></td>

  872.         </tr>

  873.       </table>

  874.   </td>

  875.   <td class="mlabels-right">

  876. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>

  877.   </tr>

  878. </table>

  879. </div><div class="memdoc">

  880. <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>

  881. 

  882. <p>Reimplemented in <a class="el" href="classTopLevelWidget.html#a8ceccb37de18c8e3b21fbf64ad58981c">TopLevelWidget</a>, <a class="el" href="classImageBaseSwitch.html#a6912be0532a24c33e6dac851779fc8f0">ImageBaseSwitch&lt; ImageType &gt;</a>, <a class="el" href="classImageBaseSlider.html#af1caea46d10b3decd14ad795e0a58a9d">ImageBaseSlider&lt; ImageType &gt;</a>, <a class="el" href="classImageBaseKnob.html#a6cd97ff56064b28a56d1321508e29f8b">ImageBaseKnob&lt; ImageType &gt;</a>, <a class="el" href="classImageBaseButton.html#a643f3c0429d514c70c7a1333829f6cf8">ImageBaseButton&lt; ImageType &gt;</a>, and <a class="el" href="classImageBaseAboutWindow.html#ad2c3d4c6943a5562574baf60f58de483">ImageBaseAboutWindow&lt; ImageType &gt;</a>.</p>

  883. 

  884. </div>

  885. </div>

  886. <a id="a655569fb78a598652e9f24cefa1fe4a5"></a>

  887. <h2 class="memtitle"><span class="permalink"><a href="#a655569fb78a598652e9f24cefa1fe4a5">&#9670;&nbsp;</a></span>onMotion()</h2>

  888. 

  889. <div class="memitem">

  890. <div class="memproto">

  891. <table class="mlabels">

  892.   <tr>

  893.   <td class="mlabels-left">

  894.       <table class="memname">

  895.         <tr>

  896.           <td class="memname">virtual bool Widget::onMotion </td>

  897.           <td>(</td>

  898.           <td class="paramtype">const <a class="el" href="structWidget_1_1MotionEvent.html">MotionEvent</a> &amp;&#160;</td>

  899.           <td class="paramname"></td><td>)</td>

  900.           <td></td>

  901.         </tr>

  902.       </table>

  903.   </td>

  904.   <td class="mlabels-right">

  905. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>

  906.   </tr>

  907. </table>

  908. </div><div class="memdoc">

  909. <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>

  910. 

  911. <p>Reimplemented in <a class="el" href="classTopLevelWidget.html#ac640eb913196c9edb68e5d52df4a89cb">TopLevelWidget</a>, <a class="el" href="classImageBaseSlider.html#a2b50b9c33b7f0685c6d3037afe65ebae">ImageBaseSlider&lt; ImageType &gt;</a>, <a class="el" href="classImageBaseKnob.html#ab7fc0602637a98d5a0a5ecfd74557636">ImageBaseKnob&lt; ImageType &gt;</a>, and <a class="el" href="classImageBaseButton.html#a6333af8b73082f6b4dff77cf690be82d">ImageBaseButton&lt; ImageType &gt;</a>.</p>

  912. 

  913. </div>

  914. </div>

  915. <a id="a0d78d28bd4a98c3a016a38091b2d4185"></a>

  916. <h2 class="memtitle"><span class="permalink"><a href="#a0d78d28bd4a98c3a016a38091b2d4185">&#9670;&nbsp;</a></span>onScroll()</h2>

  917. 

  918. <div class="memitem">

  919. <div class="memproto">

  920. <table class="mlabels">

  921.   <tr>

  922.   <td class="mlabels-left">

  923.       <table class="memname">

  924.         <tr>

  925.           <td class="memname">virtual bool Widget::onScroll </td>

  926.           <td>(</td>

  927.           <td class="paramtype">const <a class="el" href="structWidget_1_1ScrollEvent.html">ScrollEvent</a> &amp;&#160;</td>

  928.           <td class="paramname"></td><td>)</td>

  929.           <td></td>

  930.         </tr>

  931.       </table>

  932.   </td>

  933.   <td class="mlabels-right">

  934. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>

  935.   </tr>

  936. </table>

  937. </div><div class="memdoc">

  938. <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>

  939. 

  940. <p>Reimplemented in <a class="el" href="classTopLevelWidget.html#a412a6ce96a4ef7f64396e312ad072f9d">TopLevelWidget</a>, and <a class="el" href="classImageBaseKnob.html#aeb9c35449f4b48741ceb8ba8253648bb">ImageBaseKnob&lt; ImageType &gt;</a>.</p>

  941. 

  942. </div>

  943. </div>

  944. <a id="acc0365ec4b9245bdffb8d0285be55dea"></a>

  945. <h2 class="memtitle"><span class="permalink"><a href="#acc0365ec4b9245bdffb8d0285be55dea">&#9670;&nbsp;</a></span>onResize()</h2>

  946. 

  947. <div class="memitem">

  948. <div class="memproto">

  949. <table class="mlabels">

  950.   <tr>

  951.   <td class="mlabels-left">

  952.       <table class="memname">

  953.         <tr>

  954.           <td class="memname">virtual void Widget::onResize </td>

  955.           <td>(</td>

  956.           <td class="paramtype">const <a class="el" href="structWidget_1_1ResizeEvent.html">ResizeEvent</a> &amp;&#160;</td>

  957.           <td class="paramname"></td><td>)</td>

  958.           <td></td>

  959.         </tr>

  960.       </table>

  961.   </td>

  962.   <td class="mlabels-right">

  963. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>

  964.   </tr>

  965. </table>

  966. </div><div class="memdoc">

  967. <p>A function called when the widget is resized. </p>

  968. 

  969. </div>

  970. </div>

  971. <a id="a3b42652fcb2f95c6f86bdd43a1727507"></a>

  972. <h2 class="memtitle"><span class="permalink"><a href="#a3b42652fcb2f95c6f86bdd43a1727507">&#9670;&nbsp;</a></span>onSpecial()</h2>

  973. 

  974. <div class="memitem">

  975. <div class="memproto">

  976. <table class="mlabels">

  977.   <tr>

  978.   <td class="mlabels-left">

  979.       <table class="memname">

  980.         <tr>

  981.           <td class="memname">virtual bool Widget::onSpecial </td>

  982.           <td>(</td>

  983.           <td class="paramtype">const SpecialEvent &amp;&#160;</td>

  984.           <td class="paramname"></td><td>)</td>

  985.           <td></td>

  986.         </tr>

  987.       </table>

  988.   </td>

  989.   <td class="mlabels-right">

  990. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>

  991.   </tr>

  992. </table>

  993. </div><div class="memdoc">

  994. <p>A function called when a special key is pressed or released. DEPRECATED use onKeyboard or onCharacterInput </p>

  995. 

  996. </div>

  997. </div>

  998. <hr/>The documentation for this class was generated from the following file:<ul>

  999. <li>dgl/<a class="el" href="Widget_8hpp_source.html">Widget.hpp</a></li>

  1000. </ul>

  1001. </div><!-- contents -->

  1002. <!-- start footer part -->

  1003. <hr class="footer"/><address class="footer"><small>

  1004. 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

  1005. </small></address>

  1006. </body>

  1007. </html>