73 lines
2.4 KiB
Objective-C
73 lines
2.4 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 <Foundation/Foundation.h>
|
|
#import "SDWebImageCompat.h"
|
|
#import "SDWebImageDefine.h"
|
|
|
|
@class SDWebImageOptionsResult;
|
|
|
|
typedef SDWebImageOptionsResult * _Nullable(^SDWebImageOptionsProcessorBlock)(NSURL * _Nullable url, SDWebImageOptions options, SDWebImageContext * _Nullable context);
|
|
|
|
/**
|
|
The options result contains both options and context.
|
|
*/
|
|
@interface SDWebImageOptionsResult : NSObject
|
|
|
|
/**
|
|
WebCache options.
|
|
*/
|
|
@property (nonatomic, assign, readonly) SDWebImageOptions options;
|
|
|
|
/**
|
|
Context options.
|
|
*/
|
|
@property (nonatomic, copy, readonly, nullable) SDWebImageContext *context;
|
|
|
|
/**
|
|
Create a new options result.
|
|
|
|
@param options options
|
|
@param context context
|
|
@return The options result contains both options and context.
|
|
*/
|
|
- (nonnull instancetype)initWithOptions:(SDWebImageOptions)options context:(nullable SDWebImageContext *)context;
|
|
|
|
@end
|
|
|
|
/**
|
|
This is the protocol for options processor.
|
|
Options processor can be used, to control the final result for individual image request's `SDWebImageOptions` and `SDWebImageContext`
|
|
Implements the protocol to have a global control for each indivadual image request's option.
|
|
*/
|
|
@protocol SDWebImageOptionsProcessor <NSObject>
|
|
|
|
/**
|
|
Return the processed options result for specify image URL, with its options and context
|
|
|
|
@param url The URL to the image
|
|
@param options A mask to specify options to use for this request
|
|
@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.
|
|
@return The processed result, contains both options and context
|
|
*/
|
|
- (nullable SDWebImageOptionsResult *)processedResultForURL:(nullable NSURL *)url
|
|
options:(SDWebImageOptions)options
|
|
context:(nullable SDWebImageContext *)context;
|
|
|
|
@end
|
|
|
|
/**
|
|
A options processor class with block.
|
|
*/
|
|
@interface SDWebImageOptionsProcessor : NSObject<SDWebImageOptionsProcessor>
|
|
|
|
- (nonnull instancetype)initWithBlock:(nonnull SDWebImageOptionsProcessorBlock)block;
|
|
+ (nonnull instancetype)optionsProcessorWithBlock:(nonnull SDWebImageOptionsProcessorBlock)block;
|
|
|
|
@end
|