forked from jverkoey/nimbus
-
Notifications
You must be signed in to change notification settings - Fork 0
/
interface_n_i_overview.html
186 lines (158 loc) · 9.32 KB
/
interface_n_i_overview.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
<!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: NIOverview 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.6.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.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">NIOverview Class Reference<div class="ingroups"><a class="el" href="group___overview.html">Overview</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="NIOverview" --><hr/><a name="details" id="details"></a><h2>Overview</h2>
<div class="textblock"><p>The Overview state management class. </p>
<h2>What is the Overview?</h2>
<p>The Overview is a paged view that sits directly below the status bar and presents information about the device and the currently running application. The Overview is extensible, in that you can write your own pages and add them to the Overview. The included pages allow you to see the current and historical state of memory and disk use, the console logs, and important events that have occurred (such as memory warnings).</p>
<h2>Before Using the Overview</h2>
<p>None of the Overview methods will do anything unless you have the DEBUG preprocessor macro defined. This is by design. The Overview swizzles private API methods in order to trick the device into showing the Overview as part of the status bar.</p>
<p>DO *NOT* SUBMIT YOUR APP TO THE APP STORE WITH DEBUG DEFINED.</p>
<p>If you submit your app to the App Store with DEBUG defined, you *will* be rejected. Overview works only because it hacks certain aspects of the device using private APIs and method swizzling. For good reason, Apple will not look too kindly to the Overview being included in production code. If Apple ever changes any of the APIs that the Overview depends on then the Overview would break. </p>
<p>Definition at line <a class="el" href="_n_i_overview_8h_source.html#l00050">50</a> of file <a class="el" href="_n_i_overview_8h_source.html">NIOverview.h</a>.</p>
</div><table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Methods</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Initializing the Overview</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.html#af70180942bcd7b774d4311154a7181f7">applicationDidFinishLaunching</a></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.html#a1bb1fd53f838e9630e68c77efd75d5e3">addOverviewToWindow:</a></td></tr>
<tr><td colspan="2"><div class="groupHeader">Accessing State Information</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae16e8cc5ef3a0bc2bd0fb212ded7b526"></a><!-- doxytag: member="NIOverview::height" ref="ae16e8cc5ef3a0bc2bd0fb212ded7b526" args="()" -->
(CGFloat) </td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_n_i_overview.html#ae16e8cc5ef3a0bc2bd0fb212ded7b526">height</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc2d59e7ca18b42b762c605e391ba01c"></a><!-- doxytag: member="NIOverview::frame" ref="acc2d59e7ca18b42b762c605e391ba01c" args="()" -->
(CGRect) </td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_n_i_overview.html#acc2d59e7ca18b42b762c605e391ba01c">frame</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a52cf10f473a6d46224a2583ad5fc3cbe"></a><!-- doxytag: member="NIOverview::view" ref="a52cf10f473a6d46224a2583ad5fc3cbe" args="()" -->
(<a class="el" href="interface_n_i_overview_view.html">NIOverviewView</a> *) </td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_n_i_overview.html#a52cf10f473a6d46224a2583ad5fc3cbe">view</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(<a class="el" href="interface_n_i_overview_logger.html">NIOverviewLogger</a> *) </td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_n_i_overview.html#acd1228a794482118056b0c5d7fb62683">logger</a></td></tr>
</table>
<hr/><h2>Method Documentation</h2>
<a class="anchor" id="af70180942bcd7b774d4311154a7181f7"></a><!-- doxytag: member="NIOverview::applicationDidFinishLaunching" ref="af70180942bcd7b774d4311154a7181f7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">+ (void) applicationDidFinishLaunching </td>
<td></td>
<td class="paramname"></td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Call this immediately in application:didFinishLaunchingWithOptions:. </p>
<p>Swizzles the necessary methods for adding the Overview to the view hierarchy and registers notifications for device state changes. </p>
<p>Definition at line <a class="el" href="_n_i_overview_8m_source.html#l00223">223</a> of file <a class="el" href="_n_i_overview_8m_source.html">NIOverview.m</a>.</p>
</div>
</div>
<a class="anchor" id="a1bb1fd53f838e9630e68c77efd75d5e3"></a><!-- doxytag: member="NIOverview::addOverviewToWindow:" ref="a1bb1fd53f838e9630e68c77efd75d5e3" args="(UIWindow *window)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">+ (void) addOverviewToWindow: </td>
<td></td>
<td class="paramtype">(UIWindow *) </td>
<td class="paramname"><em>window</em></td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds the Overview to the given window. </p>
<p>The Overview will always be fixed at the top of the device's screen directly beneath the status bar (if it is visible). </p>
<p>Definition at line <a class="el" href="_n_i_overview_8m_source.html#l00261">261</a> of file <a class="el" href="_n_i_overview_8m_source.html">NIOverview.m</a>.</p>
</div>
</div>
<a class="anchor" id="acd1228a794482118056b0c5d7fb62683"></a><!-- doxytag: member="NIOverview::logger" ref="acd1228a794482118056b0c5d7fb62683" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">+ (<a class="el" href="interface_n_i_overview_logger.html">NIOverviewLogger</a> *) logger </td>
<td></td>
<td class="paramname"></td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The Overview logger. </p>
<p>This is the logger that all of the Overview pages use to present their information. </p>
<p>Definition at line <a class="el" href="_n_i_overview_8m_source.html#l00290">290</a> of file <a class="el" href="_n_i_overview_8m_source.html">NIOverview.m</a>.</p>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="interface_n_i_overview.html">NIOverview</a> </li>
</div><!-- .fixedwidth -->
<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>