xuanchi/XCEngine
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add xceditor api tree and new resource docs

Browse Source
This commit is contained in:
ssdfasd
2026-04-10 17:10:42 +08:00
parent 6b90c2f6c3
commit 66ae9ec919
189 changed files with 6613 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/api/XCEditor/Foundation/UIEditorShortcutManager/ClearBindings.md Normal file
View File

@@ -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)

41
docs/api/XCEditor/Foundation/UIEditorShortcutManager/Constructor.md Normal file
View File

@@ -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)

33
docs/api/XCEditor/Foundation/UIEditorShortcutManager/Dispatch.md Normal file
View File

@@ -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)

30
docs/api/XCEditor/Foundation/UIEditorShortcutManager/GetCommandDispatcher.md Normal file
View File

@@ -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)

30
docs/api/XCEditor/Foundation/UIEditorShortcutManager/GetCommandRegistry.md Normal file
View File

@@ -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)

30
docs/api/XCEditor/Foundation/UIEditorShortcutManager/GetHostCommandHandler.md Normal file
View File

@@ -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)

31
docs/api/XCEditor/Foundation/UIEditorShortcutManager/GetPreferredShortcutText.md Normal file
View File

@@ -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)

30
docs/api/XCEditor/Foundation/UIEditorShortcutManager/GetShortcutRegistry.md Normal file
View File

@@ -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)

31
docs/api/XCEditor/Foundation/UIEditorShortcutManager/RegisterBinding.md Normal file
View File

@@ -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)

31
docs/api/XCEditor/Foundation/UIEditorShortcutManager/SetHostCommandHandler.md Normal file
View File

@@ -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)

45
docs/api/XCEditor/Foundation/UIEditorShortcutManager/UIEditorShortcutManager.md Normal file
View File

@@ -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) - 返回顶层索引

31
docs/api/XCEditor/Foundation/UIEditorShortcutManager/UnregisterBinding.md Normal file
View File

@@ -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)

30
docs/api/XCEditor/Foundation/UIEditorShortcutManager/ValidateConfiguration.md Normal file
View File

@@ -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)