-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathNIWebController.html
281 lines (261 loc) · 14 KB
/
NIWebController.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
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
<!-- 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: NIWebController Class Reference</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('NIWebController.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="classNIWebController-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NIWebController Class Reference<div class="ingroups"><a class="el" href="NimbusWebController.html">Nimbus Web Controller</a></div></div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>A simple web view controller implementation with a toolbar. </p>
<h2>Subclassing</h2>
<p>This view controller implements <a class="el" href="classUIWebViewDelegate-Protocol.html">UIWebViewDelegate</a>. If you want to implement methods of this delegate then you should take care to call the super implementation if necessary. The following UIViewWebDelegate methods have implementations in this class:</p>
<div class="fragment"><div class="line">- <a class="code" href="NIWebController.html#webView">webView</a>:shouldStartLoadWithRequest:navigationType:</div>
<div class="line">- webViewDidStartLoad:</div>
<div class="line">- webViewDidFinishLoad:</div>
<div class="line">- <a class="code" href="NIWebController.html#webView">webView</a>:didFailLoadWithError:</div>
</div><!-- fragment --><p>This view controller also implements <a class="el" href="classUIActionSheetDelegate-Protocol.html">UIActionSheetDelegate</a>. If you want to implement methods of this delegate then you should take care to call the super implementation if necessary. The following <a class="el" href="classUIActionSheetDelegate-Protocol.html">UIActionSheetDelegate</a> methods have implementations in this class:</p>
<div class="fragment"><div class="line">- actionSheet:clickedButtonAtIndex:</div>
<div class="line">- actionSheet:didDismissWithButtonIndex:</div>
</div><!-- fragment --><p>In addition to the above methods of the <a class="el" href="classUIActionSheetDelegate-Protocol.html">UIActionSheetDelegate</a>, this view controller also provides the following method, which is invoked prior to presenting the internal action sheet to the user and allows subclasses to customize the action sheet or even reject to display it (and provide their own handling instead):</p>
<div class="fragment"><div class="line">- shouldPresentActionSheet:</div>
</div><!-- fragment --><h2>Recommended Configurations</h2>
<h3>Default</h3>
<p>The default settings will create a toolbar with the default tint color, which is normally light blue on the iPhone and gray on the iPad.</p>
<h3>Colored Toolbar</h3>
<p>The following settings will change the toolbar tint color (in this case black)</p>
<div class="fragment"><div class="line">[webController setToolbarTintColor:[UIColor blackColor]];</div>
</div><!-- fragment --> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Tasks</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Accessing the Toolbar</div></td></tr>
<tr class="memitem:toolbar"><td class="memItemLeft" align="right" valign="top">UIToolbar * </td><td class="memItemRight" valign="bottom"><a class="el" href="NIWebController.html#toolbar">toolbar</a> <span class="suffix">property</span></td></tr>
<tr class="separator:toolbar"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:toolbarHidden"><td class="memItemLeft" align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="NIWebController.html#toolbarHidden">toolbarHidden</a> <span class="suffix">property</span></td></tr>
<tr class="separator:toolbarHidden"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:toolbarTintColor"><td class="memItemLeft" align="right" valign="top">UIColor * </td><td class="memItemRight" valign="bottom"><a class="el" href="NIWebController.html#toolbarTintColor">toolbarTintColor</a> <span class="suffix">property</span></td></tr>
<tr class="separator:toolbarTintColor"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Accessing the Web View</div></td></tr>
<tr class="memitem:webView"><td class="memItemLeft" align="right" valign="top">UIWebView * </td><td class="memItemRight" valign="bottom"><a class="el" href="NIWebController.html#webView">webView</a> <span class="suffix">property</span></td></tr>
<tr class="separator:webView"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Creating a Web Controller</div></td></tr>
<tr class="memitem:initWithRequest:"><td class="memItemLeft" align="right" valign="top">(id) </td><td class="memItemRight" valign="bottom">- <a class="el" href="NIWebController.html#initWithRequest:">initWithRequest:</a></td></tr>
<tr class="separator:initWithRequest:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:initWithURL:"><td class="memItemLeft" align="right" valign="top">(id) </td><td class="memItemRight" valign="bottom">- <a class="el" href="NIWebController.html#initWithURL:">initWithURL:</a></td></tr>
<tr class="separator:initWithURL:"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Loading a Request</div></td></tr>
<tr class="memitem:openURL:"><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="NIWebController.html#openURL:">openURL:</a></td></tr>
<tr class="separator:openURL:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:openRequest:"><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="NIWebController.html#openRequest:">openRequest:</a></td></tr>
<tr class="separator:openRequest:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:openHTMLString:baseURL:"><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="NIWebController.html#openHTMLString:baseURL:">openHTMLString:baseURL:</a></td></tr>
<tr class="separator:openHTMLString:baseURL:"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Subclassing the Web Controller</div></td></tr>
<tr class="memitem:shouldPresentActionSheet:"><td class="memItemLeft" align="right" valign="top">(BOOL) </td><td class="memItemRight" valign="bottom">- <a class="el" href="NIWebController.html#shouldPresentActionSheet:">shouldPresentActionSheet:</a></td></tr>
<tr class="separator:shouldPresentActionSheet:"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Method Documentation</h2>
<a class="anchor" id="toolbar"></a>
<div class="memitem">
<h3 class="memname">toolbar</h3>
<div class="memdoc">
<p class="abstract">The toolbar. </p>
<div class="declaration">
@property (nonatomic, readonly, strong) UIToolbar* toolbar;</td></tr>
</div>
</div>
</div>
<a class="anchor" id="toolbarHidden"></a>
<div class="memitem">
<h3 class="memname">toolbarHidden</h3>
<div class="memdoc">
<p class="abstract">The visibility of the toolbar. </p>
<div class="declaration">
@property (nonatomic) BOOL toolbarHidden;</td></tr>
</div>
<h5>Discussion</h5>
<p>If the toolbar is hidden then the web view will take up the controller's entire view. </p>
</div>
</div>
<a class="anchor" id="toolbarTintColor"></a>
<div class="memitem">
<h3 class="memname">toolbarTintColor</h3>
<div class="memdoc">
<p class="abstract">The tint color of the toolbar. </p>
<div class="declaration">
@property (nonatomic, weak) UIColor* toolbarTintColor;</td></tr>
</div>
</div>
</div>
<a class="anchor" id="webView"></a>
<div class="memitem">
<h3 class="memname">webView</h3>
<div class="memdoc">
<p class="abstract">The internal web view. </p>
<div class="declaration">
@property (nonatomic, readonly, strong) UIWebView* webView;</td></tr>
</div>
</div>
</div>
<a class="anchor" id="initWithRequest:"></a>
<div class="memitem">
<h3 class="memname">initWithRequest:</h3>
<div class="memdoc">
<p class="abstract">Initializes a newly allocated web controller with a given request. </p>
<div class="declaration">
- (id)initWithRequest:(NSURLRequest *)request;</td></tr>
</div>
<h5>Discussion</h5>
<p>Once the controller is presented it will begin loading the given request.</p>
<p>This is the designated initializer. </p>
</div>
</div>
<a class="anchor" id="initWithURL:"></a>
<div class="memitem">
<h3 class="memname">initWithURL:</h3>
<div class="memdoc">
<p class="abstract">Initializes a newly allocated web controller with a given URL to request. </p>
<div class="declaration">
- (id)initWithURL:(NSURL *)URL;</td></tr>
</div>
<h5>Discussion</h5>
<p>Once the controller is presented it will begin loading the given URL. </p>
</div>
</div>
<a class="anchor" id="openURL:"></a>
<div class="memitem">
<h3 class="memname">openURL:</h3>
<div class="memdoc">
<p class="abstract">Loads a request with the given URL in the web view. </p>
<div class="declaration">
- (void)openURL:(NSURL *)URL;</td></tr>
</div>
</div>
</div>
<a class="anchor" id="openRequest:"></a>
<div class="memitem">
<h3 class="memname">openRequest:</h3>
<div class="memdoc">
<p class="abstract">Load the given request using UIWebView's loadRequest:. </p>
<div class="declaration">
- (void)openRequest:(NSURLRequest *)request;</td></tr>
</div>
<h5>Discussion</h5>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">request</td><td>A URL request identifying the location of the content to load. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="openHTMLString:baseURL:"></a>
<div class="memitem">
<h3 class="memname">openHTMLString:baseURL:</h3>
<div class="memdoc">
<p class="abstract">Load the given request using UIWebView's loadHTMLString:baseURL:. </p>
<div class="declaration">
- (void)openHTMLString:(NSString *)htmlString baseURL:(NSURL *)baseUrl;</td></tr>
</div>
<h5>Discussion</h5>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">htmlString</td><td>The content for the main page. </td></tr>
<tr><td class="paramname">baseUrl</td><td>The base URL for the content. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="shouldPresentActionSheet:"></a>
<div class="memitem">
<h3 class="memname">shouldPresentActionSheet:</h3>
<div class="memdoc">
<p class="abstract">This message is called in response to the user clicking the action toolbar button. </p>
<div class="declaration">
- (BOOL)shouldPresentActionSheet:(UIActionSheet *)actionSheet;</td></tr>
</div>
<h5>Discussion</h5>
<p>You can provide your own implementation in your subclass and customize the actionSheet that is shown to the user or even cancel the presentation of the <code>actionSheet</code> by returning NO from your implementation.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">actionSheet</td><td>The UIActionSheet that will be presented to the user. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>YES to present the actionSheet, NO if you want to perform a custom action. </dd></dl>
</div>
</div>
</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>