Atalasoft MobileImage API Reference
Properties | List of all members
kfxLookAndFeelParameters Class Reference

The look and feel parameters class. More...

#import <kfxLookAndFeelParameters.h>

Inheritance diagram for kfxLookAndFeelParameters:

Properties

BOOL galleryEnabled
 A boolean value that determines whether gallery button is enabled. More...
 
BOOL forceCaptureEnabled
 A boolean value that determines whether force capture button is enabled. More...
 
NSTimeInterval manualCaptureTimer
 The number of seconds to show force capture button after presenting capture controller. More...
 
BOOL exitEnabled
 A boolean value that determines whether exit button is enabled. More...
 
kfxTorchMode torch
 A torch mode value that determines camera torch behavior. More...
 
BOOL reviewCapturedImageEnabled
 A boolean value that determines whether to show captured image review flow. More...
 
BOOL reviewProcessedImageEnabled
 A boolean value that determines whether to show processed image review flow. More...
 

Detailed Description

The look and feel parameters class.

The parameters object allows the user to customize visual look and feel for capture view controller. The behavior and default values for some parameters could vary across capture view controllers, and details are specified in target document capture view controller parameters class.

See also
kfxIParameters

Property Documentation

- (BOOL) exitEnabled
readwritenonatomicassign

A boolean value that determines whether exit button is enabled.

The Exit button allows the user to close capture view controller and cancel current operation. Specify YES to make the exit button enabled; otherwise, specify NO to make it disabled. The default value is YES. If the enabled state is NO, the exit button is hidden.

- (BOOL) forceCaptureEnabled
readwritenonatomicassign

A boolean value that determines whether force capture button is enabled.

The Force capture button allows the user to manually capture a photo of the document. Specify YES to make the force capture button enabled; otherwise, specify NO to make it disabled. The default value is YES. If the enabled state is YES capture button is visible depending on manualCaptureTimer timeout.

See also
manualCaptureTimer
- (BOOL) galleryEnabled
readwritenonatomicassign

A boolean value that determines whether gallery button is enabled.

The gallery button launches the native photo gallery to select a photo of the document, instead of capturing it with a camera. Specify YES to make the gallery button enabled; otherwise, specify NO to make it disabled. The default value is NO. If the enabled state is NO, the gallery button is hidden.

- (NSTimeInterval) manualCaptureTimer
readwritenonatomicassign

The number of seconds to show force capture button after presenting capture controller.

If manualCaptureTimer is less than or equal to 0.0 and forceCaptureEnabled state is YES, the force capture button will be shown immediately after presenting capture controller. The default value is 10 seconds. If the forceCaptureEnabled state is NO, the value has no affect.

See also
forceCaptureEnabled
- (BOOL) reviewCapturedImageEnabled
readwritenonatomicassign

A boolean value that determines whether to show captured image review flow.

This flow allows to user visually review the captured photo of the document by choose accept or retake action. The default value is NO, which mean there is no captured image review flow.

- (BOOL) reviewProcessedImageEnabled
readwritenonatomicassign

A boolean value that determines whether to show processed image review flow.

This flow allows to user visually review the processed image by choose accept or retake action. The default value is NO, which mean there is no processed image review flow.

- (kfxTorchMode) torch
readwritenonatomicassign

A torch mode value that determines camera torch behavior.

The supported modes are: kfxTorchMode_Off: Torch is turned off and torch button is visible. kfxTorchMode_On: Torch is turned on and torch button is visible. kfxTorchMode_Auto: Torch will turn on automatically based on curent lighting. Torch button is hidden.

The default value is kfxTorchMode_Auto.

See also
kfxTorchMode

The documentation for this class was generated from the following file:
Untitled Document © 2016 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.