docs: add xceditor api tree and new resource docs
This commit is contained in:
@@ -0,0 +1,30 @@
|
||||
# UIEditorWorkspaceController::CaptureLayoutSnapshot
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
|
||||
```cpp
|
||||
UIEditorWorkspaceLayoutSnapshot CaptureLayoutSnapshot() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Shell/UIEditorWorkspaceController.h`,当前页面用于固定 `UIEditorWorkspaceController` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `UIEditorWorkspaceLayoutSnapshot` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorWorkspaceController.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorWorkspaceController object;
|
||||
// 根据上下文补齐参数后调用 UIEditorWorkspaceController::CaptureLayoutSnapshot(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorWorkspaceController.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
@@ -0,0 +1,43 @@
|
||||
# UIEditorWorkspaceController::UIEditorWorkspaceController()
|
||||
|
||||
构造对象。
|
||||
|
||||
该方法在 `XCEditor/Shell/UIEditorWorkspaceController.h` 中提供了 2 个重载,当前页面统一汇总这些公开声明。
|
||||
|
||||
## 重载 1: 声明
|
||||
|
||||
```cpp
|
||||
UIEditorWorkspaceController() = default;
|
||||
```
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
## 重载 2: 声明
|
||||
|
||||
```cpp
|
||||
UIEditorWorkspaceController( UIEditorPanelRegistry panelRegistry, UIEditorWorkspaceModel workspace, UIEditorWorkspaceSession session);
|
||||
```
|
||||
|
||||
**参数:**
|
||||
- `panelRegistry` - 参数语义详见头文件声明。
|
||||
- `workspace` - 参数语义详见头文件声明。
|
||||
- `session` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorWorkspaceController.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorWorkspaceController object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorWorkspaceController.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
@@ -0,0 +1,31 @@
|
||||
# UIEditorWorkspaceController::Dispatch
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
|
||||
```cpp
|
||||
UIEditorWorkspaceCommandResult Dispatch(const UIEditorWorkspaceCommand& command);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Shell/UIEditorWorkspaceController.h`,当前页面用于固定 `UIEditorWorkspaceController` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `command` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `UIEditorWorkspaceCommandResult` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorWorkspaceController.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorWorkspaceController object;
|
||||
// 根据上下文补齐参数后调用 UIEditorWorkspaceController::Dispatch(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorWorkspaceController.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
@@ -0,0 +1,30 @@
|
||||
# UIEditorWorkspaceController::GetPanelRegistry
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
const UIEditorPanelRegistry& GetPanelRegistry() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Shell/UIEditorWorkspaceController.h`,当前页面用于固定 `UIEditorWorkspaceController` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `const UIEditorPanelRegistry&` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorWorkspaceController.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorWorkspaceController object;
|
||||
// 根据上下文补齐参数后调用 UIEditorWorkspaceController::GetPanelRegistry(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorWorkspaceController.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
@@ -0,0 +1,30 @@
|
||||
# UIEditorWorkspaceController::GetSession
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
const UIEditorWorkspaceSession& GetSession() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Shell/UIEditorWorkspaceController.h`,当前页面用于固定 `UIEditorWorkspaceController` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `const UIEditorWorkspaceSession&` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorWorkspaceController.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorWorkspaceController object;
|
||||
// 根据上下文补齐参数后调用 UIEditorWorkspaceController::GetSession(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorWorkspaceController.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
@@ -0,0 +1,30 @@
|
||||
# UIEditorWorkspaceController::GetWorkspace
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
const UIEditorWorkspaceModel& GetWorkspace() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Shell/UIEditorWorkspaceController.h`,当前页面用于固定 `UIEditorWorkspaceController` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `const UIEditorWorkspaceModel&` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorWorkspaceController.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorWorkspaceController object;
|
||||
// 根据上下文补齐参数后调用 UIEditorWorkspaceController::GetWorkspace(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorWorkspaceController.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
@@ -0,0 +1,31 @@
|
||||
# UIEditorWorkspaceController::RestoreLayoutSnapshot
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
|
||||
```cpp
|
||||
UIEditorWorkspaceLayoutOperationResult RestoreLayoutSnapshot( const UIEditorWorkspaceLayoutSnapshot& snapshot);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Shell/UIEditorWorkspaceController.h`,当前页面用于固定 `UIEditorWorkspaceController` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `snapshot` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `UIEditorWorkspaceLayoutOperationResult` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorWorkspaceController.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorWorkspaceController object;
|
||||
// 根据上下文补齐参数后调用 UIEditorWorkspaceController::RestoreLayoutSnapshot(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorWorkspaceController.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
@@ -0,0 +1,31 @@
|
||||
# UIEditorWorkspaceController::RestoreSerializedLayout
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
|
||||
```cpp
|
||||
UIEditorWorkspaceLayoutOperationResult RestoreSerializedLayout( std::string_view serializedLayout);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Shell/UIEditorWorkspaceController.h`,当前页面用于固定 `UIEditorWorkspaceController` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `serializedLayout` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `UIEditorWorkspaceLayoutOperationResult` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorWorkspaceController.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorWorkspaceController object;
|
||||
// 根据上下文补齐参数后调用 UIEditorWorkspaceController::RestoreSerializedLayout(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorWorkspaceController.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
@@ -0,0 +1,32 @@
|
||||
# UIEditorWorkspaceController::SetSplitRatio
|
||||
|
||||
设置相关状态或配置。
|
||||
|
||||
```cpp
|
||||
UIEditorWorkspaceLayoutOperationResult SetSplitRatio( std::string_view nodeId, float splitRatio);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Shell/UIEditorWorkspaceController.h`,当前页面用于固定 `UIEditorWorkspaceController` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `nodeId` - 参数语义详见头文件声明。
|
||||
- `splitRatio` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `UIEditorWorkspaceLayoutOperationResult` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorWorkspaceController.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorWorkspaceController object;
|
||||
// 根据上下文补齐参数后调用 UIEditorWorkspaceController::SetSplitRatio(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorWorkspaceController.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
@@ -0,0 +1,47 @@
|
||||
# UIEditorWorkspaceController
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `class`
|
||||
|
||||
**头文件**: `XCEditor/Shell/UIEditorWorkspaceController.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Shell` 子目录中的 `UIEditorWorkspaceController` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorWorkspaceController.h` 是 `XCEditor/Shell` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorWorkspaceCommandKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceCommandStatus` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceCommand` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceCommandResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceControllerValidationCode` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceControllerValidationResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceLayoutOperationStatus` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceLayoutOperationResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceController` | `class` | 头文件中的公开声明。 |
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [UIEditorWorkspaceController()](Constructor.md) | 构造对象。 |
|
||||
| [GetPanelRegistry](GetPanelRegistry.md) | 获取相关状态或对象。 |
|
||||
| [GetWorkspace](GetWorkspace.md) | 获取相关状态或对象。 |
|
||||
| [GetSession](GetSession.md) | 获取相关状态或对象。 |
|
||||
| [ValidateState](ValidateState.md) | 公开方法,详见头文件声明。 |
|
||||
| [CaptureLayoutSnapshot](CaptureLayoutSnapshot.md) | 公开方法,详见头文件声明。 |
|
||||
| [RestoreLayoutSnapshot](RestoreLayoutSnapshot.md) | 公开方法,详见头文件声明。 |
|
||||
| [RestoreSerializedLayout](RestoreSerializedLayout.md) | 公开方法,详见头文件声明。 |
|
||||
| [SetSplitRatio](SetSplitRatio.md) | 设置相关状态或配置。 |
|
||||
| [Dispatch](Dispatch.md) | 公开方法,详见头文件声明。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Shell.md) - 返回 `Shell` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,30 @@
|
||||
# UIEditorWorkspaceController::ValidateState
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
|
||||
```cpp
|
||||
UIEditorWorkspaceControllerValidationResult ValidateState() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Shell/UIEditorWorkspaceController.h`,当前页面用于固定 `UIEditorWorkspaceController` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `UIEditorWorkspaceControllerValidationResult` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorWorkspaceController.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorWorkspaceController object;
|
||||
// 根据上下文补齐参数后调用 UIEditorWorkspaceController::ValidateState(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorWorkspaceController.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
Reference in New Issue
Block a user