【Qt笔记】QUndoView控件详解

 

目录

引言

一、QUndoView 的用途

二、工作原理

三、 如何与 QUndoStack 配合使用

四、自定义化

4.1 代理 

4.2 模型 

4.3 样式表 

五、事件处理

六、代码示例 

实现效果

注意

结语

---

引言

QUndoView是Qt框架中用于可视化显示QUndoStack（撤销/重做堆栈）内容的控件。它通常用于开发需要复杂撤销/重做历史的应用程序，如文本编辑器、图形编辑器或任何需要精细控制用户操作历史的应用程序。

一、QUndoView 的用途

QUndoView的主要用途是提供一个用户界面，让用户能够查看和操作撤销/重做堆栈中的命令。这包括：

• 查看命令历史：用户可以查看他们之前执行的所有命令的列表。
• 撤销/重做特定命令：用户可以通过点击QUndoView中的命令来撤销或重做它们，而不仅仅是最近的命令。
• 调试：对于开发者来说，QUndoView是一个强大的调试工具，可以帮助他们理解撤销/重做堆栈的状态。

二、工作原理

QUndoView内部使用了一个QUndoView（或类似的树形视图控件）来显示QUndoStack中的命令。每个命令都被视为树中的一个节点，通常是一个简单的列表（因为大多数撤销/重做堆栈是线性的），但也可以支持更复杂的命令结构（如复合命令）。

三、 如何与 QUndoStack 配合使用

要使用QUndoView，你首先需要有一个QUndoStack实例，该实例管理你的撤销/重做命令。然后，你可以创建QUndoView的实例，并将其与QUndoStack关联。

QUndoStack *undoStack = new QUndoStack(this);  
QUndoView *undoView = new QUndoView(undoStack, this);

一旦关联，QUndoView将自动显示QUndoStack中的命令。每当QUndoStack的状态发生变化时（例如，通过push()、undo()或redo()操作），QUndoView都会更新其显示以反映这些变化。 

四、自定义化

虽然QUndoView提供了基本的可视化功能，但你可能想要对其进行自定义以满足你的特定需求。以下是一些自定义化的方法：

4.1 代理 

• 代理（QStyledItemDelegate）：你可以使用QStyledItemDelegate（或其子类）来自定义命令在QUndoView中的显示方式。例如，你可以改变文本的颜色、字体或添加图标。

#include <QStyledItemDelegate>  
#include <QPainter>  
#include <QUndoView>  
  
class CustomUndoDelegate : public QStyledItemDelegate {  
public:  
    CustomUndoDelegate(QObject *parent = nullptr) : QStyledItemDelegate(parent) {}  
  
    void paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const override {  
        QStyleOptionViewItem opt = option;  
        initStyleOption(&opt, index);  
  
        // 自定义文本颜色  
        opt.palette.setColor(QPalette::Text, Qt::blue); // 设置为蓝色  
  
        // 绘制项  
        QApplication::style()->drawControl(QStyle::CE_ItemViewItem, &opt, painter);  
  
        // 如果需要绘制额外的文本或图标，可以在这里添加  
        // 例如，在文本前添加一个图标  
        // if (!index.data(QUndoModel::CleanChangedRole).toBool()) {  
        //     // 绘制图标逻辑  
        // }  
    }  
};  
  
// 在你的主窗口或相关类中设置代理  
QUndoView *undoView = new QUndoView(undoStack);  
CustomUndoDelegate *delegate = new CustomUndoDelegate(undoView);  
undoView->setItemDelegate(delegate);

4.2 模型 

• 模型（QAbstractItemModel）：虽然QUndoView通常与QUndoStack一起使用，但你也可以通过设置自定义的QAbstractItemModel来提供不同的数据源。然而，这通常不是必需的，因为QUndoStack已经是一个很好的模型。

4.3 样式表 

• 样式表（QSS）：你可以使用Qt样式表（QSS）来改变QUndoView的外观，包括背景颜色、边框、边距等。

// 在你的主窗口或相关类中设置样式表  
QUndoView *undoView = new QUndoView(undoStack);  
undoView->setStyleSheet("QUndoView { background-color: lightgray; border: 1px solid black; margin: 5px; }");  
  
// 如果你还想为其中的项设置样式（虽然这通常通过代理完成），你可能需要更复杂的QSS选择器  
// 但请注意，QUndoView中的项可能不是直接可访问的QSS选择器，因为它们是通过模型/视图架构管理的  
// 在这种情况下，你可能需要依赖代理来完全自定义项的显示

 

五、事件处理

QUndoView继承自QTreeView（或类似的树形视图控件），因此它支持所有QTreeView的事件和信号。但是，在处理QUndoView的事件时，你通常不需要做太多工作，因为点击命令来撤销/重做它们的行为是自动处理的。

然而，如果你想要对用户的点击或其他操作进行更精细的控制（例如，在用户点击某个命令时显示一个确认对话框），你可能需要安装事件过滤器或使用QTreeView的信号和槽机制。

六、代码示例 

QUndoView 是 Qt 框架中用于显示 QUndoStack（撤销堆栈）中命令历史的一个控件。它通常与 QUndoStack 一起使用，以提供一个图形化的界面来查看和操作撤销/重做历史。

