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

31
docs/api/XCEditor/Shell/UIEditorMenuSession/CloseAll.md Normal file
View 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)

30
docs/api/XCEditor/Shell/UIEditorMenuSession/DismissFromEscape.md Normal file
View File

@@ -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)

31
docs/api/XCEditor/Shell/UIEditorMenuSession/DismissFromFocusLoss.md Normal file
View File

@@ -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)

31
docs/api/XCEditor/Shell/UIEditorMenuSession/DismissFromPointerDown.md Normal file
View File

@@ -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)

31
docs/api/XCEditor/Shell/UIEditorMenuSession/FindPopupState.md Normal file
View File

@@ -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)

30
docs/api/XCEditor/Shell/UIEditorMenuSession/GetOpenRootMenuId.md Normal file
View File

@@ -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)

30
docs/api/XCEditor/Shell/UIEditorMenuSession/GetOpenSubmenuItemIds.md Normal file
View File

@@ -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)

30
docs/api/XCEditor/Shell/UIEditorMenuSession/GetPopupOverlayModel.md Normal file
View File

@@ -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)

30
docs/api/XCEditor/Shell/UIEditorMenuSession/GetPopupStates.md Normal file
View File

@@ -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
View 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)

32
docs/api/XCEditor/Shell/UIEditorMenuSession/HoverMenuBarRoot.md Normal file
View File

@@ -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
View 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
View 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
View 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)

32
docs/api/XCEditor/Shell/UIEditorMenuSession/OpenMenuBarRoot.md Normal file
View File

@@ -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
View 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
View 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)

48
docs/api/XCEditor/Shell/UIEditorMenuSession/UIEditorMenuSession.md Normal file
View File

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