docs: add xceditor api tree and new resource docs
This commit is contained in:
47
docs/api/XCEditor/Collections/Collections.md
Normal file
47
docs/api/XCEditor/Collections/Collections.md
Normal file
@@ -0,0 +1,47 @@
|
||||
# Collections
|
||||
|
||||
**命名空间**: `XCEngine::UI::Editor::Widgets`
|
||||
|
||||
**类型**: `submodule`
|
||||
|
||||
**描述**: 编辑器集合类控件子模块,覆盖列表、树、标签栏、滚动视图及其交互辅助。
|
||||
|
||||
## 概述
|
||||
|
||||
`Collections` 主要提供“多项内容如何排布、命中、滚动与选择”的公共 UI 原语。按当前头文件与实现分工:
|
||||
|
||||
- `UIEditorListView*`
|
||||
- 双行列表项布局、命中测试与交互
|
||||
- `UIEditorTreeView*`
|
||||
- 树节点可见性、展开/折叠与行命中
|
||||
- `UIEditorScrollView*`
|
||||
- 视口、内容范围与滚动条交互
|
||||
- `UIEditorTabStrip*`
|
||||
- 面板标签切换
|
||||
- `UIEditorInlineRenameSession`
|
||||
- 就地重命名会话状态
|
||||
|
||||
这些类型大多位于 `XCEngine::UI::Editor::Widgets` 命名空间下,并且被 `Fields` 与 `Shell` 复用。
|
||||
|
||||
## 公开头文件
|
||||
|
||||
- `UIEditorInlineRenameSession.h`
|
||||
- `UIEditorListView.h`
|
||||
- `UIEditorListViewInteraction.h`
|
||||
- `UIEditorScrollView.h`
|
||||
- `UIEditorScrollViewInteraction.h`
|
||||
- `UIEditorTabStrip.h`
|
||||
- `UIEditorTabStripInteraction.h`
|
||||
- `UIEditorTreeView.h`
|
||||
- `UIEditorTreeViewInteraction.h`
|
||||
|
||||
## 当前实现边界
|
||||
|
||||
- 当前这里只建立目录索引页,具体头文件页仍需后续分批补齐。
|
||||
- 该模块依赖 `XCEngine/UI/Widgets` 的选择、展开、输入模型,而不是自行维护通用状态容器。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [XCEditor](../XCEditor.md)
|
||||
- [Fields](../Fields/Fields.md)
|
||||
- [Widgets](../Widgets/Widgets.md)
|
||||
@@ -0,0 +1,36 @@
|
||||
# UIEditorInlineRenameSession
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Collections/UIEditorInlineRenameSession.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Collections` 子目录中的 `UIEditorInlineRenameSession` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorInlineRenameSession.h` 是 `XCEditor/Collections` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorInlineRenameSessionState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorInlineRenameSessionRequest` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorInlineRenameSessionResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorInlineRenameSessionFrame` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `active` | `bool` | 结构体公开字段。 | `false` |
|
||||
| `itemId` | `std::string` | 结构体公开字段。 | `{}` |
|
||||
| `textFieldSpec` | `Widgets::UIEditorTextFieldSpec` | 结构体公开字段。 | `{}` |
|
||||
| `textFieldInteraction` | `UIEditorTextFieldInteractionState` | 结构体公开字段。 | `{}` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Collections.md) - 返回 `Collections` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,37 @@
|
||||
# UIEditorListView
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEditor/Collections/UIEditorListView.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Collections` 子目录中的 `UIEditorListView` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorListView.h` 是 `XCEditor/Collections` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorListViewHitTargetKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorListViewItem` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorListViewState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorListViewMetrics` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorListViewPalette` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorListViewLayout` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorListViewHitTarget` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `None` | `0` | 枚举项。 |
|
||||
| `Row` | - | 枚举项。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Collections.md) - 返回 `Collections` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,36 @@
|
||||
# UIEditorListViewInteraction
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Collections/UIEditorListViewInteraction.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Collections` 子目录中的 `UIEditorListViewInteraction` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorListViewInteraction.h` 是 `XCEditor/Collections` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorListViewInteractionState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorListViewInteractionResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorListViewInteractionFrame` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `listViewState` | `Widgets::UIEditorListViewState` | 结构体公开字段。 | `{}` |
|
||||
| `keyboardNavigation` | `::XCEngine::UI::Widgets::UIKeyboardNavigationModel` | 结构体公开字段。 | `{}` |
|
||||
| `selectionAnchorId` | `std::string` | 结构体公开字段。 | `{}` |
|
||||
| `pointerPosition` | `::XCEngine::UI::UIPoint` | 结构体公开字段。 | `{}` |
|
||||
| `hasPointerPosition` | `bool` | 结构体公开字段。 | `false` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Collections.md) - 返回 `Collections` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,38 @@
|
||||
# UIEditorScrollView
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEditor/Collections/UIEditorScrollView.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Collections` 子目录中的 `UIEditorScrollView` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorScrollView.h` 是 `XCEditor/Collections` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorScrollViewHitTargetKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorScrollViewState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorScrollViewMetrics` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorScrollViewPalette` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorScrollViewLayout` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorScrollViewHitTarget` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `None` | `0` | 枚举项。 |
|
||||
| `Content` | - | 枚举项。 |
|
||||
| `ScrollbarTrack` | - | 枚举项。 |
|
||||
| `ScrollbarThumb` | - | 枚举项。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Collections.md) - 返回 `Collections` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,36 @@
|
||||
# UIEditorScrollViewInteraction
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Collections/UIEditorScrollViewInteraction.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Collections` 子目录中的 `UIEditorScrollViewInteraction` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorScrollViewInteraction.h` 是 `XCEditor/Collections` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorScrollViewInteractionState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorScrollViewInteractionResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorScrollViewInteractionFrame` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `scrollViewState` | `Widgets::UIEditorScrollViewState` | 结构体公开字段。 | `{}` |
|
||||
| `pointerPosition` | `::XCEngine::UI::UIPoint` | 结构体公开字段。 | `{}` |
|
||||
| `thumbDragStartPointerY` | `float` | 结构体公开字段。 | `0.0f` |
|
||||
| `thumbDragStartOffset` | `float` | 结构体公开字段。 | `0.0f` |
|
||||
| `hasPointerPosition` | `bool` | 结构体公开字段。 | `false` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Collections.md) - 返回 `Collections` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,39 @@
|
||||
# UIEditorTabStrip
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Collections/UIEditorTabStrip.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Collections` 子目录中的 `UIEditorTabStrip` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorTabStrip.h` 是 `XCEditor/Collections` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorTabStripItem` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorTabStripState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorTabStripMetrics` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorTabStripPalette` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorTabStripLayout` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorTabStripHitTargetKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorTabStripHitTarget` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `tabId` | `std::string` | 结构体公开字段。 | `{}` |
|
||||
| `title` | `std::string` | 结构体公开字段。 | `{}` |
|
||||
| `closable` | `bool` | 结构体公开字段。 | `true` |
|
||||
| `desiredHeaderLabelWidth` | `float` | 结构体公开字段。 | `0.0f` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Collections.md) - 返回 `Collections` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,36 @@
|
||||
# UIEditorTabStripInteraction
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Collections/UIEditorTabStripInteraction.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Collections` 子目录中的 `UIEditorTabStripInteraction` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorTabStripInteraction.h` 是 `XCEditor/Collections` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorTabStripInteractionState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorTabStripInteractionResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorTabStripInteractionFrame` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `tabStripState` | `Widgets::UIEditorTabStripState` | 结构体公开字段。 | `{}` |
|
||||
| `navigationModel` | `::XCEngine::UI::Widgets::UITabStripModel` | 结构体公开字段。 | `{}` |
|
||||
| `pressedTarget` | `Widgets::UIEditorTabStripHitTarget` | 结构体公开字段。 | `{}` |
|
||||
| `pointerPosition` | `::XCEngine::UI::UIPoint` | 结构体公开字段。 | `{}` |
|
||||
| `hasPointerPosition` | `bool` | 结构体公开字段。 | `false` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Collections.md) - 返回 `Collections` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,38 @@
|
||||
# UIEditorTreeView
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEditor/Collections/UIEditorTreeView.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Collections` 子目录中的 `UIEditorTreeView` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorTreeView.h` 是 `XCEditor/Collections` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorTreeViewHitTargetKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorTreeViewItem` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorTreeViewState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorTreeViewMetrics` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorTreeViewPalette` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorTreeViewLayout` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorTreeViewHitTarget` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `None` | `0` | 枚举项。 |
|
||||
| `Row` | - | 枚举项。 |
|
||||
| `Disclosure` | - | 枚举项。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Collections.md) - 返回 `Collections` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,36 @@
|
||||
# UIEditorTreeViewInteraction
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Collections/UIEditorTreeViewInteraction.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Collections` 子目录中的 `UIEditorTreeViewInteraction` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorTreeViewInteraction.h` 是 `XCEditor/Collections` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorTreeViewInteractionState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorTreeViewInteractionResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorTreeViewInteractionFrame` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `treeViewState` | `Widgets::UIEditorTreeViewState` | 结构体公开字段。 | `{}` |
|
||||
| `keyboardNavigation` | `::XCEngine::UI::Widgets::UIKeyboardNavigationModel` | 结构体公开字段。 | `{}` |
|
||||
| `selectionAnchorId` | `std::string` | 结构体公开字段。 | `{}` |
|
||||
| `pointerPosition` | `::XCEngine::UI::UIPoint` | 结构体公开字段。 | `{}` |
|
||||
| `hasPointerPosition` | `bool` | 结构体公开字段。 | `false` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Collections.md) - 返回 `Collections` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
68
docs/api/XCEditor/Fields/Fields.md
Normal file
68
docs/api/XCEditor/Fields/Fields.md
Normal file
@@ -0,0 +1,68 @@
|
||||
# Fields
|
||||
|
||||
**命名空间**: `XCEngine::UI::Editor::Widgets`
|
||||
|
||||
**类型**: `submodule`
|
||||
|
||||
**描述**: 编辑器字段控件子模块,覆盖布尔、数字、文本、颜色、对象、资源与属性网格等值编辑控件。
|
||||
|
||||
## 概述
|
||||
|
||||
`Fields` 面向“属性编辑”场景。当前头文件可以分成两层:
|
||||
|
||||
- 单字段控件
|
||||
- `UIEditorBoolField*`
|
||||
- `UIEditorNumberField*`
|
||||
- `UIEditorTextField*`
|
||||
- `UIEditorEnumField*`
|
||||
- `UIEditorColorField*`
|
||||
- `UIEditorObjectField*`
|
||||
- `UIEditorAssetField*`
|
||||
- `UIEditorVector2/3/4Field*`
|
||||
- 聚合编辑控件
|
||||
- `UIEditorPropertyGrid*`
|
||||
- 把 section、field row、弹窗菜单和颜色字段等组合成统一 inspector 布局
|
||||
|
||||
按当前 `UIEditorPropertyGrid.h`,这一层会复用:
|
||||
|
||||
- `Collections` 中的滚动/列表布局能力
|
||||
- `Shell/UIEditorMenuPopup.h` 提供的弹出菜单能力
|
||||
- `Widgets/UIEditorFieldRowLayout.h` 和 `UIEditorTextLayout.h` 等基础布局工具
|
||||
|
||||
## 公开头文件
|
||||
|
||||
- `UIEditorAssetField.h`
|
||||
- `UIEditorAssetFieldInteraction.h`
|
||||
- `UIEditorBoolField.h`
|
||||
- `UIEditorBoolFieldInteraction.h`
|
||||
- `UIEditorColorField.h`
|
||||
- `UIEditorColorFieldInteraction.h`
|
||||
- `UIEditorEnumField.h`
|
||||
- `UIEditorEnumFieldInteraction.h`
|
||||
- `UIEditorFieldStyle.h`
|
||||
- `UIEditorNumberField.h`
|
||||
- `UIEditorNumberFieldInteraction.h`
|
||||
- `UIEditorObjectField.h`
|
||||
- `UIEditorObjectFieldInteraction.h`
|
||||
- `UIEditorPropertyGrid.h`
|
||||
- `UIEditorPropertyGridInteraction.h`
|
||||
- `UIEditorTextField.h`
|
||||
- `UIEditorTextFieldInteraction.h`
|
||||
- `UIEditorVector2Field.h`
|
||||
- `UIEditorVector2FieldInteraction.h`
|
||||
- `UIEditorVector3Field.h`
|
||||
- `UIEditorVector3FieldInteraction.h`
|
||||
- `UIEditorVector4Field.h`
|
||||
- `UIEditorVector4FieldInteraction.h`
|
||||
|
||||
## 当前实现边界
|
||||
|
||||
- 当前这里只建立目录索引页,具体头文件页仍需后续逐个补齐。
|
||||
- 这一层当前偏重 UI 表达与交互状态,不负责真正的资产解析、对象生命周期或命令持久化。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [XCEditor](../XCEditor.md)
|
||||
- [Collections](../Collections/Collections.md)
|
||||
- [Shell](../Shell/Shell.md)
|
||||
- [Widgets](../Widgets/Widgets.md)
|
||||
@@ -0,0 +1,40 @@
|
||||
# UIEditorAssetField
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEditor/Fields/UIEditorAssetField.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Fields` 子目录中的 `UIEditorAssetField` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorAssetField.h` 是 `XCEditor/Fields` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorAssetFieldHitTargetKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorAssetFieldSpec` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorAssetFieldState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorAssetFieldMetrics` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorAssetFieldPalette` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorAssetFieldLayout` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorAssetFieldHitTarget` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `None` | `0` | 枚举项。 |
|
||||
| `Row` | - | 枚举项。 |
|
||||
| `ValueBox` | - | 枚举项。 |
|
||||
| `PickerButton` | - | 枚举项。 |
|
||||
| `ClearButton` | - | 枚举项。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Fields.md) - 返回 `Fields` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,34 @@
|
||||
# UIEditorAssetFieldInteraction
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Fields/UIEditorAssetFieldInteraction.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Fields` 子目录中的 `UIEditorAssetFieldInteraction` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorAssetFieldInteraction.h` 是 `XCEditor/Fields` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorAssetFieldInteractionState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorAssetFieldInteractionResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorAssetFieldInteractionFrame` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `fieldState` | `Widgets::UIEditorAssetFieldState` | 结构体公开字段。 | `{}` |
|
||||
| `pointerPosition` | `::XCEngine::UI::UIPoint` | 结构体公开字段。 | `{}` |
|
||||
| `hasPointerPosition` | `bool` | 结构体公开字段。 | `false` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Fields.md) - 返回 `Fields` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,38 @@
|
||||
# UIEditorBoolField
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEditor/Fields/UIEditorBoolField.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Fields` 子目录中的 `UIEditorBoolField` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorBoolField.h` 是 `XCEditor/Fields` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorBoolFieldHitTargetKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorBoolFieldSpec` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorBoolFieldState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorBoolFieldMetrics` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorBoolFieldPalette` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorBoolFieldLayout` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorBoolFieldHitTarget` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `None` | `0` | 枚举项。 |
|
||||
| `Row` | - | 枚举项。 |
|
||||
| `Checkbox` | - | 枚举项。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Fields.md) - 返回 `Fields` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,34 @@
|
||||
# UIEditorBoolFieldInteraction
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Fields/UIEditorBoolFieldInteraction.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Fields` 子目录中的 `UIEditorBoolFieldInteraction` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorBoolFieldInteraction.h` 是 `XCEditor/Fields` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorBoolFieldInteractionState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorBoolFieldInteractionResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorBoolFieldInteractionFrame` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `fieldState` | `Widgets::UIEditorBoolFieldState` | 结构体公开字段。 | `{}` |
|
||||
| `pointerPosition` | `::XCEngine::UI::UIPoint` | 结构体公开字段。 | `{}` |
|
||||
| `hasPointerPosition` | `bool` | 结构体公开字段。 | `false` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Fields.md) - 返回 `Fields` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,46 @@
|
||||
# UIEditorColorField
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEditor/Fields/UIEditorColorField.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Fields` 子目录中的 `UIEditorColorField` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorColorField.h` 是 `XCEditor/Fields` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorColorFieldHitTargetKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorColorFieldSpec` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorColorFieldState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorColorFieldMetrics` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorColorFieldPalette` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorColorFieldLayout` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorColorFieldHitTarget` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `None` | `0` | 枚举项。 |
|
||||
| `Row` | - | 枚举项。 |
|
||||
| `Swatch` | - | 枚举项。 |
|
||||
| `PopupSurface` | - | 枚举项。 |
|
||||
| `PopupCloseButton` | - | 枚举项。 |
|
||||
| `HueWheel` | - | 枚举项。 |
|
||||
| `SaturationValue` | - | 枚举项。 |
|
||||
| `RedChannel` | - | 枚举项。 |
|
||||
| `GreenChannel` | - | 枚举项。 |
|
||||
| `BlueChannel` | - | 枚举项。 |
|
||||
| `AlphaChannel` | - | 枚举项。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Fields.md) - 返回 `Fields` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,34 @@
|
||||
# UIEditorColorFieldInteraction
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Fields/UIEditorColorFieldInteraction.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Fields` 子目录中的 `UIEditorColorFieldInteraction` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorColorFieldInteraction.h` 是 `XCEditor/Fields` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorColorFieldInteractionState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorColorFieldInteractionResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorColorFieldInteractionFrame` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `colorFieldState` | `Widgets::UIEditorColorFieldState` | 结构体公开字段。 | `{}` |
|
||||
| `pointerPosition` | `::XCEngine::UI::UIPoint` | 结构体公开字段。 | `{}` |
|
||||
| `hasPointerPosition` | `bool` | 结构体公开字段。 | `false` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Fields.md) - 返回 `Fields` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,39 @@
|
||||
# UIEditorEnumField
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEditor/Fields/UIEditorEnumField.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Fields` 子目录中的 `UIEditorEnumField` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorEnumField.h` 是 `XCEditor/Fields` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorEnumFieldHitTargetKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorEnumFieldSpec` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorEnumFieldState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorEnumFieldMetrics` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorEnumFieldPalette` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorEnumFieldLayout` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorEnumFieldHitTarget` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `None` | `0` | 枚举项。 |
|
||||
| `Row` | - | 枚举项。 |
|
||||
| `ValueBox` | - | 枚举项。 |
|
||||
| `DropdownArrow` | - | 枚举项。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Fields.md) - 返回 `Fields` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,37 @@
|
||||
# UIEditorEnumFieldInteraction
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Fields/UIEditorEnumFieldInteraction.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Fields` 子目录中的 `UIEditorEnumFieldInteraction` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorEnumFieldInteraction.h` 是 `XCEditor/Fields` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorEnumFieldInteractionState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorEnumFieldInteractionResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorEnumFieldInteractionFrame` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `fieldState` | `Widgets::UIEditorEnumFieldState` | 结构体公开字段。 | `{}` |
|
||||
| `pointerPosition` | `::XCEngine::UI::UIPoint` | 结构体公开字段。 | `{}` |
|
||||
| `highlightedIndex` | `std::size_t` | 结构体公开字段。 | `Widgets::UIEditorMenuPopupInvalidIndex` |
|
||||
| `pressedPopupIndex` | `std::size_t` | 结构体公开字段。 | `Widgets::UIEditorMenuPopupInvalidIndex` |
|
||||
| `hasPointerPosition` | `bool` | 结构体公开字段。 | `false` |
|
||||
| `popupOpen` | `bool` | 结构体公开字段。 | `false` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Fields.md) - 返回 `Fields` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,18 @@
|
||||
# UIEditorFieldStyle
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `header`
|
||||
|
||||
**头文件**: `XCEditor/Fields/UIEditorFieldStyle.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Fields` 子目录中的 `UIEditorFieldStyle` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorFieldStyle.h` 是 `XCEditor/Fields` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Fields.md) - 返回 `Fields` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,38 @@
|
||||
# UIEditorNumberField
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEditor/Fields/UIEditorNumberField.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Fields` 子目录中的 `UIEditorNumberField` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorNumberField.h` 是 `XCEditor/Fields` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorNumberFieldHitTargetKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorNumberFieldSpec` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorNumberFieldState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorNumberFieldMetrics` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorNumberFieldPalette` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorNumberFieldLayout` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorNumberFieldHitTarget` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `None` | `0` | 枚举项。 |
|
||||
| `Row` | - | 枚举项。 |
|
||||
| `ValueBox` | - | 枚举项。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Fields.md) - 返回 `Fields` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,36 @@
|
||||
# UIEditorNumberFieldInteraction
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Fields/UIEditorNumberFieldInteraction.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Fields` 子目录中的 `UIEditorNumberFieldInteraction` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorNumberFieldInteraction.h` 是 `XCEditor/Fields` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorNumberFieldInteractionState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorNumberFieldInteractionResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorNumberFieldInteractionFrame` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `numberFieldState` | `Widgets::UIEditorNumberFieldState` | 结构体公开字段。 | `{}` |
|
||||
| `textInputState` | `::XCEngine::UI::Text::UITextInputState` | 结构体公开字段。 | `{}` |
|
||||
| `editModel` | `::XCEngine::UI::Widgets::UIPropertyEditModel` | 结构体公开字段。 | `{}` |
|
||||
| `pointerPosition` | `::XCEngine::UI::UIPoint` | 结构体公开字段。 | `{}` |
|
||||
| `hasPointerPosition` | `bool` | 结构体公开字段。 | `false` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Fields.md) - 返回 `Fields` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,40 @@
|
||||
# UIEditorObjectField
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEditor/Fields/UIEditorObjectField.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Fields` 子目录中的 `UIEditorObjectField` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorObjectField.h` 是 `XCEditor/Fields` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorObjectFieldHitTargetKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorObjectFieldSpec` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorObjectFieldState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorObjectFieldMetrics` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorObjectFieldPalette` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorObjectFieldLayout` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorObjectFieldHitTarget` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `None` | `0` | 枚举项。 |
|
||||
| `Row` | - | 枚举项。 |
|
||||
| `ValueBox` | - | 枚举项。 |
|
||||
| `ClearButton` | - | 枚举项。 |
|
||||
| `PickerButton` | - | 枚举项。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Fields.md) - 返回 `Fields` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,34 @@
|
||||
# UIEditorObjectFieldInteraction
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Fields/UIEditorObjectFieldInteraction.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Fields` 子目录中的 `UIEditorObjectFieldInteraction` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorObjectFieldInteraction.h` 是 `XCEditor/Fields` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorObjectFieldInteractionState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorObjectFieldInteractionResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorObjectFieldInteractionFrame` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `fieldState` | `Widgets::UIEditorObjectFieldState` | 结构体公开字段。 | `{}` |
|
||||
| `pointerPosition` | `::XCEngine::UI::UIPoint` | 结构体公开字段。 | `{}` |
|
||||
| `hasPointerPosition` | `bool` | 结构体公开字段。 | `false` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Fields.md) - 返回 `Fields` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,53 @@
|
||||
# UIEditorPropertyGrid
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEditor/Fields/UIEditorPropertyGrid.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Fields` 子目录中的 `UIEditorPropertyGrid` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorPropertyGrid.h` 是 `XCEditor/Fields` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorPropertyGridFieldKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorPropertyGridHitTargetKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorPropertyGridFieldLocation` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPropertyGridNumberFieldValue` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPropertyGridEnumFieldValue` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPropertyGridColorFieldValue` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPropertyGridVector2FieldValue` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPropertyGridVector3FieldValue` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPropertyGridVector4FieldValue` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPropertyGridField` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPropertyGridSection` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPropertyGridColorFieldVisualState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPropertyGridState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPropertyGridMetrics` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPropertyGridPalette` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPropertyGridLayout` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPropertyGridHitTarget` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `Text` | `0` | 枚举项。 |
|
||||
| `Bool` | - | 枚举项。 |
|
||||
| `Number` | - | 枚举项。 |
|
||||
| `Enum` | - | 枚举项。 |
|
||||
| `Color` | - | 枚举项。 |
|
||||
| `Vector2` | - | 枚举项。 |
|
||||
| `Vector3` | - | 枚举项。 |
|
||||
| `Vector4` | - | 枚举项。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Fields.md) - 返回 `Fields` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,37 @@
|
||||
# UIEditorPropertyGridInteraction
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Fields/UIEditorPropertyGridInteraction.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Fields` 子目录中的 `UIEditorPropertyGridInteraction` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorPropertyGridInteraction.h` 是 `XCEditor/Fields` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorPropertyGridInteractionState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPropertyGridInteractionResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorPropertyGridInteractionFrame` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `propertyGridState` | `Widgets::UIEditorPropertyGridState` | 结构体公开字段。 | `{}` |
|
||||
| `keyboardNavigation` | `::XCEngine::UI::Widgets::UIKeyboardNavigationModel` | 结构体公开字段。 | `{}` |
|
||||
| `textInputState` | `::XCEngine::UI::Text::UITextInputState` | 结构体公开字段。 | `{}` |
|
||||
| `pointerPosition` | `::XCEngine::UI::UIPoint` | 结构体公开字段。 | `{}` |
|
||||
| `pressedPopupIndex` | `std::size_t` | 结构体公开字段。 | `Widgets::UIEditorPropertyGridInvalidIndex` |
|
||||
| `hasPointerPosition` | `bool` | 结构体公开字段。 | `false` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Fields.md) - 返回 `Fields` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,38 @@
|
||||
# UIEditorTextField
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEditor/Fields/UIEditorTextField.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Fields` 子目录中的 `UIEditorTextField` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorTextField.h` 是 `XCEditor/Fields` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorTextFieldHitTargetKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorTextFieldSpec` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorTextFieldState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorTextFieldMetrics` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorTextFieldPalette` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorTextFieldLayout` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorTextFieldHitTarget` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `None` | `0` | 枚举项。 |
|
||||
| `Row` | - | 枚举项。 |
|
||||
| `ValueBox` | - | 枚举项。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Fields.md) - 返回 `Fields` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,36 @@
|
||||
# UIEditorTextFieldInteraction
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Fields/UIEditorTextFieldInteraction.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Fields` 子目录中的 `UIEditorTextFieldInteraction` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorTextFieldInteraction.h` 是 `XCEditor/Fields` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorTextFieldInteractionState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorTextFieldInteractionResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorTextFieldInteractionFrame` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `textFieldState` | `Widgets::UIEditorTextFieldState` | 结构体公开字段。 | `{}` |
|
||||
| `textInputState` | `::XCEngine::UI::Text::UITextInputState` | 结构体公开字段。 | `{}` |
|
||||
| `editModel` | `::XCEngine::UI::Widgets::UIPropertyEditModel` | 结构体公开字段。 | `{}` |
|
||||
| `pointerPosition` | `::XCEngine::UI::UIPoint` | 结构体公开字段。 | `{}` |
|
||||
| `hasPointerPosition` | `bool` | 结构体公开字段。 | `false` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Fields.md) - 返回 `Fields` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,38 @@
|
||||
# UIEditorVector2Field
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEditor/Fields/UIEditorVector2Field.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Fields` 子目录中的 `UIEditorVector2Field` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorVector2Field.h` 是 `XCEditor/Fields` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorVector2FieldHitTargetKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorVector2FieldSpec` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorVector2FieldState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorVector2FieldMetrics` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorVector2FieldPalette` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorVector2FieldLayout` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorVector2FieldHitTarget` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `None` | `0` | 枚举项。 |
|
||||
| `Row` | - | 枚举项。 |
|
||||
| `Component` | - | 枚举项。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Fields.md) - 返回 `Fields` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,36 @@
|
||||
# UIEditorVector2FieldInteraction
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Fields/UIEditorVector2FieldInteraction.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Fields` 子目录中的 `UIEditorVector2FieldInteraction` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorVector2FieldInteraction.h` 是 `XCEditor/Fields` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorVector2FieldInteractionState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorVector2FieldInteractionResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorVector2FieldInteractionFrame` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `vector2FieldState` | `Widgets::UIEditorVector2FieldState` | 结构体公开字段。 | `{}` |
|
||||
| `textInputState` | `::XCEngine::UI::Text::UITextInputState` | 结构体公开字段。 | `{}` |
|
||||
| `editModel` | `::XCEngine::UI::Widgets::UIPropertyEditModel` | 结构体公开字段。 | `{}` |
|
||||
| `pointerPosition` | `::XCEngine::UI::UIPoint` | 结构体公开字段。 | `{}` |
|
||||
| `hasPointerPosition` | `bool` | 结构体公开字段。 | `false` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Fields.md) - 返回 `Fields` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,38 @@
|
||||
# UIEditorVector3Field
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEditor/Fields/UIEditorVector3Field.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Fields` 子目录中的 `UIEditorVector3Field` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorVector3Field.h` 是 `XCEditor/Fields` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorVector3FieldHitTargetKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorVector3FieldSpec` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorVector3FieldState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorVector3FieldMetrics` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorVector3FieldPalette` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorVector3FieldLayout` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorVector3FieldHitTarget` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `None` | `0` | 枚举项。 |
|
||||
| `Row` | - | 枚举项。 |
|
||||
| `Component` | - | 枚举项。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Fields.md) - 返回 `Fields` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,36 @@
|
||||
# UIEditorVector3FieldInteraction
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Fields/UIEditorVector3FieldInteraction.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Fields` 子目录中的 `UIEditorVector3FieldInteraction` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorVector3FieldInteraction.h` 是 `XCEditor/Fields` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorVector3FieldInteractionState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorVector3FieldInteractionResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorVector3FieldInteractionFrame` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `vector3FieldState` | `Widgets::UIEditorVector3FieldState` | 结构体公开字段。 | `{}` |
|
||||
| `textInputState` | `::XCEngine::UI::Text::UITextInputState` | 结构体公开字段。 | `{}` |
|
||||
| `editModel` | `::XCEngine::UI::Widgets::UIPropertyEditModel` | 结构体公开字段。 | `{}` |
|
||||
| `pointerPosition` | `::XCEngine::UI::UIPoint` | 结构体公开字段。 | `{}` |
|
||||
| `hasPointerPosition` | `bool` | 结构体公开字段。 | `false` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Fields.md) - 返回 `Fields` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,38 @@
|
||||
# UIEditorVector4Field
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEditor/Fields/UIEditorVector4Field.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Fields` 子目录中的 `UIEditorVector4Field` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorVector4Field.h` 是 `XCEditor/Fields` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorVector4FieldHitTargetKind` | `enum class` | 头文件中的公开声明。 |
|
||||
| `UIEditorVector4FieldSpec` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorVector4FieldState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorVector4FieldMetrics` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorVector4FieldPalette` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorVector4FieldLayout` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorVector4FieldHitTarget` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `None` | `0` | 枚举项。 |
|
||||
| `Row` | - | 枚举项。 |
|
||||
| `Component` | - | 枚举项。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Fields.md) - 返回 `Fields` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,36 @@
|
||||
# UIEditorVector4FieldInteraction
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Fields/UIEditorVector4FieldInteraction.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Fields` 子目录中的 `UIEditorVector4FieldInteraction` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorVector4FieldInteraction.h` 是 `XCEditor/Fields` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorVector4FieldInteractionState` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorVector4FieldInteractionResult` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorVector4FieldInteractionFrame` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `vector4FieldState` | `Widgets::UIEditorVector4FieldState` | 结构体公开字段。 | `{}` |
|
||||
| `textInputState` | `::XCEngine::UI::Text::UITextInputState` | 结构体公开字段。 | `{}` |
|
||||
| `editModel` | `::XCEngine::UI::Widgets::UIPropertyEditModel` | 结构体公开字段。 | `{}` |
|
||||
| `pointerPosition` | `::XCEngine::UI::UIPoint` | 结构体公开字段。 | `{}` |
|
||||
| `hasPointerPosition` | `bool` | 结构体公开字段。 | `false` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Fields.md) - 返回 `Fields` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
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) - 返回顶层索引
|
||||
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)
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user