Qt Undo Framework Demo
eryar@163.com
Abstract. Qt’s Undo Framework is an implementation of the Command Pattern, for implementing undo/redo functionality in applications. The Command pattern is based on the idea that all editing in an application is done by creating instances of command objects. Command objects apply changes to the document and are stored on a command stack. Furthermore, each command knows how to undo its changes to bring the document back to its previous state. As long as the application only uses command objects to change the state of the document, it is possible to undo a sequence of commands by traversing the stack downwards and calling undo on each command in turn. It is also possible to redo a sequence of commands by traversing the stack upwards and calling redo on each command.
Key Words. Qt, Undo/Redo, Command Pattern, Model/View
1. Introduction
在交互應用程序中撤銷和重做（Undo/Redo）能力是很重要的。像常見的軟件Office，AutoCAD等，有了撤銷功能，用戶體驗更舒服。一般都會使用Command模式來實現這一功能。
命令模式通過將請求本身變成一個對象來使工具箱對象可向未指定的應用對象提出請求，這個對象可被存儲并像其他對象一樣被傳遞。這一模式的關鍵是一個抽象的Command類，它定義了一個可執行操作的接口。其最簡單的形式是一個抽象的Execute操作。具體的Command子類將接收者作為其一個實例變量，并實現Execute操作，指定接收者采取動作，而接收者執行該請求所需要的具體信息。在GoF的《Design Patterns》中，給出了Command模式的一般結構，如圖1.1所示：
Figure 1.1 Command pattern structure
將一個請求封裝為一個對象，從而使你可用不同的請求對客戶進行參數化；對請求排隊或記錄成日志，以及支持可撤銷的操作。
支持任意層次的撤銷和重做命令的最后一步是定義一個命令歷史記錄（Command History），或稱為已執行的命令列表。從概念上理解，命令的歷史記錄看起來有如下形狀：
Figure 1.2 Command History
每個圓代表一個Command對象，標有present的對象即為當前命令對象。當我們調用Unexecute()后，標有present的對象將會向左移；當調用Execute()，標有present的對象將會向右移。重復這個過程，我們可以進行多層次的撤銷，層次數只受命令歷史記錄長度的限制。
在Qt的Undo框架中主要包括以下幾個類：
v QUndoCommand：這個類相當于Command模式中的那個抽象基類Command，所有這些命令都被保存到undo棧中，在其派生類中實現undo和redo函數。
v QUndoStack：這個相當于命令歷史記錄，其中保存了Command對象的列表。
v QUndoGroup：是一個undo stack的組合。
v QUndoView：是顯示undo堆棧中內容的一個列表組件，在這個視圖中點擊命令的名稱也可以實現與Undo/Redo按鈕相同的作用。
本文通過一個簡單的例子來示例Qt中Undo框架，先在簡單的List模型中實現，進而在Tree上實現。掌握Qt的這個框架，就可以不用OpenCASCADE的OCAF了，并且Qt的代碼用起來還是相對簡單清晰的。
2.Example
Qt提供了一個Undo框架的示例，程序還涉及到圖形繪制相關的內容，程序效果如下圖2.1所示：
Figure 2.1 Qt Undo Framework Example
結合這個示例程序，學習一下Qt的Undo框架，從而寫出一個更簡單的程序，代碼如下所示：
class InsertCommand : public QUndoCommand
{
public:
InsertCommand(const QModelIndex& theIndex, QStringListModel* theModel);
~InsertCommand();
public:
virtual void undo();
virtual void redo();
private:
QModelIndex mIndex;
QStringListModel* mModel;
};
首先，從QUndoCommand派生出一個插件字符串的類InsertCommand，并要實現undo()和redo()這兩個虛函數，實現代碼如下所示：
void InsertCommand::undo()
{
mModel->removeRows(mIndex.row(), 1);
}
void InsertCommand::redo()
{
mModel->insertRows(mIndex.row(), 1);
mModel->setData(mIndex, QString("Insert string " + QString::number(mIndex.row())));
}
這樣在響應工具欄按鈕的函數中，只需要生成這個命令，并將命令加入到命令棧中即可，代碼如下：
void undoTest::insertString()
{
QModelIndex aIndex = mListView->currentIndex();
mUndoStack->push(new InsertCommand(aIndex, mListModel));
}
程序運行效果如下圖2.2所示：
Figure 2.3 Test Qt Undo Framework
通過工具欄上的undo/redo及命令列表中選擇，都可以實現命令的回退及重做。完整的程序代碼可通過文后鏈接下載。
3.Conclusion
在學習C++基本語法后，可以看看GoF的《設計模式》。剛剛接觸可能感覺有些抽象，這時可以使用Qt來編寫一些程序來練練手。用Qt來編程感覺比MFC要舒服很多，有些類封裝得很直接，易于使用。盡管MFC中也有個Document/View的設計模式，但是Qt中的MVC用起來更直接。通過使用現有的框架，來理解那些抽象的設計模式，從而加深面向對象的觀念，讓自己的程序更簡單，有趣。
OpenCASCADE的OCAF框架也提供了一個數據框架，基于這個樹形的框架，可以存儲層次表示的數據，且也提供了Undo/Redo的支持。基于OCAF框架，可以快速開發出一定功能的專業軟件了。但是要使用OCAF框架，涉及的OpenCASCADE庫很多。如果打算開發一個輕量級的三維程序，而又正好選擇了Qt來開發GUI，這時就可以考慮使用Qt的MVC框架及在這個框架上的Undo/Redo功能，這樣開發效率可以相對高一些，且程序發布時依賴的動態庫也要少很多。
流行的工廠設計軟件中的數據框架多用樹形結構，樹中每個結點上的屬性可以讓用戶自由擴展，像OCAF中通過TDataStd_Integer添加一些整數屬性一樣，及用TDataStd_Name添加名稱屬性。但是OCAF中添加屬性有些局限性，因為每種屬性是用GUID來區別的，所以每個結點上同一種屬性只能有一個。
所以用Qt的MVC框架來根據需要實現一個自定義的樹形Model，再基于V3d_Viewer實現一個顯示三維的View，即可以實現一個簡單，但看上去相對專業的CAD建模程序了。
4. References
1. GoF. Design Patterns-Elements of Reusable Object-Oriented Software.機械工業出版社. 2010
2. Qt5.4. Overview of Qt’s Undo Framework. 2014
3. Qt5.4. Undo Framework Example. 2014
4. OpenCASCADE6.8.0. OCAF. 2014
5. OpenCASCADE6.8.0. OCAF White Paper. 2014
6. OpenCASCADE6.8.0. Distribution of Data Through OCAF Tree. 2014