Foxit PDF SDK
foxit::pdf::TableOfContentsConfig类 参考

继承自 Object .

Public 成员函数

 TableOfContentsConfig (const wchar_t *title, Int32Array bookmark_level_array, bool is_show_serial_number, bool include_toc_pages)
 带参数的构造函数。 更多...
 
 TableOfContentsConfig ()
 构造函数。
 
bool operator != (const TableOfContentsConfig &other) const
 不等操作符。 更多...
 
TableOfContentsConfigoperator= (const TableOfContentsConfig &other)
 赋值操作符。 更多...
 
bool operator== (const TableOfContentsConfig &other) const
 相等操作符。 更多...
 
void Set (const wchar_t *title, Int32Array bookmark_level_array, bool is_show_serial_number, bool include_toc_pages)
 设置值。 更多...
 

Public 属性

Int32Array bookmark_level_array
 书签级别数组,用于指定用于生成"目录"的书签。 对于输入数组中的每个元素,有效范围:从1到(depth)。 depth 由函数 PDFDoc::GetBookmarkLevelDepth 返回。 如果输入数组是空数组,则意味着所有书签都用于生成"目录"。
 
bool include_toc_pages
 true 表示在目录的页码计算中包含目录页面, false 表示在目录的页码计算中排除目录页面。
 
bool is_show_serial_number
 true 表示在目录中显示序列号,false 表示不显示序列号。
 
WString title
 目录的标题。如果这是空字符串,将使用默认值"Table of Contents"。
 

详细描述

此类表示目录配置。

构造及析构函数说明

◆ TableOfContentsConfig()

foxit::pdf::TableOfContentsConfig::TableOfContentsConfig ( const wchar_t *  title,
Int32Array  bookmark_level_array,
bool  is_show_serial_number,
bool  include_toc_pages 
)
inline

带参数的构造函数。

参数
[in]title目录的标题。
[in]bookmark_level_array书签级别数组,用于指定用于生成"目录"的书签。
[in]is_show_serial_numbertrue 表示在目录中显示序列号,false 表示不显示序列号。
[in]include_toc_pagestrue 表示在目录的页码计算中包含目录页面, false 表示在目录的页码计算中排除目录页面。

成员函数说明

◆ operator !=()

bool foxit::pdf::TableOfContentsConfig::operator != ( const TableOfContentsConfig other) const
inline

不等操作符。

参数
[in]other另一个目录配置对象。此函数将检查当前对象是否与此对象不相等。
返回
true 表示不相等,false 表示相等。

◆ operator=()

TableOfContentsConfig& foxit::pdf::TableOfContentsConfig::operator= ( const TableOfContentsConfig other)
inline

赋值操作符。

参数
[in]other另一个目录配置对象,其值将赋给当前对象。
返回
当前对象自身的引用。

◆ operator==()

bool foxit::pdf::TableOfContentsConfig::operator== ( const TableOfContentsConfig other) const
inline

相等操作符。

参数
[in]other另一个目录配置对象。此函数将检查当前对象是否与此对象相等。
返回
true 表示相等,false 表示不相等。

◆ Set()

void foxit::pdf::TableOfContentsConfig::Set ( const wchar_t *  title,
Int32Array  bookmark_level_array,
bool  is_show_serial_number,
bool  include_toc_pages 
)
inline

设置值。

参数
[in]title目录的标题。
[in]bookmark_level_array书签级别数组,用于指定用于生成"目录"的书签。
[in]is_show_serial_numbertrue 表示在目录中显示序列号,false 表示不显示序列号。
[in]include_toc_pagestrue 表示在目录的页码计算中包含目录页面, false 表示在目录的页码计算中排除目录页面。

@ return 无。