-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_reaper_ext_base_8h_source.html
160 lines (158 loc) · 15.4 KB
/
_reaper_ext_base_8h_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<!-- HTML header for doxygen 1.8.14-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>iPlug 2: ReaperExtBase.h 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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="style.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: 80px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">iPlug2 - C++ Audio Plug-in Framework
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_a8a4892678035c62db3a4af7d9811050.html">IPlug</a></li><li class="navelem"><a class="el" href="dir_31a8d9627630b30cd71b58362c5c6278.html">ReaperExt</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">ReaperExtBase.h</div></div>
</div><!--header-->
<div class="contents">
<a href="_reaper_ext_base_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> ==============================================================================</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> </span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> This file is part of the iPlug 2 library. Copyright (C) the iPlug 2 developers. </span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> </span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> See LICENSE.txt for more info.</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> </span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> ==============================================================================</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">*/</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#include "<a class="code" href="_i_plug_timer_8h.html">IPlugTimer.h</a>"</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#include "<a class="code" href="_i_plug_delegate__select_8h.html">IPlugDelegate_select.h</a>"</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="keyword">struct </span>reaper_plugin_info_t;</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span>BEGIN_IPLUG_NAMESPACE</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="class_reaper_ext_base.html"> 27</a></span><span class="keyword">class </span><a class="code hl_class" href="class_reaper_ext_base.html">ReaperExtBase</a> : <span class="keyword">public</span> EDITOR_DELEGATE_CLASS</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span>{</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <a class="code hl_class" href="class_reaper_ext_base.html">ReaperExtBase</a>(reaper_plugin_info_t* pRec);</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">virtual</span> <a class="code hl_class" href="class_reaper_ext_base.html">~ReaperExtBase</a>();</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="comment">//IEditorDelegate</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordtype">void</span> BeginInformHostOfParamChangeFromUI(<span class="keywordtype">int</span> paramIdx)<span class="keyword"> override </span>{}; <span class="comment">// NO-OP</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keywordtype">void</span> EndInformHostOfParamChangeFromUI(<span class="keywordtype">int</span> paramIdx)<span class="keyword"> override </span>{}; <span class="comment">// NO-OP</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keywordtype">bool</span> EditorResizeFromUI(<span class="keywordtype">int</span> viewWidth, <span class="keywordtype">int</span> viewHeight, <span class="keywordtype">bool</span> needsPlatformResize) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="class_reaper_ext_base.html#afc2682c54bba3b9b10a32da359e8b619"> 42</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_reaper_ext_base.html#afc2682c54bba3b9b10a32da359e8b619">OnIdle</a>() {}; <span class="comment">// NO-OP</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_reaper_ext_base.html#af36768e35c40037fce7c77c0406e2484">RegisterAction</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* actionName, std::function<<span class="keywordtype">void</span>()> func, <span class="keywordtype">bool</span> addMenuItem = <span class="keyword">false</span>, <span class="keywordtype">int</span>* pToggle = <span class="keyword">nullptr</span><span class="comment">/*, IKeyPress keyCmd*/</span>);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_reaper_ext_base.html#a172d7d91c5c54e976ef1e872110ea82d">ShowHideMainWindow</a>();</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keywordtype">void</span> ToggleDocking();</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="comment">// Reaper calls back to this when it wants to execute an action registered by the extension plugin</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">static</span> <span class="keywordtype">bool</span> HookCommandProc(<span class="keywordtype">int</span> command, <span class="keywordtype">int</span> flag);</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="comment">// Reaper calls back to this when it wants to know an actions toggle state</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keyword">static</span> <span class="keywordtype">int</span> ToggleActionCallback(<span class="keywordtype">int</span> command);</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keyword">static</span> WDL_DLGRET MainDlgProc(HWND hwndDlg, UINT uMsg, WPARAM wParam, LPARAM lParam);</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="keywordtype">void</span> OnTimer(<a class="code hl_struct" href="struct_timer.html">Timer</a>& t);</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> reaper_plugin_info_t* mRec = <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> std::unique_ptr<Timer> mTimer;</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keywordtype">bool</span> mDocked = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span>};</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span>END_IPLUG_NAMESPACE</div>
<div class="ttc" id="a_i_plug_delegate__select_8h_html"><div class="ttname"><a href="_i_plug_delegate__select_8h.html">IPlugDelegate_select.h</a></div><div class="ttdoc">Used for choosing an editor delegate.</div></div>
<div class="ttc" id="a_i_plug_timer_8h_html"><div class="ttname"><a href="_i_plug_timer_8h.html">IPlugTimer.h</a></div><div class="ttdoc">This file includes classes for implementing timers - in order to get a regular callback on the main t...</div></div>
<div class="ttc" id="aclass_reaper_ext_base_html"><div class="ttname"><a href="class_reaper_ext_base.html">ReaperExtBase</a></div><div class="ttdoc">Reaper extension base class interface.</div><div class="ttdef"><b>Definition:</b> <a href="_reaper_ext_base_8h_source.html#l00027">ReaperExtBase.h:28</a></div></div>
<div class="ttc" id="aclass_reaper_ext_base_html_a172d7d91c5c54e976ef1e872110ea82d"><div class="ttname"><a href="class_reaper_ext_base.html#a172d7d91c5c54e976ef1e872110ea82d">ReaperExtBase::ShowHideMainWindow</a></div><div class="ttdeci">void ShowHideMainWindow()</div><div class="ttdef"><b>Definition:</b> <a href="_reaper_ext_base_8cpp_source.html#l00054">ReaperExtBase.cpp:54</a></div></div>
<div class="ttc" id="aclass_reaper_ext_base_html_af36768e35c40037fce7c77c0406e2484"><div class="ttname"><a href="class_reaper_ext_base.html#af36768e35c40037fce7c77c0406e2484">ReaperExtBase::RegisterAction</a></div><div class="ttdeci">void RegisterAction(const char *actionName, std::function< void()> func, bool addMenuItem=false, int *pToggle=nullptr)</div><div class="ttdef"><b>Definition:</b> <a href="_reaper_ext_base_8cpp_source.html#l00081">ReaperExtBase.cpp:81</a></div></div>
<div class="ttc" id="aclass_reaper_ext_base_html_afc2682c54bba3b9b10a32da359e8b619"><div class="ttname"><a href="class_reaper_ext_base.html#afc2682c54bba3b9b10a32da359e8b619">ReaperExtBase::OnIdle</a></div><div class="ttdeci">virtual void OnIdle()</div><div class="ttdef"><b>Definition:</b> <a href="_reaper_ext_base_8h_source.html#l00042">ReaperExtBase.h:42</a></div></div>
<div class="ttc" id="astruct_timer_html"><div class="ttname"><a href="struct_timer.html">Timer</a></div><div class="ttdoc">Base class for timer.</div><div class="ttdef"><b>Definition:</b> <a href="_i_plug_timer_8h_source.html#l00039">IPlugTimer.h:40</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
</small></address>
</body>
</html>