docs: add xceditor api tree and new resource docs
This commit is contained in:
74
docs/api/XCEditor/Shell/Shell.md
Normal file
74
docs/api/XCEditor/Shell/Shell.md
Normal file
@@ -0,0 +1,74 @@
|
||||
# Shell
|
||||
|
||||
**命名空间**: `XCEngine::UI::Editor`
|
||||
|
||||
**类型**: `submodule`
|
||||
|
||||
**描述**: 编辑器壳层子模块，覆盖 menu、dock、workspace、viewport slot、panel registry 以及整套 shell compose / interaction 流程。
|
||||
|
||||
## 概述
|
||||
|
||||
`Shell` 是当前新编辑器 public headers 中最靠近应用层的一层。按 `new_editor/app/Application.cpp` 当前启动链：
|
||||
|
||||
1. 先构造 `EditorShellAsset`
|
||||
2. 用 `ValidateEditorShellAsset(...)` 校验 panel / workspace / shortcut 配置
|
||||
3. 创建 `UIEditorWorkspaceController`
|
||||
4. 在每帧中调用 `UpdateUIEditorShellInteraction(...)`
|
||||
5. 再调用 `AppendUIEditorShellInteraction(...)` 输出绘制数据
|
||||
|
||||
因此这个子模块既包含纯数据模型，也包含布局与交互协议：
|
||||
|
||||
- shell 资产与配置
|
||||
- `UIEditorShellAsset.h`
|
||||
- `UIEditorPanelRegistry.h`
|
||||
- `UIEditorWorkspaceModel.h`
|
||||
- `UIEditorWorkspaceSession.h`
|
||||
- 壳层布局与交互
|
||||
- `UIEditorShellCompose.h`
|
||||
- `UIEditorShellInteraction.h`
|
||||
- `UIEditorWorkspaceCompose.h`
|
||||
- `UIEditorWorkspaceInteraction.h`
|
||||
- 具体面板宿主与框架控件
|
||||
- `UIEditorDockHost*`
|
||||
- `UIEditorMenu*`
|
||||
- `UIEditorStatusBar.h`
|
||||
- `UIEditorViewportSlot.h`
|
||||
- `UIEditorViewportShell.h`
|
||||
|
||||
## 公开头文件
|
||||
|
||||
- `UIEditorDockHost.h`
|
||||
- `UIEditorDockHostInteraction.h`
|
||||
- `UIEditorMenuBar.h`
|
||||
- `UIEditorMenuModel.h`
|
||||
- `UIEditorMenuPopup.h`
|
||||
- `UIEditorMenuSession.h`
|
||||
- `UIEditorPanelContentHost.h`
|
||||
- `UIEditorPanelFrame.h`
|
||||
- `UIEditorPanelHostLifecycle.h`
|
||||
- `UIEditorPanelRegistry.h`
|
||||
- `UIEditorShellAsset.h`
|
||||
- `UIEditorShellCompose.h`
|
||||
- `UIEditorShellInteraction.h`
|
||||
- `UIEditorStatusBar.h`
|
||||
- `UIEditorStructuredShell.h`
|
||||
- `UIEditorViewportInputBridge.h`
|
||||
- `UIEditorViewportShell.h`
|
||||
- `UIEditorViewportSlot.h`
|
||||
- `UIEditorWorkspaceCompose.h`
|
||||
- `UIEditorWorkspaceController.h`
|
||||
- `UIEditorWorkspaceInteraction.h`
|
||||
- `UIEditorWorkspaceLayoutPersistence.h`
|
||||
- `UIEditorWorkspaceModel.h`
|
||||
- `UIEditorWorkspaceSession.h`
|
||||
|
||||
## 当前实现边界
|
||||
|
||||
- 当前这里只建立目录索引页，具体头文件页仍需后续分批补齐。
|
||||
- 这层 public API 面向新编辑器宿主；旧版 `editor/src/Viewport/**` 的 source-backed helper 不属于这里。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [XCEditor](../XCEditor.md)
|
||||
- [Foundation](../Foundation/Foundation.md)
|
||||
- [Fields](../Fields/Fields.md)
|
||||
49
docs/api/XCEditor/Shell/UIEditorDockHost/UIEditorDockHost.md
Normal file
49
docs/api/XCEditor/Shell/UIEditorDockHost/UIEditorDockHost.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# UIEditorDockHost
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEditor/Shell/UIEditorDockHost.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Shell` 子目录中的 `UIEditorDockHost` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorDockHost.h` 是 `XCEditor/Shell` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorDockHostHitTargetKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorDockHostHitTarget` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorDockHostTabStripVisualState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorDockHostState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorDockHostMetrics` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorDockHostPalette` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorDockHostTabItemLayout` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorDockHostSplitterLayout` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorDockHostPanelLayout` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorDockHostTabStackLayout` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorDockHostLayout` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorDockHostForegroundOptions` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `None` | `0` | 枚举项。 |
|
||||
| `SplitterHandle` | - | 枚举项。 |
|
||||
| `TabStripBackground` | - | 枚举项。 |
|
||||
| `Tab` | - | 枚举项。 |
|
||||
| `TabCloseButton` | - | 枚举项。 |
|
||||
| `PanelHeader` | - | 枚举项。 |
|
||||
| `PanelBody` | - | 枚举项。 |
|
||||
| `PanelFooter` | - | 枚举项。 |
|
||||
| `PanelCloseButton` | - | 枚举项。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Shell.md) - 返回 `Shell` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,34 @@
|
||||
# UIEditorDockHostInteraction
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Shell/UIEditorDockHostInteraction.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Shell` 子目录中的 `UIEditorDockHostInteraction` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorDockHostInteraction.h` 是 `XCEditor/Shell` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorDockHostTabStripInteractionEntry` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorDockHostInteractionState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorDockHostInteractionResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorDockHostInteractionFrame` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `nodeId` | `std::string` | 结构体公开字段。 | `{}` |
|
||||
| `state` | `UIEditorTabStripInteractionState` | 结构体公开字段。 | `{}` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Shell.md) - 返回 `Shell` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
39
docs/api/XCEditor/Shell/UIEditorMenuBar/UIEditorMenuBar.md
Normal file
39
docs/api/XCEditor/Shell/UIEditorMenuBar/UIEditorMenuBar.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# UIEditorMenuBar
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Shell/UIEditorMenuBar.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Shell` 子目录中的 `UIEditorMenuBar` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorMenuBar.h` 是 `XCEditor/Shell` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorMenuBarItem` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorMenuBarState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorMenuBarMetrics` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorMenuBarPalette` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorMenuBarLayout` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorMenuBarHitTargetKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorMenuBarHitTarget` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `menuId` | `std::string` | 结构体公开字段。 | `{}` |
|
||||
| `label` | `std::string` | 结构体公开字段。 | `{}` |
|
||||
| `enabled` | `bool` | 结构体公开字段。 | `true` |
|
||||
| `desiredLabelWidth` | `float` | 结构体公开字段。 | `0.0f` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Shell.md) - 返回 `Shell` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,40 @@
|
||||
# UIEditorMenuModel
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Shell/UIEditorMenuModel.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Shell` 子目录中的 `UIEditorMenuModel` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorMenuModel.h` 是 `XCEditor/Shell` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorMenuItemKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorMenuCheckedStateSource` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorMenuCheckedStateBinding` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorMenuItemDescriptor` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorMenuDescriptor` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorMenuModel` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorMenuModelValidationCode` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorMenuModelValidationResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorResolvedMenuItem` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorResolvedMenuDescriptor` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorResolvedMenuModel` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `menus` | `std::vector<UIEditorMenuDescriptor>` | 结构体公开字段。 | `{}` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Shell.md) - 返回 `Shell` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,44 @@
|
||||
# UIEditorMenuPopup
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Shell/UIEditorMenuPopup.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Shell` 子目录中的 `UIEditorMenuPopup` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorMenuPopup.h` 是 `XCEditor/Shell` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorMenuPopupItem` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorMenuPopupState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorMenuPopupMetrics` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorMenuPopupPalette` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorMenuPopupLayout` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorMenuPopupHitTargetKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorMenuPopupHitTarget` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `itemId` | `std::string` | 结构体公开字段。 | `{}` |
|
||||
| `kind` | `::XCEngine::UI::Editor::UIEditorMenuItemKind` | 结构体公开字段。 | `::XCEngine::UI::Editor::UIEditorMenuItemKind::Command` |
|
||||
| `label` | `std::string` | 结构体公开字段。 | `{}` |
|
||||
| `shortcutText` | `std::string` | 结构体公开字段。 | `{}` |
|
||||
| `enabled` | `bool` | 结构体公开字段。 | `true` |
|
||||
| `checked` | `bool` | 结构体公开字段。 | `false` |
|
||||
| `hasSubmenu` | `bool` | 结构体公开字段。 | `false` |
|
||||
| `desiredLabelWidth` | `float` | 结构体公开字段。 | `0.0f` |
|
||||
| `desiredShortcutWidth` | `float` | 结构体公开字段。 | `0.0f` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Shell.md) - 返回 `Shell` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
31
docs/api/XCEditor/Shell/UIEditorMenuSession/CloseAll.md
Normal file
31
docs/api/XCEditor/Shell/UIEditorMenuSession/CloseAll.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# UIEditorMenuSession::CloseAll
|
||||
|
||||
公开方法，详见头文件声明。
|
||||
|
||||
```cpp
|
||||
UIEditorMenuSessionMutationResult CloseAll( ::XCEngine::UI::Widgets::UIPopupDismissReason dismissReason = ::XCEngine::UI::Widgets::UIPopupDismissReason::Programmatic);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Shell/UIEditorMenuSession.h`，当前页面用于固定 `UIEditorMenuSession` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数：**
|
||||
- `dismissReason` - 参数语义详见头文件声明。
|
||||
|
||||
**返回：** `UIEditorMenuSessionMutationResult` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorMenuSession.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorMenuSession object;
|
||||
// 根据上下文补齐参数后调用 UIEditorMenuSession::CloseAll(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorMenuSession.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
@@ -0,0 +1,30 @@
|
||||
# UIEditorMenuSession::DismissFromEscape
|
||||
|
||||
公开方法，详见头文件声明。
|
||||
|
||||
```cpp
|
||||
UIEditorMenuSessionMutationResult DismissFromEscape();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Shell/UIEditorMenuSession.h`，当前页面用于固定 `UIEditorMenuSession` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数：** 无。
|
||||
|
||||
**返回：** `UIEditorMenuSessionMutationResult` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorMenuSession.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorMenuSession object;
|
||||
// 根据上下文补齐参数后调用 UIEditorMenuSession::DismissFromEscape(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorMenuSession.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
@@ -0,0 +1,31 @@
|
||||
# UIEditorMenuSession::DismissFromFocusLoss
|
||||
|
||||
公开方法，详见头文件声明。
|
||||
|
||||
```cpp
|
||||
UIEditorMenuSessionMutationResult DismissFromFocusLoss( const UIInputPath& focusedPath);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Shell/UIEditorMenuSession.h`，当前页面用于固定 `UIEditorMenuSession` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数：**
|
||||
- `focusedPath` - 参数语义详见头文件声明。
|
||||
|
||||
**返回：** `UIEditorMenuSessionMutationResult` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorMenuSession.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorMenuSession object;
|
||||
// 根据上下文补齐参数后调用 UIEditorMenuSession::DismissFromFocusLoss(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorMenuSession.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
@@ -0,0 +1,31 @@
|
||||
# UIEditorMenuSession::DismissFromPointerDown
|
||||
|
||||
公开方法，详见头文件声明。
|
||||
|
||||
```cpp
|
||||
UIEditorMenuSessionMutationResult DismissFromPointerDown( const UIInputPath& hitPath);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Shell/UIEditorMenuSession.h`，当前页面用于固定 `UIEditorMenuSession` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数：**
|
||||
- `hitPath` - 参数语义详见头文件声明。
|
||||
|
||||
**返回：** `UIEditorMenuSessionMutationResult` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorMenuSession.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorMenuSession object;
|
||||
// 根据上下文补齐参数后调用 UIEditorMenuSession::DismissFromPointerDown(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorMenuSession.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
@@ -0,0 +1,31 @@
|
||||
# UIEditorMenuSession::FindPopupState
|
||||
|
||||
查找并返回匹配对象。
|
||||
|
||||
```cpp
|
||||
const UIEditorMenuPopupState* FindPopupState(std::string_view popupId) const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Shell/UIEditorMenuSession.h`，当前页面用于固定 `UIEditorMenuSession` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数：**
|
||||
- `popupId` - 参数语义详见头文件声明。
|
||||
|
||||
**返回：** `const UIEditorMenuPopupState*` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorMenuSession.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorMenuSession object;
|
||||
// 根据上下文补齐参数后调用 UIEditorMenuSession::FindPopupState(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorMenuSession.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
@@ -0,0 +1,30 @@
|
||||
# UIEditorMenuSession::GetOpenRootMenuId
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
std::string_view GetOpenRootMenuId() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Shell/UIEditorMenuSession.h`，当前页面用于固定 `UIEditorMenuSession` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数：** 无。
|
||||
|
||||
**返回：** `std::string_view` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorMenuSession.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorMenuSession object;
|
||||
// 根据上下文补齐参数后调用 UIEditorMenuSession::GetOpenRootMenuId(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorMenuSession.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
@@ -0,0 +1,30 @@
|
||||
# UIEditorMenuSession::GetOpenSubmenuItemIds
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
const std::vector<std::string>& GetOpenSubmenuItemIds() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Shell/UIEditorMenuSession.h`，当前页面用于固定 `UIEditorMenuSession` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数：** 无。
|
||||
|
||||
**返回：** `const std::vector<std::string>&` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorMenuSession.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorMenuSession object;
|
||||
// 根据上下文补齐参数后调用 UIEditorMenuSession::GetOpenSubmenuItemIds(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorMenuSession.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
@@ -0,0 +1,30 @@
|
||||
# UIEditorMenuSession::GetPopupOverlayModel
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
const ::XCEngine::UI::Widgets::UIPopupOverlayModel& GetPopupOverlayModel() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Shell/UIEditorMenuSession.h`，当前页面用于固定 `UIEditorMenuSession` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数：** 无。
|
||||
|
||||
**返回：** `const ::XCEngine::UI::Widgets::UIPopupOverlayModel&` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorMenuSession.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorMenuSession object;
|
||||
// 根据上下文补齐参数后调用 UIEditorMenuSession::GetPopupOverlayModel(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorMenuSession.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
@@ -0,0 +1,30 @@
|
||||
# UIEditorMenuSession::GetPopupStates
|
||||
|
||||
获取相关状态或对象。
|
||||
|
||||
```cpp
|
||||
const std::vector<UIEditorMenuPopupState>& GetPopupStates() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Shell/UIEditorMenuSession.h`，当前页面用于固定 `UIEditorMenuSession` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数：** 无。
|
||||
|
||||
**返回：** `const std::vector<UIEditorMenuPopupState>&` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorMenuSession.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorMenuSession object;
|
||||
// 根据上下文补齐参数后调用 UIEditorMenuSession::GetPopupStates(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorMenuSession.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
30
docs/api/XCEditor/Shell/UIEditorMenuSession/HasOpenMenu.md
Normal file
30
docs/api/XCEditor/Shell/UIEditorMenuSession/HasOpenMenu.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# UIEditorMenuSession::HasOpenMenu
|
||||
|
||||
判断是否具备指定状态或能力。
|
||||
|
||||
```cpp
|
||||
[[nodiscard]] bool HasOpenMenu() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Shell/UIEditorMenuSession.h`，当前页面用于固定 `UIEditorMenuSession` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数：** 无。
|
||||
|
||||
**返回：** `[[nodiscard]] bool` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorMenuSession.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorMenuSession object;
|
||||
// 根据上下文补齐参数后调用 UIEditorMenuSession::HasOpenMenu(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorMenuSession.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
@@ -0,0 +1,32 @@
|
||||
# UIEditorMenuSession::HoverMenuBarRoot
|
||||
|
||||
公开方法，详见头文件声明。
|
||||
|
||||
```cpp
|
||||
UIEditorMenuSessionMutationResult HoverMenuBarRoot( std::string_view menuId, ::XCEngine::UI::Widgets::UIPopupOverlayEntry entry);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Shell/UIEditorMenuSession.h`，当前页面用于固定 `UIEditorMenuSession` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数：**
|
||||
- `menuId` - 参数语义详见头文件声明。
|
||||
- `entry` - 参数语义详见头文件声明。
|
||||
|
||||
**返回：** `UIEditorMenuSessionMutationResult` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorMenuSession.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorMenuSession object;
|
||||
// 根据上下文补齐参数后调用 UIEditorMenuSession::HoverMenuBarRoot(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorMenuSession.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
32
docs/api/XCEditor/Shell/UIEditorMenuSession/HoverSubmenu.md
Normal file
32
docs/api/XCEditor/Shell/UIEditorMenuSession/HoverSubmenu.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# UIEditorMenuSession::HoverSubmenu
|
||||
|
||||
公开方法，详见头文件声明。
|
||||
|
||||
```cpp
|
||||
UIEditorMenuSessionMutationResult HoverSubmenu( std::string_view itemId, ::XCEngine::UI::Widgets::UIPopupOverlayEntry entry);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Shell/UIEditorMenuSession.h`，当前页面用于固定 `UIEditorMenuSession` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数：**
|
||||
- `itemId` - 参数语义详见头文件声明。
|
||||
- `entry` - 参数语义详见头文件声明。
|
||||
|
||||
**返回：** `UIEditorMenuSessionMutationResult` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorMenuSession.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorMenuSession object;
|
||||
// 根据上下文补齐参数后调用 UIEditorMenuSession::HoverSubmenu(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorMenuSession.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
31
docs/api/XCEditor/Shell/UIEditorMenuSession/IsMenuOpen.md
Normal file
31
docs/api/XCEditor/Shell/UIEditorMenuSession/IsMenuOpen.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# UIEditorMenuSession::IsMenuOpen
|
||||
|
||||
查询当前状态。
|
||||
|
||||
```cpp
|
||||
[[nodiscard]] bool IsMenuOpen(std::string_view menuId) const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Shell/UIEditorMenuSession.h`，当前页面用于固定 `UIEditorMenuSession` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数：**
|
||||
- `menuId` - 参数语义详见头文件声明。
|
||||
|
||||
**返回：** `[[nodiscard]] bool` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorMenuSession.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorMenuSession object;
|
||||
// 根据上下文补齐参数后调用 UIEditorMenuSession::IsMenuOpen(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorMenuSession.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
31
docs/api/XCEditor/Shell/UIEditorMenuSession/IsPopupOpen.md
Normal file
31
docs/api/XCEditor/Shell/UIEditorMenuSession/IsPopupOpen.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# UIEditorMenuSession::IsPopupOpen
|
||||
|
||||
查询当前状态。
|
||||
|
||||
```cpp
|
||||
[[nodiscard]] bool IsPopupOpen(std::string_view popupId) const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Shell/UIEditorMenuSession.h`，当前页面用于固定 `UIEditorMenuSession` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数：**
|
||||
- `popupId` - 参数语义详见头文件声明。
|
||||
|
||||
**返回：** `[[nodiscard]] bool` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorMenuSession.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorMenuSession object;
|
||||
// 根据上下文补齐参数后调用 UIEditorMenuSession::IsPopupOpen(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorMenuSession.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
@@ -0,0 +1,32 @@
|
||||
# UIEditorMenuSession::OpenMenuBarRoot
|
||||
|
||||
公开方法，详见头文件声明。
|
||||
|
||||
```cpp
|
||||
UIEditorMenuSessionMutationResult OpenMenuBarRoot( std::string_view menuId, ::XCEngine::UI::Widgets::UIPopupOverlayEntry entry);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Shell/UIEditorMenuSession.h`，当前页面用于固定 `UIEditorMenuSession` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数：**
|
||||
- `menuId` - 参数语义详见头文件声明。
|
||||
- `entry` - 参数语义详见头文件声明。
|
||||
|
||||
**返回：** `UIEditorMenuSessionMutationResult` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorMenuSession.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorMenuSession object;
|
||||
// 根据上下文补齐参数后调用 UIEditorMenuSession::OpenMenuBarRoot(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorMenuSession.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
32
docs/api/XCEditor/Shell/UIEditorMenuSession/OpenRootMenu.md
Normal file
32
docs/api/XCEditor/Shell/UIEditorMenuSession/OpenRootMenu.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# UIEditorMenuSession::OpenRootMenu
|
||||
|
||||
公开方法，详见头文件声明。
|
||||
|
||||
```cpp
|
||||
UIEditorMenuSessionMutationResult OpenRootMenu( std::string_view menuId, ::XCEngine::UI::Widgets::UIPopupOverlayEntry entry);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Shell/UIEditorMenuSession.h`，当前页面用于固定 `UIEditorMenuSession` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数：**
|
||||
- `menuId` - 参数语义详见头文件声明。
|
||||
- `entry` - 参数语义详见头文件声明。
|
||||
|
||||
**返回：** `UIEditorMenuSessionMutationResult` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorMenuSession.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorMenuSession object;
|
||||
// 根据上下文补齐参数后调用 UIEditorMenuSession::OpenRootMenu(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorMenuSession.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
30
docs/api/XCEditor/Shell/UIEditorMenuSession/Reset.md
Normal file
30
docs/api/XCEditor/Shell/UIEditorMenuSession/Reset.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# UIEditorMenuSession::Reset
|
||||
|
||||
公开方法，详见头文件声明。
|
||||
|
||||
```cpp
|
||||
void Reset();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEditor/Shell/UIEditorMenuSession.h`，当前页面用于固定 `UIEditorMenuSession` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数：** 无。
|
||||
|
||||
**返回：** `void` - 无返回值。
|
||||
|
||||
**示例：**
|
||||
|
||||
```cpp
|
||||
#include <XCEditor/Shell/UIEditorMenuSession.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::UIEditorMenuSession object;
|
||||
// 根据上下文补齐参数后调用 UIEditorMenuSession::Reset(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](UIEditorMenuSession.md)
|
||||
- [返回模块目录](../Shell.md)
|
||||
@@ -0,0 +1,48 @@
|
||||
# UIEditorMenuSession
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `class`
|
||||
|
||||
**头文件**: `XCEditor/Shell/UIEditorMenuSession.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Shell` 子目录中的 `UIEditorMenuSession` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorMenuSession.h` 是 `XCEditor/Shell` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorMenuPopupState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorMenuSessionMutationResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorMenuSession` | `class` | 头文件中的公开声明。 |
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [GetPopupOverlayModel](GetPopupOverlayModel.md) | 获取相关状态或对象。 |
|
||||
| [GetPopupStates](GetPopupStates.md) | 获取相关状态或对象。 |
|
||||
| [GetOpenSubmenuItemIds](GetOpenSubmenuItemIds.md) | 获取相关状态或对象。 |
|
||||
| [GetOpenRootMenuId](GetOpenRootMenuId.md) | 获取相关状态或对象。 |
|
||||
| [HasOpenMenu](HasOpenMenu.md) | 判断是否具备指定状态或能力。 |
|
||||
| [IsMenuOpen](IsMenuOpen.md) | 查询当前状态。 |
|
||||
| [IsPopupOpen](IsPopupOpen.md) | 查询当前状态。 |
|
||||
| [FindPopupState](FindPopupState.md) | 查找并返回匹配对象。 |
|
||||
| [Reset](Reset.md) | 公开方法，详见头文件声明。 |
|
||||
| [OpenRootMenu](OpenRootMenu.md) | 公开方法，详见头文件声明。 |
|
||||
| [OpenMenuBarRoot](OpenMenuBarRoot.md) | 公开方法，详见头文件声明。 |
|
||||
| [HoverMenuBarRoot](HoverMenuBarRoot.md) | 公开方法，详见头文件声明。 |
|
||||
| [HoverSubmenu](HoverSubmenu.md) | 公开方法，详见头文件声明。 |
|
||||
| [CloseAll](CloseAll.md) | 公开方法，详见头文件声明。 |
|
||||
| [DismissFromEscape](DismissFromEscape.md) | 公开方法，详见头文件声明。 |
|
||||
| [DismissFromPointerDown](DismissFromPointerDown.md) | 公开方法，详见头文件声明。 |
|
||||
| [DismissFromFocusLoss](DismissFromFocusLoss.md) | 公开方法，详见头文件声明。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Shell.md) - 返回 `Shell` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,39 @@
|
||||
# UIEditorPanelContentHost
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEditor/Shell/UIEditorPanelContentHost.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Shell` 子目录中的 `UIEditorPanelContentHost` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorPanelContentHost.h` 是 `XCEditor/Shell` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorPanelContentHostEventKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorPanelContentHostBinding` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPanelContentHostMountRequest` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPanelContentHostRequest` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPanelContentHostPanelState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPanelContentHostState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPanelContentHostEvent` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPanelContentHostFrame` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `Mounted` | `0` | 枚举项。 |
|
||||
| `Unmounted` | - | 枚举项。 |
|
||||
| `BoundsChanged` | - | 枚举项。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Shell.md) - 返回 `Shell` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,38 @@
|
||||
# UIEditorPanelFrame
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEditor/Shell/UIEditorPanelFrame.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Shell` 子目录中的 `UIEditorPanelFrame` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorPanelFrame.h` 是 `XCEditor/Shell` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorPanelFrameAction` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorPanelFrameHitTarget` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorPanelFrameState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPanelFrameText` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPanelFrameMetrics` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPanelFramePalette` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPanelFrameLayout` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `None` | `0` | 枚举项。 |
|
||||
| `Pin` | - | 枚举项。 |
|
||||
| `Close` | - | 枚举项。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Shell.md) - 返回 `Shell` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,42 @@
|
||||
# UIEditorPanelHostLifecycle
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEditor/Shell/UIEditorPanelHostLifecycle.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Shell` 子目录中的 `UIEditorPanelHostLifecycle` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorPanelHostLifecycle.h` 是 `XCEditor/Shell` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorPanelHostLifecycleEventKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorPanelHostState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPanelHostLifecycleEvent` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPanelHostLifecycleState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPanelHostLifecycleRequest` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPanelHostLifecycleFrame` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `Attached` | `0` | 枚举项。 |
|
||||
| `Detached` | - | 枚举项。 |
|
||||
| `Shown` | - | 枚举项。 |
|
||||
| `Hidden` | - | 枚举项。 |
|
||||
| `Activated` | - | 枚举项。 |
|
||||
| `Deactivated` | - | 枚举项。 |
|
||||
| `FocusGained` | - | 枚举项。 |
|
||||
| `FocusLost` | - | 枚举项。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Shell.md) - 返回 `Shell` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,34 @@
|
||||
# UIEditorPanelRegistry
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Shell/UIEditorPanelRegistry.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Shell` 子目录中的 `UIEditorPanelRegistry` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorPanelRegistry.h` 是 `XCEditor/Shell` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorPanelPresentationKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorPanelDescriptor` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPanelRegistry` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPanelRegistryValidationCode` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorPanelRegistryValidationResult` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `panels` | `std::vector<UIEditorPanelDescriptor>` | 结构体公开字段。 | `{}` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Shell.md) - 返回 `Shell` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,34 @@
|
||||
# UIEditorShellAsset
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Shell/UIEditorShellAsset.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Shell` 子目录中的 `UIEditorShellAsset` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorShellAsset.h` 是 `XCEditor/Shell` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `EditorShellShortcutAsset` | `struct` | 头文件中的公开声明。 |
|
||||
| `EditorShellAsset` | `struct` | 头文件中的公开声明。 |
|
||||
| `EditorShellAssetValidationCode` | `enum class` | 头文件中的公开声明。 |
|
||||
| `EditorShellAssetValidationResult` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `commandRegistry` | `UIEditorCommandRegistry` | 结构体公开字段。 | `{}` |
|
||||
| `bindings` | `std::vector<UIShortcutBinding>` | 结构体公开字段。 | `{}` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Shell.md) - 返回 `Shell` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,43 @@
|
||||
# UIEditorShellCompose
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEditor/Shell/UIEditorShellCompose.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Shell` 子目录中的 `UIEditorShellCompose` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorShellCompose.h` 是 `XCEditor/Shell` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorShellToolbarGlyph` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorShellToolbarButton` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorShellToolbarLayout` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorShellToolbarMetrics` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorShellToolbarPalette` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorShellComposeModel` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorShellComposeState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorShellComposeMetrics` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorShellComposePalette` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorShellComposeLayout` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorShellComposeRequest` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorShellComposeFrame` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `Play` | `0` | 枚举项。 |
|
||||
| `Pause` | - | 枚举项。 |
|
||||
| `Step` | - | 枚举项。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Shell.md) - 返回 `Shell` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,45 @@
|
||||
# UIEditorShellInteraction
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Shell/UIEditorShellInteraction.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Shell` 子目录中的 `UIEditorShellInteraction` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorShellInteraction.h` 是 `XCEditor/Shell` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorShellInteractionDefinition` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorShellInteractionModel` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorShellInteractionState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorShellInteractionMetrics` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorShellInteractionPalette` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorShellInteractionServices` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorShellInteractionMenuButtonRequest` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorShellInteractionPopupItemRequest` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorShellInteractionPopupRequest` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorShellInteractionRequest` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorShellInteractionResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorShellInteractionPopupFrame` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorShellInteractionFrame` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `menuModel` | `UIEditorMenuModel` | 结构体公开字段。 | `{}` |
|
||||
| `toolbarButtons` | `std::vector<UIEditorShellToolbarButton>` | 结构体公开字段。 | `{}` |
|
||||
| `statusSegments` | `std::vector<Widgets::UIEditorStatusBarSegment>` | 结构体公开字段。 | `{}` |
|
||||
| `workspacePresentations` | `std::vector<UIEditorWorkspacePanelPresentationModel>` | 结构体公开字段。 | `{}` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Shell.md) - 返回 `Shell` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,39 @@
|
||||
# UIEditorStatusBar
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEditor/Shell/UIEditorStatusBar.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Shell` 子目录中的 `UIEditorStatusBar` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorStatusBar.h` 是 `XCEditor/Shell` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorStatusBarSlot` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorStatusBarTextTone` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorStatusBarHitTargetKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorStatusBarSegment` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorStatusBarState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorStatusBarMetrics` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorStatusBarPalette` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorStatusBarLayout` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorStatusBarHitTarget` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `Leading` | `0` | 枚举项。 |
|
||||
| `Trailing` | - | 枚举项。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Shell.md) - 返回 `Shell` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,34 @@
|
||||
# UIEditorStructuredShell
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Shell/UIEditorStructuredShell.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Shell` 子目录中的 `UIEditorStructuredShell` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorStructuredShell.h` 是 `XCEditor/Shell` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `StructuredEditorShellBinding` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `screenAsset` | `::XCEngine::UI::Runtime::UIScreenAsset` | 结构体公开字段。 | `{}` |
|
||||
| `workspaceController` | `UIEditorWorkspaceController` | 结构体公开字段。 | `{}` |
|
||||
| `shellDefinition` | `UIEditorShellInteractionDefinition` | 结构体公开字段。 | `{}` |
|
||||
| `shortcutManager` | `UIEditorShortcutManager` | 结构体公开字段。 | `{}` |
|
||||
| `assetValidation` | `EditorShellAssetValidationResult` | 结构体公开字段。 | `{}` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Shell.md) - 返回 `Shell` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,34 @@
|
||||
# UIEditorViewportInputBridge
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Shell/UIEditorViewportInputBridge.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Shell` 子目录中的 `UIEditorViewportInputBridge` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorViewportInputBridge.h` 是 `XCEditor/Shell` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorViewportInputBridgeConfig` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorViewportInputBridgeState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorViewportInputBridgeFrame` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `focusOnPointerDownInside` | `bool` | 结构体公开字段。 | `true` |
|
||||
| `clearFocusOnPointerDownOutside` | `bool` | 结构体公开字段。 | `true` |
|
||||
| `capturePointerOnPointerDownInside` | `bool` | 结构体公开字段。 | `true` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Shell.md) - 返回 `Shell` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,37 @@
|
||||
# UIEditorViewportShell
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Shell/UIEditorViewportShell.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Shell` 子目录中的 `UIEditorViewportShell` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorViewportShell.h` 是 `XCEditor/Shell` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorViewportShellVisualState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorViewportShellSpec` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorViewportShellModel` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorViewportShellRequest` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorViewportShellState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorViewportShellFrame` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `hoveredToolIndex` | `std::size_t` | 结构体公开字段。 | `Widgets::UIEditorViewportSlotInvalidIndex` |
|
||||
| `activeToolIndex` | `std::size_t` | 结构体公开字段。 | `Widgets::UIEditorViewportSlotInvalidIndex` |
|
||||
| `statusBarState` | `Widgets::UIEditorStatusBarState` | 结构体公开字段。 | `{}` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Shell.md) - 返回 `Shell` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,40 @@
|
||||
# UIEditorViewportSlot
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEditor/Shell/UIEditorViewportSlot.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Shell` 子目录中的 `UIEditorViewportSlot` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorViewportSlot.h` 是 `XCEditor/Shell` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorViewportSlotToolSlot` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorViewportSlotHitTargetKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorViewportSlotFrame` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorViewportSlotChrome` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorViewportSlotToolItem` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorViewportSlotState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorViewportSlotMetrics` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorViewportSlotPalette` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorViewportSlotLayout` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorViewportSlotHitTarget` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `Leading` | `0` | 枚举项。 |
|
||||
| `Trailing` | - | 枚举项。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Shell.md) - 返回 `Shell` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,38 @@
|
||||
# UIEditorWorkspaceCompose
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Shell/UIEditorWorkspaceCompose.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Shell` 子目录中的 `UIEditorWorkspaceCompose` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorWorkspaceCompose.h` 是 `XCEditor/Shell` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorWorkspacePanelPresentationModel` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspacePanelPresentationState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceComposeState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceViewportComposeRequest` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceComposeRequest` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceViewportComposeFrame` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceComposeFrame` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `panelId` | `std::string` | 结构体公开字段。 | `{}` |
|
||||
| `kind` | `UIEditorPanelPresentationKind` | 结构体公开字段。 | `UIEditorPanelPresentationKind::Placeholder` |
|
||||
| `viewportShellModel` | `UIEditorViewportShellModel` | 结构体公开字段。 | `{}` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Shell.md) - 返回 `Shell` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -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)
|
||||
@@ -0,0 +1,33 @@
|
||||
# UIEditorWorkspaceInteraction
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Shell/UIEditorWorkspaceInteraction.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Shell` 子目录中的 `UIEditorWorkspaceInteraction` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorWorkspaceInteraction.h` 是 `XCEditor/Shell` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorWorkspaceInteractionModel` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceInteractionState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceInteractionResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceInteractionFrame` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `workspacePresentations` | `std::vector<UIEditorWorkspacePanelPresentationModel>` | 结构体公开字段。 | `{}` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Shell.md) - 返回 `Shell` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,33 @@
|
||||
# UIEditorWorkspaceLayoutPersistence
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Shell/UIEditorWorkspaceLayoutPersistence.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Shell` 子目录中的 `UIEditorWorkspaceLayoutPersistence` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorWorkspaceLayoutPersistence.h` 是 `XCEditor/Shell` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorWorkspaceLayoutSnapshot` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceLayoutLoadCode` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceLayoutLoadResult` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `workspace` | `UIEditorWorkspaceModel` | 结构体公开字段。 | `{}` |
|
||||
| `session` | `UIEditorWorkspaceSession` | 结构体公开字段。 | `{}` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Shell.md) - 返回 `Shell` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,38 @@
|
||||
# UIEditorWorkspaceModel
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Shell/UIEditorWorkspaceModel.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Shell` 子目录中的 `UIEditorWorkspaceModel` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorWorkspaceModel.h` 是 `XCEditor/Shell` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorWorkspaceNodeKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceSplitAxis` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspacePanelState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceNode` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceModel` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceValidationCode` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceValidationResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceVisiblePanel` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `root` | `UIEditorWorkspaceNode` | 结构体公开字段。 | `{}` |
|
||||
| `activePanelId` | `std::string` | 结构体公开字段。 | `{}` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Shell.md) - 返回 `Shell` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,33 @@
|
||||
# UIEditorWorkspaceSession
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Shell/UIEditorWorkspaceSession.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Shell` 子目录中的 `UIEditorWorkspaceSession` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorWorkspaceSession.h` 是 `XCEditor/Shell` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorPanelSessionState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceSession` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceSessionValidationCode` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorWorkspaceSessionValidationResult` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `panelStates` | `std::vector<UIEditorPanelSessionState>` | 结构体公开字段。 | `{}` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Shell.md) - 返回 `Shell` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
Reference in New Issue
Block a user