|
- <!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: dgl/Application.hpp Source File</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&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&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 id="nav-path" class="navpath">
- <ul>
- <li class="navelem"><a class="el" href="dir_99893ac99dd47c2a73745483a12a725f.html">dgl</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="headertitle">
- <div class="title">Application.hpp</div> </div>
- </div><!--header-->
- <div class="contents">
- <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
- <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * DISTRHO Plugin Framework (DPF)</span></div>
- <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright (C) 2012-2021 Filipe Coelho <falktx@falktx.com></span></div>
- <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
- <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Permission to use, copy, modify, and/or distribute this software for any purpose with</span></div>
- <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * or without fee is hereby granted, provided that the above copyright notice and this</span></div>
- <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * permission notice appear in all copies.</span></div>
- <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div>
- <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD</span></div>
- <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN</span></div>
- <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL</span></div>
- <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER</span></div>
- <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN</span></div>
- <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
- <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
- <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef DGL_APP_HPP_INCLUDED</span></div>
- <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define DGL_APP_HPP_INCLUDED</span></div>
- <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
- <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "Base.hpp"</span></div>
- <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
- <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> START_NAMESPACE_DGL</div>
- <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
- <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>
- <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">/**</span></div>
- <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> Base DGL Application class.</span></div>
- <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> One application instance is required for creating a window.</span></div>
- <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> There's no single/global application instance in DGL, and multiple windows can share the same app instance.</span></div>
- <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> In standalone mode an application will automatically quit its event-loop when all its windows are closed.</span></div>
- <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classApplication.html"> 34</a></span> <span class="keyword">class </span><a class="code" href="classApplication.html">Application</a></div>
- <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> {</div>
- <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">public</span>:<span class="comment"></span></div>
- <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> /**</span></div>
- <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> Constructor.</span></div>
- <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="comment">// NOTE: the default value is not yet passed, so we catch where we use this</span></div>
- <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="classApplication.html#af9dd089d30cf442f8ffda646305089bb">Application</a>(<span class="keywordtype">bool</span> isStandalone = <span class="keyword">true</span>);</div>
- <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> /**</span></div>
- <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> Destructor.</span></div>
- <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">virtual</span> <a class="code" href="classApplication.html#a20573928a0d53fb96d929513bc5acde6">~Application</a>();</div>
- <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> /**</span></div>
- <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> Idle function.</span></div>
- <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> This runs the application event-loop once.</span></div>
- <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">void</span> <a class="code" href="classApplication.html#ac8382754f04f4de15768981459a28e3a">idle</a>();</div>
- <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> /**</span></div>
- <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> Run the application event-loop until all Windows are closed.</span></div>
- <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> idle() is called at regular intervals.</span></div>
- <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> @note This function is meant for standalones only, *never* call this from plugins.</span></div>
- <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">void</span> <a class="code" href="classApplication.html#a805dd37af3b9adfc1d0ee1e734ad81e3">exec</a>(uint idleTimeInMs = 30);</div>
- <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> /**</span></div>
- <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> Quit the application.</span></div>
- <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> This stops the event-loop and closes all Windows.</span></div>
- <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> @note This function is meant for standalones only, *never* call this from plugins.</span></div>
- <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">void</span> <a class="code" href="classApplication.html#af77b716ee803aecb2ce1674695dc3986">quit</a>();</div>
- <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> /**</span></div>
- <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> Check if the application is about to quit.</span></div>
- <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> Returning true means there's no event-loop running at the moment (or it's just about to stop).</span></div>
- <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">bool</span> <a class="code" href="classApplication.html#a7e5fe58c9cdc488a34d61cf95b55fdc7">isQuiting</a>() <span class="keyword">const</span> noexcept;</div>
- <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> /**</span></div>
- <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> Add a callback function to be triggered on every idle cycle.</span></div>
- <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> You can add more than one, and remove them at anytime with removeIdleCallback().</span></div>
- <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> Idle callbacks trigger right after OS event handling and Window idle events (within the same cycle).</span></div>
- <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> There are no guarantees in terms of timing.</span></div>
- <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">void</span> <a class="code" href="classApplication.html#ad6aab76a79b7b3c2883785040b46017a">addIdleCallback</a>(<a class="code" href="structIdleCallback.html">IdleCallback</a>* callback);</div>
- <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> /**</span></div>
- <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> Remove an idle callback previously added via addIdleCallback().</span></div>
- <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">void</span> <a class="code" href="classApplication.html#a082f532e2922924c6c72517f9272f67d">removeIdleCallback</a>(<a class="code" href="structIdleCallback.html">IdleCallback</a>* callback);</div>
- <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> /**</span></div>
- <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> Set the class name of the application.</span></div>
- <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> This is a stable identifier for the application, used as the window class/instance name on X11 and Windows.</span></div>
- <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> It is not displayed to the user, but can be used in scripts and by window managers,</span></div>
- <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> so it should be the same for every instance of the application, but different from other applications.</span></div>
- <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> Plugins created with DPF have their class name automatically set based on DGL_NAMESPACE and plugin name.</span></div>
- <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">void</span> <a class="code" href="classApplication.html#a203d22d1ce0c0de90c2379f6bc839815">setClassName</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* name);</div>
- <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  </div>
- <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">private</span>:</div>
- <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">struct </span>PrivateData;</div>
- <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  PrivateData* <span class="keyword">const</span> pData;</div>
- <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classWindow.html">Window</a>;</div>
- <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  </div>
- <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(<a class="code" href="classApplication.html">Application</a>)</div>
- <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> };</div>
- <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  </div>
- <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment">// --------------------------------------------------------------------------------------------------------------------</span></div>
- <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  </div>
- <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> END_NAMESPACE_DGL</div>
- <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  </div>
- <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="preprocessor">#endif // DGL_APP_HPP_INCLUDED</span></div>
- </div><!-- fragment --></div><!-- contents -->
- <div class="ttc" id="aclassApplication_html_af77b716ee803aecb2ce1674695dc3986"><div class="ttname"><a href="classApplication.html#af77b716ee803aecb2ce1674695dc3986">Application::quit</a></div><div class="ttdeci">void quit()</div></div>
- <div class="ttc" id="aclassApplication_html_a082f532e2922924c6c72517f9272f67d"><div class="ttname"><a href="classApplication.html#a082f532e2922924c6c72517f9272f67d">Application::removeIdleCallback</a></div><div class="ttdeci">void removeIdleCallback(IdleCallback *callback)</div></div>
- <div class="ttc" id="aclassWindow_html"><div class="ttname"><a href="classWindow.html">Window</a></div><div class="ttdef"><b>Definition:</b> Window.hpp:50</div></div>
- <div class="ttc" id="aclassApplication_html_ac8382754f04f4de15768981459a28e3a"><div class="ttname"><a href="classApplication.html#ac8382754f04f4de15768981459a28e3a">Application::idle</a></div><div class="ttdeci">void idle()</div></div>
- <div class="ttc" id="aclassApplication_html_a7e5fe58c9cdc488a34d61cf95b55fdc7"><div class="ttname"><a href="classApplication.html#a7e5fe58c9cdc488a34d61cf95b55fdc7">Application::isQuiting</a></div><div class="ttdeci">bool isQuiting() const noexcept</div></div>
- <div class="ttc" id="aclassApplication_html"><div class="ttname"><a href="classApplication.html">Application</a></div><div class="ttdef"><b>Definition:</b> Application.hpp:34</div></div>
- <div class="ttc" id="aclassApplication_html_a20573928a0d53fb96d929513bc5acde6"><div class="ttname"><a href="classApplication.html#a20573928a0d53fb96d929513bc5acde6">Application::~Application</a></div><div class="ttdeci">virtual ~Application()</div></div>
- <div class="ttc" id="aclassApplication_html_af9dd089d30cf442f8ffda646305089bb"><div class="ttname"><a href="classApplication.html#af9dd089d30cf442f8ffda646305089bb">Application::Application</a></div><div class="ttdeci">Application(bool isStandalone=true)</div></div>
- <div class="ttc" id="aclassApplication_html_a805dd37af3b9adfc1d0ee1e734ad81e3"><div class="ttname"><a href="classApplication.html#a805dd37af3b9adfc1d0ee1e734ad81e3">Application::exec</a></div><div class="ttdeci">void exec(uint idleTimeInMs=30)</div></div>
- <div class="ttc" id="aclassApplication_html_ad6aab76a79b7b3c2883785040b46017a"><div class="ttname"><a href="classApplication.html#ad6aab76a79b7b3c2883785040b46017a">Application::addIdleCallback</a></div><div class="ttdeci">void addIdleCallback(IdleCallback *callback)</div></div>
- <div class="ttc" id="astructIdleCallback_html"><div class="ttname"><a href="structIdleCallback.html">IdleCallback</a></div><div class="ttdef"><b>Definition:</b> Base.hpp:159</div></div>
- <div class="ttc" id="aclassApplication_html_a203d22d1ce0c0de90c2379f6bc839815"><div class="ttname"><a href="classApplication.html#a203d22d1ce0c0de90c2379f6bc839815">Application::setClassName</a></div><div class="ttdeci">void setClassName(const char *name)</div></div>
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Tue Jun 15 2021 12:29:15 for DISTRHO Plugin Framework by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.17
- </small></address>
- </body>
- </html>
|