/usr/share/doc/libjuce/apiref/classUndoableAction.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 | <!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: UndoableAction 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="classUndoableAction-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">UndoableAction Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Used by the <a class="el" href="classUndoManager.html" title="Manages a list of undo/redo commands. ">UndoManager</a> class to store an action which can be done and undone.
<a href="classUndoableAction.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:ae1567cc5931e990c2a2912f47808593b"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoableAction.html#ae1567cc5931e990c2a2912f47808593b">~UndoableAction</a> ()</td></tr>
<tr class="memdesc:ae1567cc5931e990c2a2912f47808593b"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ae1567cc5931e990c2a2912f47808593b">More...</a><br /></td></tr>
<tr class="separator:ae1567cc5931e990c2a2912f47808593b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6411ef8343148b52fef4bdc0290dfe06"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoableAction.html#a6411ef8343148b52fef4bdc0290dfe06">perform</a> ()=0</td></tr>
<tr class="memdesc:a6411ef8343148b52fef4bdc0290dfe06"><td class="mdescLeft"> </td><td class="mdescRight">Overridden by a subclass to perform the action. <a href="#a6411ef8343148b52fef4bdc0290dfe06">More...</a><br /></td></tr>
<tr class="separator:a6411ef8343148b52fef4bdc0290dfe06"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a535a5ca2bdc00edebe2b868ec7c13482"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoableAction.html#a535a5ca2bdc00edebe2b868ec7c13482">undo</a> ()=0</td></tr>
<tr class="memdesc:a535a5ca2bdc00edebe2b868ec7c13482"><td class="mdescLeft"> </td><td class="mdescRight">Overridden by a subclass to undo the action. <a href="#a535a5ca2bdc00edebe2b868ec7c13482">More...</a><br /></td></tr>
<tr class="separator:a535a5ca2bdc00edebe2b868ec7c13482"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a77613c64378930b1af6255ea5ec8df0d"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoableAction.html#a77613c64378930b1af6255ea5ec8df0d">getSizeInUnits</a> ()</td></tr>
<tr class="memdesc:a77613c64378930b1af6255ea5ec8df0d"><td class="mdescLeft"> </td><td class="mdescRight">Returns a value to indicate how much memory this object takes up. <a href="#a77613c64378930b1af6255ea5ec8df0d">More...</a><br /></td></tr>
<tr class="separator:a77613c64378930b1af6255ea5ec8df0d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ca68fbe4905168d985c7a30a9ca266d"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classUndoableAction.html">UndoableAction</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoableAction.html#a7ca68fbe4905168d985c7a30a9ca266d">createCoalescedAction</a> (<a class="el" href="classUndoableAction.html">UndoableAction</a> *nextAction)</td></tr>
<tr class="memdesc:a7ca68fbe4905168d985c7a30a9ca266d"><td class="mdescLeft"> </td><td class="mdescRight">Allows multiple actions to be coalesced into a single action object, to reduce storage space. <a href="#a7ca68fbe4905168d985c7a30a9ca266d">More...</a><br /></td></tr>
<tr class="separator:a7ca68fbe4905168d985c7a30a9ca266d"><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:abf39d7ee8e52523f0583dd3857ad86d6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoableAction.html#abf39d7ee8e52523f0583dd3857ad86d6">UndoableAction</a> () noexcept</td></tr>
<tr class="memdesc:abf39d7ee8e52523f0583dd3857ad86d6"><td class="mdescLeft"> </td><td class="mdescRight">Creates an action. <a href="#abf39d7ee8e52523f0583dd3857ad86d6">More...</a><br /></td></tr>
<tr class="separator:abf39d7ee8e52523f0583dd3857ad86d6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Used by the <a class="el" href="classUndoManager.html" title="Manages a list of undo/redo commands. ">UndoManager</a> class to store an action which can be done and undone. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classUndoManager.html" title="Manages a list of undo/redo commands. ">UndoManager</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="abf39d7ee8e52523f0583dd3857ad86d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf39d7ee8e52523f0583dd3857ad86d6">§ </a></span>UndoableAction()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">UndoableAction::UndoableAction </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 an action. </p>
</div>
</div>
<a id="ae1567cc5931e990c2a2912f47808593b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1567cc5931e990c2a2912f47808593b">§ </a></span>~UndoableAction()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual UndoableAction::~UndoableAction </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>
<p>References <a class="el" href="namespaceStandardApplicationCommandIDs.html#ad348cc9beaaea88093769e2da468320aa5b866e822eb795f30f0c77ebecc84f7f">StandardApplicationCommandIDs::undo</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a6411ef8343148b52fef4bdc0290dfe06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6411ef8343148b52fef4bdc0290dfe06">§ </a></span>perform()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool UndoableAction::perform </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>Overridden by a subclass to perform the action. </p>
<p>This method is called by the <a class="el" href="classUndoManager.html" title="Manages a list of undo/redo commands. ">UndoManager</a>, and shouldn't be used directly by applications.</p>
<p>Be careful not to make any calls in a <a class="el" href="classUndoableAction.html#a6411ef8343148b52fef4bdc0290dfe06" title="Overridden by a subclass to perform the action. ">perform()</a> method that could call recursively back into the <a class="el" href="classUndoManager.html#a5f8b51dbb061ca3a1a8916938e0e2f49" title="Performs an action and adds it to the undo history list. ">UndoManager::perform()</a> method</p>
<dl class="section return"><dt>Returns</dt><dd>true if the action could be performed. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classUndoManager.html#a5f8b51dbb061ca3a1a8916938e0e2f49" title="Performs an action and adds it to the undo history list. ">UndoManager::perform</a> </dd></dl>
</div>
</div>
<a id="a535a5ca2bdc00edebe2b868ec7c13482"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a535a5ca2bdc00edebe2b868ec7c13482">§ </a></span>undo()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool UndoableAction::undo </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>Overridden by a subclass to undo the action. </p>
<p>This method is called by the <a class="el" href="classUndoManager.html" title="Manages a list of undo/redo commands. ">UndoManager</a>, and shouldn't be used directly by applications.</p>
<p>Be careful not to make any calls in an <a class="el" href="classUndoableAction.html#a535a5ca2bdc00edebe2b868ec7c13482" title="Overridden by a subclass to undo the action. ">undo()</a> method that could call recursively back into the <a class="el" href="classUndoManager.html#a5f8b51dbb061ca3a1a8916938e0e2f49" title="Performs an action and adds it to the undo history list. ">UndoManager::perform()</a> method</p>
<dl class="section return"><dt>Returns</dt><dd>true if the action could be undone without any errors. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classUndoManager.html#a5f8b51dbb061ca3a1a8916938e0e2f49" title="Performs an action and adds it to the undo history list. ">UndoManager::perform</a> </dd></dl>
</div>
</div>
<a id="a77613c64378930b1af6255ea5ec8df0d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77613c64378930b1af6255ea5ec8df0d">§ </a></span>getSizeInUnits()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int UndoableAction::getSizeInUnits </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>Returns a value to indicate how much memory this object takes up. </p>
<p>Because the <a class="el" href="classUndoManager.html" title="Manages a list of undo/redo commands. ">UndoManager</a> keeps a list of UndoableActions, this is used to work out how much space each one will take up, so that the <a class="el" href="classUndoManager.html" title="Manages a list of undo/redo commands. ">UndoManager</a> can work out how many to keep.</p>
<p>The default value returned here is 10 - units are arbitrary and don't have to be accurate.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classUndoManager.html#aa9665feaecf58905d1dc515dc2f24893" title="Returns the current amount of space to use for storing UndoableAction objects. ">UndoManager::getNumberOfUnitsTakenUpByStoredCommands</a>, <a class="el" href="classUndoManager.html#a371dddb00a010caf5e3bb88d4009bdfb" title="Sets the amount of space that can be used for storing UndoableAction objects. ">UndoManager::setMaxNumberOfStoredUnits</a> </dd></dl>
</div>
</div>
<a id="a7ca68fbe4905168d985c7a30a9ca266d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ca68fbe4905168d985c7a30a9ca266d">§ </a></span>createCoalescedAction()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classUndoableAction.html">UndoableAction</a>* UndoableAction::createCoalescedAction </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classUndoableAction.html">UndoableAction</a> * </td>
<td class="paramname"><em>nextAction</em></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>Allows multiple actions to be coalesced into a single action object, to reduce storage space. </p>
<p>If possible, this method should create and return a single action that does the same job as this one followed by the supplied action.</p>
<p>If it's not possible to merge the two actions, the method should return a nullptr. </p>
<p>References <a class="el" href="juce__MathsFunctions_8h.html#a07a40f89c351c7e7a7f98a62beaa1e4a">ignoreUnused()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__UndoableAction_8h.html">juce_UndoableAction.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|