下面是一个具体的代码示例，展示了如何将 QUndoView 与 QUndoStack 以及其他一些控件（如按钮和文本框）集成到一个 Qt 窗口中。在这个例子中，我们将通过编辑文本框的内容来生成撤销/重做命令。

首先，你需要确保你的 Qt 项目已经包含了必要的模块（通常是 QtWidgets 和 QtGui）。

#include <QApplication>  
#include <QWidget>  
#include <QVBoxLayout>  
#include <QUndoStack>  
#include <QUndoView>  
#include <QPushButton>  
#include <QLineEdit>  
#include <QUndoCommand>  
  
// 自定义命令类，用于处理文本编辑的撤销/重做  
class TextEditCommand : public QUndoCommand {  
public:  
    TextEditCommand(QLineEdit *editor, const QString &oldText, QUndoCommand *parent = nullptr)  
        : QUndoCommand(parent), m_editor(editor), m_oldText(oldText), m_newText(editor->text()) {}  
  
    void redo() override {  
        m_editor->setText(m_newText);  
    }  
  
    void undo() override {  
        m_editor->setText(m_oldText);  
    }  
  
private:  
    QLineEdit *m_editor;  
    QString m_oldText;  
    QString m_newText;  
};  
  
int main(int argc, char *argv[]) {  
    QApplication app(argc, argv);  
  
    // 创建主窗口和布局  
    QWidget window;  
    QVBoxLayout *layout = new QVBoxLayout(&window);  
  
    // 文本编辑框  
    QLineEdit *editor = new QLineEdit(&window);  
  
    // 撤销堆栈  
    QUndoStack *undoStack = new QUndoStack(&window);  
  
    // 撤销视图  
    QUndoView *undoView = new QUndoView(undoStack, &window);  
  
    // 撤销和重做按钮  
    QPushButton *undoButton = new QPushButton("Undo", &window);  
    QPushButton *redoButton = new QPushButton("Redo", &window);  
  
    // 初始禁用撤销和重做按钮  
    undoButton->setEnabled(false);  
    redoButton->setEnabled(false);  
  
    // 连接信号和槽  
    QObject::connect(undoStack, &QUndoStack::canUndoChanged, undoButton, &QPushButton::setEnabled);  
    QObject::connect(undoStack, &QUndoStack::canRedoChanged, redoButton, &QPushButton::setEnabled);  
    QObject::connect(undoButton, &QPushButton::clicked, undoStack, &QUndoStack::undo);  
    QObject::connect(redoButton, &QPushButton::clicked, undoStack, &QUndoStack::redo);  
  
    // 连接文本编辑框的信号以生成撤销/重做命令  
    QObject::connect(editor, &QLineEdit::textEdited, [&](const QString &newText) {  
        if (editor->hasFocus()) { // 避免在失去焦点时添加不必要的命令  
            undoStack->push(new TextEditCommand(editor, editor->text(), nullptr));  
            // 注意：这里实际上我们推送了一个“无效”的命令，因为我们总是在编辑时推送新状态  
            // 更合理的做法是在文本实际改变时（比如通过另一个信号或函数）推送命令  
            // 这里只是为了演示如何集成 QUndoStack 和 QUndoView  
        }  
    });  
  
    // 将控件添加到布局  
    layout->addWidget(editor);  
    layout->addWidget(undoButton);  
    layout->addWidget(redoButton);  
    layout->addWidget(undoView);  
  
    // 显示窗口  
    window.show();  
  
    return app.exec();  
}  
  
#include "main.moc" // 如果你使用的是 qmake 并且你的 main 函数在一个 .cpp 文件中，这通常是必需的

实现效果

注意

        上面的代码示例有一个逻辑问题，即它每次文本编辑时都会推送一个新的 TextEditCommand，但实际上 m_newText 和编辑器当前的文本是相同的（因为我们总是在文本变化时立即推送命令）。这会导致撤销堆栈中充满了很多“无操作”的命令。

        更合理的做法是在文本真正发生变化（例如，通过某种形式的“提交”操作，如按下 Enter 键或焦点丢失）时推送命令。这可以通过连接不同的信号（如 editingFinished）或使用不同的逻辑来实现。

        此外，上面的代码示例中，TextEditCommand 的构造函数实际上并没有捕获文本变化的“旧”状态，因为我们在文本变化时立即推送了命令。为了正确实现撤销/重做，你需要在文本实际变化之前捕获旧状态，并在变化后捕获新状态。这通常涉及到更复杂的逻辑，可能需要使用不同的信号或自定义逻辑来触发命令的推送。

结语

QUndoView是Qt框架中一个非常有用的控件，它提供了对QUndoStack内容的可视化表示。通过将其与QUndoStack和QUndoCommand结合使用，你可以为你的应用程序实现强大的撤销/重做功能，并为用户提供直观的操作界面。虽然QUndoView本身可能不需要大量的自定义工作，但Qt的灵活性和可扩展性允许你根据需要对其进行调整和优化。

以上就是关于Qt中QUndoView控件的全部介绍，如有不足与缺陷之处，欢迎评论区留言！！！