/usr/share/doc/libjuce/apiref/classUndoManager.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 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 | <!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: UndoManager 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="classUndoManager-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">UndoManager Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Manages a list of undo/redo commands.
<a href="classUndoManager.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 UndoManager:</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="classUndoManager.png" usemap="#UndoManager_map" alt=""/>
<map id="UndoManager_map" name="UndoManager_map">
<area href="classChangeBroadcaster.html" title="Holds a list of ChangeListeners, and sends messages to them when instructed. " alt="ChangeBroadcaster" shape="rect" coords="0,0,125,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:a80479ce847ec1ac8cccb8bdf5bb5729e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoManager.html#a80479ce847ec1ac8cccb8bdf5bb5729e">UndoManager</a> (int maxNumberOfUnitsToKeep=30000, int minimumTransactionsToKeep=30)</td></tr>
<tr class="memdesc:a80479ce847ec1ac8cccb8bdf5bb5729e"><td class="mdescLeft"> </td><td class="mdescRight">Creates an <a class="el" href="classUndoManager.html" title="Manages a list of undo/redo commands. ">UndoManager</a>. <a href="#a80479ce847ec1ac8cccb8bdf5bb5729e">More...</a><br /></td></tr>
<tr class="separator:a80479ce847ec1ac8cccb8bdf5bb5729e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8d02b39eef79a885fb71be93ddac1115"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoManager.html#a8d02b39eef79a885fb71be93ddac1115">~UndoManager</a> ()</td></tr>
<tr class="memdesc:a8d02b39eef79a885fb71be93ddac1115"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a8d02b39eef79a885fb71be93ddac1115">More...</a><br /></td></tr>
<tr class="separator:a8d02b39eef79a885fb71be93ddac1115"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a14ecaa1dcab72d09ccb826bc7a0d2743"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoManager.html#a14ecaa1dcab72d09ccb826bc7a0d2743">clearUndoHistory</a> ()</td></tr>
<tr class="memdesc:a14ecaa1dcab72d09ccb826bc7a0d2743"><td class="mdescLeft"> </td><td class="mdescRight">Deletes all stored actions in the list. <a href="#a14ecaa1dcab72d09ccb826bc7a0d2743">More...</a><br /></td></tr>
<tr class="separator:a14ecaa1dcab72d09ccb826bc7a0d2743"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa9665feaecf58905d1dc515dc2f24893"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoManager.html#aa9665feaecf58905d1dc515dc2f24893">getNumberOfUnitsTakenUpByStoredCommands</a> () const</td></tr>
<tr class="memdesc:aa9665feaecf58905d1dc515dc2f24893"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current amount of space to use for storing <a class="el" href="classUndoableAction.html" title="Used by the UndoManager class to store an action which can be done and undone. ">UndoableAction</a> objects. <a href="#aa9665feaecf58905d1dc515dc2f24893">More...</a><br /></td></tr>
<tr class="separator:aa9665feaecf58905d1dc515dc2f24893"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a371dddb00a010caf5e3bb88d4009bdfb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoManager.html#a371dddb00a010caf5e3bb88d4009bdfb">setMaxNumberOfStoredUnits</a> (int maxNumberOfUnitsToKeep, int minimumTransactionsToKeep)</td></tr>
<tr class="memdesc:a371dddb00a010caf5e3bb88d4009bdfb"><td class="mdescLeft"> </td><td class="mdescRight">Sets the amount of space that can be used for storing <a class="el" href="classUndoableAction.html" title="Used by the UndoManager class to store an action which can be done and undone. ">UndoableAction</a> objects. <a href="#a371dddb00a010caf5e3bb88d4009bdfb">More...</a><br /></td></tr>
<tr class="separator:a371dddb00a010caf5e3bb88d4009bdfb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f8b51dbb061ca3a1a8916938e0e2f49"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoManager.html#a5f8b51dbb061ca3a1a8916938e0e2f49">perform</a> (<a class="el" href="classUndoableAction.html">UndoableAction</a> *action)</td></tr>
<tr class="memdesc:a5f8b51dbb061ca3a1a8916938e0e2f49"><td class="mdescLeft"> </td><td class="mdescRight">Performs an action and adds it to the undo history list. <a href="#a5f8b51dbb061ca3a1a8916938e0e2f49">More...</a><br /></td></tr>
<tr class="separator:a5f8b51dbb061ca3a1a8916938e0e2f49"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad38696c85f0e94c58d70a83167b1153c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoManager.html#ad38696c85f0e94c58d70a83167b1153c">perform</a> (<a class="el" href="classUndoableAction.html">UndoableAction</a> *action, const <a class="el" href="classString.html">String</a> &actionName)</td></tr>
<tr class="memdesc:ad38696c85f0e94c58d70a83167b1153c"><td class="mdescLeft"> </td><td class="mdescRight">Performs an action and also gives it a name. <a href="#ad38696c85f0e94c58d70a83167b1153c">More...</a><br /></td></tr>
<tr class="separator:ad38696c85f0e94c58d70a83167b1153c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae05cd5e09da8e1208bd82a4d2d433e74"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoManager.html#ae05cd5e09da8e1208bd82a4d2d433e74">beginNewTransaction</a> () noexcept</td></tr>
<tr class="memdesc:ae05cd5e09da8e1208bd82a4d2d433e74"><td class="mdescLeft"> </td><td class="mdescRight">Starts a new group of actions that together will be treated as a single transaction. <a href="#ae05cd5e09da8e1208bd82a4d2d433e74">More...</a><br /></td></tr>
<tr class="separator:ae05cd5e09da8e1208bd82a4d2d433e74"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae0c60270c6e99ec4b2b77b91380dd963"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoManager.html#ae0c60270c6e99ec4b2b77b91380dd963">beginNewTransaction</a> (const <a class="el" href="classString.html">String</a> &actionName) noexcept</td></tr>
<tr class="memdesc:ae0c60270c6e99ec4b2b77b91380dd963"><td class="mdescLeft"> </td><td class="mdescRight">Starts a new group of actions that together will be treated as a single transaction. <a href="#ae0c60270c6e99ec4b2b77b91380dd963">More...</a><br /></td></tr>
<tr class="separator:ae0c60270c6e99ec4b2b77b91380dd963"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6ea5eee5bf4bb54640318a4a01752b88"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoManager.html#a6ea5eee5bf4bb54640318a4a01752b88">setCurrentTransactionName</a> (const <a class="el" href="classString.html">String</a> &newName) noexcept</td></tr>
<tr class="memdesc:a6ea5eee5bf4bb54640318a4a01752b88"><td class="mdescLeft"> </td><td class="mdescRight">Changes the name stored for the current transaction. <a href="#a6ea5eee5bf4bb54640318a4a01752b88">More...</a><br /></td></tr>
<tr class="separator:a6ea5eee5bf4bb54640318a4a01752b88"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae3b3855a4b265f53082522952210138b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoManager.html#ae3b3855a4b265f53082522952210138b">getCurrentTransactionName</a> () const noexcept</td></tr>
<tr class="memdesc:ae3b3855a4b265f53082522952210138b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the current transaction. <a href="#ae3b3855a4b265f53082522952210138b">More...</a><br /></td></tr>
<tr class="separator:ae3b3855a4b265f53082522952210138b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a001384b3068589de6564796f7e43864e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoManager.html#a001384b3068589de6564796f7e43864e">canUndo</a> () const noexcept</td></tr>
<tr class="memdesc:a001384b3068589de6564796f7e43864e"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if there's at least one action in the list to undo. <a href="#a001384b3068589de6564796f7e43864e">More...</a><br /></td></tr>
<tr class="separator:a001384b3068589de6564796f7e43864e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a92646d4d9b759313bc835d6bd35d3cb7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoManager.html#a92646d4d9b759313bc835d6bd35d3cb7">getUndoDescription</a> () const</td></tr>
<tr class="memdesc:a92646d4d9b759313bc835d6bd35d3cb7"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the transaction that will be rolled-back when <a class="el" href="classUndoManager.html#a39f45c284e8d0df1a0d378e676246931" title="Tries to roll-back the last transaction. ">undo()</a> is called. <a href="#a92646d4d9b759313bc835d6bd35d3cb7">More...</a><br /></td></tr>
<tr class="separator:a92646d4d9b759313bc835d6bd35d3cb7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a39f45c284e8d0df1a0d378e676246931"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoManager.html#a39f45c284e8d0df1a0d378e676246931">undo</a> ()</td></tr>
<tr class="memdesc:a39f45c284e8d0df1a0d378e676246931"><td class="mdescLeft"> </td><td class="mdescRight">Tries to roll-back the last transaction. <a href="#a39f45c284e8d0df1a0d378e676246931">More...</a><br /></td></tr>
<tr class="separator:a39f45c284e8d0df1a0d378e676246931"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad81c6649e3acc3ab36726c280058d6bb"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoManager.html#ad81c6649e3acc3ab36726c280058d6bb">undoCurrentTransactionOnly</a> ()</td></tr>
<tr class="memdesc:ad81c6649e3acc3ab36726c280058d6bb"><td class="mdescLeft"> </td><td class="mdescRight">Tries to roll-back any actions that were added to the current transaction. <a href="#ad81c6649e3acc3ab36726c280058d6bb">More...</a><br /></td></tr>
<tr class="separator:ad81c6649e3acc3ab36726c280058d6bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acfdf8915b31ec38c484f10d7fcb9d8fb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoManager.html#acfdf8915b31ec38c484f10d7fcb9d8fb">getActionsInCurrentTransaction</a> (<a class="el" href="classArray.html">Array</a>< const <a class="el" href="classUndoableAction.html">UndoableAction</a> *> &actionsFound) const</td></tr>
<tr class="memdesc:acfdf8915b31ec38c484f10d7fcb9d8fb"><td class="mdescLeft"> </td><td class="mdescRight">Returns a list of the <a class="el" href="classUndoableAction.html" title="Used by the UndoManager class to store an action which can be done and undone. ">UndoableAction</a> objects that have been performed during the transaction that is currently open. <a href="#acfdf8915b31ec38c484f10d7fcb9d8fb">More...</a><br /></td></tr>
<tr class="separator:acfdf8915b31ec38c484f10d7fcb9d8fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeaa886c6d975e9326a12f739dddf654e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoManager.html#aeaa886c6d975e9326a12f739dddf654e">getNumActionsInCurrentTransaction</a> () const</td></tr>
<tr class="memdesc:aeaa886c6d975e9326a12f739dddf654e"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of <a class="el" href="classUndoableAction.html" title="Used by the UndoManager class to store an action which can be done and undone. ">UndoableAction</a> objects that have been performed during the transaction that is currently open. <a href="#aeaa886c6d975e9326a12f739dddf654e">More...</a><br /></td></tr>
<tr class="separator:aeaa886c6d975e9326a12f739dddf654e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0c85cc5e3365b6657621b0a206f02278"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTime.html">Time</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoManager.html#a0c85cc5e3365b6657621b0a206f02278">getTimeOfUndoTransaction</a> () const</td></tr>
<tr class="memdesc:a0c85cc5e3365b6657621b0a206f02278"><td class="mdescLeft"> </td><td class="mdescRight">Returns the time to which the state would be restored if <a class="el" href="classUndoManager.html#a39f45c284e8d0df1a0d378e676246931" title="Tries to roll-back the last transaction. ">undo()</a> was to be called. <a href="#a0c85cc5e3365b6657621b0a206f02278">More...</a><br /></td></tr>
<tr class="separator:a0c85cc5e3365b6657621b0a206f02278"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad96854c33ac388cf363b4c5c83363c0b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTime.html">Time</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoManager.html#ad96854c33ac388cf363b4c5c83363c0b">getTimeOfRedoTransaction</a> () const</td></tr>
<tr class="memdesc:ad96854c33ac388cf363b4c5c83363c0b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the time to which the state would be restored if <a class="el" href="classUndoManager.html#aaea507a3b9eaea3360c0e393edf69ccb" title="Tries to redo the last transaction that was undone. ">redo()</a> was to be called. <a href="#ad96854c33ac388cf363b4c5c83363c0b">More...</a><br /></td></tr>
<tr class="separator:ad96854c33ac388cf363b4c5c83363c0b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a5d1d64c3e774db76047c17b0408067"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoManager.html#a2a5d1d64c3e774db76047c17b0408067">canRedo</a> () const noexcept</td></tr>
<tr class="memdesc:a2a5d1d64c3e774db76047c17b0408067"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if there's at least one action in the list to redo. <a href="#a2a5d1d64c3e774db76047c17b0408067">More...</a><br /></td></tr>
<tr class="separator:a2a5d1d64c3e774db76047c17b0408067"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aadc8eb18f4cc2a7e77e16aee8cba6292"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoManager.html#aadc8eb18f4cc2a7e77e16aee8cba6292">getRedoDescription</a> () const</td></tr>
<tr class="memdesc:aadc8eb18f4cc2a7e77e16aee8cba6292"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the transaction that will be redone when <a class="el" href="classUndoManager.html#aaea507a3b9eaea3360c0e393edf69ccb" title="Tries to redo the last transaction that was undone. ">redo()</a> is called. <a href="#aadc8eb18f4cc2a7e77e16aee8cba6292">More...</a><br /></td></tr>
<tr class="separator:aadc8eb18f4cc2a7e77e16aee8cba6292"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaea507a3b9eaea3360c0e393edf69ccb"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classUndoManager.html#aaea507a3b9eaea3360c0e393edf69ccb">redo</a> ()</td></tr>
<tr class="memdesc:aaea507a3b9eaea3360c0e393edf69ccb"><td class="mdescLeft"> </td><td class="mdescRight">Tries to redo the last transaction that was undone. <a href="#aaea507a3b9eaea3360c0e393edf69ccb">More...</a><br /></td></tr>
<tr class="separator:aaea507a3b9eaea3360c0e393edf69ccb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classChangeBroadcaster"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classChangeBroadcaster')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classChangeBroadcaster.html">ChangeBroadcaster</a></td></tr>
<tr class="memitem:a1c8ccfa186a47d58a05e7f1f1576c038 inherit pub_methods_classChangeBroadcaster"><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 inherit pub_methods_classChangeBroadcaster"><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="classChangeBroadcaster.html#a1c8ccfa186a47d58a05e7f1f1576c038">More...</a><br /></td></tr>
<tr class="separator:a1c8ccfa186a47d58a05e7f1f1576c038 inherit pub_methods_classChangeBroadcaster"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3b2f8465cc6c09c0583c8bdf56319742 inherit pub_methods_classChangeBroadcaster"><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 inherit pub_methods_classChangeBroadcaster"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="classChangeBroadcaster.html#a3b2f8465cc6c09c0583c8bdf56319742">More...</a><br /></td></tr>
<tr class="separator:a3b2f8465cc6c09c0583c8bdf56319742 inherit pub_methods_classChangeBroadcaster"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad68416fe79a94cd5c99519bdea6c2a06 inherit pub_methods_classChangeBroadcaster"><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 inherit pub_methods_classChangeBroadcaster"><td class="mdescLeft"> </td><td class="mdescRight">Registers a listener to receive change callbacks from this broadcaster. <a href="classChangeBroadcaster.html#ad68416fe79a94cd5c99519bdea6c2a06">More...</a><br /></td></tr>
<tr class="separator:ad68416fe79a94cd5c99519bdea6c2a06 inherit pub_methods_classChangeBroadcaster"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae558a26c795278549a63e342bd5f1650 inherit pub_methods_classChangeBroadcaster"><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 inherit pub_methods_classChangeBroadcaster"><td class="mdescLeft"> </td><td class="mdescRight">Unregisters a listener from the list. <a href="classChangeBroadcaster.html#ae558a26c795278549a63e342bd5f1650">More...</a><br /></td></tr>
<tr class="separator:ae558a26c795278549a63e342bd5f1650 inherit pub_methods_classChangeBroadcaster"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b9c150078318d419debc82e6f22ce58 inherit pub_methods_classChangeBroadcaster"><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 inherit pub_methods_classChangeBroadcaster"><td class="mdescLeft"> </td><td class="mdescRight">Removes all listeners from the list. <a href="classChangeBroadcaster.html#a6b9c150078318d419debc82e6f22ce58">More...</a><br /></td></tr>
<tr class="separator:a6b9c150078318d419debc82e6f22ce58 inherit pub_methods_classChangeBroadcaster"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a10f01d1c0a7fde85355321985a682cbd inherit pub_methods_classChangeBroadcaster"><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 inherit pub_methods_classChangeBroadcaster"><td class="mdescLeft"> </td><td class="mdescRight">Causes an asynchronous change message to be sent to all the registered listeners. <a href="classChangeBroadcaster.html#a10f01d1c0a7fde85355321985a682cbd">More...</a><br /></td></tr>
<tr class="separator:a10f01d1c0a7fde85355321985a682cbd inherit pub_methods_classChangeBroadcaster"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5d16cd01b9af4bacb1716530af17f77b inherit pub_methods_classChangeBroadcaster"><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 inherit pub_methods_classChangeBroadcaster"><td class="mdescLeft"> </td><td class="mdescRight">Sends a synchronous change message to all the registered listeners. <a href="classChangeBroadcaster.html#a5d16cd01b9af4bacb1716530af17f77b">More...</a><br /></td></tr>
<tr class="separator:a5d16cd01b9af4bacb1716530af17f77b inherit pub_methods_classChangeBroadcaster"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a78f62ecd57a016f8ba7a6ce55454947d inherit pub_methods_classChangeBroadcaster"><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 inherit pub_methods_classChangeBroadcaster"><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="classChangeBroadcaster.html#a78f62ecd57a016f8ba7a6ce55454947d">More...</a><br /></td></tr>
<tr class="separator:a78f62ecd57a016f8ba7a6ce55454947d inherit pub_methods_classChangeBroadcaster"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Manages a list of undo/redo commands. </p>
<p>An <a class="el" href="classUndoManager.html" title="Manages a list of undo/redo commands. ">UndoManager</a> object keeps a list of past actions and can use these actions to move backwards and forwards through an undo history.</p>
<p>To use it, create subclasses of <a class="el" href="classUndoableAction.html" title="Used by the UndoManager class to store an action which can be done and undone. ">UndoableAction</a> which perform all the actions you need, then when you need to actually perform an action, create one and pass it to the <a class="el" href="classUndoManager.html" title="Manages a list of undo/redo commands. ">UndoManager</a>'s <a class="el" href="classUndoManager.html#a5f8b51dbb061ca3a1a8916938e0e2f49" title="Performs an action and adds it to the undo history list. ">perform()</a> method.</p>
<p>The manager also uses the concept of 'transactions' to group the actions together - all actions performed between calls to <a class="el" href="classUndoManager.html#ae05cd5e09da8e1208bd82a4d2d433e74" title="Starts a new group of actions that together will be treated as a single transaction. ">beginNewTransaction()</a> are grouped together and are all undone/redone as a group.</p>
<p>The <a class="el" href="classUndoManager.html" title="Manages a list of undo/redo commands. ">UndoManager</a> is a <a class="el" href="classChangeBroadcaster.html" title="Holds a list of ChangeListeners, and sends messages to them when instructed. ">ChangeBroadcaster</a>, so listeners can register to be told when actions are performed or undone.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classUndoableAction.html" title="Used by the UndoManager class to store an action which can be done and undone. ">UndoableAction</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a80479ce847ec1ac8cccb8bdf5bb5729e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80479ce847ec1ac8cccb8bdf5bb5729e">§ </a></span>UndoManager()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">UndoManager::UndoManager </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>maxNumberOfUnitsToKeep</em> = <code>30000</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>minimumTransactionsToKeep</em> = <code>30</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an <a class="el" href="classUndoManager.html" title="Manages a list of undo/redo commands. ">UndoManager</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">maxNumberOfUnitsToKeep</td><td>each <a class="el" href="classUndoableAction.html" title="Used by the UndoManager class to store an action which can be done and undone. ">UndoableAction</a> object returns a value to indicate how much storage it takes up (<a class="el" href="classUndoableAction.html#a77613c64378930b1af6255ea5ec8df0d" title="Returns a value to indicate how much memory this object takes up. ">UndoableAction::getSizeInUnits()</a>), so this lets you specify the maximum total number of units that the undomanager is allowed to keep in memory before letting the older actions drop off the end of the list. </td></tr>
<tr><td class="paramname">minimumTransactionsToKeep</td><td>this specifies the minimum number of transactions that will be kept, even if this involves exceeding the amount of space specified in maxNumberOfUnitsToKeep </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8d02b39eef79a885fb71be93ddac1115"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d02b39eef79a885fb71be93ddac1115">§ </a></span>~UndoManager()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">UndoManager::~UndoManager </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a14ecaa1dcab72d09ccb826bc7a0d2743"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14ecaa1dcab72d09ccb826bc7a0d2743">§ </a></span>clearUndoHistory()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void UndoManager::clearUndoHistory </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deletes all stored actions in the list. </p>
</div>
</div>
<a id="aa9665feaecf58905d1dc515dc2f24893"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9665feaecf58905d1dc515dc2f24893">§ </a></span>getNumberOfUnitsTakenUpByStoredCommands()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int UndoManager::getNumberOfUnitsTakenUpByStoredCommands </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the current amount of space to use for storing <a class="el" href="classUndoableAction.html" title="Used by the UndoManager class to store an action which can be done and undone. ">UndoableAction</a> objects. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classUndoManager.html#a371dddb00a010caf5e3bb88d4009bdfb" title="Sets the amount of space that can be used for storing UndoableAction objects. ">setMaxNumberOfStoredUnits</a> </dd></dl>
</div>
</div>
<a id="a371dddb00a010caf5e3bb88d4009bdfb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a371dddb00a010caf5e3bb88d4009bdfb">§ </a></span>setMaxNumberOfStoredUnits()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void UndoManager::setMaxNumberOfStoredUnits </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>maxNumberOfUnitsToKeep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>minimumTransactionsToKeep</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the amount of space that can be used for storing <a class="el" href="classUndoableAction.html" title="Used by the UndoManager class to store an action which can be done and undone. ">UndoableAction</a> objects. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">maxNumberOfUnitsToKeep</td><td>each <a class="el" href="classUndoableAction.html" title="Used by the UndoManager class to store an action which can be done and undone. ">UndoableAction</a> object returns a value to indicate how much storage it takes up (<a class="el" href="classUndoableAction.html#a77613c64378930b1af6255ea5ec8df0d" title="Returns a value to indicate how much memory this object takes up. ">UndoableAction::getSizeInUnits()</a>), so this lets you specify the maximum total number of units that the undomanager is allowed to keep in memory before letting the older actions drop off the end of the list. </td></tr>
<tr><td class="paramname">minimumTransactionsToKeep</td><td>this specifies the minimum number of transactions that will be kept, even if this involves exceeding the amount of space specified in maxNumberOfUnitsToKeep </td></tr>
</table>
</dd>
</dl>
<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. ">getNumberOfUnitsTakenUpByStoredCommands</a> </dd></dl>
</div>
</div>
<a id="a5f8b51dbb061ca3a1a8916938e0e2f49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f8b51dbb061ca3a1a8916938e0e2f49">§ </a></span>perform() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool UndoManager::perform </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classUndoableAction.html">UndoableAction</a> * </td>
<td class="paramname"><em>action</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs an action and adds it to the undo history list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">action</td><td>the action to perform - this object will be deleted by the <a class="el" href="classUndoManager.html" title="Manages a list of undo/redo commands. ">UndoManager</a> when no longer needed </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the command succeeds - see <a class="el" href="classUndoableAction.html#a6411ef8343148b52fef4bdc0290dfe06" title="Overridden by a subclass to perform the action. ">UndoableAction::perform</a> </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classUndoManager.html#ae05cd5e09da8e1208bd82a4d2d433e74" title="Starts a new group of actions that together will be treated as a single transaction. ">beginNewTransaction</a> </dd></dl>
</div>
</div>
<a id="ad38696c85f0e94c58d70a83167b1153c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad38696c85f0e94c58d70a83167b1153c">§ </a></span>perform() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool UndoManager::perform </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classUndoableAction.html">UndoableAction</a> * </td>
<td class="paramname"><em>action</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>actionName</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs an action and also gives it a name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">action</td><td>the action to perform - this object will be deleted by the <a class="el" href="classUndoManager.html" title="Manages a list of undo/redo commands. ">UndoManager</a> when no longer needed </td></tr>
<tr><td class="paramname">actionName</td><td>if this string is non-empty, the current transaction will be given this name; if it's empty, the current transaction name will be left unchanged. See <a class="el" href="classUndoManager.html#a6ea5eee5bf4bb54640318a4a01752b88" title="Changes the name stored for the current transaction. ">setCurrentTransactionName()</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the command succeeds - see <a class="el" href="classUndoableAction.html#a6411ef8343148b52fef4bdc0290dfe06" title="Overridden by a subclass to perform the action. ">UndoableAction::perform</a> </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classUndoManager.html#ae05cd5e09da8e1208bd82a4d2d433e74" title="Starts a new group of actions that together will be treated as a single transaction. ">beginNewTransaction</a> </dd></dl>
</div>
</div>
<a id="ae05cd5e09da8e1208bd82a4d2d433e74"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae05cd5e09da8e1208bd82a4d2d433e74">§ </a></span>beginNewTransaction() <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">void UndoManager::beginNewTransaction </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>Starts a new group of actions that together will be treated as a single transaction. </p>
<p>All actions that are passed to the <a class="el" href="classUndoManager.html#a5f8b51dbb061ca3a1a8916938e0e2f49" title="Performs an action and adds it to the undo history list. ">perform()</a> method between calls to this method are grouped together and undone/redone together by a single call to <a class="el" href="classUndoManager.html#a39f45c284e8d0df1a0d378e676246931" title="Tries to roll-back the last transaction. ">undo()</a> or <a class="el" href="classUndoManager.html#aaea507a3b9eaea3360c0e393edf69ccb" title="Tries to redo the last transaction that was undone. ">redo()</a>. </p>
</div>
</div>
<a id="ae0c60270c6e99ec4b2b77b91380dd963"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0c60270c6e99ec4b2b77b91380dd963">§ </a></span>beginNewTransaction() <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">void UndoManager::beginNewTransaction </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>actionName</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 a new group of actions that together will be treated as a single transaction. </p>
<p>All actions that are passed to the <a class="el" href="classUndoManager.html#a5f8b51dbb061ca3a1a8916938e0e2f49" title="Performs an action and adds it to the undo history list. ">perform()</a> method between calls to this method are grouped together and undone/redone together by a single call to <a class="el" href="classUndoManager.html#a39f45c284e8d0df1a0d378e676246931" title="Tries to roll-back the last transaction. ">undo()</a> or <a class="el" href="classUndoManager.html#aaea507a3b9eaea3360c0e393edf69ccb" title="Tries to redo the last transaction that was undone. ">redo()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">actionName</td><td>a description of the transaction that is about to be performed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6ea5eee5bf4bb54640318a4a01752b88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ea5eee5bf4bb54640318a4a01752b88">§ </a></span>setCurrentTransactionName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void UndoManager::setCurrentTransactionName </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>newName</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>Changes the name stored for the current transaction. </p>
<p>Each transaction is given a name when the <a class="el" href="classUndoManager.html#ae05cd5e09da8e1208bd82a4d2d433e74" title="Starts a new group of actions that together will be treated as a single transaction. ">beginNewTransaction()</a> method is called, but this can be used to change that name without starting a new transaction. </p>
</div>
</div>
<a id="ae3b3855a4b265f53082522952210138b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3b3855a4b265f53082522952210138b">§ </a></span>getCurrentTransactionName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classString.html">String</a> UndoManager::getCurrentTransactionName </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 name of the current transaction. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classUndoManager.html#a6ea5eee5bf4bb54640318a4a01752b88" title="Changes the name stored for the current transaction. ">setCurrentTransactionName</a> </dd></dl>
</div>
</div>
<a id="a001384b3068589de6564796f7e43864e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a001384b3068589de6564796f7e43864e">§ </a></span>canUndo()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool UndoManager::canUndo </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 there's at least one action in the list to undo. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classUndoManager.html#a92646d4d9b759313bc835d6bd35d3cb7" title="Returns the name of the transaction that will be rolled-back when undo() is called. ">getUndoDescription</a>, <a class="el" href="classUndoManager.html#a39f45c284e8d0df1a0d378e676246931" title="Tries to roll-back the last transaction. ">undo</a>, <a class="el" href="classUndoManager.html#a2a5d1d64c3e774db76047c17b0408067" title="Returns true if there's at least one action in the list to redo. ">canRedo</a> </dd></dl>
</div>
</div>
<a id="a92646d4d9b759313bc835d6bd35d3cb7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92646d4d9b759313bc835d6bd35d3cb7">§ </a></span>getUndoDescription()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classString.html">String</a> UndoManager::getUndoDescription </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the name of the transaction that will be rolled-back when <a class="el" href="classUndoManager.html#a39f45c284e8d0df1a0d378e676246931" title="Tries to roll-back the last transaction. ">undo()</a> is called. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classUndoManager.html#a39f45c284e8d0df1a0d378e676246931" title="Tries to roll-back the last transaction. ">undo</a> </dd></dl>
</div>
</div>
<a id="a39f45c284e8d0df1a0d378e676246931"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39f45c284e8d0df1a0d378e676246931">§ </a></span>undo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool UndoManager::undo </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tries to roll-back the last transaction. </p>
<dl class="section return"><dt>Returns</dt><dd>true if the transaction can be undone, and false if it fails, or if there aren't any transactions to undo </dd></dl>
</div>
</div>
<a id="ad81c6649e3acc3ab36726c280058d6bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad81c6649e3acc3ab36726c280058d6bb">§ </a></span>undoCurrentTransactionOnly()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool UndoManager::undoCurrentTransactionOnly </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tries to roll-back any actions that were added to the current transaction. </p>
<p>This will perform an <a class="el" href="classUndoManager.html#a39f45c284e8d0df1a0d378e676246931" title="Tries to roll-back the last transaction. ">undo()</a> only if there are some actions in the undo list that were added after the last call to <a class="el" href="classUndoManager.html#ae05cd5e09da8e1208bd82a4d2d433e74" title="Starts a new group of actions that together will be treated as a single transaction. ">beginNewTransaction()</a>.</p>
<p>This is useful because it lets you call <a class="el" href="classUndoManager.html#ae05cd5e09da8e1208bd82a4d2d433e74" title="Starts a new group of actions that together will be treated as a single transaction. ">beginNewTransaction()</a>, then perform an operation which may or may not actually perform some actions, and then call this method to get rid of any actions that might have been done without it rolling back the previous transaction if nothing was actually done.</p>
<dl class="section return"><dt>Returns</dt><dd>true if any actions were undone. </dd></dl>
</div>
</div>
<a id="acfdf8915b31ec38c484f10d7fcb9d8fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acfdf8915b31ec38c484f10d7fcb9d8fb">§ </a></span>getActionsInCurrentTransaction()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void UndoManager::getActionsInCurrentTransaction </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classArray.html">Array</a>< const <a class="el" href="classUndoableAction.html">UndoableAction</a> *> & </td>
<td class="paramname"><em>actionsFound</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a list of the <a class="el" href="classUndoableAction.html" title="Used by the UndoManager class to store an action which can be done and undone. ">UndoableAction</a> objects that have been performed during the transaction that is currently open. </p>
<p>Effectively, this is the list of actions that would be undone if <a class="el" href="classUndoManager.html#ad81c6649e3acc3ab36726c280058d6bb" title="Tries to roll-back any actions that were added to the current transaction. ">undoCurrentTransactionOnly()</a> were to be called now.</p>
<p>The first item in the list is the earliest action performed. </p>
</div>
</div>
<a id="aeaa886c6d975e9326a12f739dddf654e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeaa886c6d975e9326a12f739dddf654e">§ </a></span>getNumActionsInCurrentTransaction()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int UndoManager::getNumActionsInCurrentTransaction </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of <a class="el" href="classUndoableAction.html" title="Used by the UndoManager class to store an action which can be done and undone. ">UndoableAction</a> objects that have been performed during the transaction that is currently open. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classUndoManager.html#acfdf8915b31ec38c484f10d7fcb9d8fb" title="Returns a list of the UndoableAction objects that have been performed during the transaction that is ...">getActionsInCurrentTransaction</a> </dd></dl>
</div>
</div>
<a id="a0c85cc5e3365b6657621b0a206f02278"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c85cc5e3365b6657621b0a206f02278">§ </a></span>getTimeOfUndoTransaction()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTime.html">Time</a> UndoManager::getTimeOfUndoTransaction </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the time to which the state would be restored if <a class="el" href="classUndoManager.html#a39f45c284e8d0df1a0d378e676246931" title="Tries to roll-back the last transaction. ">undo()</a> was to be called. </p>
<p>If an undo isn't currently possible, it'll return <a class="el" href="classTime.html" title="Holds an absolute date and time. ">Time()</a>. </p>
</div>
</div>
<a id="ad96854c33ac388cf363b4c5c83363c0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad96854c33ac388cf363b4c5c83363c0b">§ </a></span>getTimeOfRedoTransaction()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTime.html">Time</a> UndoManager::getTimeOfRedoTransaction </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the time to which the state would be restored if <a class="el" href="classUndoManager.html#aaea507a3b9eaea3360c0e393edf69ccb" title="Tries to redo the last transaction that was undone. ">redo()</a> was to be called. </p>
<p>If a redo isn't currently possible, it'll return <a class="el" href="classTime.html#abc76e37eb137734df20c107ae94bbfee" title="Returns a Time object that is set to the current system time. ">Time::getCurrentTime()</a>. </p>
</div>
</div>
<a id="a2a5d1d64c3e774db76047c17b0408067"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a5d1d64c3e774db76047c17b0408067">§ </a></span>canRedo()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool UndoManager::canRedo </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 there's at least one action in the list to redo. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classUndoManager.html#aadc8eb18f4cc2a7e77e16aee8cba6292" title="Returns the name of the transaction that will be redone when redo() is called. ">getRedoDescription</a>, <a class="el" href="classUndoManager.html#aaea507a3b9eaea3360c0e393edf69ccb" title="Tries to redo the last transaction that was undone. ">redo</a>, <a class="el" href="classUndoManager.html#a001384b3068589de6564796f7e43864e" title="Returns true if there's at least one action in the list to undo. ">canUndo</a> </dd></dl>
</div>
</div>
<a id="aadc8eb18f4cc2a7e77e16aee8cba6292"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aadc8eb18f4cc2a7e77e16aee8cba6292">§ </a></span>getRedoDescription()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classString.html">String</a> UndoManager::getRedoDescription </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the name of the transaction that will be redone when <a class="el" href="classUndoManager.html#aaea507a3b9eaea3360c0e393edf69ccb" title="Tries to redo the last transaction that was undone. ">redo()</a> is called. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classUndoManager.html#aaea507a3b9eaea3360c0e393edf69ccb" title="Tries to redo the last transaction that was undone. ">redo</a> </dd></dl>
</div>
</div>
<a id="aaea507a3b9eaea3360c0e393edf69ccb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaea507a3b9eaea3360c0e393edf69ccb">§ </a></span>redo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool UndoManager::redo </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tries to redo the last transaction that was undone. </p>
<dl class="section return"><dt>Returns</dt><dd>true if the transaction can be redone, and false if it fails, or if there aren't any transactions to redo </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__UndoManager_8h.html">juce_UndoManager.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|