170 lines
8.6 KiB
Objective-C
170 lines
8.6 KiB
Objective-C
//
|
|
// SVGKImageView+WebCache.h
|
|
// SDWebImageSVGPlugin
|
|
//
|
|
// Created by DreamPiggy on 2018/10/10.
|
|
//
|
|
|
|
#import <SVGKit/SVGKit.h>
|
|
#import "SDWebImageSVGKitDefine.h"
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
@interface SVGKImageView (WebCache)
|
|
|
|
/**
|
|
* Unlike `UIView`, `SVGKImageView`'s subclass does not follows `UIView.contentMode` property, the position of SVG vector image is controled by `SVGKImage` instance with SVG's viewport && viewbox information. You can adjust it after image was loading, however it's not so convenient.
|
|
* So we provide a simple solution. If you want the same behavior like UIImageView to use `contentMode` property to position SVG images, set this value to YES and we'll resize the SVG image to correspond `contentMode` of `SVGKImageView` during image loading.
|
|
*/
|
|
@property (nonatomic, assign) BOOL sd_adjustContentMode API_UNAVAILABLE(macos);
|
|
|
|
/**
|
|
* Set the imageView `image` with an `url`.
|
|
*
|
|
* The download is asynchronous and cached.
|
|
*
|
|
* @param url The url for the image.
|
|
*/
|
|
- (void)sd_setImageWithURL:(nullable NSURL *)url NS_REFINED_FOR_SWIFT;
|
|
|
|
/**
|
|
* Set the imageView `image` with an `url` and a placeholder.
|
|
*
|
|
* The download is asynchronous and cached.
|
|
*
|
|
* @param url The url for the image.
|
|
* @param placeholder The image to be set initially, until the image request finishes.
|
|
* @see sd_setImageWithURL:placeholderImage:options:
|
|
*/
|
|
- (void)sd_setImageWithURL:(nullable NSURL *)url
|
|
placeholderImage:(nullable UIImage *)placeholder NS_REFINED_FOR_SWIFT;
|
|
|
|
/**
|
|
* Set the imageView `image` with an `url`, placeholder and custom options.
|
|
*
|
|
* The download is asynchronous and cached.
|
|
*
|
|
* @param url The url for the image.
|
|
* @param placeholder The image to be set initially, until the image request finishes.
|
|
* @param options The options to use when downloading the image. @see SDWebImageOptions for the possible values.
|
|
*/
|
|
- (void)sd_setImageWithURL:(nullable NSURL *)url
|
|
placeholderImage:(nullable UIImage *)placeholder
|
|
options:(SDWebImageOptions)options NS_REFINED_FOR_SWIFT;
|
|
|
|
/**
|
|
* Set the imageView `image` with an `url`, placeholder, custom options and context.
|
|
*
|
|
* The download is asynchronous and cached.
|
|
*
|
|
* @param url The url for the image.
|
|
* @param placeholder The image to be set initially, until the image request finishes.
|
|
* @param options The options to use when downloading the image. @see SDWebImageOptions for the possible values.
|
|
* @param context A context contains different options to perform specify changes or processes, see `SDWebImageContextOption`. This hold the extra objects which `options` enum can not hold.
|
|
*/
|
|
- (void)sd_setImageWithURL:(nullable NSURL *)url
|
|
placeholderImage:(nullable UIImage *)placeholder
|
|
options:(SDWebImageOptions)options
|
|
context:(nullable SDWebImageContext *)context;
|
|
|
|
/**
|
|
* Set the imageView `image` with an `url`.
|
|
*
|
|
* The download is asynchronous and cached.
|
|
*
|
|
* @param url The url for the image.
|
|
* @param completedBlock A block called when operation has been completed. This block has no return value
|
|
* and takes the requested UIImage as first parameter. In case of error the image parameter
|
|
* is nil and the second parameter may contain an NSError. The third parameter is a Boolean
|
|
* indicating if the image was retrieved from the local cache or from the network.
|
|
* The fourth parameter is the original image url.
|
|
*/
|
|
- (void)sd_setImageWithURL:(nullable NSURL *)url
|
|
completed:(nullable SDExternalCompletionBlock)completedBlock;
|
|
|
|
/**
|
|
* Set the imageView `image` with an `url`, placeholder.
|
|
*
|
|
* The download is asynchronous and cached.
|
|
*
|
|
* @param url The url for the image.
|
|
* @param placeholder The image to be set initially, until the image request finishes.
|
|
* @param completedBlock A block called when operation has been completed. This block has no return value
|
|
* and takes the requested UIImage as first parameter. In case of error the image parameter
|
|
* is nil and the second parameter may contain an NSError. The third parameter is a Boolean
|
|
* indicating if the image was retrieved from the local cache or from the network.
|
|
* The fourth parameter is the original image url.
|
|
*/
|
|
- (void)sd_setImageWithURL:(nullable NSURL *)url
|
|
placeholderImage:(nullable UIImage *)placeholder
|
|
completed:(nullable SDExternalCompletionBlock)completedBlock NS_REFINED_FOR_SWIFT;
|
|
|
|
/**
|
|
* Set the imageView `image` with an `url`, placeholder and custom options.
|
|
*
|
|
* The download is asynchronous and cached.
|
|
*
|
|
* @param url The url for the image.
|
|
* @param placeholder The image to be set initially, until the image request finishes.
|
|
* @param options The options to use when downloading the image. @see SDWebImageOptions for the possible values.
|
|
* @param completedBlock A block called when operation has been completed. This block has no return value
|
|
* and takes the requested UIImage as first parameter. In case of error the image parameter
|
|
* is nil and the second parameter may contain an NSError. The third parameter is a Boolean
|
|
* indicating if the image was retrieved from the local cache or from the network.
|
|
* The fourth parameter is the original image url.
|
|
*/
|
|
- (void)sd_setImageWithURL:(nullable NSURL *)url
|
|
placeholderImage:(nullable UIImage *)placeholder
|
|
options:(SDWebImageOptions)options
|
|
completed:(nullable SDExternalCompletionBlock)completedBlock;
|
|
|
|
/**
|
|
* Set the imageView `image` with an `url`, placeholder and custom options.
|
|
*
|
|
* The download is asynchronous and cached.
|
|
*
|
|
* @param url The url for the image.
|
|
* @param placeholder The image to be set initially, until the image request finishes.
|
|
* @param options The options to use when downloading the image. @see SDWebImageOptions for the possible values.
|
|
* @param progressBlock A block called while image is downloading
|
|
* @note the progress block is executed on a background queue
|
|
* @param completedBlock A block called when operation has been completed. This block has no return value
|
|
* and takes the requested UIImage as first parameter. In case of error the image parameter
|
|
* is nil and the second parameter may contain an NSError. The third parameter is a Boolean
|
|
* indicating if the image was retrieved from the local cache or from the network.
|
|
* The fourth parameter is the original image url.
|
|
*/
|
|
- (void)sd_setImageWithURL:(nullable NSURL *)url
|
|
placeholderImage:(nullable UIImage *)placeholder
|
|
options:(SDWebImageOptions)options
|
|
progress:(nullable SDImageLoaderProgressBlock)progressBlock
|
|
completed:(nullable SDExternalCompletionBlock)completedBlock;
|
|
|
|
/**
|
|
* Set the imageView `image` with an `url`, placeholder, custom options and context.
|
|
*
|
|
* The download is asynchronous and cached.
|
|
*
|
|
* @param url The url for the image.
|
|
* @param placeholder The image to be set initially, until the image request finishes.
|
|
* @param options The options to use when downloading the image. @see SDWebImageOptions for the possible values.
|
|
* @param context A context contains different options to perform specify changes or processes, see `SDWebImageContextOption`. This hold the extra objects which `options` enum can not hold.
|
|
* @param progressBlock A block called while image is downloading
|
|
* @note the progress block is executed on a background queue
|
|
* @param completedBlock A block called when operation has been completed. This block has no return value
|
|
* and takes the requested UIImage as first parameter. In case of error the image parameter
|
|
* is nil and the second parameter may contain an NSError. The third parameter is a Boolean
|
|
* indicating if the image was retrieved from the local cache or from the network.
|
|
* The fourth parameter is the original image url.
|
|
*/
|
|
- (void)sd_setImageWithURL:(nullable NSURL *)url
|
|
placeholderImage:(nullable UIImage *)placeholder
|
|
options:(SDWebImageOptions)options
|
|
context:(nullable SDWebImageContext *)context
|
|
progress:(nullable SDImageLoaderProgressBlock)progressBlock
|
|
completed:(nullable SDExternalCompletionBlock)completedBlock;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|