Foxit PDF SDK

fs_compliancecommon.h
Go to the documentation of this file.
1
15 #ifndef FS_COMPLIANCEENGINE_H_
16 #define FS_COMPLIANCEENGINE_H_
17
18 #include "common/fs_common.h"
19
25 namespace foxit {
29 namespace addon {
33 namespace compliance {
34 class ResultInformation;
35 class ProgressCallback;
36 class PreflightSettingData;
37 class PreflightReportSettingData;
38 class Preflight;
39
49 class ComplianceEngine FS_FINAL : public Object{
50 public:
56 typedef enum _ViewOrPrintCondition {
58 e_ViewOrPrintConditionAuto = 0,
60 e_ViewOrPrintConditionCoatedGRACoL2006 = 1,
62 e_ViewOrPrintConditionISOCoatedv2ECI = 2,
64 e_ViewOrPrintConditionJapanColor2001Coated = 3,
66 e_ViewOrPrintConditionPSOCoatedv3ECI = 4
67 } ViewOrPrintCondition;
68
69
102 static ErrorCode Initialize(const wchar_t* compliance_resource_folder_path, const char* compliance_engine_unlockcode);
103
112 static void Release();
113
114 #if !defined(_MAC_JAVA_)
115
136 static ErrorCode InitializeThreadContext();
137
147 static void ReleaseThreadContext();
148 #endif
149
162 static void SetTempFolderPath(const wchar_t* temp_folder_path);
163
173 static void EnableHandleTransparency(bool enable_handle_transparency);
174
191 static void SetLanguage(const char* language);
192 };
193
198 class ProgressCallback {
199 public:
205 virtual void Release() = 0;
206
215 virtual void UpdateCurrentStateData(int current_rate, const WString& current_state_string) = 0;
216
217 protected:
218 ~ProgressCallback() {}
219 };
220
222 class PreflightSettingData FS_FINAL : public Object{
223 public:
229 typedef enum _LibraryType {
231 e_LibraryTypeFoxit = 0,
233 e_LibraryTypePDFStandards = 1,
235 e_LibraryTypePrepressColorTransparency = 2
236 } LibraryType;
237
243 typedef enum _OperateType {
245 e_OperateTypeProfiles = 0,
247 e_OperateTypeSingleChecks = 1,
249 e_OperateTypeSingleFixups = 2
250 } OperateType;
251
252
254 PreflightSettingData()
255 : preflight_key(L"")
256 , operate_type(e_OperateTypeProfiles)
257 , src_pdf_path(L"")
258 , saved_pdf_path(L"")
259 , first_page_index(0)
260 , last_page_index(-1) {}
261
277 PreflightSettingData(const wchar_t* preflight_key, OperateType operate_type, const wchar_t* src_pdf_path, const wchar_t* saved_pdf_path,
278 int first_page_index, int last_page_index) {
279 this->preflight_key = preflight_key;
280 this->operate_type = operate_type;
281 this->src_pdf_path = src_pdf_path;
282 this->saved_pdf_path = saved_pdf_path;
283 this->first_page_index = first_page_index;
284 this->last_page_index = last_page_index;
285 }
286
294 PreflightSettingData &operator = (const PreflightSettingData& data) {
295 preflight_key = data.preflight_key;
296 operate_type = data.operate_type;
297 src_pdf_path = data.src_pdf_path;
298 saved_pdf_path = data.saved_pdf_path;
299 first_page_index = data.first_page_index;
300 last_page_index = data.last_page_index;
301 return (*this);
302 }
303
305 WString preflight_key;
306
312 OperateType operate_type;
313
315 WString src_pdf_path;
316
318 WString saved_pdf_path;
319
321 int first_page_index;
322
328 int last_page_index;
329 };
330
332 class PreflightReportSettingData FS_FINAL : public Object{
333 public:
339 typedef enum _ReportFileFormatType {
341 e_ReportFileFormatTypePdf = 0,
343 e_ReportFileFormatTypeXml = 1,
345 e_ReportFileFormatTypeTxt = 2,
347 e_ReportFileFormatTypeHtml = 3
348 } ReportFileFormatType;
349
355 typedef enum _ProblemsHighlightMethod {
357 e_ProblemsHighlightMethodTransparentMasks = 0,
359 e_ProblemsHighlightMethodLayers = 1
360 } ProblemsHighlightMethod;
361
362
364 PreflightReportSettingData()
365 : report_file_format_type(e_ReportFileFormatTypePdf)
366 , to_generate_overview(true)
367 , to_highlight_problems(true)
368 , problems_highlight_method(e_ProblemsHighlightMethodTransparentMasks)
369 , report_file_path(L"") {}
370
386 PreflightReportSettingData(ReportFileFormatType report_file_format_type, bool to_generate_overview, bool to_highlight_problems,
387 ProblemsHighlightMethod problem_highlight_method, const wchar_t* report_file_path) {
388 this->report_file_format_type = report_file_format_type;
389 this->to_generate_overview = to_generate_overview;
390 this->to_highlight_problems = to_highlight_problems;
391 this->problems_highlight_method = problem_highlight_method;
392 this->report_file_path = report_file_path;
393 }
394
402 PreflightReportSettingData &operator = (const PreflightReportSettingData& data) {
403 report_file_format_type = data.report_file_format_type;
404 to_generate_overview = data.to_generate_overview;
405 to_highlight_problems = data.to_highlight_problems;
406 problems_highlight_method = data.problems_highlight_method;
407 report_file_path = data.report_file_path;
408 return (*this);
409 }
410
415 ReportFileFormatType report_file_format_type;
416
418 bool to_generate_overview;
419
421 bool to_highlight_problems;
422
428 ProblemsHighlightMethod problems_highlight_method;
429
431 WString report_file_path;
432 };
433
437 class Preflight FS_FINAL : public Base {
438 public:
440 Preflight();
441
442 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
443 explicit Preflight(FS_HANDLE handle);
444
446 ~Preflight();
447
453 Preflight(const Preflight& other);
454
462 Preflight& operator = (const Preflight& other);
463
471 bool operator == (const Preflight& other) const;
472
480 bool operator != (const Preflight& other) const;
481
489 bool IsEmpty() const;
490
501 StringArray GetGroupNamesArray(const PreflightSettingData::LibraryType& library_type, const PreflightSettingData::OperateType& operate_type);
502
510 StringArray GetItemKeysArray(const String& group_name);
511
520 void Analyze(const PreflightSettingData& preflight_setting_data, ProgressCallback* progress_callback = NULL);
521
530 void AnalyzeAndFixup(const PreflightSettingData& preflight_setting_data, ProgressCallback* progress_callback = NULL);
531
540 bool GenerateReport(const PreflightReportSettingData& preflight_report_setting_data, ProgressCallback* progress_callback = NULL);
541
549 bool CanFixup(const String& item_key);
550 };
551
555 class FixupData : public Object {
556 public:
562 typedef enum _FixupState {
564 e_FixupStateSuccess = 0,
566 e_FixupStateFailure = 1,
568 e_FixupStateNotRequired = 2
569 } FixupState;
570
571
573 FixupData()
574 : used_count(0)
575 , state(e_FixupStateNotRequired) {}
576
582 FixupData(const FixupData& other)
583 : used_count(other.used_count)
584 , state(other.state)
585 , name(other.name)
586 , comment(other.comment)
587 , reasons(other.reasons) {}
588
596 FixupData& operator = (const FixupData& other) {
597 used_count = other.used_count;
598 state = other.state;
599 name = other.name;
600 comment = other.comment;
601 reasons = other.reasons;
602 return *this;
603 }
604
612 bool operator == (const FixupData& other) const {
613 bool is_equal = (used_count == other.used_count && state == other.state &&
614 name == other.name && comment == other.comment);
615 if (is_equal) {
616 for (int i=0; i<(int)reasons.GetSize(); i++) {
617 if (reasons[i] != other.reasons[i]) {
618 is_equal = false;
619 break;
620 }
621 }
622 }
623 return is_equal;
624 }
625
633 bool operator != (const FixupData& other) const {
634 return !((*this) == other);
635 }
636
638 uint32 used_count;
643 FixupState state;
645 WString name;
647 WString comment;
649 WStringArray reasons;
650 };
651
655 class HitData : public Object {
656 public:
662 typedef enum _CheckSeverity {
664 e_CheckSeverityInfo = 1,
666 e_CheckSeverityWarning = 2,
668 e_CheckSeverityError = 3
669 } CheckSeverity;
670
671
673 HitData()
674 : triggered_count(0)
675 , severity(e_CheckSeverityInfo)
676 , page_index(-1){}
677
683 HitData(const HitData& other)
684 : triggered_count(other.triggered_count)
685 , severity(other.severity)
686 , name(other.name)
687 , comment(other.comment)
688 , trigger_values(other.trigger_values)
689 , page_index(other.page_index) {}
690
698 HitData& operator = (const HitData& other) {
699 triggered_count = other.triggered_count;
700 severity = other.severity;
701 name = other.name;
702 comment = other.comment;
703 trigger_values = other.trigger_values;
704 page_index = other.page_index;
705 return *this;
706 }
707
715 bool operator == (const HitData& other) const {
716 bool is_equal = (triggered_count == other.triggered_count && severity == other.severity &&
717 name == other.name && comment == other.comment && page_index == other.page_index);
718 if (is_equal) {
719 for (int i=0; i<(int)trigger_values.GetSize(); i++) {
720 if (trigger_values[i] != other.trigger_values[i]) {
721 is_equal = false;
722 break;
723 }
724 }
725 }
726 return is_equal;
727 }
728
736 bool operator != (const HitData& other) const {
737 return !((*this) == other);
738 }
739
741 uint32 triggered_count;
746 CheckSeverity severity;
748 WString name;
750 WString comment;
752 WStringArray trigger_values;
754 int page_index;
755 };
756
761 class ResultInformation FS_FINAL : public Base {
762 public:
764 ResultInformation();
765 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
766 explicit ResultInformation(FS_HANDLE handle);
768 ~ResultInformation();
774 ResultInformation(const ResultInformation& other);
775
783 ResultInformation& operator = (const ResultInformation& other);
791 bool operator == (const ResultInformation& other) const;
792
800 bool operator != (const ResultInformation& other) const;
801
809 bool IsEmpty() const;
810
816 int GetFixupDataCount() const;
825 FixupData GetFixupData(int index) const;
826
832 int GetHitDataCount() const;
833
842 HitData GetHitData(int index) const;
843 };
844 } // namespace compliance/**
845 } // namespace addon
846 } // namespace foxit
847
848 #endif // FS_COMPLIANCEENGINE_H_
foxit::addon::compliance::PreflightSettingData::e_LibraryTypeFoxit
Preflight library type: Foxit.
Definition: fs_compliancecommon.h:231
foxit::addon::compliance::PreflightSettingData::e_OperateTypeProfiles
Opearte type: profiles.
Definition: fs_compliancecommon.h:245
foxit::addon::compliance::PreflightSettingData::saved_pdf_path
WString saved_pdf_path
A complete path for saving the PDF file generated by the preflight analysis and fixup process.
Definition: fs_compliancecommon.h:318
foxit::addon::compliance::PreflightSettingData::OperateType
OperateType
Enumeration for the preflight operate type.
Definition: fs_compliancecommon.h:243
foxit::FS_HANDLE
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:213
foxit::addon::compliance::HitData::e_CheckSeverityInfo
Info severity.
Definition: fs_compliancecommon.h:664
foxit::addon::compliance::Preflight::IsEmpty
bool IsEmpty() const
Check whether current object is empty or not.
foxit::addon::compliance::PreflightSettingData::preflight_key
WString preflight_key
The preflight key. Retrieve available keys via Preflight::GetItemKeysArray.
Definition: fs_compliancecommon.h:305
foxit::addon::compliance::PreflightSettingData::PreflightSettingData
PreflightSettingData(const wchar_t *preflight_key, OperateType operate_type, const wchar_t *src_pdf_path, const wchar_t *saved_pdf_path, int first_page_index, int last_page_index)
Constructor, with parameters.
Definition: fs_compliancecommon.h:277
foxit::addon::compliance::HitData::severity
CheckSeverity severity
The check severity of current hit data. Please refer to values starting from HitData::e_CheckSeverity...
Definition: fs_compliancecommon.h:746
foxit::addon::compliance::ComplianceEngine::e_ViewOrPrintConditionJapanColor2001Coated
Viewing or printing condition:Japan Color 2001 Coated.
Definition: fs_compliancecommon.h:64
foxit::addon::compliance::PreflightReportSettingData
Definition: fs_compliancecommon.h:332
foxit::addon::compliance::FixupData::FixupData
FixupData(const FixupData &other)
Constructor, with another fixup data object.
Definition: fs_compliancecommon.h:582
foxit::StringArray
Definition: fs_basictypes.h:229
foxit::addon::compliance::ResultInformation::ResultInformation
ResultInformation()
Constructor.
foxit::Object
CFX_Object Object
Object type.
Definition: fs_basictypes.h:220
foxit::addon::compliance::PreflightSettingData::operator=
PreflightSettingData & operator=(const PreflightSettingData &data)
Assign operator.
Definition: fs_compliancecommon.h:294
foxit::addon::compliance::PreflightReportSettingData::e_ReportFileFormatTypePdf
Report file format type: PDF.
Definition: fs_compliancecommon.h:341
foxit::addon::compliance::HitData::HitData
HitData()
Constructor.
Definition: fs_compliancecommon.h:673
foxit::addon::compliance::Preflight::operator==
bool operator==(const Preflight &other) const
Equal operator.
foxit::addon::compliance::Preflight::Analyze
void Analyze(const PreflightSettingData &preflight_setting_data, ProgressCallback *progress_callback=0)
Analyze a PDF file.
foxit::addon::compliance::PreflightSettingData::e_LibraryTypePDFStandards
Preflight library type: Standards.
Definition: fs_compliancecommon.h:233
fs_common.h
Header file for common definitions and classes.
foxit::addon::compliance::HitData::operator==
bool operator==(const HitData &other) const
Equal operator.
Definition: fs_compliancecommon.h:715
foxit::addon::compliance::ResultInformation::GetFixupData
FixupData GetFixupData(int index) const
Get a fixup data.
foxit::addon::compliance::HitData::e_CheckSeverityWarning
Warning severity.
Definition: fs_compliancecommon.h:666
foxit::addon::compliance::PreflightReportSettingData::e_ReportFileFormatTypeHtml
Report file format type: HTML.
Definition: fs_compliancecommon.h:347
foxit::addon::compliance::PreflightSettingData::e_OperateTypeSingleFixups
Opearte type: single fixups.
Definition: fs_compliancecommon.h:249
foxit::ErrorCode
ErrorCode
Enumeration for error code.
Definition: fs_basictypes.h:236
foxit::addon::compliance::HitData::operator!=
bool operator!=(const HitData &other) const
Not equal operator.
Definition: fs_compliancecommon.h:736
foxit::addon::compliance::PreflightReportSettingData::e_ProblemsHighlightMethodLayers
Problems highlighted by layers.
Definition: fs_compliancecommon.h:359
foxit::addon::compliance::PreflightReportSettingData::e_ReportFileFormatTypeTxt
Report file format type: TXT & TEXT.
Definition: fs_compliancecommon.h:345
foxit::addon::compliance::PreflightSettingData::last_page_index
int last_page_index
Index of the last page to be analyzed or fixed. If this is -1, that means all the pages of the source...
Definition: fs_compliancecommon.h:328
foxit::addon::compliance::FixupData::operator==
bool operator==(const FixupData &other) const
Equal operator.
Definition: fs_compliancecommon.h:612
foxit::addon::compliance::HitData::triggered_count
uint32 triggered_count
Represents the count of hit operation for current data has been triggered during document verificatio...
Definition: fs_compliancecommon.h:741
foxit::addon::compliance::ComplianceEngine::SetLanguage
static void SetLanguage(const char *language)
Set language for compliance engine.
foxit::addon::compliance::PreflightReportSettingData::report_file_path
WString report_file_path
A complete path for the report file. This should not be an empty string.
Definition: fs_compliancecommon.h:431
foxit::addon::compliance::HitData::page_index
int page_index
Page index, starting from 0. -1 means current hit data was hit in document level.
Definition: fs_compliancecommon.h:754
foxit::addon::compliance::FixupData::name
WString name
Fixup rule name.
Definition: fs_compliancecommon.h:645
foxit::addon::compliance::FixupData::operator=
FixupData & operator=(const FixupData &other)
Assign operator.
Definition: fs_compliancecommon.h:596
foxit::addon::compliance::HitData
Definition: fs_compliancecommon.h:655
foxit::addon::compliance::Preflight::AnalyzeAndFixup
void AnalyzeAndFixup(const PreflightSettingData &preflight_setting_data, ProgressCallback *progress_callback=0)
Analyze and fixup a PDF file.
foxit::addon::compliance::HitData::e_CheckSeverityError
Error severity.
Definition: fs_compliancecommon.h:668
foxit::addon::compliance::Preflight::GetItemKeysArray
StringArray GetItemKeysArray(const String &group_name)
Get item keys array with the specific group name.
foxit::addon::compliance::HitData::trigger_values
WStringArray trigger_values
Array of trigger values. The count of triggered values is no more then triggered_count.
Definition: fs_compliancecommon.h:752
foxit::addon::compliance::PreflightSettingData::src_pdf_path
WString src_pdf_path
A complete path of source PDF file to be analyze and fix.
Definition: fs_compliancecommon.h:315
foxit::addon::compliance::ComplianceEngine::InitializeThreadContext
static ErrorCode InitializeThreadContext()
Initialize compliance context for a new thread.
foxit::addon::compliance::PreflightReportSettingData::e_ProblemsHighlightMethodTransparentMasks
Problems highlighted by transparent masks.
Definition: fs_compliancecommon.h:357
foxit::addon::compliance::FixupData::used_count
uint32 used_count
Represents the count of fixup operation invocations for current data during the conversion.
Definition: fs_compliancecommon.h:638
foxit::addon::compliance::ResultInformation
Definition: fs_compliancecommon.h:761
foxit::addon::compliance::HitData::operator=
HitData & operator=(const HitData &other)
Assign operator.
Definition: fs_compliancecommon.h:698
foxit::addon::compliance::PreflightSettingData
Definition: fs_compliancecommon.h:222
foxit::addon::compliance::ComplianceEngine::Initialize
static ErrorCode Initialize(const wchar_t *compliance_resource_folder_path, const char *compliance_engine_unlockcode)
Initialize compliance engine.
foxit::addon::compliance::ComplianceEngine::e_ViewOrPrintConditionISOCoatedv2ECI
Viewing or printing condition:ISO Coated v2 (ECI).
Definition: fs_compliancecommon.h:62
foxit::addon::compliance::PreflightReportSettingData::report_file_format_type
ReportFileFormatType report_file_format_type
The report file format type. Please refer to values starting from PreflightReportSettingData::e_Repor...
Definition: fs_compliancecommon.h:415
CFX_ByteString
BYTE STRING CLASS.
Definition: fx_string.h:317
foxit::addon::compliance::ResultInformation::~ResultInformation
~ResultInformation()
Destructor.
foxit::addon::compliance::ResultInformation::operator!=
bool operator!=(const ResultInformation &other) const
Not equal operator.
foxit::addon::compliance::FixupData::state
FixupState state
Fixup state. Please refer to values starting from FixupData::e_FixupStateSuccess and this should be o...
Definition: fs_compliancecommon.h:643
foxit::addon::compliance::FixupData::reasons
WStringArray reasons
Fixup reasons. This may be an empty array. The count of reasons will not exceed used_times.
Definition: fs_compliancecommon.h:649
foxit::addon::compliance::ComplianceEngine::e_ViewOrPrintConditionAuto
Viewing or printing condition: Auto.
Definition: fs_compliancecommon.h:58
foxit::addon::compliance::FixupData::e_FixupStateNotRequired
A fixup was not required.
Definition: fs_compliancecommon.h:568
foxit::addon::compliance::PreflightReportSettingData::PreflightReportSettingData
PreflightReportSettingData()
Constructor.
Definition: fs_compliancecommon.h:364
foxit::addon::compliance::PreflightSettingData::e_OperateTypeSingleChecks
Opearte type: single checks.
Definition: fs_compliancecommon.h:247
foxit::WStringArray::GetSize
size_t GetSize() const
Get the size of elements in current array.
foxit::addon::compliance::ResultInformation::operator==
bool operator==(const ResultInformation &other) const
Equal operator.
foxit::addon::compliance::Preflight::CanFixup
bool CanFixup(const String &item_key)
Check whether the item key can be fixuped or not.
foxit::addon::compliance::ComplianceEngine::ViewOrPrintCondition
ViewOrPrintCondition
Enumeration for viewing or printing condition.
Definition: fs_compliancecommon.h:56
foxit::addon::compliance::ResultInformation::GetHitData
HitData GetHitData(int index) const
Get a hit data.
foxit::addon::compliance::Preflight::Preflight
Preflight()
Constructor.
foxit::addon::compliance::FixupData::FixupState
FixupState
Enumeration for the state of a fixup data.
Definition: fs_compliancecommon.h:562
foxit::addon::compliance::PreflightSettingData::operate_type
OperateType operate_type
The preflight operate type. Please refer to values starting from PreflightSettingData::e_OperateTypeP...
Definition: fs_compliancecommon.h:312
foxit::addon::compliance::PreflightReportSettingData::operator=
PreflightReportSettingData & operator=(const PreflightReportSettingData &data)
Assign operator.
Definition: fs_compliancecommon.h:402
foxit
Foxit namespace.
Definition: fs_taggedpdf.h:27
foxit::addon::compliance::HitData::HitData
HitData(const HitData &other)
Constructor, with another hit data object.
Definition: fs_compliancecommon.h:683
foxit::addon::compliance::ComplianceEngine::EnableHandleTransparency
static void EnableHandleTransparency(bool enable_handle_transparency)
Set a flag to decide whether to enable transparency handling.
foxit::addon::compliance::HitData::CheckSeverity
CheckSeverity
Enumeration for check severity of a hit data.
Definition: fs_compliancecommon.h:662
foxit::addon::compliance::ComplianceEngine::e_ViewOrPrintConditionPSOCoatedv3ECI
Viewing or printing condition: PSO Coated v3 (ECI).
Definition: fs_compliancecommon.h:66
foxit::addon::compliance::ResultInformation::IsEmpty
bool IsEmpty() const
Check whether current object is empty or not.
foxit::addon::compliance::PreflightReportSettingData::problems_highlight_method
ProblemsHighlightMethod problems_highlight_method
The method highlight problems. Only effective when to_highlight_problems is true and report_file_form...
Definition: fs_compliancecommon.h:428
foxit::addon::compliance::PreflightSettingData::PreflightSettingData
PreflightSettingData()
Constructor.
Definition: fs_compliancecommon.h:254
foxit::addon::compliance::Preflight::~Preflight
~Preflight()
Destructor.
foxit::addon::compliance::PreflightReportSettingData::to_highlight_problems
bool to_highlight_problems
Whether to highlight problems or not. true menas to highlight problems, false means not.
Definition: fs_compliancecommon.h:421
foxit::addon::compliance::HitData::comment
WString comment
Hit rule comment to explain more details about the rule.
Definition: fs_compliancecommon.h:750
foxit::addon::compliance::Preflight
Definition: fs_compliancecommon.h:437
foxit::addon::compliance::Preflight::GetGroupNamesArray
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.
foxit::addon::compliance::Preflight::operator!=
bool operator!=(const Preflight &other) const
Not equal operator.
foxit::addon::compliance::ComplianceEngine::Release
static void Release()
Release compliance engine.
NULL
#define NULL
The null-pointer value.
Definition: fx_system.h:792
foxit::addon::compliance::PreflightSettingData::first_page_index
int first_page_index
Index of the first page to be analyzed or fixed, staring from 0. Default value: 0.
Definition: fs_compliancecommon.h:321
foxit::addon::compliance::ProgressCallback::Release
virtual void Release()=0
A callback function used to release current callback object itself.
foxit::addon::compliance::FixupData::e_FixupStateSuccess
A fixup succeeded.
Definition: fs_compliancecommon.h:564
foxit::addon::compliance::ResultInformation::operator=
ResultInformation & operator=(const ResultInformation &other)
Assign operator.
foxit::addon::compliance::ComplianceEngine::SetTempFolderPath
static void SetTempFolderPath(const wchar_t *temp_folder_path)
Set the temporary folder for compliance engine.
foxit::WStringArray
Definition: fs_basictypes.h:227
foxit::addon::compliance::PreflightSettingData::LibraryType
LibraryType
Enumeration for the preflight library type.
Definition: fs_compliancecommon.h:229
foxit::addon::compliance::Preflight::GenerateReport
bool GenerateReport(const PreflightReportSettingData &preflight_report_setting_data, ProgressCallback *progress_callback=0)
Generate report after analyzing or fixing.
foxit::addon::compliance::PreflightReportSettingData::to_generate_overview
bool to_generate_overview
Whether to generate overview or not. true menas to generate overview, false means not.
Definition: fs_compliancecommon.h:418
foxit::addon::compliance::ComplianceEngine
Definition: fs_compliancecommon.h:49
foxit::addon::compliance::ProgressCallback::UpdateCurrentStateData
virtual void UpdateCurrentStateData(int current_rate, const WString &current_state_string)=0
A callback function used to update current progress state data to user in order that user can update ...
foxit::addon::compliance::FixupData
Definition: fs_compliancecommon.h:555
foxit::addon::compliance::FixupData::operator!=
bool operator!=(const FixupData &other) const
Not equal operator.
Definition: fs_compliancecommon.h:633
foxit::addon::compliance::ProgressCallback
Definition: fs_compliancecommon.h:198
foxit::addon::compliance::PreflightSettingData::e_LibraryTypePrepressColorTransparency
Preflight library type: Prepress,Color and Transparency.
Definition: fs_compliancecommon.h:235
CFX_WideString
WIDE STRING CLASS.
Definition: fx_string.h:1461
foxit::addon::compliance::FixupData::FixupData
FixupData()
Constructor.
Definition: fs_compliancecommon.h:573
foxit::addon::compliance::PreflightReportSettingData::e_ReportFileFormatTypeXml
Report file format type: XML.
Definition: fs_compliancecommon.h:343
foxit::addon::compliance::PreflightReportSettingData::PreflightReportSettingData
PreflightReportSettingData(ReportFileFormatType report_file_format_type, bool to_generate_overview, bool to_highlight_problems, ProblemsHighlightMethod problem_highlight_method, const wchar_t *report_file_path)
Constructor, with parameters.
Definition: fs_compliancecommon.h:386
foxit::addon::compliance::PreflightReportSettingData::ReportFileFormatType
ReportFileFormatType
Enumeration for the preflight report file format type.
Definition: fs_compliancecommon.h:339
foxit::addon::compliance::ResultInformation::GetFixupDataCount
int GetFixupDataCount() const
Get count of fixup data.
foxit::addon::compliance::HitData::name
WString name
Hit rule name.
Definition: fs_compliancecommon.h:748
foxit::addon::compliance::FixupData::comment
WString comment
Fixup rule comment to explain more details about the rule.
Definition: fs_compliancecommon.h:647
foxit::addon::compliance::ResultInformation::GetHitDataCount
int GetHitDataCount() const
Get count of hit data.
foxit::uint32
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:195
foxit::addon::compliance::Preflight::operator=
Preflight & operator=(const Preflight &other)
Assign operator.
foxit::addon::compliance::ComplianceEngine::e_ViewOrPrintConditionCoatedGRACoL2006
Viewing or printing condition:Coated GRACoL 2006.
Definition: fs_compliancecommon.h:60
foxit::Base
Definition: fs_basictypes.h:451
foxit::addon::compliance::PreflightReportSettingData::ProblemsHighlightMethod
ProblemsHighlightMethod
Enumeration for the highlight method for preflight problems.
Definition: fs_compliancecommon.h:355
foxit::addon::compliance::FixupData::e_FixupStateFailure
A fixup failed.
Definition: fs_compliancecommon.h:566
foxit::addon::compliance::ComplianceEngine::ReleaseThreadContext
static void ReleaseThreadContext()
Release compliance context of the thread.