YSTest  PreAlpha_b400_20130424
The YSLib Test Project
 全部  命名空间 文件 函数 变量 类型定义 枚举 枚举值 友元 宏定义  
ShlReader类 参考

#include <ShlReader.h>

类 ShlReader 继承关系图:
ShlReader 的协作图:

Public 成员函数

 ShlReader (const IO::Path &, const shared_ptr< Desktop > &={}, const shared_ptr< Desktop > &={})
 构造:使用指定路径和上下桌面。
 
void Exit ()
 退出阅读器:停止后台任务并发送消息准备切换至 ShlExplorer
 
void OnInput () override
 处理输入消息:发送绘制消息,当处于滚屏状态时自动执行滚屏。
 
- Public 成员函数 继承自 ShlDS
 ShlDS (const shared_ptr< Desktop > &={}, const shared_ptr< Desktop > &={})
 构造:使用指定上下桌面。
 
 DefGetter (const ynothrow, const shared_ptr< Desktop > &, DesktopUpHandle, desktop_up_ptr) DefGetter(const ynothrow
 
const shared_ptr< Desktop >
desktop_down_ptr 
DefGetter (const ynothrow, Desktop &, DesktopUp,*desktop_up_ptr) DefGetter(const ynothrow
 
const shared_ptr< Desktop >
desktop_down_ptr Desktop
*desktop_down_ptr void 
OnGotMessage (const Message &) override
 消息处理函数。
 
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
 退出标识。
 
- Protected 属性 继承自 ShlDS
bool bUpdateUp
 指定当前桌面是否需要更新。
 
bool bUpdateDown
 

额外继承的成员函数

- Public 属性 继承自 ShlDS
const shared_ptr< Desktop > DesktopDownHandle
 
const shared_ptr< Desktop >
desktop_down_ptr Desktop 
DesktopDown
 

详细描述

在文件 ShlReader.h144 行定义.

构造及析构函数说明

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.cpp174 行定义.

成员函数说明

void ShlReader::Exit ( )

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

自从
build 295

在文件 ShlReader.cpp181 行定义.

参考 bExit,CurrentPath,fBackgroundTask,GetDesktopDownHandle(),h_up,NowShellTo() , 以及 ResetDSDesktops().

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

函数调用图:

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

BookmarkList ShlReader::LoadBookmarks ( const string group)
static
自从
build 399

在文件 ShlReader.cpp200 行定义.

参考 bookmarks(),FetchGlobalInstance(),ystdex::ltrim(),MakeEscape() , 以及 ystdex::split().

函数调用图:

ReaderSetting ShlReader::LoadGlobalConfiguration ( )
static

载入阅读器配置。

注解
若失败则使用默认初始化。
自从
build 344

在文件 ShlReader.cpp220 行定义.

参考 FetchGlobalInstance() , 以及 LoadConfiguration().

函数调用图:

void ShlReader::OnInput ( )
override

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

自从
build 289

在文件 ShlReader.cpp233 行定义.

参考 fBackgroundTask.

void ShlReader::SaveBookmarks ( const string group,
const BookmarkList bookmarks 
)
static
自从
build 399

在文件 ShlReader.cpp241 行定义.

参考 FetchGlobalInstance(),YSLib::ValueNode::GetNode(),MakeEscape(),GUIApplication::Root,ystdex::to_string() , 以及 YSLib::ValueNode::Value.

参考自 ShlTextReader::~ShlTextReader().

函数调用图:

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

void ShlReader::SaveGlobalConfiguration ( const ReaderSetting rs)
static

保存阅读器配置。

自从
build 344

在文件 ShlReader.cpp262 行定义.

参考 FetchGlobalInstance() , 以及 SaveConfiguration().

参考自 ShlTextReader::~ShlTextReader().

函数调用图:

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

类成员变量说明

bool ShlReader::bExit
protected

退出标识。

自从
build 302

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

在文件 ShlReader.h163 行定义.

参考自 Exit().

IO::Path ShlReader::CurrentPath
protected
std::function<void()> ShlReader::fBackgroundTask
protected

背景任务:用于滚屏。

自从
build 297

在文件 ShlReader.h156 行定义.

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


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