QUndoCommand Class

成员函数文档

[explicit] QUndoCommand::QUndoCommand(QUndoCommand *parent = nullptr)

构造一个 QUndoCommand 对象，父对象为parent 。

如果parent 不是nullptr ，则该命令会被附加到父命令的子命令列表中。父命令拥有该命令，并将在其析构函数中删除该命令。

另请参阅 ~QUndoCommand() 。

[explicit] QUndoCommand::QUndoCommand(const QString &text, QUndoCommand *parent = nullptr)

用给定的parent 和text 构造一个 QUndoCommand 对象。

如果parent 不是nullptr ，则该命令会被附加到父命令的子命令列表中。父命令拥有该命令，并将在其析构函数中删除该命令。

另请参见 ~QUndoCommand()。

[virtual noexcept] QUndoCommand::~QUndoCommand()

销毁QUndoCommand 对象和所有子命令。

另请参见 QUndoCommand().

QString QUndoCommand::actionText() const

返回一个简短的文本字符串，说明该命令的作用；例如，"插入文本"。

该文本将在更新栈的撤销和重做操作的文本属性时使用。

另请参阅 text()、setText()、QUndoStack::createUndoAction() 和QUndoStack::createRedoAction()。

const QUndoCommand *QUndoCommand::child(int index) const

返回子命令index 。

另请参阅 childCount() 和QUndoStack::command()。

int QUndoCommand::childCount() const

返回该命令中子命令的数目。

另请参阅 child()。

[virtual] int QUndoCommand::id() const

返回此命令的 ID。

命令 ID 用于命令压缩。它必须是该命令类独有的整数，如果命令不支持压缩，则返回-1。

如果命令支持压缩，则必须在派生类中重载此函数，以返回正确的 ID。基本实现返回-1。

QUndoStack::push只有当两个命令的 ID 相同且 ID 不是-1 时，() 才会尝试合并它们。

另请参阅 mergeWith() 和QUndoStack::push()。

bool QUndoCommand::isObsolete() const

返回命令是否过时。

布尔值用于自动删除堆栈中不再需要的命令。函数QUndoStack::push(),QUndoStack::undo(),QUndoStack::redo() 和QUndoStack::setIndex() 会检查 isObsolete 函数。

另请参见 setObsolete()、mergeWith()、QUndoStack::push()、QUndoStack::undo() 和QUndoStack::redo()。

[virtual] bool QUndoCommand::mergeWith(const QUndoCommand *command)

尝试将此命令与command 合并。成功时返回true ，否则返回false 。

如果此函数返回true ，则调用此命令的redo() 与重做此命令和command 的效果相同。同样，调用此命令的undo() 与撤销command 和此命令的效果相同。

QUndoStack 只有当两条命令的 id 相同且 id 不为 -1 时，系统才会尝试合并它们。

默认执行返回false 。

bool AppendText::mergeWith(const QUndoCommand *other)
{
    if (other->id() != id()) // make sure other is also an AppendText command
        return false;
    m_text += static_cast<const AppendText*>(other)->m_text;
    return true;
}

另请参阅 id() 和QUndoStack::push()。

[virtual] void QUndoCommand::redo()

对文档进行更改。该函数必须在派生类中实现。调用QUndoStack::push(),QUndoStack::undo() 或QUndoStack::redo() 会导致未定义的行为。

默认实现会对所有子命令调用 redo()。

另请参见 undo()。

void QUndoCommand::setObsolete(bool obsolete)

将命令是否过时设置为obsolete 。

另请参阅 isObsolete(),mergeWith(),QUndoStack::push(),QUndoStack::undo() 和QUndoStack::redo() 。

void QUndoCommand::setText(const QString &text)

将命令文本设置为text 。

指定的文本应是用户可读的简短字符串，描述该命令的作用。

如果需要为text() 和actionText() 设置两个不同的字符串，请用"\n "将它们分开，然后传入此函数。即使在开发过程中不对英文字符串使用该功能，也可以让翻译人员使用两种不同的字符串，以满足特定语言的需要。所述功能和函数actionText() 自 Qt XML 4.8 起可用。

另请参见 text()、actionText()、QUndoStack::createUndoAction() 和QUndoStack::createRedoAction()。

QString QUndoCommand::text() const

返回一个简短的文本字符串，说明该命令的作用；例如，"插入文本"。

文本用于QUndoView 中的项目名称。

另请参阅 actionText()、setText()、QUndoStack::createUndoAction() 和QUndoStack::createRedoAction()。

[virtual] void QUndoCommand::undo()

撤销对文档的更改。调用 undo() 后，文档的状态应与调用redo() 前相同。该函数必须在派生类中实现。调用QUndoStack::push()、QUndoStack::undo() 或QUndoStack::redo() 会导致未定义的行为。

默认实现以相反顺序对所有子命令调用 undo()。

另请参见 redo()。