UIButton(WebCache) Category Reference

#import <UIButton+WebCache.h>

Instance Methods
(NSURL *)	- sd_currentImageURL
(NSURL *)	- sd_imageURLForState:
(void)	- sd_setImageWithURL:forState:
(void)	- sd_setImageWithURL:forState:placeholderImage:
(void)	- sd_setImageWithURL:forState:placeholderImage:options:
(void)	- sd_setImageWithURL:forState:completed:
(void)	- sd_setImageWithURL:forState:placeholderImage:completed:
(void)	- sd_setImageWithURL:forState:placeholderImage:options:completed:
(void)	- sd_setBackgroundImageWithURL:forState:
(void)	- sd_setBackgroundImageWithURL:forState:placeholderImage:
(void)	- sd_setBackgroundImageWithURL:forState:placeholderImage:options:
(void)	- sd_setBackgroundImageWithURL:forState:completed:
(void)	- sd_setBackgroundImageWithURL:forState:placeholderImage:completed:
(void)	- sd_setBackgroundImageWithURL:forState:placeholderImage:options:completed:
(void)	- sd_cancelImageLoadForState:
(void)	- sd_cancelBackgroundImageLoadForState:

Detailed Description

Integrates SDWebImage async downloading and caching of remote images with UIButtonView.

Method Documentation

- (void) sd_cancelBackgroundImageLoadForState:

(UIControlState)

state

Cancel the current backgroundImage download

- (void) sd_cancelImageLoadForState:

(UIControlState)

state

Cancel the current image download

- (NSURL *) sd_currentImageURL

Get the current image URL.

- (NSURL *) sd_imageURLForState:

(UIControlState)

state

Get the image URL for a control state.

Parameters

state

Which state you want to know the URL for. The values are described in UIControlState.

- (void) sd_setBackgroundImageWithURL:		(NSURL *)	url
forState:		(UIControlState)	state

Set the backgroundImageView image with an url.

The download is asynchronous and cached.

Parameters

url	The url for the image.
state	The state that uses the specified title. The values are described in UIControlState.

- (void) sd_setBackgroundImageWithURL:		(NSURL *)	url
forState:		(UIControlState)	state
completed:		(SDWebImageCompletionBlock)	completedBlock

Set the backgroundImageView image with an url.

The download is asynchronous and cached.

Parameters

url	The url for the image.
state	The state that uses the specified title. The values are described in UIControlState.
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 retrived from the local cache or from the network. The fourth parameter is the original image url.

- (void) sd_setBackgroundImageWithURL:		(NSURL *)	url
forState:		(UIControlState)	state
placeholderImage:		(UIImage *)	placeholder

Set the backgroundImageView image with an url and a placeholder.

The download is asynchronous and cached.

Parameters

url	The url for the image.
state	The state that uses the specified title. The values are described in UIControlState.
placeholder	The image to be set initially, until the image request finishes.

See also

sd_setImageWithURL:placeholderImage:options:

- (void) sd_setBackgroundImageWithURL:		(NSURL *)	url
forState:		(UIControlState)	state
placeholderImage:		(UIImage *)	placeholder
completed:		(SDWebImageCompletionBlock)	completedBlock

Set the backgroundImageView image with an url, placeholder.

The download is asynchronous and cached.

Parameters

url	The url for the image.
state	The state that uses the specified title. The values are described in UIControlState.
placeholder	The image to be set initially, until the image request finishes.
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 retrived from the local cache or from the network. The fourth parameter is the original image url.

- (void) sd_setBackgroundImageWithURL:		(NSURL *)	url
forState:		(UIControlState)	state
placeholderImage:		(UIImage *)	placeholder
options:		(SDWebImageOptions)	options

Set the backgroundImageView image with an url, placeholder and custom options.

The download is asynchronous and cached.

Parameters

url	The url for the image.
state	The state that uses the specified title. The values are described in UIControlState.
placeholder	The image to be set initially, until the image request finishes.
options	The options to use when downloading the image.

See also

SDWebImageOptions for the possible values.

- (void) sd_setBackgroundImageWithURL:		(NSURL *)	url
forState:		(UIControlState)	state
placeholderImage:		(UIImage *)	placeholder
options:		(SDWebImageOptions)	options
completed:		(SDWebImageCompletionBlock)	completedBlock

Set the backgroundImageView image with an url, placeholder and custom options.

The download is asynchronous and cached.

Parameters

url	The url for the image.
placeholder	The image to be set initially, until the image request finishes.
options	The options to use when downloading the image.

See also

SDWebImageOptions for the possible values.

Parameters

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 retrived from the local cache or from the network. The fourth parameter is the original image url.

- (void) sd_setImageWithURL:		(NSURL *)	url
forState:		(UIControlState)	state

Set the imageView image with an url.

The download is asynchronous and cached.

Parameters

url	The url for the image.
state	The state that uses the specified title. The values are described in UIControlState.

- (void) sd_setImageWithURL:		(NSURL *)	url
forState:		(UIControlState)	state
completed:		(SDWebImageCompletionBlock)	completedBlock

Set the imageView image with an url.

The download is asynchronous and cached.

Parameters

url	The url for the image.
state	The state that uses the specified title. The values are described in UIControlState.
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 retrived from the local cache or from the network. The fourth parameter is the original image url.

- (void) sd_setImageWithURL:		(NSURL *)	url
forState:		(UIControlState)	state
placeholderImage:		(UIImage *)	placeholder

Set the imageView image with an url and a placeholder.

The download is asynchronous and cached.

Parameters

url	The url for the image.
state	The state that uses the specified title. The values are described in UIControlState.
placeholder	The image to be set initially, until the image request finishes.

See also

sd_setImageWithURL:placeholderImage:options:

- (void) sd_setImageWithURL:		(NSURL *)	url
forState:		(UIControlState)	state
placeholderImage:		(UIImage *)	placeholder
completed:		(SDWebImageCompletionBlock)	completedBlock

Set the imageView image with an url, placeholder.

The download is asynchronous and cached.

Parameters

url	The url for the image.
state	The state that uses the specified title. The values are described in UIControlState.
placeholder	The image to be set initially, until the image request finishes.
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 retrived from the local cache or from the network. The fourth parameter is the original image url.

- (void) sd_setImageWithURL:		(NSURL *)	url
forState:		(UIControlState)	state
placeholderImage:		(UIImage *)	placeholder
options:		(SDWebImageOptions)	options

Set the imageView image with an url, placeholder and custom options.

The download is asynchronous and cached.

Parameters

url	The url for the image.
state	The state that uses the specified title. The values are described in UIControlState.
placeholder	The image to be set initially, until the image request finishes.
options	The options to use when downloading the image.

See also

SDWebImageOptions for the possible values.

- (void) sd_setImageWithURL:		(NSURL *)	url
forState:		(UIControlState)	state
placeholderImage:		(UIImage *)	placeholder
options:		(SDWebImageOptions)	options
completed:		(SDWebImageCompletionBlock)	completedBlock

Set the imageView image with an url, placeholder and custom options.

The download is asynchronous and cached.

Parameters

url	The url for the image.
state	The state that uses the specified title. The values are described in UIControlState.
placeholder	The image to be set initially, until the image request finishes.
options	The options to use when downloading the image.

See also

SDWebImageOptions for the possible values.

Parameters

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 retrived from the local cache or from the network. The fourth parameter is the original image url.

---

The documentation for this category was generated from the following files:

• Vendors/SDWebImage/UIButton+WebCache.h
• Vendors/SDWebImage/UIButton+WebCache.m