/usr/share/doc/libjuce/apiref/classMultiTimer.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 | <!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.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: MultiTimer 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">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="classMultiTimer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">MultiTimer Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>A type of timer class that can run multiple timers with different frequencies, all of which share a single callback.
<a href="classMultiTimer.html#details">More...</a></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:a6b839b0a693cfaf5e42d8274450b9a9e"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classMultiTimer.html#a6b839b0a693cfaf5e42d8274450b9a9e">~MultiTimer</a> ()</td></tr>
<tr class="memdesc:a6b839b0a693cfaf5e42d8274450b9a9e"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a6b839b0a693cfaf5e42d8274450b9a9e">More...</a><br /></td></tr>
<tr class="separator:a6b839b0a693cfaf5e42d8274450b9a9e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a16dde865d7aaf32ba2649f498518e7a7"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMultiTimer.html#a16dde865d7aaf32ba2649f498518e7a7">timerCallback</a> (int timerID)=0</td></tr>
<tr class="memdesc:a16dde865d7aaf32ba2649f498518e7a7"><td class="mdescLeft"> </td><td class="mdescRight">The user-defined callback routine that actually gets called by each of the timers that are running. <a href="#a16dde865d7aaf32ba2649f498518e7a7">More...</a><br /></td></tr>
<tr class="separator:a16dde865d7aaf32ba2649f498518e7a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae1a9966181d6680a15cebb95168093b5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMultiTimer.html#ae1a9966181d6680a15cebb95168093b5">startTimer</a> (int timerID, int intervalInMilliseconds) noexcept</td></tr>
<tr class="memdesc:ae1a9966181d6680a15cebb95168093b5"><td class="mdescLeft"> </td><td class="mdescRight">Starts a timer and sets the length of interval required. <a href="#ae1a9966181d6680a15cebb95168093b5">More...</a><br /></td></tr>
<tr class="separator:ae1a9966181d6680a15cebb95168093b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3eec2bf5bb83c0307bdb4568c7391a2b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMultiTimer.html#a3eec2bf5bb83c0307bdb4568c7391a2b">stopTimer</a> (int timerID) noexcept</td></tr>
<tr class="memdesc:a3eec2bf5bb83c0307bdb4568c7391a2b"><td class="mdescLeft"> </td><td class="mdescRight">Stops a timer. <a href="#a3eec2bf5bb83c0307bdb4568c7391a2b">More...</a><br /></td></tr>
<tr class="separator:a3eec2bf5bb83c0307bdb4568c7391a2b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b58acb555c3fe60472049f87829daa5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classMultiTimer.html#a7b58acb555c3fe60472049f87829daa5">isTimerRunning</a> (int timerID) const noexcept</td></tr>
<tr class="memdesc:a7b58acb555c3fe60472049f87829daa5"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether a timer has been started for a specified ID. <a href="#a7b58acb555c3fe60472049f87829daa5">More...</a><br /></td></tr>
<tr class="separator:a7b58acb555c3fe60472049f87829daa5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad69e9355c606daccf5fbc99085f3d114"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classMultiTimer.html#ad69e9355c606daccf5fbc99085f3d114">getTimerInterval</a> (int timerID) const noexcept</td></tr>
<tr class="memdesc:ad69e9355c606daccf5fbc99085f3d114"><td class="mdescLeft"> </td><td class="mdescRight">Returns the interval for a specified timer ID. <a href="#ad69e9355c606daccf5fbc99085f3d114">More...</a><br /></td></tr>
<tr class="separator:ad69e9355c606daccf5fbc99085f3d114"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a608fc823bb95f046f439424521615dc9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMultiTimer.html#a608fc823bb95f046f439424521615dc9">MultiTimer</a> () noexcept</td></tr>
<tr class="memdesc:a608fc823bb95f046f439424521615dc9"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classMultiTimer.html" title="A type of timer class that can run multiple timers with different frequencies, all of which share a s...">MultiTimer</a>. <a href="#a608fc823bb95f046f439424521615dc9">More...</a><br /></td></tr>
<tr class="separator:a608fc823bb95f046f439424521615dc9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5020d0be93325aed21de9f06e2b28935"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMultiTimer.html#a5020d0be93325aed21de9f06e2b28935">MultiTimer</a> (const <a class="el" href="classMultiTimer.html">MultiTimer</a> &) noexcept</td></tr>
<tr class="memdesc:a5020d0be93325aed21de9f06e2b28935"><td class="mdescLeft"> </td><td class="mdescRight">Creates a copy of another timer. <a href="#a5020d0be93325aed21de9f06e2b28935">More...</a><br /></td></tr>
<tr class="separator:a5020d0be93325aed21de9f06e2b28935"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A type of timer class that can run multiple timers with different frequencies, all of which share a single callback. </p>
<p>This class is very similar to the <a class="el" href="classTimer.html" title="Makes repeated callbacks to a virtual method at a specified time interval. ">Timer</a> class, but allows you run multiple separate timers, where each one has a unique ID number. The methods in this class are exactly equivalent to those in <a class="el" href="classTimer.html" title="Makes repeated callbacks to a virtual method at a specified time interval. ">Timer</a>, but with the addition of this ID number.</p>
<p>To use it, you need to create a subclass of <a class="el" href="classMultiTimer.html" title="A type of timer class that can run multiple timers with different frequencies, all of which share a s...">MultiTimer</a>, implementing the <a class="el" href="classMultiTimer.html#a16dde865d7aaf32ba2649f498518e7a7" title="The user-defined callback routine that actually gets called by each of the timers that are running...">timerCallback()</a> method. Then you can start timers with <a class="el" href="classMultiTimer.html#ae1a9966181d6680a15cebb95168093b5" title="Starts a timer and sets the length of interval required. ">startTimer()</a>, and each time the callback is triggered, it passes in the ID of the timer that caused it.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classTimer.html" title="Makes repeated callbacks to a virtual method at a specified time interval. ">Timer</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a608fc823bb95f046f439424521615dc9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a608fc823bb95f046f439424521615dc9">§ </a></span>MultiTimer() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">MultiTimer::MultiTimer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="classMultiTimer.html" title="A type of timer class that can run multiple timers with different frequencies, all of which share a s...">MultiTimer</a>. </p>
<p>When created, no timers are running, so use <a class="el" href="classMultiTimer.html#ae1a9966181d6680a15cebb95168093b5" title="Starts a timer and sets the length of interval required. ">startTimer()</a> to start things off. </p>
</div>
</div>
<a id="a5020d0be93325aed21de9f06e2b28935"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5020d0be93325aed21de9f06e2b28935">§ </a></span>MultiTimer() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">MultiTimer::MultiTimer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classMultiTimer.html">MultiTimer</a> & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a copy of another timer. </p>
<p>Note that this timer will not contain any running timers, even if the one you're copying from was running. </p>
</div>
</div>
<a id="a6b839b0a693cfaf5e42d8274450b9a9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b839b0a693cfaf5e42d8274450b9a9e">§ </a></span>~MultiTimer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual MultiTimer::~MultiTimer </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="a16dde865d7aaf32ba2649f498518e7a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16dde865d7aaf32ba2649f498518e7a7">§ </a></span>timerCallback()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void MultiTimer::timerCallback </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>timerID</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The user-defined callback routine that actually gets called by each of the timers that are running. </p>
<p>It's perfectly ok to call <a class="el" href="classMultiTimer.html#ae1a9966181d6680a15cebb95168093b5" title="Starts a timer and sets the length of interval required. ">startTimer()</a> or <a class="el" href="classMultiTimer.html#a3eec2bf5bb83c0307bdb4568c7391a2b" title="Stops a timer. ">stopTimer()</a> from within this callback to change the subsequent intervals. </p>
</div>
</div>
<a id="ae1a9966181d6680a15cebb95168093b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1a9966181d6680a15cebb95168093b5">§ </a></span>startTimer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void MultiTimer::startTimer </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>timerID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>intervalInMilliseconds</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></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>Starts a timer and sets the length of interval required. </p>
<p>If the timer is already started, this will reset it, so the time between calling this method and the next timer callback will not be less than the interval length passed in.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">timerID</td><td>a unique Id number that identifies the timer to start. This is the id that will be passed back to the <a class="el" href="classMultiTimer.html#a16dde865d7aaf32ba2649f498518e7a7" title="The user-defined callback routine that actually gets called by each of the timers that are running...">timerCallback()</a> method when this timer is triggered </td></tr>
<tr><td class="paramname">intervalInMilliseconds</td><td>the interval to use (any values less than 1 will be rounded up to 1) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3eec2bf5bb83c0307bdb4568c7391a2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3eec2bf5bb83c0307bdb4568c7391a2b">§ </a></span>stopTimer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void MultiTimer::stopTimer </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>timerID</em></td><td>)</td>
<td></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>Stops a timer. </p>
<p>If a timer has been started with the given ID number, it will be cancelled. No more callbacks will be made for the specified timer after this method returns.</p>
<p>If this is called from a different thread, any callbacks that may be currently executing may be allowed to finish before the method returns. </p>
</div>
</div>
<a id="a7b58acb555c3fe60472049f87829daa5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b58acb555c3fe60472049f87829daa5">§ </a></span>isTimerRunning()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool MultiTimer::isTimerRunning </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>timerID</em></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>Checks whether a timer has been started for a specified ID. </p>
<dl class="section return"><dt>Returns</dt><dd>true if a timer with the given ID is running. </dd></dl>
</div>
</div>
<a id="ad69e9355c606daccf5fbc99085f3d114"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad69e9355c606daccf5fbc99085f3d114">§ </a></span>getTimerInterval()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int MultiTimer::getTimerInterval </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>timerID</em></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>Returns the interval for a specified timer ID. </p>
<dl class="section return"><dt>Returns</dt><dd>the timer's interval in milliseconds if it's running, or 0 if no timer was running for the ID number specified. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__MultiTimer_8h.html">juce_MultiTimer.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|