-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathNITableViewModel_8h_source.html
186 lines (186 loc) · 21.5 KB
/
NITableViewModel_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
<!-- 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/models/src/NITableViewModel.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('NITableViewModel_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">NITableViewModel.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 "NIPreprocessorMacros.h"</span> <span class="comment">/* for weak */</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#if NS_BLOCKS_AVAILABLE</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"></span><span class="keyword">typedef</span> UITableViewCell* (^NITableViewModelCellForIndexPathBlock)(UITableView* tableView, NSIndexPath* indexPath, <span class="keywordtype">id</span> <span class="keywordtype">object</span>);</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#endif // #if NS_BLOCKS_AVAILABLE</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">@protocol </span><a class="code" href="NITableViewModelDelegate-Protocol.html">NITableViewModelDelegate</a>;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#pragma mark Sectioned Array Objects</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// Classes used when creating NITableViewModels.</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">@class</span> <a class="code" href="NITableViewModelFooter.html">NITableViewModelFooter</a>; <span class="comment">// Provides the information for a footer.</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  NITableViewModelSectionIndexNone, <span class="comment">// Displays no section index.</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  NITableViewModelSectionIndexDynamic, <span class="comment">// Generates a section index from the first letters of the section titles.</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  NITableViewModelSectionIndexAlphabetical, <span class="comment">// Generates an alphabetical section index.</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> } NITableViewModelSectionIndex;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="NITableViewModel.html"> 51</a></span> <span class="keyword">@interface </span><a class="code" href="NITableViewModel.html">NITableViewModel</a> : NSObject <UITableViewDataSource></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#pragma mark Creating Table View Models</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">// Designated initializer.</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> - (id)initWithDelegate:(<span class="keywordtype">id</span><<a class="code" href="NITableViewModelDelegate-Protocol.html">NITableViewModelDelegate</a>>)delegate;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> - (id)initWithListArray:(NSArray *)sectionedArray delegate:(<span class="keywordtype">id</span><<a class="code" href="NITableViewModelDelegate-Protocol.html">NITableViewModelDelegate</a>>)delegate;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">// Each NSString in the array starts a new section. Any other object is a new row (with exception of certain model-specific objects).</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> - (id)initWithSectionedArray:(NSArray *)sectionedArray delegate:(<span class="keywordtype">id</span><<a class="code" href="NITableViewModelDelegate-Protocol.html">NITableViewModelDelegate</a>>)delegate;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor">#pragma mark Accessing Objects</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> - (id)objectAtIndexPath:(NSIndexPath *)indexPath;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment">// This method is not appropriate for performance critical codepaths.</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> - (NSIndexPath *)indexPathForObject:(<span class="keywordtype">id</span>)object;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor">#pragma mark Configuration</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">// Immediately compiles the section index.</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> - (void)setSectionIndexType:(NITableViewModelSectionIndex)sectionIndexType showsSearch:(BOOL)showsSearch showsSummary:(BOOL)showsSummary;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="NITableViewModel.html#sectionIndexType"> 73</a></span> <span class="keyword">@property</span> (nonatomic, readonly, assign) NITableViewModelSectionIndex <a class="code" href="NITableViewModel.html#sectionIndexType">sectionIndexType</a>; <span class="comment">// Default: NITableViewModelSectionIndexNone</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="NITableViewModel.html#sectionIndexShowsSearch"> 74</a></span> <span class="keyword">@property</span> (nonatomic, readonly, assign) BOOL <a class="code" href="NITableViewModel.html#sectionIndexShowsSearch">sectionIndexShowsSearch</a>; <span class="comment">// Default: NO</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="NITableViewModel.html#sectionIndexShowsSummary"> 75</a></span> <span class="keyword">@property</span> (nonatomic, readonly, assign) BOOL <a class="code" href="NITableViewModel.html#sectionIndexShowsSummary">sectionIndexShowsSummary</a>; <span class="comment">// Default: NO</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor">#pragma mark Creating Table View Cells</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="NITableViewModel.html#delegate"> 79</a></span> <span class="keyword">@property</span> (nonatomic, weak) id<NITableViewModelDelegate> delegate;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor">#if NS_BLOCKS_AVAILABLE</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor"></span><span class="comment">// If both the delegate and this block are provided, cells returned by this block will be used</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment">// and the delegate will not be called.</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="NITableViewModel.html#createCellBlock"> 84</a></span> <span class="keyword">@property</span> (nonatomic, copy) NITableViewModelCellForIndexPathBlock <a class="code" href="NITableViewModel.html#createCellBlock">createCellBlock</a>;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor">#endif // #if NS_BLOCKS_AVAILABLE</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="keyword">@end</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="NITableViewModelDelegate-Protocol.html"> 94</a></span> <span class="keyword">@protocol </span><a class="code" href="NITableViewModelDelegate-Protocol.html">NITableViewModelDelegate</a> <NSObject></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="keyword">@required</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> - (UITableViewCell *)tableViewModel: (<a class="code" href="NITableViewModel.html">NITableViewModel</a> *)tableViewModel</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  cellForTableView: (UITableView *)tableView</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  atIndexPath: (NSIndexPath *)indexPath</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  withObject: (<span class="keywordtype">id</span>)object;</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="keyword">@end</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div>
<div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="NITableViewModelFooter.html"> 121</a></span> <span class="keyword">@interface </span><a class="code" href="NITableViewModelFooter.html">NITableViewModelFooter</a> : NSObject</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> + (id)footerWithTitle:(NSString *)title;</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> - (id)initWithTitle:(NSString *)title;</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="keyword">@property</span> (nonatomic, copy) NSString* title;</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="keyword">@end</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div>
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="preprocessor">#if NS_BLOCKS_AVAILABLE</span></div>
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="preprocessor">#endif // #if NS_BLOCKS_AVAILABLE</span></div>
<div class="ttc" id="NITableViewModel_html_sectionIndexType"><div class="ttname"><a href="NITableViewModel.html#sectionIndexType">NITableViewModel::sectionIndexType</a></div><div class="ttdeci">NITableViewModelSectionIndex sectionIndexType</div><div class="ttdoc">The section index type. </div><div class="ttdef"><b>Definition:</b> <a href="NITableViewModel_8h_source.html#l00073">NITableViewModel.h:73</a></div></div>
<div class="ttc" id="NITableViewModel_html_createCellBlock"><div class="ttname"><a href="NITableViewModel.html#createCellBlock">NITableViewModel::createCellBlock</a></div><div class="ttdeci">NITableViewModelCellForIndexPathBlock createCellBlock</div><div class="ttdoc">A block used to create a UITableViewCell for a given object. </div><div class="ttdef"><b>Definition:</b> <a href="NITableViewModel_8h_source.html#l00084">NITableViewModel.h:84</a></div></div>
<div class="ttc" id="NITableViewModel_html"><div class="ttname"><a href="NITableViewModel.html">NITableViewModel</a></div><div class="ttdoc">A non-mutable table view model that complies to the UITableViewDataSource protocol. </div><div class="ttdef"><b>Definition:</b> <a href="NITableViewModel_8h_source.html#l00051">NITableViewModel.h:51</a></div></div>
<div class="ttc" id="NITableViewModel_html_sectionIndexShowsSearch"><div class="ttname"><a href="NITableViewModel.html#sectionIndexShowsSearch">NITableViewModel::sectionIndexShowsSearch</a></div><div class="ttdeci">BOOL sectionIndexShowsSearch</div><div class="ttdoc">Whether or not the search symbol will be shown in the section index. </div><div class="ttdef"><b>Definition:</b> <a href="NITableViewModel_8h_source.html#l00074">NITableViewModel.h:74</a></div></div>
<div class="ttc" id="NITableViewModelFooter_html"><div class="ttname"><a href="NITableViewModelFooter.html">NITableViewModelFooter</a></div><div class="ttdoc">An object used in sectioned arrays to denote a section footer title. </div><div class="ttdef"><b>Definition:</b> <a href="NITableViewModel_8h_source.html#l00121">NITableViewModel.h:121</a></div></div>
<div class="ttc" id="NITableViewModel_html_sectionIndexShowsSummary"><div class="ttname"><a href="NITableViewModel.html#sectionIndexShowsSummary">NITableViewModel::sectionIndexShowsSummary</a></div><div class="ttdeci">BOOL sectionIndexShowsSummary</div><div class="ttdoc">Whether or not the summary symbol will be shown in the section index. </div><div class="ttdef"><b>Definition:</b> <a href="NITableViewModel_8h_source.html#l00075">NITableViewModel.h:75</a></div></div>
<div class="ttc" id="NITableViewModelDelegate-Protocol_html"><div class="ttname"><a href="NITableViewModelDelegate-Protocol.html">NITableViewModelDelegate-p</a></div><div class="ttdoc">A protocol for NITableViewModel to fetch rows to be displayed for the table view. ...</div><div class="ttdef"><b>Definition:</b> <a href="NITableViewModel_8h_source.html#l00094">NITableViewModel.h:94</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>