EnumDefinitions_interface.h

Go to the documentation of this file.

 
#ifndef ENUMDEFINITIONS_INTERFACE_H
 
#define ENUMDEFINITIONS_INTERFACE_H
 
#include "idrskrn_interface.h"
 
#include "idrs_common.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * Generic Enums
 */
enum SeekPosition {
 
    SeekPositionBegin = 0,
    SeekPositionCurrent = 1,
    SeekPositionEnd = 2
 
};
 
enum FileStreamMode {
 
    FileStreamModeRead = 0,
    FileStreamModeWrite = 1,
    FileStreamModeAppend = 2,
    FileStreamModeReadWrite = 3
 
};
 
enum SeverityLevel {
 
    SeverityLevelInfo = 0,
    SeverityLevelWarning = 1,
    SeverityLevelError = 2
 
};
 
enum SerializationFormat {
 
    SerializationVersion10 = 10,
    SerializationVersion11 = 11,
    SerializationVersion12 = 12,
    SerializationVersion13 = 13,
    SerializationVersion14 = 14,
    SerializationVersion15 = 15,
    SerializationVersion16 = 16,
    SerializationVersion17 = 17,
    SerializationVersion18 = 18,
    SerializationVersion19 = 19,
    SerializationVersion20 = 20,
    SerializationVersionLatest = 20
 
};
 
/*
 * Enums related to Page Content representation
 */
enum GraphicShapeType {
 
    GraphicShapeTypeLine = 0
 
};
 
enum BookmarkDisplayMode {
 
    BookmarkDisplayModePage = 0,
    BookmarkDisplayModePageWidth = 1,
    BookmarkDisplayModePageHeight = 2,
    BookmarkDisplayModeContent = 3,
    BookmarkDisplayModeContentWidth = 4,
    BookmarkDisplayModeContentHeight = 5,
    BookmarkDisplayModeRectangle = 6,
    BookmarkDisplayModeZoom = 7
 
};
 
enum PdfCustomMetadataResourceType {
 
    PdfCustomMetadataResourceTypeContainer = 0,
    PdfCustomMetadataResourceTypePropertyList = 1
 
};
 
enum ZoneType {
 
    ZoneTypeText = 0,
    ZoneTypeGraphic = 1,
    ZoneTypeTable = 2
 
};
 
enum PageZoneGraphicSource {
 
    PageZoneGraphicSourceBaseImage = 0,
    PageZoneGraphicSourceExternal = 1,
    PageZoneGraphicSourceExternalWithMask = 2
 
};
 
enum TextType {
 
    TextTypePrinted = 0,
    TextTypeBlockLettersHandwriting = 1,
    TextTypeCursiveHandwriting = 2
 
};
 
enum TextDirection {
 
    TextDirectionAny = 0,
    TextDirectionLeftToRight = 1,
    TextDirectionTopToBottom = 2,
    TextDirectionRightToLeft = 3
 
};
 
enum FontFamilyType {
 
    FontFamilyTypeSansSerif = 1,
    FontFamilyTypeSerif = 2,
    FontFamilyTypeMonotype = 3
 
};
 
enum HorizontalAlignment {
 
    HorizontalAlignmentLeft = 1,
    HorizontalAlignmentRight = 2,
    HorizontalAlignmentJustify = 3,
    HorizontalAlignmentCenter = 4,
    HorizontalAlignmentChar = 5
 
};
 
enum VerticalAlignment {
 
    VerticalAlignmentTop = 1,
    VerticalAlignmentMiddle = 2,
    VerticalAlignmentBottom = 3,
    VerticalAlignmentBaseline = 4
 
};
 
enum TabulationLeader {
 
    TabulationLeaderTypeNone = 0,
    TabulationLeaderTypeDots = 1,
    TabulationLeaderTypeHyphen = 2,
    TabulationLeaderTypeUnderscore = 3
 
};
 
enum ListType {
 
    ListTypeUnordered = 1,
    ListTypeOrdered = 2
 
};
 
enum Hyperlink {
 
    HyperlinkTypeNone = 0,
    HyperlinkTypeEmail = 1,
    HyperlinkTypeUrl = 2
 
};
 
enum ParagraphType {
 
    ParagraphTypeBody = 0,
    ParagraphTypeTitle = 1,
    ParagraphTypeList = 2
 
};
 
enum ListStyle {
 
    ListStyleNone = 0,
    ListStyleDisc = 1,
    ListStyleCircle = 2,
    ListStyleSquare = 3,
    ListStyleDecimal = 4,
    ListStyleDecimalLeadingZero = 5,
    ListStyleLowerRoman = 6,
    ListStyleUpperRoman = 7,
    ListStyleLowerGreek = 10,
    ListStyleLowerLatin = 11,
    ListStyleUpperLatin = 12
 
};
 
