FocusToolControllerOptions

@objc(IMGLYFocusToolControllerOptions) 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

    open let allowedFocusTypes: [FocusType]

  • 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

    open let focusTypeButtonConfigurationClosure: ((IconCaptionCollectionViewCell, FocusType) -> Void)?

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

    Declaration

    Swift

    open let focusTypeSelectedClosure: ((FocusType) -> Void)?

  • This closure can be used to configure the slider.

    Declaration

    Swift

    open let sliderConfigurationClosure: SliderConfigurationClosure?

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

    Declaration

    Swift

    open 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

    open let sliderChangedValueClosure: ((Slider, FocusType) -> Void)?

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

    Declaration

    Swift

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

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

    Declaration

    Swift

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

  • Returns a newly allocated instance of a FocusToolControllerOptions using the default builder.

    Declaration

    Swift

    public convenience init()

    Return Value

    An instance of a FocusToolControllerOptions.

  • Returns a newly allocated instance of a FocusToolControllerOptions using the given builder.

    Declaration

    Swift

    public init(builder: FocusToolControllerOptionsBuilder)

    Parameters

    builder

    A FocusToolControllerOptionsBuilder instance.

    Return Value

    An instance of a FocusToolControllerOptions.