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.
400 Commits
6 Branches
58MB
Tree: 262c01eee3
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '262c01eee3'
${ noResults }
DPF/VstGuiWidget_8hpp_source.html

202 lines
19KB
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.8.17"/>

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

  8. <title>DISTRHO Plugin Framework: dgl/VstGuiWidget.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. 

  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">VstGuiWidget.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 DISTRHO_VSTGUI_TOP_LEVEL_WIDGET_HPP_INCLUDED</span></div>

  89. <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#define DISTRHO_VSTGUI_TOP_LEVEL_WIDGET_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;Base.hpp&quot;</span></div>

  92. <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &quot;../distrho/extra/String.hpp&quot;</span></div>

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

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

  95. <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160; </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">/**</span></div>

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

  100. <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"></span> </div>

  101. <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment">   This is a vstgui on top of DGL/DPF, with similar semantics as a VstGuiStandaloneWindow (Window + TopLevelWidget).</span></div>

  102. <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment">   The intention is to make it usable as a plugin UI target.</span></div>

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

  104. <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment">   Work-in-progress.</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"><a class="line" href="classVstGuiStandaloneWindow.html">   35</a></span>&#160;<span class="keyword">class </span><a class="code" href="classVstGuiStandaloneWindow.html">VstGuiStandaloneWindow</a></div>

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

  108. <div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="keyword">public</span>:<span class="comment"></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">   39</span>&#160;<span class="comment">      Constructor.</span></div>

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

  112. <div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classVstGuiStandaloneWindow.html#a42194a31b6ebd9b12fee1460bca2df79">   41</a></span>&#160;    <a class="code" href="classVstGuiStandaloneWindow.html#a42194a31b6ebd9b12fee1460bca2df79">VstGuiStandaloneWindow</a>(<span class="keyword">const</span> uint w = 1, <span class="keyword">const</span> uint h = 1, <span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keyword">const</span> t = <span class="stringliteral">&quot;&quot;</span>)</div>

  113. <div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;        : width(w),</div>

  114. <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;          height(h),</div>

  115. <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;          title(t),</div>

  116. <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;          transientWinId(0),</div>

  117. <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;          visible(false) {}</div>

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

  119. <div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;    <span class="keyword">virtual</span> ~<a class="code" href="classVstGuiStandaloneWindow.html">VstGuiStandaloneWindow</a>()</div>

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

  121. <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    }</div>

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

  123. <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;    uint getWidth() const noexcept</div>

  124. <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    {</div>

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

  126. <div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    }</div>

  127. <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160; </div>

  128. <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;    uint getHeight() const noexcept</div>

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

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

  131. <div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;    }</div>

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

  133. <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    <span class="keyword">const</span> <span class="keywordtype">char</span>* getTitle() const noexcept</div>

  134. <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;    {</div>

  135. <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;        <span class="keywordflow">return</span> title;</div>

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

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

  138. <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;    uintptr_t getTransientWinId() const noexcept</div>

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

  140. <div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;        <span class="keywordflow">return</span> transientWinId;</div>

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

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

  143. <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;    <span class="keywordtype">bool</span> isVisible() const noexcept</div>

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

  145. <div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;        <span class="keywordflow">return</span> visible;</div>

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

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

  148. <div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;    <span class="keywordtype">bool</span> isRunning() noexcept</div>

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

  150. <div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;        <span class="keywordflow">return</span> visible;</div>

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

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

  153. <div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> idle() {}</div>

  154. <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160; </div>

  155. <div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> setSize(uint w, uint h)</div>

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

  157. <div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;        width = w;</div>

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

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

  160. <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160; </div>

  161. <div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> setTitle(<span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keyword">const</span> t)</div>

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

  163. <div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;        title = t;</div>

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

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

  166. <div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> setTransientWinId(<span class="keyword">const</span> uintptr_t winId)</div>

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

  168. <div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;        transientWinId = winId;</div>

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

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

  171. <div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> setVisible(<span class="keyword">const</span> <span class="keywordtype">bool</span> yesNo)</div>

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

  173. <div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;        visible = yesNo;</div>

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

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

  176. <div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="keyword">private</span>:</div>

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

  178. <div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;    uint height;</div>

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

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

  181. <div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;    <span class="keywordtype">bool</span> visible;</div>

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

  183. <div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;    DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(<a class="code" href="classVstGuiStandaloneWindow.html">VstGuiStandaloneWindow</a>)</div>

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

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

  186. <div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;<span class="comment">// -----------------------------------------------------------------------</span></div>

  187. <div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160; </div>

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

  189. <div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160; </div>

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

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

  192. <div class="ttc" id="aclassVstGuiStandaloneWindow_html_a42194a31b6ebd9b12fee1460bca2df79"><div class="ttname"><a href="classVstGuiStandaloneWindow.html#a42194a31b6ebd9b12fee1460bca2df79">VstGuiStandaloneWindow::VstGuiStandaloneWindow</a></div><div class="ttdeci">VstGuiStandaloneWindow(const uint w=1, const uint h=1, const char *const t=&quot;&quot;)</div><div class="ttdef"><b>Definition:</b> VstGuiWidget.hpp:41</div></div>

  193. <div class="ttc" id="aclassVstGuiStandaloneWindow_html"><div class="ttname"><a href="classVstGuiStandaloneWindow.html">VstGuiStandaloneWindow</a></div><div class="ttdef"><b>Definition:</b> VstGuiWidget.hpp:35</div></div>

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

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

  196. Generated on Sat Jul 3 2021 23:07:05 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

  197. <img class="footer" src="doxygen.png" alt="doxygen"/>

  198. </a> 1.8.17

  199. </small></address>

  200. </body>

  201. </html>