类 foxit::addon::compliance::Preflight 继承关系图:

Public 成员函数
	Preflight ()
	构造函数。

	Preflight (const Preflight &other)
	带另一个预检对象的构造函数。更多...

	~Preflight ()
	析构函数。

ResultInformation	Analyze (const PreflightSettingData &preflight_setting_data, ProgressCallback *progress_callback=0)
	分析PDF文件。更多...

ResultInformation	AnalyzeAndFixup (const PreflightSettingData &preflight_setting_data, ProgressCallback *progress_callback=0)
	分析并修复PDF文件。更多...

bool	CanFixup (const String &item_key)
	检查项目密钥是否可以修复。更多...

bool	GenerateReport (const PreflightReportSettingData &preflight_report_setting_data, ProgressCallback *progress_callback=0)
	在分析或修复后生成报告。更多...

bool	GenerateXMLReport (const wchar_t xml_report_file_path, ProgressCallback progress_callback=0)
	在分析或修复后生成XML报告。更多...

WString	GetGroupItemComment (const String &key)
	通过密钥获取组项的注释。更多...

WString	GetGroupItemName (const String &key)
	通过密钥获取组项的名称。更多...

StringArray	GetGroupNamesArray (const PreflightSettingData::LibraryType &library_type, const PreflightSettingData::OperateType &operate_type)
	获取与库类型和操作类型对应的所有组名数组。更多...

StringArray	GetItemKeysArray (const String &group_name)
	使用特定组名获取项目密钥数组。更多...

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

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

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

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

void	SetPreflightGroupLocalCallback (PreflightGroupLocalCallback *callback)
	为预检组项设置本地化名称和注释回调。更多...

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

详细描述

此类表示与指定行业配置文件匹配的分析和修复功能，并执行检查或修复。

构造及析构函数说明

◆ Preflight()

foxit::addon::compliance::Preflight::Preflight ( const Preflight & other )

带另一个预检对象的构造函数。

参数

[in] other 另一个预检对象。

成员函数说明

◆ Analyze()

ResultInformation foxit::addon::compliance::Preflight::Analyze	(	const PreflightSettingData &	preflight_setting_data,
		ProgressCallback *	progress_callback = `0`
	)

分析PDF文件。

参数

[in]	preflight_setting_data	预检设置数据。
[in]	progress_callback	由用户实现的 ProgressCallback 对象，可用于获取进度数据。

返回: 一个 ResultInformation 对象。

◆ AnalyzeAndFixup()

ResultInformation foxit::addon::compliance::Preflight::AnalyzeAndFixup	(	const PreflightSettingData &	preflight_setting_data,
		ProgressCallback *	progress_callback = `0`
	)

分析并修复PDF文件。

参数

[in]	preflight_setting_data	预检设置数据。
[in]	progress_callback	由用户实现的 ProgressCallback 对象，可用于获取进度数据。

返回: 一个 ResultInformation 对象。

◆ CanFixup()

bool foxit::addon::compliance::Preflight::CanFixup ( const String & item_key )

检查项目密钥是否可以修复。

参数

[in] item_key 项目密钥。可以通过 Preflight::GetItemKeysArray 检索。

返回: true表示可以修复，false表示不能修复。

◆ GenerateReport()

bool foxit::addon::compliance::Preflight::GenerateReport	(	const PreflightReportSettingData &	preflight_report_setting_data,
		ProgressCallback *	progress_callback = `0`
	)

在分析或修复后生成报告。

此方法应在 Preflight::Analyze 或 Preflight::AnalyzeAndFixup 之后调用。

参数

[in]	preflight_report_setting_data	预检报告设置数据。
[in]	progress_callback	由用户实现的 ProgressCallback 对象，可用于获取进度数据。

返回: true表示成功，false表示失败。

◆ GenerateXMLReport()

bool foxit::addon::compliance::Preflight::GenerateXMLReport	(	const wchar_t *	xml_report_file_path,
		ProgressCallback *	progress_callback = `0`
	)

