类 foxit::ofd::OFDPackage 继承关系图:

Public 成员函数
	OFDPackage ()
	构造函数。更多...

	OFDPackage (const char *path)
	构造函数，从现有OFD包文件路径。更多...

	OFDPackage (const wchar_t *path)
	构造函数，从现有OFD包文件路径。更多...

	OFDPackage (const void *buffer, size_t size, bool take_over)
	构造函数，从内存缓冲区。更多...

	OFDPackage (common::file::ReaderCallback *file_reader)
	构造函数，使用文件读取回调对象。更多...

	OFDPackage (const OFDPackage &other)
	构造函数，通过另一个OFD文件包对象。更多...

	~OFDPackage ()
	析构函数。

OFDDoc	AddBlankDocument ()
	添加空OFD文档。更多...

void	EnableDocumentGrayScale (bool gray_scale)
	启用或禁用保存时文档灰度化。更多...

void	EnableEmbedFont (bool embed_font)
	启用或禁用保存时字体内嵌。更多...

void	EnableOptimizeResource (bool is_optimize_resource)
	启用或禁用保存时资源优化。更多...

int	GetDocumentCount ()
	获取文件包中的OFD文档数量。更多...

OFDDoc::EncryptMethod	GetEncryptMethod (int document_index)
	获取OFD文档加密方法。更多...

OFDDoc::EncryptType	GetEncryptType (int document_index)
	获取OFD文档加密类型。更多...

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

bool	IsEncrypted (int document_index)
	检查OFD文档是否被加密。更多...

OFDDoc	LoadDocument (int document_index, const foxit::String &password)
	加载OFD文档。更多...

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

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

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

bool	Save ()
	保存OFD文件包。更多...

bool	SaveAs (const String &file_path)
	将当前OFD文件另存为另一个OFD文件。更多...

bool	SaveAs (const WString &file_path)
	将当前OFD文件另存为另一个OFD文件。更多...

bool	SaveAs (common::file::WriterCallback *file_writer)
	将当前OFD文件另存为另一个OFD文件。更多...

void	SetFloatBit (int float_bit)
	设置保存时文件中浮点类型数字的保留小数位数。更多...

void	SetSplittable (bool is_splittable)
	设置被插入的文件是否可以拆分回源文档。更多...

foxit::WStringArray	SplitAsSourceFile (const String &dest_folder)
	将当前已合并的OFD文件拆分回原未拆分前的文档。更多...

foxit::WStringArray	SplitAsSourceFile (const WString &dest_folder)
	将当前已合并的OFD文件拆分回原未拆分前的文档。更多...

bool	Verify ()
	检查OFD文件是否符合规范。更多...

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

详细描述

此类表示和OFD包相关的方法。在使用“OFD”模块之前，请确保已通过 common::Library::Initialize 函数成功初始化 Foxit PDF SDK，且初始化时使用的密钥包含“OFD”模块。

@详见 common::Library

构造及析构函数说明

◆ OFDPackage() [1/6]

foxit::ofd::OFDPackage::OFDPackage ( )

构造函数。

此构造函数用于构造新的OFD包（没有任何数据）。

◆ OFDPackage() [2/6]

foxit::ofd::OFDPackage::OFDPackage ( const char * path )

explicit

构造函数，从现有OFD包文件路径。

参数

[in] path 现有OFD包文件的完整路径。它不应该是空字符串。

◆ OFDPackage() [3/6]

foxit::ofd::OFDPackage::OFDPackage ( const wchar_t * path )

explicit

构造函数，从现有OFD包文件路径。

参数

[in] path 现有OFD包文件的完整路径。它不应该是空字符串。

◆ OFDPackage() [4/6]

foxit::ofd::OFDPackage::OFDPackage	(	const void *	buffer,
		size_t	size,
		bool	take_over
	)

explicit

构造函数，从内存缓冲区。

参数

[in]	buffer	包含序列化文档的内存缓冲区。OFD文件包数据应完全加载在此内存缓冲区中。它不应该是 NULL。
[in]	size	内存缓冲区的大小。它应该大于0。
[in]	take_over	一个标记用来指示是否交出内存缓冲区的所有权。true表示所有权交给sdk，内存由sdk来释放，false表示所有权保留在应用层。

