QUndoStack 类

成员函数文档

[显式] QUndoStack::QUndoStack(QObject *parent = nullptr)

使用指定的父对象构建一个空的撤销堆栈。堆栈最初将处于清洁状态。如果 parent 是一个 QUndoGroup 对象，则堆栈将自动添加到该组中。

另请参阅push。

[虚函数 noexcept] QUndoStack::~QUndoStack()

销毁撤销堆栈，删除其上的任何命令。如果该堆栈位于 QUndoGroup 中，则堆栈将自动从该组中删除。

另请参阅QUndoStack。

void QUndoStack::beginMacro(const QString &text)

以给定的 text 描述开始宏命令的合成。

将指定的 text 描述的空命令推入堆栈。任何后续推入堆栈的命令都将追加到空命令的子项中，直到调用 endMacro()。

beginMacro() 和 endMacro() 的调用可以嵌套，但每个 beginMacro() 调用必须有一个匹配的 endMacro() 调用。

在宏被合成时，堆栈将被禁用。这意味着

• indexChanged() 和 cleanChanged() 将不会被发出，
• canUndo() 和 canRedo() 返回 false，
• 调用 undo() 或 redo() 没有任何效果，
• 撤销/重做动作被禁用。

当为最外层的宏调用 endMacro() 时，堆栈将变为启用状态，并发出适当的信号。

stack.beginMacro("insert red text");
stack.push(new InsertText(document, idx, text));
stack.push(new SetColor(document, idx, text.length(), Qt::red));
stack.endMacro(); // indexChanged() is emitted

此代码等价于

QUndoCommand *insertRed = new QUndoCommand(); // an empty command
insertRed->setText("insert red text");

new InsertText(document, idx, text, insertRed); // becomes child of insertRed
new SetColor(document, idx, text.length(), Qt::red, insertRed);

stack.push(insertRed);

另请参阅endMacro。

bool QUndoStack::canRedo() const

如果有可重做的命令，则返回 true；否则返回 false。

如果该堆栈为空或堆栈顶部的命令已重做，则此函数返回 false。

等同于 index() == count。

另请参阅index() 和 canUndo。

[信号] void QUndoStack::canRedoChanged(bool canRedo)

此信号在 canRedo() 的值更改时发出。它用于启用或禁用由 createRedoAction() 返回的重做动作。canRedo 指定了新值。

bool QUndoStack::canUndo() const

如果有可撤销的命令，则返回 true；否则返回 false。

如果该堆栈为空，或堆栈底部的命令已撤销，则此函数返回 false。

等同于 index() == 0。

另请参阅 index() 和 canRedo().

[信号] void QUndoStack::canUndoChanged(bool canUndo)

该信号在 canUndo() 的值更改时发出。它用于启用或禁用由 createUndoAction() 返回的撤消动作。 canUndo 指定新值。

[信号] void QUndoStack::cleanChanged(bool clean)

该信号在堆栈进入或离开清洁状态时发出。如果 clean 为 true，则堆栈处于清洁状态；否则此信号表示它已离开清洁状态。

另请参阅 isClean() 和 setClean().

int QUndoStack::cleanIndex() const

返回清洁索引。这是调用 setClean() 的索引。

堆栈可能没有清洁索引。这发生在文档保存后、某些命令被撤消 ，然后推入新的命令。由于 push() 在推入新命令之前删除所有被撤消的命令，堆栈不能再次回到清洁状态。在这种情况下，此函数返回 -1。在调用 resetClean() 后也可能返回 -1。

另请参阅 isClean() 和 setClean().

void QUndoStack::clear()

通过删除其上的所有命令来清除命令堆栈，并将堆栈返回到清洁状态。

命令不会被撤消或重做；编辑对象的属性状态保持不变。

通常用于放弃文档内容时使用此函数。

另请参阅QUndoStack。

QUndoCommand *QUndoStack::command(int index) const

返回对 index 处的命令的 const 指针。

此函数返回一个 const 指针，因为在执行后修改已推入堆栈的命令几乎总是会导致文档状态的损坏。

另请参阅 QUndoCommand::child().

int QUndoStack::count() const

返回堆栈上的命令数量。宏命令计数为一个命令。

另请参阅 index()，setIndex() 和 command().

QAction *QUndoStack::createRedoAction(QObject *parent, const QString &prefix = QString()) const

创建具有给定 parent 的重做 QAction 对象。

触发此动作将触发对redo()的调用。此动作的文本是将在下一次调用redo()时重做的命令文本，前面加上指定的前缀。如果没有可用于重做的命令，此动作将禁用。

如果前缀为空，则使用默认模板“重做 %1”代替前缀。在Qt 4.8之前，默认使用前缀“重做”。

另请参阅createUndoAction()，canRedo()，和QUndoCommand::text。

QAction *QUndoStack::createUndoAction(QObject *parent, const QString &prefix = QString()) const

根据给定的父对象创建一个撤销QAction对象。

触发此动作将触发对undo()的调用。此动作的文本是将在下一次调用undo()时撤销的命令文本，前面加上指定的前缀。如果没有可用于撤销的命令，此动作将禁用。

如果前缀为空，则使用默认模板“撤销 %1”代替前缀。在Qt 4.8之前，默认使用前缀“撤销”。

