FocusToolControllerOptions

@available(iOS 9.0, *)
@objcMembers
@objc(PESDKFocusToolControllerOptions)
open class FocusToolControllerOptions : ToolControllerOptions

Options for configuring a FocusToolController.

  • Defines all allowed focus types. The focus buttons are shown in the given order. Defaults to show all available modes. The .Off type is always added. To set this property from Obj-C, see the allowedFocusTypesAsNSNumbers property.

    Declaration

    Swift

    @available(*, deprecated, message: "Use `allowedFocusModes` instead.")
public var allowedFocusTypes: [FocusType] { get }

  • Defines all allowed focus modes. The focus buttons are shown in the given order. Defaults to show all available modes. The .off mode is always added. To set this property from Obj-C, see the allowedFocusModesAsNSNumbers property.

    Declaration

    Swift

    public let allowedFocusModes: [FocusMode]

  • This closure allows further configuration of the focus type buttons. The closure is called for each focus type button and has the button and its corresponding focus type as parameters.

    Declaration

    Swift

    @available(*, deprecated, message: "Use `focusModeButtonConfigurationClosure` instead.")
public var focusTypeButtonConfigurationClosure: ((IconCaptionCollectionViewCell, FocusType) -> Void)? { get }

  • This closure allows further configuration of the focus mode buttons. The closure is called for each focus mode button and has the button and its corresponding focus mode as parameters.

    Declaration

    Swift

    public let focusModeButtonConfigurationClosure: ((IconCaptionCollectionViewCell, FocusMode) -> Void)?

  • This closure is called when the user selects a focus type.

    Declaration

    Swift

    @available(*, deprecated, message: "Use `focusModeSelectedClosure` instead.")
public var focusTypeSelectedClosure: ((FocusType) -> Void)? { get }

  • This closure is called when the user selects a focus mode.

    Declaration

    Swift

    public let focusModeSelectedClosure: ((FocusMode) -> Void)?

  • This closure can be used to configure the slider.

    Declaration

    Swift

    public let sliderConfigurationClosure: ((Slider) -> Void)?

  • This closure can be used to configure the view that contains the slider.

    Declaration

    Swift

    public let sliderContainerConfigurationClosure: ViewConfigurationClosure?

  • This closure is called whenever the slider changes its value. The instance of Slider and the active focus type are passed as parameters.

    Declaration

    Swift

    @available(*, deprecated, message: "Use `sliderUpdatedValueClosure` instead.")
public var sliderChangedValueClosure: ((Slider, FocusType) -> Void)? { get }

  • This closure is called whenever the slider changes its value. The instance of Slider and the active focus mode are passed as parameters.

    Declaration

    Swift

    public let sliderUpdatedValueClosure: ((Slider, FocusMode) -> Void)?

  • This closure can be used to configure the circle gradient view.

    Declaration

    Swift

    public let circleGradientViewConfigurationClosure: ((CircleGradientView) -> Void)?

  • This closure can be used to configure the box gradient view.

    Declaration

    Swift

    public let boxGradientViewConfigurationClosure: ((BoxGradientView) -> Void)?

  • Creates a new instance of FocusToolControllerOptions using the given builder.

    Declaration

    Swift

    public init(builder: FocusToolControllerOptionsBuilder)

    Parameters

    builder