docs: add xceditor api tree and new resource docs
This commit is contained in:
@@ -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) - 返回顶层索引
|
||||
Reference in New Issue
Block a user