YSTest: YSLib::UI::MUIContainer类 参考

YSTest PreAlpha_b800_20170810 The YSLib Test Project

- 首页
- 相关页面
- 模块
- 命名空间
- 类
- 文件

- 类列表
- 类索引
- 类继承关系
- 类成员

Public 类型 | Public 成员函数 | Public 属性 | Protected 属性 | 所有成员列表
YSLib::UI::MUIContainer类 参考

部件容器模块。 更多...

`#include <YUIContainer.h>`

类 YSLib::UI::MUIContainer 继承关系图:
[图例]
YSLib::UI::MUIContainer 的协作图:
[图例]

## Public 类型

using | ItemType = lref< IWidget >
| 部件组项目类型。 更多...
using | WidgetMap = multimap< ZOrder, ItemType >
| 部件映射表类型：映射 Z 顺序至部件。 更多...
using | PairType = WidgetMap::value_type
using | iterator = WidgetIterator

## Public 成员函数

bool | Contains (IWidget &)
| 判断是否包含指定部件。 更多...
| DefGetter (const ynothrow, size_t, Count, mWidgets.size()) void Add(IWidget &
| 取部件数。 更多...
void | PaintVisibleChildren (PaintEventArgs &)
| 绘制可视子部件。 更多...
ZOrder | QueryZ (IWidget &) const
| 查询指定部件的 Z 顺序。 更多...
iterator | begin ()
| PDefH (void, clear,) ynothrow ImplExpr(mWidgets.clear()) iterator end()
| DefDeCtor (MUIContainer) DefDeMoveCtor(MUIContainer) PDefHOp(void
| 无参数构造：默认实现。 更多...
IWidget &wgt | ImplRet (Add(wgt)) bool operator-
| 从部件组移除部件。 更多...

## Public 属性

| ZOrder = DefaultZOrder)

## Protected 属性

WidgetMap | mWidgets
| 部件映射：存储 Z 顺序映射至部件引用。 更多...

## 详细描述

部件容器模块。

警告
  非虚析构。

自从
  build 167

在文件 YUIContainer.h 第 311 行定义.

## 成员类型定义说明

using YSLib::UI::MUIContainer::ItemType = lref<IWidget>

部件组项目类型。

自从
  build 554

在文件 YUIContainer.h 第 318 行定义.

using YSLib::UI::MUIContainer::iterator = WidgetIterator

自从
  build 460

在文件 YUIContainer.h 第 326 行定义.

using YSLib::UI::MUIContainer::PairType = WidgetMap::value_type

在文件 YUIContainer.h 第 324 行定义.

using YSLib::UI::MUIContainer::WidgetMap = multimap<ZOrder, ItemType>

部件映射表类型：映射 Z 顺序至部件。

自从
  build 555

在文件 YUIContainer.h 第 323 行定义.

## 成员函数说明

MUIContainer::iterator YSLib::UI::MUIContainer::begin | ( |  | ) |

自从
  build 460

在文件 YUIContainer.cpp 第 271 行定义.

参考 ystdex::get_get , 以及 ystdex::get_value.

bool YSLib::UI::MUIContainer::Contains | ( | IWidget & | wgt | ) |

判断是否包含指定部件。

在文件 YUIContainer.cpp 第 244 行定义.

参考 YSLib::UI::wgt , 以及 ynothrow.

YSLib::UI::MUIContainer::DefDeCtor | ( | MUIContainer |  | ) |

无参数构造：默认实现。

自从
  build 537

向部件组添加部件。

注解
  部件已存在时忽略。

向部件组按默认 Z 顺序值添加部件。

YSLib::UI::MUIContainer::DefGetter | ( | const ynothrow | ,
|  | size_t | ,
|  | Count | ,
|  | mWidgets. | size()
| ) |  |

取部件数。

自从
  build 495

向部件组添加部件。

注解
  部件已存在时忽略。

自从
  build 555

向焦点对象组添加焦点对象，同时向部件组按指定 Z 顺序值添加部件。

IWidget& wgt YSLib::UI::MUIContainer::ImplRet | ( | Add(wgt) |  | ) |

从部件组移除部件。

返回
  存在指定部件且移除成功。

从部件组移除部件。

void YSLib::UI::MUIContainer::PaintVisibleChildren | ( | PaintEventArgs & | e | ) |

绘制可视子部件。

自从
  build 537

在文件 YUIContainer.cpp 第 253 行定义.

参考 ystdex::get_value , 以及 YSLib::UI::PaintVisibleChildAndCommit().

参考自 YSLib::UI::Panel::Refresh().

函数调用图:

这是这个函数的调用关系图:

YSLib::UI::MUIContainer::PDefH | ( | void | ,
|  | clear |
| ) |  |

自从
  build 537
  build 460

ZOrder YSLib::UI::MUIContainer::QueryZ | ( | IWidget & | wgt | ) | const

查询指定部件的 Z 顺序。

异常

  std::out_of_range | 不包含指定子部件。

自从
  build 555

在文件 YUIContainer.cpp 第 262 行定义.

## 类成员变量说明

WidgetMap YSLib::UI::MUIContainer::mWidgets

protected

部件映射：存储 Z 顺序映射至部件引用。

自从
  build 279

在文件 YUIContainer.h 第 333 行定义.

参考自 YSLib::UI::Panel::ClearContents() , 以及 YSLib::UI::Panel::MoveToFront().

YSLib::UI::MUIContainer::ZOrder = DefaultZOrder)

在文件 YUIContainer.h 第 383 行定义.

该类的文档由以下文件生成:

- YUIContainer.h
- YUIContainer.cpp