DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF
1
0
Fork 0
Code Releases 0 Activity
DISTRHO Plugin Framework
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
417 Commits
7 Branches
91MB
Branch: gh-pages
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'gh-pages'
${ noResults }
DPF/classExternalWindow.html

1019 lines
49KB
Raw Permalink Blame History 

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

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

  3. <head>

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

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

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

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

  8. <title>DISTRHO Plugin Framework: ExternalWindow Class Reference</title>

  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>

  10. <script type="text/javascript" src="jquery.js"></script>

  11. <script type="text/javascript" src="dynsections.js"></script>

  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>

  13. <script type="text/javascript" src="search/searchdata.js"></script>

  14. <script type="text/javascript" src="search/search.js"></script>

  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />

  16. </head>

  17. <body>

  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

  19. <div id="titlearea">

  20. <table cellspacing="0" cellpadding="0">

  21.  <tbody>

  22.  <tr style="height: 56px;">

  23.   <td id="projectalign" style="padding-left: 0.5em;">

  24.    <div id="projectname">DISTRHO Plugin Framework

  25.    </div>

  26.   </td>

  27.  </tr>

  28.  </tbody>

  29. </table>

  30. </div>

  31. <!-- end header part -->

  32. <!-- Generated by Doxygen 1.9.1 -->

  33. <script type="text/javascript">

  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  35. var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');

  36. /* @license-end */

  37. </script>

  38. <script type="text/javascript" src="menudata.js"></script>

  39. <script type="text/javascript" src="menu.js"></script>

  40. <script type="text/javascript">

  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  42. $(function() {

  43.   initMenu('',true,false,'search.php','Search');

  44.   $(document).ready(function() { init_search(); });

  45. });

  46. /* @license-end */</script>

  47. <div id="main-nav"></div>

  48. <!-- window showing the filter options -->

  49. <div id="MSearchSelectWindow"

  50.      onmouseover="return searchBox.OnSearchSelectShow()"

  51.      onmouseout="return searchBox.OnSearchSelectHide()"

  52.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  53. </div>

  54. 

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

  56. <div id="MSearchResultsWindow">

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

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

  59. </iframe>

  60. </div>

  61. 

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

  63. <div class="header">

  64.   <div class="summary">

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

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

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

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

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

  70.   <div class="headertitle">

  71. <div class="title">ExternalWindow Class Reference</div>  </div>

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

  73. <div class="contents">

  74. 

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

  76. <table class="memberdecls">

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

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

  79. <tr class="memitem:afc5ed08d95e01734cdfbd6c69d8505c6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#afc5ed08d95e01734cdfbd6c69d8505c6">ExternalWindow</a> ()</td></tr>

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

  81. <tr class="memitem:a4db15a0baa5e85c04b4a8c3545958aad"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#a4db15a0baa5e85c04b4a8c3545958aad">ExternalWindow</a> (const PrivateData &amp;data)</td></tr>

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

  83. <tr class="memitem:a97f21d30b4449fc5cd87396ff051c199"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#a97f21d30b4449fc5cd87396ff051c199">~ExternalWindow</a> ()</td></tr>

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

  85. <tr class="memitem:ae5763405ca1d2405973e691e78d9b2a7"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#ae5763405ca1d2405973e691e78d9b2a7">isRunning</a> () const</td></tr>

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

  87. <tr class="memitem:a7aacd265be6cd6901405ad32cf6758a0"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#a7aacd265be6cd6901405ad32cf6758a0">isQuitting</a> () const</td></tr>

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

  89. <tr class="memitem:a8ec7abf1b22271458926530b377f2c27"><td class="memItemLeft" align="right" valign="top">virtual uintptr_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#a8ec7abf1b22271458926530b377f2c27">getNativeWindowHandle</a> () const noexcept</td></tr>

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

  91. <tr class="memitem:a6957b4f82aa3e3557c4c455bbc6b1e15"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#a6957b4f82aa3e3557c4c455bbc6b1e15">focus</a> ()</td></tr>

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

  93. <tr class="memitem:a26dd0bc32a816c014731a78658cc3a5b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#a26dd0bc32a816c014731a78658cc3a5b">isEmbed</a> () const noexcept</td></tr>

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

  95. <tr class="memitem:a2e76b734d72a0766d7ddbf62d3e9f2b5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#a2e76b734d72a0766d7ddbf62d3e9f2b5">isVisible</a> () const noexcept</td></tr>

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

  97. <tr class="memitem:a5a870bd4d4e4cdbee7eb029384c2f1bf"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#a5a870bd4d4e4cdbee7eb029384c2f1bf">isStandalone</a> () const noexcept</td></tr>

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

  99. <tr class="memitem:a0e15df4f8b3425b67ad56b42526bb5df"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#a0e15df4f8b3425b67ad56b42526bb5df">getWidth</a> () const noexcept</td></tr>

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

  101. <tr class="memitem:a6206ef403f95462ef84fe8127b65b1b7"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#a6206ef403f95462ef84fe8127b65b1b7">getHeight</a> () const noexcept</td></tr>

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

  103. <tr class="memitem:a0383b6696469e9709e1a1ee53399d9f4"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#a0383b6696469e9709e1a1ee53399d9f4">getScaleFactor</a> () const noexcept</td></tr>

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

  105. <tr class="memitem:acd0c7cbaa50aab700bebe633309f6778"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#acd0c7cbaa50aab700bebe633309f6778">getTitle</a> () const noexcept</td></tr>

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

  107. <tr class="memitem:a56da59b2722bd7b0a6c63f9f7f120839"><td class="memItemLeft" align="right" valign="top">uintptr_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#a56da59b2722bd7b0a6c63f9f7f120839">getParentWindowHandle</a> () const noexcept</td></tr>

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

  109. <tr class="memitem:ad06f0e6adb6a1460af88707cd452e767"><td class="memItemLeft" align="right" valign="top">uintptr_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#ad06f0e6adb6a1460af88707cd452e767">getTransientWindowId</a> () const noexcept</td></tr>

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

  111. <tr class="memitem:aa9bce2cc83c1a8c6ee87f79bf36e3955"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#aa9bce2cc83c1a8c6ee87f79bf36e3955">hide</a> ()</td></tr>

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

  113. <tr class="memitem:acaa09de3c6dfccecf725a8f7a486ce15"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#acaa09de3c6dfccecf725a8f7a486ce15">close</a> ()</td></tr>

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

  115. <tr class="memitem:a4bebffffd78f13122dc74e4d85c0b527"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#a4bebffffd78f13122dc74e4d85c0b527">setWidth</a> (uint width)</td></tr>

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

  117. <tr class="memitem:add192e95a0fa7187cb0a8e739095674f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#add192e95a0fa7187cb0a8e739095674f">setHeight</a> (uint height)</td></tr>

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

  119. <tr class="memitem:a54bb8e6674ef42e0ebc67576df3d103a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#a54bb8e6674ef42e0ebc67576df3d103a">setSize</a> (uint width, uint height)</td></tr>

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

  121. <tr class="memitem:a8a196d0db3f082f6861d1d1bfc1db993"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#a8a196d0db3f082f6861d1d1bfc1db993">setTitle</a> (const char *title)</td></tr>

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

  123. <tr class="memitem:a15b677215c3abb5c1f7f71c4a00fd41c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#a15b677215c3abb5c1f7f71c4a00fd41c">setGeometryConstraints</a> (uint minimumWidth, uint minimumHeight, bool keepAspectRatio=false)</td></tr>

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

  125. <tr class="memitem:a35f711faffa1195c478689f4654dcc4f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#a35f711faffa1195c478689f4654dcc4f">show</a> ()</td></tr>

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

  127. <tr class="memitem:a2b599fc96437e666a7a0a4c1b9844b15"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#a2b599fc96437e666a7a0a4c1b9844b15">setVisible</a> (bool visible)</td></tr>

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

  129. <tr class="memitem:afe5b255affc787ad34b25a30114f9b89"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#afe5b255affc787ad34b25a30114f9b89">setTransientWindowId</a> (uintptr_t winId)</td></tr>

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

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

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

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

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

  135. bool&#160;</td><td class="memItemRight" valign="bottom"><b>startExternalProcess</b> (const char *args[])</td></tr>

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

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

  138. void&#160;</td><td class="memItemRight" valign="bottom"><b>terminateAndWaitForExternalProcess</b> ()</td></tr>

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

  140. <tr class="memitem:aba350e1f737b68e51bfe8018bded6e45"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#aba350e1f737b68e51bfe8018bded6e45">sizeChanged</a> (uint, uint)</td></tr>

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

  142. <tr class="memitem:afd42fab01a270aab541b161237b7d9f3"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#afd42fab01a270aab541b161237b7d9f3">titleChanged</a> (const char *)</td></tr>

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

  144. <tr class="memitem:a60ddf70411d05cef91f4a1eaa09554b8"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#a60ddf70411d05cef91f4a1eaa09554b8">visibilityChanged</a> (bool)</td></tr>

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

  146. <tr class="memitem:a4ea76a2c6240c95ff941bc95841c73c8"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalWindow.html#a4ea76a2c6240c95ff941bc95841c73c8">transientParentWindowChanged</a> (uintptr_t)</td></tr>

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

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

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

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

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

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

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

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

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

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

  157. </table>

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

  159. <div class="textblock"><p>External <a class="el" href="classWindow.html">Window</a> class.</p>

  160. <p>This is a standalone TopLevelWidget/Window-compatible class, but without any real event handling. Being compatible with TopLevelWidget/Window, it allows to be used as DPF <a class="el" href="classUI.html">UI</a> target.</p>

  161. <p>It can be used to embed non-DPF things or to run a tool in a new process as the "UI". The uiIdle() function will be called at regular intervals to keep <a class="el" href="classUI.html">UI</a> running. There are helper methods in place to launch external tools and keep track of its running state.</p>

  162. <p>External windows can be setup to run in 3 different modes: Embed: Embed into the host <a class="el" href="classUI.html">UI</a>, even-loop driven by the host. This is basically working as a regular plugin <a class="el" href="classUI.html">UI</a>, as you typically expect them to. The plugin side does not get control over showing, hiding or closing the window (as usual for plugins). No restrictions on supported plugin format, everything should work. Requires DISTRHO_PLUGIN_HAS_EMBED_UI to be set to 1.</p>

  163. <p>Semi-external: The <a class="el" href="classUI.html">UI</a> is not embed into the host, but the even-loop is still driven by it. In this mode the host does not have control over the <a class="el" href="classUI.html">UI</a> except for showing, hiding and setting transient parent. It is possible to close the window from the plugin, the host will be notified of such case. Host regularly calls <a class="el" href="classExternalWindow.html#a7aacd265be6cd6901405ad32cf6758a0">isQuitting()</a> to check if the <a class="el" href="classUI.html">UI</a> got closed by the user or plugin side. This mode is only possible in LV2 plugin formats, using lv2ui:showInterface extension.</p>

  164. <p>Standalone: The <a class="el" href="classUI.html">UI</a> is not embed into the host or uses its event-loop, basically running as standalone. The host only has control over showing and hiding the window, nothing else. The <a class="el" href="classUI.html">UI</a> is still free to close itself at any point. DPF will keep calling <a class="el" href="classExternalWindow.html#ae5763405ca1d2405973e691e78d9b2a7">isRunning()</a> to check if it should keep the event-loop running. Only possible in JACK and DSSI targets, as the UIs are literally standalone applications there.</p>

  165. <p>Please note that for non-embed windows, you cannot show the window yourself. The plugin window is only allowed to hide or close itself, a "show" action needs to come from the host.</p>

  166. <p>A few callbacks are provided so that implementations do not need to care about checking for state changes. They are not called on construction, but will be everytime something changes either by the host or the window itself. </p>

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

  168. <a id="afc5ed08d95e01734cdfbd6c69d8505c6"></a>

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

  170. 

  171. <div class="memitem">

  172. <div class="memproto">

  173. <table class="mlabels">

  174.   <tr>

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

  176.       <table class="memname">

  177.         <tr>

  178.           <td class="memname">ExternalWindow::ExternalWindow </td>

  179.           <td>(</td>

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

  181.           <td></td>

  182.         </tr>

  183.       </table>

  184.   </td>

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

  186. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>

  187.   </tr>

  188. </table>

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

  190. <p>Constructor. </p>

  191. 

  192. </div>

  193. </div>

  194. <a id="a4db15a0baa5e85c04b4a8c3545958aad"></a>

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

  196. 

  197. <div class="memitem">

  198. <div class="memproto">

  199. <table class="mlabels">

  200.   <tr>

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

  202.       <table class="memname">

  203.         <tr>

  204.           <td class="memname">ExternalWindow::ExternalWindow </td>

  205.           <td>(</td>

  206.           <td class="paramtype">const PrivateData &amp;&#160;</td>

  207.           <td class="paramname"><em>data</em></td><td>)</td>

  208.           <td></td>

  209.         </tr>

  210.       </table>

  211.   </td>

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

  213. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>

  214.   </tr>

  215. </table>

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

  217. <p>Constructor for DPF internal use. </p>

  218. 

  219. </div>

  220. </div>

  221. <a id="a97f21d30b4449fc5cd87396ff051c199"></a>

  222. <h2 class="memtitle"><span class="permalink"><a href="#a97f21d30b4449fc5cd87396ff051c199">&#9670;&nbsp;</a></span>~ExternalWindow()</h2>

  223. 

  224. <div class="memitem">

  225. <div class="memproto">

  226. <table class="mlabels">

  227.   <tr>

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

  229.       <table class="memname">

  230.         <tr>

  231.           <td class="memname">virtual ExternalWindow::~ExternalWindow </td>

  232.           <td>(</td>

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

  234.           <td></td>

  235.         </tr>

  236.       </table>

  237.   </td>

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

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

  240.   </tr>

  241. </table>

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

  243. <p>Destructor. </p>

  244. 

  245. </div>

  246. </div>

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

  248. <a id="ae5763405ca1d2405973e691e78d9b2a7"></a>

  249. <h2 class="memtitle"><span class="permalink"><a href="#ae5763405ca1d2405973e691e78d9b2a7">&#9670;&nbsp;</a></span>isRunning()</h2>

  250. 

  251. <div class="memitem">

  252. <div class="memproto">

  253. <table class="mlabels">

  254.   <tr>

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

  256.       <table class="memname">

  257.         <tr>

  258.           <td class="memname">virtual bool ExternalWindow::isRunning </td>

  259.           <td>(</td>

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

  261.           <td> const</td>

  262.         </tr>

  263.       </table>

  264.   </td>

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

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

  267.   </tr>

  268. </table>

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

  270. <p>Check if main-loop is running. This is used under standalone mode to check whether to keep things running. Returning false from this function will stop the event-loop and close the window. </p>

  271. 

  272. </div>

  273. </div>

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

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

  276. 

  277. <div class="memitem">

  278. <div class="memproto">

  279. <table class="mlabels">

  280.   <tr>

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

  282.       <table class="memname">

  283.         <tr>

  284.           <td class="memname">virtual bool ExternalWindow::isQuitting </td>

  285.           <td>(</td>

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

  287.           <td> const</td>

  288.         </tr>

  289.       </table>

  290.   </td>

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

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

  293.   </tr>

  294. </table>

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

  296. <p>Check if we are about to close. This is used when the event-loop is provided by the host to check if it should close the window. It is also used in standalone mode right after <a class="el" href="classExternalWindow.html#ae5763405ca1d2405973e691e78d9b2a7">isRunning()</a> returns false to verify if window needs to be closed. </p>

  297. 

  298. </div>

  299. </div>

  300. <a id="a8ec7abf1b22271458926530b377f2c27"></a>

  301. <h2 class="memtitle"><span class="permalink"><a href="#a8ec7abf1b22271458926530b377f2c27">&#9670;&nbsp;</a></span>getNativeWindowHandle()</h2>

  302. 

  303. <div class="memitem">

  304. <div class="memproto">

  305. <table class="mlabels">

  306.   <tr>

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

  308.       <table class="memname">

  309.         <tr>

  310.           <td class="memname">virtual uintptr_t ExternalWindow::getNativeWindowHandle </td>

  311.           <td>(</td>

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

  313.           <td> const</td>

  314.         </tr>

  315.       </table>

  316.   </td>

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

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

  319.   </tr>

  320. </table>

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

  322. <p>Get the "native" window handle. This can be reimplemented in order to pass the native window to hosts that can use such informaton.</p>

  323. <p>Returned value type depends on the platform:</p><ul>

  324. <li>HaikuOS: This is a pointer to a <code>BView</code>.</li>

  325. <li>MacOS: This is a pointer to an <code>NSView*</code>.</li>

  326. <li>Windows: This is a <code>HWND</code>.</li>

  327. <li>Everything else: This is an [X11] <code><a class="el" href="classWindow.html">Window</a></code>.</li>

  328. </ul>

  329. <dl class="section note"><dt>Note</dt><dd>Only available to override if DISTRHO_PLUGIN_HAS_EMBED_UI is set to 1. </dd></dl>

  330. 

  331. </div>

  332. </div>

  333. <a id="a6957b4f82aa3e3557c4c455bbc6b1e15"></a>

  334. <h2 class="memtitle"><span class="permalink"><a href="#a6957b4f82aa3e3557c4c455bbc6b1e15">&#9670;&nbsp;</a></span>focus()</h2>

  335. 

  336. <div class="memitem">

  337. <div class="memproto">

  338. <table class="mlabels">

  339.   <tr>

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

  341.       <table class="memname">

  342.         <tr>

  343.           <td class="memname">virtual void ExternalWindow::focus </td>

  344.           <td>(</td>

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

  346.           <td></td>

  347.         </tr>

  348.       </table>

  349.   </td>

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

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

  352.   </tr>

  353. </table>

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

  355. <p>Grab the keyboard input focus. Typically you would setup OS-native methods to bring the window to front and give it focus. Default implementation does nothing. </p>

  356. 

  357. </div>

  358. </div>

  359. <a id="a26dd0bc32a816c014731a78658cc3a5b"></a>

  360. <h2 class="memtitle"><span class="permalink"><a href="#a26dd0bc32a816c014731a78658cc3a5b">&#9670;&nbsp;</a></span>isEmbed()</h2>

  361. 

  362. <div class="memitem">

  363. <div class="memproto">

  364. <table class="mlabels">

  365.   <tr>

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

  367.       <table class="memname">

  368.         <tr>

  369.           <td class="memname">bool ExternalWindow::isEmbed </td>

  370.           <td>(</td>

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

  372.           <td> const</td>

  373.         </tr>

  374.       </table>

  375.   </td>

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

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

  378.   </tr>

  379. </table>

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

  381. <p>Whether this <a class="el" href="classWindow.html">Window</a> is embed into another (usually not DGL-controlled) <a class="el" href="classWindow.html">Window</a>. </p>

  382. 

  383. </div>

  384. </div>

  385. <a id="a2e76b734d72a0766d7ddbf62d3e9f2b5"></a>

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

  387. 

  388. <div class="memitem">

  389. <div class="memproto">

  390. <table class="mlabels">

  391.   <tr>

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

  393.       <table class="memname">

  394.         <tr>

  395.           <td class="memname">bool ExternalWindow::isVisible </td>

  396.           <td>(</td>

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

  398.           <td> const</td>

  399.         </tr>

  400.       </table>

  401.   </td>

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

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

  404.   </tr>

  405. </table>

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

  407. <p>Check if this window is visible. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classExternalWindow.html#a2b599fc96437e666a7a0a4c1b9844b15">setVisible(bool)</a> </dd></dl>

  408. 

  409. </div>

  410. </div>

  411. <a id="a5a870bd4d4e4cdbee7eb029384c2f1bf"></a>

  412. <h2 class="memtitle"><span class="permalink"><a href="#a5a870bd4d4e4cdbee7eb029384c2f1bf">&#9670;&nbsp;</a></span>isStandalone()</h2>

  413. 

  414. <div class="memitem">

  415. <div class="memproto">

  416. <table class="mlabels">

  417.   <tr>

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

  419.       <table class="memname">

  420.         <tr>

  421.           <td class="memname">bool ExternalWindow::isStandalone </td>

  422.           <td>(</td>

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

  424.           <td> const</td>

  425.         </tr>

  426.       </table>

  427.   </td>

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

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

  430.   </tr>

  431. </table>

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

  433. <p>Whether this <a class="el" href="classWindow.html">Window</a> is running as standalone, that is, without being coupled to a host event-loop. When in standalone mode, <a class="el" href="classExternalWindow.html#ae5763405ca1d2405973e691e78d9b2a7">isRunning()</a> is called to check if the event-loop should keep running. </p>

  434. 

  435. </div>

  436. </div>

  437. <a id="a0e15df4f8b3425b67ad56b42526bb5df"></a>

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

  439. 

  440. <div class="memitem">

  441. <div class="memproto">

  442. <table class="mlabels">

  443.   <tr>

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

  445.       <table class="memname">

  446.         <tr>

  447.           <td class="memname">uint ExternalWindow::getWidth </td>

  448.           <td>(</td>

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

  450.           <td> const</td>

  451.         </tr>

  452.       </table>

  453.   </td>

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

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

  456.   </tr>

  457. </table>

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

  459. <p>Get width of this window. Only relevant to hosts when the <a class="el" href="classUI.html">UI</a> is embedded. </p>

  460. 

  461. </div>

  462. </div>

  463. <a id="a6206ef403f95462ef84fe8127b65b1b7"></a>

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

  465. 

  466. <div class="memitem">

  467. <div class="memproto">

  468. <table class="mlabels">

  469.   <tr>

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

  471.       <table class="memname">

  472.         <tr>

  473.           <td class="memname">uint ExternalWindow::getHeight </td>

  474.           <td>(</td>

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

  476.           <td> const</td>

  477.         </tr>

  478.       </table>

  479.   </td>

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

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

  482.   </tr>

  483. </table>

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

  485. <p>Get height of this window. Only relevant to hosts when the <a class="el" href="classUI.html">UI</a> is embedded. </p>

  486. 

  487. </div>

  488. </div>

  489. <a id="a0383b6696469e9709e1a1ee53399d9f4"></a>

  490. <h2 class="memtitle"><span class="permalink"><a href="#a0383b6696469e9709e1a1ee53399d9f4">&#9670;&nbsp;</a></span>getScaleFactor()</h2>

  491. 

  492. <div class="memitem">

  493. <div class="memproto">

  494. <table class="mlabels">

  495.   <tr>

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

  497.       <table class="memname">

  498.         <tr>

  499.           <td class="memname">double ExternalWindow::getScaleFactor </td>

  500.           <td>(</td>

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

  502.           <td> const</td>

  503.         </tr>

  504.       </table>

  505.   </td>

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

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

  508.   </tr>

  509. </table>

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

  511. <p>Get the scale factor requested for this window. This is purely informational, and up to developers to choose what to do with it. </p>

  512. 

  513. </div>

  514. </div>

  515. <a id="acd0c7cbaa50aab700bebe633309f6778"></a>

  516. <h2 class="memtitle"><span class="permalink"><a href="#acd0c7cbaa50aab700bebe633309f6778">&#9670;&nbsp;</a></span>getTitle()</h2>

  517. 

  518. <div class="memitem">

  519. <div class="memproto">

  520. <table class="mlabels">

  521.   <tr>

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

  523.       <table class="memname">

  524.         <tr>

  525.           <td class="memname">const char* ExternalWindow::getTitle </td>

  526.           <td>(</td>

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

  528.           <td> const</td>

  529.         </tr>

  530.       </table>

  531.   </td>

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

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

  534.   </tr>

  535. </table>

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

  537. <p>Get the title of the window previously set with <a class="el" href="classExternalWindow.html#a8a196d0db3f082f6861d1d1bfc1db993">setTitle()</a>. This is typically displayed in the title bar or in window switchers. </p>

  538. 

  539. </div>

  540. </div>

  541. <a id="a56da59b2722bd7b0a6c63f9f7f120839"></a>

  542. <h2 class="memtitle"><span class="permalink"><a href="#a56da59b2722bd7b0a6c63f9f7f120839">&#9670;&nbsp;</a></span>getParentWindowHandle()</h2>

  543. 

  544. <div class="memitem">

  545. <div class="memproto">

  546. <table class="mlabels">

  547.   <tr>

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

  549.       <table class="memname">

  550.         <tr>

  551.           <td class="memname">uintptr_t ExternalWindow::getParentWindowHandle </td>

  552.           <td>(</td>

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

  554.           <td> const</td>

  555.         </tr>

  556.       </table>

  557.   </td>

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

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

  560.   </tr>

  561. </table>

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

  563. <p>Get the "native" window handle that this window should embed itself into. Returned value type depends on the platform:</p><ul>

  564. <li>HaikuOS: This is a pointer to a <code>BView</code>.</li>

  565. <li>MacOS: This is a pointer to an <code>NSView*</code>.</li>

  566. <li>Windows: This is a <code>HWND</code>.</li>

  567. <li>Everything else: This is an [X11] <code><a class="el" href="classWindow.html">Window</a></code>. </li>

  568. </ul>

  569. 

  570. </div>

  571. </div>

  572. <a id="ad06f0e6adb6a1460af88707cd452e767"></a>

  573. <h2 class="memtitle"><span class="permalink"><a href="#ad06f0e6adb6a1460af88707cd452e767">&#9670;&nbsp;</a></span>getTransientWindowId()</h2>

  574. 

  575. <div class="memitem">

  576. <div class="memproto">

  577. <table class="mlabels">

  578.   <tr>

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

  580.       <table class="memname">

  581.         <tr>

  582.           <td class="memname">uintptr_t ExternalWindow::getTransientWindowId </td>

  583.           <td>(</td>

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

  585.           <td> const</td>

  586.         </tr>

  587.       </table>

  588.   </td>

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

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

  591.   </tr>

  592. </table>

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

  594. <p>Get the transient window that we should attach ourselves to. TODO what id? also NSView* on macOS, or NSWindow? </p>

  595. 

  596. </div>

  597. </div>

  598. <a id="aa9bce2cc83c1a8c6ee87f79bf36e3955"></a>

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

  600. 

  601. <div class="memitem">

  602. <div class="memproto">

  603. <table class="mlabels">

  604.   <tr>

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

  606.       <table class="memname">

  607.         <tr>

  608.           <td class="memname">void ExternalWindow::hide </td>

  609.           <td>(</td>

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

  611.           <td></td>

  612.         </tr>

  613.       </table>

  614.   </td>

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

  616. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  617.   </tr>

  618. </table>

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

  620. <p>Hide window. This is the same as calling setVisible(false). Embed windows should never call this! </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classExternalWindow.html#a2e76b734d72a0766d7ddbf62d3e9f2b5">isVisible()</a>, <a class="el" href="classExternalWindow.html#a2b599fc96437e666a7a0a4c1b9844b15">setVisible(bool)</a> </dd></dl>

  621. 

  622. </div>

  623. </div>

  624. <a id="acaa09de3c6dfccecf725a8f7a486ce15"></a>

  625. <h2 class="memtitle"><span class="permalink"><a href="#acaa09de3c6dfccecf725a8f7a486ce15">&#9670;&nbsp;</a></span>close()</h2>

  626. 

  627. <div class="memitem">

  628. <div class="memproto">

  629. <table class="mlabels">

  630.   <tr>

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

  632.       <table class="memname">

  633.         <tr>

  634.           <td class="memname">virtual void ExternalWindow::close </td>

  635.           <td>(</td>

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

  637.           <td></td>

  638.         </tr>

  639.       </table>

  640.   </td>

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

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

  643.   </tr>

  644. </table>

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

  646. <p>Hide the <a class="el" href="classUI.html">UI</a> and gracefully terminate. Embed windows should never call this! </p>

  647. 

  648. </div>

  649. </div>

  650. <a id="a4bebffffd78f13122dc74e4d85c0b527"></a>

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

  652. 

  653. <div class="memitem">

  654. <div class="memproto">

  655. <table class="mlabels">

  656.   <tr>

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

  658.       <table class="memname">

  659.         <tr>

  660.           <td class="memname">void ExternalWindow::setWidth </td>

  661.           <td>(</td>

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

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

  664.           <td></td>

  665.         </tr>

  666.       </table>

  667.   </td>

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

  669. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  670.   </tr>

  671. </table>

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

  673. <p>Set width of this window. Can trigger a sizeChanged callback. Only relevant to hosts when the <a class="el" href="classUI.html">UI</a> is embedded. </p>

  674. 

  675. </div>

  676. </div>

  677. <a id="add192e95a0fa7187cb0a8e739095674f"></a>

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

  679. 

  680. <div class="memitem">

  681. <div class="memproto">

  682. <table class="mlabels">

  683.   <tr>

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

  685.       <table class="memname">

  686.         <tr>

  687.           <td class="memname">void ExternalWindow::setHeight </td>

  688.           <td>(</td>

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

  690.           <td class="paramname"><em>height</em></td><td>)</td>

  691.           <td></td>

  692.         </tr>

  693.       </table>

  694.   </td>

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

  696. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  697.   </tr>

  698. </table>

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

  700. <p>Set height of this window. Can trigger a sizeChanged callback. Only relevant to hosts when the <a class="el" href="classUI.html">UI</a> is embedded. </p>

  701. 

  702. </div>

  703. </div>

  704. <a id="a54bb8e6674ef42e0ebc67576df3d103a"></a>

  705. <h2 class="memtitle"><span class="permalink"><a href="#a54bb8e6674ef42e0ebc67576df3d103a">&#9670;&nbsp;</a></span>setSize()</h2>

  706. 

  707. <div class="memitem">

  708. <div class="memproto">

  709. <table class="mlabels">

  710.   <tr>

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

  712.       <table class="memname">

  713.         <tr>

  714.           <td class="memname">void ExternalWindow::setSize </td>

  715.           <td>(</td>

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

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

  718.         </tr>

  719.         <tr>

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

  721.           <td></td>

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

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

  724.         </tr>

  725.         <tr>

  726.           <td></td>

  727.           <td>)</td>

  728.           <td></td><td></td>

  729.         </tr>

  730.       </table>

  731.   </td>

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

  733. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  734.   </tr>

  735. </table>

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

  737. <p>Set size of this window using <em>width</em> and <em>height</em> values. Can trigger a sizeChanged callback. Only relevant to hosts when the <a class="el" href="classUI.html">UI</a> is embedded. </p>

  738. 

  739. </div>

  740. </div>

  741. <a id="a8a196d0db3f082f6861d1d1bfc1db993"></a>

  742. <h2 class="memtitle"><span class="permalink"><a href="#a8a196d0db3f082f6861d1d1bfc1db993">&#9670;&nbsp;</a></span>setTitle()</h2>

  743. 

  744. <div class="memitem">

  745. <div class="memproto">

  746. <table class="mlabels">

  747.   <tr>

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

  749.       <table class="memname">

  750.         <tr>

  751.           <td class="memname">void ExternalWindow::setTitle </td>

  752.           <td>(</td>

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

  754.           <td class="paramname"><em>title</em></td><td>)</td>

  755.           <td></td>

  756.         </tr>

  757.       </table>

  758.   </td>

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

  760. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  761.   </tr>

  762. </table>

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

  764. <p>Set the title of the window, typically displayed in the title bar or in window switchers. Can trigger a titleChanged callback. Only relevant to hosts when the <a class="el" href="classUI.html">UI</a> is not embedded. </p>

  765. 

  766. </div>

  767. </div>

  768. <a id="a15b677215c3abb5c1f7f71c4a00fd41c"></a>

  769. <h2 class="memtitle"><span class="permalink"><a href="#a15b677215c3abb5c1f7f71c4a00fd41c">&#9670;&nbsp;</a></span>setGeometryConstraints()</h2>

  770. 

  771. <div class="memitem">

  772. <div class="memproto">

  773. <table class="mlabels">

  774.   <tr>

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

  776.       <table class="memname">

  777.         <tr>

  778.           <td class="memname">void ExternalWindow::setGeometryConstraints </td>

  779.           <td>(</td>

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

  781.           <td class="paramname"><em>minimumWidth</em>, </td>

  782.         </tr>

  783.         <tr>

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

  785.           <td></td>

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

  787.           <td class="paramname"><em>minimumHeight</em>, </td>

  788.         </tr>

  789.         <tr>

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

  791.           <td></td>

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

  793.           <td class="paramname"><em>keepAspectRatio</em> = <code>false</code>&#160;</td>

  794.         </tr>

  795.         <tr>

  796.           <td></td>

  797.           <td>)</td>

  798.           <td></td><td></td>

  799.         </tr>

  800.       </table>

  801.   </td>

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

  803. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  804.   </tr>

  805. </table>

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

  807. <p>Set geometry constraints for the <a class="el" href="classWindow.html">Window</a> when resized by the user. </p>

  808. 

  809. </div>

  810. </div>

  811. <a id="a35f711faffa1195c478689f4654dcc4f"></a>

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

  813. 

  814. <div class="memitem">

  815. <div class="memproto">

  816. <table class="mlabels">

  817.   <tr>

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

  819.       <table class="memname">

  820.         <tr>

  821.           <td class="memname">void ExternalWindow::show </td>

  822.           <td>(</td>

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

  824.           <td></td>

  825.         </tr>

  826.       </table>

  827.   </td>

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

  829. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  830.   </tr>

  831. </table>

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

  833. <p>Show window. This is the same as calling setVisible(true). </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classExternalWindow.html#a2e76b734d72a0766d7ddbf62d3e9f2b5">isVisible()</a>, <a class="el" href="classExternalWindow.html#a2b599fc96437e666a7a0a4c1b9844b15">setVisible(bool)</a> </dd></dl>

  834. 

  835. </div>

  836. </div>

  837. <a id="a2b599fc96437e666a7a0a4c1b9844b15"></a>

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

  839. 

  840. <div class="memitem">

  841. <div class="memproto">

  842. <table class="mlabels">

  843.   <tr>

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

  845.       <table class="memname">

  846.         <tr>

  847.           <td class="memname">void ExternalWindow::setVisible </td>

  848.           <td>(</td>

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

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

  851.           <td></td>

  852.         </tr>

  853.       </table>

  854.   </td>

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

  856. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  857.   </tr>

  858. </table>

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

  860. <p>Set window visible (or not) according to <em>visible</em>. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classExternalWindow.html#a2e76b734d72a0766d7ddbf62d3e9f2b5">isVisible()</a>, <a class="el" href="classExternalWindow.html#aa9bce2cc83c1a8c6ee87f79bf36e3955">hide()</a>, <a class="el" href="classExternalWindow.html#a35f711faffa1195c478689f4654dcc4f">show()</a> </dd></dl>

  861. 

  862. </div>

  863. </div>

  864. <a id="afe5b255affc787ad34b25a30114f9b89"></a>

  865. <h2 class="memtitle"><span class="permalink"><a href="#afe5b255affc787ad34b25a30114f9b89">&#9670;&nbsp;</a></span>setTransientWindowId()</h2>

  866. 

  867. <div class="memitem">

  868. <div class="memproto">

  869. <table class="mlabels">

  870.   <tr>

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

  872.       <table class="memname">

  873.         <tr>

  874.           <td class="memname">void ExternalWindow::setTransientWindowId </td>

  875.           <td>(</td>

  876.           <td class="paramtype">uintptr_t&#160;</td>

  877.           <td class="paramname"><em>winId</em></td><td>)</td>

  878.           <td></td>

  879.         </tr>

  880.       </table>

  881.   </td>

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

  883. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  884.   </tr>

  885. </table>

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

  887. <p>Called by the host to set the transient parent window that we should attach ourselves to. TODO what id? also NSView* on macOS, or NSWindow? </p>

  888. 

  889. </div>

  890. </div>

  891. <a id="aba350e1f737b68e51bfe8018bded6e45"></a>

  892. <h2 class="memtitle"><span class="permalink"><a href="#aba350e1f737b68e51bfe8018bded6e45">&#9670;&nbsp;</a></span>sizeChanged()</h2>

  893. 

  894. <div class="memitem">

  895. <div class="memproto">

  896. <table class="mlabels">

  897.   <tr>

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

  899.       <table class="memname">

  900.         <tr>

  901.           <td class="memname">virtual void ExternalWindow::sizeChanged </td>

  902.           <td>(</td>

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

  904.           <td class="paramname">, </td>

  905.         </tr>

  906.         <tr>

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

  908.           <td></td>

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

  910.           <td class="paramname">&#160;</td>

  911.         </tr>

  912.         <tr>

  913.           <td></td>

  914.           <td>)</td>

  915.           <td></td><td></td>

  916.         </tr>

  917.       </table>

  918.   </td>

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

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

  921.   </tr>

  922. </table>

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

  924. <p>A callback for when the window size changes. </p><dl class="section note"><dt>Note</dt><dd>WIP this might need to get fed back into the host somehow. </dd></dl>

  925. 

  926. </div>

  927. </div>

  928. <a id="afd42fab01a270aab541b161237b7d9f3"></a>

  929. <h2 class="memtitle"><span class="permalink"><a href="#afd42fab01a270aab541b161237b7d9f3">&#9670;&nbsp;</a></span>titleChanged()</h2>

  930. 

  931. <div class="memitem">

  932. <div class="memproto">

  933. <table class="mlabels">

  934.   <tr>

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

  936.       <table class="memname">

  937.         <tr>

  938.           <td class="memname">virtual void ExternalWindow::titleChanged </td>

  939.           <td>(</td>

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

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

  942.           <td></td>

  943.         </tr>

  944.       </table>

  945.   </td>

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

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

  948.   </tr>

  949. </table>

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

  951. <p>A callback for when the window title changes. </p><dl class="section note"><dt>Note</dt><dd>WIP this might need to get fed back into the host somehow. </dd></dl>

  952. 

  953. </div>

  954. </div>

  955. <a id="a60ddf70411d05cef91f4a1eaa09554b8"></a>

  956. <h2 class="memtitle"><span class="permalink"><a href="#a60ddf70411d05cef91f4a1eaa09554b8">&#9670;&nbsp;</a></span>visibilityChanged()</h2>

  957. 

  958. <div class="memitem">

  959. <div class="memproto">

  960. <table class="mlabels">

  961.   <tr>

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

  963.       <table class="memname">

  964.         <tr>

  965.           <td class="memname">virtual void ExternalWindow::visibilityChanged </td>

  966.           <td>(</td>

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

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

  969.           <td></td>

  970.         </tr>

  971.       </table>

  972.   </td>

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

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

  975.   </tr>

  976. </table>

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

  978. <p>A callback for when the window visibility changes. </p><dl class="section note"><dt>Note</dt><dd>WIP this might need to get fed back into the host somehow. </dd></dl>

  979. 

  980. </div>

  981. </div>

  982. <a id="a4ea76a2c6240c95ff941bc95841c73c8"></a>

  983. <h2 class="memtitle"><span class="permalink"><a href="#a4ea76a2c6240c95ff941bc95841c73c8">&#9670;&nbsp;</a></span>transientParentWindowChanged()</h2>

  984. 

  985. <div class="memitem">

  986. <div class="memproto">

  987. <table class="mlabels">

  988.   <tr>

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

  990.       <table class="memname">

  991.         <tr>

  992.           <td class="memname">virtual void ExternalWindow::transientParentWindowChanged </td>

  993.           <td>(</td>

  994.           <td class="paramtype">uintptr_t&#160;</td>

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

  996.           <td></td>

  997.         </tr>

  998.       </table>

  999.   </td>

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

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

  1002.   </tr>

  1003. </table>

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

  1005. <p>A callback for when the transient parent window changes. </p>

  1006. 

  1007. </div>

  1008. </div>

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

  1010. <li>distrho/extra/<a class="el" href="ExternalWindow_8hpp_source.html">ExternalWindow.hpp</a></li>

  1011. </ul>

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

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

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

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

  1016. </small></address>

  1017. </body>

  1018. </html>