/*
|
* 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"
|
|
#if SD_UIKIT
|
|
#import "SDWebImageManager.h"
|
|
/**
|
* Integrates SDWebImage async downloading and caching of remote images with UIButton.
|
*/
|
@interface UIButton (WebCache)
|
|
#pragma mark - Image
|
|
/**
|
* Get the current image URL.
|
* This simply translate to `[self sd_imageURLForState:self.state]` from v5.18.0
|
*/
|
@property (nonatomic, strong, readonly, nullable) NSURL *sd_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.
|
*/
|
- (nullable NSURL *)sd_imageURLForState:(UIControlState)state;
|
|
/**
|
* Get the image operation key for a control state.
|
*
|
* @param state Which state you want to know the URL for. The values are described in UIControlState.
|
*/
|
- (nonnull NSString *)sd_imageOperationKeyForState:(UIControlState)state;
|
|
/**
|
* Set the button `image` with an `url`.
|
*
|
* The download 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)sd_setImageWithURL:(nullable NSURL *)url
|
forState:(UIControlState)state NS_REFINED_FOR_SWIFT;
|
|
/**
|
* Set the button `image` with an `url` and a placeholder.
|
*
|
* The download 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 sd_setImageWithURL:placeholderImage:options:
|
*/
|
- (void)sd_setImageWithURL:(nullable NSURL *)url
|
forState:(UIControlState)state
|
placeholderImage:(nullable UIImage *)placeholder NS_REFINED_FOR_SWIFT;
|
|
/**
|
* Set the button `image` with an `url`, placeholder and custom options.
|
*
|
* The download 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)sd_setImageWithURL:(nullable NSURL *)url
|
forState:(UIControlState)state
|
placeholderImage:(nullable UIImage *)placeholder
|
options:(SDWebImageOptions)options NS_REFINED_FOR_SWIFT;
|
|
/**
|
* Set the button `image` with an `url`, placeholder, custom options and context.
|
*
|
* The download 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 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
|
forState:(UIControlState)state
|
placeholderImage:(nullable UIImage *)placeholder
|
options:(SDWebImageOptions)options
|
context:(nullable SDWebImageContext *)context;
|
|
/**
|
* Set the button `image` with an `url`.
|
*
|
* The download 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 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
|
forState:(UIControlState)state
|
completed:(nullable SDExternalCompletionBlock)completedBlock;
|
|
/**
|
* Set the button `image` with an `url`, placeholder.
|
*
|
* The download 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 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
|
forState:(UIControlState)state
|
placeholderImage:(nullable UIImage *)placeholder
|
completed:(nullable SDExternalCompletionBlock)completedBlock NS_REFINED_FOR_SWIFT;
|
|
/**
|
* Set the button `image` with an `url`, placeholder and custom options.
|
*
|
* The download 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 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
|
forState:(UIControlState)state
|
placeholderImage:(nullable UIImage *)placeholder
|
options:(SDWebImageOptions)options
|
completed:(nullable SDExternalCompletionBlock)completedBlock;
|
|
/**
|
* Set the button `image` with an `url`, placeholder and custom options.
|
*
|
* The download 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 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
|
forState:(UIControlState)state
|
placeholderImage:(nullable UIImage *)placeholder
|
options:(SDWebImageOptions)options
|
progress:(nullable SDImageLoaderProgressBlock)progressBlock
|
completed:(nullable SDExternalCompletionBlock)completedBlock;
|
|
/**
|
* Set the button `image` with an `url`, placeholder, custom options and context.
|
*
|
* The download 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 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
|
forState:(UIControlState)state
|
placeholderImage:(nullable UIImage *)placeholder
|
options:(SDWebImageOptions)options
|
context:(nullable SDWebImageContext *)context
|
progress:(nullable SDImageLoaderProgressBlock)progressBlock
|
completed:(nullable SDExternalCompletionBlock)completedBlock;
|
|
#pragma mark - Background Image
|
|
/**
|
* Get the current background image URL.
|
*/
|
@property (nonatomic, strong, readonly, nullable) NSURL *sd_currentBackgroundImageURL;
|
|
/**
|
* Get the background image operation key for a control state.
|
*
|
* @param state Which state you want to know the URL for. The values are described in UIControlState.
|
*/
|
- (nonnull NSString *)sd_backgroundImageOperationKeyForState:(UIControlState)state;
|
|
/**
|
* Get the background image URL for a control state.
|
*
|
* @param state Which state you want to know the URL for. The values are described in UIControlState.
|
*/
|
- (nullable NSURL *)sd_backgroundImageURLForState:(UIControlState)state;
|
|
/**
|
* Set the button `backgroundImage` with an `url`.
|
*
|
* The download 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)sd_setBackgroundImageWithURL:(nullable NSURL *)url
|
forState:(UIControlState)state NS_REFINED_FOR_SWIFT;
|
|
/**
|
* Set the button `backgroundImage` with an `url` and a placeholder.
|
*
|
* The download 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 sd_setImageWithURL:placeholderImage:options:
|
*/
|
- (void)sd_setBackgroundImageWithURL:(nullable NSURL *)url
|
forState:(UIControlState)state
|
placeholderImage:(nullable UIImage *)placeholder NS_REFINED_FOR_SWIFT;
|
|
/**
|
* Set the button `backgroundImage` with an `url`, placeholder and custom options.
|
*
|
* The download 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)sd_setBackgroundImageWithURL:(nullable NSURL *)url
|
forState:(UIControlState)state
|
placeholderImage:(nullable UIImage *)placeholder
|
options:(SDWebImageOptions)options NS_REFINED_FOR_SWIFT;
|
|
/**
|
* Set the button `backgroundImage` with an `url`, placeholder, custom options and context.
|
*
|
* The download 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 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_setBackgroundImageWithURL:(nullable NSURL *)url
|
forState:(UIControlState)state
|
placeholderImage:(nullable UIImage *)placeholder
|
options:(SDWebImageOptions)options
|
context:(nullable SDWebImageContext *)context;
|
|
/**
|
* Set the button `backgroundImage` with an `url`.
|
*
|
* The download 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 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_setBackgroundImageWithURL:(nullable NSURL *)url
|
forState:(UIControlState)state
|
completed:(nullable SDExternalCompletionBlock)completedBlock;
|
|
/**
|
* Set the button `backgroundImage` with an `url`, placeholder.
|
*
|
* The download 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 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_setBackgroundImageWithURL:(nullable NSURL *)url
|
forState:(UIControlState)state
|
placeholderImage:(nullable UIImage *)placeholder
|
completed:(nullable SDExternalCompletionBlock)completedBlock NS_REFINED_FOR_SWIFT;
|
|
/**
|
* Set the button `backgroundImage` 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_setBackgroundImageWithURL:(nullable NSURL *)url
|
forState:(UIControlState)state
|
placeholderImage:(nullable UIImage *)placeholder
|
options:(SDWebImageOptions)options
|
completed:(nullable SDExternalCompletionBlock)completedBlock;
|
|
/**
|
* Set the button `backgroundImage` 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_setBackgroundImageWithURL:(nullable NSURL *)url
|
forState:(UIControlState)state
|
placeholderImage:(nullable UIImage *)placeholder
|
options:(SDWebImageOptions)options
|
progress:(nullable SDImageLoaderProgressBlock)progressBlock
|
completed:(nullable SDExternalCompletionBlock)completedBlock;
|
|
/**
|
* Set the button `backgroundImage` 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_setBackgroundImageWithURL:(nullable NSURL *)url
|
forState:(UIControlState)state
|
placeholderImage:(nullable UIImage *)placeholder
|
options:(SDWebImageOptions)options
|
context:(nullable SDWebImageContext *)context
|
progress:(nullable SDImageLoaderProgressBlock)progressBlock
|
completed:(nullable SDExternalCompletionBlock)completedBlock;
|
|
#pragma mark - Cancel
|
|
/**
|
* Cancel the current image download
|
*/
|
- (void)sd_cancelImageLoadForState:(UIControlState)state;
|
|
/**
|
* Cancel the current backgroundImage download
|
*/
|
- (void)sd_cancelBackgroundImageLoadForState:(UIControlState)state;
|
|
@end
|
|
#endif
|
