15 #ifndef FS_COMPLIANCEENGINE_H_ 16 #define FS_COMPLIANCEENGINE_H_ 33 namespace compliance {
56 typedef enum _ViewOrPrintCondition {
102 static ErrorCode Initialize(
const wchar_t* compliance_resource_folder_path,
const char* compliance_engine_unlockcode);
114 #if !defined(_MAC_JAVA_) 228 typedef enum _LibraryType {
242 typedef enum _OperateType {
338 typedef enum _ReportFileFormatType {
354 typedef enum _ProblemsHighlightMethod {
561 typedef enum _FixupState {
633 return !((*this) == other);
661 typedef enum _CheckSeverity {
736 return !((*this) == other);
847 #endif // FS_COMPLIANCEENGINE_H_ virtual void Release()=0
A callback function used to release current callback object itself.
LibraryType
Enumeration for the preflight library type.
Definition: fs_compliancecommon.h:228
PreflightReportSettingData()
Constructor.
Definition: fs_compliancecommon.h:363
FixupData & operator=(const FixupData &other)
Assign operator.
Definition: fs_compliancecommon.h:595
Error severity.
Definition: fs_compliancecommon.h:667
Report file format type: XML.
Definition: fs_compliancecommon.h:342
bool operator !=(const HitData &other) const
Not equal operator.
Definition: fs_compliancecommon.h:735
int page_index
Page index, starting from 0. -1 means current hit data was hit in document level.
Definition: fs_compliancecommon.h:753
bool to_generate_overview
Whether to generate overview or not. true menas to generate overview, false means not.
Definition: fs_compliancecommon.h:417
CFX_Object Object
Object type.
Definition: fs_basictypes.h:221
Preflight library type: Foxit.
Definition: fs_compliancecommon.h:230
int first_page_index
Index of the first page to be analyzed or fixed, staring from 0. Default value: 0.
Definition: fs_compliancecommon.h:320
bool CanFixup(const String &item_key)
Check whether the item key can be fixuped or not.
Definition: fs_basictypes.h:228
uint32 triggered_count
Represents the count of hit operation for current data has been triggered during document verificatio...
Definition: fs_compliancecommon.h:740
ReportFileFormatType
Enumeration for the preflight report file format type.
Definition: fs_compliancecommon.h:338
FixupData()
Constructor.
Definition: fs_compliancecommon.h:572
A fixup succeeded.
Definition: fs_compliancecommon.h:563
StringArray GetItemKeysArray(const String &group_name)
Get item keys array with the specific group name.
WStringArray trigger_values
Array of trigger values. The count of triggered values is no more then triggered_count.
Definition: fs_compliancecommon.h:751
bool GenerateReport(const PreflightReportSettingData &preflight_report_setting_data, ProgressCallback *progress_callback=0)
Generate report after analyzing or fixing.
CheckSeverity severity
The check severity of current hit data. Please refer to values starting from HitData::e_CheckSeverity...
Definition: fs_compliancecommon.h:745
WIDE STRING CLASS.
Definition: fx_string.h:1461
HitData & operator=(const HitData &other)
Assign operator.
Definition: fs_compliancecommon.h:697
Definition: fs_compliancecommon.h:654
Viewing or printing condition:Japan Color 2001 Coated.
Definition: fs_compliancecommon.h:64
Definition: fs_compliancecommon.h:221
Problems highlighted by transparent masks.
Definition: fs_compliancecommon.h:356
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:276
ViewOrPrintCondition
Enumeration for viewing or printing condition.
Definition: fs_compliancecommon.h:56
HitData()
Constructor.
Definition: fs_compliancecommon.h:672
Definition: fs_compliancecommon.h:331
PreflightReportSettingData & operator=(const PreflightReportSettingData &data)
Assign operator.
Definition: fs_compliancecommon.h:401
HitData(const HitData &other)
Constructor, with another hit data object.
Definition: fs_compliancecommon.h:682
FixupState state
Fixup state. Please refer to values starting from FixupData::e_FixupStateSuccess and this should be o...
Definition: fs_compliancecommon.h:642
WStringArray reasons
Fixup reasons. This may be an empty array. The count of reasons will not exceed used_times.
Definition: fs_compliancecommon.h:648
virtual void UpdateCurrentStateData(int current_rate, const WString ¤t_state_string)=0
A callback function used to update current progress state data to user in order that user can update ...
Preflight library type: Prepress,Color and Transparency.
Definition: fs_compliancecommon.h:234
bool IsEmpty() const
Check whether current object is empty or not.
WString comment
Hit rule comment to explain more details about the rule.
Definition: fs_compliancecommon.h:749
FixupData(const FixupData &other)
Constructor, with another fixup data object.
Definition: fs_compliancecommon.h:581
bool operator==(const FixupData &other) const
Equal operator.
Definition: fs_compliancecommon.h:611
static void EnableHandleTransparency(bool enable_handle_transparency)
Set a flag to decide whether to enable transparency handling.
FixupState
Enumeration for the state of a fixup data.
Definition: fs_compliancecommon.h:561
Definition: fs_compliancecommon.h:197
WString name
Fixup rule name.
Definition: fs_compliancecommon.h:644
ErrorCode
Enumeration for error code.
Definition: fs_basictypes.h:237
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:327
bool operator==(const Preflight &other) const
Equal operator.
bool operator==(const HitData &other) const
Equal operator.
Definition: fs_compliancecommon.h:714
Opearte type: single fixups.
Definition: fs_compliancecommon.h:248
Viewing or printing condition: PSO Coated v3 (ECI).
Definition: fs_compliancecommon.h:66
static void SetTempFolderPath(const wchar_t *temp_folder_path)
Set the temporary folder for compliance engine.
Viewing or printing condition:ISO Coated v2 (ECI).
Definition: fs_compliancecommon.h:62
Opearte type: single checks.
Definition: fs_compliancecommon.h:246
Definition: fs_compliancecommon.h:49
A fixup failed.
Definition: fs_compliancecommon.h:565
Viewing or printing condition: Auto.
Definition: fs_compliancecommon.h:58
Report file format type: HTML.
Definition: fs_compliancecommon.h:346
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
Header file for common definitions and classes.
WString comment
Fixup rule comment to explain more details about the rule.
Definition: fs_compliancecommon.h:646
bool operator !=(const FixupData &other) const
Not equal operator.
Definition: fs_compliancecommon.h:632
bool operator !=(const Preflight &other) const
Not equal operator.
Info severity.
Definition: fs_compliancecommon.h:663
Warning severity.
Definition: fs_compliancecommon.h:665
PreflightSettingData & operator=(const PreflightSettingData &data)
Assign operator.
Definition: fs_compliancecommon.h:293
uint32 used_count
Represents the count of fixup operation invocations for current data during the conversion.
Definition: fs_compliancecommon.h:637
Definition: fs_basictypes.h:449
void Analyze(const PreflightSettingData &preflight_setting_data, ProgressCallback *progress_callback=0)
Analyze a PDF file.
Definition: fs_basictypes.h:230
OperateType
Enumeration for the preflight operate type.
Definition: fs_compliancecommon.h:242
static void Release()
Release compliance engine.
CheckSeverity
Enumeration for check severity of a hit data.
Definition: fs_compliancecommon.h:661
WString name
Hit rule name.
Definition: fs_compliancecommon.h:747
WString src_pdf_path
A complete path of source PDF file to be analyze and fix.
Definition: fs_compliancecommon.h:314
Preflight & operator=(const Preflight &other)
Assign operator.
Foxit namespace.
Definition: fs_taggedpdf.h:27
void AnalyzeAndFixup(const PreflightSettingData &preflight_setting_data, ProgressCallback *progress_callback=0)
Analyze and fixup a PDF file.
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.
ProblemsHighlightMethod problems_highlight_method
The method highlight problems. Only effective when to_highlight_problems is true and report_file_form...
Definition: fs_compliancecommon.h:427
BYTE STRING CLASS.
Definition: fx_string.h:317
static void ReleaseThreadContext()
Release compliance context of the thread.
size_t GetSize() const
Get the size of elements in current array.
Report file format type: TXT & TEXT.
Definition: fs_compliancecommon.h:344
Preflight library type: Standards.
Definition: fs_compliancecommon.h:232
Report file format type: PDF.
Definition: fs_compliancecommon.h:340
static ErrorCode Initialize(const wchar_t *compliance_resource_folder_path, const char *compliance_engine_unlockcode)
Initialize compliance engine.
Opearte type: profiles.
Definition: fs_compliancecommon.h:244
static void SetLanguage(const char *language)
Set language for compliance engine.
#define NULL
The null-pointer value.
Definition: fx_system.h:792
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:385
OperateType operate_type
The preflight operate type. Please refer to values starting from PreflightSettingData::e_OperateTypeP...
Definition: fs_compliancecommon.h:311
ReportFileFormatType report_file_format_type
The report file format type. Please refer to values starting from PreflightReportSettingData::e_Repor...
Definition: fs_compliancecommon.h:414
A fixup was not required.
Definition: fs_compliancecommon.h:567
PreflightSettingData()
Constructor.
Definition: fs_compliancecommon.h:253
Problems highlighted by layers.
Definition: fs_compliancecommon.h:358
WString report_file_path
A complete path for the report file. This should not be an empty string.
Definition: fs_compliancecommon.h:430
Definition: fs_compliancecommon.h:554
ProblemsHighlightMethod
Enumeration for the highlight method for preflight problems.
Definition: fs_compliancecommon.h:354
static ErrorCode InitializeThreadContext()
Initialize compliance context for a new thread.
Definition: fs_compliancecommon.h:436
Viewing or printing condition:Coated GRACoL 2006.
Definition: fs_compliancecommon.h:60
WString saved_pdf_path
A complete path for saving the PDF file generated by the preflight analysis and fixup process.
Definition: fs_compliancecommon.h:317
bool to_highlight_problems
Whether to highlight problems or not. true menas to highlight problems, false means not.
Definition: fs_compliancecommon.h:420
WString preflight_key
The preflight key. Retrieve available keys via Preflight::GetItemKeysArray.
Definition: fs_compliancecommon.h:304