enum FormFieldType {
 
    FormFieldTypeText = 0,
    FormFieldTypeCombedText = 1,
    FormFieldTypePassword = 2,
    FormFieldTypeCheckbox = 3,
    FormFieldTypeRadioButtonItem = 4,
    FormFieldTypeRadioButton = 5,
    FormFieldTypeGroup = 6,
    FormFieldTypeDropdown = 7,
    FormFieldTypeListBox = 8
 
};
 
enum FormActionType {
 
    FormActionTypeJavaScript = 0
 
};
 
enum FormFieldEventType {
 
    FormFieldEventTypeOnKeyStroke = 0,
    FormFieldEventTypeOnBeforeFormat = 1,
    FormFieldEventTypeOnValidate = 2,
    FormFieldEventTypeOnCalculate = 3,
    FormFieldEventTypeOnMouseEnter = 4,
    FormFieldEventTypeOnMouseLeave = 5,
    FormFieldEventTypeOnMouseDown = 6,
    FormFieldEventTypeOnMouseUp = 7,
    FormFieldEventTypeOnFocus = 8,
    FormFieldEventTypeOnBlur = 9,
    FormFieldEventTypeOnPageOpen = 10,
    FormFieldEventTypeOnPageClose = 11,
    FormFieldEventTypeOnPageVisible = 12,
    FormFieldEventTypeOnPageHide = 13
 
};
 
enum FormFieldBorderStyle {
 
    FormFieldBorderStyleInherit = 0,
    FormFieldBorderStyleNone = 1,
    FormFieldBorderStyleSolid = 2,
    FormFieldBorderStyleDashed = 3,
    FormFieldBorderStyleBeveled = 4,
    FormFieldBorderStyleInset = 5,
    FormFieldBorderStyleUnderline = 6
 
};
 
enum FormFieldTextAlignment {
 
    FormFieldTextAlignmentNone = 0,
    FormFieldTextAlignmentCenter = 1,
    FormFieldTextAlignmentLeft = 2,
    FormFieldTextAlignmentRight = 3
 
};
 
enum AttachmentType {
 
    AttachmentTypeText = 0,
    AttachmentTypePdf = 1,
    AttachmentTypeXml = 2,
    AttachmentTypeHtml = 3,
    AttachmentTypeRtf = 4,
    AttachmentTypeDoc = 5,
    AttachmentTypeDot = 6,
    AttachmentTypeDocx = 7,
    AttachmentTypeDotx = 8,
    AttachmentTypeXls = 9,
    AttachmentTypeXlt = 10,
    AttachmentTypeXla = 11,
    AttachmentTypeXlsx = 12,
    AttachmentTypeXltx = 13,
    AttachmentTypeCsv = 14,
    AttachmentTypePpt = 15,
    AttachmentTypePptx = 16,
    AttachmentTypePot = 17,
    AttachmentTypePotx = 18,
    AttachmentTypePps = 19,
    AttachmentTypePpa = 20,
    AttachmentTypeJpeg = 21,
    AttachmentTypePng = 22,
    AttachmentTypeTiff = 23,
    AttachmentTypeGif = 24,
    AttachmentTypeAppSpecific = 25
 
};
 
/*
 * Enums related to Imaging and Compression
 */
enum ColorMode {
 
    ColorModeUnknown = 0,
    ColorModeBlackAndWhite = 1,
    ColorModeGreyscale = 2,
    ColorModeColor = 3
 
};
 
enum CompressionQuality {
 
    CompressionQualityMinimalSize = 0,
    CompressionQualityVerySmallSize = 1,
    CompressionQualitySmallSize = 2,
    CompressionQualityFavorSizeOverQuality = 3,
    CompressionQualityMedium = 4,
    CompressionQualityFavorQualityOverSize = 5,
    CompressionQualityHighQuality = 6,
    CompressionQualityVeryHighQuality = 7,
    CompressionQualityMaximalQuality = 8
 
};
 
enum CompressionLevel {
 
    CompressionLevelMaximumPerformance = 1,
    CompressionLevelVeryHighPerformance = 2,
    CompressionLevelHighPerformance = 3,
    CompressionLevelFavorPerformance = 4,
    CompressionLevelMedium = 5,
    CompressionLevelFavorCompression = 6,
    CompressionLevelHighCompression = 7,
    CompressionLevelVeryHighCompression = 8,
    CompressionLevelMaximumCompression = 9
 
};
 
enum PdfInputBlackAndWhiteDetection {
 
    PdfInputBlackAndWhiteDetectionDisabled = 0,
    PdfInputBlackAndWhiteDetectionFast = 1,
    PdfInputBlackAndWhiteDetectionAccurate = 2
 
};
 
enum ImageFormat {
 
