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
6 Branches
58MB
Tree: 3b225396b3
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '3b225396b3'
${ noResults }
DPF/SubWidget_8hpp_source.html

291 lines
40KB
Raw 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: dgl/SubWidget.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.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 id="nav-path" class="navpath">

  63.   <ul>

  64. <li class="navelem"><a class="el" href="dir_99893ac99dd47c2a73745483a12a725f.html">dgl</a></li>  </ul>

  65. </div>

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

  67. <div class="header">

  68.   <div class="headertitle">

  69. <div class="title">SubWidget.hpp</div>  </div>

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

  71. <div class="contents">

  72. <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>

  73. <div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * DISTRHO Plugin Framework (DPF)</span></div>

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

  75. <div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div>

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

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

  78. <div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * permission notice appear in all copies.</span></div>

  79. <div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *</span></div>

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

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

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

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

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

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

  86. <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> */</span></div>

  87. <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160; </div>

  88. <div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#ifndef DGL_SUBWIDGET_HPP_INCLUDED</span></div>

  89. <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#define DGL_SUBWIDGET_HPP_INCLUDED</span></div>

  90. <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160; </div>

  91. <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &quot;Widget.hpp&quot;</span></div>

  92. <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160; </div>

  93. <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;START_NAMESPACE_DGL</div>

  94. <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160; </div>

  95. <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>

  96. <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"></span> </div>

  97. <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment">/**</span></div>

  98. <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment">   Sub-Widget class.</span></div>

  99. <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"></span> </div>

  100. <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment">   This class is the main entry point for creating any reusable widgets from within DGL.</span></div>

  101. <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment">   It can be freely positioned from within a parent widget, thus being named subwidget.</span></div>

  102. <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment"></span> </div>

  103. <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="comment">   Many subwidgets can share the same parent, and subwidgets themselves can also have its own subwidgets.</span></div>

  104. <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment">   It is subwidgets all the way down.</span></div>

  105. <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment"></span> </div>

  106. <div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment">   TODO check absolute vs relative position and see what makes more sense.</span></div>

  107. <div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="comment"></span> </div>

  108. <div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment">   @see CairoSubWidget</span></div>

  109. <div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment"> */</span></div>

  110. <div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classSubWidget.html">   39</a></span>&#160;<span class="keyword">class </span><a class="code" href="classSubWidget.html">SubWidget</a> : <span class="keyword">public</span> <a class="code" href="classWidget.html">Widget</a></div>

  111. <div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;{</div>

  112. <div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="keyword">public</span>:<span class="comment"></span></div>

  113. <div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment">   /**</span></div>

  114. <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="comment">      Constructor.</span></div>

  115. <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="comment">    */</span></div>

  116. <div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classSubWidget.html#a9fda448971613b2758fd9570c3065f7a">   45</a></span>&#160;    <span class="keyword">explicit</span> <a class="code" href="classSubWidget.html#a9fda448971613b2758fd9570c3065f7a">SubWidget</a>(<a class="code" href="classWidget.html">Widget</a>* parentWidget);</div>

  117. <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment"></span> </div>

  118. <div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment">   /**</span></div>

  119. <div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment">      Destructor.</span></div>

  120. <div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="comment">    */</span></div>

  121. <div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classSubWidget.html#a7ac8a2d6086eceb5af7b7fa5a157e2bc">   50</a></span>&#160;    <a class="code" href="classSubWidget.html#a7ac8a2d6086eceb5af7b7fa5a157e2bc">~SubWidget</a>() <span class="keyword">override</span>;</div>

  122. <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="comment"></span> </div>

  123. <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="comment">   /**</span></div>

  124. <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="comment">      Check if this widget contains the point defined by @a x and @a y.</span></div>

  125. <div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="comment">    */</span></div>

  126. <div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    <span class="comment">// TODO rename as containsRelativePos</span></div>

  127. <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;    <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div>

  128. <div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classSubWidget.html#ac9b4d3e2a3a39e588504dd33c1d9ca95">   57</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classSubWidget.html#ac9b4d3e2a3a39e588504dd33c1d9ca95">contains</a>(T x, T y) <span class="keyword">const</span> noexcept;</div>

  129. <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="comment"></span> </div>

  130. <div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="comment">   /**</span></div>

  131. <div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="comment">      Check if this widget contains the point @a pos.</span></div>

  132. <div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment">    */</span></div>

  133. <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    <span class="comment">// TODO rename as containsRelativePos</span></div>

  134. <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;    <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div>

  135. <div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classSubWidget.html#ac5b584dfb15c98b67c03a2d9699651b7">   64</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classSubWidget.html#ac5b584dfb15c98b67c03a2d9699651b7">contains</a>(<span class="keyword">const</span> <a class="code" href="classPoint.html">Point&lt;T&gt;</a>&amp; pos) <span class="keyword">const</span> noexcept;</div>

  136. <div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="comment"></span> </div>

  137. <div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="comment">   /**</span></div>

  138. <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="comment">      Get absolute X.</span></div>

  139. <div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;<span class="comment">    */</span></div>

  140. <div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="classSubWidget.html#a5a641f035fa0ce5b5e87ee9b3ab7bf34">   69</a></span>&#160;    <span class="keywordtype">int</span> <a class="code" href="classSubWidget.html#a5a641f035fa0ce5b5e87ee9b3ab7bf34">getAbsoluteX</a>() const noexcept;</div>

  141. <div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="comment"></span> </div>

  142. <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="comment">   /**</span></div>

  143. <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="comment">      Get absolute Y.</span></div>

  144. <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="comment">    */</span></div>

  145. <div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="classSubWidget.html#aefe10cc8f9d62950b56f71559d1e3f5e">   74</a></span>&#160;    <span class="keywordtype">int</span> <a class="code" href="classSubWidget.html#aefe10cc8f9d62950b56f71559d1e3f5e">getAbsoluteY</a>() const noexcept;</div>

  146. <div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="comment"></span> </div>

  147. <div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="comment">   /**</span></div>

  148. <div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="comment">      Get absolute position.</span></div>

  149. <div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="comment">    */</span></div>

  150. <div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="classSubWidget.html#a1c67b16fb0234941f387a960a0f0cb76">   79</a></span>&#160;    <a class="code" href="classPoint.html">Point</a>&lt;<span class="keywordtype">int</span>&gt; <a class="code" href="classSubWidget.html#a1c67b16fb0234941f387a960a0f0cb76">getAbsolutePos</a>() const noexcept;</div>

  151. <div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="comment"></span> </div>

  152. <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment">   /**</span></div>

  153. <div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="comment">      Get absolute area of this subwidget.</span></div>

  154. <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="comment">      This is the same as `Rectangle&lt;int&gt;(getAbsolutePos(), getSize());`</span></div>

  155. <div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="comment">      @see getConstrainedAbsoluteArea()</span></div>

  156. <div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="comment">    */</span></div>

  157. <div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="classSubWidget.html#af2f289973c4a58d78eb6bb12bcbf093a">   86</a></span>&#160;    <a class="code" href="classRectangle.html">Rectangle</a>&lt;<span class="keywordtype">int</span>&gt; <a class="code" href="classSubWidget.html#af2f289973c4a58d78eb6bb12bcbf093a">getAbsoluteArea</a>() const noexcept;</div>

  158. <div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="comment"></span> </div>

  159. <div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="comment">   /**</span></div>

  160. <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="comment">      Get absolute area of this subwidget, with special consideration for not allowing negative values.</span></div>

  161. <div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="comment">      @see getAbsoluteArea()</span></div>

  162. <div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="comment">    */</span></div>

  163. <div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="classSubWidget.html#a72bf08fe6f61fc935f6f0836d308bc9e">   92</a></span>&#160;    <a class="code" href="classRectangle.html">Rectangle</a>&lt;uint&gt; <a class="code" href="classSubWidget.html#a72bf08fe6f61fc935f6f0836d308bc9e">getConstrainedAbsoluteArea</a>() const noexcept;</div>

  164. <div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;<span class="comment"></span> </div>

  165. <div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;<span class="comment">   /**</span></div>

  166. <div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;<span class="comment">      Set absolute X.</span></div>

  167. <div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="comment">    */</span></div>

  168. <div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="classSubWidget.html#abcd0a00a4c3cdc402aea56044df26cc3">   97</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classSubWidget.html#abcd0a00a4c3cdc402aea56044df26cc3">setAbsoluteX</a>(<span class="keywordtype">int</span> x) noexcept;</div>

  169. <div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<span class="comment"></span> </div>

  170. <div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;<span class="comment">   /**</span></div>

  171. <div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="comment">      Set absolute Y.</span></div>

  172. <div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;<span class="comment">    */</span></div>

  173. <div class="line"><a name="l00102"></a><span class="lineno"><a class="line" href="classSubWidget.html#a3c674e3c46206ac29a562c0f02dcf82c">  102</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classSubWidget.html#a3c674e3c46206ac29a562c0f02dcf82c">setAbsoluteY</a>(<span class="keywordtype">int</span> y) noexcept;</div>

  174. <div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;<span class="comment"></span> </div>

  175. <div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<span class="comment">   /**</span></div>

  176. <div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="comment">      Set absolute position using @a x and @a y values.</span></div>

  177. <div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;<span class="comment">    */</span></div>

  178. <div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="classSubWidget.html#a0e7a4dd27eee8a3a1b7bf12d9f21769f">  107</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classSubWidget.html#a0e7a4dd27eee8a3a1b7bf12d9f21769f">setAbsolutePos</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y) noexcept;</div>

  179. <div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;<span class="comment"></span> </div>

  180. <div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;<span class="comment">   /**</span></div>

  181. <div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;<span class="comment">      Set absolute position.</span></div>

  182. <div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;<span class="comment">    */</span></div>

  183. <div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="classSubWidget.html#a05c5e533e9b10186d0f72ae94f72196d">  112</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classSubWidget.html#a0e7a4dd27eee8a3a1b7bf12d9f21769f">setAbsolutePos</a>(const <a class="code" href="classPoint.html">Point</a>&lt;<span class="keywordtype">int</span>&gt;&amp; pos) noexcept;</div>

  184. <div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;<span class="comment"></span> </div>

  185. <div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="comment">   /**</span></div>

  186. <div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;<span class="comment">      Get the margin currently in use for widget coordinates.</span></div>

  187. <div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<span class="comment">      By default this value is (0,0).</span></div>

  188. <div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;<span class="comment">    */</span></div>

  189. <div class="line"><a name="l00118"></a><span class="lineno"><a class="line" href="classSubWidget.html#abe42b4ff151599ca5ea72f2e26e93860">  118</a></span>&#160;    <a class="code" href="classPoint.html">Point</a>&lt;<span class="keywordtype">int</span>&gt; <a class="code" href="classSubWidget.html#abe42b4ff151599ca5ea72f2e26e93860">getMargin</a>() const noexcept;</div>

  190. <div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;<span class="comment"></span> </div>

  191. <div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;<span class="comment">   /**</span></div>

  192. <div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;<span class="comment">      Set a margin to be used for widget coordinates using @a x and @a y values.</span></div>

  193. <div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<span class="comment">    */</span></div>

  194. <div class="line"><a name="l00123"></a><span class="lineno"><a class="line" href="classSubWidget.html#a9594d89a623dd7e63cbdb8139e9e4a38">  123</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classSubWidget.html#a9594d89a623dd7e63cbdb8139e9e4a38">setMargin</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y) noexcept;</div>

  195. <div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="comment"></span> </div>

  196. <div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;<span class="comment">   /**</span></div>

  197. <div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;<span class="comment">      Set a margin to be used for widget coordinates.</span></div>

  198. <div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;<span class="comment">    */</span></div>

  199. <div class="line"><a name="l00128"></a><span class="lineno"><a class="line" href="classSubWidget.html#a77f510ea6d0864d296b02b085cc05f2b">  128</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classSubWidget.html#a9594d89a623dd7e63cbdb8139e9e4a38">setMargin</a>(const <a class="code" href="classPoint.html">Point</a>&lt;<span class="keywordtype">int</span>&gt;&amp; offset) noexcept;</div>

  200. <div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;<span class="comment"></span> </div>

  201. <div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="comment">   /**</span></div>

  202. <div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;<span class="comment">      Get parent Widget, as passed in the constructor.</span></div>

  203. <div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="comment">    */</span></div>

  204. <div class="line"><a name="l00133"></a><span class="lineno"><a class="line" href="classSubWidget.html#a2d658e71ccb9502b8409a08782d8b345">  133</a></span>&#160;    <a class="code" href="classWidget.html">Widget</a>* <a class="code" href="classSubWidget.html#a2d658e71ccb9502b8409a08782d8b345">getParentWidget</a>() const noexcept;</div>

  205. <div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;<span class="comment"></span> </div>

  206. <div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;<span class="comment">   /**</span></div>

  207. <div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="comment">      Request repaint of this subwidget&#39;s area to the window this widget belongs to.</span></div>

  208. <div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;<span class="comment">    */</span></div>

  209. <div class="line"><a name="l00138"></a><span class="lineno"><a class="line" href="classSubWidget.html#a13910739dc797b600502e2dfa7daef87">  138</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classSubWidget.html#a13910739dc797b600502e2dfa7daef87">repaint</a>() noexcept override;</div>

  210. <div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;<span class="comment"></span> </div>

  211. <div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;<span class="comment">   /**</span></div>

  212. <div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;<span class="comment">      Pushes this widget to the &quot;bottom&quot; of the parent widget.</span></div>

  213. <div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;<span class="comment">      Makes the widget behave as if it was the first to be registered on the parent widget, thus being &quot;on bottom&quot;.</span></div>

  214. <div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;<span class="comment">    */</span></div>

  215. <div class="line"><a name="l00144"></a><span class="lineno"><a class="line" href="classSubWidget.html#a87d35cdd41511d75fb12bc18a2d9facc">  144</a></span>&#160;    virtual <span class="keywordtype">void</span> <a class="code" href="classSubWidget.html#a87d35cdd41511d75fb12bc18a2d9facc">toBottom</a>();</div>

  216. <div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;<span class="comment"></span> </div>

  217. <div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;<span class="comment">   /**</span></div>

  218. <div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;<span class="comment">      Bring this widget to the &quot;front&quot; of the parent widget.</span></div>

  219. <div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="comment">      Makes the widget behave as if it was the last to be registered on the parent widget, thus being &quot;in front&quot;.</span></div>

  220. <div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;<span class="comment">    */</span></div>

  221. <div class="line"><a name="l00150"></a><span class="lineno"><a class="line" href="classSubWidget.html#a3426cbcf0104c8a5c9996e3efff75381">  150</a></span>&#160;    virtual <span class="keywordtype">void</span> <a class="code" href="classSubWidget.html#a3426cbcf0104c8a5c9996e3efff75381">toFront</a>();</div>

  222. <div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;<span class="comment"></span> </div>

  223. <div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;<span class="comment">   /**</span></div>

  224. <div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;<span class="comment">      Indicate that this subwidget will draw out of bounds, and thus needs the entire viewport available for drawing.</span></div>

  225. <div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;<span class="comment">    */</span></div>

  226. <div class="line"><a name="l00155"></a><span class="lineno"><a class="line" href="classSubWidget.html#a926884690b66c762f7bdb1196c58522b">  155</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classSubWidget.html#a926884690b66c762f7bdb1196c58522b">setNeedsFullViewportDrawing</a>(<span class="keywordtype">bool</span> needsFullViewportForDrawing = true);</div>

  227. <div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;<span class="comment"></span> </div>

  228. <div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;<span class="comment">   /**</span></div>

  229. <div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;<span class="comment">      Indicate that this subwidget will always draw at its own internal size and needs scaling to fit target size.</span></div>

  230. <div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;<span class="comment">    */</span></div>

  231. <div class="line"><a name="l00160"></a><span class="lineno"><a class="line" href="classSubWidget.html#a5cd703976adf24decbb66dd3dbc1db8b">  160</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classSubWidget.html#a5cd703976adf24decbb66dd3dbc1db8b">setNeedsViewportScaling</a>(<span class="keywordtype">bool</span> needsViewportScaling = true, <span class="keywordtype">double</span> autoScaleFactor = 0.0);</div>

  232. <div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;<span class="comment"></span> </div>

  233. <div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;<span class="comment">   /**</span></div>

  234. <div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;<span class="comment">      Indicate that this subwidget should not be drawn on screen, typically because it is managed by something else.</span></div>

  235. <div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;<span class="comment">    */</span></div>

  236. <div class="line"><a name="l00165"></a><span class="lineno"><a class="line" href="classSubWidget.html#adb38f61c0205d7832ddfd090f7f60f2a">  165</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classSubWidget.html#adb38f61c0205d7832ddfd090f7f60f2a">setSkipDrawing</a>(<span class="keywordtype">bool</span> skipDrawing = true);</div>

  237. <div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160; </div>

  238. <div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;protected:<span class="comment"></span></div>

  239. <div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;<span class="comment">   /**</span></div>

  240. <div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;<span class="comment">      A function called when the subwidget&#39;s absolute position is changed.</span></div>

  241. <div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;<span class="comment">    */</span></div>

  242. <div class="line"><a name="l00171"></a><span class="lineno"><a class="line" href="classSubWidget.html#a80ac88898a4a87047d63a7e49a5a0946">  171</a></span>&#160;    virtual <span class="keywordtype">void</span> <a class="code" href="classSubWidget.html#a80ac88898a4a87047d63a7e49a5a0946">onPositionChanged</a>(const <a class="code" href="structWidget_1_1PositionChangedEvent.html">PositionChangedEvent</a>&amp;);</div>

  243. <div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160; </div>

  244. <div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;private:</div>

  245. <div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;    struct PrivateData;</div>

  246. <div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;    PrivateData* const pData;</div>

  247. <div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;    friend class <a class="code" href="classWidget.html">Widget</a>;</div>

  248. <div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;    DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(<a class="code" href="classSubWidget.html">SubWidget</a>)</div>

  249. <div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;};</div>

  250. <div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160; </div>

  251. <div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;<span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>

  252. <div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160; </div>

  253. <div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;END_NAMESPACE_DGL</div>

  254. <div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160; </div>

  255. <div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// DGL_SUBWIDGET_HPP_INCLUDED</span></div>

  256. <div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160; </div>

  257. <div class="ttc" id="aclassPoint_html"><div class="ttname"><a href="classPoint.html">Point</a></div><div class="ttdef"><b>Definition:</b> Geometry.hpp:41</div></div>

  258. <div class="ttc" id="aclassRectangle_html"><div class="ttname"><a href="classRectangle.html">Rectangle</a></div><div class="ttdef"><b>Definition:</b> Geometry.hpp:614</div></div>

  259. <div class="ttc" id="aclassSubWidget_html"><div class="ttname"><a href="classSubWidget.html">SubWidget</a></div><div class="ttdef"><b>Definition:</b> SubWidget.hpp:40</div></div>

  260. <div class="ttc" id="aclassSubWidget_html_a0e7a4dd27eee8a3a1b7bf12d9f21769f"><div class="ttname"><a href="classSubWidget.html#a0e7a4dd27eee8a3a1b7bf12d9f21769f">SubWidget::setAbsolutePos</a></div><div class="ttdeci">void setAbsolutePos(int x, int y) noexcept</div></div>

  261. <div class="ttc" id="aclassSubWidget_html_a13910739dc797b600502e2dfa7daef87"><div class="ttname"><a href="classSubWidget.html#a13910739dc797b600502e2dfa7daef87">SubWidget::repaint</a></div><div class="ttdeci">void repaint() noexcept override</div></div>

  262. <div class="ttc" id="aclassSubWidget_html_a1c67b16fb0234941f387a960a0f0cb76"><div class="ttname"><a href="classSubWidget.html#a1c67b16fb0234941f387a960a0f0cb76">SubWidget::getAbsolutePos</a></div><div class="ttdeci">Point&lt; int &gt; getAbsolutePos() const noexcept</div></div>

  263. <div class="ttc" id="aclassSubWidget_html_a2d658e71ccb9502b8409a08782d8b345"><div class="ttname"><a href="classSubWidget.html#a2d658e71ccb9502b8409a08782d8b345">SubWidget::getParentWidget</a></div><div class="ttdeci">Widget * getParentWidget() const noexcept</div></div>

  264. <div class="ttc" id="aclassSubWidget_html_a3426cbcf0104c8a5c9996e3efff75381"><div class="ttname"><a href="classSubWidget.html#a3426cbcf0104c8a5c9996e3efff75381">SubWidget::toFront</a></div><div class="ttdeci">virtual void toFront()</div></div>

  265. <div class="ttc" id="aclassSubWidget_html_a3c674e3c46206ac29a562c0f02dcf82c"><div class="ttname"><a href="classSubWidget.html#a3c674e3c46206ac29a562c0f02dcf82c">SubWidget::setAbsoluteY</a></div><div class="ttdeci">void setAbsoluteY(int y) noexcept</div></div>

  266. <div class="ttc" id="aclassSubWidget_html_a5a641f035fa0ce5b5e87ee9b3ab7bf34"><div class="ttname"><a href="classSubWidget.html#a5a641f035fa0ce5b5e87ee9b3ab7bf34">SubWidget::getAbsoluteX</a></div><div class="ttdeci">int getAbsoluteX() const noexcept</div></div>

  267. <div class="ttc" id="aclassSubWidget_html_a5cd703976adf24decbb66dd3dbc1db8b"><div class="ttname"><a href="classSubWidget.html#a5cd703976adf24decbb66dd3dbc1db8b">SubWidget::setNeedsViewportScaling</a></div><div class="ttdeci">void setNeedsViewportScaling(bool needsViewportScaling=true, double autoScaleFactor=0.0)</div></div>

  268. <div class="ttc" id="aclassSubWidget_html_a72bf08fe6f61fc935f6f0836d308bc9e"><div class="ttname"><a href="classSubWidget.html#a72bf08fe6f61fc935f6f0836d308bc9e">SubWidget::getConstrainedAbsoluteArea</a></div><div class="ttdeci">Rectangle&lt; uint &gt; getConstrainedAbsoluteArea() const noexcept</div></div>

  269. <div class="ttc" id="aclassSubWidget_html_a7ac8a2d6086eceb5af7b7fa5a157e2bc"><div class="ttname"><a href="classSubWidget.html#a7ac8a2d6086eceb5af7b7fa5a157e2bc">SubWidget::~SubWidget</a></div><div class="ttdeci">~SubWidget() override</div></div>

  270. <div class="ttc" id="aclassSubWidget_html_a80ac88898a4a87047d63a7e49a5a0946"><div class="ttname"><a href="classSubWidget.html#a80ac88898a4a87047d63a7e49a5a0946">SubWidget::onPositionChanged</a></div><div class="ttdeci">virtual void onPositionChanged(const PositionChangedEvent &amp;)</div></div>

  271. <div class="ttc" id="aclassSubWidget_html_a87d35cdd41511d75fb12bc18a2d9facc"><div class="ttname"><a href="classSubWidget.html#a87d35cdd41511d75fb12bc18a2d9facc">SubWidget::toBottom</a></div><div class="ttdeci">virtual void toBottom()</div></div>

  272. <div class="ttc" id="aclassSubWidget_html_a926884690b66c762f7bdb1196c58522b"><div class="ttname"><a href="classSubWidget.html#a926884690b66c762f7bdb1196c58522b">SubWidget::setNeedsFullViewportDrawing</a></div><div class="ttdeci">void setNeedsFullViewportDrawing(bool needsFullViewportForDrawing=true)</div></div>

  273. <div class="ttc" id="aclassSubWidget_html_a9594d89a623dd7e63cbdb8139e9e4a38"><div class="ttname"><a href="classSubWidget.html#a9594d89a623dd7e63cbdb8139e9e4a38">SubWidget::setMargin</a></div><div class="ttdeci">void setMargin(int x, int y) noexcept</div></div>

  274. <div class="ttc" id="aclassSubWidget_html_a9fda448971613b2758fd9570c3065f7a"><div class="ttname"><a href="classSubWidget.html#a9fda448971613b2758fd9570c3065f7a">SubWidget::SubWidget</a></div><div class="ttdeci">SubWidget(Widget *parentWidget)</div></div>

  275. <div class="ttc" id="aclassSubWidget_html_abcd0a00a4c3cdc402aea56044df26cc3"><div class="ttname"><a href="classSubWidget.html#abcd0a00a4c3cdc402aea56044df26cc3">SubWidget::setAbsoluteX</a></div><div class="ttdeci">void setAbsoluteX(int x) noexcept</div></div>

  276. <div class="ttc" id="aclassSubWidget_html_abe42b4ff151599ca5ea72f2e26e93860"><div class="ttname"><a href="classSubWidget.html#abe42b4ff151599ca5ea72f2e26e93860">SubWidget::getMargin</a></div><div class="ttdeci">Point&lt; int &gt; getMargin() const noexcept</div></div>

  277. <div class="ttc" id="aclassSubWidget_html_ac5b584dfb15c98b67c03a2d9699651b7"><div class="ttname"><a href="classSubWidget.html#ac5b584dfb15c98b67c03a2d9699651b7">SubWidget::contains</a></div><div class="ttdeci">bool contains(const Point&lt; T &gt; &amp;pos) const noexcept</div></div>

  278. <div class="ttc" id="aclassSubWidget_html_ac9b4d3e2a3a39e588504dd33c1d9ca95"><div class="ttname"><a href="classSubWidget.html#ac9b4d3e2a3a39e588504dd33c1d9ca95">SubWidget::contains</a></div><div class="ttdeci">bool contains(T x, T y) const noexcept</div></div>

  279. <div class="ttc" id="aclassSubWidget_html_adb38f61c0205d7832ddfd090f7f60f2a"><div class="ttname"><a href="classSubWidget.html#adb38f61c0205d7832ddfd090f7f60f2a">SubWidget::setSkipDrawing</a></div><div class="ttdeci">void setSkipDrawing(bool skipDrawing=true)</div></div>

  280. <div class="ttc" id="aclassSubWidget_html_aefe10cc8f9d62950b56f71559d1e3f5e"><div class="ttname"><a href="classSubWidget.html#aefe10cc8f9d62950b56f71559d1e3f5e">SubWidget::getAbsoluteY</a></div><div class="ttdeci">int getAbsoluteY() const noexcept</div></div>

  281. <div class="ttc" id="aclassSubWidget_html_af2f289973c4a58d78eb6bb12bcbf093a"><div class="ttname"><a href="classSubWidget.html#af2f289973c4a58d78eb6bb12bcbf093a">SubWidget::getAbsoluteArea</a></div><div class="ttdeci">Rectangle&lt; int &gt; getAbsoluteArea() const noexcept</div></div>

  282. <div class="ttc" id="aclassWidget_html"><div class="ttname"><a href="classWidget.html">Widget</a></div><div class="ttdef"><b>Definition:</b> Widget.hpp:56</div></div>

  283. <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:247</div></div>

  284. </div><!-- fragment --></div><!-- contents -->

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

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

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

  288. </small></address>

  289. </body>

  290. </html>