另请参阅createRedoAction()，canUndo()，和QUndoCommand::text。

void QUndoStack::endMacro()

结束宏命令的合成。

如果这是嵌套宏集中的最外层宏，此函数将对整个宏命令调用一次indexChanged()。

另请参阅beginMacro。

int QUndoStack::index() const

返回当前命令的索引。这是下一次调用redo()时将执行的命令。由于可能撤销了许多命令，这并不总是堆栈中最顶部的命令。

另请参阅setIndex()，undo()，redo()，和count。

[信号] void QUndoStack::indexChanged(int idx)

每当命令修改文档状态时，都会发出此信号。当撤销或重做命令时会发生这种情况。当撤销或重做宏命令，或调用setIndex()时，此信号只发出一次。

idx指定当前命令的索引，即下一次调用redo()将执行的命令。

另请参阅index()和setIndex。

bool QUndoStack::isClean() const

如果堆栈处于清洁状态，则返回true；否则返回false。

另请参阅 setClean() 和 cleanIndex respectfuly.

void QUndoStack::push(QUndoCommand *cmd)

将 cmd 添加到堆栈或与其最近执行命令合并。在任何情况下，都会通过调用其 redo() 函数执行 cmd。

如果 cmd 的 ID 不是 -1，并且与最近执行的命令的 ID 相同，QUndoStack 将尝试通过在最近执行的命令上调用 QUndoCommand::mergeWith() 来合并两个命令。如果 QUndoCommand::mergeWith() 返回 true，则删除 cmd。

调用 QUndoCommand::redo() 和，如果适用，QUndoCommand::mergeWith() 后，将针对 cmd 或合并的命令调用 QUndoCommand::isObsolete()。如果 QUndoCommand::isObsolete() 返回 true，则从堆栈中删除 cmd 或合并的命令。

在其他所有情况下，仅将 cmd 添加到堆栈。

如果在 cmd 被推送到堆栈之前撤销了命令，则删除当前命令及其上述所有命令。因此，cmd 总是成为堆栈上的顶层命令。

一旦命令被推送到堆栈，堆栈就负责该命令。由于修改已执行后的文档状态几乎总会导致损坏，因此没有用于返回命令的获取器。

另请参阅 QUndoCommand::id() 以及 QUndoCommand::mergeWith respectfuly。

[slot] void QUndoStack::redo()

通过调用 QUndoCommand::redo() 重做当前命令。增加当前命令索引。

如果堆栈为空，或者堆栈顶部的命令已经重做，则此函数不执行任何操作。

如果 QUndoCommand::isObsolete() 对于当前命令返回 true，则将命令从堆栈中删除。此外，如果干净索引大于或等于当前命令索引，则重置干净索引。

另请参阅 undo() 以及 index respectfuly。

QString QUndoStack::redoText() const

返回将在下一个调用 redo() 时的下一个重做命令的文本。

另请参阅 QUndoCommand::actionText() 以及 undoText respectfuly。

[signal] void QUndoStack::redoTextChanged(const QString &redoText)

此信号在 redoText() 的值更改时发出。它用于更新通过 createRedoAction() 返回的重做动作的文本属性。新文本由 redoText 指定。

[slot] void QUndoStack::resetClean()

如果堆栈是干净的，则退出干净状态并发出 cleanChanged()。如果堆栈之前是干净的，此方法将干净索引重置为 -1。

通常在以下情况下调用此方法：文档经过

• 基于某些模板创建，尚未保存，因此尚无文件名与文档关联。
• 从备份文件中恢复。
• 在编辑器外更改，用户未重新加载。

另请参阅isClean()，setClean()，以及 cleanIndex().

[slot] void QUndoStack::setClean()

如果栈未被标记为干净，则标记栈为干净并发出 cleanChanged() 信号。

这通常在文档保存时调用，例如。

当栈使用撤销/重做命令返回到该状态时，它将发出 cleanChanged() 信号。此信号还在栈离开干净状态时发出。

另请参阅isClean()，resetClean()，以及 cleanIndex().

[slot] void QUndoStack::setIndex(int idx)

反复调用 undo() 或 redo()，直到当前命令索引达到 idx。此函数可用于将文档状态向前或向后滚动。仅发出 indexChanged() 一次。

另请参阅index()，count()，undo()，和 redo().

QString QUndoStack::text(int idx) const

返回索引为 idx 的命令的文本。

另请参阅beginMacro。

[slot] void QUndoStack::undo()

通过调用 QUndoCommand::undo() 撤销当前命令下面的命令。递减当前命令索引。

如果栈为空，或者栈底命令已经撤销，此函数不执行任何操作。

撤销命令后，如果 QUndoCommand::isObsolete() 返回 true，则该命令将从栈中删除。此外，如果干净索引大于或等于当前命令索引，则重置干净索引。

另请参阅redo() 和 index().

QString QUndoStack::undoText() const

在下一个对 undo() 的调用中，返回将要撤销的命令的文本。

另请参阅QUndoCommand::actionText() 和 redoText().

[signal] void QUndoStack::undoTextChanged(const QString &undoText)

每次 undoText() 的值更改时都会发出此信号。它用于更新 createUndoAction() 返回的撤销操作的文本属性。 undoText 指定新文本。