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

docs: add xceditor api tree and new resource docs

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

68
docs/api/XCEditor/Fields/Fields.md Normal file
View 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)

40
docs/api/XCEditor/Fields/UIEditorAssetField/UIEditorAssetField.md Normal file
View File

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

34
docs/api/XCEditor/Fields/UIEditorAssetFieldInteraction/UIEditorAssetFieldInteraction.md Normal file
View File

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

38
docs/api/XCEditor/Fields/UIEditorBoolField/UIEditorBoolField.md Normal file
View File

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

34
docs/api/XCEditor/Fields/UIEditorBoolFieldInteraction/UIEditorBoolFieldInteraction.md Normal file
View File

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

46
docs/api/XCEditor/Fields/UIEditorColorField/UIEditorColorField.md Normal file
View File

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

34
docs/api/XCEditor/Fields/UIEditorColorFieldInteraction/UIEditorColorFieldInteraction.md Normal file
View File

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

39
docs/api/XCEditor/Fields/UIEditorEnumField/UIEditorEnumField.md Normal file
View File

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

37
docs/api/XCEditor/Fields/UIEditorEnumFieldInteraction/UIEditorEnumFieldInteraction.md Normal file
View File

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

18
docs/api/XCEditor/Fields/UIEditorFieldStyle/UIEditorFieldStyle.md Normal file
View File

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

38
docs/api/XCEditor/Fields/UIEditorNumberField/UIEditorNumberField.md Normal file
View File

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

36
docs/api/XCEditor/Fields/UIEditorNumberFieldInteraction/UIEditorNumberFieldInteraction.md Normal file
View File

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

40
docs/api/XCEditor/Fields/UIEditorObjectField/UIEditorObjectField.md Normal file
View File

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

34
docs/api/XCEditor/Fields/UIEditorObjectFieldInteraction/UIEditorObjectFieldInteraction.md Normal file
View File

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

53
docs/api/XCEditor/Fields/UIEditorPropertyGrid/UIEditorPropertyGrid.md Normal file
View File

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

37
docs/api/XCEditor/Fields/UIEditorPropertyGridInteraction/UIEditorPropertyGridInteraction.md Normal file
View File

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

38
docs/api/XCEditor/Fields/UIEditorTextField/UIEditorTextField.md Normal file
View File

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

36
docs/api/XCEditor/Fields/UIEditorTextFieldInteraction/UIEditorTextFieldInteraction.md Normal file
View File

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

38
docs/api/XCEditor/Fields/UIEditorVector2Field/UIEditorVector2Field.md Normal file
View File

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

36
docs/api/XCEditor/Fields/UIEditorVector2FieldInteraction/UIEditorVector2FieldInteraction.md Normal file
View File

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

38
docs/api/XCEditor/Fields/UIEditorVector3Field/UIEditorVector3Field.md Normal file
View File

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

36
docs/api/XCEditor/Fields/UIEditorVector3FieldInteraction/UIEditorVector3FieldInteraction.md Normal file
View File

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

38
docs/api/XCEditor/Fields/UIEditorVector4Field/UIEditorVector4Field.md Normal file
View File

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

36
docs/api/XCEditor/Fields/UIEditorVector4FieldInteraction/UIEditorVector4FieldInteraction.md Normal file
View File

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