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

YSTest PreAlpha_b400_20130424 The YSLib Test Project

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

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

全部 类 命名空间 文件 函数 变量 类型定义 枚举 枚举值 友元 宏定义 组 页
Public 成员函数 | 所有成员列表
YSLib::UI::FileBox类 参考

文件列表框。 更多...

`#include <ComboList.h>`

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

## Public 成员函数

| FileBox (const Rect &={})
| FileBox (FileBox &&)=default
IO::Path | GetPath () const
| 取当前路径。
bool | SetPath (const IO::Path &)
| 设置路径，若成功则刷新列表。
Public 成员函数 继承自 YSLib::IO::FileList
| FileList (const_path_t={})
| 构造：使用指定路径。
| FileList (const string &)
| 构造：使用窄字符串。
| FileList (const ItemType &)
| 构造：使用指定项目。
virtual | ~FileList ()
bool | operator= (const Path &)
| 导航至绝对路径。
bool | operator/= (const Path &)
| 导航至相对路径。
const Path & | GetDirectory () const ynothrow
| 取目录的完整路径。
shared_ptr< ListType > | GetListPtr () const ynothrow
| 取项目列表句柄。
ListType::size_type | ListItems ()
| 遍历目录中的项目，更新至列表。
Public 成员函数 继承自 YSLib::UI::ListBox
| ListBox (const Rect &={}, const shared_ptr< ListType > &={})
| ListBox (ListBox &&)=default
Iterator | GetBegin ()
Iterator | GetEnd ()
WidgetRange | GetChildren () override
IWidget & | operator[] (size_t idx) ynoexcept
size_t | GetChildrenCount () const ynothrow
bool | IsSelected () const ynothrow
bool | Contains (ListType::size_type i)
ListType::size_type | GetHeadIndex () const ynothrow
ListType::size_type | GetSelectedIndex () const ynothrow
const ListType & | GetList () const ynothrow
ListType & | GetListRef () ynothrow
GEvent< void(HViewEvent::EventArgsType)> & | GetViewChanged () ynothrow
| 视图变更事件。
GEvent< void(HIndexEvent::EventArgsType)> & | GetSelected () ynothrow
| 项目选择状态变更事件。
GEvent< void(HIndexEvent::EventArgsType)> & | GetConfirmed () ynothrow
| 项目选中确定事件。
void | SetList (const shared_ptr< ListType > &_tempArgName)
| 设置文本列表。
void | SetSelected (ListType::size_type i)
| 设置选中项。
void | AdjustViewForContent ()
| 按内容大小依次调整列表视图中选中和首个项目的索引。
void | AdjustViewLength ()
| 调整视图长度。
void | ClearSelected ()
| 清除选中项。
IndexType | Find (const ItemType &text)
| 查找项。
void | ResetView ()
void | ResizeForPreferred (const Size &sup, Size s={})
| 按指定大小上限和内容调整大小。
void | UpdateView ()
Public 成员函数 继承自 YSLib::UI::ScrollableContainer
| ScrollableContainer (const Rect &={})
| ScrollableContainer (ScrollableContainer &&)=default
Iterator | GetBegin ()
Iterator | GetEnd ()
WidgetRange | GetChildren () override
IWidget & | operator[] (size_t idx) ynoexcept
size_t | GetChildrenCount () const ynothrow
Public 成员函数 继承自 YSLib::UI::Control
| Control (const Rect &={})
| 构造：使用指定边界，默认背景（同 Widget 默认构造）。
| Control (const Rect &, NoBackgroundTag)
| 构造：使用指定边界，无背景。
| Control (const Control &)
| 复制构造：除容器为空外深复制。
| Control (Control &&)=default
virtual IWidget * | GetBoundControlPtr (const KeyInput &)
| 取按键-指针设备输入默认事件组映射。
void | OnTouch_Close (TouchEventArgs &&)
| 处理屏幕事件：关闭显示。
Public 成员函数 继承自 YSLib::UI::Widget
| Widget (const Rect &={}, Color=Drawing::ColorSpace::White, Color=Drawing::ColorSpace::Black)
template<typename _tView , typename _tRenderer , typename _tController >
| Widget (_tView &&pView_=make_unique< View >(), _tRenderer &&pRenderer_=make_unique< Renderer >(), _tController &&pController_={})
| 构造：使用视图指针、渲染器指针和控制器指针，无背景。
| Widget (const Widget &)
| 复制构造：除容器指针为空外深复制。
| Widget (Widget &&)=default
virtual | ~Widget ()
| 析构：虚实现。
SPos | GetX () const ynothrow
SPos | GetY () const ynothrow
SDst | GetWidth () const ynothrow
SDst | GetHeight () const ynothrow
virtual Renderer & | GetRenderer () const ynothrow
| 取渲染器。
virtual View & | GetView () const ynothrow
| 取部件视图。
virtual AController & | GetController () const override
| 取控制器。
void | SetX (SDst _tempArgName)
void | SetY (SDst _tempArgName)
void | SetWidth (SDst _tempArgName)
void | SetHeight (SDst _tempArgName)
void | SetRenderer (unique_ptr< Renderer > &&)
| 设置渲染器为指定指针指向的对象，同时更新渲染器状态。
void | SetView (unique_ptr< View > &&)
| 设置渲染器为指定指针指向的对象，同时更新渲染器状态。
virtual void | Refresh (PaintEventArgs &&)
| 刷新：按指定参数绘制界面并更新状态。
Public 成员函数 继承自 YSLib::UI::IWidget
virtual | ~IWidget ()

## 额外继承的成员函数

Public 类型 继承自 YSLib::IO::FileList
typedef String | ItemType
| 项目名称类型。
typedef vector< ItemType > | ListType
| 项目列表类型。
Public 类型 继承自 YSLib::UI::ListBox
typedef TextList::ListType | ListType
typedef TextList::ViewArgs | ViewArgs
typedef TextList::HViewEvent | HViewEvent
typedef TextList::IndexType | IndexType
typedef TextList::ItemType | ItemType
typedef ystdex::subscriptive_iterator < ListBox, IWidget > | Iterator
Public 属性 继承自 YSLib::UI::Control
std::function< IWidget *(const KeyInput &)> | BoundControlPtr
| 按键-指针设备输入事件组映射。
Protected 成员函数 继承自 YSLib::UI::ScrollableContainer
Size | FixLayout (const Size &)
| 固定布局。
Protected 属性 继承自 YSLib::IO::FileList
Path | Directory
| 目录的完整路径。
shared_ptr< ListType > | hList
| 目录中的项目列表句柄。
Protected 属性 继承自 YSLib::UI::ListBox
TextList | tlContent

## 详细描述

文件列表框。

自从
  build 205

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

## 构造及析构函数说明

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

explicit

自从
  build 337

YSLib::UI::FileBox::FileBox | ( | FileBox && |  | ) |

inlinedefault

## 成员函数说明

IO::Path FileBox::GetPath | ( |  | ) | const

取当前路径。

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

参考 YSLib::IO::FileList::Directory,YSLib::UI::ListBox::GetList(),YSLib::UI::ListBox::GetSelectedIndex() , 以及 YSLib::UI::ListBox::IsSelected().

函数调用图:

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

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

返回
  是否成功。

自从
  build 298

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

参考 YSLib::UI::ListBox::UpdateView().

函数调用图:

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

- ComboList.h
- ComboList.cpp