-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_i_r_t_text_control_8h_source.html
170 lines (168 loc) · 18.6 KB
/
_i_r_t_text_control_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
161
162
163
164
165
166
167
168
169
170
<!-- 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: IRTTextControl.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_c70994b0d9919a11b368e677cb7f323c.html">IGraphics</a></li><li class="navelem"><a class="el" href="dir_b13fc9fb79eb1e19d3aa0747e2e621c7.html">Controls</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">IRTTextControl.h</div></div>
</div><!--header-->
<div class="contents">
<a href="_i_r_t_text_control_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_control_8h.html">IControl.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_sender_8h.html">ISender.h</a>"</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include "IPlugStructs.h"</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span>BEGIN_IPLUG_NAMESPACE</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span>BEGIN_IGRAPHICS_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"> 27</span><span class="keyword">template</span> <<span class="keywordtype">int</span> MAXNC = 1, <span class="keyword">typename</span> T = <span class="keywordtype">double</span>></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="class_i_r_t_text_control.html"> 28</a></span><span class="keyword">class </span><a class="code hl_class" href="class_i_r_t_text_control.html">IRTTextControl</a> : <span class="keyword">public</span> <a class="code hl_class" href="class_i_text_control.html">ITextControl</a></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span>{</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <a class="code hl_class" href="class_i_r_t_text_control.html">IRTTextControl</a>(<span class="keyword">const</span> <a class="code hl_struct" href="struct_i_r_e_c_t.html">IRECT</a>& bounds, <span class="keyword">const</span> <span class="keywordtype">char</span>* fmtStr = <span class="stringliteral">"%f"</span>, <span class="keyword">const</span> <span class="keywordtype">char</span>* separatorStr = <span class="stringliteral">", "</span>, <span class="keyword">const</span> <span class="keywordtype">char</span>* initStr = <span class="stringliteral">""</span>, <span class="keyword">const</span> <a class="code hl_struct" href="struct_i_text.html">IText</a>& text = DEFAULT_TEXT, <span class="keyword">const</span> <a class="code hl_struct" href="struct_i_color.html">IColor</a>& BGColor = DEFAULT_BGCOLOR)</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> : <a class="code hl_class" href="class_i_text_control.html">ITextControl</a>(bounds, initStr, text, BGColor)</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> , mFMTStr(fmtStr)</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> , mSeparatorStr(separatorStr)</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</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> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="class_i_r_t_text_control.html#ac8708487c8a9ac5b166b7c4c473c12e1"> 38</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_i_r_t_text_control.html#ac8708487c8a9ac5b166b7c4c473c12e1">OnMsgFromDelegate</a>(<span class="keywordtype">int</span> msgTag, <span class="keywordtype">int</span> dataSize, <span class="keyword">const</span> <span class="keywordtype">void</span>* pData)<span class="keyword"> override</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keywordflow">if</span> (!<a class="code hl_function" href="class_i_control.html#a498bd0f85778e3c4205b0b7158361b48">IsDisabled</a>() && msgTag == <a class="code hl_class" href="class_i_sender.html">ISender<>::kUpdateMessage</a>)</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> {</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <a class="code hl_class" href="class_i_byte_stream.html">IByteStream</a> stream(pData, dataSize);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keywordtype">int</span> pos = 0;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <a class="code hl_struct" href="struct_i_sender_data.html">ISenderData<MAXNC, T></a> d;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> pos = stream.<a class="code hl_function" href="class_i_byte_stream.html#a6a559e06ec65ba71667b37265c1061da">Get</a>(&d, pos);</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> WDL_String str;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keywordflow">for</span>(<span class="keywordtype">int</span> i=0; i<d.nChans-1; i++)</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> str.AppendFormatted(256, mFMTStr.Get(), d.vals[i]);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> str.Append(mSeparatorStr.Get());</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> }</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> str.AppendFormatted(256, mFMTStr.Get(), d.vals[d.nChans-1]);</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <a class="code hl_function" href="class_i_text_control.html#af2c4ee0aebd893680977304fabd3c5ae">SetStr</a>(str.Get());</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <a class="code hl_function" href="class_i_control.html#af8c805c09b1a89f44aec43026fcb1fe7">SetDirty</a>(<span class="keyword">false</span>);</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> }</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> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> WDL_String mFMTStr;</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> WDL_String mSeparatorStr;</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> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span>END_IGRAPHICS_NAMESPACE</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span>END_IPLUG_NAMESPACE</div>
<div class="ttc" id="a_i_control_8h_html"><div class="ttname"><a href="_i_control_8h.html">IControl.h</a></div><div class="ttdoc">This file contains the base IControl implementation, along with some base classes for specific types ...</div></div>
<div class="ttc" id="a_i_sender_8h_html"><div class="ttname"><a href="_i_sender_8h.html">ISender.h</a></div></div>
<div class="ttc" id="aclass_i_byte_stream_html"><div class="ttname"><a href="class_i_byte_stream.html">IByteStream</a></div><div class="ttdoc">Manages a non-owned block of memory, for receiving arbitrary message byte streams.</div><div class="ttdef"><b>Definition:</b> <a href="_i_plug_structs_8h_source.html#l00267">IPlugStructs.h:268</a></div></div>
<div class="ttc" id="aclass_i_byte_stream_html_a6a559e06ec65ba71667b37265c1061da"><div class="ttname"><a href="class_i_byte_stream.html#a6a559e06ec65ba71667b37265c1061da">IByteStream::Get</a></div><div class="ttdeci">int Get(T *pDst, int startPos) const</div><div class="ttdoc">Get arbitary typed data from the stream.</div><div class="ttdef"><b>Definition:</b> <a href="_i_plug_structs_8h_source.html#l00289">IPlugStructs.h:289</a></div></div>
<div class="ttc" id="aclass_i_control_html_a498bd0f85778e3c4205b0b7158361b48"><div class="ttname"><a href="class_i_control.html#a498bd0f85778e3c4205b0b7158361b48">IControl::IsDisabled</a></div><div class="ttdeci">bool IsDisabled() const</div><div class="ttdef"><b>Definition:</b> <a href="_i_control_8h_source.html#l00367">IControl.h:367</a></div></div>
<div class="ttc" id="aclass_i_control_html_af8c805c09b1a89f44aec43026fcb1fe7"><div class="ttname"><a href="class_i_control.html#af8c805c09b1a89f44aec43026fcb1fe7">IControl::SetDirty</a></div><div class="ttdeci">virtual void SetDirty(bool triggerAction=true, int valIdx=kNoValIdx)</div><div class="ttdoc">Mark the control as dirty, i.e.</div><div class="ttdef"><b>Definition:</b> <a href="_i_control_8cpp_source.html#l00198">IControl.cpp:198</a></div></div>
<div class="ttc" id="aclass_i_r_t_text_control_html"><div class="ttname"><a href="class_i_r_t_text_control.html">IRTTextControl</a></div><div class="ttdoc">A control to display some text in the UI, driven by values in the RT audio thread.</div><div class="ttdef"><b>Definition:</b> <a href="_i_r_t_text_control_8h_source.html#l00028">IRTTextControl.h:29</a></div></div>
<div class="ttc" id="aclass_i_r_t_text_control_html_ac8708487c8a9ac5b166b7c4c473c12e1"><div class="ttname"><a href="class_i_r_t_text_control.html#ac8708487c8a9ac5b166b7c4c473c12e1">IRTTextControl::OnMsgFromDelegate</a></div><div class="ttdeci">void OnMsgFromDelegate(int msgTag, int dataSize, const void *pData) override</div><div class="ttdoc">Implement to receive messages sent to the control, see IEditorDelegate:SendControlMsgFromDelegate()</div><div class="ttdef"><b>Definition:</b> <a href="_i_r_t_text_control_8h_source.html#l00038">IRTTextControl.h:38</a></div></div>
<div class="ttc" id="aclass_i_sender_html"><div class="ttname"><a href="class_i_sender.html">ISender</a></div><div class="ttdoc">ISender is a utility class which can be used to defer data from the realtime audio processing and sen...</div><div class="ttdef"><b>Definition:</b> <a href="_i_sender_8h_source.html#l00065">ISender.h:66</a></div></div>
<div class="ttc" id="aclass_i_text_control_html"><div class="ttname"><a href="class_i_text_control.html">ITextControl</a></div><div class="ttdoc">A basic control to display some text.</div><div class="ttdef"><b>Definition:</b> <a href="_i_control_8h_source.html#l02156">IControl.h:2157</a></div></div>
<div class="ttc" id="aclass_i_text_control_html_af2c4ee0aebd893680977304fabd3c5ae"><div class="ttname"><a href="class_i_text_control.html#af2c4ee0aebd893680977304fabd3c5ae">ITextControl::SetStr</a></div><div class="ttdeci">virtual void SetStr(const char *str)</div><div class="ttdoc">Set the text to display.</div><div class="ttdef"><b>Definition:</b> <a href="_i_control_8cpp_source.html#l00456">IControl.cpp:456</a></div></div>
<div class="ttc" id="astruct_i_color_html"><div class="ttname"><a href="struct_i_color.html">IColor</a></div><div class="ttdoc">Used to manage color data, independent of draw class/platform.</div><div class="ttdef"><b>Definition:</b> <a href="_i_graphics_structs_8h_source.html#l00222">IGraphicsStructs.h:223</a></div></div>
<div class="ttc" id="astruct_i_r_e_c_t_html"><div class="ttname"><a href="struct_i_r_e_c_t.html">IRECT</a></div><div class="ttdoc">Used to manage a rectangular area, independent of draw class/platform.</div><div class="ttdef"><b>Definition:</b> <a href="_i_graphics_structs_8h_source.html#l00748">IGraphicsStructs.h:749</a></div></div>
<div class="ttc" id="astruct_i_sender_data_html"><div class="ttname"><a href="struct_i_sender_data.html">ISenderData</a></div><div class="ttdoc">ISenderData is used to represent a typed data packet, that may contain values for multiple channels.</div><div class="ttdef"><b>Definition:</b> <a href="_i_sender_8h_source.html#l00034">ISender.h:35</a></div></div>
<div class="ttc" id="astruct_i_text_html"><div class="ttname"><a href="struct_i_text.html">IText</a></div><div class="ttdoc">IText is used to manage font and text/text entry style for a piece of text on the UI,...</div><div class="ttdef"><b>Definition:</b> <a href="_i_graphics_structs_8h_source.html#l00661">IGraphicsStructs.h:662</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>