YSTest: YReader::ShlReader类 参考

YSTest PreAlpha_b700_20160611 The YSLib Test Project

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

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

Public 成员函数 | 静态 Public 成员函数 | Protected 属性 | 所有成员列表
YReader::ShlReader类 参考

`#include <ShlReader.h>`

类 YReader::ShlReader 继承关系图:
[图例]
YReader::ShlReader 的协作图:
[图例]

## Public 成员函数

| ShlReader (const IO::Path &, const shared_ptr< Desktop > &={}, const shared_ptr< Desktop > &={})
| 构造：使用指定路径和上下桌面。 更多...
void | Exit ()
| 退出阅读器：停止后台任务并发送消息准备切换至 ShlExplorer 。 更多...
void | OnInput () override
| 处理输入消息：发送绘制消息，当处于滚屏状态时自动执行滚屏。 更多...

## 静态 Public 成员函数

static BookmarkList | LoadBookmarks (const string &)
static ReaderSetting | LoadGlobalConfiguration ()
| 载入阅读器配置。 更多...
static void | SaveBookmarks (const string &, const BookmarkList &)
static void | SaveGlobalConfiguration (const ReaderSetting &)
| 保存阅读器配置。 更多...

## Protected 属性

IO::Path | CurrentPath
| 当前路径。 更多...
std::function< void()> | fBackgroundTask
| 背景任务：用于滚屏。 更多...
bool | bExit
| 退出标识。 更多...

## 详细描述

自从
  build 198

在文件 ShlReader.h 第 153 行定义.

## 构造及析构函数说明

YReader::ShlReader::ShlReader | ( | const IO::Path & | ,
|  | const shared_ptr< Desktop > & | = `{}`,
|  | const shared_ptr< Desktop > & | = `{}`
| ) |  |

构造：使用指定路径和上下桌面。

参见
  ShlDS::ShlDS

自从
  build 395

## 成员函数说明

void YReader::ShlReader::Exit | ( |  | ) |

退出阅读器：停止后台任务并发送消息准备切换至 ShlExplorer 。

自从
  build 295

在文件 ShlReader.cpp 第 193 行定义.

参考 bExit, CurrentPath, fBackgroundTask, YSLib::PostTask(), YSLib::DS::ResetDSDesktops() , 以及 yunseq.

参考自 YReader::ShlTextReader::Execute() , 以及 YReader::ShlTextReader::OnKeyDown().

函数调用图:

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

BookmarkList YReader::ShlReader::LoadBookmarks | ( | const string & | group | ) |

static

自从
  build 399

在文件 ShlReader.cpp 第 212 行定义.

参考 YSLib::AccessNode(), CatchExpr, CatchIgnore, CHRLib::e, YSLib::FetchRoot(), platform::Descriptions::Informative, ystdex::ltrim(), NPL::A1::name, platform::Descriptions::Notice, ystdex::quote(), ystdex::split(), TryExpr, platform::Descriptions::Warning , 以及 YTraceDe.

函数调用图:

ReaderSetting YReader::ShlReader::LoadGlobalConfiguration | ( |  | ) |

static

载入阅读器配置。

注解
  若失败则使用默认初始化。

自从
  build 344

在文件 ShlReader.cpp 第 241 行定义.

参考 YSLib::AccessNode(), CatchExpr, CHRLib::e, YSLib::FetchRoot(), YSLib::LoadConfiguration(), NPL::A1::name, TryRet, platform::Descriptions::Warning , 以及 YTraceDe.

函数调用图:

void YReader::ShlReader::OnInput | ( |  | ) |

override

处理输入消息：发送绘制消息，当处于滚屏状态时自动执行滚屏。

自从
  build 289

在文件 ShlReader.cpp 第 252 行定义.

参考 fBackgroundTask , 以及 YSLib::PostTask().

函数调用图:

void YReader::ShlReader::SaveBookmarks | ( | const string & | group,
|  | const BookmarkList & | bookmarks
| ) |  |

static

自从
  build 399

在文件 ShlReader.cpp 第 260 行定义.

参考 CatchExpr, CHRLib::e, YSLib::FetchRoot(), NPL::A1::name, YSLib::Text::str, ystdex::to_string(), YSLib::ValueNode::Value, platform::Descriptions::Warning , 以及 YTraceDe.

参考自 YReader::ShlTextReader::~ShlTextReader().

函数调用图:

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

void YReader::ShlReader::SaveGlobalConfiguration | ( | const ReaderSetting & | rs | ) |

static

保存阅读器配置。

自从
  build 344

在文件 ShlReader.cpp 第 277 行定义.

参考 CatchExpr, CHRLib::e, YSLib::FetchRoot(), NPL::A1::name, YSLib::SaveConfiguration(), platform::Descriptions::Warning , 以及 YTraceDe.

参考自 YReader::ShlTextReader::~ShlTextReader().

函数调用图:

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

## 类成员变量说明

bool YReader::ShlReader::bExit

protected

退出标识。

自从
  build 302

用于保证对一个实例只进行一次有效切换的标识。

在文件 ShlReader.h 第 172 行定义.

参考自 Exit().

IO::Path YReader::ShlReader::CurrentPath

protected

当前路径。

自从
  build 296

在文件 ShlReader.h 第 160 行定义.

参考自 Exit(), YReader::ShlTextReader::LoadFile(), YReader::ShlTextReader::Locate(), YReader::ShlTextReader::UpdateReadingList() , 以及 YReader::ShlTextReader::~ShlTextReader().

std::function<void()> YReader::ShlReader::fBackgroundTask

protected

背景任务：用于滚屏。

自从
  build 297

在文件 ShlReader.h 第 165 行定义.

参考自 Exit(), OnInput(), YReader::ShlTextReader::StartAutoScroll() , 以及 YReader::ShlTextReader::StopAutoScroll().

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

- ShlReader.h
- ShlReader.cpp