|
Foxit PDF SDK
|
Public Member Functions | |
| Preflight () | |
| Constructor. | |
| Preflight (const Preflight &other) | |
| Constructor, with another preflight object. More... | |
| ~Preflight () | |
| Destructor. | |
| void | Analyze (const PreflightSettingData &preflight_setting_data, ProgressCallback *progress_callback=0) |
| Analyze a PDF file. More... | |
| void | AnalyzeAndFixup (const PreflightSettingData &preflight_setting_data, ProgressCallback *progress_callback=0) |
| Analyze and fixup a PDF file. More... | |
| bool | CanFixup (const String &item_key) |
| Check whether the item key can be fixuped or not. More... | |
| bool | GenerateReport (const PreflightReportSettingData &preflight_report_setting_data, ProgressCallback *progress_callback=0) |
| Generate report after analyzing or fixing. More... | |
| StringArray | GetGroupNamesArray (const PreflightSettingData::LibraryType &library_type, const PreflightSettingData::OperateType &operate_type) |
| Get all group names array corresponding to the library type and operation type. More... | |
| StringArray | GetItemKeysArray (const String &group_name) |
| Get item keys array with the specific group name. More... | |
| bool | IsEmpty () const |
| Check whether current object is empty or not. More... | |
| bool | operator != (const Preflight &other) const |
| Not equal operator. More... | |
| Preflight & | operator= (const Preflight &other) |
| Assign operator. More... | |
| bool | operator== (const Preflight &other) const |
| Equal operator. More... | |
Public Member Functions inherited from foxit::Base | |
| FS_HANDLE | Handle () const |
| Get the handle of current object. More... | |
This class represents the analysis and fix-up functions that match a specified industry profile and performs checks or fix-ups.
| foxit::addon::compliance::Preflight::Preflight | ( | const Preflight & | other | ) |
Constructor, with another preflight object.
| [in] | other | Another preflight object. |
| void foxit::addon::compliance::Preflight::Analyze | ( | const PreflightSettingData & | preflight_setting_data, |
| ProgressCallback * | progress_callback = 0 |
||
| ) |
Analyze a PDF file.
| [in] | preflight_setting_data | The preflight setting data. |
| [in] | progress_callback | A ProgressCallback object which is implemented by user and can be used to get progress data. |
| void foxit::addon::compliance::Preflight::AnalyzeAndFixup | ( | const PreflightSettingData & | preflight_setting_data, |
| ProgressCallback * | progress_callback = 0 |
||
| ) |
Analyze and fixup a PDF file.
| [in] | preflight_setting_data | The preflight setting data. |
| [in] | progress_callback | A ProgressCallback object which is implemented by user and can be used to get progress data. |
| bool foxit::addon::compliance::Preflight::CanFixup | ( | const String & | item_key | ) |
Check whether the item key can be fixuped or not.
| [in] | item_key | The item key. It can be retrieved by Preflight::GetItemKeysArray. |
| bool foxit::addon::compliance::Preflight::GenerateReport | ( | const PreflightReportSettingData & | preflight_report_setting_data, |
| ProgressCallback * | progress_callback = 0 |
||
| ) |
Generate report after analyzing or fixing.
| [in] | preflight_report_setting_data | The preflight report setting data. |
| [in] | progress_callback | A ProgressCallback object which is implemented by user and can be used to get progress data. |
| StringArray foxit::addon::compliance::Preflight::GetGroupNamesArray | ( | const PreflightSettingData::LibraryType & | library_type, |
| const PreflightSettingData::OperateType & | operate_type | ||
| ) |
Get all group names array corresponding to the library type and operation type.
| [in] | library_type | The library type. Please refer to values starting from PreflightSettingData::e_LibraryTypeFoxit and this should be one of these values. |
| [in] | operate_type | The operate type. Please refer to values starting from PreflightSettingData::e_OperateTypeProfiles and this should be one of these values. |
| StringArray foxit::addon::compliance::Preflight::GetItemKeysArray | ( | const String & | group_name | ) |
Get item keys array with the specific group name.
| [in] | group_name | The group name which can obtain from the function Preflight::GetGroupNamesArray. |
| bool foxit::addon::compliance::Preflight::IsEmpty | ( | ) | const |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
| bool foxit::addon::compliance::Preflight::operator != | ( | const Preflight & | other | ) | const |
Not equal operator.
| [in] | other | Another preflight object. This function will check if current object is not equal to this one. |
Assign operator.
| [in] | other | Another preflight object, whose value would be assigned to current object. |
| bool foxit::addon::compliance::Preflight::operator== | ( | const Preflight & | other | ) | const |
Equal operator.
| [in] | other | Another preflight object. This function will check if current object is equal to this one. |