docs: add xceditor api tree and new resource docs
This commit is contained in:
@@ -0,0 +1,41 @@
|
||||
# UIEditorCommandDispatcher::UIEditorCommandDispatcher()
|
||||
|
||||
构造对象。
|
||||
|
||||
该方法在 `XCEditor/Foundation/UIEditorCommandDispatcher.h` 中提供了 2 个重载,当前页面统一汇总这些公开声明。
|
||||
|
||||
## 重载 1: 声明
|
||||
|
||||
```cpp
|
||||
UIEditorCommandDispatcher() = default;
|
||||
```
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
## 重载 2: 声明
|
||||
|
||||
```cpp
|
||||
explicit UIEditorCommandDispatcher(UIEditorCommandRegistry commandRegistry);
|
||||
```
|
||||
|
||||
**参数:**
|
||||
- `commandRegistry` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Foundation/UIEditorCommandDispatcher.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorCommandDispatcher object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorCommandDispatcher.md)
|
||||
- [返回模块目录](../Foundation.md)
|
||||
@@ -0,0 +1,32 @@
|
||||
# UIEditorCommandDispatcher::Dispatch
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
|
||||
```cpp
|
||||
UIEditorCommandDispatchResult Dispatch( std::string_view commandId, UIEditorWorkspaceController& controller) const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Foundation/UIEditorCommandDispatcher.h`,当前页面用于固定 `UIEditorCommandDispatcher` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `commandId` - 参数语义详见头文件声明。
|
||||
- `controller` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `UIEditorCommandDispatchResult` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Foundation/UIEditorCommandDispatcher.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorCommandDispatcher object;
|
||||
// 根据上下文补齐参数后调用 UIEditorCommandDispatcher::Dispatch(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorCommandDispatcher.md)
|
||||
- [返回模块目录](../Foundation.md)
|
||||
@@ -0,0 +1,32 @@
|
||||
# UIEditorCommandDispatcher::Evaluate
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
|
||||
```cpp
|
||||
UIEditorCommandEvaluationResult Evaluate( std::string_view commandId, const UIEditorWorkspaceController& controller) const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Foundation/UIEditorCommandDispatcher.h`,当前页面用于固定 `UIEditorCommandDispatcher` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `commandId` - 参数语义详见头文件声明。
|
||||
- `controller` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `UIEditorCommandEvaluationResult` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Foundation/UIEditorCommandDispatcher.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorCommandDispatcher object;
|
||||
// 根据上下文补齐参数后调用 UIEditorCommandDispatcher::Evaluate(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorCommandDispatcher.md)
|
||||
- [返回模块目录](../Foundation.md)
|
||||
@@ -0,0 +1,30 @@
|
||||
# UIEditorCommandDispatcher::GetCommandRegistry
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
const UIEditorCommandRegistry& GetCommandRegistry() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Foundation/UIEditorCommandDispatcher.h`,当前页面用于固定 `UIEditorCommandDispatcher` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `const UIEditorCommandRegistry&` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Foundation/UIEditorCommandDispatcher.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorCommandDispatcher object;
|
||||
// 根据上下文补齐参数后调用 UIEditorCommandDispatcher::GetCommandRegistry(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorCommandDispatcher.md)
|
||||
- [返回模块目录](../Foundation.md)
|
||||
@@ -0,0 +1,30 @@
|
||||
# UIEditorCommandDispatcher::GetHostCommandHandler
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
UIEditorHostCommandHandler* GetHostCommandHandler() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Foundation/UIEditorCommandDispatcher.h`,当前页面用于固定 `UIEditorCommandDispatcher` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `UIEditorHostCommandHandler*` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Foundation/UIEditorCommandDispatcher.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorCommandDispatcher object;
|
||||
// 根据上下文补齐参数后调用 UIEditorCommandDispatcher::GetHostCommandHandler(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorCommandDispatcher.md)
|
||||
- [返回模块目录](../Foundation.md)
|
||||
@@ -0,0 +1,31 @@
|
||||
# UIEditorCommandDispatcher::SetHostCommandHandler
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void SetHostCommandHandler(UIEditorHostCommandHandler* handler);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Foundation/UIEditorCommandDispatcher.h`,当前页面用于固定 `UIEditorCommandDispatcher` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `handler` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Foundation/UIEditorCommandDispatcher.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorCommandDispatcher object;
|
||||
// 根据上下文补齐参数后调用 UIEditorCommandDispatcher::SetHostCommandHandler(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorCommandDispatcher.md)
|
||||
- [返回模块目录](../Foundation.md)
|
||||
@@ -0,0 +1,43 @@
|
||||
# UIEditorCommandDispatcher
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `class`
|
||||
|
||||
**头文件**: `XCEditor/Foundation/UIEditorCommandDispatcher.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Foundation` 子目录中的 `UIEditorCommandDispatcher` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorCommandDispatcher.h` 是 `XCEditor/Foundation` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorHostCommandEvaluationResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorHostCommandDispatchResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorHostCommandHandler` | `class` | 头文件中的公开声明。 |
|
||||
| `UIEditorCommandEvaluationCode` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorCommandEvaluationResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorCommandDispatchStatus` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorCommandDispatchResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorCommandDispatcher` | `class` | 头文件中的公开声明。 |
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [UIEditorCommandDispatcher()](Constructor.md) | 构造对象。 |
|
||||
| [GetCommandRegistry](GetCommandRegistry.md) | 获取相关状态或对象。 |
|
||||
| [SetHostCommandHandler](SetHostCommandHandler.md) | 设置相关状态或配置。 |
|
||||
| [GetHostCommandHandler](GetHostCommandHandler.md) | 获取相关状态或对象。 |
|
||||
| [ValidateConfiguration](ValidateConfiguration.md) | 公开方法,详见头文件声明。 |
|
||||
| [Evaluate](Evaluate.md) | 公开方法,详见头文件声明。 |
|
||||
| [Dispatch](Dispatch.md) | 公开方法,详见头文件声明。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Foundation.md) - 返回 `Foundation` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,30 @@
|
||||
# UIEditorCommandDispatcher::ValidateConfiguration
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
|
||||
```cpp
|
||||
UIEditorCommandRegistryValidationResult ValidateConfiguration() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Foundation/UIEditorCommandDispatcher.h`,当前页面用于固定 `UIEditorCommandDispatcher` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `UIEditorCommandRegistryValidationResult` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Foundation/UIEditorCommandDispatcher.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorCommandDispatcher object;
|
||||
// 根据上下文补齐参数后调用 UIEditorCommandDispatcher::ValidateConfiguration(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorCommandDispatcher.md)
|
||||
- [返回模块目录](../Foundation.md)
|
||||
Reference in New Issue
Block a user