QUndoCommand 类

成员函数文档

[显式] QUndoCommand::QUndoCommand(QUndoCommand *parent = nullptr)

构造一个具有父 parent 的 QUndoCommand 对象。

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

参见~QUndoCommand。

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

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

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

参见~QUndoCommand。

[虚拟 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。

[虚拟] 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().

[虚函数] 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().

[虚函数] 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 4.8 中提供。

另请参阅 text()(), actionText()(), QUndoStack::createUndoAction()(), 和 QUndoStack::createRedoAction()().

QString QUndoCommand::text() const

返回一个描述这个命令做了什么的简短文本字符串；例如，“插入文本”。

该文本用于QUndoView中各项的名称。

另请参阅 actionText()(), setText()(), QUndoStack::createUndoAction()(), 和 QUndoStack::createRedoAction()().

[虚拟] void QUndoCommand::undo()

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

默认实现会在逆序中调用所有子命令的 undo()。

另请参阅 redo().