Executes, groups, rolls back and replays arbitrary edit commands. 更多...
#include <EditorTransactions.h>
Public 成员函数 | |
| eve::Result< TransactionId > | beginTransaction (TransactionSpec specification) |
| Begin a canonical checked transaction. | |
| eve::Result< TransactionId > | beginTransaction (std::string label) |
| Begin a checked legacy-command transaction with a generated identity. | |
| eve::Result< void > | append (std::unique_ptr< IEditCommand > command) |
| Stage and preview one command without discarding diagnostics. | |
| eve::Result< EditorTransactionRecord > | commitTransaction () |
| Commit the active transaction and return its complete record. | |
| eve::Result< void > | rollbackTransaction () |
| Discard the active transaction and restore its preview state. | |
| eve::Result< EditorTransactionRecord > | undoTransaction () |
| Compensate the latest committed transaction. | |
| eve::Result< EditorTransactionRecord > | redoTransaction () |
| Reapply the latest compensated transaction. | |
| bool | begin (const std::string &name) |
| Compatibility-only boolean facade over beginTransaction(label). | |
| bool | execute (std::unique_ptr< IEditCommand > command) |
| Compatibility-only boolean facade over append(). | |
| bool | commit () |
| Compatibility-only boolean projection of commitTransaction(). | |
| bool | rollback () |
| Compatibility-only boolean projection of rollbackTransaction(). | |
| bool | undo () |
| Compatibility-only boolean projection of undoTransaction(). | |
| bool | redo () |
| Compatibility-only boolean projection of redoTransaction(). | |
| void | clear () |
| Clears . | |
| bool | isActive () const |
| True when active. | |
| bool | canUndo () const |
| Can undo. | |
| bool | canRedo () const |
| Can redo. | |
| int | undoCount () const |
| Undo count. | |
| int | redoCount () const |
| Redo count. | |
详细描述
Executes, groups, rolls back and replays arbitrary edit commands.
在文件 EditorTransactions.h 第 13 行定义.
成员函数说明
◆ append()
| eve::Result< void > eve::editor::EditorTransactions::append | ( | std::unique_ptr< IEditCommand > | command | ) |
Stage and preview one command without discarding diagnostics.
在文件 EditorTransactions.cpp 第 13 行定义.
引用了 eve::editor::EditorTransactionConsumer::appendPreview().
被这些函数引用 execute() , 以及 eve::editor::EditorSession::executeChecked().
◆ begin()
| bool eve::editor::EditorTransactions::begin | ( | const std::string & | name | ) |
Compatibility-only boolean facade over beginTransaction(label).
在文件 EditorTransactions.cpp 第 25 行定义.
引用了 beginTransaction() , 以及 name.
◆ beginTransaction() [1/2]
| eve::Result< TransactionId > eve::editor::EditorTransactions::beginTransaction | ( | std::string | label | ) |
Begin a checked legacy-command transaction with a generated identity.
在文件 EditorTransactions.cpp 第 9 行定义.
引用了 eve::editor::EditorTransactionConsumer::beginLegacy() , 以及 label.
◆ beginTransaction() [2/2]
| eve::Result< TransactionId > eve::editor::EditorTransactions::beginTransaction | ( | TransactionSpec | specification | ) |
Begin a canonical checked transaction.
在文件 EditorTransactions.cpp 第 5 行定义.
引用了 eve::editor::EditorTransactionConsumer::begin().
被这些函数引用 begin() , 以及 eve::editor::EditorSession::executeCommand().
◆ canRedo()
|
inline |
Can redo.
在文件 EditorTransactions.h 第 49 行定义.
◆ canUndo()
|
inline |
Can undo.
在文件 EditorTransactions.h 第 47 行定义.
◆ clear()
| void eve::editor::EditorTransactions::clear | ( | ) |
◆ commit()
| bool eve::editor::EditorTransactions::commit | ( | ) |
Compatibility-only boolean projection of commitTransaction().
在文件 EditorTransactions.cpp 第 33 行定义.
引用了 commitTransaction().
◆ commitTransaction()
| eve::Result< EditorTransactionRecord > eve::editor::EditorTransactions::commitTransaction | ( | ) |
Commit the active transaction and return its complete record.
在文件 EditorTransactions.cpp 第 17 行定义.
引用了 eve::editor::EditorTransactionConsumer::commit().
被这些函数引用 commit() , 以及 eve::editor::EditorSession::executeCommand().
◆ execute()
| bool eve::editor::EditorTransactions::execute | ( | std::unique_ptr< IEditCommand > | command | ) |
◆ isActive()
|
inline |
True when active.
在文件 EditorTransactions.h 第 45 行定义.
◆ redo()
| bool eve::editor::EditorTransactions::redo | ( | ) |
Compatibility-only boolean projection of redoTransaction().
在文件 EditorTransactions.cpp 第 45 行定义.
引用了 redoTransaction().
◆ redoCount()
|
inline |
Redo count.
在文件 EditorTransactions.h 第 53 行定义.
◆ redoTransaction()
| eve::Result< EditorTransactionRecord > eve::editor::EditorTransactions::redoTransaction | ( | ) |
Reapply the latest compensated transaction.
在文件 EditorTransactions.cpp 第 23 行定义.
引用了 eve::editor::EditorTransactionConsumer::redo().
被这些函数引用 redo().
◆ rollback()
| bool eve::editor::EditorTransactions::rollback | ( | ) |
Compatibility-only boolean projection of rollbackTransaction().
在文件 EditorTransactions.cpp 第 37 行定义.
◆ rollbackTransaction()
| eve::Result< void > eve::editor::EditorTransactions::rollbackTransaction | ( | ) |
Discard the active transaction and restore its preview state.
在文件 EditorTransactions.cpp 第 19 行定义.
引用了 eve::editor::EditorTransactionConsumer::rollback().
被这些函数引用 eve::editor::EditorSession::executeCommand() , 以及 rollback().
◆ undo()
| bool eve::editor::EditorTransactions::undo | ( | ) |
Compatibility-only boolean projection of undoTransaction().
在文件 EditorTransactions.cpp 第 41 行定义.
引用了 undoTransaction().
◆ undoCount()
|
inline |
Undo count.
在文件 EditorTransactions.h 第 51 行定义.
◆ undoTransaction()
| eve::Result< EditorTransactionRecord > eve::editor::EditorTransactions::undoTransaction | ( | ) |
Compensate the latest committed transaction.
在文件 EditorTransactions.cpp 第 21 行定义.
引用了 eve::editor::EditorTransactionConsumer::undo().
被这些函数引用 undo().
该类的文档由以下文件生成:
- src/modules/editor/EditorTransactions.h
- src/modules/editor/EditorTransactions.cpp