-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathNIToolbarPhotoViewController_8h_source.html
147 lines (147 loc) · 19.4 KB
/
NIToolbarPhotoViewController_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
<!-- 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/NIToolbarPhotoViewController.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('NIToolbarPhotoViewController_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">NIToolbarPhotoViewController.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 <Foundation/Foundation.h></span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#import <UIKit/UIKit.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 "NIPhotoAlbumScrollView.h"</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#import "NIPhotoScrubberView.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">@class</span> <a class="code" href="NIPhotoAlbumScrollView.html">NIPhotoAlbumScrollView</a>;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="NIToolbarPhotoViewController.html"> 72</a></span> <span class="keyword">@interface </span><a class="code" href="NIToolbarPhotoViewController.html">NIToolbarPhotoViewController</a> : UIViewController <<a class="code" href="NIPhotoAlbumScrollViewDelegate-Protocol.html">NIPhotoAlbumScrollViewDelegate</a>, <a class="code" href="NIPhotoScrubberViewDelegate-Protocol.html">NIPhotoScrubberViewDelegate</a>></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor">#pragma mark Configuring Functionality</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="NIToolbarPhotoViewController.html#toolbarIsTranslucent"> 76</a></span> <span class="keyword">@property</span> (nonatomic, assign, getter=isToolbarTranslucent) BOOL <a class="code" href="NIToolbarPhotoViewController.html#toolbarIsTranslucent">toolbarIsTranslucent</a>; <span class="comment">// default: yes</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="NIToolbarPhotoViewController.html#hidesChromeWhenScrolling"> 77</a></span> <span class="keyword">@property</span> (nonatomic, assign) BOOL <a class="code" href="NIToolbarPhotoViewController.html#hidesChromeWhenScrolling">hidesChromeWhenScrolling</a>; <span class="comment">// default: yes</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="NIToolbarPhotoViewController.html#chromeCanBeHidden"> 78</a></span> <span class="keyword">@property</span> (nonatomic, assign) BOOL <a class="code" href="NIToolbarPhotoViewController.html#chromeCanBeHidden">chromeCanBeHidden</a>; <span class="comment">// default: yes</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="NIToolbarPhotoViewController.html#animateMovingToNextAndPreviousPhotos"> 79</a></span> <span class="keyword">@property</span> (nonatomic, assign) BOOL <a class="code" href="NIToolbarPhotoViewController.html#animateMovingToNextAndPreviousPhotos">animateMovingToNextAndPreviousPhotos</a>; <span class="comment">// default: no</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="NIToolbarPhotoViewController.html#scrubberIsEnabled"> 80</a></span> <span class="keyword">@property</span> (nonatomic, assign, getter=isScrubberEnabled) BOOL <a class="code" href="NIToolbarPhotoViewController.html#scrubberIsEnabled">scrubberIsEnabled</a>; <span class="comment">// default: ipad yes - iphone no</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor">#pragma mark Views</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="NIToolbarPhotoViewController.html#toolbar"> 84</a></span> <span class="keyword">@property</span> (nonatomic, readonly, strong) UIToolbar* <a class="code" href="NIToolbarPhotoViewController.html#toolbar">toolbar</a>;</div>
<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="NIToolbarPhotoViewController.html#photoAlbumView"> 85</a></span> <span class="keyword">@property</span> (nonatomic, readonly, strong) <a class="code" href="NIPhotoAlbumScrollView.html">NIPhotoAlbumScrollView</a>* <a class="code" href="NIToolbarPhotoViewController.html#photoAlbumView">photoAlbumView</a>;</div>
<div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="NIToolbarPhotoViewController.html#photoScrubberView"> 86</a></span> <span class="keyword">@property</span> (nonatomic, readonly, strong) <a class="code" href="NIPhotoScrubberView.html">NIPhotoScrubberView</a>* <a class="code" href="NIToolbarPhotoViewController.html#photoScrubberView">photoScrubberView</a>;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> - (void)refreshChromeState;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor">#pragma mark Toolbar Buttons</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="NIToolbarPhotoViewController.html#nextButton"> 91</a></span> <span class="keyword">@property</span> (nonatomic, readonly, strong) UIBarButtonItem* <a class="code" href="NIToolbarPhotoViewController.html#nextButton">nextButton</a>;</div>
<div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="NIToolbarPhotoViewController.html#previousButton"> 92</a></span> <span class="keyword">@property</span> (nonatomic, readonly, strong) UIBarButtonItem* <a class="code" href="NIToolbarPhotoViewController.html#previousButton">previousButton</a>;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="preprocessor">#pragma mark Subclassing</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> - (void)setChromeVisibility:(BOOL)isVisible animated:(BOOL)animated;</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> - (void)setChromeTitle;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="keyword">@end</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="ttc" id="NIToolbarPhotoViewController_html_scrubberIsEnabled"><div class="ttname"><a href="NIToolbarPhotoViewController.html#scrubberIsEnabled">NIToolbarPhotoViewController::scrubberIsEnabled</a></div><div class="ttdeci">BOOL scrubberIsEnabled</div><div class="ttdoc">Whether to show a scrubber in the toolbar instead of next/previous buttons. </div><div class="ttdef"><b>Definition:</b> <a href="NIToolbarPhotoViewController_8h_source.html#l00080">NIToolbarPhotoViewController.h:80</a></div></div>
<div class="ttc" id="NIToolbarPhotoViewController_html_nextButton"><div class="ttname"><a href="NIToolbarPhotoViewController.html#nextButton">NIToolbarPhotoViewController::nextButton</a></div><div class="ttdeci">UIBarButtonItem * nextButton</div><div class="ttdoc">The 'next' button. </div><div class="ttdef"><b>Definition:</b> <a href="NIToolbarPhotoViewController_8h_source.html#l00091">NIToolbarPhotoViewController.h:91</a></div></div>
<div class="ttc" id="NIToolbarPhotoViewController_html_animateMovingToNextAndPreviousPhotos"><div class="ttname"><a href="NIToolbarPhotoViewController.html#animateMovingToNextAndPreviousPhotos">NIToolbarPhotoViewController::animateMovingToNextAndPreviousPhotos</a></div><div class="ttdeci">BOOL animateMovingToNextAndPreviousPhotos</div><div class="ttdoc">Whether to animate moving to a next or previous photo when the user taps the button. </div><div class="ttdef"><b>Definition:</b> <a href="NIToolbarPhotoViewController_8h_source.html#l00079">NIToolbarPhotoViewController.h:79</a></div></div>
<div class="ttc" id="NIToolbarPhotoViewController_html_toolbar"><div class="ttname"><a href="NIToolbarPhotoViewController.html#toolbar">NIToolbarPhotoViewController::toolbar</a></div><div class="ttdeci">UIToolbar * toolbar</div><div class="ttdoc">The toolbar view. </div><div class="ttdef"><b>Definition:</b> <a href="NIToolbarPhotoViewController_8h_source.html#l00084">NIToolbarPhotoViewController.h:84</a></div></div>
<div class="ttc" id="NIPhotoAlbumScrollViewDelegate-Protocol_html"><div class="ttname"><a href="NIPhotoAlbumScrollViewDelegate-Protocol.html">NIPhotoAlbumScrollViewDelegate-p</a></div><div class="ttdoc">The photo album scroll view delegate. </div><div class="ttdef"><b>Definition:</b> <a href="NIPhotoAlbumScrollViewDelegate_8h_source.html#l00029">NIPhotoAlbumScrollViewDelegate.h:29</a></div></div>
<div class="ttc" id="NIToolbarPhotoViewController_html_previousButton"><div class="ttname"><a href="NIToolbarPhotoViewController.html#previousButton">NIToolbarPhotoViewController::previousButton</a></div><div class="ttdeci">UIBarButtonItem * previousButton</div><div class="ttdoc">The 'previous' button. </div><div class="ttdef"><b>Definition:</b> <a href="NIToolbarPhotoViewController_8h_source.html#l00092">NIToolbarPhotoViewController.h:92</a></div></div>
<div class="ttc" id="NIPhotoScrubberViewDelegate-Protocol_html"><div class="ttname"><a href="NIPhotoScrubberViewDelegate-Protocol.html">NIPhotoScrubberViewDelegate-p</a></div><div class="ttdoc">The delegate for the photo scrubber. </div><div class="ttdef"><b>Definition:</b> <a href="NIPhotoScrubberView_8h_source.html#l00155">NIPhotoScrubberView.h:155</a></div></div>
<div class="ttc" id="NIPhotoAlbumScrollView_html"><div class="ttname"><a href="NIPhotoAlbumScrollView.html">NIPhotoAlbumScrollView</a></div><div class="ttdoc">A paged scroll view that shows a collection of photos. </div><div class="ttdef"><b>Definition:</b> <a href="NIPhotoAlbumScrollView_8h_source.html#l00041">NIPhotoAlbumScrollView.h:41</a></div></div>
<div class="ttc" id="NIToolbarPhotoViewController_html_toolbarIsTranslucent"><div class="ttname"><a href="NIToolbarPhotoViewController.html#toolbarIsTranslucent">NIToolbarPhotoViewController::toolbarIsTranslucent</a></div><div class="ttdeci">BOOL toolbarIsTranslucent</div><div class="ttdoc">Whether the toolbar is translucent and shows photos beneath it or not. </div><div class="ttdef"><b>Definition:</b> <a href="NIToolbarPhotoViewController_8h_source.html#l00076">NIToolbarPhotoViewController.h:76</a></div></div>
<div class="ttc" id="NIToolbarPhotoViewController_html_chromeCanBeHidden"><div class="ttname"><a href="NIToolbarPhotoViewController.html#chromeCanBeHidden">NIToolbarPhotoViewController::chromeCanBeHidden</a></div><div class="ttdeci">BOOL chromeCanBeHidden</div><div class="ttdoc">Whether or not to allow hiding the chrome. </div><div class="ttdef"><b>Definition:</b> <a href="NIToolbarPhotoViewController_8h_source.html#l00078">NIToolbarPhotoViewController.h:78</a></div></div>
<div class="ttc" id="NIToolbarPhotoViewController_html_photoScrubberView"><div class="ttname"><a href="NIToolbarPhotoViewController.html#photoScrubberView">NIToolbarPhotoViewController::photoScrubberView</a></div><div class="ttdeci">NIPhotoScrubberView * photoScrubberView</div><div class="ttdoc">The photo scrubber view. </div><div class="ttdef"><b>Definition:</b> <a href="NIToolbarPhotoViewController_8h_source.html#l00086">NIToolbarPhotoViewController.h:86</a></div></div>
<div class="ttc" id="NIToolbarPhotoViewController_html"><div class="ttname"><a href="NIToolbarPhotoViewController.html">NIToolbarPhotoViewController</a></div><div class="ttdoc">A simple photo album view controller implementation with a toolbar. </div><div class="ttdef"><b>Definition:</b> <a href="NIToolbarPhotoViewController_8h_source.html#l00072">NIToolbarPhotoViewController.h:72</a></div></div>
<div class="ttc" id="NIPhotoScrubberView_html"><div class="ttname"><a href="NIPhotoScrubberView.html">NIPhotoScrubberView</a></div><div class="ttdoc">A control built for quickly skimming through a collection of images. </div><div class="ttdef"><b>Definition:</b> <a href="NIPhotoScrubberView_8h_source.html#l00049">NIPhotoScrubberView.h:49</a></div></div>
<div class="ttc" id="NIToolbarPhotoViewController_html_hidesChromeWhenScrolling"><div class="ttname"><a href="NIToolbarPhotoViewController.html#hidesChromeWhenScrolling">NIToolbarPhotoViewController::hidesChromeWhenScrolling</a></div><div class="ttdeci">BOOL hidesChromeWhenScrolling</div><div class="ttdoc">Whether or not to hide the chrome when the user begins interacting with the photo. </div><div class="ttdef"><b>Definition:</b> <a href="NIToolbarPhotoViewController_8h_source.html#l00077">NIToolbarPhotoViewController.h:77</a></div></div>
<div class="ttc" id="NIToolbarPhotoViewController_html_photoAlbumView"><div class="ttname"><a href="NIToolbarPhotoViewController.html#photoAlbumView">NIToolbarPhotoViewController::photoAlbumView</a></div><div class="ttdeci">NIPhotoAlbumScrollView * photoAlbumView</div><div class="ttdoc">The photo album view. </div><div class="ttdef"><b>Definition:</b> <a href="NIToolbarPhotoViewController_8h_source.html#l00085">NIToolbarPhotoViewController.h:85</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>