docs: add xceditor api tree and new resource docs
This commit is contained in:
40
docs/api/XCEditor/Foundation/Foundation.md
Normal file
40
docs/api/XCEditor/Foundation/Foundation.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Foundation
|
||||
|
||||
**命名空间**: `XCEngine::UI::Editor`
|
||||
|
||||
**类型**: `submodule`
|
||||
|
||||
**描述**: 编辑器基础设施子模块,覆盖命令注册、命令派发、快捷键管理以及主题度量解析入口。
|
||||
|
||||
## 概述
|
||||
|
||||
`Foundation` 负责把 shell 壳层的静态配置转换成运行时可执行的命令与快捷键系统。按当前头文件分工:
|
||||
|
||||
- `UIEditorCommandRegistry.h`
|
||||
- 声明命令描述、workspace 命令描述和注册表校验规则
|
||||
- `UIEditorCommandDispatcher.h`
|
||||
- 把命令 id 分发到 workspace controller 或 host command handler
|
||||
- `UIEditorShortcutManager.h`
|
||||
- 在 `UIShortcutRegistry` 之上管理绑定、校验冲突并执行调度
|
||||
- `UIEditorTheme.h`
|
||||
- 汇总 Collections / Fields / Shell 各控件的 metrics 与 palette 解析入口
|
||||
|
||||
`new_editor/app/Application.cpp` 当前会构造 `UIEditorWorkspaceController`,再通过 `BuildEditorShellShortcutManager(...)` 接入这一层。
|
||||
|
||||
## 公开头文件
|
||||
|
||||
- `UIEditorCommandDispatcher.h`
|
||||
- `UIEditorCommandRegistry.h`
|
||||
- `UIEditorShortcutManager.h`
|
||||
- `UIEditorTheme.h`
|
||||
|
||||
## 当前实现边界
|
||||
|
||||
- 当前这里只建立目录索引页,具体头文件页仍需后续补齐。
|
||||
- 该模块不直接渲染 UI,而是为 `Shell` 与各控件模块提供命令、快捷键、主题和度量解析能力。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [XCEditor](../XCEditor.md)
|
||||
- [Shell](../Shell/Shell.md)
|
||||
- [Widgets](../Widgets/Widgets.md)
|
||||
@@ -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)
|
||||
@@ -0,0 +1,36 @@
|
||||
# UIEditorCommandRegistry
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Foundation/UIEditorCommandRegistry.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Foundation` 子目录中的 `UIEditorCommandRegistry` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorCommandRegistry.h` 是 `XCEditor/Foundation` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorCommandKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorCommandPanelSource` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceCommandDescriptor` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorCommandDescriptor` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorCommandRegistry` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorCommandRegistryValidationCode` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorCommandRegistryValidationResult` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `commands` | `std::vector<UIEditorCommandDescriptor>` | 结构体公开字段。 | `{}` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Foundation.md) - 返回 `Foundation` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,30 @@
|
||||
# UIEditorShortcutManager::ClearBindings
|
||||
|
||||
清空内部数据。
|
||||
|
||||
```cpp
|
||||
void ClearBindings();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Foundation/UIEditorShortcutManager.h`,当前页面用于固定 `UIEditorShortcutManager` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Foundation/UIEditorShortcutManager.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorShortcutManager object;
|
||||
// 根据上下文补齐参数后调用 UIEditorShortcutManager::ClearBindings(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorShortcutManager.md)
|
||||
- [返回模块目录](../Foundation.md)
|
||||
@@ -0,0 +1,41 @@
|
||||
# UIEditorShortcutManager::UIEditorShortcutManager()
|
||||
|
||||
构造对象。
|
||||
|
||||
该方法在 `XCEditor/Foundation/UIEditorShortcutManager.h` 中提供了 2 个重载,当前页面统一汇总这些公开声明。
|
||||
|
||||
## 重载 1: 声明
|
||||
|
||||
```cpp
|
||||
UIEditorShortcutManager() = default;
|
||||
```
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
## 重载 2: 声明
|
||||
|
||||
```cpp
|
||||
explicit UIEditorShortcutManager(UIEditorCommandRegistry commandRegistry);
|
||||
```
|
||||
|
||||
**参数:**
|
||||
- `commandRegistry` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Foundation/UIEditorShortcutManager.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorShortcutManager object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorShortcutManager.md)
|
||||
- [返回模块目录](../Foundation.md)
|
||||
@@ -0,0 +1,33 @@
|
||||
# UIEditorShortcutManager::Dispatch
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
|
||||
```cpp
|
||||
UIEditorShortcutDispatchResult Dispatch( const XCEngine::UI::UIInputEvent& event, const XCEngine::UI::UIShortcutContext& shortcutContext, UIEditorWorkspaceController& controller) const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Foundation/UIEditorShortcutManager.h`,当前页面用于固定 `UIEditorShortcutManager` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `event` - 参数语义详见头文件声明。
|
||||
- `shortcutContext` - 参数语义详见头文件声明。
|
||||
- `controller` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `UIEditorShortcutDispatchResult` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Foundation/UIEditorShortcutManager.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorShortcutManager object;
|
||||
// 根据上下文补齐参数后调用 UIEditorShortcutManager::Dispatch(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorShortcutManager.md)
|
||||
- [返回模块目录](../Foundation.md)
|
||||
@@ -0,0 +1,30 @@
|
||||
# UIEditorShortcutManager::GetCommandDispatcher
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
const UIEditorCommandDispatcher& GetCommandDispatcher() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Foundation/UIEditorShortcutManager.h`,当前页面用于固定 `UIEditorShortcutManager` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `const UIEditorCommandDispatcher&` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Foundation/UIEditorShortcutManager.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorShortcutManager object;
|
||||
// 根据上下文补齐参数后调用 UIEditorShortcutManager::GetCommandDispatcher(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorShortcutManager.md)
|
||||
- [返回模块目录](../Foundation.md)
|
||||
@@ -0,0 +1,30 @@
|
||||
# UIEditorShortcutManager::GetCommandRegistry
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
const UIEditorCommandRegistry& GetCommandRegistry() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Foundation/UIEditorShortcutManager.h`,当前页面用于固定 `UIEditorShortcutManager` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `const UIEditorCommandRegistry&` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Foundation/UIEditorShortcutManager.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorShortcutManager object;
|
||||
// 根据上下文补齐参数后调用 UIEditorShortcutManager::GetCommandRegistry(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorShortcutManager.md)
|
||||
- [返回模块目录](../Foundation.md)
|
||||
@@ -0,0 +1,30 @@
|
||||
# UIEditorShortcutManager::GetHostCommandHandler
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
UIEditorHostCommandHandler* GetHostCommandHandler() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Foundation/UIEditorShortcutManager.h`,当前页面用于固定 `UIEditorShortcutManager` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `UIEditorHostCommandHandler*` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Foundation/UIEditorShortcutManager.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorShortcutManager object;
|
||||
// 根据上下文补齐参数后调用 UIEditorShortcutManager::GetHostCommandHandler(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorShortcutManager.md)
|
||||
- [返回模块目录](../Foundation.md)
|
||||
@@ -0,0 +1,31 @@
|
||||
# UIEditorShortcutManager::GetPreferredShortcutText
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
std::string GetPreferredShortcutText(std::string_view commandId) const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Foundation/UIEditorShortcutManager.h`,当前页面用于固定 `UIEditorShortcutManager` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `commandId` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `std::string` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Foundation/UIEditorShortcutManager.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorShortcutManager object;
|
||||
// 根据上下文补齐参数后调用 UIEditorShortcutManager::GetPreferredShortcutText(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorShortcutManager.md)
|
||||
- [返回模块目录](../Foundation.md)
|
||||
@@ -0,0 +1,30 @@
|
||||
# UIEditorShortcutManager::GetShortcutRegistry
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
const XCEngine::UI::UIShortcutRegistry& GetShortcutRegistry() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Foundation/UIEditorShortcutManager.h`,当前页面用于固定 `UIEditorShortcutManager` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `const XCEngine::UI::UIShortcutRegistry&` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Foundation/UIEditorShortcutManager.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorShortcutManager object;
|
||||
// 根据上下文补齐参数后调用 UIEditorShortcutManager::GetShortcutRegistry(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorShortcutManager.md)
|
||||
- [返回模块目录](../Foundation.md)
|
||||
@@ -0,0 +1,31 @@
|
||||
# UIEditorShortcutManager::RegisterBinding
|
||||
|
||||
注册对象、回调或映射。
|
||||
|
||||
```cpp
|
||||
std::uint64_t RegisterBinding(const XCEngine::UI::UIShortcutBinding& binding);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Foundation/UIEditorShortcutManager.h`,当前页面用于固定 `UIEditorShortcutManager` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `binding` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `std::uint64_t` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Foundation/UIEditorShortcutManager.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorShortcutManager object;
|
||||
// 根据上下文补齐参数后调用 UIEditorShortcutManager::RegisterBinding(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorShortcutManager.md)
|
||||
- [返回模块目录](../Foundation.md)
|
||||
@@ -0,0 +1,31 @@
|
||||
# UIEditorShortcutManager::SetHostCommandHandler
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
void SetHostCommandHandler(UIEditorHostCommandHandler* handler);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Foundation/UIEditorShortcutManager.h`,当前页面用于固定 `UIEditorShortcutManager` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `handler` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Foundation/UIEditorShortcutManager.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorShortcutManager object;
|
||||
// 根据上下文补齐参数后调用 UIEditorShortcutManager::SetHostCommandHandler(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorShortcutManager.md)
|
||||
- [返回模块目录](../Foundation.md)
|
||||
@@ -0,0 +1,45 @@
|
||||
# UIEditorShortcutManager
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `class`
|
||||
|
||||
**头文件**: `XCEditor/Foundation/UIEditorShortcutManager.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Foundation` 子目录中的 `UIEditorShortcutManager` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorShortcutManager.h` 是 `XCEditor/Foundation` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorShortcutManagerValidationCode` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorShortcutManagerValidationResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorShortcutDispatchStatus` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorShortcutDispatchResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorShortcutManager` | `class` | 头文件中的公开声明。 |
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [UIEditorShortcutManager()](Constructor.md) | 构造对象。 |
|
||||
| [GetCommandDispatcher](GetCommandDispatcher.md) | 获取相关状态或对象。 |
|
||||
| [SetHostCommandHandler](SetHostCommandHandler.md) | 设置相关状态或配置。 |
|
||||
| [GetHostCommandHandler](GetHostCommandHandler.md) | 获取相关状态或对象。 |
|
||||
| [GetCommandRegistry](GetCommandRegistry.md) | 获取相关状态或对象。 |
|
||||
| [GetShortcutRegistry](GetShortcutRegistry.md) | 获取相关状态或对象。 |
|
||||
| [RegisterBinding](RegisterBinding.md) | 注册对象、回调或映射。 |
|
||||
| [UnregisterBinding](UnregisterBinding.md) | 取消注册对象、回调或映射。 |
|
||||
| [ClearBindings](ClearBindings.md) | 清空内部数据。 |
|
||||
| [ValidateConfiguration](ValidateConfiguration.md) | 公开方法,详见头文件声明。 |
|
||||
| [GetPreferredShortcutText](GetPreferredShortcutText.md) | 获取相关状态或对象。 |
|
||||
| [Dispatch](Dispatch.md) | 公开方法,详见头文件声明。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Foundation.md) - 返回 `Foundation` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,31 @@
|
||||
# UIEditorShortcutManager::UnregisterBinding
|
||||
|
||||
取消注册对象、回调或映射。
|
||||
|
||||
```cpp
|
||||
bool UnregisterBinding(std::uint64_t bindingId);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Foundation/UIEditorShortcutManager.h`,当前页面用于固定 `UIEditorShortcutManager` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `bindingId` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `bool` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Foundation/UIEditorShortcutManager.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorShortcutManager object;
|
||||
// 根据上下文补齐参数后调用 UIEditorShortcutManager::UnregisterBinding(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorShortcutManager.md)
|
||||
- [返回模块目录](../Foundation.md)
|
||||
@@ -0,0 +1,30 @@
|
||||
# UIEditorShortcutManager::ValidateConfiguration
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
|
||||
```cpp
|
||||
UIEditorShortcutManagerValidationResult ValidateConfiguration() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Foundation/UIEditorShortcutManager.h`,当前页面用于固定 `UIEditorShortcutManager` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `UIEditorShortcutManagerValidationResult` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Foundation/UIEditorShortcutManager.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorShortcutManager object;
|
||||
// 根据上下文补齐参数后调用 UIEditorShortcutManager::ValidateConfiguration(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorShortcutManager.md)
|
||||
- [返回模块目录](../Foundation.md)
|
||||
18
docs/api/XCEditor/Foundation/UIEditorTheme/UIEditorTheme.md
Normal file
18
docs/api/XCEditor/Foundation/UIEditorTheme/UIEditorTheme.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# UIEditorTheme
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `header`
|
||||
|
||||
**头文件**: `XCEditor/Foundation/UIEditorTheme.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Foundation` 子目录中的 `UIEditorTheme` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorTheme.h` 是 `XCEditor/Foundation` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Foundation.md) - 返回 `Foundation` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
Reference in New Issue
Block a user