/usr/share/doc/libjuce/apiref/classTimer.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 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 | <!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: Timer 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="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="classTimer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Timer Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Makes repeated callbacks to a virtual method at a specified time interval.
<a href="classTimer.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Timer:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="classTimer.png" usemap="#Timer_map" alt=""/>
<map id="Timer_map" name="Timer_map">
<area href="classAnimatedAppComponent.html" title="A base class for writing simple one-page graphical apps. " alt="AnimatedAppComponent" shape="rect" coords="205,56,400,80"/>
<area href="classAnimatedPosition.html" title="Models a 1-dimensional position that can be dragged around by the user, and which will then continue ..." alt="AnimatedPosition< Behaviour >" shape="rect" coords="205,112,400,136"/>
<area href="classAudioDeviceSelectorComponent.html" title="A component containing controls to let the user change the audio settings of an AudioDeviceManager ob..." alt="AudioDeviceSelectorComponent" shape="rect" coords="205,168,400,192"/>
<area href="classAudioProcessorValueTreeState.html" title="This class contains a ValueTree which is used to manage an AudioProcessor's entire state..." alt="AudioProcessorValueTreeState" shape="rect" coords="205,224,400,248"/>
<area href="classAudioVisualiserComponent.html" title="A simple component that can be used to show a scrolling waveform of audio data. " alt="AudioVisualiserComponent" shape="rect" coords="205,280,400,304"/>
<area href="classBubbleMessageComponent.html" title="A speech-bubble component that displays a short message. " alt="BubbleMessageComponent" shape="rect" coords="205,336,400,360"/>
<area href="classCallOutBox.html" title="A box with a small arrow that can be used as a temporary pop-up window to show extra controls when a ..." alt="CallOutBox" shape="rect" coords="205,392,400,416"/>
<area href="classCaretComponent.html" alt="CaretComponent" shape="rect" coords="205,448,400,472"/>
<area href="classComponentAnimator.html" title="Animates a set of components, moving them to a new position and/or fading their alpha levels..." alt="ComponentAnimator" shape="rect" coords="205,504,400,528"/>
<area href="classDesktop.html" title="Describes and controls aspects of the computer's desktop. " alt="Desktop" shape="rect" coords="205,560,400,584"/>
<area href="classFakeMouseMoveGenerator.html" alt="FakeMouseMoveGenerator" shape="rect" coords="205,616,400,640"/>
<area href="classFileBrowserComponent.html" title="A component for browsing and selecting a file or directory to open or save. " alt="FileBrowserComponent" shape="rect" coords="205,672,400,696"/>
<area href="classImagePreviewComponent.html" title="A simple preview component that shows thumbnails of image files. " alt="ImagePreviewComponent" shape="rect" coords="205,728,400,752"/>
<area href="classMenuBarComponent.html" title="A menu bar component. " alt="MenuBarComponent" shape="rect" coords="205,784,400,808"/>
<area href="classMidiKeyboardComponent.html" title="A component that displays a piano keyboard, whose notes can be clicked on. " alt="MidiKeyboardComponent" shape="rect" coords="205,840,400,864"/>
<area href="classMouseInactivityDetector.html" title="This object watches for mouse-events happening within a component, and if the mouse remains still for..." alt="MouseInactivityDetector" shape="rect" coords="205,896,400,920"/>
<area href="classProgressBar.html" title="A progress bar component. " alt="ProgressBar" shape="rect" coords="205,952,400,976"/>
<area href="classPropertiesFile.html" title="Wrapper on a file that stores a list of key/value data pairs. " alt="PropertiesFile" shape="rect" coords="205,1008,400,1032"/>
<area href="classScrollBar.html" title="A scrollbar component. " alt="ScrollBar" shape="rect" coords="205,1064,400,1088"/>
<area href="classSplashScreen.html" title="A component for showing a splash screen while your app starts up. " alt="SplashScreen" shape="rect" coords="205,1120,400,1144"/>
<area href="classStandalonePluginHolder.html" title="An object that creates and plays a standalone instance of an AudioProcessor. " alt="StandalonePluginHolder" shape="rect" coords="205,1176,400,1200"/>
<area href="classThreadWithProgressWindow.html" title="A thread that automatically pops up a modal dialog box with a progress bar and cancel button while it..." alt="ThreadWithProgressWindow" shape="rect" coords="205,1232,400,1256"/>
<area href="classTooltipWindow.html" title="A window that displays a pop-up tooltip when the mouse hovers over another component. " alt="TooltipWindow" shape="rect" coords="205,1288,400,1312"/>
</map>
</div></div>
<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:ad3c95ce902fce977d280256256856d64"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTimer.html#ad3c95ce902fce977d280256256856d64">~Timer</a> ()</td></tr>
<tr class="memdesc:ad3c95ce902fce977d280256256856d64"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ad3c95ce902fce977d280256256856d64">More...</a><br /></td></tr>
<tr class="separator:ad3c95ce902fce977d280256256856d64"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8adc40ca0fb4170737ba12e30481b9d8"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTimer.html#a8adc40ca0fb4170737ba12e30481b9d8">timerCallback</a> ()=0</td></tr>
<tr class="memdesc:a8adc40ca0fb4170737ba12e30481b9d8"><td class="mdescLeft"> </td><td class="mdescRight">The user-defined callback routine that actually gets called periodically. <a href="#a8adc40ca0fb4170737ba12e30481b9d8">More...</a><br /></td></tr>
<tr class="separator:a8adc40ca0fb4170737ba12e30481b9d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3b1a51ac348c56a55fcef4570214f057"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTimer.html#a3b1a51ac348c56a55fcef4570214f057">startTimer</a> (int intervalInMilliseconds) noexcept</td></tr>
<tr class="memdesc:a3b1a51ac348c56a55fcef4570214f057"><td class="mdescLeft"> </td><td class="mdescRight">Starts the timer and sets the length of interval required. <a href="#a3b1a51ac348c56a55fcef4570214f057">More...</a><br /></td></tr>
<tr class="separator:a3b1a51ac348c56a55fcef4570214f057"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a457efb22cb11b8518b18a0e8f02d818b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTimer.html#a457efb22cb11b8518b18a0e8f02d818b">startTimerHz</a> (int timerFrequencyHz) noexcept</td></tr>
<tr class="memdesc:a457efb22cb11b8518b18a0e8f02d818b"><td class="mdescLeft"> </td><td class="mdescRight">Starts the timer with an interval specified in Hertz. <a href="#a457efb22cb11b8518b18a0e8f02d818b">More...</a><br /></td></tr>
<tr class="separator:a457efb22cb11b8518b18a0e8f02d818b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab918b8c1f80bf1de92dd1a5878f498bd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTimer.html#ab918b8c1f80bf1de92dd1a5878f498bd">stopTimer</a> () noexcept</td></tr>
<tr class="memdesc:ab918b8c1f80bf1de92dd1a5878f498bd"><td class="mdescLeft"> </td><td class="mdescRight">Stops the timer. <a href="#ab918b8c1f80bf1de92dd1a5878f498bd">More...</a><br /></td></tr>
<tr class="separator:ab918b8c1f80bf1de92dd1a5878f498bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a11b80f425e27ea9899e05b104e2df07a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTimer.html#a11b80f425e27ea9899e05b104e2df07a">isTimerRunning</a> () const noexcept</td></tr>
<tr class="memdesc:a11b80f425e27ea9899e05b104e2df07a"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the timer is currently running. <a href="#a11b80f425e27ea9899e05b104e2df07a">More...</a><br /></td></tr>
<tr class="separator:a11b80f425e27ea9899e05b104e2df07a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3515b6e7a1e3777965e35686eaeb2da7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTimer.html#a3515b6e7a1e3777965e35686eaeb2da7">getTimerInterval</a> () const noexcept</td></tr>
<tr class="memdesc:a3515b6e7a1e3777965e35686eaeb2da7"><td class="mdescLeft"> </td><td class="mdescRight">Returns the timer's interval. <a href="#a3515b6e7a1e3777965e35686eaeb2da7">More...</a><br /></td></tr>
<tr class="separator:a3515b6e7a1e3777965e35686eaeb2da7"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a7074d145c7408da67fdbbe7359aa3b74"><td class="memItemLeft" align="right" valign="top">static void <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTimer.html#a7074d145c7408da67fdbbe7359aa3b74">callPendingTimersSynchronously</a> ()</td></tr>
<tr class="memdesc:a7074d145c7408da67fdbbe7359aa3b74"><td class="mdescLeft"> </td><td class="mdescRight">For internal use only: invokes any timers that need callbacks. <a href="#a7074d145c7408da67fdbbe7359aa3b74">More...</a><br /></td></tr>
<tr class="separator:a7074d145c7408da67fdbbe7359aa3b74"><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:a3d18ff196960cc65f19ff5452ece31db"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTimer.html#a3d18ff196960cc65f19ff5452ece31db">Timer</a> () noexcept</td></tr>
<tr class="memdesc:a3d18ff196960cc65f19ff5452ece31db"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classTimer.html" title="Makes repeated callbacks to a virtual method at a specified time interval. ">Timer</a>. <a href="#a3d18ff196960cc65f19ff5452ece31db">More...</a><br /></td></tr>
<tr class="separator:a3d18ff196960cc65f19ff5452ece31db"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9d88bd608681fc2dc80e87044ed64526"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTimer.html#a9d88bd608681fc2dc80e87044ed64526">Timer</a> (const <a class="el" href="classTimer.html">Timer</a> &) noexcept</td></tr>
<tr class="memdesc:a9d88bd608681fc2dc80e87044ed64526"><td class="mdescLeft"> </td><td class="mdescRight">Creates a copy of another timer. <a href="#a9d88bd608681fc2dc80e87044ed64526">More...</a><br /></td></tr>
<tr class="separator:a9d88bd608681fc2dc80e87044ed64526"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Makes repeated callbacks to a virtual method at a specified time interval. </p>
<p>A <a class="el" href="classTimer.html" title="Makes repeated callbacks to a virtual method at a specified time interval. ">Timer</a>'s <a class="el" href="classTimer.html#a8adc40ca0fb4170737ba12e30481b9d8" title="The user-defined callback routine that actually gets called periodically. ">timerCallback()</a> method will be repeatedly called at a given interval. When you create a <a class="el" href="classTimer.html" title="Makes repeated callbacks to a virtual method at a specified time interval. ">Timer</a> object, it will do nothing until the <a class="el" href="classTimer.html#a3b1a51ac348c56a55fcef4570214f057" title="Starts the timer and sets the length of interval required. ">startTimer()</a> method is called, which will cause the message thread to start making callbacks at the specified interval, until <a class="el" href="classTimer.html#ab918b8c1f80bf1de92dd1a5878f498bd" title="Stops the timer. ">stopTimer()</a> is called or the object is deleted.</p>
<p>The time interval isn't guaranteed to be precise to any more than maybe 10-20ms, and the intervals may end up being much longer than requested if the system is busy. Because the callbacks are made by the main message thread, anything that blocks the message queue for a period of time will also prevent any timers from running until it can carry on.</p>
<p>If you need to have a single callback that is shared by multiple timers with different frequencies, then the <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> class allows you to do that - its structure 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 contains multiple timers internally, each one identified by an ID number.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classHighResolutionTimer.html" title="A high-resolution periodic timer. ">HighResolutionTimer</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> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a3d18ff196960cc65f19ff5452ece31db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d18ff196960cc65f19ff5452ece31db">§ </a></span>Timer() <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">Timer::Timer </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="classTimer.html" title="Makes repeated callbacks to a virtual method at a specified time interval. ">Timer</a>. </p>
<p>When created, the timer is stopped, so use <a class="el" href="classTimer.html#a3b1a51ac348c56a55fcef4570214f057" title="Starts the timer and sets the length of interval required. ">startTimer()</a> to get it going. </p>
</div>
</div>
<a id="a9d88bd608681fc2dc80e87044ed64526"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d88bd608681fc2dc80e87044ed64526">§ </a></span>Timer() <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">Timer::Timer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTimer.html">Timer</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 won't be started, even if the one you're copying is running. </p>
</div>
</div>
<a id="ad3c95ce902fce977d280256256856d64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3c95ce902fce977d280256256856d64">§ </a></span>~Timer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual Timer::~Timer </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="a8adc40ca0fb4170737ba12e30481b9d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8adc40ca0fb4170737ba12e30481b9d8">§ </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 Timer::timerCallback </td>
<td>(</td>
<td class="paramname"></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 periodically. </p>
<p>It's perfectly ok to call <a class="el" href="classTimer.html#a3b1a51ac348c56a55fcef4570214f057" title="Starts the timer and sets the length of interval required. ">startTimer()</a> or <a class="el" href="classTimer.html#ab918b8c1f80bf1de92dd1a5878f498bd" title="Stops the timer. ">stopTimer()</a> from within this callback to change the subsequent intervals. </p>
<p>Implemented in <a class="el" href="classMidiKeyboardComponent.html#a287ff0306d5f83f88aab4a512698b20f">MidiKeyboardComponent</a>, <a class="el" href="classBubbleMessageComponent.html#a3c18ebec472bdae07e7544261e6dc372">BubbleMessageComponent</a>, <a class="el" href="classAudioDeviceSelectorComponent.html#a225ffb9aebc48af8e51d0891fe2ae719">AudioDeviceSelectorComponent</a>, <a class="el" href="classImagePreviewComponent.html#ad2a20bfff150cf417ded4f90eab0fe56">ImagePreviewComponent</a>, and <a class="el" href="classFakeMouseMoveGenerator.html#a9b66aec9e060556136c605f018f01786">FakeMouseMoveGenerator</a>.</p>
<p>Referenced by <a class="el" href="classThreadWithProgressWindow.html#a0e5317249298095d572ca993649f444f">ThreadWithProgressWindow::getAlertWindow()</a>, <a class="el" href="classAudioDeviceSelectorComponent.html#a37ab45ee4651bb9f12750a043b1659a8">AudioDeviceSelectorComponent::getItemHeight()</a>, <a class="el" href="classMidiKeyboardComponent.html#a4409af4c9ef645c3c1d91027c98a87d0">MidiKeyboardComponent::getOctaveForMiddleC()</a>, and <a class="el" href="structFileBrowserComponent_1_1LookAndFeelMethods.html#a934f73e7eca0f87b718f09971859a2c3">FileBrowserComponent::LookAndFeelMethods::~LookAndFeelMethods()</a>.</p>
</div>
</div>
<a id="a3b1a51ac348c56a55fcef4570214f057"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b1a51ac348c56a55fcef4570214f057">§ </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 Timer::startTimer </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>intervalInMilliseconds</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>Starts the 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">intervalInMilliseconds</td><td>the interval to use (any value less than 1 will be rounded up to 1) </td></tr>
</table>
</dd>
</dl>
<p>Referenced by <a class="el" href="classFakeMouseMoveGenerator.html#a0abab3f56b571ae115caf33eb5c9c596">FakeMouseMoveGenerator::FakeMouseMoveGenerator()</a>, and <a class="el" href="classStandalonePluginHolder.html#a01907d1aa9e4ce519e1e691f96eb2c06">StandalonePluginHolder::StandalonePluginHolder()</a>.</p>
</div>
</div>
<a id="a457efb22cb11b8518b18a0e8f02d818b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a457efb22cb11b8518b18a0e8f02d818b">§ </a></span>startTimerHz()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Timer::startTimerHz </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>timerFrequencyHz</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>Starts the timer with an interval specified in Hertz. </p>
<p>This is effectively the same as calling startTimer (1000 / timerFrequencyHz). </p>
<p>Referenced by <a class="el" href="classAnimatedPosition.html#a31520fda363c37afac010416dab7707f">AnimatedPosition< Behaviour >::endDrag()</a>, and <a class="el" href="classAnimatedPosition.html#aa58f2a396a133f7325322b5eeb9b1d3b">AnimatedPosition< Behaviour >::nudge()</a>.</p>
</div>
</div>
<a id="ab918b8c1f80bf1de92dd1a5878f498bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab918b8c1f80bf1de92dd1a5878f498bd">§ </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 Timer::stopTimer </td>
<td>(</td>
<td class="paramname"></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 the timer. </p>
<p>No more timer callbacks will be triggered after this method returns.</p>
<p>Note that if you call this from a background thread while the message-thread is already in the middle of your callback, then this method will cancel any future timer callbacks, but it will return without waiting for the current one to finish. The current callback will continue, possibly still running some of your timer code after this method has returned. </p>
<p>Referenced by <a class="el" href="classAnimatedPosition.html#a3378dd6b200539ef684f5d8031a4f69a">AnimatedPosition< Behaviour >::beginDrag()</a>, <a class="el" href="classAnimatedPosition.html#a18201fedfc570cb04582ff65b9ddbf3d">AnimatedPosition< Behaviour >::setPosition()</a>, and <a class="el" href="classStandalonePluginHolder.html#a228609a6435e5ae61c21c59353b675a5">StandalonePluginHolder::~StandalonePluginHolder()</a>.</p>
</div>
</div>
<a id="a11b80f425e27ea9899e05b104e2df07a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11b80f425e27ea9899e05b104e2df07a">§ </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 Timer::isTimerRunning </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>Returns true if the timer is currently running. </p>
</div>
</div>
<a id="a3515b6e7a1e3777965e35686eaeb2da7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3515b6e7a1e3777965e35686eaeb2da7">§ </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 Timer::getTimerInterval </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>Returns the timer's interval. </p>
<dl class="section return"><dt>Returns</dt><dd>the timer's interval in milliseconds if it's running, or 0 if it's not. </dd></dl>
<p>References <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a>.</p>
</div>
</div>
<a id="a7074d145c7408da67fdbbe7359aa3b74"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7074d145c7408da67fdbbe7359aa3b74">§ </a></span>callPendingTimersSynchronously()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> Timer::callPendingTimersSynchronously </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>For internal use only: invokes any timers that need callbacks. </p>
<p>Don't call this unless you really know what you're doing! </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__Timer_8h.html">juce_Timer.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|