    ImageFormatTiff = 0,
    ImageFormatPng = 1,
    ImageFormatJpeg = 2,
    ImageFormatBmp = 3,
    ImageFormatJpeg2000 = 5,
    ImageFormatJbig2 = 6,
    ImageFormatCustom = 10,
    ImageFormatPdf = 11
 
};
 
enum TiffCompression {
 
    TiffCompressionGroup4 = 0,
    TiffCompressionFaxGroup4 = 1,
    TiffCompressionPackbits = 2,
    TiffCompressionJpeg = 3
 
};
 
enum PngTransparencyMode {
 
    PngTransparencyModeNone = 0,
    PngTransparencyModeBlack = 1
 
};
 
/*
 * Enums related to Preprocessing
 */
enum BinarizationType {
 
    BinarizationTypeFixedThreshold = 0,
    BinarizationTypeAutomaticThreshold = 1,
    BinarizationTypeAdaptive = 2
 
};
 
enum DespeckleType {
 
    DespeckleTypeBlack = 0,
    DespeckleTypeWhite = 1,
    DespeckleTypeAll = 2
 
};
 
enum BlankImageDetectionMode {
 
    BlankImageDetectionModeFast = 0,
    BlankImageDetectionModeAdvanced = 1
 
};
 
enum BlankImageDetectionSensitivity {
 
    BlankImageDetectionSensitivityStronglyFavorBlank = 0,
    BlankImageDetectionSensitivityFavorBlank = 1,
    BlankImageDetectionSensitivityBalanced = 2,
    BlankImageDetectionSensitivityFavorNotBlank = 3,
    BlankImageDetectionSensitivityStronglyFavorNotBlank = 4
 
};
 
enum ImageSource {
 
    ImageSourceUnknown = 0,
    ImageSourceScanner = 1,
    ImageSourceCamera = 2
 
};
 
enum SkewDetection {
 
    SkewDetectionNone = 0,
    SkewDetectionIfText = 1,
    SkewDetectionAlways = 2
 
};
 
enum DimensionAdjust {
 
    DimensionAdjustNone = 0,
    DimensionAdjustCrop = 1
 
};
 
/*
 * Enums related to Document Output
 */
enum OutputFormat {
 
    OutputFormatText = 0,
    OutputFormatHtml = 1,
    OutputFormatRtf = 2,
    OutputFormatPdf = 3,
    OutputFormatOdt = 4,
    OutputFormatDocx = 5,
    OutputFormatXlsx = 6,
    OutputFormatEpub = 7,
    OutputFormatPptx = 8,
    OutputFormatXml = 9
 
};
 
enum PageLayout {
 
    PageLayoutNoLayout = 0,
    PageLayoutFlowing = 1,
    PageLayoutEditable = 2,
    PageLayoutExact = 3
 
};
 
enum SpreadsheetLayout {
 
    SpreadsheetLayoutTablesOnly = 0,
    SpreadsheetLayoutTablesAndText = 1,
    SpreadsheetLayoutRecreateInput = 2
 
};
 
enum SlideSize {
 
    SlideSizeStandard = 0,
    SlideSizeWideScreen = 1,
    SlideSizeCustom = 2
 
};
 
enum PageDisplay {
 
    PageDisplayTextAndGraphics = 0,
    PageDisplayTextOverImage = 1,
    PageDisplayImageOverText = 2,
    PageDisplayHyperCompression = 3
 
};
 
enum BookmarksMode {
 
    BookmarksModeDisabled = 0,
    BookmarksModeEnabled = 1
 
};
 
enum PageSize {
 
    PageSizeA3 = 0,
    PageSizeA4 = 1,
    PageSizeA5 = 2,
    PageSizeA6 = 3,
    PageSizeB4 = 4,
    PageSizeB5 = 5,
    PageSizeLetter = 6,
    PageSizeLegal = 7,
    PageSizeTabloid = 8,
    PageSizeExecutive = 9
 
};
 
enum PaperOrientation {
 
    PaperOrientationPortrait = 0,
    PaperOrientationLandscape = 1
 
};
 
enum PageOrientation {
 
    PageOrientationStraight = 0,
    PageOrientationRotatedLeft = 90,
    PageOrientationUpsideDown = 180,
    PageOrientationRotatedRight = 270
 
};
 
enum PdfVersion {
 
    PdfVersionPdf14 = 0,
    PdfVersionPdfA1b = 1,
    PdfVersionPdfA1a = 2,
    PdfVersionPdf15 = 3,
    PdfVersionPdf16 = 4,
    PdfVersionPdf17 = 5,
    PdfVersionPdfA2b = 6,
    PdfVersionPdfA2a = 7,
    PdfVersionPdfA3b = 8,
    PdfVersionPdfA3a = 9,
    PdfVersionPdf17Extension3 = 10,
    PdfVersionPdf17Extension5 = 11,
    PdfVersionPdf17Extension8 = 12,
    PdfVersionPdfA2u = 13,
    PdfVersionPdfA3u = 14
 
};
 
