mirror of
https://github.com/SDWebImage/SDWebImage.git
synced 2026-04-07 19:27:40 +00:00
DreamPiggy
a986a77734
Key idea: 1. Image Loading pipeline is based on `operation key`, when start/cancel it always need operation key 2. Stateful view has multiple operation key for different image property, we can use KeyPath as the hint to generate operation key 3. To make exists API compatible, we do not change much, however, in 6.0 we may do refactory and store all the loadState/operation/result into the single object, instead of 3
210 lines
9.5 KiB
Objective-C
210 lines
9.5 KiB
Objective-C
/*
|
|
* This file is part of the SDWebImage package.
|
|
* (c) Olivier Poitrey <rs@dailymotion.com>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
#import "SDWebImageCompat.h"
|
|
#import "SDWebImageManager.h"
|
|
|
|
/**
|
|
* Usage with a UITableViewCell sub-class:
|
|
*
|
|
* @code
|
|
|
|
#import <SDWebImage/UIImageView+WebCache.h>
|
|
|
|
...
|
|
|
|
- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath
|
|
{
|
|
static NSString *MyIdentifier = @"MyIdentifier";
|
|
|
|
UITableViewCell *cell = [tableView dequeueReusableCellWithIdentifier:MyIdentifier];
|
|
|
|
if (cell == nil) {
|
|
cell = [[UITableViewCell alloc] initWithStyle:UITableViewCellStyleDefault reuseIdentifier:MyIdentifier];
|
|
}
|
|
|
|
// Here we use the provided sd_setImageWithURL:placeholderImage: method to load the web image
|
|
// Ensure you use a placeholder image otherwise cells will be initialized with no image
|
|
[cell.imageView sd_setImageWithURL:[NSURL URLWithString:@"http://example.com/image.jpg"]
|
|
placeholderImage:[UIImage imageNamed:@"placeholder"]];
|
|
|
|
cell.textLabel.text = @"My Text";
|
|
return cell;
|
|
}
|
|
|
|
* @endcode
|
|
*/
|
|
|
|
/**
|
|
* Integrates SDWebImage async downloading and caching of remote images with UIImageView.
|
|
*/
|
|
@interface UIImageView (WebCache)
|
|
|
|
#pragma mark - Image State
|
|
|
|
/**
|
|
* Get the current image URL.
|
|
*/
|
|
@property (nonatomic, strong, readonly, nullable) NSURL *sd_currentImageURL;
|
|
|
|
#pragma mark - Image Loading
|
|
|
|
/**
|
|
* 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;
|
|
|
|
/**
|
|
* Cancel the current normal image load (for `UIImageView.image`)
|
|
* @note For highlighted image, use `sd_cancelCurrentHighlightedImageLoad`
|
|
*/
|
|
- (void)sd_cancelCurrentImageLoad;
|
|
|
|
@end
|