/usr/share/doc/libjuce/apiref/classValueTreeSynchroniser.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 | <!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: ValueTreeSynchroniser 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="classValueTreeSynchroniser-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ValueTreeSynchroniser Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>This class can be used to watch for all changes to the state of a <a class="el" href="classValueTree.html" title="A powerful tree structure that can be used to hold free-form data, and which can handle its own undo ...">ValueTree</a>, and to convert them to a transmittable binary encoding.
<a href="classValueTreeSynchroniser.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 ValueTreeSynchroniser:</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="classValueTreeSynchroniser.png" usemap="#ValueTreeSynchroniser_map" alt=""/>
<map id="ValueTreeSynchroniser_map" name="ValueTreeSynchroniser_map">
<area href="classValueTree_1_1Listener.html" title="Listener class for events that happen to a ValueTree. " alt="ValueTree::Listener" shape="rect" coords="0,0,147,24"/>
</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:a85fc71c5c6f74a970ff2b0f45d0a679b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classValueTreeSynchroniser.html#a85fc71c5c6f74a970ff2b0f45d0a679b">ValueTreeSynchroniser</a> (const <a class="el" href="classValueTree.html">ValueTree</a> &tree)</td></tr>
<tr class="memdesc:a85fc71c5c6f74a970ff2b0f45d0a679b"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classValueTreeSynchroniser.html" title="This class can be used to watch for all changes to the state of a ValueTree, and to convert them to a...">ValueTreeSynchroniser</a> that watches the given tree. <a href="#a85fc71c5c6f74a970ff2b0f45d0a679b">More...</a><br /></td></tr>
<tr class="separator:a85fc71c5c6f74a970ff2b0f45d0a679b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae0719684d20eee3d640551cef6c75e72"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classValueTreeSynchroniser.html#ae0719684d20eee3d640551cef6c75e72">~ValueTreeSynchroniser</a> ()</td></tr>
<tr class="memdesc:ae0719684d20eee3d640551cef6c75e72"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ae0719684d20eee3d640551cef6c75e72">More...</a><br /></td></tr>
<tr class="separator:ae0719684d20eee3d640551cef6c75e72"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd2f064583c5bf45d65c5ff1369f0a5b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classValueTreeSynchroniser.html#acd2f064583c5bf45d65c5ff1369f0a5b">stateChanged</a> (const void *encodedChange, size_t encodedChangeSize)=0</td></tr>
<tr class="memdesc:acd2f064583c5bf45d65c5ff1369f0a5b"><td class="mdescLeft"> </td><td class="mdescRight">This callback happens when the <a class="el" href="classValueTree.html" title="A powerful tree structure that can be used to hold free-form data, and which can handle its own undo ...">ValueTree</a> changes and the given state-change message needs to be applied to any other trees that need to stay in sync with it. <a href="#acd2f064583c5bf45d65c5ff1369f0a5b">More...</a><br /></td></tr>
<tr class="separator:acd2f064583c5bf45d65c5ff1369f0a5b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6e39d8dfd2653907078f91d79eb81dd5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classValueTreeSynchroniser.html#a6e39d8dfd2653907078f91d79eb81dd5">sendFullSyncCallback</a> ()</td></tr>
<tr class="memdesc:a6e39d8dfd2653907078f91d79eb81dd5"><td class="mdescLeft"> </td><td class="mdescRight">Forces the sending of a full state message, which may be large, as it encodes the entire <a class="el" href="classValueTree.html" title="A powerful tree structure that can be used to hold free-form data, and which can handle its own undo ...">ValueTree</a>. <a href="#a6e39d8dfd2653907078f91d79eb81dd5">More...</a><br /></td></tr>
<tr class="separator:a6e39d8dfd2653907078f91d79eb81dd5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac1ec42c492653823573c25f6892764e9"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classValueTree.html">ValueTree</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classValueTreeSynchroniser.html#ac1ec42c492653823573c25f6892764e9">getRoot</a> () noexcept</td></tr>
<tr class="memdesc:ac1ec42c492653823573c25f6892764e9"><td class="mdescLeft"> </td><td class="mdescRight">Returns the root <a class="el" href="classValueTree.html" title="A powerful tree structure that can be used to hold free-form data, and which can handle its own undo ...">ValueTree</a> that is being observed. <a href="#ac1ec42c492653823573c25f6892764e9">More...</a><br /></td></tr>
<tr class="separator:ac1ec42c492653823573c25f6892764e9"><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:a987b026099f040bd1fb85a5ee1431fe3"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classValueTreeSynchroniser.html#a987b026099f040bd1fb85a5ee1431fe3">applyChange</a> (<a class="el" href="classValueTree.html">ValueTree</a> &target, const void *encodedChangeData, size_t encodedChangeDataSize, <a class="el" href="classUndoManager.html">UndoManager</a> *undoManager)</td></tr>
<tr class="memdesc:a987b026099f040bd1fb85a5ee1431fe3"><td class="mdescLeft"> </td><td class="mdescRight">Applies an encoded change to the given destination tree. <a href="#a987b026099f040bd1fb85a5ee1431fe3">More...</a><br /></td></tr>
<tr class="separator:a987b026099f040bd1fb85a5ee1431fe3"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class can be used to watch for all changes to the state of a <a class="el" href="classValueTree.html" title="A powerful tree structure that can be used to hold free-form data, and which can handle its own undo ...">ValueTree</a>, and to convert them to a transmittable binary encoding. </p>
<p>The purpose of this class is to allow two or more ValueTrees to be remotely synchronised by transmitting encoded changes over some kind of transport mechanism.</p>
<p>To use it, you'll need to implement a subclass of <a class="el" href="classValueTreeSynchroniser.html" title="This class can be used to watch for all changes to the state of a ValueTree, and to convert them to a...">ValueTreeSynchroniser</a> and implement the <a class="el" href="classValueTreeSynchroniser.html#acd2f064583c5bf45d65c5ff1369f0a5b" title="This callback happens when the ValueTree changes and the given state-change message needs to be appli...">stateChanged()</a> method to transmit the encoded change (maybe via a network or other means) to a remote destination, where it can be applied to a target tree. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a85fc71c5c6f74a970ff2b0f45d0a679b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85fc71c5c6f74a970ff2b0f45d0a679b">§ </a></span>ValueTreeSynchroniser()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ValueTreeSynchroniser::ValueTreeSynchroniser </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classValueTree.html">ValueTree</a> & </td>
<td class="paramname"><em>tree</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="classValueTreeSynchroniser.html" title="This class can be used to watch for all changes to the state of a ValueTree, and to convert them to a...">ValueTreeSynchroniser</a> that watches the given tree. </p>
<p>After creating an instance of this class and somehow attaching it to a target tree, you probably want to call <a class="el" href="classValueTreeSynchroniser.html#a6e39d8dfd2653907078f91d79eb81dd5" title="Forces the sending of a full state message, which may be large, as it encodes the entire ValueTree...">sendFullSyncCallback()</a> to get them into a common starting state. </p>
</div>
</div>
<a id="ae0719684d20eee3d640551cef6c75e72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0719684d20eee3d640551cef6c75e72">§ </a></span>~ValueTreeSynchroniser()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ValueTreeSynchroniser::~ValueTreeSynchroniser </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="acd2f064583c5bf45d65c5ff1369f0a5b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd2f064583c5bf45d65c5ff1369f0a5b">§ </a></span>stateChanged()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ValueTreeSynchroniser::stateChanged </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>encodedChange</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>encodedChangeSize</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This callback happens when the <a class="el" href="classValueTree.html" title="A powerful tree structure that can be used to hold free-form data, and which can handle its own undo ...">ValueTree</a> changes and the given state-change message needs to be applied to any other trees that need to stay in sync with it. </p>
<p>The data is an opaque blob of binary that you should transmit to wherever your target tree lives, and use <a class="el" href="classValueTreeSynchroniser.html#a987b026099f040bd1fb85a5ee1431fe3" title="Applies an encoded change to the given destination tree. ">applyChange()</a> to apply this to the target tree. </p>
</div>
</div>
<a id="a6e39d8dfd2653907078f91d79eb81dd5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e39d8dfd2653907078f91d79eb81dd5">§ </a></span>sendFullSyncCallback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ValueTreeSynchroniser::sendFullSyncCallback </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Forces the sending of a full state message, which may be large, as it encodes the entire <a class="el" href="classValueTree.html" title="A powerful tree structure that can be used to hold free-form data, and which can handle its own undo ...">ValueTree</a>. </p>
<p>This will internally invoke <a class="el" href="classValueTreeSynchroniser.html#acd2f064583c5bf45d65c5ff1369f0a5b" title="This callback happens when the ValueTree changes and the given state-change message needs to be appli...">stateChanged()</a> with the encoded version of the state. </p>
</div>
</div>
<a id="a987b026099f040bd1fb85a5ee1431fe3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a987b026099f040bd1fb85a5ee1431fe3">§ </a></span>applyChange()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool ValueTreeSynchroniser::applyChange </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classValueTree.html">ValueTree</a> & </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>encodedChangeData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>encodedChangeDataSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classUndoManager.html">UndoManager</a> * </td>
<td class="paramname"><em>undoManager</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Applies an encoded change to the given destination tree. </p>
<p>When you implement a receiver for changes that were sent by the <a class="el" href="classValueTreeSynchroniser.html#acd2f064583c5bf45d65c5ff1369f0a5b" title="This callback happens when the ValueTree changes and the given state-change message needs to be appli...">stateChanged()</a> message, this is the function that you'll need to call to apply them to the target tree that you want to be synced. </p>
</div>
</div>
<a id="ac1ec42c492653823573c25f6892764e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1ec42c492653823573c25f6892764e9">§ </a></span>getRoot()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classValueTree.html">ValueTree</a>& ValueTreeSynchroniser::getRoot </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>Returns the root <a class="el" href="classValueTree.html" title="A powerful tree structure that can be used to hold free-form data, and which can handle its own undo ...">ValueTree</a> that is being observed. </p>
<p>References <a class="el" href="juce__PlatformDefs_8h.html#a851b02724a8158a7f746c66b5758b3dd">JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR</a>, <a class="el" href="classValueTree_1_1Listener.html#abd937fd4a9a57124ff6c68bd49ce9b67">ValueTree::Listener::valueTreeChildAdded()</a>, <a class="el" href="classValueTree_1_1Listener.html#aa0926793951c23e37218ff7a88f97680">ValueTree::Listener::valueTreeChildOrderChanged()</a>, <a class="el" href="classValueTree_1_1Listener.html#af398254dea149b4cce8b4dd77f0f9f50">ValueTree::Listener::valueTreeChildRemoved()</a>, <a class="el" href="classValueTree_1_1Listener.html#a597ebac03d1095a618843fdcc3573b21">ValueTree::Listener::valueTreeParentChanged()</a>, and <a class="el" href="classValueTree_1_1Listener.html#aea6d5afc919eab727e0bdb6668f4a245">ValueTree::Listener::valueTreePropertyChanged()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__ValueTreeSynchroniser_8h.html">juce_ValueTreeSynchroniser.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|