Go to the documentation of this file.
16 #ifndef FS_COMPLIANCEENGINE_H_
17 #define FS_COMPLIANCEENGINE_H_
34 namespace compliance {
78 static ErrorCode Initialize(
const wchar_t* compliance_resource_folder_path,
const char* compliance_engine_unlockcode);
90 #if !defined(_MAC_JAVA_)
196 typedef enum _FixupState {
268 return !((*this) == other);
296 typedef enum _CheckSeverity {
371 return !((*this) == other);
482 #endif // FS_COMPLIANCEENGINE_H_
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
Info severity.
Definition: fs_compliancecommon.h:298
CheckSeverity severity
The check severity of current hit data. Please refer to values starting from HitData::e_CheckSeverity...
Definition: fs_compliancecommon.h:380
FixupData(const FixupData &other)
Constructor, with another fixup data object.
Definition: fs_compliancecommon.h:216
CFX_Object Object
Object type.
Definition: fs_basictypes.h:221
HitData()
Constructor.
Definition: fs_compliancecommon.h:307
Header file for common definitions and classes.
bool operator==(const HitData &other) const
Equal operator.
Definition: fs_compliancecommon.h:349
Warning severity.
Definition: fs_compliancecommon.h:300
ErrorCode
Enumeration for error code.
Definition: fs_basictypes.h:237
bool operator!=(const HitData &other) const
Not equal operator.
Definition: fs_compliancecommon.h:370
bool operator==(const FixupData &other) const
Equal operator.
Definition: fs_compliancecommon.h:246
uint32 triggered_count
Represents how many times the hit operation for current data has been triggered during verifying or c...
Definition: fs_compliancecommon.h:375
static void SetLanguage(const char *language)
Set language for compliance engine.
int page_index
Page index, starting from 0. -1 means current hit data was hit in document level.
Definition: fs_compliancecommon.h:388
WString name
Fixup rule name.
Definition: fs_compliancecommon.h:279
FixupData & operator=(const FixupData &other)
Assign operator.
Definition: fs_compliancecommon.h:230
Definition: fs_compliancecommon.h:289
Error severity.
Definition: fs_compliancecommon.h:302
WStringArray trigger_values
Array of trigger values. The count of triggered values is no more then triggered_count.
Definition: fs_compliancecommon.h:386
static ErrorCode InitializeThreadContext()
Initialize compliance context for a new thread.
uint32 used_count
Represents how many times the fixup operation for current data has been triggered during converting p...
Definition: fs_compliancecommon.h:272
HitData & operator=(const HitData &other)
Assign operator.
Definition: fs_compliancecommon.h:332
static ErrorCode Initialize(const wchar_t *compliance_resource_folder_path, const char *compliance_engine_unlockcode)
Initialize compliance engine.
FixupState state
Fixup state. Please refer to values starting from FixupData::e_FixupStateSuccess and this should be o...
Definition: fs_compliancecommon.h:277
WStringArray reasons
Fixup reasons. This may be an empty array. The count of reasons is no more then used_times.
Definition: fs_compliancecommon.h:283
A fixup was not required.
Definition: fs_compliancecommon.h:202
size_t GetSize() const
Get the size of elements in current array.
FixupState
Enumeration for the state of a fixup data.
Definition: fs_compliancecommon.h:196
Foxit namespace.
Definition: fs_taggedpdf.h:27
HitData(const HitData &other)
Constructor, with another hit data object.
Definition: fs_compliancecommon.h:317
CheckSeverity
Enumeration for check severity of a hit data.
Definition: fs_compliancecommon.h:296
WString comment
Hit rule comment to explain more details about the rule.
Definition: fs_compliancecommon.h:384
static void Release()
Release compliance engine.
virtual void Release()=0
A callback function used to release current callback object itself.
A fixup succeeded.
Definition: fs_compliancecommon.h:198
static void SetTempFolderPath(const wchar_t *temp_folder_path)
Set a temp folder for compliance engine.
Definition: fs_basictypes.h:228
Definition: fs_compliancecommon.h:44
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 ...
Definition: fs_compliancecommon.h:189
bool operator!=(const FixupData &other) const
Not equal operator.
Definition: fs_compliancecommon.h:267
Definition: fs_compliancecommon.h:163
WIDE STRING CLASS.
Definition: fx_string.h:1452
FixupData()
Constructor.
Definition: fs_compliancecommon.h:207
WString name
Hit rule name.
Definition: fs_compliancecommon.h:382
WString comment
Fixup rule comment to explain more details about the rule.
Definition: fs_compliancecommon.h:281
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
Definition: fs_basictypes.h:427
A fixup failed.
Definition: fs_compliancecommon.h:200
static void ReleaseThreadContext()
Release compliance context of the thread.
@2024 Foxit Software Incorporated. All rights reserved.