在分析或修复后生成XML报告。

此方法应在 Preflight::Analyze 或 Preflight::AnalyzeAndFixup 之后调用。

参数

[in]	xml_report_file_path	用于保存XML报告文件的完整路径。这不应该是空字符串。
[in]	progress_callback	由用户实现的 ProgressCallback 对象，可用于获取进度数据。可以为NULL。默认值：NULL。

返回: true表示成功，false表示失败。

◆ GetGroupItemComment()

WString foxit::addon::compliance::Preflight::GetGroupItemComment ( const String & key )

通过密钥获取组项的注释。

仅提供英文，其他语言需要参考翻译的XML自行获取。

参数

[in] key 组项的密钥。

返回: 通过 Preflight::GetGroupNamesArray 和 Preflight::GetItemKeysArray 接口获取的组项的注释。

◆ GetGroupItemName()

WString foxit::addon::compliance::Preflight::GetGroupItemName ( const String & key )

通过密钥获取组项的名称。

仅提供英文，其他语言需要参考翻译的XML自行获取。

参数

[in] key 组项的密钥。

返回: 通过 Preflight::GetGroupNamesArray 和 Preflight::GetItemKeysArray 接口获取的组项的名称。

◆ GetGroupNamesArray()

StringArray foxit::addon::compliance::Preflight::GetGroupNamesArray	(	const PreflightSettingData::LibraryType &	library_type,
		const PreflightSettingData::OperateType &	operate_type
	)

获取与库类型和操作类型对应的所有组名数组。

参数

[in]	library_type	库类型。请参考从 PreflightSettingData::e_LibraryTypeFoxit 开始的值，这应该是这些值之一。
[in]	operate_type	操作类型。请参考从 PreflightSettingData::e_OperateTypeProfiles 开始的值，这应该是这些值之一。

返回: 组名数组。

◆ GetItemKeysArray()

StringArray foxit::addon::compliance::Preflight::GetItemKeysArray ( const String & group_name )

使用特定组名获取项目密钥数组。

参数

[in] group_name 可以从函数 Preflight::GetGroupNamesArray 获取的组名。

返回: 项目密钥数组。

◆ IsEmpty()

bool foxit::addon::compliance::Preflight::IsEmpty ( ) const

检查当前对象是否为空。

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

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

◆ operator !=()

bool foxit::addon::compliance::Preflight::operator != ( const Preflight & other ) const

不相等操作符。

参数

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

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

◆ operator=()

Preflight& foxit::addon::compliance::Preflight::operator= ( const Preflight & other )

赋值操作符。

参数

[in] other 另一个预检对象，其值将分配给当前对象。

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

◆ operator==()

bool foxit::addon::compliance::Preflight::operator== ( const Preflight & other ) const

相等操作符。

参数

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

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

◆ SetPreflightGroupLocalCallback()

void foxit::addon::compliance::Preflight::SetPreflightGroupLocalCallback ( PreflightGroupLocalCallback * callback )

为预检组项设置本地化名称和注释回调。

此回调由 Preflight::GetGroupItemName 和 Preflight::GetGroupItemComment 使用，以提供组项的本地化名称和注释。当回调中有给定密钥的本地化字符串时，将使用它；否则将使用默认的库字符串。

参数

[in] callback 提供 PreflightGroupLocalCallback 本地化名称和注释的回调对象。

返回: 无。

Public 成员函数

详细描述

构造及析构函数说明

◆ Preflight()

成员函数说明

◆ Analyze()

◆ AnalyzeAndFixup()

◆ CanFixup()

◆ GenerateReport()

◆ GenerateXMLReport()

◆ GetGroupItemComment()

◆ GetGroupItemName()

◆ GetGroupNamesArray()

◆ GetItemKeysArray()

◆ IsEmpty()

◆ operator !=()

◆ operator=()

◆ operator==()

◆ SetPreflightGroupLocalCallback()