forked from pinterest/PINRemoteImage
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathPINRemoteImageCategoryManager.h
361 lines (271 loc) · 17 KB
/
PINRemoteImageCategoryManager.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
//
// PINRemoteImageCategory.h
// Pods
//
// Created by Garrett Moon on 11/4/14.
//
//
#import <UIKit/UIKit.h>
#import "PINRemoteImageManager.h"
@protocol PINRemoteImageCategory;
/**
PINRemoteImageCategoryManager is a class that handles subclassing image display classes. UIImage+PINRemoteImage, UIButton+PINRemoteImage, etc, all delegate their work to this class. If you'd like to create a category to display an image on a view, you should mimic one of the above categories.
*/
@interface PINRemoteImageCategoryManager : NSObject
+ (void)setImageOnView:(id <PINRemoteImageCategory>)view
fromURL:(NSURL *)url;
+ (void)setImageOnView:(id <PINRemoteImageCategory>)view
fromURL:(NSURL *)url
placeholderImage:(UIImage *)placeholderImage;
+ (void)setImageOnView:(id <PINRemoteImageCategory>)view
fromURL:(NSURL *)url
placeholderImage:(UIImage *)placeholderImage
completion:(PINRemoteImageManagerImageCompletion)completion;
+ (void)setImageOnView:(id <PINRemoteImageCategory>)view
fromURL:(NSURL *)url
completion:(PINRemoteImageManagerImageCompletion)completion;
+ (void)setImageOnView:(id <PINRemoteImageCategory>)view
fromURL:(NSURL *)url
processorKey:(NSString *)processorKey
processor:(PINRemoteImageManagerImageProcessor)processor;
+ (void)setImageOnView:(id <PINRemoteImageCategory>)view
fromURL:(NSURL *)url
placeholderImage:(UIImage *)placeholderImage
processorKey:(NSString *)processorKey
processor:(PINRemoteImageManagerImageProcessor)processor;
+ (void)setImageOnView:(id <PINRemoteImageCategory>)view
fromURL:(NSURL *)url
processorKey:(NSString *)processorKey
processor:(PINRemoteImageManagerImageProcessor)processor
completion:(PINRemoteImageManagerImageCompletion)completion;
+ (void)setImageOnView:(id <PINRemoteImageCategory>)view
fromURLs:(NSArray *)urls
placeholderImage:(UIImage *)placeholderImage
processorKey:(NSString *)processorKey
processor:(PINRemoteImageManagerImageProcessor)processor
completion:(PINRemoteImageManagerImageCompletion)completion;
+ (void)setImageOnView:(id <PINRemoteImageCategory>)view
fromURLs:(NSArray *)urls;
+ (void)setImageOnView:(id <PINRemoteImageCategory>)view
fromURLs:(NSArray *)urls
placeholderImage:(UIImage *)placeholderImage;
+ (void)setImageOnView:(id <PINRemoteImageCategory>)view
fromURLs:(NSArray *)urls
placeholderImage:(UIImage *)placeholderImage
completion:(PINRemoteImageManagerImageCompletion)completion;
+ (void)cancelImageDownloadOnView:(id <PINRemoteImageCategory>)view;
+ (NSUUID *)downloadImageOperationUUIDOnView:(id <PINRemoteImageCategory>)view;
+ (void)setDownloadImageOperationUUID:(NSUUID *)downloadImageOperationUUID onView:(id <PINRemoteImageCategory>)view;
+ (BOOL)updateWithProgressOnView:(id <PINRemoteImageCategory>)view;
+ (void)setUpdateWithProgressOnView:(BOOL)updateWithProgress onView:(id <PINRemoteImageCategory>)view;
@end
/**
Protocol to implement on UIView subclasses to support PINRemoteImage
*/
@protocol PINRemoteImageCategory <NSObject>
//Call manager
/**
Set the image from the given URL.
@param url NSURL to fetch from.
*/
- (void)pin_setImageFromURL:(NSURL *)url;
/**
Set the image from the given URL and set placeholder image while image at URL is being retrieved.
@param url NSURL to fetch from.
@param placeholderImage UIImage to set on the view while the image at URL is being retrieved.
*/
- (void)pin_setImageFromURL:(NSURL *)url placeholderImage:(UIImage *)placeholderImage;
/**
Set the image from the given URL and call completion when finished.
@param url NSURL to fetch from.
@param completion Called when url has been retrieved and set on view.
*/
- (void)pin_setImageFromURL:(NSURL *)url completion:(PINRemoteImageManagerImageCompletion)completion;
/**
Set the image from the given URL, set placeholder while image at url is being retrieved and call completion when finished.
@param url NSURL to fetch from.
@param placeholderImage UIImage to set on the view while the image at URL is being retrieved.
@param completion Called when url has been retrieved and set on view.
*/
- (void)pin_setImageFromURL:(NSURL *)url placeholderImage:(UIImage *)placeholderImage completion:(PINRemoteImageManagerImageCompletion)completion;
/**
Retrieve the image from the given URL, process it using the passed in processor block and set result on view.
@param url NSURL to fetch from.
@param processorKey NSString key to uniquely identify processor. Used in caching.
@param processor PINRemoteImageManagerImageProcessor processor block which should return the processed image.
*/
- (void)pin_setImageFromURL:(NSURL *)url processorKey:(NSString *)processorKey processor:(PINRemoteImageManagerImageProcessor)processor;
/**
Set placeholder on view and retrieve the image from the given URL, process it using the passed in processor block and set result on view.
@param url NSURL to fetch from.
@param placeholderImage UIImage to set on the view while the image at URL is being retrieved.
@param processorKey NSString key to uniquely identify processor. Used in caching.
@param processor PINRemoteImageManagerImageProcessor processor block which should return the processed image.
*/
- (void)pin_setImageFromURL:(NSURL *)url placeholderImage:(UIImage *)placeholderImage processorKey:(NSString *)processorKey processor:(PINRemoteImageManagerImageProcessor)processor;
/**
Retrieve the image from the given URL, process it using the passed in processor block and set result on view. Call completion after image has been fetched, processed and set on view.
@param url NSURL to fetch from.
@param processorKey NSString key to uniquely identify processor. Used in caching.
@param processor PINRemoteImageManagerImageProcessor processor block which should return the processed image.
@param completion Called when url has been retrieved and set on view.
*/
- (void)pin_setImageFromURL:(NSURL *)url processorKey:(NSString *)processorKey processor:(PINRemoteImageManagerImageProcessor)processor completion:(PINRemoteImageManagerImageCompletion)completion;
/**
Set placeholder on view and retrieve the image from the given URL, process it using the passed in processor block and set result on view. Call completion after image has been fetched, processed and set on view.
@param url NSURL to fetch from.
@param placeholderImage UIImage to set on the view while the image at URL is being retrieved.
@param processorKey NSString key to uniquely identify processor. Used in caching.
@param processor PINRemoteImageManagerImageProcessor processor block which should return the processed image.
@param completion Called when url has been retrieved and set on view.
*/
- (void)pin_setImageFromURL:(NSURL *)url placeholderImage:(UIImage *)placeholderImage processorKey:(NSString *)processorKey processor:(PINRemoteImageManagerImageProcessor)processor completion:(PINRemoteImageManagerImageCompletion)completion;
/**
Retrieve one of the images at the passed in URLs depending on previous network performance and set result on view.
@param urls NSArray of NSURLs sorted in increasing quality
*/
- (void)pin_setImageFromURLs:(NSArray *)urls;
/**
Set placeholder on view and retrieve one of the images at the passed in URLs depending on previous network performance and set result on view.
@param urls NSArray of NSURLs sorted in increasing quality
@param placeholderImage UIImage to set on the view while the image at URL is being retrieved.
*/
- (void)pin_setImageFromURLs:(NSArray *)urls placeholderImage:(UIImage *)placeholderImage;
/**
Set placeholder on view and retrieve one of the images at the passed in URLs depending on previous network performance and set result on view. Call completion after image has been fetched and set on view.
@param urls NSArray of NSURLs sorted in increasing quality
@param placeholderImage UIImage to set on the view while the image at URL is being retrieved.
@param completion Called when url has been retrieved and set on view.
*/
- (void)pin_setImageFromURLs:(NSArray *)urls placeholderImage:(UIImage *)placeholderImage completion:(PINRemoteImageManagerImageCompletion)completion;
/**
Cancels the image download. Guarantees that previous setImage calls will *not* have their results set on the image view after calling this (as opposed to PINRemoteImageManager which does not guarantee cancellation).
*/
- (void)pin_cancelImageDownload;
/**
Returns the NSUUID associated with any PINRemoteImage task currently running on the view.
@return NSUUID associated with any PINRemoteImage task currently running on the view.
*/
- (NSUUID *)pin_downloadImageOperationUUID;
/**
Set the current NSUUID associated with a PINRemoteImage task running on the view.
@param downloadImageOperationUUID NSUUID associated with a PINRemoteImage task.
*/
- (void)pin_setDownloadImageOperationUUID:(NSUUID *)downloadImageOperationUUID;
/**
Whether the view should update with progress images (such as those provided by progressive JPEG images).
@return BOOL value indicating whether the view should update with progress images
*/
@property (nonatomic, assign) BOOL pin_updateWithProgress;
//Handle
- (void)pin_setPlaceholderWithImage:(UIImage *)image;
- (void)pin_updateUIWithImage:(UIImage *)image animatedImage:(FLAnimatedImage *)animatedImage;
- (void)pin_clearImages;
- (BOOL)pin_ignoreGIFs;
@optional
- (PINRemoteImageManagerDownloadOptions)pin_defaultOptions;
@end
/**
Deprecated version of protocol to implement on UIView subclasses to support PINRemoteImage
*/
@protocol PINRemoteImageCategory_Deprecated <NSObject>
//Call manager
/**
Set the image from the given URL.
@param url NSURL to fetch from.
*/
- (void)setImageFromURL:(NSURL *)url __attribute((deprecated("use pin_setImageFromURL:")));
/**
Set the image from the given URL and set placeholder image while image at URL is being retrieved.
@param url NSURL to fetch from.
@param placeholderImage UIImage to set on the view while the image at URL is being retrieved.
*/
- (void)setImageFromURL:(NSURL *)url placeholderImage:(UIImage *)placeholderImage __attribute((deprecated("use pin_setImageFromURL:placeholderImage:")));
/**
Set the image from the given URL and call completion when finished.
@param url NSURL to fetch from.
@param completion Called when url has been retrieved and set on view.
*/
- (void)setImageFromURL:(NSURL *)url completion:(PINRemoteImageManagerImageCompletion)completion __attribute((deprecated("use pin_setImageFromURL:completion:")));
/**
Set the image from the given URL, set placeholder while image at url is being retrieved and call completion when finished.
@param url NSURL to fetch from.
@param placeholderImage UIImage to set on the view while the image at URL is being retrieved.
@param completion Called when url has been retrieved and set on view.
*/
- (void)setImageFromURL:(NSURL *)url placeholderImage:(UIImage *)placeholderImage completion:(PINRemoteImageManagerImageCompletion)completion __attribute((deprecated("use pin_setImageFromURL:placeholderImage:completion:")));
/**
Retrieve the image from the given URL, process it using the passed in processor block and set result on view.
@param url NSURL to fetch from.
@param processorKey NSString key to uniquely identify processor. Used in caching.
@param processor PINRemoteImageManagerImageProcessor processor block which should return the processed image.
*/
- (void)setImageFromURL:(NSURL *)url processorKey:(NSString *)processorKey processor:(PINRemoteImageManagerImageProcessor)processor __attribute((deprecated("use pin_setImageFromURL:processorKey:processor:")));
/**
Set placeholder on view and retrieve the image from the given URL, process it using the passed in processor block and set result on view.
@param url NSURL to fetch from.
@param placeholderImage UIImage to set on the view while the image at URL is being retrieved.
@param processorKey NSString key to uniquely identify processor. Used in caching.
@param processor PINRemoteImageManagerImageProcessor processor block which should return the processed image.
*/
- (void)setImageFromURL:(NSURL *)url placeholderImage:(UIImage *)placeholderImage processorKey:(NSString *)processorKey processor:(PINRemoteImageManagerImageProcessor)processor __attribute((deprecated("use pin_setImageFromURL:placeholderImage:processorKey:processor:")));
/**
Retrieve the image from the given URL, process it using the passed in processor block and set result on view. Call completion after image has been fetched, processed and set on view.
@param url NSURL to fetch from.
@param processorKey NSString key to uniquely identify processor. Used in caching.
@param processor PINRemoteImageManagerImageProcessor processor block which should return the processed image.
@param completion Called when url has been retrieved and set on view.
*/
- (void)setImageFromURL:(NSURL *)url processorKey:(NSString *)processorKey processor:(PINRemoteImageManagerImageProcessor)processor completion:(PINRemoteImageManagerImageCompletion)completion __attribute((deprecated("use pin_completion:")));
/**
Set placeholder on view and retrieve the image from the given URL, process it using the passed in processor block and set result on view. Call completion after image has been fetched, processed and set on view.
@param url NSURL to fetch from.
@param placeholderImage UIImage to set on the view while the image at URL is being retrieved.
@param processorKey NSString key to uniquely identify processor. Used in caching.
@param processor PINRemoteImageManagerImageProcessor processor block which should return the processed image.
@param completion Called when url has been retrieved and set on view.
*/
- (void)setImageFromURL:(NSURL *)url placeholderImage:(UIImage *)placeholderImage processorKey:(NSString *)processorKey processor:(PINRemoteImageManagerImageProcessor)processor completion:(PINRemoteImageManagerImageCompletion)completion __attribute((deprecated("use pin_completion:")));
/**
Retrieve one of the images at the passed in URLs depending on previous network performance and set result on view.
@param urls NSArray of NSURLs sorted in increasing quality
*/
- (void)setImageFromURLs:(NSArray *)urls __attribute((deprecated("use pin_setImageFromURLs:")));
/**
Set placeholder on view and retrieve one of the images at the passed in URLs depending on previous network performance and set result on view.
@param urls NSArray of NSURLs sorted in increasing quality
@param placeholderImage UIImage to set on the view while the image at URL is being retrieved.
*/
- (void)setImageFromURLs:(NSArray *)urls placeholderImage:(UIImage *)placeholderImage __attribute((deprecated("use pin_setImageFromURLs:placeholderImage:")));
/**
Set placeholder on view and retrieve one of the images at the passed in URLs depending on previous network performance and set result on view. Call completion after image has been fetched and set on view.
@param urls NSArray of NSURLs sorted in increasing quality
@param placeholderImage UIImage to set on the view while the image at URL is being retrieved.
@param completion Called when url has been retrieved and set on view.
*/
- (void)setImageFromURLs:(NSArray *)urls placeholderImage:(UIImage *)placeholderImage completion:(PINRemoteImageManagerImageCompletion)completion __attribute((deprecated("use pin_setImageFromURLs:(NSArray *)urls placeholderImage:completion:")));
/**
Cancels the image download. Guarantees that previous setImage calls will *not* have their results set on the image view after calling this (as opposed to PINRemoteImageManager which does not guarantee cancellation).
*/
- (void)cancelImageDownload __attribute((deprecated("use pin_cancelImageDownload")));
/**
Returns the NSUUID associated with any PINRemoteImage task currently running on the view.
@return NSUUID associated with any PINRemoteImage task currently running on the view.
*/
- (NSUUID *)downloadImageOperationUUID __attribute((deprecated("use pin_downloadImageOperationUUID")));
/**
Set the current NSUUID associated with a PINRemoteImage task running on the view.
@param downloadImageOperationUUID NSUUID associated with a PINRemoteImage task.
*/
- (void)setDownloadImageOperationUUID:(NSUUID *)downloadImageOperationUUID __attribute((deprecated("use pin_setDownloadImageOperationUUID:")));
/**
Whether the view should update with progress images (such as those provided by progressive JPEG images).
@return BOOL value indicating whether the view should update with progress images
*/
@property (nonatomic, assign) BOOL updateWithProgress __attribute((deprecated("use pin_@property (nonatomic, assign) BOOL updateWithProgress")));
//Handle
- (void)setPlaceholderWithImage:(UIImage *)image __attribute((deprecated("use pin_setPlaceholderWithImage:")));
- (void)updateUIWithImage:(UIImage *)image animatedImage:(FLAnimatedImage *)animatedImage __attribute((deprecated("use pin_updateUIWithImage:animatedImage:")));
- (void)clearImages __attribute((deprecated("use pin_clearImages")));
- (BOOL)ignoreGIFs __attribute((deprecated("use pin_ignoreGIFs")));
@end