foxit::addon::comparison::Comparison类 参考

类 foxit::addon::comparison::Comparison 继承关系图:

Public 类型
enum	CompareType { e_CompareTypeAll = 0x00000000, e_CompareTypeText = 0x00000001, e_CompareTypeAnnotation = 0x00000002 }
	比较类型标志的枚举。 更多...

Public 成员函数
	Comparison (const pdf::PDFDoc &base_doc, const pdf::PDFDoc &compared_doc)
	从PDF文档对象构造。 更多...
	Comparison (const Comparison &other)
	带另一个比较对象的构造函数。 更多...
	~Comparison ()
	析构函数。
CompareResults	DoCompare (int base_page_index, int compared_page_index, foxit::uint32 compare_flags)
	比较基本文档的PDF页面与比较文档中的PDF页面。"基本文档"和"比较文档"指用于构造当前对象的PDF文档对象。 更多...
pdf::PDFDoc	GenerateComparedDoc (foxit::uint32 compare_flags)
	比较基本文档与比较文档（用于构造当前对象），然后生成PDF文档作为比较结果。 更多...
pdf::PDFDoc	GenerateComparedDoc (foxit::uint32 compare_flags, bool is_show_all_layers)
	比较基本文档与比较文档（用于构造当前对象），然后生成PDF文档作为比较结果。 更多...
bool	IsEmpty () const
	检查当前对象是否为空。 更多...
bool	operator != (const Comparison &other) const
	不相等操作符。 更多...
Comparison &	operator= (const Comparison &other)
	赋值操作符。 更多...
bool	operator== (const Comparison &other) const
	相等操作符。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE	Handle () const
	获取当前对象的句柄。 更多...

详细描述

此类可用于逐页比较一个PDF文件（作为"基本文档"）与另一个PDF文件（作为"比较文档"）。

成员枚举类型说明

CompareType

enum foxit::addon::comparison::Comparison::CompareType

比较类型标志的枚举。

此枚举的值可以单独使用，某些值可以组合使用。

枚举值
e_CompareTypeAll	比较所有内容。此值应单独使用。
e_CompareTypeText	仅比较文本。
e_CompareTypeAnnotation	仅比较注释。

构造及析构函数说明

Comparison() [1/2]

foxit::addon::comparison::Comparison::Comparison ( const pdf::PDFDoc &  base_doc, const pdf::PDFDoc &  compared_doc  )

explicit

从PDF文档对象构造。

参数

[in]	base_doc	作为基本文档的有效PDF文档对象。
[in]	compared_doc	作为比较文档的有效PDF文档对象。

注解

如果在函数common::Library::Initialize中使用的许可证信息中未定义 "Comparison"模块，意味着用户无权使用比较相关功能， 此构造函数将抛出异常foxit::e_ErrNoComparisonModuleRight。

Comparison() [2/2]

foxit::addon::comparison::Comparison::Comparison

(

const Comparison &

other

)

带另一个比较对象的构造函数。

参数

[in]

other

另一个比较对象。

成员函数说明

DoCompare()

CompareResults foxit::addon::comparison::Comparison::DoCompare	(	int	base_page_index,
		int	compared_page_index,
		foxit::uint32	compare_flags
	)

比较基本文档的PDF页面与比较文档中的PDF页面。"基本文档"和"比较文档"指用于构造当前对象的PDF文档对象。

参数

[in]	base_page_index	基本文档中的页面索引。有效范围：从0到(base_page_count-1)。 base_page_count由基本文档的函数pdf::PDFDoc::GetPageCount返回。
[in]	compared_page_index	比较文档中的页面索引。有效范围：从0到(compared_page_count-1)。 compared_page_count由比较文档的函数pdf::PDFDoc::GetPageCount返回。
[in]	compare_flags	比较类型，指定在PDF页面中要比较的内容。请参考从 Comparison::e_CompareTypeAll开始的值，这可以是这些值中的一个或某些值的组合。

返回

comparison::CompareResults对象。

GenerateComparedDoc() [1/2]

pdf::PDFDoc foxit::addon::comparison::Comparison::GenerateComparedDoc

(

foxit::uint32

compare_flags

)

比较基本文档与比较文档（用于构造当前对象），然后生成PDF文档作为比较结果。

比较两个PDF文档的内容并生成新PDF文档可能需要很长时间。

参数

[in]

compare_flags

比较类型，指定在PDF页面中要比较的内容。请参考从 Comparison::e_CompareTypeAll开始的值，这可以是这些值中的一个或组合。

返回

pdf::PDFDoc对象，表示输出的比较PDF文档。

GenerateComparedDoc() [2/2]

pdf::PDFDoc foxit::addon::comparison::Comparison::GenerateComparedDoc	(	foxit::uint32	compare_flags,
		bool	is_show_all_layers
	)

比较基本文档与比较文档（用于构造当前对象），然后生成PDF文档作为比较结果。

比较两个PDF文档的内容并生成新PDF文档可能需要很长时间。

参数

[in]	compare_flags	比较类型，指定在PDF页面中要比较的内容。请参考从 Comparison::e_CompareTypeAll开始的值，这可以是这些值中的一个或组合。
[in]	is_show_all_layers	布尔值，用于决定是否显示所有比较结果图层。 true表示默认显示所有比较结果图层，false表示默认仅显示 "文本"和"图像"比较结果图层。

返回

pdf::PDFDoc对象，表示输出的比较PDF文档。

IsEmpty()

bool foxit::addon::comparison::Comparison::IsEmpty

(

)

const

检查当前对象是否为空。

当当前对象为空时，意味着当前对象无用。

返回

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

operator !=()

bool foxit::addon::comparison::Comparison::operator !=

(

const Comparison &

other

)

const

不相等操作符。

参数

[in]

other

另一个比较对象。此函数将检查当前对象是否不等于此对象。

返回

true表示不相等，false表示相等。

operator=()

Comparison& foxit::addon::comparison::Comparison::operator=

(

const Comparison &

other

)

赋值操作符。

参数

[in]

other

另一个比较对象，其值将被赋给当前对象。

返回

当前对象自身的引用。

operator==()

bool foxit::addon::comparison::Comparison::operator==

(

const Comparison &

other

)

const

相等操作符。

参数

[in]

other

另一个比较对象。此函数将检查当前对象是否等于此对象。

返回

true表示相等，false表示不相等。