DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF


			
				
					
						
						
							
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>DISTRHO Plugin Framework: Application Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">DISTRHO Plugin Framework
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classApplication-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Application Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="Application_8hpp_source.html">Application.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<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 isStandalone=true)</td></tr>
<tr class="separator:af9dd089d30cf442f8ffda646305089bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a20573928a0d53fb96d929513bc5acde6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:ac8382754f04f4de15768981459a28e3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a866d2145b9aa35bb7f88b1b9fd0aa9cc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApplication.html#a866d2145b9aa35bb7f88b1b9fd0aa9cc">exec</a> (uint idleTimeInMs=10)</td></tr>
<tr class="separator:a866d2145b9aa35bb7f88b1b9fd0aa9cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:af77b716ee803aecb2ce1674695dc3986"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e5fe58c9cdc488a34d61cf95b55fdc7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApplication.html#a7e5fe58c9cdc488a34d61cf95b55fdc7">isQuiting</a> () const noexcept</td></tr>
<tr class="separator:a7e5fe58c9cdc488a34d61cf95b55fdc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:ad6aab76a79b7b3c2883785040b46017a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a082f532e2922924c6c72517f9272f67d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a553f958a25683445088050a69d3de8e9"><td class="memItemLeft" align="right" valign="top"><a id="a553f958a25683445088050a69d3de8e9"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>Window</b></td></tr>
<tr class="separator:a553f958a25683445088050a69d3de8e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base DGL <a class="el" href="classApplication.html">Application</a> class.</p>
<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>
<p>In standalone mode an application will automatically quit its event-loop when all its windows are closed. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af9dd089d30cf442f8ffda646305089bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9dd089d30cf442f8ffda646305089bb">&#9670;&nbsp;</a></span>Application()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Application::Application </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>isStandalone</em> = <code>true</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Constructor. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual Application::~Application </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac8382754f04f4de15768981459a28e3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8382754f04f4de15768981459a28e3a">&#9670;&nbsp;</a></span>idle()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Application::idle </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Idle function. This runs the application event-loop once. </p>

</div>
</div>
<a id="a866d2145b9aa35bb7f88b1b9fd0aa9cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a866d2145b9aa35bb7f88b1b9fd0aa9cc">&#9670;&nbsp;</a></span>exec()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Application::exec </td>
          <td>(</td>
          <td class="paramtype">uint&#160;</td>
          <td class="paramname"><em>idleTimeInMs</em> = <code>10</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<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>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Application::quit </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Quit the application. This stops the event-loop and closes all Windows. </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>

</div>
</div>
<a id="a7e5fe58c9cdc488a34d61cf95b55fdc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e5fe58c9cdc488a34d61cf95b55fdc7">&#9670;&nbsp;</a></span>isQuiting()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool Application::isQuiting </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<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). </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Application::addIdleCallback </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structIdleCallback.html">IdleCallback</a> *&#160;</td>
          <td class="paramname"><em>callback</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<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. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Application::removeIdleCallback </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structIdleCallback.html">IdleCallback</a> *&#160;</td>
          <td class="paramname"><em>callback</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Remove an idle callback previously added via <a class="el" href="classApplication.html#ad6aab76a79b7b3c2883785040b46017a">addIdleCallback()</a>. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>dgl/<a class="el" href="Application_8hpp_source.html">Application.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue May 18 2021 11:21:11 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>