//
//  PPUiSettings.h
//  PhotoPayFramework
//
//  Created by Jura on 24/02/15.
//  Copyright (c) 2015 MicroBlink Ltd. All rights reserved.
//

#import <Foundation/Foundation.h>
#import <UIKit/UIKit.h>

#import "MBRecognizerCollection.h"
#import "PPMicroBlinkDefines.h"

NS_ASSUME_NONNULL_BEGIN

/**
 * Different options for displaying help
 */
typedef PP_DEPRECATED_IOS(1_0, 5_9) NS_ENUM(NSUInteger, PPHelpDisplayMode) {

    /** Defines that help should never be displayed */
    PPHelpDisplayModeNever,

    /** Defines help should only be displayed on first PhotoPay run */
    PPHelpDisplayModeFirstRun,

    /** Defines help should be displayed on every PhotoPay run */
    PPHelpDisplayModeAlways
};

/**
 * Settings class containing UI information
 */
PP_CLASS_AVAILABLE_IOS(6.0)
@interface MBUiSettings : NSObject <NSCopying>

/**
 * If YES, tooltip limited license key warning messages will appear on screen
 *
 * Default: YES.
 */
@property (nonatomic, assign) BOOL showLicenseKeyTimeLimitedWarning;

/**
 * If YES, default camera overlay will display Cancel button.
 * Usually, if camera is displayed inside Navigation View Controler, this is reasonable to set to NO.
 *
 * Default: YES.
 */
@property (nonatomic, assign) BOOL showCloseButton;

/**
 * If YES, default camera overlay will display Torch button.
 * Usually, if camera is displayed inside Navigation View Controler, this is reasonable to set to NO.
 *
 * Default: YES.
 */
@property (nonatomic, assign) BOOL showTorchButton;

/**
 * If YES, default camera overlay will display Status bar.
 * Usually, if camera is displayed inside Navigation View Controler, this is reasonable to set to YES.
 *
 * Default: NO.
 */
@property (nonatomic, assign) BOOL showStatusBar;

/**
 * If YES, Overlay View Controller will be autorotated independently of ScanningViewController.
 *
 * Default: NO.
 */
@property (nonatomic, assign) BOOL autorotateOverlay;

/**
 * If YES, OCR results will be passed to the UI callbacks. For you, this means OCR effects will be shown on screen.
 *
 * Default: YES. Use NO if you care about scanning speed.
 */
@property (nonatomic, assign) BOOL showOcrResults;

/**
 * Settings to control scanning.
 *
 * Here you need to define what type of scanning will be performed on video frames.
 * You can do that by adding different PPRecognizerSettings object.
 *
 * Each PPRecognizerSettings object initializes one Recognizer object which is then responsible for performing
 * recognition on each video frame
 *
 * @see PPRecognizerSettings
 */
@property (nonatomic) MBRecognizerCollection *recognizerCollection;

/**
 * If default overlay contains textual information, text will be localized to this language
 *
 * Default: nil, because it uses default language of the device
 */
@property (nonatomic, strong, nullable) NSString *language;

/**
 * Full path to the sound file which is played when the valid result is scanned.
 *
 * Default: `[bundle pathForResource:@"PPbeep" ofType:@"wav"];`, where bundle is either Microblink.bundle, or bundle used by PPSettings
 */
@property (nonatomic, strong, nullable) NSString *soundFilePath;

/**
 * Label which is displayed on screen when camera is paused, but still exists on the screen.
 *
 * This happens in split view and slide over modes in iOS 9.
 *
 * The view is centered on screen and displayed with a 0.4s fade in animation. It's dismissed with 0.4s
 * fade out animation.
 *
 * Default:
 *     UILabel *cameraPausedLabel = [[UILabel alloc] init];
 *     cameraPausedLabel.text = @"Camera paused";
 *     cameraPausedLabel.font = [UIFont systemFontOfSize:24.f];
 *     cameraPausedLabel.textColor = [UIColor whiteColor];
 *     cameraPausedLabel.layer.shadowRadius = 5.0f;
 *     cameraPausedLabel.layer.shadowOffset = CGSizeMake(1.0, 1.0);
 *     cameraPausedLabel.layer.shadowOpacity = 1.0f;
 *     cameraPausedLabel.layer.shadowColor = [UIColor blackColor].CGColor;
 *     [cameraPausedLabel sizeToFit];
 */
@property (nonatomic, strong, nullable) UIView *cameraPausedView;


/**
 * If YES, debug information will be displayed on the information.
 * Debug information displays payslip detection duration and recognition duration.
 *
 * Default: NO
 */
@property (nonatomic, assign) BOOL displayDebugInfo;

/**
 * If Scanning UI has Help UI available, this enum defines the mode in which the help is displayed.
 *
 * Default: PPHelpDisplayModeFirstRun
 */
@property (nonatomic, assign) PPHelpDisplayMode helpDisplayMode PP_DEPRECATED_IOS(1_0, 5_9, "Perform manual help display in your app");


/**
 * Initializes the object with default settings (see above for defaults).
 *
 *  @return object initialized with default values.
 */
- (instancetype)init;

/**
 * Designated initializer. Initializes the object with default settings (see above for defaults).
 *
 * Also receives a path to the sound file used when scanning finishes successfully
 *
 *  @return object initialized with default values.
 */
- (instancetype)initWithSoundFilePath:(nullable NSString *)soundFilePath NS_DESIGNATED_INITIALIZER;

@end

NS_ASSUME_NONNULL_END