192 lines
8.8 KiB
Objective-C
192 lines
8.8 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"
|
|
|
|
/**
|
|
* Integrates SDWebImage async downloading and caching of remote images with UIButtonView.
|
|
*/
|
|
@interface UIButton (WebCache)
|
|
|
|
/**
|
|
* Get the current image URL.
|
|
*/
|
|
- (NSURL *)currentImageURL;
|
|
|
|
/**
|
|
* Get the image URL for a control state.
|
|
*
|
|
* @param state Which state you want to know the URL for. The values are described in UIControlState.
|
|
*/
|
|
- (NSURL *)imageURLForState:(UIControlState)state;
|
|
|
|
/**
|
|
* Set the imageView `image` with an `url`.
|
|
*
|
|
* The downloand is asynchronous and cached.
|
|
*
|
|
* @param url The url for the image.
|
|
* @param state The state that uses the specified title. The values are described in UIControlState.
|
|
*/
|
|
- (void)setImageWithURL:(NSURL *)url forState:(UIControlState)state;
|
|
|
|
/**
|
|
* Set the imageView `image` with an `url` and a placeholder.
|
|
*
|
|
* The downloand is asynchronous and cached.
|
|
*
|
|
* @param url The url for the image.
|
|
* @param state The state that uses the specified title. The values are described in UIControlState.
|
|
* @param placeholder The image to be set initially, until the image request finishes.
|
|
* @see setImageWithURL:placeholderImage:options:
|
|
*/
|
|
- (void)setImageWithURL:(NSURL *)url forState:(UIControlState)state placeholderImage:(UIImage *)placeholder;
|
|
|
|
/**
|
|
* Set the imageView `image` with an `url`, placeholder and custom options.
|
|
*
|
|
* The downloand is asynchronous and cached.
|
|
*
|
|
* @param url The url for the image.
|
|
* @param state The state that uses the specified title. The values are described in UIControlState.
|
|
* @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)setImageWithURL:(NSURL *)url forState:(UIControlState)state placeholderImage:(UIImage *)placeholder options:(SDWebImageOptions)options;
|
|
|
|
/**
|
|
* Set the imageView `image` with an `url`.
|
|
*
|
|
* The downloand is asynchronous and cached.
|
|
*
|
|
* @param url The url for the image.
|
|
* @param state The state that uses the specified title. The values are described in UIControlState.
|
|
* @param completedBlock A block called when operation has been completed. This block as 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 retrived from the local cache of from the network.
|
|
*/
|
|
- (void)setImageWithURL:(NSURL *)url forState:(UIControlState)state completed:(SDWebImageCompletedBlock)completedBlock;
|
|
|
|
/**
|
|
* Set the imageView `image` with an `url`, placeholder.
|
|
*
|
|
* The downloand is asynchronous and cached.
|
|
*
|
|
* @param url The url for the image.
|
|
* @param state The state that uses the specified title. The values are described in UIControlState.
|
|
* @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 as 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 retrived from the local cache of from the network.
|
|
*/
|
|
- (void)setImageWithURL:(NSURL *)url forState:(UIControlState)state placeholderImage:(UIImage *)placeholder completed:(SDWebImageCompletedBlock)completedBlock;
|
|
|
|
/**
|
|
* Set the imageView `image` with an `url`, placeholder and custom options.
|
|
*
|
|
* The downloand is asynchronous and cached.
|
|
*
|
|
* @param url The url for the image.
|
|
* @param state The state that uses the specified title. The values are described in UIControlState.
|
|
* @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 as 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 retrived from the local cache of from the network.
|
|
*/
|
|
- (void)setImageWithURL:(NSURL *)url forState:(UIControlState)state placeholderImage:(UIImage *)placeholder options:(SDWebImageOptions)options completed:(SDWebImageCompletedBlock)completedBlock;
|
|
|
|
/**
|
|
* Set the backgroundImageView `image` with an `url`.
|
|
*
|
|
* The downloand is asynchronous and cached.
|
|
*
|
|
* @param url The url for the image.
|
|
* @param state The state that uses the specified title. The values are described in UIControlState.
|
|
*/
|
|
- (void)setBackgroundImageWithURL:(NSURL *)url forState:(UIControlState)state;
|
|
|
|
/**
|
|
* Set the backgroundImageView `image` with an `url` and a placeholder.
|
|
*
|
|
* The downloand is asynchronous and cached.
|
|
*
|
|
* @param url The url for the image.
|
|
* @param state The state that uses the specified title. The values are described in UIControlState.
|
|
* @param placeholder The image to be set initially, until the image request finishes.
|
|
* @see setImageWithURL:placeholderImage:options:
|
|
*/
|
|
- (void)setBackgroundImageWithURL:(NSURL *)url forState:(UIControlState)state placeholderImage:(UIImage *)placeholder;
|
|
|
|
/**
|
|
* Set the backgroundImageView `image` with an `url`, placeholder and custom options.
|
|
*
|
|
* The downloand is asynchronous and cached.
|
|
*
|
|
* @param url The url for the image.
|
|
* @param state The state that uses the specified title. The values are described in UIControlState.
|
|
* @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)setBackgroundImageWithURL:(NSURL *)url forState:(UIControlState)state placeholderImage:(UIImage *)placeholder options:(SDWebImageOptions)options;
|
|
|
|
/**
|
|
* Set the backgroundImageView `image` with an `url`.
|
|
*
|
|
* The downloand is asynchronous and cached.
|
|
*
|
|
* @param url The url for the image.
|
|
* @param state The state that uses the specified title. The values are described in UIControlState.
|
|
* @param completedBlock A block object to be executed after the request operation
|
|
* completed. This block has no return value and takes three argument: the requested
|
|
* `UIImage` object, the `NSError` object describing error that occurred, and an
|
|
* `SDImageCacheType` enum describing the source of the image obtained from.
|
|
*/
|
|
- (void)setBackgroundImageWithURL:(NSURL *)url forState:(UIControlState)state completed:(SDWebImageCompletedBlock)completedBlock;
|
|
|
|
/**
|
|
* Set the backgroundImageView `image` with an `url`, placeholder.
|
|
*
|
|
* The downloand is asynchronous and cached.
|
|
*
|
|
* @param url The url for the image.
|
|
* @param state The state that uses the specified title. The values are described in UIControlState.
|
|
* @param placeholder The image to be set initially, until the image request finishes.
|
|
* @param completedBlock A block object to be executed after the request operation
|
|
* completed. This block has no return value and takes three argument: the requested
|
|
* `UIImage` object, the `NSError` object describing error that occurred, and an
|
|
* `SDImageCacheType` enum describing the source of the image obtained from.
|
|
*/
|
|
- (void)setBackgroundImageWithURL:(NSURL *)url forState:(UIControlState)state placeholderImage:(UIImage *)placeholder completed:(SDWebImageCompletedBlock)completedBlock;
|
|
|
|
/**
|
|
* Set the backgroundImageView `image` with an `url`, placeholder and custom options.
|
|
*
|
|
* The downloand 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 object to be executed after the request operation
|
|
* completed. This block has no return value and takes three argument: the requested
|
|
* `UIImage` object, the `NSError` object describing error that occurred, and an
|
|
* `SDImageCacheType` enum describing the source of the image obtained from.
|
|
*/
|
|
- (void)setBackgroundImageWithURL:(NSURL *)url forState:(UIControlState)state placeholderImage:(UIImage *)placeholder options:(SDWebImageOptions)options completed:(SDWebImageCompletedBlock)completedBlock;
|
|
|
|
/**
|
|
* Cancel the current download
|
|
*/
|
|
- (void)cancelCurrentImageLoad;
|
|
|
|
@end
|