enum CharacterEncoding {
 
    CharacterEncodingUtf8 = 0,
    CharacterEncodingUtf16 = 1
 
};
 
enum PageCollectionType {
 
    PageCollectionTypeDefault = 0,
    PageCollectionTypeCustom = 1
 
};
 
enum XmlSchema {
 
    XmlSchemaBasic = 0,
    XmlSchemaAlto = 1
 
};
 
enum EncryptionAlgorithm {
 
    EncryptionAlgorithmNone = 0,
    EncryptionAlgorithmAuto = 1,
    EncryptionAlgorithmRc4 = 2,
    EncryptionAlgorithmAes128 = 3
 
};
 
enum PrintPermission {
 
    PrintPermissionForbidden = 0,
    PrintPermissionLowResolution = 1,
    PrintPermissionAllowed = 2
 
};
 
enum EditPermission {
 
    EditPermissionNone = 0,
    EditPermissionOrganizePages = 1,
    EditPermissionFillAndSign = 2,
    EditPermissionFillAndSignAndComment = 3,
    EditPermissionAllViewerOptions = 4
 
};
 
/*
 * Enums related to OCR
 */
enum FontInfoComputation {
 
    FontInfoComputationNone = 0,
    FontInfoComputationStandard = 1,
    FontInfoComputationOffice = 2,
    FontInfoComputationCustom = 3
 
};
 
enum RecognitionType {
 
    RecognitionTypeFullPage = 0,
    RecognitionTypeZonal = 1
 
};
 
enum Workdepth {
 
    WorkdepthMaximumSpeed = 0,
    WorkdepthFavorSpeedOverAccuracy = 1,
    WorkdepthBalanced = 2,
    WorkdepthFavorAccuracyOverSpeed = 3,
    WorkdepthMaximumAccuracy = 4
 
};
 
enum TextDetectionSensivity {
 
    TextDetectionSensivityMaximumText = 0,
    TextDetectionSensivityFavorTextOverLayout = 1,
    TextDetectionSensivityBalanced = 2,
    TextDetectionSensivityFavorLayoutOverText = 3,
    TextDetectionSensivityMaximumLayout = 4
 
};
 
enum ThreadingMode {
 
    ThreadingModeNone = 0,
    ThreadingModeLimited = 1,
    ThreadingModeOptimized = 2,
    ThreadingModeMaximum = 3,
    ThreadingModeMemoryConservative = 4
 
};
 
enum TableDetectionMode {
 
    TableDetectionModeDisabled = 0,
    TableDetectionModeAutomatic = 1,
    TableDetectionModeForceSingleTable = 2
 
};
 
/*
 * Enums related to Barcode detection
 */
enum BarcodeEncoding {
 
    BarcodeEncodingUtf8 = 0,
    BarcodeEncodingSjis = 1
 
};
 
enum BarcodeEngineIdentifier {
 
    BarcodeEngineUIDStandard = 0,
    BarcodeEngineUIDAdvanced = 1,
    BarcodeEngineUIDDatamatrix = 2,
    BarcodeEngineUIDExtra2D = 3,
    BarcodeEngineUIDStandardDespeckle = 4,
    BarcodeEngineUIDExtra2dDespeckle = 5,
    BarcodeEngineUIDStandardUndither = 6,
    BarcodeEngineUIDExtra2dUndither = 7,
    BarcodeEngineUIDCustom = 8
 
};
 
enum BarcodeRecognitionMode {
 
    BarcodeRecognitionModeStopOnFirstResult = 0,
    BarcodeRecognitionModeReadAllBarcodes = 1
 
};
 
enum BarcodeCapability {
 
    BarcodeCapabilityImageBlackAndWhite = 1,
    BarcodeCapabilityImageGreyscale = 2,
    BarcodeCapabilityImageColor = 3,
    BarcodeCapabilityCode128ControlCode = 4
 
};
 
enum BarcodeSessionParameter {
 
    BarcodeSessionWorkdepth = 0,
    BarcodeSessionMinHeight = 1,
    BarcodeSessionMaxHeight = 2,
    BarcodeSessionMinLength = 3,
    BarcodeSessionMaxLength = 4,
    BarcodeSessionRecognitionMode = 5,
    BarcodeSessionTimeoutMilliseconds = 6,
    BarcodeSessionCode128ControlCode = 7,
    BarcodeSessionAutomaticEncodingDetectionUtf8 = 8,
    BarcodeSessionAutomaticEncodingDetectionSJIS = 9,
    BarcodeSessionMax = 10
 
};
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* ENUMDEFINITIONS_INTERFACE_H */