FrameToolControllerOptions

@objc(IMGLYFrameToolControllerOptions) open class FrameToolControllerOptions: ToolControllerOptions

Options for configuring a FrameToolController.

  • This closure is called when the user selects a frame. The closure is passed nil when no frame was selected.

    Declaration

    Swift

    open let selectedFrameClosure: ((Frame?) -> Void)?

  • The tolerance that is used to pick the correct frame image based on the aspect ratio. Defaults to 0.1.

    Declaration

    Swift

    open let tolerance: CGFloat

  • This closure allows further customization of the ‘No Frame’ cell.

    Declaration

    Swift

    open let noFrameCellConfigurationClosure: ((IconCaptionCollectionViewCell) -> Void)?

  • This closure allows further customization of the cells of a frame.

    Declaration

    Swift

    open let frameCellConfigurationClosure: ((IconBorderedCollectionViewCell, Frame) -> Void)?

  • This closure is called when installing the frame data source. You can use it to save a reference to the frame data source.

    Declaration

    Swift

    open let frameDataSourceConfigurationClosure: ((FrameDataSource) -> Void)?

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

    Declaration

    Swift

    open let overlayButtonConfigurationClosure: ((OverlayButton, FrameOverlayAction) -> Void)?

  • Defines all allowed actions. Only buttons for allowed actions are visible. Defaults to show all available actions. To set this property from Obj-C, see the allowedFrameOverlayActionsAsNSNumbers property.

    Declaration

    Swift

    open let allowedFrameOverlayActions: [FrameOverlayAction]

  • This closure is called when the user selects an action.

    Declaration

    Swift

    open let frameOverlayActionSelectedClosure: ((FrameOverlayAction) -> Void)?

  • Creates a newly allocated instance of FrameToolControllerOptions using the default builder.

    Declaration

    Swift

    public convenience init()

  • Creates a newly allocated instance of FrameToolControllerOptions using the given builder.

    Declaration

    Swift

    public init(builder: FrameToolControllerOptionsBuilder)

    Parameters

    builder

    A FrameToolControllerOptionsBuilder instance.