◆ OFDPackage() [5/6]

foxit::ofd::OFDPackage::OFDPackage ( common::file::ReaderCallback * file_reader )

explicit

构造函数，使用文件读取回调对象。

参数

[in] file_read 由用户实现的 common::file::ReaderCallback 对象，用于加载OFD文件包。它不应该是 NULL。

◆ OFDPackage() [6/6]

foxit::ofd::OFDPackage::OFDPackage ( const OFDPackage & other )

构造函数，通过另一个OFD文件包对象。

参数

[in] other 另一个OFD文件包对象。

成员函数说明

◆ AddBlankDocument()

OFDDoc foxit::ofd::OFDPackage::AddBlankDocument ( )

添加空OFD文档。

返回: 新创建的OFD文档对象。

◆ EnableDocumentGrayScale()

void foxit::ofd::OFDPackage::EnableDocumentGrayScale ( bool gray_scale )

启用或禁用保存时文档灰度化。

参数

[in] gray_scale true 表示启用文档灰度化，false 禁用文档灰度化。默认值：false。

返回: 无。

◆ EnableEmbedFont()

void foxit::ofd::OFDPackage::EnableEmbedFont ( bool embed_font )

启用或禁用保存时字体内嵌。

参数

[in] embed_font true 表示启用字体内嵌，false 禁用字体内嵌。默认值：false。

返回: 无。

◆ EnableOptimizeResource()

void foxit::ofd::OFDPackage::EnableOptimizeResource ( bool is_optimize_resource )

启用或禁用保存时资源优化。

参数

[in] is_optimize_resource true 表示启用资源优化，false 禁用资源优化。默认值：false。此接口会将未使用的资源从文档中移除，不保证文件大小一定会减小。

返回: 无。

◆ GetDocumentCount()

int foxit::ofd::OFDPackage::GetDocumentCount ( )

获取文件包中的OFD文档数量。

返回: OFD文档数量。

◆ GetEncryptMethod()

OFDDoc::EncryptMethod foxit::ofd::OFDPackage::GetEncryptMethod ( int document_index )

获取OFD文档加密方法。

参数

[in] document_index 文档索引。有效范围：从0到(count-1)。 count 由函数 OFDPagckage::GetDocumentCount 返回。

返回: 文档加密方法。请参考从 OFDDoc::e_OFDEncryptMethodNone 开始的值，这将是这些值中的一个。

◆ GetEncryptType()

OFDDoc::EncryptType foxit::ofd::OFDPackage::GetEncryptType ( int document_index )

获取OFD文档加密类型。

参数

[in] document_index 文档索引。有效范围：从0到(count-1)。 count 由函数 OFDPagckage::GetDocumentCount 返回。

返回: 文档加密类型。请参考从 OFDDoc::e_OFDEncryptTypeNone 开始的值，这将是这些值中的一个。

◆ IsEmpty()

bool foxit::ofd::OFDPackage::IsEmpty ( ) const

检查当前对象是否为空。

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

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

◆ IsEncrypted()

bool foxit::ofd::OFDPackage::IsEncrypted ( int document_index )

检查OFD文档是否被加密。

参数

[in] document_index 文档索引。有效范围：从0到(count-1)。 count 由函数 OFDPagckage::GetDocumentCount 返回。

返回: true 表示文档被加密，false 表示文档没有被加密。

◆ LoadDocument()

OFDDoc foxit::ofd::OFDPackage::LoadDocument	(	int	document_index,
		const foxit::String &	password
	)

加载OFD文档。

参数

[in]	document_index	文档索引。有效范围：从0到(count-1)。 count 由函数 OFDPagckage::GetDocumentCount 返回。
[in]	password	用于加载当前文档内容的密码字符串。密码可以是用户密码或所有者密码。如果当前文档未使用密码加密，只需传递空字符串。默认值：空字符串。

返回: OFD文档对象。

◆ operator !=()

bool foxit::ofd::OFDPackage::operator != ( const OFDPackage & other ) const

不等操作符。

参数

[in] other 另一个OFD文件包对象。此函数将检查当前对象是否不等于这个对象。

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

