TooltipsManagerType

public protocol TooltipsManagerType

Protocol for tooltip managers.

  • Returns whether a tooltip is currently visible on screen.

    Declaration

    Swift

    var isTooltipVisible: Bool { get }

  • Returns true if an active CustomTooltipHandlerType is currently using this tooltips manager service.

    If true, calls to tooltip management methods are ignored until the custom tooltip handler revokes its exclusive access or it’s ARC lifetime ends.

    Declaration

    Swift

    var hasCustomTooltipActive: Bool { get }

  • Returns whether a given view is a tooltip view, or contained within a tooltip view’s hierarchy.

    Declaration

    Swift

    func isInTooltipView(_ view: View) -> Bool

  • Hides the currently displayed tooltip.

    Declaration

    Swift

    func hideTooltip()

  • Shows a provided tooltip.

    Declaration

    Swift

    func showTooltip(_ tooltip: Tooltip, view: View, location: PreferredTooltipLocation)

  • Updates the contents of the currently displayed tooltip.

    Declaration

    Swift

    func updateTooltip(_ tooltip: Tooltip)

  • Starts a custom tooltip display mode where the caller has exclusive access to the tooltip control until it is either revoked or the lifetime of the returned CustomTooltipHandlerType reaches its end.

    Method returns nil if another custom tooltip handler is already active.

    Declaration

    Swift

    func beginCustomTooltipLifetime() -> CustomTooltipHandlerType?