类 foxit::pdf::ReadingBookmark 继承关系图:

Public 成员函数
	ReadingBookmark (const ReadingBookmark &other)
	构造函数，使用另一个阅读书签对象。更多...

	~ReadingBookmark ()
	析构函数。

DateTime	GetDateTime (bool is_creation_date) const
	获取日期时间信息。更多...

int	GetPageIndex () const
	获取目标页面的索引。更多...

WString	GetTitle () const
	获取标题。更多...

bool	IsEmpty () const
	检查当前对象是否为空。更多...

bool	operator != (const ReadingBookmark &other) const
	不相等操作符。更多...

ReadingBookmark &	operator= (const ReadingBookmark &other)
	赋值操作符。更多...

bool	operator== (const ReadingBookmark &other) const
	相等操作符。更多...

void	SetDateTime (const DateTime &date_time, bool is_creation_date)
	设置日期时间信息。更多...

void	SetPageIndex (int index)
	设置目标页面的索引。更多...

void	SetTitle (const WString &title)
	设置标题。更多...

Public 成员函数继承自 foxit::Base
FS_HANDLE	Handle () const
	获取当前对象的句柄。更多...

详细描述

阅读书签不是PDF书签，换句话说，它不是PDF大纲。它是应用程序级别的书签。它存储在目录的元数据（XML格式）中。它允许用户根据阅读偏好添加或删除阅读书签，并通过选择一个阅读书签轻松导航到PDF页面。
为了检索阅读书签，可以调用函数 PDFDoc::GetReadingBookmarkCount 来计算阅读书签的数量，可以调用函数 PDFDoc::GetReadingBookmark 来通过索引获取阅读书签。
此类提供了几个函数来获取/设置阅读书签的属性，例如标题、目标页面索引以及创建/修改日期时间。

参见: PDFDoc

构造及析构函数说明

◆ ReadingBookmark()

foxit::pdf::ReadingBookmark::ReadingBookmark ( const ReadingBookmark & other )

构造函数，使用另一个阅读书签对象。

参数

[in] other 另一个阅读书签对象。

成员函数说明

◆ GetDateTime()

DateTime foxit::pdf::ReadingBookmark::GetDateTime ( bool is_creation_date ) const

获取日期时间信息。

参数

[in] is_creation_date true 表示获取创建日期时间信息， false 表示获取最后修改日期时间信息。

返回: 指定的日期和时间。如果找不到指定的日期和时间属性，此函数将返回所有值为0的日期和时间对象。

◆ GetPageIndex()

int foxit::pdf::ReadingBookmark::GetPageIndex ( ) const

获取目标页面的索引。

返回: 页面索引，从0开始。如果找不到页面索引属性，此函数将返回-1。

◆ GetTitle()

WString foxit::pdf::ReadingBookmark::GetTitle ( ) const

获取标题。

返回: 标题字符串。如果找不到标题属性，此函数将返回空字符串。

◆ IsEmpty()

bool foxit::pdf::ReadingBookmark::IsEmpty ( ) const

检查当前对象是否为空。

当前对象为空时，表示当前对象无用。

返回: true 表示当前对象为空，false 表示不为空。

◆ operator !=()

bool foxit::pdf::ReadingBookmark::operator != ( const ReadingBookmark & other ) const

不相等操作符。

参数

[in] other 另一个阅读书签对象。此函数将检查当前对象是否不等于此对象。

返回: true 表示不相等，false 表示相等。

◆ operator=()

ReadingBookmark& foxit::pdf::ReadingBookmark::operator= ( const ReadingBookmark & other )

赋值操作符。

参数

[in] other 另一个阅读书签对象，其值将被赋予当前对象。

返回: 当前对象本身的引用。

◆ operator==()

bool foxit::pdf::ReadingBookmark::operator== ( const ReadingBookmark & other ) const

相等操作符。

参数

[in] other 另一个阅读书签对象。此函数将检查当前对象是否等于此对象。

返回: true 表示相等，false 表示不相等。

◆ SetDateTime()

void foxit::pdf::ReadingBookmark::SetDateTime	(	const DateTime &	date_time,
		bool	is_creation_date
	)

设置日期时间信息。

参数

[in]	date_time	新的日期时间信息。此日期对象的所有值都应有效。更多详细信息请参考类 foxit::DateTime 的注释。
[in]	is_creation_date	true 表示设置创建日期时间信息， false 表示设置最后修改日期时间信息。

返回: 无。

◆ SetPageIndex()

void foxit::pdf::ReadingBookmark::SetPageIndex ( int index )

设置目标页面的索引。

参数

[in] index 新的目标页面索引。有效范围：从0到（count-1）。 count 是当前阅读书签所属PDF文档的页面数。页面数可以通过函数 PDFDoc::GetPageCount 检索。

返回: 无。

◆ SetTitle()

void foxit::pdf::ReadingBookmark::SetTitle ( const WString & title )

设置标题。

参数

[in] title 新的标题字符串。

返回: 无。

Public 成员函数

详细描述

构造及析构函数说明

◆ ReadingBookmark()

成员函数说明

◆ GetDateTime()

◆ GetPageIndex()

◆ GetTitle()

◆ IsEmpty()

◆ operator !=()

◆ operator=()

◆ operator==()

◆ SetDateTime()

◆ SetPageIndex()

◆ SetTitle()