kfxKEDBasicSettingsProfile.h

Go to the documentation of this file.

//  API Reference
//
//  kfxKEDBasicSettingsProfile.h
//  KMCEngineData Objects
//
//  Copyright (c) 2012 - 2017 Kofax. Use of this code is with permission pursuant to Kofax license terms.
//

#import <Foundation/Foundation.h>
#ifndef KEDBASICSETTNGSPROFILE
#define KEDBASICSETTNGSPROFILE

#import "kfxKEDBoundingTetragon.h"


typedef enum {
    KED_ROTATE_NONE,
    KED_ROTATE_90,
    KED_ROTATE_180,
    KED_ROTATE_270,
    KED_AUTOMATIC
} KEDRotationOptions;

typedef enum {
    KED_BITDEPTH_BITONAL = 1,
    KED_BITDEPTH_GRAYSCALE = 8,
    KED_BITDEPTH_COLOR = 24
} KEDOutputColor;


typedef enum {
    KED_CROP_NONE,
    KED_CROP_AUTO,
    KED_CROP_TETRAGON,
    KED_CROP_WITH_QUICK_ANALYSIS_RESULTS,
    KED_CROP_LAST
} KEDCroppingOptions;


__deprecated_msg("This class was deprecated in SDK 3.3. Please use KFXImageProcessorConfiguration instead.")
@interface kfxKEDBasicSettingsProfile : NSObject <NSCoding>

// ==========================================================

@property (assign, nonatomic) KEDRotationOptions doRotate;

// ==========================================================

@property (assign, nonatomic) KEDCroppingOptions doCrop;

// ==========================================================

@property (assign, nonatomic) bool doDeskew;

// ==========================================================

@property (assign, nonatomic) float inputDocShortEdge;

// ==========================================================

@property (assign, nonatomic) float inputDocLongEdge;

// ==========================================================

@property (strong, nonatomic) kfxKEDBoundingTetragon *croppingTetragon;

// ==========================================================

@property (assign, nonatomic) int outputDPI;

// ==========================================================

@property (assign, nonatomic) KEDOutputColor outputBitDepth;

// ==========================================================

- (int)specifyOutputBitDepth:(KEDOutputColor)outputBitDepth;

// ==========================================================

- (int)specifyOutputDPI:(int)dpi;

// ==========================================================

- (instancetype)init;

// ==========================================================

- (instancetype)initForStandardBitonalWithDPI:(int)dpi;

// ==========================================================

- (instancetype)initForStandardGrayscaleWithDPI:(int)dpi;

// ==========================================================

- (instancetype)initForStandardColorWithDPI:(int)dpi;

// ==========================================================

+ (NSString *)decodeCroppingOption:(KEDCroppingOptions)option;

// ==========================================================

+ (NSString *)decodeBitDepth:(KEDOutputColor)option;

// ==========================================================

+ (NSString *)decodeRotateOpt:(KEDRotationOptions)option;

@end
#endif