YSTest: YSLib::IO::FileList类 参考

YSTest PreAlpha_b400_20130424 The YSLib Test Project

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

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

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

文件列表模块。 更多...

`#include <yfilesys.h>`

类 YSLib::IO::FileList 继承关系图:
[图例]
YSLib::IO::FileList 的协作图:
[图例]

## Public 类型

typedef String | ItemType
| 项目名称类型。
typedef vector< ItemType > | ListType
| 项目列表类型。

## Public 成员函数

| 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 ()
| 遍历目录中的项目，更新至列表。

## Protected 属性

Path | Directory
| 目录的完整路径。
shared_ptr< ListType > | hList
| 目录中的项目列表句柄。

## 详细描述

文件列表模块。

在文件 yfilesys.h 第 568 行定义.

## 成员类型定义说明

typedef String YSLib::IO::FileList::ItemType

项目名称类型。

在文件 yfilesys.h 第 571 行定义.

typedef vector<ItemType> YSLib::IO::FileList::ListType

项目列表类型。

在文件 yfilesys.h 第 572 行定义.

## 构造及析构函数说明

YSLib::IO::FileList::FileList | ( | const_path_t | = `{}` | ) |

构造：使用指定路径。

注解
  参数为空或空字符串时为根目录。

YSLib::IO::FileList::FileList | ( | const string & |  | ) |

构造：使用窄字符串。

注解
  参数为空字符串时为根目录。

YSLib::IO::FileList::FileList | ( | const ItemType & |  | ) |

构造：使用指定项目。

注解
  参数为空字符串时为根目录。

virtual YSLib::IO::FileList::~FileList | ( |  | ) |

inlinevirtual

在文件 yfilesys.h 第 594 行定义.

## 成员函数说明

const Path& YSLib::IO::FileList::GetDirectory | ( |  | ) | const

inline

取目录的完整路径。

在文件 yfilesys.h 第 611 行定义.

shared_ptr<ListType> YSLib::IO::FileList::GetListPtr | ( |  | ) | const

inline

取项目列表句柄。

在文件 yfilesys.h 第 613 行定义.

FileList::ListType::size_type FileList::ListItems | ( |  | ) |

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

在文件 yfilesys.cpp 第 405 行定义.

参考 YSLib::IO::CP_Path(),YSLib::IO::FS_Now(),YSLib::IO::FS_Parent(),YSLib::IO::FS_Seperator(),YAssert , 以及 YB_LIKELY.

函数调用图:

bool FileList::operator/= | ( | const Path & | d | ) |

导航至相对路径。

注解
  若成功同时读取列表。

自从
  build 298

在文件 yfilesys.cpp 第 398 行定义.

bool FileList::operator= | ( | const Path & | d | ) |

导航至绝对路径。

注解
  若成功同时读取列表。

自从
  build 298

在文件 yfilesys.cpp 第 387 行定义.

参考 YSLib::IO::Path::IsDirectory().

函数调用图:

## 类成员变量说明

Path YSLib::IO::FileList::Directory

protected

目录的完整路径。

在文件 yfilesys.h 第 575 行定义.

参考自 YSLib::UI::FileBox::GetPath().

shared_ptr<ListType> YSLib::IO::FileList::hList

protected

目录中的项目列表句柄。

在文件 yfilesys.h 第 576 行定义.

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

- yfilesys.h
- yfilesys.cpp