docs: add xceditor api tree and new resource docs
This commit is contained in:
@@ -0,0 +1,37 @@
|
||||
# UIEditorCollectionPrimitives
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**头文件**: `XCEditor/Widgets/UIEditorCollectionPrimitives.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Widgets` 子目录中的 `UIEditorCollectionPrimitives` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorCollectionPrimitives.h` 是 `XCEditor/Widgets` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorCollectionPrimitiveKind` | `enum class` | 头文件中的公开声明。 |
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 枚举值 | 数值 | 描述 |
|
||||
|--------|------|------|
|
||||
| `None` | `0` | 枚举项。 |
|
||||
| `ScrollView` | - | 枚举项。 |
|
||||
| `TreeView` | - | 枚举项。 |
|
||||
| `TreeItem` | - | 枚举项。 |
|
||||
| `ListView` | - | 枚举项。 |
|
||||
| `ListItem` | - | 枚举项。 |
|
||||
| `PropertySection` | - | 枚举项。 |
|
||||
| `FieldRow` | - | 枚举项。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Widgets.md) - 返回 `Widgets` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,33 @@
|
||||
# UIEditorColorUtils
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Widgets/UIEditorColorUtils.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Widgets` 子目录中的 `UIEditorColorUtils` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorColorUtils.h` 是 `XCEditor/Widgets` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorHsvColor` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `hue` | `float` | 结构体公开字段。 | `0.0f` |
|
||||
| `saturation` | `float` | 结构体公开字段。 | `0.0f` |
|
||||
| `value` | `float` | 结构体公开字段。 | `0.0f` |
|
||||
| `alpha` | `float` | 结构体公开字段。 | `1.0f` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Widgets.md) - 返回 `Widgets` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,34 @@
|
||||
# UIEditorFieldRowLayout
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEditor/Widgets/UIEditorFieldRowLayout.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Widgets` 子目录中的 `UIEditorFieldRowLayout` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorFieldRowLayout.h` 是 `XCEditor/Widgets` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `UIEditorInspectorFieldStyleTokens` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorFieldRowLayoutMetrics` | `struct` | 头文件中的公开声明。 |
|
||||
| `UIEditorFieldRowLayout` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `bounds` | `::XCEngine::UI::UIRect` | 结构体公开字段。 | `{}` |
|
||||
| `labelRect` | `::XCEngine::UI::UIRect` | 结构体公开字段。 | `{}` |
|
||||
| `controlRect` | `::XCEngine::UI::UIRect` | 结构体公开字段。 | `{}` |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Widgets.md) - 返回 `Widgets` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
@@ -0,0 +1,18 @@
|
||||
# UIEditorTextLayout
|
||||
|
||||
**命名空间**: `XCEngine`
|
||||
|
||||
**类型**: `header`
|
||||
|
||||
**头文件**: `XCEditor/Widgets/UIEditorTextLayout.h`
|
||||
|
||||
**描述**: 定义 `XCEditor/Widgets` 子目录中的 `UIEditorTextLayout` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`UIEditorTextLayout.h` 是 `XCEditor/Widgets` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Widgets.md) - 返回 `Widgets` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
41
docs/api/XCEditor/Widgets/Widgets.md
Normal file
41
docs/api/XCEditor/Widgets/Widgets.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# Widgets
|
||||
|
||||
**命名空间**: `XCEngine::UI::Editor::Widgets`
|
||||
|
||||
**类型**: `submodule`
|
||||
|
||||
**描述**: 编辑器基础 UI 原语子模块,覆盖集合控件标签分类、通用文本布局、字段行布局与颜色工具。
|
||||
|
||||
## 概述
|
||||
|
||||
`Widgets` 不是完整控件集合,而是被 `Collections`、`Fields` 和 `Shell` 反复复用的低层工具头文件:
|
||||
|
||||
- `UIEditorCollectionPrimitives.h`
|
||||
- 统一描述 scroll/tree/list/property-section/field-row 等标签的分类和布局属性
|
||||
- `UIEditorColorUtils.h`
|
||||
- 颜色与视觉辅助函数
|
||||
- `UIEditorFieldRowLayout.h`
|
||||
- 字段标签列 / 控件列的基础布局工具
|
||||
- `UIEditorTextLayout.h`
|
||||
- 文本高度、顶边与裁剪矩形的内联 helper
|
||||
|
||||
这些类型被 `UIEditorTheme.h`、`UIEditorPropertyGrid.h`、`UIEditorShellCompose.h` 等更高层模块直接复用。
|
||||
|
||||
## 公开头文件
|
||||
|
||||
- `UIEditorCollectionPrimitives.h`
|
||||
- `UIEditorColorUtils.h`
|
||||
- `UIEditorFieldRowLayout.h`
|
||||
- `UIEditorTextLayout.h`
|
||||
|
||||
## 当前实现边界
|
||||
|
||||
- 当前这里只建立目录索引页,具体头文件页仍需后续逐个补齐。
|
||||
- 这一层主要提供纯函数和轻量布局工具,不承担 panel / workspace 级状态管理。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [XCEditor](../XCEditor.md)
|
||||
- [Collections](../Collections/Collections.md)
|
||||
- [Fields](../Fields/Fields.md)
|
||||
- [Foundation](../Foundation/Foundation.md)
|
||||
Reference in New Issue
Block a user