-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathNIPhotoScrollView_8h_source.html
140 lines (140 loc) · 16.8 KB
/
NIPhotoScrollView_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
<!-- HTML header for doxygen 1.8.6-->
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6-nimbuskit"/>
<title>NimbusKit: src/photos/src/NIPhotoScrollView.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="appledocs.css" rel="stylesheet" type="text/css"/>
<link href="nimbuskit.css" rel="stylesheet" type="text/css" />
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-24278774-1']);
_gaq.push(['_setDomainName', 'nimbuskit.info']);
_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="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<a href="index.html"><img style="float:left" src="nimbus128.png" width="80" height="80" /></a>
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">NimbusKit
 <span id="projectnumber">1.2.1 - <a href="http://github.com/jverkoey/nimbus">Fork Nimbus on Github</a> - <a href="http://wiki.nimbuskit.info/">Visit the Nimbus Wiki</a></span>
</div>
<div id="projectbrief">The iOS framework that grows only as fast as its documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6-nimbuskit -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('NIPhotoScrollView_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">NIPhotoScrollView.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Copyright 2011-2014 NimbusKit</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">//</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Licensed under the Apache License, Version 2.0 (the "License");</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">//</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">//</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// limitations under the License.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">//</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#import "NIPagingScrollViewPage.h"</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#import "NIPhotoScrollViewPhotoSize.h"</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#import <Foundation/Foundation.h></span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#import <UIKit/UIKit.h></span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">@protocol </span><a class="code" href="NIPhotoScrollViewDelegate-Protocol.html">NIPhotoScrollViewDelegate</a>;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">@class</span> NICenteringScrollView;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="NIPhotoScrollView.html"> 31</a></span> <span class="keyword">@interface </span><a class="code" href="NIPhotoScrollView.html">NIPhotoScrollView</a> : UIView <UIScrollViewDelegate, <a class="code" href="NIPagingScrollViewPage-Protocol.html">NIPagingScrollViewPage</a>></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#pragma mark Configuring Functionality</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="NIPhotoScrollView.html#zoomingIsEnabled"> 35</a></span> <span class="keyword">@property</span> (nonatomic, assign, getter=isZoomingEnabled) BOOL <a class="code" href="NIPhotoScrollView.html#zoomingIsEnabled">zoomingIsEnabled</a>; <span class="comment">// default: yes</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="NIPhotoScrollView.html#zoomingAboveOriginalSizeIsEnabled"> 36</a></span> <span class="keyword">@property</span> (nonatomic, assign, getter=isZoomingAboveOriginalSizeEnabled) BOOL <a class="code" href="NIPhotoScrollView.html#zoomingAboveOriginalSizeIsEnabled">zoomingAboveOriginalSizeIsEnabled</a>; <span class="comment">// default: yes</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="NIPhotoScrollView.html#doubleTapToZoomIsEnabled"> 37</a></span> <span class="keyword">@property</span> (nonatomic, assign, getter=isDoubleTapToZoomEnabled) BOOL <a class="code" href="NIPhotoScrollView.html#doubleTapToZoomIsEnabled">doubleTapToZoomIsEnabled</a>; <span class="comment">// default: yes</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="NIPhotoScrollView.html#maximumScale"> 38</a></span> <span class="keyword">@property</span> (nonatomic, assign) CGFloat <a class="code" href="NIPhotoScrollView.html#maximumScale">maximumScale</a>; <span class="comment">// default: 0 (autocalculate)</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="NIPhotoScrollView.html#photoScrollViewDelegate"> 39</a></span> <span class="keyword">@property</span> (nonatomic, weak) id<NIPhotoScrollViewDelegate> <a class="code" href="NIPhotoScrollView.html#photoScrollViewDelegate">photoScrollViewDelegate</a>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#pragma mark State</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> - (UIImage *)<a class="code" href="NIPhotoScrollView.html#image">image</a>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> - (NIPhotoScrollViewPhotoSize)<a class="code" href="NIPhotoScrollView.html#photoSize">photoSize</a>;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> - (void)setImage:(UIImage *)image photoSize:(NIPhotoScrollViewPhotoSize)photoSize;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">@property</span> (nonatomic, assign, getter = isLoading) BOOL loading;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="NIPhotoScrollView.html#pageIndex"> 48</a></span> <span class="keyword">@property</span> (nonatomic, assign) NSInteger <a class="code" href="NIPhotoScrollView.html#pageIndex">pageIndex</a>;</div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="NIPhotoScrollView.html#photoDimensions"> 49</a></span> <span class="keyword">@property</span> (nonatomic, assign) CGSize <a class="code" href="NIPhotoScrollView.html#photoDimensions">photoDimensions</a>;</div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="NIPhotoScrollView.html#doubleTapGestureRecognizer"> 50</a></span> <span class="keyword">@property</span> (nonatomic, readonly, strong) UITapGestureRecognizer* <a class="code" href="NIPhotoScrollView.html#doubleTapGestureRecognizer">doubleTapGestureRecognizer</a>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">@end</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="ttc" id="NIPhotoScrollView_html_photoScrollViewDelegate"><div class="ttname"><a href="NIPhotoScrollView.html#photoScrollViewDelegate">NIPhotoScrollView::photoScrollViewDelegate</a></div><div class="ttdeci">id< NIPhotoScrollViewDelegate > photoScrollViewDelegate</div><div class="ttdoc">The photo scroll view delegate. </div><div class="ttdef"><b>Definition:</b> <a href="NIPhotoScrollView_8h_source.html#l00039">NIPhotoScrollView.h:39</a></div></div>
<div class="ttc" id="NIPhotoScrollView_html_zoomingIsEnabled"><div class="ttname"><a href="NIPhotoScrollView.html#zoomingIsEnabled">NIPhotoScrollView::zoomingIsEnabled</a></div><div class="ttdeci">BOOL zoomingIsEnabled</div><div class="ttdoc">Whether the photo is allowed to be zoomed. </div><div class="ttdef"><b>Definition:</b> <a href="NIPhotoScrollView_8h_source.html#l00035">NIPhotoScrollView.h:35</a></div></div>
<div class="ttc" id="NIPagingScrollViewPage-Protocol_html"><div class="ttname"><a href="NIPagingScrollViewPage-Protocol.html">NIPagingScrollViewPage-p</a></div><div class="ttdoc">The protocol that a paging scroll view page should implement. </div><div class="ttdef"><b>Definition:</b> <a href="NIPagingScrollView_8h_source.html#l00162">NIPagingScrollView.h:162</a></div></div>
<div class="ttc" id="NIPhotoScrollView_html"><div class="ttname"><a href="NIPhotoScrollView.html">NIPhotoScrollView</a></div><div class="ttdoc">A single photo view that supports zooming and rotation. </div><div class="ttdef"><b>Definition:</b> <a href="NIPhotoScrollView_8h_source.html#l00031">NIPhotoScrollView.h:31</a></div></div>
<div class="ttc" id="NIPhotoScrollView_html_maximumScale"><div class="ttname"><a href="NIPhotoScrollView.html#maximumScale">NIPhotoScrollView::maximumScale</a></div><div class="ttdeci">CGFloat maximumScale</div><div class="ttdoc">The maximum scale of the image. </div><div class="ttdef"><b>Definition:</b> <a href="NIPhotoScrollView_8h_source.html#l00038">NIPhotoScrollView.h:38</a></div></div>
<div class="ttc" id="NIPhotoScrollView_html_pageIndex"><div class="ttname"><a href="NIPhotoScrollView.html#pageIndex">NIPhotoScrollView::pageIndex</a></div><div class="ttdeci">NSInteger pageIndex</div><div class="ttdoc">The index of this photo within a photo album. </div><div class="ttdef"><b>Definition:</b> <a href="NIPhotoScrollView_8h_source.html#l00048">NIPhotoScrollView.h:48</a></div></div>
<div class="ttc" id="NIPhotoScrollView_html_doubleTapToZoomIsEnabled"><div class="ttname"><a href="NIPhotoScrollView.html#doubleTapToZoomIsEnabled">NIPhotoScrollView::doubleTapToZoomIsEnabled</a></div><div class="ttdeci">BOOL doubleTapToZoomIsEnabled</div><div class="ttdoc">Whether double-tapping zooms in and out of the image. </div><div class="ttdef"><b>Definition:</b> <a href="NIPhotoScrollView_8h_source.html#l00037">NIPhotoScrollView.h:37</a></div></div>
<div class="ttc" id="NIPhotoScrollView_html_photoDimensions"><div class="ttname"><a href="NIPhotoScrollView.html#photoDimensions">NIPhotoScrollView::photoDimensions</a></div><div class="ttdeci">CGSize photoDimensions</div><div class="ttdoc">The largest dimensions of the photo. </div><div class="ttdef"><b>Definition:</b> <a href="NIPhotoScrollView_8h_source.html#l00049">NIPhotoScrollView.h:49</a></div></div>
<div class="ttc" id="NIPhotoScrollView_html_zoomingAboveOriginalSizeIsEnabled"><div class="ttname"><a href="NIPhotoScrollView.html#zoomingAboveOriginalSizeIsEnabled">NIPhotoScrollView::zoomingAboveOriginalSizeIsEnabled</a></div><div class="ttdeci">BOOL zoomingAboveOriginalSizeIsEnabled</div><div class="ttdoc">Whether small photos can be zoomed at least until they fit the screen. </div><div class="ttdef"><b>Definition:</b> <a href="NIPhotoScrollView_8h_source.html#l00036">NIPhotoScrollView.h:36</a></div></div>
<div class="ttc" id="NIPhotoScrollView_html_photoSize"><div class="ttname"><a href="NIPhotoScrollView.html#photoSize">-[NIPhotoScrollView photoSize]</a></div><div class="ttdeci">NIPhotoScrollViewPhotoSize photoSize()</div><div class="ttdoc">The current size of the photo. </div></div>
<div class="ttc" id="NIPhotoScrollView_html_doubleTapGestureRecognizer"><div class="ttname"><a href="NIPhotoScrollView.html#doubleTapGestureRecognizer">NIPhotoScrollView::doubleTapGestureRecognizer</a></div><div class="ttdeci">UITapGestureRecognizer * doubleTapGestureRecognizer</div><div class="ttdoc">The gesture recognizer for double-tapping zooms in and out of the image. </div><div class="ttdef"><b>Definition:</b> <a href="NIPhotoScrollView_8h_source.html#l00050">NIPhotoScrollView.h:50</a></div></div>
<div class="ttc" id="NIPhotoScrollView_html_image"><div class="ttname"><a href="NIPhotoScrollView.html#image">-[NIPhotoScrollView image]</a></div><div class="ttdeci">UIImage * image()</div><div class="ttdoc">The currently-displayed photo. </div><div class="ttdef"><b>Definition:</b> <a href="NIPhotoScrollView_8m_source.html#l00270">NIPhotoScrollView.m:270</a></div></div>
<div class="ttc" id="NIPhotoScrollViewDelegate-Protocol_html"><div class="ttname"><a href="NIPhotoScrollViewDelegate-Protocol.html">NIPhotoScrollViewDelegate-p</a></div><div class="ttdoc">The photo scroll view delegate. </div><div class="ttdef"><b>Definition:</b> <a href="NIPhotoScrollViewDelegate_8h_source.html#l00026">NIPhotoScrollViewDelegate.h:26</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.6-->
<!-- start footer part -->
<script type="text/javascript" src="widget.js"></script>
</body>
</html>