◆ operator=()

OFDPackage& foxit::ofd::OFDPackage::operator= ( const OFDPackage & other )

赋值操作符。

参数

[in] other 另一个OFD文件包对象，其值将被赋给当前对象。

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

◆ operator==()

bool foxit::ofd::OFDPackage::operator== ( const OFDPackage & other ) const

相等操作符。

参数

[in] other 另一个OFD文件包对象。此函数将检查当前对象是否等于这个对象。

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

◆ Save()

bool foxit::ofd::OFDPackage::Save ( )

保存OFD文件包。

返回: true 表示文档保存成功，false 表示文档保存失败。

◆ SaveAs() [1/3]

bool foxit::ofd::OFDPackage::SaveAs ( const String & file_path )

将当前OFD文件另存为另一个OFD文件。

参数

[in] file_path 新保存的OFD文件的完整路径。它不应该是空字符串。

返回: true 表示文档保存成功，false 表示文档保存失败。

◆ SaveAs() [2/3]

bool foxit::ofd::OFDPackage::SaveAs ( const WString & file_path )

将当前OFD文件另存为另一个OFD文件。

参数

[in] file_path 新保存的OFD文件的完整路径。它不应该是空字符串。

返回: true 表示文档保存成功，false 表示文档保存失败。

◆ SaveAs() [3/3]

bool foxit::ofd::OFDPackage::SaveAs ( common::file::WriterCallback * file_writer )

将当前OFD文件另存为另一个OFD文件。

参数

[in] file_writer 用户实现的 common::file::WriterCallback 对象，用于保存OFD文档。

返回: true 表示文档保存成功，false 表示文档保存失败。

◆ SetFloatBit()

void foxit::ofd::OFDPackage::SetFloatBit ( int float_bit )

设置保存时文件中浮点类型数字的保留小数位数。

参数

[in] float_bit 保留小数位数，如果设置0，则默认按照源文档输出。如果小于0，则按照0处理。

返回: 无。

◆ SetSplittable()

void foxit::ofd::OFDPackage::SetSplittable ( bool is_splittable )

设置被插入的文件是否可以拆分回源文档。

参数

[in] is_file_splittable true 表示可以拆分回源文档，false 表示不能拆分回源文档。

返回: 无。

◆ SplitAsSourceFile() [1/2]

foxit::WStringArray foxit::ofd::OFDPackage::SplitAsSourceFile ( const String & dest_folder )

将当前已合并的OFD文件拆分回原未拆分前的文档。

参数

[in] dest_folder 拆分后文档保存的目标文件夹路径。

返回: 拆分文件后的路径数组。

◆ SplitAsSourceFile() [2/2]

foxit::WStringArray foxit::ofd::OFDPackage::SplitAsSourceFile ( const WString & dest_folder )

将当前已合并的OFD文件拆分回原未拆分前的文档。

参数

[in] dest_folder 拆分后文档保存的目标文件夹路径。

返回: 拆分文件后的路径数组。

◆ Verify()

bool foxit::ofd::OFDPackage::Verify ( )

检查OFD文件是否符合规范。

返回: true 表示文件符合规范，false 表示文件不符合规范。

Public 成员函数

详细描述

构造及析构函数说明

◆ OFDPackage() [1/6]

◆ OFDPackage() [2/6]

◆ OFDPackage() [3/6]

◆ OFDPackage() [4/6]

◆ OFDPackage() [5/6]

◆ OFDPackage() [6/6]

成员函数说明

◆ AddBlankDocument()

◆ EnableDocumentGrayScale()

◆ EnableEmbedFont()

◆ EnableOptimizeResource()

◆ GetDocumentCount()

◆ GetEncryptMethod()

◆ GetEncryptType()

◆ IsEmpty()

◆ IsEncrypted()

◆ LoadDocument()

◆ operator !=()

◆ operator=()

◆ operator==()

◆ Save()

◆ SaveAs() [1/3]

◆ SaveAs() [2/3]

◆ SaveAs() [3/3]

◆ SetFloatBit()

◆ SetSplittable()

◆ SplitAsSourceFile() [1/2]

◆ SplitAsSourceFile() [2/2]

◆ Verify()