kfxKUICommon.h File Reference

Typedefs
typedef enum LINE_STYLE_ENUM	kfxUILineStyle
	Style of outline for cropping rectangle/tetragon (solid or dotted lines). More...

Enumerations
enum	kfxKUIFlashSetting {   kfxKUIFlashOn = 0, kfxKUIFlashOff = 1, kfxKUIFlashAuto = 2, kfxKUITorch = 3,   kfxKUITorchAuto = 4 }
	An enumeration to set the flash mode of a capture control. More...
enum	kfxKUIGuidingLine { kfxKUIGuidingLineOff = 0, kfxKUIGuidingLineLandscape = 1, kfxKUIGuidingLinePortrait = 2 }
	An enumeration to set the guiding line mode of a barcode capture control. More...
enum	kfxKUISymbology {   kfxKUISymbologyCode39 = 0, kfxKUISymbologyPdf417 = 1, kfxKUISymbologyQR = 2, kfxKUISymbologyDataMatrix = 3,   kfxKUISymbologyCode128 = 4, kfxKUISymbologyCode25 = 5, kfxKUISymbologyEAN = 6, kfxKUISymbologyUPC = 7,   kfxKUISymbologyCodabar = 8, kfxKUISymbologyAztec = 9, kfxKUISymbologyCode93 = 10 }
	An enumeration containing the different barcode symbologies that can be detected. More...
enum	kfxKUISearchDirection { kfxKUIDirectionHorizontal = 1 | 2, kfxKUIDirectionVertical = 4 | 8, kfxKUIDirectionAll = 1 | 2 | 4 | 8 }
	An enumeration containing the different possible barcode search directions. More...
enum	kfxKUIPageDetect { kfxKUIPageDetectOff = 0, kfxKUIPageDetectAutomatic = 1, kfxKUIPageDetectContinuous = 2 }
	An enumeration to control page detection mode. More...
enum	kfxKUIGPSUsageLimits { kfxKUINeverUse = 0, kfxKUIAlwaysUseIfEnabled =1 }
	An enumeration to control use of GPS location information. More...
enum	kfxKUIDocumentDetectionModes { kfxKUIGenericDocument = 0, kfxKUICheckFront = 1, kfxKUICheckBack = 2 }
	An enumeration to control use of detection algorithm used for real time document detection. More...
enum	kfxKUICameraType { kfxKUIBackCamera = 0, kfxKUIFrontCamera = 1 }
	An enumeration to set camera type. More...
enum	LINE_STYLE_ENUM { LINE_STYLE_SOLID, LINE_STYLE_DOTTED }
	Style of outline for cropping rectangle/tetragon (solid or dotted lines). More...

Typedef Documentation

kfxUILineStyle

typedef enum LINE_STYLE_ENUM kfxUILineStyle

Style of outline for cropping rectangle/tetragon (solid or dotted lines).

Enumeration Type Documentation

kfxKUICameraType

enum kfxKUICameraType

An enumeration to set camera type.

Use one of the values of this enumeration to camera type front or back.

Enumerator
kfxKUIBackCamera
kfxKUIFrontCamera

kfxKUIDocumentDetectionModes

enum kfxKUIDocumentDetectionModes

An enumeration to control use of detection algorithm used for real time document detection.

Use one of the values of this enumeration to determine what type of algorithm is used in real time doucment detection

Enumerator
kfxKUIGenericDocument
kfxKUICheckFront
kfxKUICheckBack

kfxKUIFlashSetting

enum kfxKUIFlashSetting

An enumeration to set the flash mode of a capture control.

Use one of the values of this enumeration to set the flash mode of a capture control.

Enumerator
kfxKUIFlashOn
kfxKUIFlashOff
kfxKUIFlashAuto
kfxKUITorch
kfxKUITorchAuto

kfxKUIGPSUsageLimits

enum kfxKUIGPSUsageLimits

An enumeration to control use of GPS location information.

Use one of the values of this enumeration to determine whether GPS location information is included in SDK photos.

Enumerator
kfxKUINeverUse
kfxKUIAlwaysUseIfEnabled

kfxKUIGuidingLine

enum kfxKUIGuidingLine

An enumeration to set the guiding line mode of a barcode capture control.

Use one of the values of this enumeration to set the guiding line display mode of a barcode capture contorl.

Enumerator
kfxKUIGuidingLineOff
kfxKUIGuidingLineLandscape
kfxKUIGuidingLinePortrait

kfxKUIPageDetect

enum kfxKUIPageDetect

An enumeration to control page detection mode.

Use one of the values of this enumeration to set the page detection mode of a capture control.

Enumerator
kfxKUIPageDetectOff
kfxKUIPageDetectAutomatic
kfxKUIPageDetectContinuous

kfxKUISearchDirection

enum kfxKUISearchDirection

An enumeration containing the different possible barcode search directions.

One or more of these values can be passed to a barcode capture control to restrict the directions that are searched for barcodes.

Enumerator
kfxKUIDirectionHorizontal
kfxKUIDirectionVertical
kfxKUIDirectionAll

kfxKUISymbology

enum kfxKUISymbology

An enumeration containing the different barcode symbologies that can be detected.

One or more of these values can be passed to a barcode capture control to restrict search to those symbologies.

Enumerator
kfxKUISymbologyCode39
kfxKUISymbologyPdf417
kfxKUISymbologyQR
kfxKUISymbologyDataMatrix
kfxKUISymbologyCode128
kfxKUISymbologyCode25
kfxKUISymbologyEAN
kfxKUISymbologyUPC
kfxKUISymbologyCodabar
kfxKUISymbologyAztec
kfxKUISymbologyCode93

LINE_STYLE_ENUM

enum LINE_STYLE_ENUM

Style of outline for cropping rectangle/tetragon (solid or dotted lines).

Enumerator
LINE_STYLE_SOLID
LINE_STYLE_DOTTED