YSTest: YSLib::UI::FileBox类 参考

YSTest PreAlpha_b700_20160611 The YSLib Test Project

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

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

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

文件列表框。 更多...

`#include <ComboList.h>`

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

## Public 成员函数

| FileBox (const Rect &={})
| DefDeMoveCtor (FileBox)~FileBox() override
| 虚析构：类定义外默认实现。 更多...
bool | operator= (const IO::Path &)
| 导航至绝对路径。 更多...
bool | operator/= (const String &)
| 导航至子目录。 更多...
bool | operator/= (const IO::Path &)
| 导航至相对路径。 更多...
bool | SetPath (const IO::Path &)
| 设置路径，若成功则刷新列表。 更多...
ListType | ListItems () const
| 遍历目录中的项目，更新至列表。 更多...
Public 成员函数 继承自 YSLib::UI::ListBox
| ListBox (const Rect &={}, const shared_ptr< ListType > &={})
| DefDeMoveCtor (ListBox)~ListBox() override
| 虚析构：类定义外默认实现。 更多...
| DefWidgetMemberIterationBase (ScrollableContainer, GetTextListRef()) PDefH(bool
ListType::size_type i const ynothrow | ImplRet (GetTextListRef().Contains(i)) DefPredMem(const ynothrow
ListType::size_type i const ynothrow | GetTextListRef ()) DefGetter(
| 项目选中确定事件。 更多...
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> | GetTextListRef ().Confirmed) DefGetterMem(const
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> | GetTextListRef ()) DefGetterMem(const
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> | GetTextListRef ()) DefGetterMem(const
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> const ListType | GetTextListRef ()) DefGetterMem(
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> const ListType ListType | GetTextListRef ()) DefGetter(
| 项目选择状态变更事件。 更多...
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> const ListType ListType GEvent< void(IndexEventArgs)> | GetTextListRef ().Selected) DefGetter(const
| 取文本列表引用。 更多...
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> const ListType ListType GEvent< void(IndexEventArgs)> TextList | Deref (pTextList)) DefGetter(
| 视图变更事件。 更多...
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> const ListType ListType GEvent< void(IndexEventArgs)> TextList GEvent< void(ViewArgs)> | GetTextListRef ().ViewChanged) DefSetterMem(
| 设置文本列表。 更多...
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> const ListType ListType GEvent< void(IndexEventArgs)> TextList GEvent< void(ViewArgs)> const shared_ptr< ListType > | GetTextListRef ()) PDefH(void
| 设置选中项。 更多...
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> const ListType ListType GEvent< void(IndexEventArgs)> TextList GEvent< void(ViewArgs)> const shared_ptr< ListType > ListType::size_type i | ImplExpr (GetTextListRef().SetSelected(i)) PDefH(void
| 按内容大小依次调整列表视图中选中和首个项目的索引。 更多...
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> const ListType ListType GEvent< void(IndexEventArgs)> TextList GEvent< void(ViewArgs)> const shared_ptr< ListType > ListType::size_type i | ImplExpr (GetTextListRef().AdjustViewForContent()) PDefH(void
| 调整视图长度。 更多...
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> const ListType ListType GEvent< void(IndexEventArgs)> TextList GEvent< void(ViewArgs)> const shared_ptr< ListType > ListType::size_type i | ImplExpr (GetTextListRef().AdjustViewLength()) PDefH(void
| 清除选中项。 更多...
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> const ListType ListType GEvent< void(IndexEventArgs)> TextList GEvent< void(ViewArgs)> const shared_ptr< ListType > ListType::size_type i | ImplExpr (GetTextListRef().ClearSelected()) PDefH(void
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> const ListType ListType GEvent< void(IndexEventArgs)> TextList GEvent< void(ViewArgs)> const shared_ptr< ListType > ListType::size_type i | ImplExpr (GetTextListRef().ResetView()) void ResizeForPreferred(const Size &sup
| 按指定大小上限和内容调整大小。 更多...
Public 成员函数 继承自 YSLib::UI::ScrollableContainer
| ScrollableContainer (const Rect &={})
| DefDeMoveCtor (ScrollableContainer)~ScrollableContainer() override
| 虚析构：类定义外默认实现。 更多...
Public 成员函数 继承自 YSLib::UI::Widget
| Widget (const Rect &={})
| Widget (const Rect &, HBrush)
template<typename _tView , typename _tRenderer , typename _tController >
| Widget (_tView &&pView_=make_unique< View >(), _tRenderer &&pRenderer_=make_unique< Renderer >(), _tController &&pController_={})
| 构造：使用视图指针、渲染器指针和控制器指针，无背景。 更多...
| Widget (const Widget &)
| 复制构造：除容器指针为空外深复制。 更多...
| DefDelMoveCtor (Widget) virtual ~Widget()
| since build 428 更多...
| DefGetter (ImplI(IWidget), WidgetRange, Children, WidgetRange()) static HBrush MakeBlankBrush()
| 取空白画刷。 更多...
| DefGetter (const ImplI(IWidget), AController &, Controller, Deref(controller_ptr)) DefGetterMem(const ynothrow
| GetView ()) DefGetter(const ImplI(IWidget)
Renderer | Deref (renderer_ptr)) DefGetter(const ImplI(IWidget)
Renderer AView | Deref (view_ptr)) DefGetterMem(const ynothrow
Renderer AView | GetView ()) DefGetterMem(const ynothrow
Renderer AView | GetView ()) DefGetterMem(const ynothrow
Renderer AView | GetView ()) DefSetterMem(
Renderer AView | GetView ()) DefSetterMem(
Renderer AView | GetView ()) DefSetterMem(
Renderer AView | GetView ()) DefSetterMem(
Renderer AView | GetView ()) void SetRenderer(unique_ptr< Renderer >)
| 设置渲染器为指定指针指向的对象，同时更新渲染器状态。 更多...
void | SetView (unique_ptr< AView >)
| 设置视图为指定指针指向的对象。 更多...
virtual void | Refresh (PaintEventArgs &&)
| 刷新：按指定参数绘制界面并更新状态。 更多...

## Public 属性

DefGetter(const ynothrow, const IO::Path &, Directory, pthDirectory) IO IO::Path | GetPath (typename ListType::size_type i) const
| 取目录的完整路径。 更多...
Public 属性 继承自 YSLib::UI::ListBox
| Contains
ListType::size_type i const ynothrow | Selected
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> | Confirmed
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> | HeadIndex
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> | SelectedIndex
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> const ListType | List
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> const ListType ListType | ListRef
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> const ListType ListType GEvent< void(IndexEventArgs)> | Selected
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> const ListType ListType GEvent< void(IndexEventArgs)> TextList | TextListRef
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> const ListType ListType GEvent< void(IndexEventArgs)> TextList GEvent< void(ViewArgs)> | ViewChanged
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> const ListType ListType GEvent< void(IndexEventArgs)> TextList GEvent< void(ViewArgs)> const shared_ptr< ListType > | List
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> const ListType ListType GEvent< void(IndexEventArgs)> TextList GEvent< void(ViewArgs)> const shared_ptr< ListType > | SetSelected
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> const ListType ListType GEvent< void(IndexEventArgs)> TextList GEvent< void(ViewArgs)> const shared_ptr< ListType > ListType::size_type i | AdjustViewForContent
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> const ListType ListType GEvent< void(IndexEventArgs)> TextList GEvent< void(ViewArgs)> const shared_ptr< ListType > ListType::size_type i | AdjustViewLength
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> const ListType ListType GEvent< void(IndexEventArgs)> TextList GEvent< void(ViewArgs)> const shared_ptr< ListType > ListType::size_type i | ClearSelected
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> const ListType ListType GEvent< void(IndexEventArgs)> TextList GEvent< void(ViewArgs)> const shared_ptr< ListType > ListType::size_type i | ResetView
ListType::size_type i const ynothrow GEvent< void(IndexEventArgs)> const ListType ListType GEvent< void(IndexEventArgs)> TextList GEvent< void(ViewArgs)> const shared_ptr< ListType > ListType::size_type i Size | s = {})
Public 属性 继承自 YSLib::UI::Widget
HBrush | Background
| 背景。 更多...
| SDst
| Height
Renderer | Renderer
Renderer AView | View
Renderer AView | SDst
Renderer AView | Width
Renderer AView | SPos
Renderer AView | X
Renderer AView | Y
Renderer AView | Height

## Protected 属性

IO::Path | pthDirectory
| 目录的完整路径。 更多...
Protected 属性 继承自 YSLib::UI::ListBox
unique_ptr< TextList > | pTextList
| 文本列表指针。 更多...
Protected 属性 继承自 YSLib::UI::ScrollableContainer
ScrollBar | hsbHorizontal
| 控制水平和竖直可视区域的水平滚动条。 更多...
ScrollBar | vsbVertical

## 额外继承的成员函数

Public 类型 继承自 YSLib::UI::ListBox
using | ListType = TextList::ListType
using | ViewArgs = TextList::ViewArgs
using | IndexType = TextList::IndexType
using | ItemType = TextList::ItemType
using | iterator = ystdex::subscriptive_iterator< ListBox, IWidget >
Public 类型 继承自 YSLib::UI::ScrollableContainer
using | iterator = ystdex::subscriptive_iterator< ScrollableContainer, IWidget >
Protected 成员函数 继承自 YSLib::UI::ListBox
| ListBox (const Rect &, unique_ptr< TextList >)
Protected 成员函数 继承自 YSLib::UI::Control
| Control (const Rect &, HBrush)
| 构造：使用指定边界和背景画刷。 更多...
| Control (const Control &)
| 复制构造：除容器为空外深复制。 更多...
| DefDeMoveCtor (Control)~Control() override
| 虚析构：类定义外默认实现。 更多...
virtual | PDefH (observer_ptr< IWidget >, GetBoundControlPtr, const KeyInput &) ImplRet(nullptr) void OnTouch_Close(CursorEventArgs &&)
| 取按键-指针设备输入默认事件组映射。 更多...
相关函数 继承自 YSLib::UI::Widget
template<class... _tWidgets>
void | InvalidateWidgets (_tWidgets &...wgts)
| 向无效化部件。 更多...
template<class _tRenderer >
_tRenderer & | WrapRenderer (Widget &wgt, unique_ptr< _tRenderer > p_renderer)
| 包装渲染器：设置渲染器并返回被设置的渲染器引用。 更多...

## 详细描述

文件列表框。

自从
  build 205

在文件 ComboList.h 第 169 行定义.

## 构造及析构函数说明

YSLib::UI::FileBox::FileBox | ( | const Rect & | r = `{}` | ) |

explicit

自从
  build 337

在文件 ComboList.cpp 第 122 行定义.

参考 YSLib::UI::bool, YSLib::UI::ListBox::Contains, YSLib::UI::e, GetPath, ListItems(), YSLib::UI::ListBox::ResetView , 以及 YSLib::UI::UpdateView().

函数调用图:

## 成员函数说明

YSLib::UI::FileBox::DefDeMoveCtor | ( | FileBox |  | ) |

override

虚析构：类定义外默认实现。

自从
  build 586

FileBox::ListType YSLib::UI::FileBox::ListItems | ( |  | ) | const

遍历目录中的项目，更新至列表。

自从
  build 414

在文件 ComboList.cpp 第 183 行定义.

参考 CatchIgnore, YSLib::IO::ListFiles(), pthDirectory , 以及 TryExpr.

参考自 FileBox() , 以及 SetPath().

函数调用图:

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

bool YSLib::UI::FileBox::operator/= | ( | const String & | d | ) |

导航至子目录。

自从
  build 414

在文件 ComboList.cpp 第 160 行定义.

参考 CHRLib::d , 以及 pthDirectory.

bool YSLib::UI::FileBox::operator/= | ( | const IO::Path & | d | ) |

导航至相对路径。

自从
  build 414

在文件 ComboList.cpp 第 165 行定义.

参考 CHRLib::d , 以及 pthDirectory.

bool YSLib::UI::FileBox::operator= | ( | const IO::Path & |  | ) |

导航至绝对路径。

自从
  build 414

bool YSLib::UI::FileBox::SetPath | ( | const IO::Path & | pth | ) |

设置路径，若成功则刷新列表。

返回
  是否成功。

自从
  build 298

在文件 ComboList.cpp 第 171 行定义.

参考 ListItems() , 以及 YSLib::UI::UpdateView().

函数调用图:

## 类成员变量说明

DefGetter (const ynothrow, const IO::Path&, Directory, pthDirectory) IO IO::Path YSLib::UI::FileBox::GetPath(typename ListType::size_type i) const

取目录的完整路径。

自从
  build 414

取当前选中项的路径。

取指定项的路径。

前置条件
  断言： `Contains(i)` 。

自从
  build 639

在文件 ComboList.h 第 225 行定义.

参考自 FileBox().

IO::Path YSLib::UI::FileBox::pthDirectory

protected

目录的完整路径。

自从
  build 414

在文件 ComboList.h 第 176 行定义.

参考自 ListItems() , 以及 operator/=().

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

- ComboList.h
- ComboList.cpp