AXLoadingViewProtocol

protocol AXLoadingViewProtocol : NSObjectProtocol

AXLoadingViewProtocol

  • Called by the AXPhotoViewController when progress of the image download should be shown to the user.

    Declaration

    Swift

    func startLoading(initialProgress: CGFloat)

    Parameters

    initialProgress

    The current progress of the image download. Exists on a scale from 0..1.
    Show on GitHub

  • Called by the AXPhotoViewController when progress of the image download should be hidden. This usually happens when the containing view controller is moved offscreen.

    Declaration

    Swift

    func stopLoading()
    Show on GitHub

  • Called by the AXPhotoViewController when the progress of an image download is updated. The implementation of this method should reflect the progress of the downloaded image.

    Declaration

    Swift

    func updateProgress(_ progress: CGFloat)

    Parameters

    progress

    The progress complete of the image download. Exists on a scale from 0..1.
    Show on GitHub

  • Called by the AXPhotoViewController when an image download fails. The implementation of this method should display an error to the user, and optionally, offer to retry the image download.

    Declaration

    Swift

    func showError(_ error: Error, retryHandler: @escaping () -> Void)

    Parameters

    error

    The error that the image download failed with.
    retryHandler

    Call this handler to retry the image download.
    Show on GitHub

  • Called by the AXPhotoViewController when an image download is being retried, or the container decides to stop displaying an error to the user.

    Declaration

    Swift

    func removeError()
    Show on GitHub

  • The AXPhotosViewController uses this method to correctly size the loading view for a constrained width.

    Declaration

    Swift

    func sizeThatFits(_ size: CGSize) -> CGSize

    Parameters

    size

    The constrained size. Use the width of this value to layout subviews.

    Return Value

    A size that fits all subviews inside a constrained width.

    Show on GitHub