/
_n_i_network_image_view_8h_source.html
247 lines (226 loc) · 19.7 KB
/
_n_i_network_image_view_8h_source.html
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Nimbus: src/networkimage/src/NINetworkImageView.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-24278774-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<div id="page">
<div style="position:relative">
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<a style="float: right;margin-right:20px;margin-top:20px" href='http://www.pledgie.com/campaigns/15519'><img alt='Click here to support Nimbus development and make a donation at www.pledgie.com !' src='http://www.pledgie.com/campaigns/15519.png?skin_name=chrome' border='0' /></a>
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Nimbus
 <span id="projectnumber">0.9.1 - <a href="http://github.com/jverkoey/nimbus">Nimbus is proudly hosted on Github</a></span>
</div>
<div id="projectbrief">An iOS framework whose growth is bounded by O(documentation).</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.4-20110629 -->
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('_n_i_network_image_view_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">src/networkimage/src/NINetworkImageView.h</div> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">//</span>
<a name="l00002"></a>00002 <span class="comment">// Copyright 2011 Jeff Verkoeyen</span>
<a name="l00003"></a>00003 <span class="comment">//</span>
<a name="l00004"></a>00004 <span class="comment">// Licensed under the Apache License, Version 2.0 (the "License");</span>
<a name="l00005"></a>00005 <span class="comment">// you may not use this file except in compliance with the License.</span>
<a name="l00006"></a>00006 <span class="comment">// You may obtain a copy of the License at</span>
<a name="l00007"></a>00007 <span class="comment">//</span>
<a name="l00008"></a>00008 <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00009"></a>00009 <span class="comment">//</span>
<a name="l00010"></a>00010 <span class="comment">// Unless required by applicable law or agreed to in writing, software</span>
<a name="l00011"></a>00011 <span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span>
<a name="l00012"></a>00012 <span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="l00013"></a>00013 <span class="comment">// See the License for the specific language governing permissions and</span>
<a name="l00014"></a>00014 <span class="comment">// limitations under the License.</span>
<a name="l00015"></a>00015 <span class="comment">//</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#import <Foundation/Foundation.h></span>
<a name="l00018"></a>00018 <span class="preprocessor">#import <UIKit/UIKit.h></span>
<a name="l00019"></a>00019
<a name="l00020"></a>00020 <span class="preprocessor">#import "NIInMemoryCache.h"</span>
<a name="l00021"></a>00021 <span class="preprocessor">#import "NimbusCore.h"</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="keyword">@protocol </span><a class="code" href="protocol_n_i_network_image_view_delegate-p.html" title="The image view delegate used to inform of state changes.">NINetworkImageViewDelegate</a>;
<a name="l00024"></a>00024 <span class="keyword">@protocol </span>ASICacheDelegate;
<a name="l00025"></a>00025
<a name="l00026"></a>00026 <span class="comment">// See the diskCacheLifetime property for more documentation related to this enumeration.</span>
<a name="l00027"></a>00027 <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00032"></a>00032 NINetworkImageViewDiskCacheLifetimeSession,
<a name="l00033"></a>00033
<a name="l00038"></a>00038 NINetworkImageViewDiskCacheLifetimePermanent,
<a name="l00039"></a>00039 } NINetworkImageViewDiskCacheLifetime;
<a name="l00040"></a>00040
<a name="l00041"></a><a class="code" href="group___network-_image-_user-_interface.html#ga44d338b3b1eae1d2a3bb8fd985acf856">00041</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00042"></a>00042 NINetworkImageViewScaleToFitLeavesExcessAndScaleToFillCropsExcess = 0x00,
<a name="l00043"></a>00043 NINetworkImageViewScaleToFitCropsExcess = 0x01,
<a name="l00044"></a>00044 NINetworkImageViewScaleToFillLeavesExcess = 0x02,
<a name="l00045"></a>00045 } <a class="code" href="group___network-_image-_user-_interface.html#ga44d338b3b1eae1d2a3bb8fd985acf856" title="Flags for modifying the way cropping is handled when scaling images to fit or fill.">NINetworkImageViewScaleOptions</a>;
<a name="l00046"></a>00046
<a name="l00051"></a><a class="code" href="protocol_n_i_network_image_operation-p.html">00051</a> <span class="keyword">@protocol </span><a class="code" href="protocol_n_i_network_image_operation-p.html" title="A protocol defining the set of characteristics for an operation to be used with NINetworkImageView.">NINetworkImageOperation</a> <NSObject>
<a name="l00052"></a>00052 <span class="keyword">@required</span>
<a name="l00053"></a>00053 <span class="keyword">@property</span> (readonly, copy) <a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a>* cacheIdentifier;
<a name="l00054"></a>00054 <span class="keyword">@property</span> (readwrite, assign) CGRect imageCropRect;
<a name="l00055"></a>00055 <span class="keyword">@property</span> (readwrite, assign) CGSize imageDisplaySize;
<a name="l00056"></a>00056 <span class="keyword">@property</span> (readwrite, assign) <a class="code" href="group___network-_image-_user-_interface.html#ga44d338b3b1eae1d2a3bb8fd985acf856" title="Flags for modifying the way cropping is handled when scaling images to fit or fill.">NINetworkImageViewScaleOptions</a> scaleOptions;
<a name="l00057"></a>00057 <span class="keyword">@property</span> (readwrite, assign) CGInterpolationQuality interpolationQuality;
<a name="l00058"></a>00058 <span class="keyword">@property</span> (readwrite, assign) UIViewContentMode imageContentMode;
<a name="l00059"></a>00059 <span class="keyword">@property</span> (readwrite, retain) UIImage* imageCroppedAndSizedForDisplay;
<a name="l00060"></a>00060 <span class="keyword">@end</span>
<a name="l00061"></a>00061
<a name="l00070"></a><a class="code" href="interface_n_i_network_image_view.html">00070</a> <span class="keyword">@interface </span><a class="code" href="interface_n_i_network_image_view.html" title="A network-enabled image view that consumes minimal amounts of memory.">NINetworkImageView</a> : UIImageView <<a class="code" href="protocol_n_i_operation_delegate-p.html" title="The delegate protocol for an NSOperation.">NIOperationDelegate</a>> {
<a name="l00071"></a>00071 <span class="keyword">@private</span>
<a name="l00072"></a>00072 <span class="comment">// The active operation for the image</span>
<a name="l00073"></a>00073 <a class="code" href="interface_n_i_operation.html">NIOperation<NINetworkImageOperation></a>* _operation;
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <span class="comment">// Configurable Presentation Properties</span>
<a name="l00076"></a>00076 UIImage* _initialImage;
<a name="l00077"></a>00077 BOOL _sizeForDisplay;
<a name="l00078"></a>00078 <a class="code" href="group___network-_image-_user-_interface.html#ga44d338b3b1eae1d2a3bb8fd985acf856" title="Flags for modifying the way cropping is handled when scaling images to fit or fill.">NINetworkImageViewScaleOptions</a> _scaleOptions;
<a name="l00079"></a>00079 CGInterpolationQuality _interpolationQuality;
<a name="l00080"></a>00080
<a name="l00081"></a>00081 <span class="comment">// Configurable Properties</span>
<a name="l00082"></a>00082 <a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a>* _memoryCachePrefix;
<a name="l00083"></a>00083 <a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a>* _lastPathToNetworkImage;
<a name="l00084"></a>00084 NSTimeInterval _maxAge;
<a name="l00085"></a>00085 <a class="code" href="interface_n_i_image_memory_cache.html" title="An in-memory cache for storing images with caps on the total number of pixels.">NIImageMemoryCache</a>* _imageMemoryCache;
<a name="l00086"></a>00086 NSOperationQueue* _networkOperationQueue;
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="comment">// Delegation</span>
<a name="l00089"></a>00089 id<NINetworkImageViewDelegate> _delegate;
<a name="l00090"></a>00090 }
<a name="l00091"></a>00091
<a name="l00092"></a>00092 <span class="preprocessor">#pragma mark Creating a Network Image View</span>
<a name="l00093"></a>00093 <span class="preprocessor"></span>
<a name="l00094"></a>00094 - (id)initWithImage:(UIImage *)image;
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <span class="preprocessor">#pragma mark Configurable Presentation Properties</span>
<a name="l00097"></a>00097 <span class="preprocessor"></span>
<a name="l00098"></a><a class="code" href="interface_n_i_network_image_view.html#a3dc0b8d1ba6db1eb96a3645f06f99b6a">00098</a> <span class="keyword">@property</span> (nonatomic, readwrite, retain) UIImage* initialImage; <span class="comment">// Default: nil</span>
<a name="l00099"></a><a class="code" href="interface_n_i_network_image_view.html#ae89362b1efb1347953529ddec044787f">00099</a> <span class="keyword">@property</span> (nonatomic, readwrite, assign) BOOL sizeForDisplay; <span class="comment">// Default: YES</span>
<a name="l00100"></a><a class="code" href="interface_n_i_network_image_view.html#a00d2df629a934ac974a6b27a83b75ca3">00100</a> <span class="keyword">@property</span> (nonatomic, readwrite, assign) <a class="code" href="group___network-_image-_user-_interface.html#ga44d338b3b1eae1d2a3bb8fd985acf856" title="Flags for modifying the way cropping is handled when scaling images to fit or fill.">NINetworkImageViewScaleOptions</a> scaleOptions; <span class="comment">// Default: NINetworkImageViewScaleToFitLeavesExcessAndScaleToFillCropsExcess</span>
<a name="l00101"></a><a class="code" href="interface_n_i_network_image_view.html#a04b3e01db91e87205984e10babc601be">00101</a> <span class="keyword">@property</span> (nonatomic, readwrite, assign) CGInterpolationQuality interpolationQuality; <span class="comment">// Default: kCGInterpolationDefault</span>
<a name="l00102"></a>00102
<a name="l00103"></a>00103 <span class="preprocessor">#pragma mark Configurable Properties</span>
<a name="l00104"></a>00104 <span class="preprocessor"></span>
<a name="l00105"></a><a class="code" href="interface_n_i_network_image_view.html#a797e8d53348de870b8471e020d1babca">00105</a> <span class="keyword">@property</span> (nonatomic, readwrite, retain) <a class="code" href="interface_n_i_image_memory_cache.html" title="An in-memory cache for storing images with caps on the total number of pixels.">NIImageMemoryCache</a>* imageMemoryCache; <span class="comment">// Default: [Nimbus imageMemoryCache]</span>
<a name="l00106"></a><a class="code" href="interface_n_i_network_image_view.html#ac5182e8400d566e77764d9314a1128d5">00106</a> <span class="keyword">@property</span> (nonatomic, readwrite, retain) NSOperationQueue* networkOperationQueue; <span class="comment">// Default: [Nimbus networkOperationQueue]</span>
<a name="l00107"></a>00107
<a name="l00108"></a><a class="code" href="interface_n_i_network_image_view.html#aa3100ac85be1d2eff7ed3e5d24dcfcba">00108</a> <span class="keyword">@property</span> (nonatomic, readwrite, assign) NSTimeInterval maxAge; <span class="comment">// Default: 0</span>
<a name="l00109"></a>00109
<a name="l00110"></a><a class="code" href="interface_n_i_network_image_view.html#a3f93f09bc3843a75f9ccce303a847b1b">00110</a> <span class="keyword">@property</span> (nonatomic, readwrite, copy) <a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a>* memoryCachePrefix; <span class="comment">// Default: nil</span>
<a name="l00111"></a><a class="code" href="interface_n_i_network_image_view.html#ad770af40e9cb2673b210c3f199f83210">00111</a> <span class="keyword">@property</span> (nonatomic, readonly, copy) <a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a>* lastPathToNetworkImage;
<a name="l00112"></a>00112
<a name="l00113"></a>00113 <span class="preprocessor">#pragma mark Requesting a Network Image</span>
<a name="l00114"></a>00114 <span class="preprocessor"></span>
<a name="l00115"></a>00115 - (void)setPathToNetworkImage:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)pathToNetworkImage;
<a name="l00116"></a>00116 - (void)setPathToNetworkImage:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)pathToNetworkImage forDisplaySize:(CGSize)displaySize;
<a name="l00117"></a>00117 - (void)setPathToNetworkImage:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)pathToNetworkImage forDisplaySize:(CGSize)displaySize contentMode:(UIViewContentMode)contentMode;
<a name="l00118"></a>00118 - (void)setPathToNetworkImage:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)pathToNetworkImage forDisplaySize:(CGSize)displaySize contentMode:(UIViewContentMode)contentMode cropRect:(CGRect)cropRect;
<a name="l00119"></a>00119 - (void)setPathToNetworkImage:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)pathToNetworkImage cropRect:(CGRect)cropRect;
<a name="l00120"></a>00120 - (void)setPathToNetworkImage:(<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)pathToNetworkImage contentMode:(UIViewContentMode)contentMode;
<a name="l00121"></a>00121
<a name="l00122"></a>00122 - (void)setNetworkImageOperation:(<a class="code" href="interface_n_i_operation.html" title="A base implementation of an NSOperation that supports traditional delegation and blocks.">NIOperation</a><<a class="code" href="protocol_n_i_network_image_operation-p.html" title="A protocol defining the set of characteristics for an operation to be used with NINetworkImageView.">NINetworkImageOperation</a>> *)operation forDisplaySize:(CGSize)displaySize contentMode:(UIViewContentMode)contentMode cropRect:(CGRect)cropRect;
<a name="l00123"></a>00123
<a name="l00124"></a>00124 <span class="preprocessor">#pragma mark State</span>
<a name="l00125"></a>00125 <span class="preprocessor"></span>
<a name="l00126"></a>00126 <span class="keyword">@property</span> (nonatomic, readonly, assign, getter=isLoading) BOOL loading;
<a name="l00127"></a>00127
<a name="l00128"></a>00128 <span class="preprocessor">#pragma mark Reusable View</span>
<a name="l00129"></a>00129 <span class="preprocessor"></span>
<a name="l00130"></a>00130 - (void)prepareForReuse;
<a name="l00131"></a>00131
<a name="l00132"></a>00132 <span class="preprocessor">#pragma mark Delegation</span>
<a name="l00133"></a>00133 <span class="preprocessor"></span>
<a name="l00134"></a><a class="code" href="interface_n_i_network_image_view.html#a763e5fdecb23fa0708f2fab957d1090c">00134</a> <span class="keyword">@property</span> (nonatomic, readwrite, assign) id<NINetworkImageViewDelegate> delegate;
<a name="l00135"></a>00135
<a name="l00136"></a>00136 <span class="preprocessor">#pragma mark Subclassing</span>
<a name="l00137"></a>00137 <span class="preprocessor"></span>
<a name="l00138"></a>00138 - (void)networkImageViewDidStartLoading;
<a name="l00139"></a>00139 - (void)networkImageViewDidLoadImage:(UIImage *)image;
<a name="l00140"></a>00140 - (void)networkImageViewDidFailToLoad:(NSError *)error;
<a name="l00141"></a>00141
<a name="l00142"></a>00142 <span class="keyword">@end</span>
<a name="l00143"></a>00143
<a name="l00144"></a>00144
<a name="l00150"></a><a class="code" href="protocol_n_i_network_image_view_delegate-p.html">00150</a> <span class="keyword">@protocol </span><a class="code" href="protocol_n_i_network_image_view_delegate-p.html" title="The image view delegate used to inform of state changes.">NINetworkImageViewDelegate</a> <NSObject>
<a name="l00151"></a>00151 <span class="keyword">@optional</span>
<a name="l00152"></a>00152
<a name="l00156"></a>00156 - (void)networkImageViewDidStartLoad:(<a class="code" href="interface_n_i_network_image_view.html" title="A network-enabled image view that consumes minimal amounts of memory.">NINetworkImageView</a> *)imageView;
<a name="l00157"></a>00157
<a name="l00161"></a>00161 - (void)networkImageView:(<a class="code" href="interface_n_i_network_image_view.html" title="A network-enabled image view that consumes minimal amounts of memory.">NINetworkImageView</a> *)imageView didLoadImage:(UIImage *)image;
<a name="l00162"></a>00162
<a name="l00166"></a>00166 - (void)networkImageViewDidFailLoad:(<a class="code" href="interface_n_i_network_image_view.html" title="A network-enabled image view that consumes minimal amounts of memory.">NINetworkImageView</a> *)imageView;
<a name="l00167"></a>00167
<a name="l00168"></a>00168 <span class="keyword">@end</span>
<a name="l00169"></a>00169
</pre></div><div id="disqus_thread"></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>NINetworkImageView.h</b> </li>
</div><!-- .fixedwidth -->
<script type="text/javascript">
/* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
var disqus_shortname = 'nimbusdocumentation'; // required: replace example with your forum shortname
// The following are highly recommended additional parameters. Remove the slashes in front to use.
// var disqus_identifier = 'unique_dynamic_id_1234';
// var disqus_url = 'http://example.com/permalink-to-page.html';
/* * * DON'T EDIT BELOW THIS LINE * * */
(function() {
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
dsq.src = 'http://' + disqus_shortname + '.disqus.com/embed.js';
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
})();
</script>
<span class="footer">Generated for Nimbus by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4-20110629 </span>
</ul>
</div>
</div> <!-- page -->
</body>
</html>