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.

579 lines
84KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>DISTRHO Plugin Framework: dgl/Widget.hpp Source File</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">DISTRHO Plugin Framework
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.8.17 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','Search');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. <div id="nav-path" class="navpath">
  61. <ul>
  62. <li class="navelem"><a class="el" href="dir_99893ac99dd47c2a73745483a12a725f.html">dgl</a></li> </ul>
  63. </div>
  64. </div><!-- top -->
  65. <div class="header">
  66. <div class="headertitle">
  67. <div class="title">Widget.hpp</div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
  71. <div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * DISTRHO Plugin Framework (DPF)</span></div>
  72. <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * Copyright (C) 2012-2021 Filipe Coelho &lt;falktx@falktx.com&gt;</span></div>
  73. <div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> *</span></div>
  74. <div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Permission to use, copy, modify, and/or distribute this software for any purpose with</span></div>
  75. <div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * or without fee is hereby granted, provided that the above copyright notice and this</span></div>
  76. <div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * permission notice appear in all copies.</span></div>
  77. <div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
  78. <div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD</span></div>
  79. <div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN</span></div>
  80. <div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL</span></div>
  81. <div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER</span></div>
  82. <div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN</span></div>
  83. <div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
  84. <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> */</span></div>
  85. <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div>
  86. <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#ifndef DGL_WIDGET_HPP_INCLUDED</span></div>
  87. <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#define DGL_WIDGET_HPP_INCLUDED</span></div>
  88. <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
  89. <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;Geometry.hpp&quot;</span></div>
  90. <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
  91. <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;START_NAMESPACE_DGL</div>
  92. <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
  93. <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>
  94. <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment">// Forward class names</span></div>
  95. <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
  96. <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">class </span><a class="code" href="classApplication.html">Application</a>;</div>
  97. <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">class </span><a class="code" href="classSubWidget.html">SubWidget</a>;</div>
  98. <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">class </span><a class="code" href="classTopLevelWidget.html">TopLevelWidget</a>;</div>
  99. <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">class </span><a class="code" href="classWindow.html">Window</a>;</div>
  100. <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
  101. <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>
  102. <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment"></span> </div>
  103. <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment">/**</span></div>
  104. <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment"> Base DGL Widget class.</span></div>
  105. <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment"></span> </div>
  106. <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment"> This is the base Widget class, from which all widgets are built.</span></div>
  107. <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="comment"></span> </div>
  108. <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment"> All widgets have a parent widget where they&#39;ll be drawn, this can be the top-level widget or a group widget.</span></div>
  109. <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment"> This parent is never changed during a widget&#39;s lifetime.</span></div>
  110. <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment"></span> </div>
  111. <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="comment"> Widgets receive events in relative coordinates. (0, 0) means its top-left position.</span></div>
  112. <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="comment"></span> </div>
  113. <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment"> The top-level widget will draw subwidgets in the order they are constructed.</span></div>
  114. <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="comment"> Early subwidgets are drawn first, at the bottom, then newer ones on top.</span></div>
  115. <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="comment"> Events are sent in the inverse order so that the top-most widgets get</span></div>
  116. <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="comment"> a chance to catch the event and stop its propagation.</span></div>
  117. <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="comment"></span> </div>
  118. <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="comment"> All widget event callbacks do nothing by default and onDisplay MUST be reimplemented by subclasses.</span></div>
  119. <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="comment"></span> </div>
  120. <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="comment"> @note It is not possible to subclass this Widget class directly, you must use SubWidget or TopLevelWidget instead.</span></div>
  121. <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="comment"> */</span></div>
  122. <div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classWidget.html"> 53</a></span>&#160;<span class="keyword">class </span><a class="code" href="classWidget.html">Widget</a></div>
  123. <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;{</div>
  124. <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="keyword">public</span>:<span class="comment"></span></div>
  125. <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="comment"> /**</span></div>
  126. <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="comment"> Base event data.</span></div>
  127. <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="comment"> These are the fields present on all Widget events.</span></div>
  128. <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="comment"></span> </div>
  129. <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="comment"> @a mod Currently active keyboard modifiers, @see Modifier.</span></div>
  130. <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="comment"> @a mod Event flags, @see Flag.</span></div>
  131. <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="comment"> @a time Event timestamp (if any).</span></div>
  132. <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="comment"> */</span></div>
  133. <div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="structWidget_1_1BaseEvent.html"> 64</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structWidget_1_1BaseEvent.html">BaseEvent</a> {</div>
  134. <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; uint mod;</div>
  135. <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; uint flags;</div>
  136. <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; uint time;</div>
  137. <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="comment"></span> </div>
  138. <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="comment"> /** Constuctor */</span></div>
  139. <div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="structWidget_1_1BaseEvent.html#a18c1114caca474cadefd9a13e2d9c693"> 70</a></span>&#160; <a class="code" href="structWidget_1_1BaseEvent.html#a18c1114caca474cadefd9a13e2d9c693">BaseEvent</a>() noexcept : mod(0x0), flags(0x0), time(0) {}<span class="comment"></span></div>
  140. <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="comment"> /** Destuctor */</span></div>
  141. <div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="structWidget_1_1BaseEvent.html#a58da172316b49f6d79b879b74ce5792a"> 72</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="structWidget_1_1BaseEvent.html#a58da172316b49f6d79b879b74ce5792a">~BaseEvent</a>() noexcept {}</div>
  142. <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; };</div>
  143. <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="comment"></span> </div>
  144. <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;<span class="comment"> /**</span></div>
  145. <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<span class="comment"> Keyboard event.</span></div>
  146. <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;<span class="comment"></span> </div>
  147. <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<span class="comment"> This event represents low-level key presses and releases.</span></div>
  148. <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<span class="comment"> This can be used for &quot;direct&quot; keyboard handing like key bindings, but must not be interpreted as text input.</span></div>
  149. <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;<span class="comment"></span> </div>
  150. <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="comment"> Keys are represented portably as Unicode code points, using the &quot;natural&quot; code point for the key.</span></div>
  151. <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="comment"> The @a key field is the code for the pressed key, without any modifiers applied.</span></div>
  152. <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="comment"> For example, a press or release of the &#39;A&#39; key will have `key` 97 (&#39;a&#39;)</span></div>
  153. <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="comment"> regardless of whether shift or control are being held.</span></div>
  154. <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="comment"></span> </div>
  155. <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;<span class="comment"> Alternatively, the raw @a keycode can be used to work directly with physical keys,</span></div>
  156. <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="comment"> but note that this value is not portable and differs between platforms and hardware.</span></div>
  157. <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="comment"></span> </div>
  158. <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="comment"> @a press True if the key was pressed, false if released.</span></div>
  159. <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;<span class="comment"> @a key Unicode point of the key pressed.</span></div>
  160. <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;<span class="comment"> @a keycode Raw keycode.</span></div>
  161. <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;<span class="comment"> @see onKeyboard</span></div>
  162. <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;<span class="comment"> */</span></div>
  163. <div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="structWidget_1_1KeyboardEvent.html"> 94</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structWidget_1_1KeyboardEvent.html">KeyboardEvent</a> : <a class="code" href="structWidget_1_1BaseEvent.html">BaseEvent</a> {</div>
  164. <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keywordtype">bool</span> press;</div>
  165. <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; uint key;</div>
  166. <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; uint keycode;</div>
  167. <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;<span class="comment"></span> </div>
  168. <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;<span class="comment"> /** Constuctor */</span></div>
  169. <div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="structWidget_1_1KeyboardEvent.html#a5a55a296264b9999a7915f2633eacb10"> 100</a></span>&#160; <a class="code" href="structWidget_1_1KeyboardEvent.html#a5a55a296264b9999a7915f2633eacb10">KeyboardEvent</a>() noexcept</div>
  170. <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; : <a class="code" href="structWidget_1_1BaseEvent.html">BaseEvent</a>(),</div>
  171. <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; press(false),</div>
  172. <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; key(0),</div>
  173. <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; keycode(0) {}</div>
  174. <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; };</div>
  175. <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;<span class="comment"></span> </div>
  176. <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;<span class="comment"> /**</span></div>
  177. <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;<span class="comment"> Special keyboard event.</span></div>
  178. <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;<span class="comment"></span> </div>
  179. <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;<span class="comment"> This event allows the use of keys that do not have unicode points.</span></div>
  180. <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;<span class="comment"> Note that some are non-printable keys.</span></div>
  181. <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;<span class="comment"></span> </div>
  182. <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;<span class="comment"> @a press True if the key was pressed, false if released.</span></div>
  183. <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;<span class="comment"> @a key The key pressed.</span></div>
  184. <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;<span class="comment"> @see onSpecial</span></div>
  185. <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;<span class="comment"> */</span></div>
  186. <div class="line"><a name="l00117"></a><span class="lineno"><a class="line" href="structWidget_1_1SpecialEvent.html"> 117</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structWidget_1_1SpecialEvent.html">SpecialEvent</a> : <a class="code" href="structWidget_1_1BaseEvent.html">BaseEvent</a> {</div>
  187. <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="keywordtype">bool</span> press;</div>
  188. <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; Key key;</div>
  189. <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;<span class="comment"></span> </div>
  190. <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;<span class="comment"> /** Constuctor */</span></div>
  191. <div class="line"><a name="l00122"></a><span class="lineno"><a class="line" href="structWidget_1_1SpecialEvent.html#aabddc200eb8494dccac663b83248b14b"> 122</a></span>&#160; <a class="code" href="structWidget_1_1SpecialEvent.html#aabddc200eb8494dccac663b83248b14b">SpecialEvent</a>() noexcept</div>
  192. <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; : <a class="code" href="structWidget_1_1BaseEvent.html">BaseEvent</a>(),</div>
  193. <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; press(false),</div>
  194. <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; key(Key(0)) {}</div>
  195. <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; };</div>
  196. <div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;<span class="comment"></span> </div>
  197. <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;<span class="comment"> /**</span></div>
  198. <div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;<span class="comment"> Character input event.</span></div>
  199. <div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;<span class="comment"></span> </div>
  200. <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;<span class="comment"> This event represents text input, usually as the result of a key press.</span></div>
  201. <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;<span class="comment"> The text is given both as a Unicode character code and a UTF-8 string.</span></div>
  202. <div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;<span class="comment"></span> </div>
  203. <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;<span class="comment"> Note that this event is generated by the platform&#39;s input system,</span></div>
  204. <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;<span class="comment"> so there is not necessarily a direct correspondence between text events and physical key presses.</span></div>
  205. <div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;<span class="comment"> For example, with some input methods a sequence of several key presses will generate a single character.</span></div>
  206. <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;<span class="comment"></span> </div>
  207. <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;<span class="comment"> @a keycode Raw key code.</span></div>
  208. <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;<span class="comment"> @a character Unicode character code.</span></div>
  209. <div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;<span class="comment"> @a string UTF-8 string.</span></div>
  210. <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;<span class="comment"> @see onCharacterInput</span></div>
  211. <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;<span class="comment"> */</span></div>
  212. <div class="line"><a name="l00143"></a><span class="lineno"><a class="line" href="structWidget_1_1CharacterInputEvent.html"> 143</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structWidget_1_1CharacterInputEvent.html">CharacterInputEvent</a> : <a class="code" href="structWidget_1_1BaseEvent.html">BaseEvent</a> {</div>
  213. <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; uint keycode;</div>
  214. <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; uint character;</div>
  215. <div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; <span class="keywordtype">char</span> <span class="keywordtype">string</span>[8];</div>
  216. <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;<span class="comment"></span> </div>
  217. <div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;<span class="comment"> /** Constuctor */</span></div>
  218. <div class="line"><a name="l00149"></a><span class="lineno"><a class="line" href="structWidget_1_1CharacterInputEvent.html#ab0e3407cf8693ba9f3be0be805c8af24"> 149</a></span>&#160; <a class="code" href="structWidget_1_1CharacterInputEvent.html#ab0e3407cf8693ba9f3be0be805c8af24">CharacterInputEvent</a>() noexcept</div>
  219. <div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; : <a class="code" href="structWidget_1_1BaseEvent.html">BaseEvent</a>(),</div>
  220. <div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; keycode(0),</div>
  221. <div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; character(0),</div>
  222. <div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; <span class="keywordtype">string</span>{<span class="charliteral">&#39;\0&#39;</span>,<span class="charliteral">&#39;\0&#39;</span>,<span class="charliteral">&#39;\0&#39;</span>,<span class="charliteral">&#39;\0&#39;</span>,<span class="charliteral">&#39;\0&#39;</span>,<span class="charliteral">&#39;\0&#39;</span>,<span class="charliteral">&#39;\0&#39;</span>,<span class="charliteral">&#39;\0&#39;</span>} {}</div>
  223. <div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; };</div>
  224. <div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160;<span class="comment"></span> </div>
  225. <div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160;<span class="comment"> /**</span></div>
  226. <div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160;<span class="comment"> Mouse press or release event.</span></div>
  227. <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160;<span class="comment"></span> </div>
  228. <div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160;<span class="comment"> @a button The button number starting from 1 (1 = left, 2 = middle, 3 = right).</span></div>
  229. <div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160;<span class="comment"> @a press True if the button was pressed, false if released.</span></div>
  230. <div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160;<span class="comment"> @a pos The widget-relative coordinates of the pointer.</span></div>
  231. <div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160;<span class="comment"> @a absolutePos The absolute coordinates of the pointer.</span></div>
  232. <div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;<span class="comment"> @see onMouse</span></div>
  233. <div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;<span class="comment"> */</span></div>
  234. <div class="line"><a name="l00165"></a><span class="lineno"><a class="line" href="structWidget_1_1MouseEvent.html"> 165</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structWidget_1_1MouseEvent.html">MouseEvent</a> : <a class="code" href="structWidget_1_1BaseEvent.html">BaseEvent</a> {</div>
  235. <div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; uint button;</div>
  236. <div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; <span class="keywordtype">bool</span> press;</div>
  237. <div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; <a class="code" href="classPoint.html">Point&lt;double&gt;</a> pos;</div>
  238. <div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; <a class="code" href="classPoint.html">Point&lt;double&gt;</a> absolutePos;</div>
  239. <div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160;<span class="comment"></span> </div>
  240. <div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160;<span class="comment"> /** Constuctor */</span></div>
  241. <div class="line"><a name="l00172"></a><span class="lineno"><a class="line" href="structWidget_1_1MouseEvent.html#aa37fee8a593c62c53e4ca5c67ad9278f"> 172</a></span>&#160; <a class="code" href="structWidget_1_1MouseEvent.html#aa37fee8a593c62c53e4ca5c67ad9278f">MouseEvent</a>() noexcept</div>
  242. <div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; : <a class="code" href="structWidget_1_1BaseEvent.html">BaseEvent</a>(),</div>
  243. <div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; button(0),</div>
  244. <div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160; press(false),</div>
  245. <div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160; pos(0.0, 0.0),</div>
  246. <div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160; absolutePos(0.0, 0.0) {}</div>
  247. <div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; };</div>
  248. <div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160;<span class="comment"></span> </div>
  249. <div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160;<span class="comment"> /**</span></div>
  250. <div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160;<span class="comment"> Mouse motion event.</span></div>
  251. <div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160;<span class="comment"></span> </div>
  252. <div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160;<span class="comment"> @a pos The widget-relative coordinates of the pointer.</span></div>
  253. <div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160;<span class="comment"> @a absolutePos The absolute coordinates of the pointer.</span></div>
  254. <div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160;<span class="comment"> @see onMotion</span></div>
  255. <div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160;<span class="comment"> */</span></div>
  256. <div class="line"><a name="l00187"></a><span class="lineno"><a class="line" href="structWidget_1_1MotionEvent.html"> 187</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structWidget_1_1MotionEvent.html">MotionEvent</a> : <a class="code" href="structWidget_1_1BaseEvent.html">BaseEvent</a> {</div>
  257. <div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; <a class="code" href="classPoint.html">Point&lt;double&gt;</a> pos;</div>
  258. <div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160; <a class="code" href="classPoint.html">Point&lt;double&gt;</a> absolutePos;</div>
  259. <div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160;<span class="comment"></span> </div>
  260. <div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160;<span class="comment"> /** Constuctor */</span></div>
  261. <div class="line"><a name="l00192"></a><span class="lineno"><a class="line" href="structWidget_1_1MotionEvent.html#a0d2bf8f5c66002bb129968f10e0cc082"> 192</a></span>&#160; <a class="code" href="structWidget_1_1MotionEvent.html#a0d2bf8f5c66002bb129968f10e0cc082">MotionEvent</a>() noexcept</div>
  262. <div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160; : <a class="code" href="structWidget_1_1BaseEvent.html">BaseEvent</a>(),</div>
  263. <div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160; pos(0.0, 0.0),</div>
  264. <div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160; absolutePos(0.0, 0.0) {}</div>
  265. <div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; };</div>
  266. <div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160;<span class="comment"></span> </div>
  267. <div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160;<span class="comment"> /**</span></div>
  268. <div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160;<span class="comment"> Mouse scroll event.</span></div>
  269. <div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160;<span class="comment"></span> </div>
  270. <div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160;<span class="comment"> The scroll distance is expressed in &quot;lines&quot;,</span></div>
  271. <div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160;<span class="comment"> an arbitrary unit that corresponds to a single tick of a detented mouse wheel.</span></div>
  272. <div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160;<span class="comment"> For example, `delta.y` = 1.0 scrolls 1 line up.</span></div>
  273. <div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160;<span class="comment"> Some systems and devices support finer resolution and/or higher values for fast scrolls,</span></div>
  274. <div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160;<span class="comment"> so programs should handle any value gracefully.</span></div>
  275. <div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160;<span class="comment"></span> </div>
  276. <div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160;<span class="comment"> @a pos The widget-relative coordinates of the pointer.</span></div>
  277. <div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160;<span class="comment"> @a absolutePos The absolute coordinates of the pointer.</span></div>
  278. <div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160;<span class="comment"> @a delta The scroll distance.</span></div>
  279. <div class="line"><a name="l00210"></a><span class="lineno"> 210</span>&#160;<span class="comment"> @a direction The direction of the scroll or &quot;smooth&quot;.</span></div>
  280. <div class="line"><a name="l00211"></a><span class="lineno"> 211</span>&#160;<span class="comment"> @see onScroll</span></div>
  281. <div class="line"><a name="l00212"></a><span class="lineno"> 212</span>&#160;<span class="comment"> */</span></div>
  282. <div class="line"><a name="l00213"></a><span class="lineno"><a class="line" href="structWidget_1_1ScrollEvent.html"> 213</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structWidget_1_1ScrollEvent.html">ScrollEvent</a> : <a class="code" href="structWidget_1_1BaseEvent.html">BaseEvent</a> {</div>
  283. <div class="line"><a name="l00214"></a><span class="lineno"> 214</span>&#160; <a class="code" href="classPoint.html">Point&lt;double&gt;</a> pos;</div>
  284. <div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160; <a class="code" href="classPoint.html">Point&lt;double&gt;</a> absolutePos;</div>
  285. <div class="line"><a name="l00216"></a><span class="lineno"> 216</span>&#160; <a class="code" href="classPoint.html">Point&lt;double&gt;</a> delta;</div>
  286. <div class="line"><a name="l00217"></a><span class="lineno"> 217</span>&#160; ScrollDirection direction;</div>
  287. <div class="line"><a name="l00218"></a><span class="lineno"> 218</span>&#160;<span class="comment"></span> </div>
  288. <div class="line"><a name="l00219"></a><span class="lineno"> 219</span>&#160;<span class="comment"> /** Constuctor */</span></div>
  289. <div class="line"><a name="l00220"></a><span class="lineno"><a class="line" href="structWidget_1_1ScrollEvent.html#abee88b10b7b031ddcca1454e064a3cc3"> 220</a></span>&#160; <a class="code" href="structWidget_1_1ScrollEvent.html#abee88b10b7b031ddcca1454e064a3cc3">ScrollEvent</a>() noexcept</div>
  290. <div class="line"><a name="l00221"></a><span class="lineno"> 221</span>&#160; : <a class="code" href="structWidget_1_1BaseEvent.html">BaseEvent</a>(),</div>
  291. <div class="line"><a name="l00222"></a><span class="lineno"> 222</span>&#160; pos(0.0, 0.0),</div>
  292. <div class="line"><a name="l00223"></a><span class="lineno"> 223</span>&#160; absolutePos(0.0, 0.0),</div>
  293. <div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160; delta(0.0, 0.0),</div>
  294. <div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160; direction(kScrollSmooth) {}</div>
  295. <div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160; };</div>
  296. <div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160;<span class="comment"></span> </div>
  297. <div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160;<span class="comment"> /**</span></div>
  298. <div class="line"><a name="l00229"></a><span class="lineno"> 229</span>&#160;<span class="comment"> Resize event.</span></div>
  299. <div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160;<span class="comment"> @a size The new widget size.</span></div>
  300. <div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160;<span class="comment"> @a oldSize The previous size, may be null.</span></div>
  301. <div class="line"><a name="l00232"></a><span class="lineno"> 232</span>&#160;<span class="comment"> @see onResize</span></div>
  302. <div class="line"><a name="l00233"></a><span class="lineno"> 233</span>&#160;<span class="comment"> */</span></div>
  303. <div class="line"><a name="l00234"></a><span class="lineno"><a class="line" href="structWidget_1_1ResizeEvent.html"> 234</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structWidget_1_1ResizeEvent.html">ResizeEvent</a> {</div>
  304. <div class="line"><a name="l00235"></a><span class="lineno"> 235</span>&#160; <a class="code" href="classSize.html">Size&lt;uint&gt;</a> size;</div>
  305. <div class="line"><a name="l00236"></a><span class="lineno"> 236</span>&#160; <a class="code" href="classSize.html">Size&lt;uint&gt;</a> oldSize;</div>
  306. <div class="line"><a name="l00237"></a><span class="lineno"> 237</span>&#160;<span class="comment"></span> </div>
  307. <div class="line"><a name="l00238"></a><span class="lineno"> 238</span>&#160;<span class="comment"> /** Constuctor */</span></div>
  308. <div class="line"><a name="l00239"></a><span class="lineno"><a class="line" href="structWidget_1_1ResizeEvent.html#ac92abcdb2820807cd3d020864b96b3bd"> 239</a></span>&#160; <a class="code" href="structWidget_1_1ResizeEvent.html#ac92abcdb2820807cd3d020864b96b3bd">ResizeEvent</a>() noexcept</div>
  309. <div class="line"><a name="l00240"></a><span class="lineno"> 240</span>&#160; : size(0, 0),</div>
  310. <div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160; oldSize(0, 0) {}</div>
  311. <div class="line"><a name="l00242"></a><span class="lineno"> 242</span>&#160; };</div>
  312. <div class="line"><a name="l00243"></a><span class="lineno"> 243</span>&#160;<span class="comment"></span> </div>
  313. <div class="line"><a name="l00244"></a><span class="lineno"> 244</span>&#160;<span class="comment"> /**</span></div>
  314. <div class="line"><a name="l00245"></a><span class="lineno"> 245</span>&#160;<span class="comment"> Widget position changed event.</span></div>
  315. <div class="line"><a name="l00246"></a><span class="lineno"> 246</span>&#160;<span class="comment"> @a pos The new absolute position of the widget.</span></div>
  316. <div class="line"><a name="l00247"></a><span class="lineno"> 247</span>&#160;<span class="comment"> @a oldPos The previous absolute position of the widget.</span></div>
  317. <div class="line"><a name="l00248"></a><span class="lineno"> 248</span>&#160;<span class="comment"> @see onPositionChanged</span></div>
  318. <div class="line"><a name="l00249"></a><span class="lineno"> 249</span>&#160;<span class="comment"> */</span></div>
  319. <div class="line"><a name="l00250"></a><span class="lineno"><a class="line" href="structWidget_1_1PositionChangedEvent.html"> 250</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structWidget_1_1PositionChangedEvent.html">PositionChangedEvent</a> {</div>
  320. <div class="line"><a name="l00251"></a><span class="lineno"> 251</span>&#160; <a class="code" href="classPoint.html">Point&lt;int&gt;</a> pos;</div>
  321. <div class="line"><a name="l00252"></a><span class="lineno"> 252</span>&#160; <a class="code" href="classPoint.html">Point&lt;int&gt;</a> oldPos;</div>
  322. <div class="line"><a name="l00253"></a><span class="lineno"> 253</span>&#160;<span class="comment"></span> </div>
  323. <div class="line"><a name="l00254"></a><span class="lineno"> 254</span>&#160;<span class="comment"> /** Constuctor */</span></div>
  324. <div class="line"><a name="l00255"></a><span class="lineno"><a class="line" href="structWidget_1_1PositionChangedEvent.html#aa6360f57c0314621b04d049708bea45c"> 255</a></span>&#160; <a class="code" href="structWidget_1_1PositionChangedEvent.html#aa6360f57c0314621b04d049708bea45c">PositionChangedEvent</a>() noexcept</div>
  325. <div class="line"><a name="l00256"></a><span class="lineno"> 256</span>&#160; : pos(0, 0),</div>
  326. <div class="line"><a name="l00257"></a><span class="lineno"> 257</span>&#160; oldPos(0, 0) {}</div>
  327. <div class="line"><a name="l00258"></a><span class="lineno"> 258</span>&#160; };</div>
  328. <div class="line"><a name="l00259"></a><span class="lineno"> 259</span>&#160; </div>
  329. <div class="line"><a name="l00260"></a><span class="lineno"> 260</span>&#160;<span class="keyword">private</span>:<span class="comment"></span></div>
  330. <div class="line"><a name="l00261"></a><span class="lineno"> 261</span>&#160;<span class="comment"> /**</span></div>
  331. <div class="line"><a name="l00262"></a><span class="lineno"> 262</span>&#160;<span class="comment"> Private constructor, reserved for TopLevelWidget class.</span></div>
  332. <div class="line"><a name="l00263"></a><span class="lineno"> 263</span>&#160;<span class="comment"> */</span></div>
  333. <div class="line"><a name="l00264"></a><span class="lineno"> 264</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classWidget.html">Widget</a>(<a class="code" href="classTopLevelWidget.html">TopLevelWidget</a>* topLevelWidget);</div>
  334. <div class="line"><a name="l00265"></a><span class="lineno"> 265</span>&#160;<span class="comment"></span> </div>
  335. <div class="line"><a name="l00266"></a><span class="lineno"> 266</span>&#160;<span class="comment"> /**</span></div>
  336. <div class="line"><a name="l00267"></a><span class="lineno"> 267</span>&#160;<span class="comment"> Private constructor, reserved for SubWidget class.</span></div>
  337. <div class="line"><a name="l00268"></a><span class="lineno"> 268</span>&#160;<span class="comment"> */</span></div>
  338. <div class="line"><a name="l00269"></a><span class="lineno"> 269</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classWidget.html">Widget</a>(<a class="code" href="classWidget.html">Widget</a>* widgetToGroupTo);</div>
  339. <div class="line"><a name="l00270"></a><span class="lineno"> 270</span>&#160; </div>
  340. <div class="line"><a name="l00271"></a><span class="lineno"> 271</span>&#160;<span class="keyword">public</span>:<span class="comment"></span></div>
  341. <div class="line"><a name="l00272"></a><span class="lineno"> 272</span>&#160;<span class="comment"> /**</span></div>
  342. <div class="line"><a name="l00273"></a><span class="lineno"> 273</span>&#160;<span class="comment"> Destructor.</span></div>
  343. <div class="line"><a name="l00274"></a><span class="lineno"> 274</span>&#160;<span class="comment"> */</span></div>
  344. <div class="line"><a name="l00275"></a><span class="lineno"> 275</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classWidget.html#a714cf798aadb4d615f6f60a355382c02">~Widget</a>();</div>
  345. <div class="line"><a name="l00276"></a><span class="lineno"> 276</span>&#160;<span class="comment"></span> </div>
  346. <div class="line"><a name="l00277"></a><span class="lineno"> 277</span>&#160;<span class="comment"> /**</span></div>
  347. <div class="line"><a name="l00278"></a><span class="lineno"> 278</span>&#160;<span class="comment"> Check if this widget is visible within its parent window.</span></div>
  348. <div class="line"><a name="l00279"></a><span class="lineno"> 279</span>&#160;<span class="comment"> Invisible widgets do not receive events except resize.</span></div>
  349. <div class="line"><a name="l00280"></a><span class="lineno"> 280</span>&#160;<span class="comment"> */</span></div>
  350. <div class="line"><a name="l00281"></a><span class="lineno"> 281</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classWidget.html#a234a8ee8a685dc211ad11f492f0dbc71">isVisible</a>() const noexcept;</div>
  351. <div class="line"><a name="l00282"></a><span class="lineno"> 282</span>&#160;<span class="comment"></span> </div>
  352. <div class="line"><a name="l00283"></a><span class="lineno"> 283</span>&#160;<span class="comment"> /**</span></div>
  353. <div class="line"><a name="l00284"></a><span class="lineno"> 284</span>&#160;<span class="comment"> Set widget visible (or not) according to @a visible.</span></div>
  354. <div class="line"><a name="l00285"></a><span class="lineno"> 285</span>&#160;<span class="comment"> */</span></div>
  355. <div class="line"><a name="l00286"></a><span class="lineno"> 286</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classWidget.html#a66088a03691f9c643ff335fa826576ba">setVisible</a>(<span class="keywordtype">bool</span> visible);</div>
  356. <div class="line"><a name="l00287"></a><span class="lineno"> 287</span>&#160;<span class="comment"></span> </div>
  357. <div class="line"><a name="l00288"></a><span class="lineno"> 288</span>&#160;<span class="comment"> /**</span></div>
  358. <div class="line"><a name="l00289"></a><span class="lineno"> 289</span>&#160;<span class="comment"> Show widget.</span></div>
  359. <div class="line"><a name="l00290"></a><span class="lineno"> 290</span>&#160;<span class="comment"> This is the same as calling setVisible(true).</span></div>
  360. <div class="line"><a name="l00291"></a><span class="lineno"> 291</span>&#160;<span class="comment"> */</span></div>
  361. <div class="line"><a name="l00292"></a><span class="lineno"> 292</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classWidget.html#a25ff178539e226b5f30ef0335d060f2b">show</a>();</div>
  362. <div class="line"><a name="l00293"></a><span class="lineno"> 293</span>&#160;<span class="comment"></span> </div>
  363. <div class="line"><a name="l00294"></a><span class="lineno"> 294</span>&#160;<span class="comment"> /**</span></div>
  364. <div class="line"><a name="l00295"></a><span class="lineno"> 295</span>&#160;<span class="comment"> Hide widget.</span></div>
  365. <div class="line"><a name="l00296"></a><span class="lineno"> 296</span>&#160;<span class="comment"> This is the same as calling setVisible(false).</span></div>
  366. <div class="line"><a name="l00297"></a><span class="lineno"> 297</span>&#160;<span class="comment"> */</span></div>
  367. <div class="line"><a name="l00298"></a><span class="lineno"> 298</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classWidget.html#a4a2f8eebacdd20db505b838f1a118c6b">hide</a>();</div>
  368. <div class="line"><a name="l00299"></a><span class="lineno"> 299</span>&#160;<span class="comment"></span> </div>
  369. <div class="line"><a name="l00300"></a><span class="lineno"> 300</span>&#160;<span class="comment"> /**</span></div>
  370. <div class="line"><a name="l00301"></a><span class="lineno"> 301</span>&#160;<span class="comment"> Get width.</span></div>
  371. <div class="line"><a name="l00302"></a><span class="lineno"> 302</span>&#160;<span class="comment"> */</span></div>
  372. <div class="line"><a name="l00303"></a><span class="lineno"> 303</span>&#160; uint <a class="code" href="classWidget.html#a169c317caf734c6664494a573e427b40">getWidth</a>() const noexcept;</div>
  373. <div class="line"><a name="l00304"></a><span class="lineno"> 304</span>&#160;<span class="comment"></span> </div>
  374. <div class="line"><a name="l00305"></a><span class="lineno"> 305</span>&#160;<span class="comment"> /**</span></div>
  375. <div class="line"><a name="l00306"></a><span class="lineno"> 306</span>&#160;<span class="comment"> Get height.</span></div>
  376. <div class="line"><a name="l00307"></a><span class="lineno"> 307</span>&#160;<span class="comment"> */</span></div>
  377. <div class="line"><a name="l00308"></a><span class="lineno"> 308</span>&#160; uint <a class="code" href="classWidget.html#aa20f6dc096a8836706173f31324c4db8">getHeight</a>() const noexcept;</div>
  378. <div class="line"><a name="l00309"></a><span class="lineno"> 309</span>&#160;<span class="comment"></span> </div>
  379. <div class="line"><a name="l00310"></a><span class="lineno"> 310</span>&#160;<span class="comment"> /**</span></div>
  380. <div class="line"><a name="l00311"></a><span class="lineno"> 311</span>&#160;<span class="comment"> Get size.</span></div>
  381. <div class="line"><a name="l00312"></a><span class="lineno"> 312</span>&#160;<span class="comment"> */</span></div>
  382. <div class="line"><a name="l00313"></a><span class="lineno"> 313</span>&#160; const <a class="code" href="classSize.html">Size</a>&lt;uint&gt; <a class="code" href="classWidget.html#a9044d42c20ead27dba983b710c94f8d6">getSize</a>() const noexcept;</div>
  383. <div class="line"><a name="l00314"></a><span class="lineno"> 314</span>&#160;<span class="comment"></span> </div>
  384. <div class="line"><a name="l00315"></a><span class="lineno"> 315</span>&#160;<span class="comment"> /**</span></div>
  385. <div class="line"><a name="l00316"></a><span class="lineno"> 316</span>&#160;<span class="comment"> Set width.</span></div>
  386. <div class="line"><a name="l00317"></a><span class="lineno"> 317</span>&#160;<span class="comment"> */</span></div>
  387. <div class="line"><a name="l00318"></a><span class="lineno"> 318</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classWidget.html#aed80a9cbc4a13c01641f35dd3d8688ea">setWidth</a>(uint width) noexcept;</div>
  388. <div class="line"><a name="l00319"></a><span class="lineno"> 319</span>&#160;<span class="comment"></span> </div>
  389. <div class="line"><a name="l00320"></a><span class="lineno"> 320</span>&#160;<span class="comment"> /**</span></div>
  390. <div class="line"><a name="l00321"></a><span class="lineno"> 321</span>&#160;<span class="comment"> Set height.</span></div>
  391. <div class="line"><a name="l00322"></a><span class="lineno"> 322</span>&#160;<span class="comment"> */</span></div>
  392. <div class="line"><a name="l00323"></a><span class="lineno"> 323</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classWidget.html#ac6d2e6cbb2ff96f3645493d804af07f7">setHeight</a>(uint height) noexcept;</div>
  393. <div class="line"><a name="l00324"></a><span class="lineno"> 324</span>&#160;<span class="comment"></span> </div>
  394. <div class="line"><a name="l00325"></a><span class="lineno"> 325</span>&#160;<span class="comment"> /**</span></div>
  395. <div class="line"><a name="l00326"></a><span class="lineno"> 326</span>&#160;<span class="comment"> Set size using @a width and @a height values.</span></div>
  396. <div class="line"><a name="l00327"></a><span class="lineno"> 327</span>&#160;<span class="comment"> */</span></div>
  397. <div class="line"><a name="l00328"></a><span class="lineno"> 328</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classWidget.html#ab4d9e0156e455db3ff23730f82544daa">setSize</a>(uint width, uint height) noexcept;</div>
  398. <div class="line"><a name="l00329"></a><span class="lineno"> 329</span>&#160;<span class="comment"></span> </div>
  399. <div class="line"><a name="l00330"></a><span class="lineno"> 330</span>&#160;<span class="comment"> /**</span></div>
  400. <div class="line"><a name="l00331"></a><span class="lineno"> 331</span>&#160;<span class="comment"> Set size.</span></div>
  401. <div class="line"><a name="l00332"></a><span class="lineno"> 332</span>&#160;<span class="comment"> */</span></div>
  402. <div class="line"><a name="l00333"></a><span class="lineno"> 333</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classWidget.html#ab4d9e0156e455db3ff23730f82544daa">setSize</a>(const <a class="code" href="classSize.html">Size</a>&lt;uint&gt;&amp; size) noexcept;</div>
  403. <div class="line"><a name="l00334"></a><span class="lineno"> 334</span>&#160;<span class="comment"></span> </div>
  404. <div class="line"><a name="l00335"></a><span class="lineno"> 335</span>&#160;<span class="comment"> /**</span></div>
  405. <div class="line"><a name="l00336"></a><span class="lineno"> 336</span>&#160;<span class="comment"> Get the Id associated with this widget.</span></div>
  406. <div class="line"><a name="l00337"></a><span class="lineno"> 337</span>&#160;<span class="comment"> @see setId</span></div>
  407. <div class="line"><a name="l00338"></a><span class="lineno"> 338</span>&#160;<span class="comment"> */</span></div>
  408. <div class="line"><a name="l00339"></a><span class="lineno"> 339</span>&#160; uint <a class="code" href="classWidget.html#a3ee6b2824e3f3719c1c9b3d070385f49">getId</a>() const noexcept;</div>
  409. <div class="line"><a name="l00340"></a><span class="lineno"> 340</span>&#160;<span class="comment"></span> </div>
  410. <div class="line"><a name="l00341"></a><span class="lineno"> 341</span>&#160;<span class="comment"> /**</span></div>
  411. <div class="line"><a name="l00342"></a><span class="lineno"> 342</span>&#160;<span class="comment"> Set an Id to be associated with this widget.</span></div>
  412. <div class="line"><a name="l00343"></a><span class="lineno"> 343</span>&#160;<span class="comment"> @see getId</span></div>
  413. <div class="line"><a name="l00344"></a><span class="lineno"> 344</span>&#160;<span class="comment"> */</span></div>
  414. <div class="line"><a name="l00345"></a><span class="lineno"> 345</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classWidget.html#abfba3652559de84ba1ae9ccbd3d35e31">setId</a>(uint <span class="keywordtype">id</span>) noexcept;</div>
  415. <div class="line"><a name="l00346"></a><span class="lineno"> 346</span>&#160;<span class="comment"></span> </div>
  416. <div class="line"><a name="l00347"></a><span class="lineno"> 347</span>&#160;<span class="comment"> /**</span></div>
  417. <div class="line"><a name="l00348"></a><span class="lineno"> 348</span>&#160;<span class="comment"> Get the application associated with this widget&#39;s window.</span></div>
  418. <div class="line"><a name="l00349"></a><span class="lineno"> 349</span>&#160;<span class="comment"> This is the same as calling `getTopLevelWidget()-&gt;getApp()`.</span></div>
  419. <div class="line"><a name="l00350"></a><span class="lineno"> 350</span>&#160;<span class="comment"> */</span></div>
  420. <div class="line"><a name="l00351"></a><span class="lineno"> 351</span>&#160; <a class="code" href="classApplication.html">Application</a>&amp; <a class="code" href="classWidget.html#a373419bc6353abf50a502cdbebd736e7">getApp</a>() const noexcept;</div>
  421. <div class="line"><a name="l00352"></a><span class="lineno"> 352</span>&#160;<span class="comment"></span> </div>
  422. <div class="line"><a name="l00353"></a><span class="lineno"> 353</span>&#160;<span class="comment"> /**</span></div>
  423. <div class="line"><a name="l00354"></a><span class="lineno"> 354</span>&#160;<span class="comment"> Get the window associated with this widget.</span></div>
  424. <div class="line"><a name="l00355"></a><span class="lineno"> 355</span>&#160;<span class="comment"> This is the same as calling `getTopLevelWidget()-&gt;getWindow()`.</span></div>
  425. <div class="line"><a name="l00356"></a><span class="lineno"> 356</span>&#160;<span class="comment"> */</span></div>
  426. <div class="line"><a name="l00357"></a><span class="lineno"> 357</span>&#160; <a class="code" href="classWindow.html">Window</a>&amp; <a class="code" href="classWidget.html#a0ef05695aec704b0eb1eb91c2e8af07d">getWindow</a>() const noexcept;</div>
  427. <div class="line"><a name="l00358"></a><span class="lineno"> 358</span>&#160;<span class="comment"></span> </div>
  428. <div class="line"><a name="l00359"></a><span class="lineno"> 359</span>&#160;<span class="comment"> /**</span></div>
  429. <div class="line"><a name="l00360"></a><span class="lineno"> 360</span>&#160;<span class="comment"> Get the graphics context associated with this widget&#39;s window.</span></div>
  430. <div class="line"><a name="l00361"></a><span class="lineno"> 361</span>&#160;<span class="comment"> GraphicsContext is an empty struct and needs to be casted into a different type in order to be usable,</span></div>
  431. <div class="line"><a name="l00362"></a><span class="lineno"> 362</span>&#160;<span class="comment"> for example GraphicsContext.</span></div>
  432. <div class="line"><a name="l00363"></a><span class="lineno"> 363</span>&#160;<span class="comment"> @see CairoSubWidget, CairoTopLevelWidget</span></div>
  433. <div class="line"><a name="l00364"></a><span class="lineno"> 364</span>&#160;<span class="comment"> */</span></div>
  434. <div class="line"><a name="l00365"></a><span class="lineno"> 365</span>&#160; const <a class="code" href="structGraphicsContext.html">GraphicsContext</a>&amp; <a class="code" href="classWidget.html#ae23d09ec0e5f0397a3451b603b407182">getGraphicsContext</a>() const noexcept;</div>
  435. <div class="line"><a name="l00366"></a><span class="lineno"> 366</span>&#160;<span class="comment"></span> </div>
  436. <div class="line"><a name="l00367"></a><span class="lineno"> 367</span>&#160;<span class="comment"> /**</span></div>
  437. <div class="line"><a name="l00368"></a><span class="lineno"> 368</span>&#160;<span class="comment"> Get top-level widget, as passed directly in the constructor</span></div>
  438. <div class="line"><a name="l00369"></a><span class="lineno"> 369</span>&#160;<span class="comment"> or going up the chain of group widgets until it finds the top-level one.</span></div>
  439. <div class="line"><a name="l00370"></a><span class="lineno"> 370</span>&#160;<span class="comment"> */</span></div>
  440. <div class="line"><a name="l00371"></a><span class="lineno"> 371</span>&#160; <a class="code" href="classTopLevelWidget.html">TopLevelWidget</a>* <a class="code" href="classWidget.html#a607b153f7d3187ca60bf21004efc1314">getTopLevelWidget</a>() const noexcept;</div>
  441. <div class="line"><a name="l00372"></a><span class="lineno"> 372</span>&#160;<span class="comment"></span> </div>
  442. <div class="line"><a name="l00373"></a><span class="lineno"> 373</span>&#160;<span class="comment"> /**</span></div>
  443. <div class="line"><a name="l00374"></a><span class="lineno"> 374</span>&#160;<span class="comment"> Request repaint of this widget&#39;s area to the window this widget belongs to.</span></div>
  444. <div class="line"><a name="l00375"></a><span class="lineno"> 375</span>&#160;<span class="comment"> On the raw Widget class this function does nothing.</span></div>
  445. <div class="line"><a name="l00376"></a><span class="lineno"> 376</span>&#160;<span class="comment"> */</span></div>
  446. <div class="line"><a name="l00377"></a><span class="lineno"> 377</span>&#160; virtual <span class="keywordtype">void</span> <a class="code" href="classWidget.html#abe8cfe0aaae71dd011cf9a86e930fd12">repaint</a>() noexcept;</div>
  447. <div class="line"><a name="l00378"></a><span class="lineno"> 378</span>&#160; </div>
  448. <div class="line"><a name="l00379"></a><span class="lineno"> 379</span>&#160; DISTRHO_DEPRECATED_BY(&quot;<a class="code" href="classWidget.html#a373419bc6353abf50a502cdbebd736e7">getApp</a>()&quot;)</div>
  449. <div class="line"><a name="l00380"></a><span class="lineno"> 380</span>&#160; <a class="code" href="classApplication.html">Application</a>&amp; getParentApp() const noexcept { <span class="keywordflow">return</span> <a class="code" href="classWidget.html#a373419bc6353abf50a502cdbebd736e7">getApp</a>(); }</div>
  450. <div class="line"><a name="l00381"></a><span class="lineno"> 381</span>&#160; </div>
  451. <div class="line"><a name="l00382"></a><span class="lineno"> 382</span>&#160; DISTRHO_DEPRECATED_BY(<span class="stringliteral">&quot;getWindow()&quot;</span>)</div>
  452. <div class="line"><a name="l00383"></a><span class="lineno"> 383</span>&#160; <a class="code" href="classWindow.html">Window</a>&amp; getParentWindow() const noexcept { <span class="keywordflow">return</span> <a class="code" href="classWidget.html#a0ef05695aec704b0eb1eb91c2e8af07d">getWindow</a>(); }</div>
  453. <div class="line"><a name="l00384"></a><span class="lineno"> 384</span>&#160; </div>
  454. <div class="line"><a name="l00385"></a><span class="lineno"> 385</span>&#160;<span class="keyword">protected</span>:<span class="comment"></span></div>
  455. <div class="line"><a name="l00386"></a><span class="lineno"> 386</span>&#160;<span class="comment"> /**</span></div>
  456. <div class="line"><a name="l00387"></a><span class="lineno"> 387</span>&#160;<span class="comment"> A function called to draw the widget contents.</span></div>
  457. <div class="line"><a name="l00388"></a><span class="lineno"> 388</span>&#160;<span class="comment"> */</span></div>
  458. <div class="line"><a name="l00389"></a><span class="lineno"> 389</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classWidget.html#ae1554f348fe3b2f9d4c3c5c4f9ec55bd">onDisplay</a>() = 0;</div>
  459. <div class="line"><a name="l00390"></a><span class="lineno"> 390</span>&#160;<span class="comment"></span> </div>
  460. <div class="line"><a name="l00391"></a><span class="lineno"> 391</span>&#160;<span class="comment"> /**</span></div>
  461. <div class="line"><a name="l00392"></a><span class="lineno"> 392</span>&#160;<span class="comment"> A function called when a key is pressed or released.</span></div>
  462. <div class="line"><a name="l00393"></a><span class="lineno"> 393</span>&#160;<span class="comment"> @return True to stop event propagation, false otherwise.</span></div>
  463. <div class="line"><a name="l00394"></a><span class="lineno"> 394</span>&#160;<span class="comment"> */</span></div>
  464. <div class="line"><a name="l00395"></a><span class="lineno"> 395</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classWidget.html#a9fa874aede538b41348f1029524aea11">onKeyboard</a>(<span class="keyword">const</span> KeyboardEvent&amp;);</div>
  465. <div class="line"><a name="l00396"></a><span class="lineno"> 396</span>&#160;<span class="comment"></span> </div>
  466. <div class="line"><a name="l00397"></a><span class="lineno"> 397</span>&#160;<span class="comment"> /**</span></div>
  467. <div class="line"><a name="l00398"></a><span class="lineno"> 398</span>&#160;<span class="comment"> A function called when a special key is pressed or released.</span></div>
  468. <div class="line"><a name="l00399"></a><span class="lineno"> 399</span>&#160;<span class="comment"> @return True to stop event propagation, false otherwise.</span></div>
  469. <div class="line"><a name="l00400"></a><span class="lineno"> 400</span>&#160;<span class="comment"> */</span></div>
  470. <div class="line"><a name="l00401"></a><span class="lineno"> 401</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classWidget.html#a3b42652fcb2f95c6f86bdd43a1727507">onSpecial</a>(<span class="keyword">const</span> SpecialEvent&amp;);</div>
  471. <div class="line"><a name="l00402"></a><span class="lineno"> 402</span>&#160;<span class="comment"></span> </div>
  472. <div class="line"><a name="l00403"></a><span class="lineno"> 403</span>&#160;<span class="comment"> /**</span></div>
  473. <div class="line"><a name="l00404"></a><span class="lineno"> 404</span>&#160;<span class="comment"> A function called when an UTF-8 character is received.</span></div>
  474. <div class="line"><a name="l00405"></a><span class="lineno"> 405</span>&#160;<span class="comment"> @return True to stop event propagation, false otherwise.</span></div>
  475. <div class="line"><a name="l00406"></a><span class="lineno"> 406</span>&#160;<span class="comment"> */</span></div>
  476. <div class="line"><a name="l00407"></a><span class="lineno"> 407</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classWidget.html#ad7fb24de24d8809305b04ff3750f0dea">onCharacterInput</a>(<span class="keyword">const</span> CharacterInputEvent&amp;);</div>
  477. <div class="line"><a name="l00408"></a><span class="lineno"> 408</span>&#160;<span class="comment"></span> </div>
  478. <div class="line"><a name="l00409"></a><span class="lineno"> 409</span>&#160;<span class="comment"> /**</span></div>
  479. <div class="line"><a name="l00410"></a><span class="lineno"> 410</span>&#160;<span class="comment"> A function called when a mouse button is pressed or released.</span></div>
  480. <div class="line"><a name="l00411"></a><span class="lineno"> 411</span>&#160;<span class="comment"> @return True to stop event propagation, false otherwise.</span></div>
  481. <div class="line"><a name="l00412"></a><span class="lineno"> 412</span>&#160;<span class="comment"> */</span></div>
  482. <div class="line"><a name="l00413"></a><span class="lineno"> 413</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classWidget.html#a097ec1d56a06bdc9e0a4e54880def378">onMouse</a>(<span class="keyword">const</span> MouseEvent&amp;);</div>
  483. <div class="line"><a name="l00414"></a><span class="lineno"> 414</span>&#160;<span class="comment"></span> </div>
  484. <div class="line"><a name="l00415"></a><span class="lineno"> 415</span>&#160;<span class="comment"> /**</span></div>
  485. <div class="line"><a name="l00416"></a><span class="lineno"> 416</span>&#160;<span class="comment"> A function called when the pointer moves.</span></div>
  486. <div class="line"><a name="l00417"></a><span class="lineno"> 417</span>&#160;<span class="comment"> @return True to stop event propagation, false otherwise.</span></div>
  487. <div class="line"><a name="l00418"></a><span class="lineno"> 418</span>&#160;<span class="comment"> */</span></div>
  488. <div class="line"><a name="l00419"></a><span class="lineno"> 419</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classWidget.html#a655569fb78a598652e9f24cefa1fe4a5">onMotion</a>(<span class="keyword">const</span> MotionEvent&amp;);</div>
  489. <div class="line"><a name="l00420"></a><span class="lineno"> 420</span>&#160;<span class="comment"></span> </div>
  490. <div class="line"><a name="l00421"></a><span class="lineno"> 421</span>&#160;<span class="comment"> /**</span></div>
  491. <div class="line"><a name="l00422"></a><span class="lineno"> 422</span>&#160;<span class="comment"> A function called on scrolling (e.g. mouse wheel or track pad).</span></div>
  492. <div class="line"><a name="l00423"></a><span class="lineno"> 423</span>&#160;<span class="comment"> @return True to stop event propagation, false otherwise.</span></div>
  493. <div class="line"><a name="l00424"></a><span class="lineno"> 424</span>&#160;<span class="comment"> */</span></div>
  494. <div class="line"><a name="l00425"></a><span class="lineno"> 425</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classWidget.html#a0d78d28bd4a98c3a016a38091b2d4185">onScroll</a>(<span class="keyword">const</span> ScrollEvent&amp;);</div>
  495. <div class="line"><a name="l00426"></a><span class="lineno"> 426</span>&#160;<span class="comment"></span> </div>
  496. <div class="line"><a name="l00427"></a><span class="lineno"> 427</span>&#160;<span class="comment"> /**</span></div>
  497. <div class="line"><a name="l00428"></a><span class="lineno"> 428</span>&#160;<span class="comment"> A function called when the widget is resized.</span></div>
  498. <div class="line"><a name="l00429"></a><span class="lineno"> 429</span>&#160;<span class="comment"> */</span></div>
  499. <div class="line"><a name="l00430"></a><span class="lineno"> 430</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classWidget.html#acc0365ec4b9245bdffb8d0285be55dea">onResize</a>(<span class="keyword">const</span> ResizeEvent&amp;);</div>
  500. <div class="line"><a name="l00431"></a><span class="lineno"> 431</span>&#160; </div>
  501. <div class="line"><a name="l00432"></a><span class="lineno"> 432</span>&#160;<span class="keyword">private</span>:</div>
  502. <div class="line"><a name="l00433"></a><span class="lineno"> 433</span>&#160; <span class="keyword">struct </span>PrivateData;</div>
  503. <div class="line"><a name="l00434"></a><span class="lineno"> 434</span>&#160; PrivateData* <span class="keyword">const</span> pData;</div>
  504. <div class="line"><a name="l00435"></a><span class="lineno"> 435</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classSubWidget.html">SubWidget</a>;</div>
  505. <div class="line"><a name="l00436"></a><span class="lineno"> 436</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classTopLevelWidget.html">TopLevelWidget</a>;</div>
  506. <div class="line"><a name="l00437"></a><span class="lineno"> 437</span>&#160; </div>
  507. <div class="line"><a name="l00438"></a><span class="lineno"> 438</span>&#160; DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(<a class="code" href="classWidget.html">Widget</a>)</div>
  508. <div class="line"><a name="l00439"></a><span class="lineno"> 439</span>&#160;};</div>
  509. <div class="line"><a name="l00440"></a><span class="lineno"> 440</span>&#160; </div>
  510. <div class="line"><a name="l00441"></a><span class="lineno"> 441</span>&#160;<span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>
  511. <div class="line"><a name="l00442"></a><span class="lineno"> 442</span>&#160; </div>
  512. <div class="line"><a name="l00443"></a><span class="lineno"> 443</span>&#160;END_NAMESPACE_DGL</div>
  513. <div class="line"><a name="l00444"></a><span class="lineno"> 444</span>&#160; </div>
  514. <div class="line"><a name="l00445"></a><span class="lineno"> 445</span>&#160;<span class="preprocessor">#endif // DGL_WIDGET_HPP_INCLUDED</span></div>
  515. </div><!-- fragment --></div><!-- contents -->
  516. <div class="ttc" id="astructWidget_1_1ScrollEvent_html"><div class="ttname"><a href="structWidget_1_1ScrollEvent.html">Widget::ScrollEvent</a></div><div class="ttdef"><b>Definition:</b> Widget.hpp:213</div></div>
  517. <div class="ttc" id="astructWidget_1_1PositionChangedEvent_html_aa6360f57c0314621b04d049708bea45c"><div class="ttname"><a href="structWidget_1_1PositionChangedEvent.html#aa6360f57c0314621b04d049708bea45c">Widget::PositionChangedEvent::PositionChangedEvent</a></div><div class="ttdeci">PositionChangedEvent() noexcept</div><div class="ttdef"><b>Definition:</b> Widget.hpp:255</div></div>
  518. <div class="ttc" id="astructGraphicsContext_html"><div class="ttname"><a href="structGraphicsContext.html">GraphicsContext</a></div><div class="ttdef"><b>Definition:</b> Base.hpp:154</div></div>
  519. <div class="ttc" id="astructWidget_1_1KeyboardEvent_html"><div class="ttname"><a href="structWidget_1_1KeyboardEvent.html">Widget::KeyboardEvent</a></div><div class="ttdef"><b>Definition:</b> Widget.hpp:94</div></div>
  520. <div class="ttc" id="astructWidget_1_1BaseEvent_html"><div class="ttname"><a href="structWidget_1_1BaseEvent.html">Widget::BaseEvent</a></div><div class="ttdef"><b>Definition:</b> Widget.hpp:64</div></div>
  521. <div class="ttc" id="aclassWidget_html_a66088a03691f9c643ff335fa826576ba"><div class="ttname"><a href="classWidget.html#a66088a03691f9c643ff335fa826576ba">Widget::setVisible</a></div><div class="ttdeci">void setVisible(bool visible)</div></div>
  522. <div class="ttc" id="aclassWidget_html_a097ec1d56a06bdc9e0a4e54880def378"><div class="ttname"><a href="classWidget.html#a097ec1d56a06bdc9e0a4e54880def378">Widget::onMouse</a></div><div class="ttdeci">virtual bool onMouse(const MouseEvent &amp;)</div></div>
  523. <div class="ttc" id="aclassWindow_html"><div class="ttname"><a href="classWindow.html">Window</a></div><div class="ttdef"><b>Definition:</b> Window.hpp:50</div></div>
  524. <div class="ttc" id="aclassWidget_html_a655569fb78a598652e9f24cefa1fe4a5"><div class="ttname"><a href="classWidget.html#a655569fb78a598652e9f24cefa1fe4a5">Widget::onMotion</a></div><div class="ttdeci">virtual bool onMotion(const MotionEvent &amp;)</div></div>
  525. <div class="ttc" id="astructWidget_1_1CharacterInputEvent_html"><div class="ttname"><a href="structWidget_1_1CharacterInputEvent.html">Widget::CharacterInputEvent</a></div><div class="ttdef"><b>Definition:</b> Widget.hpp:143</div></div>
  526. <div class="ttc" id="aclassWidget_html_a9fa874aede538b41348f1029524aea11"><div class="ttname"><a href="classWidget.html#a9fa874aede538b41348f1029524aea11">Widget::onKeyboard</a></div><div class="ttdeci">virtual bool onKeyboard(const KeyboardEvent &amp;)</div></div>
  527. <div class="ttc" id="aclassSize_html"><div class="ttname"><a href="classSize.html">Size&lt; uint &gt;</a></div></div>
  528. <div class="ttc" id="aclassApplication_html"><div class="ttname"><a href="classApplication.html">Application</a></div><div class="ttdef"><b>Definition:</b> Application.hpp:34</div></div>
  529. <div class="ttc" id="astructWidget_1_1ResizeEvent_html_ac92abcdb2820807cd3d020864b96b3bd"><div class="ttname"><a href="structWidget_1_1ResizeEvent.html#ac92abcdb2820807cd3d020864b96b3bd">Widget::ResizeEvent::ResizeEvent</a></div><div class="ttdeci">ResizeEvent() noexcept</div><div class="ttdef"><b>Definition:</b> Widget.hpp:239</div></div>
  530. <div class="ttc" id="astructWidget_1_1MotionEvent_html"><div class="ttname"><a href="structWidget_1_1MotionEvent.html">Widget::MotionEvent</a></div><div class="ttdef"><b>Definition:</b> Widget.hpp:187</div></div>
  531. <div class="ttc" id="aclassWidget_html_a25ff178539e226b5f30ef0335d060f2b"><div class="ttname"><a href="classWidget.html#a25ff178539e226b5f30ef0335d060f2b">Widget::show</a></div><div class="ttdeci">void show()</div></div>
  532. <div class="ttc" id="aclassWidget_html_ac6d2e6cbb2ff96f3645493d804af07f7"><div class="ttname"><a href="classWidget.html#ac6d2e6cbb2ff96f3645493d804af07f7">Widget::setHeight</a></div><div class="ttdeci">void setHeight(uint height) noexcept</div></div>
  533. <div class="ttc" id="aclassWidget_html_ad7fb24de24d8809305b04ff3750f0dea"><div class="ttname"><a href="classWidget.html#ad7fb24de24d8809305b04ff3750f0dea">Widget::onCharacterInput</a></div><div class="ttdeci">virtual bool onCharacterInput(const CharacterInputEvent &amp;)</div></div>
  534. <div class="ttc" id="astructWidget_1_1CharacterInputEvent_html_ab0e3407cf8693ba9f3be0be805c8af24"><div class="ttname"><a href="structWidget_1_1CharacterInputEvent.html#ab0e3407cf8693ba9f3be0be805c8af24">Widget::CharacterInputEvent::CharacterInputEvent</a></div><div class="ttdeci">CharacterInputEvent() noexcept</div><div class="ttdef"><b>Definition:</b> Widget.hpp:149</div></div>
  535. <div class="ttc" id="aclassWidget_html_a234a8ee8a685dc211ad11f492f0dbc71"><div class="ttname"><a href="classWidget.html#a234a8ee8a685dc211ad11f492f0dbc71">Widget::isVisible</a></div><div class="ttdeci">bool isVisible() const noexcept</div></div>
  536. <div class="ttc" id="aclassWidget_html_a3b42652fcb2f95c6f86bdd43a1727507"><div class="ttname"><a href="classWidget.html#a3b42652fcb2f95c6f86bdd43a1727507">Widget::onSpecial</a></div><div class="ttdeci">virtual bool onSpecial(const SpecialEvent &amp;)</div></div>
  537. <div class="ttc" id="aclassWidget_html_a0d78d28bd4a98c3a016a38091b2d4185"><div class="ttname"><a href="classWidget.html#a0d78d28bd4a98c3a016a38091b2d4185">Widget::onScroll</a></div><div class="ttdeci">virtual bool onScroll(const ScrollEvent &amp;)</div></div>
  538. <div class="ttc" id="aclassWidget_html_a373419bc6353abf50a502cdbebd736e7"><div class="ttname"><a href="classWidget.html#a373419bc6353abf50a502cdbebd736e7">Widget::getApp</a></div><div class="ttdeci">Application &amp; getApp() const noexcept</div></div>
  539. <div class="ttc" id="astructWidget_1_1KeyboardEvent_html_a5a55a296264b9999a7915f2633eacb10"><div class="ttname"><a href="structWidget_1_1KeyboardEvent.html#a5a55a296264b9999a7915f2633eacb10">Widget::KeyboardEvent::KeyboardEvent</a></div><div class="ttdeci">KeyboardEvent() noexcept</div><div class="ttdef"><b>Definition:</b> Widget.hpp:100</div></div>
  540. <div class="ttc" id="aclassWidget_html_a4a2f8eebacdd20db505b838f1a118c6b"><div class="ttname"><a href="classWidget.html#a4a2f8eebacdd20db505b838f1a118c6b">Widget::hide</a></div><div class="ttdeci">void hide()</div></div>
  541. <div class="ttc" id="astructWidget_1_1ScrollEvent_html_abee88b10b7b031ddcca1454e064a3cc3"><div class="ttname"><a href="structWidget_1_1ScrollEvent.html#abee88b10b7b031ddcca1454e064a3cc3">Widget::ScrollEvent::ScrollEvent</a></div><div class="ttdeci">ScrollEvent() noexcept</div><div class="ttdef"><b>Definition:</b> Widget.hpp:220</div></div>
  542. <div class="ttc" id="astructWidget_1_1PositionChangedEvent_html"><div class="ttname"><a href="structWidget_1_1PositionChangedEvent.html">Widget::PositionChangedEvent</a></div><div class="ttdef"><b>Definition:</b> Widget.hpp:250</div></div>
  543. <div class="ttc" id="aclassWidget_html_acc0365ec4b9245bdffb8d0285be55dea"><div class="ttname"><a href="classWidget.html#acc0365ec4b9245bdffb8d0285be55dea">Widget::onResize</a></div><div class="ttdeci">virtual void onResize(const ResizeEvent &amp;)</div></div>
  544. <div class="ttc" id="aclassWidget_html_a9044d42c20ead27dba983b710c94f8d6"><div class="ttname"><a href="classWidget.html#a9044d42c20ead27dba983b710c94f8d6">Widget::getSize</a></div><div class="ttdeci">const Size&lt; uint &gt; getSize() const noexcept</div></div>
  545. <div class="ttc" id="aclassWidget_html_abfba3652559de84ba1ae9ccbd3d35e31"><div class="ttname"><a href="classWidget.html#abfba3652559de84ba1ae9ccbd3d35e31">Widget::setId</a></div><div class="ttdeci">void setId(uint id) noexcept</div></div>
  546. <div class="ttc" id="aclassWidget_html_abe8cfe0aaae71dd011cf9a86e930fd12"><div class="ttname"><a href="classWidget.html#abe8cfe0aaae71dd011cf9a86e930fd12">Widget::repaint</a></div><div class="ttdeci">virtual void repaint() noexcept</div></div>
  547. <div class="ttc" id="aclassWidget_html_a169c317caf734c6664494a573e427b40"><div class="ttname"><a href="classWidget.html#a169c317caf734c6664494a573e427b40">Widget::getWidth</a></div><div class="ttdeci">uint getWidth() const noexcept</div></div>
  548. <div class="ttc" id="aclassWidget_html_a0ef05695aec704b0eb1eb91c2e8af07d"><div class="ttname"><a href="classWidget.html#a0ef05695aec704b0eb1eb91c2e8af07d">Widget::getWindow</a></div><div class="ttdeci">Window &amp; getWindow() const noexcept</div></div>
  549. <div class="ttc" id="aclassPoint_html"><div class="ttname"><a href="classPoint.html">Point&lt; double &gt;</a></div></div>
  550. <div class="ttc" id="aclassSubWidget_html"><div class="ttname"><a href="classSubWidget.html">SubWidget</a></div><div class="ttdef"><b>Definition:</b> SubWidget.hpp:39</div></div>
  551. <div class="ttc" id="astructWidget_1_1MouseEvent_html"><div class="ttname"><a href="structWidget_1_1MouseEvent.html">Widget::MouseEvent</a></div><div class="ttdef"><b>Definition:</b> Widget.hpp:165</div></div>
  552. <div class="ttc" id="astructWidget_1_1ResizeEvent_html"><div class="ttname"><a href="structWidget_1_1ResizeEvent.html">Widget::ResizeEvent</a></div><div class="ttdef"><b>Definition:</b> Widget.hpp:234</div></div>
  553. <div class="ttc" id="aclassWidget_html_aed80a9cbc4a13c01641f35dd3d8688ea"><div class="ttname"><a href="classWidget.html#aed80a9cbc4a13c01641f35dd3d8688ea">Widget::setWidth</a></div><div class="ttdeci">void setWidth(uint width) noexcept</div></div>
  554. <div class="ttc" id="aclassWidget_html_ae1554f348fe3b2f9d4c3c5c4f9ec55bd"><div class="ttname"><a href="classWidget.html#ae1554f348fe3b2f9d4c3c5c4f9ec55bd">Widget::onDisplay</a></div><div class="ttdeci">virtual void onDisplay()=0</div></div>
  555. <div class="ttc" id="astructWidget_1_1SpecialEvent_html_aabddc200eb8494dccac663b83248b14b"><div class="ttname"><a href="structWidget_1_1SpecialEvent.html#aabddc200eb8494dccac663b83248b14b">Widget::SpecialEvent::SpecialEvent</a></div><div class="ttdeci">SpecialEvent() noexcept</div><div class="ttdef"><b>Definition:</b> Widget.hpp:122</div></div>
  556. <div class="ttc" id="astructWidget_1_1MotionEvent_html_a0d2bf8f5c66002bb129968f10e0cc082"><div class="ttname"><a href="structWidget_1_1MotionEvent.html#a0d2bf8f5c66002bb129968f10e0cc082">Widget::MotionEvent::MotionEvent</a></div><div class="ttdeci">MotionEvent() noexcept</div><div class="ttdef"><b>Definition:</b> Widget.hpp:192</div></div>
  557. <div class="ttc" id="aclassWidget_html_a714cf798aadb4d615f6f60a355382c02"><div class="ttname"><a href="classWidget.html#a714cf798aadb4d615f6f60a355382c02">Widget::~Widget</a></div><div class="ttdeci">virtual ~Widget()</div></div>
  558. <div class="ttc" id="aclassWidget_html_a607b153f7d3187ca60bf21004efc1314"><div class="ttname"><a href="classWidget.html#a607b153f7d3187ca60bf21004efc1314">Widget::getTopLevelWidget</a></div><div class="ttdeci">TopLevelWidget * getTopLevelWidget() const noexcept</div></div>
  559. <div class="ttc" id="astructWidget_1_1BaseEvent_html_a18c1114caca474cadefd9a13e2d9c693"><div class="ttname"><a href="structWidget_1_1BaseEvent.html#a18c1114caca474cadefd9a13e2d9c693">Widget::BaseEvent::BaseEvent</a></div><div class="ttdeci">BaseEvent() noexcept</div><div class="ttdef"><b>Definition:</b> Widget.hpp:70</div></div>
  560. <div class="ttc" id="aclassWidget_html_a3ee6b2824e3f3719c1c9b3d070385f49"><div class="ttname"><a href="classWidget.html#a3ee6b2824e3f3719c1c9b3d070385f49">Widget::getId</a></div><div class="ttdeci">uint getId() const noexcept</div></div>
  561. <div class="ttc" id="aclassWidget_html_aa20f6dc096a8836706173f31324c4db8"><div class="ttname"><a href="classWidget.html#aa20f6dc096a8836706173f31324c4db8">Widget::getHeight</a></div><div class="ttdeci">uint getHeight() const noexcept</div></div>
  562. <div class="ttc" id="aclassWidget_html_ab4d9e0156e455db3ff23730f82544daa"><div class="ttname"><a href="classWidget.html#ab4d9e0156e455db3ff23730f82544daa">Widget::setSize</a></div><div class="ttdeci">void setSize(uint width, uint height) noexcept</div></div>
  563. <div class="ttc" id="aclassTopLevelWidget_html"><div class="ttname"><a href="classTopLevelWidget.html">TopLevelWidget</a></div><div class="ttdef"><b>Definition:</b> TopLevelWidget.hpp:46</div></div>
  564. <div class="ttc" id="astructWidget_1_1BaseEvent_html_a58da172316b49f6d79b879b74ce5792a"><div class="ttname"><a href="structWidget_1_1BaseEvent.html#a58da172316b49f6d79b879b74ce5792a">Widget::BaseEvent::~BaseEvent</a></div><div class="ttdeci">virtual ~BaseEvent() noexcept</div><div class="ttdef"><b>Definition:</b> Widget.hpp:72</div></div>
  565. <div class="ttc" id="astructWidget_1_1MouseEvent_html_aa37fee8a593c62c53e4ca5c67ad9278f"><div class="ttname"><a href="structWidget_1_1MouseEvent.html#aa37fee8a593c62c53e4ca5c67ad9278f">Widget::MouseEvent::MouseEvent</a></div><div class="ttdeci">MouseEvent() noexcept</div><div class="ttdef"><b>Definition:</b> Widget.hpp:172</div></div>
  566. <div class="ttc" id="astructWidget_1_1SpecialEvent_html"><div class="ttname"><a href="structWidget_1_1SpecialEvent.html">Widget::SpecialEvent</a></div><div class="ttdef"><b>Definition:</b> Widget.hpp:117</div></div>
  567. <div class="ttc" id="aclassWidget_html"><div class="ttname"><a href="classWidget.html">Widget</a></div><div class="ttdef"><b>Definition:</b> Widget.hpp:53</div></div>
  568. <div class="ttc" id="aclassWidget_html_ae23d09ec0e5f0397a3451b603b407182"><div class="ttname"><a href="classWidget.html#ae23d09ec0e5f0397a3451b603b407182">Widget::getGraphicsContext</a></div><div class="ttdeci">const GraphicsContext &amp; getGraphicsContext() const noexcept</div></div>
  569. <!-- start footer part -->
  570. <hr class="footer"/><address class="footer"><small>
  571. Generated on Mon Jun 14 2021 12:26:11 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">
  572. <img class="footer" src="doxygen.png" alt="doxygen"/>
  573. </a> 1.8.17
  574. </small></address>
  575. </body>
  576. </html>