undo_redo_manager.h

Go to the documentation of this file.

#ifndef AUBO_SCOPE_UNDO_REDO_MANAGER_H
#define AUBO_SCOPE_UNDO_REDO_MANAGER_H
 
#include <functional>
#include <aubo_caps/class_forward.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(UndoRedoManager);
 
/**
 * @ingroup ProgramApi
 * \chinese
 * 撤销/重做管理器
 * 此接口用于记录终端用户在 AuboCap 程序节点贡献画面中触发的更改（例如，点击按钮时）。
 * 应在 AuboCap 程序节点中使用，以支持 AuboScope 中的撤销/重做功能。
 *
 * 注意：请勿对 AuboCap 安装节点使用此功能，因为它不受支持（且无效）。<br>
 * 注意：此功能不适用于具有基于 HTML 的用户界面的 AuboCap 程序节点，因为这些节点
 * 已支持自动撤销。
 * \endchinese
 * \english
 * UndoRedoManager
 * This interface is used to record changes triggered by an end user in the
 * screen of a AuboCap program node contribution (e.g. when a button is
 * clicked). It should be used in a AuboCap program node to support the
 * Undo/Redo functionality in AuboScope.
 *
 * NOTE: Do not use this functionality for AuboCap installation nodes, since it
 * is not supported (and has no effect). <br>
 * NOTE: This functionality is not relevant for AuboCap program nodes with a
 * HTML-based user interface, since automatic undo is supported for these.
 * \endenglish
 */
class ARCS_ABI_EXPORT UndoRedoManager
{
public:
    UndoRedoManager(UndoRedoManager &f);
    UndoRedoManager(UndoRedoManager &&f);
    virtual ~UndoRedoManager();
 
    /**
     * \chinese
     * <p>
     * 将一组变更归并为一个撤销/重做步骤。
     * </p>
     * 目前撤销/重做支持程序树和数据模型的更改。
     *
     * @param undoableChanges 被记录为一个撤销/重做步骤的代码块。在AuboScope中
     * 按下"撤销"将撤销此代码块内对程序树和数据模型所做的所有更改。
     * \endchinese
     * \english
     * <p>
     * Group changes into one Undo/Redo step.
     * </p>
     *
     * Currently Undo/Redo supports changes to the program tree and the data
     * model.
     *
     * @param undoableChanges Code to be recorded as one Undo/Redo step.
     * Pressing Undo in AuboScope will undo all changes
     * done to the program tree and the data model inside this block of code.
     * \endenglish
     */
    void recordChanges(const std::string &text,
                       std::function<void()> undoableChanges);
 
private:
    friend class DataSwitch;
    UndoRedoManager();
    void *d_{ nullptr };
};
} // namespace aubo_scope
} // namespace arcs
 
#endif