<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qundostack.cpp -->
<title>QUndoCommand Class | Qt Widgets 5.9</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.9</td><td ><a href="qtwidgets-index.html">Qt Widgets</a></td><td ><a href="qtwidgets-module.html">C++ Classes</a></td><td >QUndoCommand</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QUndoCommand Class</h1>
<!-- $$$QUndoCommand-brief -->
<p>The <a href="qundocommand.html">QUndoCommand</a> class is the base class of all commands stored on a <a href="qundostack.html">QUndoStack</a>. <a href="#details">More...</a></p>
<!-- @@@QUndoCommand -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QUndoCommand></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += widgets</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 4.2</td></tr></table></div><ul>
<li><a href="qundocommand-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qundocommand.html#QUndoCommand">QUndoCommand</a></b>(QUndoCommand *<i>parent</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qundocommand.html#QUndoCommand-1">QUndoCommand</a></b>(const QString &<i>text</i>, QUndoCommand *<i>parent</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qundocommand.html#dtor.QUndoCommand">~QUndoCommand</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qundocommand.html#actionText">actionText</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QUndoCommand *</td><td class="memItemRight bottomAlign"><b><a href="qundocommand.html#child">child</a></b>(int <i>index</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qundocommand.html#childCount">childCount</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qundocommand.html#id">id</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qundocommand.html#isObsolete">isObsolete</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qundocommand.html#mergeWith">mergeWith</a></b>(const QUndoCommand *<i>command</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qundocommand.html#redo">redo</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qundocommand.html#setObsolete">setObsolete</a></b>(bool <i>obsolete</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qundocommand.html#setText">setText</a></b>(const QString &<i>text</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qundocommand.html#text">text</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qundocommand.html#undo">undo</a></b>()</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QUndoCommand-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qundocommand.html">QUndoCommand</a> class is the base class of all commands stored on a <a href="qundostack.html">QUndoStack</a>.</p>
<p>For an overview of Qt's Undo Framework, see the overview document.</p>
<p>A <a href="qundocommand.html">QUndoCommand</a> represents a single editing action on a document; for example, inserting or deleting a block of text in a text editor. <a href="qundocommand.html">QUndoCommand</a> can apply a change to the document with <a href="qundocommand.html#redo">redo</a>() and undo the change with <a href="qundocommand.html#undo">undo</a>(). The implementations for these functions must be provided in a derived class.</p>
<pre class="cpp">
<span class="keyword">class</span> AppendText : <span class="keyword">public</span> <span class="type"><a href="qundocommand.html#QUndoCommand">QUndoCommand</a></span>
{
<span class="keyword">public</span>:
AppendText(<span class="type"><a href="../qtcore/qstring.html">QString</a></span> <span class="operator">*</span>doc<span class="operator">,</span> <span class="keyword">const</span> <span class="type"><a href="../qtcore/qstring.html">QString</a></span> <span class="operator">&</span>text)
: m_document(doc)<span class="operator">,</span> m_text(text) { setText(<span class="string">"append text"</span>); }
<span class="keyword">virtual</span> <span class="type">void</span> undo()
{ m_document<span class="operator">-</span><span class="operator">></span>chop(m_text<span class="operator">.</span>length()); }
<span class="keyword">virtual</span> <span class="type">void</span> redo()
{ m_document<span class="operator">-</span><span class="operator">></span>append(m_text); }
<span class="keyword">private</span>:
<span class="type"><a href="../qtcore/qstring.html">QString</a></span> <span class="operator">*</span>m_document;
<span class="type"><a href="../qtcore/qstring.html">QString</a></span> m_text;
};
</pre>
<p>A <a href="qundocommand.html">QUndoCommand</a> has an associated <a href="qundocommand.html#text">text</a>(). This is a short string describing what the command does. It is used to update the text properties of the stack's undo and redo actions; see <a href="qundostack.html#createUndoAction">QUndoStack::createUndoAction</a>() and <a href="qundostack.html#createRedoAction">QUndoStack::createRedoAction</a>().</p>
<p><a href="qundocommand.html">QUndoCommand</a> objects are owned by the stack they were pushed on. <a href="qundostack.html">QUndoStack</a> deletes a command if it has been undone and a new command is pushed. For example:</p>
<pre class="cpp">
MyCommand <span class="operator">*</span>command1 <span class="operator">=</span> <span class="keyword">new</span> MyCommand();
stack<span class="operator">-</span><span class="operator">></span>push(command1);
MyCommand <span class="operator">*</span>command2 <span class="operator">=</span> <span class="keyword">new</span> MyCommand();
stack<span class="operator">-</span><span class="operator">></span>push(command2);
stack<span class="operator">-</span><span class="operator">></span>undo();
MyCommand <span class="operator">*</span>command3 <span class="operator">=</span> <span class="keyword">new</span> MyCommand();
stack<span class="operator">-</span><span class="operator">></span>push(command3); <span class="comment">// command2 gets deleted</span>
</pre>
<p>In effect, when a command is pushed, it becomes the top-most command on the stack.</p>
<p>To support command compression, <a href="qundocommand.html">QUndoCommand</a> has an <a href="qundocommand.html#id">id</a>() and the virtual function <a href="qundocommand.html#mergeWith">mergeWith</a>(). These functions are used by <a href="qundostack.html#push">QUndoStack::push</a>().</p>
<p>To support command macros, a <a href="qundocommand.html">QUndoCommand</a> object can have any number of child commands. Undoing or redoing the parent command will cause the child commands to be undone or redone. A command can be assigned to a parent explicitly in the constructor. In this case, the command will be owned by the parent.</p>
<p>The parent in this case is usually an empty command, in that it doesn't provide its own implementation of <a href="qundocommand.html#undo">undo</a>() and <a href="qundocommand.html#redo">redo</a>(). Instead, it uses the base implementations of these functions, which simply call <a href="qundocommand.html#undo">undo</a>() or <a href="qundocommand.html#redo">redo</a>() on all its children. The parent should, however, have a meaningful <a href="qundocommand.html#text">text</a>().</p>
<pre class="cpp">
<span class="type"><a href="qundocommand.html#QUndoCommand">QUndoCommand</a></span> <span class="operator">*</span>insertRed <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qundocommand.html#QUndoCommand">QUndoCommand</a></span>(); <span class="comment">// an empty command</span>
insertRed<span class="operator">-</span><span class="operator">></span>setText(<span class="string">"insert red text"</span>);
<span class="keyword">new</span> InsertText(document<span class="operator">,</span> idx<span class="operator">,</span> text<span class="operator">,</span> insertRed); <span class="comment">// becomes child of insertRed</span>
<span class="keyword">new</span> SetColor(document<span class="operator">,</span> idx<span class="operator">,</span> text<span class="operator">.</span>length()<span class="operator">,</span> <span class="type"><a href="../qtcore/qt.html">Qt</a></span><span class="operator">::</span>red<span class="operator">,</span> insertRed);
stack<span class="operator">.</span>push(insertRed);
</pre>
<p>Another way to create macros is to use the convenience functions <a href="qundostack.html#beginMacro">QUndoStack::beginMacro</a>() and <a href="qundostack.html#endMacro">QUndoStack::endMacro</a>().</p>
</div>
<p><b>See also </b><a href="qundostack.html">QUndoStack</a>.</p>
<!-- @@@QUndoCommand -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QUndoCommand[overload1]$$$QUndoCommandQUndoCommand* -->
<h3 class="fn" id="QUndoCommand"><a name="QUndoCommand"></a>QUndoCommand::<span class="name">QUndoCommand</span>(<span class="type"><a href="qundocommand.html#QUndoCommand">QUndoCommand</a></span> *<i>parent</i> = Q_NULLPTR)</h3>
<p>Constructs a <a href="qundocommand.html">QUndoCommand</a> object with parent <i>parent</i>.</p>
<p>If <i>parent</i> is not 0, this command is appended to parent's child list. The parent command then owns this command and will delete it in its destructor.</p>
<p><b>See also </b><a href="qundocommand.html#dtor.QUndoCommand">~QUndoCommand</a>().</p>
<!-- @@@QUndoCommand -->
<!-- $$$QUndoCommand$$$QUndoCommandconstQString&QUndoCommand* -->
<h3 class="fn" id="QUndoCommand-1"><a name="QUndoCommand-1"></a>QUndoCommand::<span class="name">QUndoCommand</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &<i>text</i>, <span class="type"><a href="qundocommand.html#QUndoCommand">QUndoCommand</a></span> *<i>parent</i> = Q_NULLPTR)</h3>
<p>Constructs a <a href="qundocommand.html">QUndoCommand</a> object with the given <i>parent</i> and <i>text</i>.</p>
<p>If <i>parent</i> is not 0, this command is appended to parent's child list. The parent command then owns this command and will delete it in its destructor.</p>
<p><b>See also </b><a href="qundocommand.html#dtor.QUndoCommand">~QUndoCommand</a>().</p>
<!-- @@@QUndoCommand -->
<!-- $$$~QUndoCommand[overload1]$$$~QUndoCommand -->
<h3 class="fn" id="dtor.QUndoCommand"><a name="dtor.QUndoCommand"></a><code>[virtual] </code>QUndoCommand::<span class="name">~QUndoCommand</span>()</h3>
<p>Destroys the <a href="qundocommand.html">QUndoCommand</a> object and all child commands.</p>
<p><b>See also </b><a href="qundocommand.html#QUndoCommand">QUndoCommand</a>().</p>
<!-- @@@~QUndoCommand -->
<!-- $$$actionText[overload1]$$$actionText -->
<h3 class="fn" id="actionText"><a name="actionText"></a><span class="type"><a href="../qtcore/qstring.html">QString</a></span> QUndoCommand::<span class="name">actionText</span>() const</h3>
<p>Returns a short text string describing what this command does; for example, "insert text".</p>
<p>The text is used when the text properties of the stack's undo and redo actions are updated.</p>
<p>This function was introduced in Qt 4.8.</p>
<p><b>See also </b><a href="qundocommand.html#text">text</a>(), <a href="qundocommand.html#setText">setText</a>(), <a href="qundostack.html#createUndoAction">QUndoStack::createUndoAction</a>(), and <a href="qundostack.html#createRedoAction">QUndoStack::createRedoAction</a>().</p>
<!-- @@@actionText -->
<!-- $$$child[overload1]$$$childint -->
<h3 class="fn" id="child"><a name="child"></a>const <span class="type"><a href="qundocommand.html#QUndoCommand">QUndoCommand</a></span> *QUndoCommand::<span class="name">child</span>(<span class="type">int</span> <i>index</i>) const</h3>
<p>Returns the child command at <i>index</i>.</p>
<p>This function was introduced in Qt 4.4.</p>
<p><b>See also </b><a href="qundocommand.html#childCount">childCount</a>() and <a href="qundostack.html#command">QUndoStack::command</a>().</p>
<!-- @@@child -->
<!-- $$$childCount[overload1]$$$childCount -->
<h3 class="fn" id="childCount"><a name="childCount"></a><span class="type">int</span> QUndoCommand::<span class="name">childCount</span>() const</h3>
<p>Returns the number of child commands in this command.</p>
<p>This function was introduced in Qt 4.4.</p>
<p><b>See also </b><a href="qundocommand.html#child">child</a>().</p>
<!-- @@@childCount -->
<!-- $$$id[overload1]$$$id -->
<h3 class="fn" id="id"><a name="id"></a><code>[virtual] </code><span class="type">int</span> QUndoCommand::<span class="name">id</span>() const</h3>
<p>Returns the ID of this command.</p>
<p>A command ID is used in command compression. It must be an integer unique to this command's class, or -1 if the command doesn't support compression.</p>
<p>If the command supports compression this function must be overridden in the derived class to return the correct ID. The base implementation returns -1.</p>
<p><a href="qundostack.html#push">QUndoStack::push</a>() will only try to merge two commands if they have the same ID, and the ID is not -1.</p>
<p><b>See also </b><a href="qundocommand.html#mergeWith">mergeWith</a>() and <a href="qundostack.html#push">QUndoStack::push</a>().</p>
<!-- @@@id -->
<!-- $$$isObsolete[overload1]$$$isObsolete -->
<h3 class="fn" id="isObsolete"><a name="isObsolete"></a><span class="type">bool</span> QUndoCommand::<span class="name">isObsolete</span>() const</h3>
<p>Returns whether the command is obsolete.</p>
<p>The boolean is used for the automatic removal of commands that are not necessary in the stack anymore. The isObsolete function is checked in the functions <a href="qundostack.html#push">QUndoStack::push</a>(), <a href="qundostack.html#undo">QUndoStack::undo</a>(), <a href="qundostack.html#redo">QUndoStack::redo</a>(), and <a href="qundostack.html#setIndex">QUndoStack::setIndex</a>().</p>
<p>This function was introduced in Qt 5.9.</p>
<p><b>See also </b><a href="qundocommand.html#setObsolete">setObsolete</a>(), <a href="qundocommand.html#mergeWith">mergeWith</a>(), <a href="qundostack.html#push">QUndoStack::push</a>(), <a href="qundostack.html#undo">QUndoStack::undo</a>(), and <a href="qundostack.html#redo">QUndoStack::redo</a>().</p>
<!-- @@@isObsolete -->
<!-- $$$mergeWith[overload1]$$$mergeWithconstQUndoCommand* -->
<h3 class="fn" id="mergeWith"><a name="mergeWith"></a><code>[virtual] </code><span class="type">bool</span> QUndoCommand::<span class="name">mergeWith</span>(const <span class="type"><a href="qundocommand.html#QUndoCommand">QUndoCommand</a></span> *<i>command</i>)</h3>
<p>Attempts to merge this command with <i>command</i>. Returns <code>true</code> on success; otherwise returns <code>false</code>.</p>
<p>If this function returns <code>true</code>, calling this command's <a href="qundocommand.html#redo">redo</a>() must have the same effect as redoing both this command and <i>command</i>. Similarly, calling this command's <a href="qundocommand.html#undo">undo</a>() must have the same effect as undoing <i>command</i> and this command.</p>
<p><a href="qundostack.html">QUndoStack</a> will only try to merge two commands if they have the same id, and the id is not -1.</p>
<p>The default implementation returns <code>false</code>.</p>
<pre class="cpp">
bool AppendText<span class="operator">::</span>mergeWith(<span class="keyword">const</span> <span class="type"><a href="qundocommand.html#QUndoCommand">QUndoCommand</a></span> <span class="operator">*</span>other)
{
<span class="keyword">if</span> (other<span class="operator">-</span><span class="operator">></span>id() <span class="operator">!</span><span class="operator">=</span> id()) <span class="comment">// make sure other is also an AppendText command</span>
<span class="keyword">return</span> <span class="keyword">false</span>;
m_text <span class="operator">+</span><span class="operator">=</span> <span class="keyword">static_cast</span><span class="operator"><</span><span class="keyword">const</span> AppendText<span class="operator">*</span><span class="operator">></span>(other)<span class="operator">-</span><span class="operator">></span>m_text;
<span class="keyword">return</span> <span class="keyword">true</span>;
}
</pre>
<p><b>See also </b><a href="qundocommand.html#id">id</a>() and <a href="qundostack.html#push">QUndoStack::push</a>().</p>
<!-- @@@mergeWith -->
<!-- $$$redo[overload1]$$$redo -->
<h3 class="fn" id="redo"><a name="redo"></a><code>[virtual] </code><span class="type">void</span> QUndoCommand::<span class="name">redo</span>()</h3>
<p>Applies a change to the document. This function must be implemented in the derived class. Calling <a href="qundostack.html#push">QUndoStack::push</a>(), <a href="qundostack.html#undo">QUndoStack::undo</a>() or <a href="qundostack.html#redo">QUndoStack::redo</a>() from this function leads to undefined beahavior.</p>
<p>The default implementation calls redo() on all child commands.</p>
<p><b>See also </b><a href="qundocommand.html#undo">undo</a>().</p>
<!-- @@@redo -->
<!-- $$$setObsolete[overload1]$$$setObsoletebool -->
<h3 class="fn" id="setObsolete"><a name="setObsolete"></a><span class="type">void</span> QUndoCommand::<span class="name">setObsolete</span>(<span class="type">bool</span> <i>obsolete</i>)</h3>
<p>Sets whether the command is obsolete to <i>obsolete</i>.</p>
<p>This function was introduced in Qt 5.9.</p>
<p><b>See also </b><a href="qundocommand.html#isObsolete">isObsolete</a>(), <a href="qundocommand.html#mergeWith">mergeWith</a>(), <a href="qundostack.html#push">QUndoStack::push</a>(), <a href="qundostack.html#undo">QUndoStack::undo</a>(), and <a href="qundostack.html#redo">QUndoStack::redo</a>().</p>
<!-- @@@setObsolete -->
<!-- $$$setText[overload1]$$$setTextconstQString& -->
<h3 class="fn" id="setText"><a name="setText"></a><span class="type">void</span> QUndoCommand::<span class="name">setText</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &<i>text</i>)</h3>
<p>Sets the command's text to be the <i>text</i> specified.</p>
<p>The specified text should be a short user-readable string describing what this command does.</p>
<p>If you need to have two different strings for <a href="qundocommand.html#text">text</a>() and <a href="qundocommand.html#actionText">actionText</a>(), separate them with "\n" and pass into this function. Even if you do not use this feature for English strings during development, you can still let translators use two different strings in order to match specific languages' needs. The described feature and the function <a href="qundocommand.html#actionText">actionText</a>() are available since Qt 4.8.</p>
<p><b>See also </b><a href="qundocommand.html#text">text</a>(), <a href="qundocommand.html#actionText">actionText</a>(), <a href="qundostack.html#createUndoAction">QUndoStack::createUndoAction</a>(), and <a href="qundostack.html#createRedoAction">QUndoStack::createRedoAction</a>().</p>
<!-- @@@setText -->
<!-- $$$text[overload1]$$$text -->
<h3 class="fn" id="text"><a name="text"></a><span class="type"><a href="../qtcore/qstring.html">QString</a></span> QUndoCommand::<span class="name">text</span>() const</h3>
<p>Returns a short text string describing what this command does; for example, "insert text".</p>
<p>The text is used for names of items in <a href="qundoview.html">QUndoView</a>.</p>
<p><b>See also </b><a href="qundocommand.html#actionText">actionText</a>(), <a href="qundocommand.html#setText">setText</a>(), <a href="qundostack.html#createUndoAction">QUndoStack::createUndoAction</a>(), and <a href="qundostack.html#createRedoAction">QUndoStack::createRedoAction</a>().</p>
<!-- @@@text -->
<!-- $$$undo[overload1]$$$undo -->
<h3 class="fn" id="undo"><a name="undo"></a><code>[virtual] </code><span class="type">void</span> QUndoCommand::<span class="name">undo</span>()</h3>
<p>Reverts a change to the document. After undo() is called, the state of the document should be the same as before <a href="qundocommand.html#redo">redo</a>() was called. This function must be implemented in the derived class. Calling <a href="qundostack.html#push">QUndoStack::push</a>(), <a href="qundostack.html#undo">QUndoStack::undo</a>() or <a href="qundostack.html#redo">QUndoStack::redo</a>() from this function leads to undefined beahavior.</p>
<p>The default implementation calls undo() on all child commands in reverse order.</p>
<p><b>See also </b><a href="qundocommand.html#redo">redo</a>().</p>
<!-- @@@undo -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
distrib
>
Mageia
>
6
>
armv5tl
>
media
>
core-updates
>
by-pkgid
>
768f7d9f703884aa2562bf0a651086df
>
files
>
4627
