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
	退出标识。 更多...

详细描述

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

构造及析构函数说明

YReader::ShlReader::ShlReader	(	const IO::Path &	pth,
		const shared_ptr< Desktop > &	h_dsk_up = {},
		const shared_ptr< Desktop > &	h_dsk_dn = {}
	)

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

参见

ShlDS::ShlDS

自从

build 395

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

成员函数说明

void YReader::ShlReader::Exit

(

)

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

自从

build 295

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

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

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

函数调用图:

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

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

static

自从

build 399

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

参考 YSLib::FetchRoot(), ystdex::ltrim(), NPL::MakeEscape() , 以及 ystdex::split().

函数调用图:

ReaderSetting YReader::ShlReader::LoadGlobalConfiguration ( )

static

载入阅读器配置。

注解

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

自从

build 344

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

参考 YSLib::FetchRoot() , 以及 YSLib::LoadConfiguration().

函数调用图:

void YReader::ShlReader::OnInput ( )

override

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

自从

build 289

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

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

函数调用图:

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

static

自从

build 399

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

参考 YSLib::ValueNode::at(), YSLib::FetchRoot(), NPL::MakeEscape(), ystdex::to_string() , 以及 YSLib::ValueNode::Value.

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

函数调用图:

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

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

static

保存阅读器配置。

自从

build 344

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

参考 YSLib::FetchRoot() , 以及 YSLib::SaveConfiguration().

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

函数调用图:

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

类成员变量说明

bool YReader::ShlReader::bExit

protected

退出标识。

自从

build 302

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

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

参考自 Exit().

IO::Path YReader::ShlReader::CurrentPath

protected

当前路径。

自从

build 296

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

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

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

protected

背景任务：用于滚屏。

自从

build 297

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

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

---

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

• ShlReader.h
• ShlReader.cpp