/usr/share/doc/libjuce/apiref/classChangeBroadcaster.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 | <!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: ChangeBroadcaster 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="classChangeBroadcaster-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ChangeBroadcaster Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Holds a list of ChangeListeners, and sends messages to them when instructed.
<a href="classChangeBroadcaster.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 ChangeBroadcaster:</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="classChangeBroadcaster.png" usemap="#ChangeBroadcaster_map" alt=""/>
<map id="ChangeBroadcaster_map" name="ChangeBroadcaster_map">
<area href="classAudioCDBurner.html" alt="AudioCDBurner" shape="rect" coords="244,56,478,80"/>
<area href="classAudioDeviceManager.html" title="Manages the state of some audio and midi i/o devices. " alt="AudioDeviceManager" shape="rect" coords="244,112,478,136"/>
<area href="classAudioThumbnailBase.html" title="Provides a base for classes that can store and draw scaled views of an audio waveform. " alt="AudioThumbnailBase" shape="rect" coords="244,168,478,192"/>
<area href="classAudioTransportSource.html" title="An AudioSource that takes a PositionableAudioSource and allows it to be played, stopped, started, etc. " alt="AudioTransportSource" shape="rect" coords="244,224,478,248"/>
<area href="classColourSelector.html" title="A component that lets the user choose a colour. " alt="ColourSelector" shape="rect" coords="244,280,478,304"/>
<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="244,336,478,360"/>
<area href="classDirectoryContentsList.html" title="A class to asynchronously scan for details about the files in a directory. " alt="DirectoryContentsList" shape="rect" coords="244,392,478,416"/>
<area href="classFileBasedDocument.html" title="A class to take care of the logic involved with the loading/saving of some kind of document..." alt="FileBasedDocument" shape="rect" coords="244,448,478,472"/>
<area href="classKeyPressMappingSet.html" title="Manages and edits a list of keypresses, which it uses to invoke the appropriate command in an Applica..." alt="KeyPressMappingSet" shape="rect" coords="244,504,478,528"/>
<area href="classKnownPluginList.html" title="Manages a list of plugin types. " alt="KnownPluginList" shape="rect" coords="244,560,478,584"/>
<area href="classMidiKeyboardComponent.html" title="A component that displays a piano keyboard, whose notes can be clicked on. " alt="MidiKeyboardComponent" shape="rect" coords="244,616,478,640"/>
<area href="classPropertiesFile.html" title="Wrapper on a file that stores a list of key/value data pairs. " alt="PropertiesFile" shape="rect" coords="244,672,478,696"/>
<area href="classSelectedItemSet.html" title="Manages a list of selectable items. " alt="SelectedItemSet< SelectableItemType >" shape="rect" coords="244,728,478,752"/>
<area href="classTabbedButtonBar.html" title="A vertical or horizontal bar containing tabs that you can select. " alt="TabbedButtonBar" shape="rect" coords="244,784,478,808"/>
<area href="classUndoManager.html" title="Manages a list of undo/redo commands. " alt="UndoManager" shape="rect" coords="244,840,478,864"/>
</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:a1c8ccfa186a47d58a05e7f1f1576c038"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classChangeBroadcaster.html#a1c8ccfa186a47d58a05e7f1f1576c038">ChangeBroadcaster</a> () noexcept</td></tr>
<tr class="memdesc:a1c8ccfa186a47d58a05e7f1f1576c038"><td class="mdescLeft"> </td><td class="mdescRight">Creates an <a class="el" href="classChangeBroadcaster.html" title="Holds a list of ChangeListeners, and sends messages to them when instructed. ">ChangeBroadcaster</a>. <a href="#a1c8ccfa186a47d58a05e7f1f1576c038">More...</a><br /></td></tr>
<tr class="separator:a1c8ccfa186a47d58a05e7f1f1576c038"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3b2f8465cc6c09c0583c8bdf56319742"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classChangeBroadcaster.html#a3b2f8465cc6c09c0583c8bdf56319742">~ChangeBroadcaster</a> ()</td></tr>
<tr class="memdesc:a3b2f8465cc6c09c0583c8bdf56319742"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a3b2f8465cc6c09c0583c8bdf56319742">More...</a><br /></td></tr>
<tr class="separator:a3b2f8465cc6c09c0583c8bdf56319742"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad68416fe79a94cd5c99519bdea6c2a06"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChangeBroadcaster.html#ad68416fe79a94cd5c99519bdea6c2a06">addChangeListener</a> (<a class="el" href="classChangeListener.html">ChangeListener</a> *listener)</td></tr>
<tr class="memdesc:ad68416fe79a94cd5c99519bdea6c2a06"><td class="mdescLeft"> </td><td class="mdescRight">Registers a listener to receive change callbacks from this broadcaster. <a href="#ad68416fe79a94cd5c99519bdea6c2a06">More...</a><br /></td></tr>
<tr class="separator:ad68416fe79a94cd5c99519bdea6c2a06"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae558a26c795278549a63e342bd5f1650"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChangeBroadcaster.html#ae558a26c795278549a63e342bd5f1650">removeChangeListener</a> (<a class="el" href="classChangeListener.html">ChangeListener</a> *listener)</td></tr>
<tr class="memdesc:ae558a26c795278549a63e342bd5f1650"><td class="mdescLeft"> </td><td class="mdescRight">Unregisters a listener from the list. <a href="#ae558a26c795278549a63e342bd5f1650">More...</a><br /></td></tr>
<tr class="separator:ae558a26c795278549a63e342bd5f1650"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b9c150078318d419debc82e6f22ce58"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChangeBroadcaster.html#a6b9c150078318d419debc82e6f22ce58">removeAllChangeListeners</a> ()</td></tr>
<tr class="memdesc:a6b9c150078318d419debc82e6f22ce58"><td class="mdescLeft"> </td><td class="mdescRight">Removes all listeners from the list. <a href="#a6b9c150078318d419debc82e6f22ce58">More...</a><br /></td></tr>
<tr class="separator:a6b9c150078318d419debc82e6f22ce58"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a10f01d1c0a7fde85355321985a682cbd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChangeBroadcaster.html#a10f01d1c0a7fde85355321985a682cbd">sendChangeMessage</a> ()</td></tr>
<tr class="memdesc:a10f01d1c0a7fde85355321985a682cbd"><td class="mdescLeft"> </td><td class="mdescRight">Causes an asynchronous change message to be sent to all the registered listeners. <a href="#a10f01d1c0a7fde85355321985a682cbd">More...</a><br /></td></tr>
<tr class="separator:a10f01d1c0a7fde85355321985a682cbd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5d16cd01b9af4bacb1716530af17f77b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChangeBroadcaster.html#a5d16cd01b9af4bacb1716530af17f77b">sendSynchronousChangeMessage</a> ()</td></tr>
<tr class="memdesc:a5d16cd01b9af4bacb1716530af17f77b"><td class="mdescLeft"> </td><td class="mdescRight">Sends a synchronous change message to all the registered listeners. <a href="#a5d16cd01b9af4bacb1716530af17f77b">More...</a><br /></td></tr>
<tr class="separator:a5d16cd01b9af4bacb1716530af17f77b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a78f62ecd57a016f8ba7a6ce55454947d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChangeBroadcaster.html#a78f62ecd57a016f8ba7a6ce55454947d">dispatchPendingMessages</a> ()</td></tr>
<tr class="memdesc:a78f62ecd57a016f8ba7a6ce55454947d"><td class="mdescLeft"> </td><td class="mdescRight">If a change message has been sent but not yet dispatched, this will call <a class="el" href="classChangeBroadcaster.html#a5d16cd01b9af4bacb1716530af17f77b" title="Sends a synchronous change message to all the registered listeners. ">sendSynchronousChangeMessage()</a> to make the callback immediately. <a href="#a78f62ecd57a016f8ba7a6ce55454947d">More...</a><br /></td></tr>
<tr class="separator:a78f62ecd57a016f8ba7a6ce55454947d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Holds a list of ChangeListeners, and sends messages to them when instructed. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classChangeListener.html" title="Receives change event callbacks that are sent out by a ChangeBroadcaster. ">ChangeListener</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a1c8ccfa186a47d58a05e7f1f1576c038"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c8ccfa186a47d58a05e7f1f1576c038">§ </a></span>ChangeBroadcaster()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ChangeBroadcaster::ChangeBroadcaster </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>Creates an <a class="el" href="classChangeBroadcaster.html" title="Holds a list of ChangeListeners, and sends messages to them when instructed. ">ChangeBroadcaster</a>. </p>
</div>
</div>
<a id="a3b2f8465cc6c09c0583c8bdf56319742"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b2f8465cc6c09c0583c8bdf56319742">§ </a></span>~ChangeBroadcaster()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ChangeBroadcaster::~ChangeBroadcaster </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="ad68416fe79a94cd5c99519bdea6c2a06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad68416fe79a94cd5c99519bdea6c2a06">§ </a></span>addChangeListener()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ChangeBroadcaster::addChangeListener </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classChangeListener.html">ChangeListener</a> * </td>
<td class="paramname"><em>listener</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers a listener to receive change callbacks from this broadcaster. </p>
<p>Trying to add a listener that's already on the list will have no effect. </p>
</div>
</div>
<a id="ae558a26c795278549a63e342bd5f1650"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae558a26c795278549a63e342bd5f1650">§ </a></span>removeChangeListener()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ChangeBroadcaster::removeChangeListener </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classChangeListener.html">ChangeListener</a> * </td>
<td class="paramname"><em>listener</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unregisters a listener from the list. </p>
<p>If the listener isn't on the list, this won't have any effect. </p>
</div>
</div>
<a id="a6b9c150078318d419debc82e6f22ce58"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b9c150078318d419debc82e6f22ce58">§ </a></span>removeAllChangeListeners()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ChangeBroadcaster::removeAllChangeListeners </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes all listeners from the list. </p>
</div>
</div>
<a id="a10f01d1c0a7fde85355321985a682cbd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10f01d1c0a7fde85355321985a682cbd">§ </a></span>sendChangeMessage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ChangeBroadcaster::sendChangeMessage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Causes an asynchronous change message to be sent to all the registered listeners. </p>
<p>The message will be delivered asynchronously by the main message thread, so this method will return immediately. To call the listeners synchronously use <a class="el" href="classChangeBroadcaster.html#a5d16cd01b9af4bacb1716530af17f77b" title="Sends a synchronous change message to all the registered listeners. ">sendSynchronousChangeMessage()</a>. </p>
<p>Referenced by <a class="el" href="classSelectedItemSet.html#ab9120f4e10142aadbeecb2347b0eb62f">SelectedItemSet< SelectableItemType >::changed()</a>.</p>
</div>
</div>
<a id="a5d16cd01b9af4bacb1716530af17f77b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d16cd01b9af4bacb1716530af17f77b">§ </a></span>sendSynchronousChangeMessage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ChangeBroadcaster::sendSynchronousChangeMessage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sends a synchronous change message to all the registered listeners. </p>
<p>This will immediately call all the listeners that are registered. For thread-safety reasons, you must only call this method on the main message thread.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classChangeBroadcaster.html#a78f62ecd57a016f8ba7a6ce55454947d" title="If a change message has been sent but not yet dispatched, this will call sendSynchronousChangeMessage...">dispatchPendingMessages</a> </dd></dl>
<p>Referenced by <a class="el" href="classSelectedItemSet.html#a76ded0d9f2a1d292879462c867c36228">SelectedItemSet< SelectableItemType >::changed()</a>.</p>
</div>
</div>
<a id="a78f62ecd57a016f8ba7a6ce55454947d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a78f62ecd57a016f8ba7a6ce55454947d">§ </a></span>dispatchPendingMessages()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ChangeBroadcaster::dispatchPendingMessages </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>If a change message has been sent but not yet dispatched, this will call <a class="el" href="classChangeBroadcaster.html#a5d16cd01b9af4bacb1716530af17f77b" title="Sends a synchronous change message to all the registered listeners. ">sendSynchronousChangeMessage()</a> to make the callback immediately. </p>
<p>For thread-safety reasons, you must only call this method on the main message thread. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__ChangeBroadcaster_8h.html">juce_ChangeBroadcaster.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|