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/classApplication.html

385 lines
19KB
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: Application 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="#pub-methods">Public Member Functions</a> &#124;

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

  67. <a href="classApplication-members.html">List of all members</a>  </div>

  68.   <div class="headertitle">

  69. <div class="title">Application Class Reference</div>  </div>

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

  71. <div class="contents">

  72. 

  73. <p><code>#include &lt;<a class="el" href="Application_8hpp_source.html">Application.hpp</a>&gt;</code></p>

  74. <table class="memberdecls">

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

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

  77. <tr class="memitem:af9dd089d30cf442f8ffda646305089bb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApplication.html#af9dd089d30cf442f8ffda646305089bb">Application</a> (bool <a class="el" href="classApplication.html#aa0728e9c72545d81ba403b44c92ecd50">isStandalone</a>=true)</td></tr>

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

  79. <tr class="memitem:a20573928a0d53fb96d929513bc5acde6"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApplication.html#a20573928a0d53fb96d929513bc5acde6">~Application</a> ()</td></tr>

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

  81. <tr class="memitem:ac8382754f04f4de15768981459a28e3a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApplication.html#ac8382754f04f4de15768981459a28e3a">idle</a> ()</td></tr>

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

  83. <tr class="memitem:a805dd37af3b9adfc1d0ee1e734ad81e3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApplication.html#a805dd37af3b9adfc1d0ee1e734ad81e3">exec</a> (uint idleTimeInMs=30)</td></tr>

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

  85. <tr class="memitem:af77b716ee803aecb2ce1674695dc3986"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApplication.html#af77b716ee803aecb2ce1674695dc3986">quit</a> ()</td></tr>

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

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

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

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

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

  91. <tr class="memitem:a2f6f8250f31dbb600bdef12692d62b73"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApplication.html#a2f6f8250f31dbb600bdef12692d62b73">getTime</a> () const</td></tr>

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

  93. <tr class="memitem:ad6aab76a79b7b3c2883785040b46017a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApplication.html#ad6aab76a79b7b3c2883785040b46017a">addIdleCallback</a> (<a class="el" href="structIdleCallback.html">IdleCallback</a> *callback)</td></tr>

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

  95. <tr class="memitem:a082f532e2922924c6c72517f9272f67d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApplication.html#a082f532e2922924c6c72517f9272f67d">removeIdleCallback</a> (<a class="el" href="structIdleCallback.html">IdleCallback</a> *callback)</td></tr>

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

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

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

  99. <tr class="memitem:a203d22d1ce0c0de90c2379f6bc839815"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApplication.html#a203d22d1ce0c0de90c2379f6bc839815">setClassName</a> (const char *name)</td></tr>

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

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

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

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

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

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

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

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

  108. class&#160;</td><td class="memItemRight" valign="bottom"><b>DISTRHO_NAMESPACE::PluginApplication</b></td></tr>

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

  110. </table>

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

  112. <div class="textblock"><p>Base DGL <a class="el" href="classApplication.html">Application</a> class.</p>

  113. <p>One application instance is required for creating a window. There's no single/global application instance in DGL, and multiple windows can share the same app instance.</p>

  114. <p>In standalone mode an application will automatically quit its event-loop when all its windows are closed.</p>

  115. <p>Unless stated otherwise, functions within this class are not thread-safe. </p>

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

  117. <a id="af9dd089d30cf442f8ffda646305089bb"></a>

  118. <h2 class="memtitle"><span class="permalink"><a href="#af9dd089d30cf442f8ffda646305089bb">&#9670;&nbsp;</a></span>Application()</h2>

  119. 

  120. <div class="memitem">

  121. <div class="memproto">

  122.       <table class="memname">

  123.         <tr>

  124.           <td class="memname">Application::Application </td>

  125.           <td>(</td>

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

  127.           <td class="paramname"><em>isStandalone</em> = <code>true</code></td><td>)</td>

  128.           <td></td>

  129.         </tr>

  130.       </table>

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

  132. <p>Constructor. </p>

  133. 

  134. </div>

  135. </div>

  136. <a id="a20573928a0d53fb96d929513bc5acde6"></a>

  137. <h2 class="memtitle"><span class="permalink"><a href="#a20573928a0d53fb96d929513bc5acde6">&#9670;&nbsp;</a></span>~Application()</h2>

  138. 

  139. <div class="memitem">

  140. <div class="memproto">

  141. <table class="mlabels">

  142.   <tr>

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

  144.       <table class="memname">

  145.         <tr>

  146.           <td class="memname">virtual Application::~Application </td>

  147.           <td>(</td>

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

  149.           <td></td>

  150.         </tr>

  151.       </table>

  152.   </td>

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

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

  155.   </tr>

  156. </table>

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

  158. <p>Destructor. </p>

  159. 

  160. </div>

  161. </div>

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

  163. <a id="ac8382754f04f4de15768981459a28e3a"></a>

  164. <h2 class="memtitle"><span class="permalink"><a href="#ac8382754f04f4de15768981459a28e3a">&#9670;&nbsp;</a></span>idle()</h2>

  165. 

  166. <div class="memitem">

  167. <div class="memproto">

  168.       <table class="memname">

  169.         <tr>

  170.           <td class="memname">void Application::idle </td>

  171.           <td>(</td>

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

  173.           <td></td>

  174.         </tr>

  175.       </table>

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

  177. <p>Idle function. This runs the application event-loop once. </p>

  178. 

  179. </div>

  180. </div>

  181. <a id="a805dd37af3b9adfc1d0ee1e734ad81e3"></a>

  182. <h2 class="memtitle"><span class="permalink"><a href="#a805dd37af3b9adfc1d0ee1e734ad81e3">&#9670;&nbsp;</a></span>exec()</h2>

  183. 

  184. <div class="memitem">

  185. <div class="memproto">

  186.       <table class="memname">

  187.         <tr>

  188.           <td class="memname">void Application::exec </td>

  189.           <td>(</td>

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

  191.           <td class="paramname"><em>idleTimeInMs</em> = <code>30</code></td><td>)</td>

  192.           <td></td>

  193.         </tr>

  194.       </table>

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

  196. <p>Run the application event-loop until all Windows are closed. <a class="el" href="classApplication.html#ac8382754f04f4de15768981459a28e3a">idle()</a> is called at regular intervals. </p><dl class="section note"><dt>Note</dt><dd>This function is meant for standalones only, <em>never</em> call this from plugins. </dd></dl>

  197. 

  198. </div>

  199. </div>

  200. <a id="af77b716ee803aecb2ce1674695dc3986"></a>

  201. <h2 class="memtitle"><span class="permalink"><a href="#af77b716ee803aecb2ce1674695dc3986">&#9670;&nbsp;</a></span>quit()</h2>

  202. 

  203. <div class="memitem">

  204. <div class="memproto">

  205.       <table class="memname">

  206.         <tr>

  207.           <td class="memname">void Application::quit </td>

  208.           <td>(</td>

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

  210.           <td></td>

  211.         </tr>

  212.       </table>

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

  214. <p>Quit the application. This stops the event-loop and closes all Windows. This function is thread-safe. </p>

  215. 

  216. </div>

  217. </div>

  218. <a id="aa2dd05d544834e8fca24a58f5e57f795"></a>

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

  220. 

  221. <div class="memitem">

  222. <div class="memproto">

  223. <table class="mlabels">

  224.   <tr>

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

  226.       <table class="memname">

  227.         <tr>

  228.           <td class="memname">bool Application::isQuitting </td>

  229.           <td>(</td>

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

  231.           <td> const</td>

  232.         </tr>

  233.       </table>

  234.   </td>

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

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

  237.   </tr>

  238. </table>

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

  240. <p>Check if the application is about to quit. Returning true means there's no event-loop running at the moment (or it's just about to stop). This function is thread-safe. </p>

  241. 

  242. </div>

  243. </div>

  244. <a id="aa0728e9c72545d81ba403b44c92ecd50"></a>

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

  246. 

  247. <div class="memitem">

  248. <div class="memproto">

  249. <table class="mlabels">

  250.   <tr>

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

  252.       <table class="memname">

  253.         <tr>

  254.           <td class="memname">bool Application::isStandalone </td>

  255.           <td>(</td>

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

  257.           <td> const</td>

  258.         </tr>

  259.       </table>

  260.   </td>

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

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

  263.   </tr>

  264. </table>

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

  266. <p>Check if the application is standalone, otherwise running as a module or plugin. This function is thread-safe. </p>

  267. 

  268. </div>

  269. </div>

  270. <a id="a2f6f8250f31dbb600bdef12692d62b73"></a>

  271. <h2 class="memtitle"><span class="permalink"><a href="#a2f6f8250f31dbb600bdef12692d62b73">&#9670;&nbsp;</a></span>getTime()</h2>

  272. 

  273. <div class="memitem">

  274. <div class="memproto">

  275.       <table class="memname">

  276.         <tr>

  277.           <td class="memname">double Application::getTime </td>

  278.           <td>(</td>

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

  280.           <td> const</td>

  281.         </tr>

  282.       </table>

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

  284. <p>Return the time in seconds.</p>

  285. <p>This is a monotonically increasing clock with high resolution.<br  />

  286. The returned time is only useful to compare against other times returned by this function, its absolute value has no meaning. </p>

  287. 

  288. </div>

  289. </div>

  290. <a id="ad6aab76a79b7b3c2883785040b46017a"></a>

  291. <h2 class="memtitle"><span class="permalink"><a href="#ad6aab76a79b7b3c2883785040b46017a">&#9670;&nbsp;</a></span>addIdleCallback()</h2>

  292. 

  293. <div class="memitem">

  294. <div class="memproto">

  295.       <table class="memname">

  296.         <tr>

  297.           <td class="memname">void Application::addIdleCallback </td>

  298.           <td>(</td>

  299.           <td class="paramtype"><a class="el" href="structIdleCallback.html">IdleCallback</a> *&#160;</td>

  300.           <td class="paramname"><em>callback</em></td><td>)</td>

  301.           <td></td>

  302.         </tr>

  303.       </table>

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

  305. <p>Add a callback function to be triggered on every idle cycle. You can add more than one, and remove them at anytime with <a class="el" href="classApplication.html#a082f532e2922924c6c72517f9272f67d">removeIdleCallback()</a>. Idle callbacks trigger right after OS event handling and <a class="el" href="classWindow.html">Window</a> idle events (within the same cycle). There are no guarantees in terms of timing, use <a class="el" href="classWindow.html#ad17a7f53a62673982f4861cdc27fd54e">Window::addIdleCallback</a> for time-relative callbacks. </p>

  306. 

  307. </div>

  308. </div>

  309. <a id="a082f532e2922924c6c72517f9272f67d"></a>

  310. <h2 class="memtitle"><span class="permalink"><a href="#a082f532e2922924c6c72517f9272f67d">&#9670;&nbsp;</a></span>removeIdleCallback()</h2>

  311. 

  312. <div class="memitem">

  313. <div class="memproto">

  314.       <table class="memname">

  315.         <tr>

  316.           <td class="memname">void Application::removeIdleCallback </td>

  317.           <td>(</td>

  318.           <td class="paramtype"><a class="el" href="structIdleCallback.html">IdleCallback</a> *&#160;</td>

  319.           <td class="paramname"><em>callback</em></td><td>)</td>

  320.           <td></td>

  321.         </tr>

  322.       </table>

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

  324. <p>Remove an idle callback previously added via <a class="el" href="classApplication.html#ad6aab76a79b7b3c2883785040b46017a">addIdleCallback()</a>. </p>

  325. 

  326. </div>

  327. </div>

  328. <a id="a4eb331050ea4835aea5ad06cad1265fb"></a>

  329. <h2 class="memtitle"><span class="permalink"><a href="#a4eb331050ea4835aea5ad06cad1265fb">&#9670;&nbsp;</a></span>getClassName()</h2>

  330. 

  331. <div class="memitem">

  332. <div class="memproto">

  333. <table class="mlabels">

  334.   <tr>

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

  336.       <table class="memname">

  337.         <tr>

  338.           <td class="memname">const char* Application::getClassName </td>

  339.           <td>(</td>

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

  341.           <td> const</td>

  342.         </tr>

  343.       </table>

  344.   </td>

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

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

  347.   </tr>

  348. </table>

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

  350. <p>Get the class name of the application.</p>

  351. <p>This is a stable identifier for the application, used as the window class/instance name on X11 and Windows. It is not displayed to the user, but can be used in scripts and by window managers, so it should be the same for every instance of the application, but different from other applications.</p>

  352. <p>Plugins created with DPF have their class name automatically set based on DGL_NAMESPACE and plugin name. </p>

  353. 

  354. </div>

  355. </div>

  356. <a id="a203d22d1ce0c0de90c2379f6bc839815"></a>

  357. <h2 class="memtitle"><span class="permalink"><a href="#a203d22d1ce0c0de90c2379f6bc839815">&#9670;&nbsp;</a></span>setClassName()</h2>

  358. 

  359. <div class="memitem">

  360. <div class="memproto">

  361.       <table class="memname">

  362.         <tr>

  363.           <td class="memname">void Application::setClassName </td>

  364.           <td>(</td>

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

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

  367.           <td></td>

  368.         </tr>

  369.       </table>

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

  371. <p>Set the class name of the application. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classApplication.html#a4eb331050ea4835aea5ad06cad1265fb">getClassName</a> </dd></dl>

  372. 

  373. </div>

  374. </div>

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

  376. <li>dgl/<a class="el" href="Application_8hpp_source.html">Application.hpp</a></li>

  377. </ul>

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

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

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

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

  382. </small></address>

  383. </body>

  384. </html>