forked from jverkoey/nimbus
/
interface_n_i_overview_graph_page_view.html
386 lines (337 loc) · 17.6 KB
/
interface_n_i_overview_graph_page_view.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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
<!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: NIOverviewGraphPageView Class Reference</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.0 - <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('interface_n_i_overview_graph_page_view.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Methods</a> </div>
<div class="headertitle">
<div class="title">NIOverviewGraphPageView Class Reference<div class="ingroups"><a class="el" href="group___overview-_pages.html">Pages</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="NIOverviewGraphPageView" --><!-- doxytag: inherits="NIOverviewPageView,NIOverviewGraphViewDataSource-p" --><hr/><a name="details" id="details"></a><h2>Overview</h2>
<div class="textblock"><p>A page that renders a graph and two labels. </p>
<p>Definition at line <a class="el" href="_n_i_overview_page_view_8h_source.html#l00086">86</a> of file <a class="el" href="_n_i_overview_page_view_8h_source.html">NIOverviewPageView.h</a>.</p>
</div><div class="dynheader">
Inheritance diagram for NIOverviewGraphPageView:</div>
<div class="dyncontent">
<div class="center">
<img src="interface_n_i_overview_graph_page_view.png" usemap="#NIOverviewGraphPageView_map" alt=""/>
<map id="NIOverviewGraphPageView_map" name="NIOverviewGraphPageView_map">
<area href="interface_n_i_overview_page_view.html" title="A page in the Overview." alt="NIOverviewPageView" shape="rect" coords="0,0,223,24"/>
<area href="protocol_n_i_overview_graph_view_data_source-p.html" title="The data source for NIOverviewGraphView." alt="<NIOverviewGraphViewDataSource>" shape="rect" coords="233,0,456,24"/>
<area href="interface_n_i_overview_disk_page_view.html" title="A page that renders a graph showing free disk space." alt="NIOverviewDiskPageView" shape="rect" coords="0,112,223,136"/>
<area href="interface_n_i_overview_memory_page_view.html" title="A page that renders a graph showing free memory." alt="NIOverviewMemoryPageView" shape="rect" coords="233,112,456,136"/>
</map>
</div></div>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Methods</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(CGFloat) </td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_n_i_overview_graph_view_data_source-p.html#a48bf9d2a25a99a342d274aea2517eb05">graphViewXRange:</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(CGFloat) </td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_n_i_overview_graph_view_data_source-p.html#a3cdac73908b6a5bc9719d3e3d209318f">graphViewYRange:</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_n_i_overview_graph_view_data_source-p.html#a544cc110bf9dc2904df834fedd837f74">resetPointIterator</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(BOOL) </td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_n_i_overview_graph_view_data_source-p.html#a9124b01a4ef642d7170b75783886bb86">nextPointInGraphView:point:</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_n_i_overview_graph_view_data_source-p.html#aa81d70cedade578efcaff7f970d4149d">resetEventIterator</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(BOOL) </td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_n_i_overview_graph_view_data_source-p.html#ac54a8ddf86ca41d49761053e905514d1">nextEventInGraphView:xValue:color:</a></td></tr>
<tr><td colspan="2"><div class="groupHeader">Configuring a Page</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_n_s_string.html">NSString</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_n_i_overview_page_view.html#a416c6693ba905d27333224ae48bfe502">pageTitle</a> <span class="suffix">property</span></td></tr>
<tr><td colspan="2"><div class="groupHeader">Subclassing</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>The following methods are provided to aid in subclassing and are not meant to be used externally. </p>
</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">UILabel * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_n_i_overview_page_view.html#aeac9b8a944c1950941d3f588a2c71db3">titleLabel</a> <span class="suffix">property</span></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(UILabel *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_n_i_overview_page_view.html#a6cb0420c7e99a04a5d47e37387ed1b17">label</a></td></tr>
<tr><td colspan="2"><div class="groupHeader">Creating a Page</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(<a class="el" href="interface_n_i_overview_page_view.html">NIOverviewPageView</a> *) </td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_n_i_overview_page_view.html#a503fd5cf3030558d4d18fce7eaf5c8d4">page</a></td></tr>
<tr><td colspan="2"><div class="groupHeader">Updating a Page</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_n_i_overview_page_view.html#ab5f226b0fae0baeed7b69045bb787fbc">update</a></td></tr>
</table>
<hr/><h2>Method Documentation</h2>
<a class="anchor" id="a416c6693ba905d27333224ae48bfe502"></a><!-- doxytag: member="NIOverviewGraphPageView::pageTitle" ref="a416c6693ba905d27333224ae48bfe502" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (<a class="el" href="class_n_s_string.html">NSString</a>*) pageTitle<code> [read, write, copy, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The title of the page. </p>
<p>Definition at line <a class="el" href="_n_i_overview_page_view_8h_source.html#l00057">57</a> of file <a class="el" href="_n_i_overview_page_view_8h_source.html">NIOverviewPageView.h</a>.</p>
</div>
</div>
<a class="anchor" id="aeac9b8a944c1950941d3f588a2c71db3"></a><!-- doxytag: member="NIOverviewGraphPageView::titleLabel" ref="aeac9b8a944c1950941d3f588a2c71db3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (UILabel*) titleLabel<code> [read, retain, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The title label for this page. </p>
<p>By default this label will be placed flush to the bottom middle of the page. </p>
<p>Definition at line <a class="el" href="_n_i_overview_page_view_8h_source.html#l00071">71</a> of file <a class="el" href="_n_i_overview_page_view_8h_source.html">NIOverviewPageView.h</a>.</p>
</div>
</div>
<a class="anchor" id="a503fd5cf3030558d4d18fce7eaf5c8d4"></a><!-- doxytag: member="NIOverviewGraphPageView::page" ref="a503fd5cf3030558d4d18fce7eaf5c8d4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">+ (<a class="el" href="interface_n_i_overview_page_view.html">NIOverviewPageView</a> *) page </td>
<td></td>
<td class="paramname"></td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns an autoreleased instance of this view. </p>
<p>Definition at line <a class="el" href="_n_i_overview_page_view_8m_source.html#l00055">55</a> of file <a class="el" href="_n_i_overview_page_view_8m_source.html">NIOverviewPageView.m</a>.</p>
</div>
</div>
<a class="anchor" id="ab5f226b0fae0baeed7b69045bb787fbc"></a><!-- doxytag: member="NIOverviewGraphPageView::update" ref="ab5f226b0fae0baeed7b69045bb787fbc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (void) update </td>
<td></td>
<td class="paramname"></td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request that this page update its information. </p>
<p>Should be implemented by the subclass. The default implementation does nothing. </p>
<p>Definition at line <a class="el" href="_n_i_overview_page_view_8m_source.html#l00113">113</a> of file <a class="el" href="_n_i_overview_page_view_8m_source.html">NIOverviewPageView.m</a>.</p>
</div>
</div>
<a class="anchor" id="a6cb0420c7e99a04a5d47e37387ed1b17"></a><!-- doxytag: member="NIOverviewGraphPageView::label" ref="a6cb0420c7e99a04a5d47e37387ed1b17" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (UILabel *) label </td>
<td></td>
<td class="paramname"></td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a generic label for use in the page. </p>
<p>Definition at line <a class="el" href="_n_i_overview_page_view_8m_source.html#l00061">61</a> of file <a class="el" href="_n_i_overview_page_view_8m_source.html">NIOverviewPageView.m</a>.</p>
</div>
</div>
<a class="anchor" id="a48bf9d2a25a99a342d274aea2517eb05"></a><!-- doxytag: member="NIOverviewGraphPageView::graphViewXRange:" ref="a48bf9d2a25a99a342d274aea2517eb05" args="(NIOverviewGraphView *graphView)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (CGFloat) graphViewXRange: </td>
<td></td>
<td class="paramtype">(<a class="el" href="interface_n_i_overview_graph_view.html">NIOverviewGraphView</a> *) </td>
<td class="paramname"><em>graphView</em></td>
<td><code> [required, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fetches the total range of all x values for this graph. </p>
</div>
</div>
<a class="anchor" id="a3cdac73908b6a5bc9719d3e3d209318f"></a><!-- doxytag: member="NIOverviewGraphPageView::graphViewYRange:" ref="a3cdac73908b6a5bc9719d3e3d209318f" args="(NIOverviewGraphView *graphView)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (CGFloat) graphViewYRange: </td>
<td></td>
<td class="paramtype">(<a class="el" href="interface_n_i_overview_graph_view.html">NIOverviewGraphView</a> *) </td>
<td class="paramname"><em>graphView</em></td>
<td><code> [required, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fetches the total range of all y values for this graph. </p>
</div>
</div>
<a class="anchor" id="a544cc110bf9dc2904df834fedd837f74"></a><!-- doxytag: member="NIOverviewGraphPageView::resetPointIterator" ref="a544cc110bf9dc2904df834fedd837f74" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (void) resetPointIterator </td>
<td></td>
<td class="paramname"></td>
<td><code> [required, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The data source should reset its iterator for fetching points in the graph. </p>
</div>
</div>
<a class="anchor" id="a9124b01a4ef642d7170b75783886bb86"></a><!-- doxytag: member="NIOverviewGraphPageView::nextPointInGraphView:point:" ref="a9124b01a4ef642d7170b75783886bb86" args="(NIOverviewGraphView *graphView,[point] CGPoint *point)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (BOOL) nextPointInGraphView: </td>
<td></td>
<td class="paramtype">(<a class="el" href="interface_n_i_overview_graph_view.html">NIOverviewGraphView</a> *) </td>
<td class="paramname"><em>graphView</em></td>
</tr>
<tr>
<td class="paramkey">point:</td>
<td></td>
<td class="paramtype">(CGPoint *) </td>
<td class="paramname"><em>point</em> </td>
</tr>
<tr>
<td></td>
<td></td>
<td></td><td><code> [required, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fetches the next point in the graph to plot. </p>
</div>
</div>
<a class="anchor" id="aa81d70cedade578efcaff7f970d4149d"></a><!-- doxytag: member="NIOverviewGraphPageView::resetEventIterator" ref="aa81d70cedade578efcaff7f970d4149d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (void) resetEventIterator </td>
<td></td>
<td class="paramname"></td>
<td><code> [required, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The data source should reset its iterator for fetching events in the graph. </p>
</div>
</div>
<a class="anchor" id="ac54a8ddf86ca41d49761053e905514d1"></a><!-- doxytag: member="NIOverviewGraphPageView::nextEventInGraphView:xValue:color:" ref="ac54a8ddf86ca41d49761053e905514d1" args="(NIOverviewGraphView *graphView,[xValue] CGFloat *xValue,[color] UIColor **color)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (BOOL) nextEventInGraphView: </td>
<td></td>
<td class="paramtype">(<a class="el" href="interface_n_i_overview_graph_view.html">NIOverviewGraphView</a> *) </td>
<td class="paramname"><em>graphView</em></td>
</tr>
<tr>
<td class="paramkey">xValue:</td>
<td></td>
<td class="paramtype">(CGFloat *) </td>
<td class="paramname"><em>xValue</em></td>
</tr>
<tr>
<td class="paramkey">color:</td>
<td></td>
<td class="paramtype">(UIColor **) </td>
<td class="paramname"><em>color</em> </td>
</tr>
<tr>
<td></td>
<td></td>
<td></td><td><code> [required, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fetches the next event in the graph to plot. </p>
</div>
</div>
<div id="disqus_thread"></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="interface_n_i_overview_graph_page_view.html">NIOverviewGraphPageView</a> </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>