Common-Metrics.html

<!-- 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: Common Metrics</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
   &#160;<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('Common-Metrics.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Common Metrics<div class="ingroups"><a class="el" href="NimbusCore.html">Nimbus Core</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gNIMinimumTapDimension"><td class="memItemLeft" align="right" valign="top">CGFloat&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Common-Metrics.html#gNIMinimumTapDimension">NIMinimumTapDimension</a> (void)</td></tr>
<tr class="separator:gNIMinimumTapDimension"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gNIToolbarHeightForOrientation"><td class="memItemLeft" align="right" valign="top">CGFloat&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Common-Metrics.html#gNIToolbarHeightForOrientation">NIToolbarHeightForOrientation</a> (UIInterfaceOrientation orientation)</td></tr>
<tr class="separator:gNIToolbarHeightForOrientation"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gNIStatusBarAnimationCurve"><td class="memItemLeft" align="right" valign="top">UIViewAnimationCurve&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Common-Metrics.html#gNIStatusBarAnimationCurve">NIStatusBarAnimationCurve</a> (void)</td></tr>
<tr class="separator:gNIStatusBarAnimationCurve"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gNIStatusBarAnimationDuration"><td class="memItemLeft" align="right" valign="top">NSTimeInterval&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Common-Metrics.html#gNIStatusBarAnimationDuration">NIStatusBarAnimationDuration</a> (void)</td></tr>
<tr class="separator:gNIStatusBarAnimationDuration"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gNIStatusBarBoundsChangeAnimationCurve"><td class="memItemLeft" align="right" valign="top">UIViewAnimationCurve&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Common-Metrics.html#gNIStatusBarBoundsChangeAnimationCurve">NIStatusBarBoundsChangeAnimationCurve</a> (void)</td></tr>
<tr class="separator:gNIStatusBarBoundsChangeAnimationCurve"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gNIStatusBarBoundsChangeAnimationDuration"><td class="memItemLeft" align="right" valign="top">NSTimeInterval&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Common-Metrics.html#gNIStatusBarBoundsChangeAnimationDuration">NIStatusBarBoundsChangeAnimationDuration</a> (void)</td></tr>
<tr class="separator:gNIStatusBarBoundsChangeAnimationDuration"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gNIStatusBarHeight"><td class="memItemLeft" align="right" valign="top">CGFloat&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Common-Metrics.html#gNIStatusBarHeight">NIStatusBarHeight</a> (void)</td></tr>
<tr class="separator:gNIStatusBarHeight"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gNIDeviceRotationDuration"><td class="memItemLeft" align="right" valign="top">NSTimeInterval&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Common-Metrics.html#gNIDeviceRotationDuration">NIDeviceRotationDuration</a> (BOOL isFlippingUpsideDown)</td></tr>
<tr class="separator:gNIDeviceRotationDuration"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gNICellContentPadding"><td class="memItemLeft" align="right" valign="top">UIEdgeInsets&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Common-Metrics.html#gNICellContentPadding">NICellContentPadding</a> (void)</td></tr>
<tr class="separator:gNICellContentPadding"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<p>For common system metrics. </p>
<p>If you work with system metrics in any way it can be a pain in the ass to figure out what the exact metrics are. Figuring out how long it takes the status bar to animate is not something you should be spending your time on. The metrics in this file are provided as a means of unifying a number of system metrics for use in your applications.</p>
<h2>What Qualifies as a Common Metric</h2>
<p>Common metrics are system components, such as the dimensions of a toolbar in a particular orientation or the duration of a standard animation. This is not the place to put feature-specific metrics, such as the height of a photo scrubber view.</p>
<h2>Examples</h2>
<h3>Positioning a Toolbar</h3>
<p>The following example updates the position and height of a toolbar when the device orientation is changing. This ensures that, in landscape mode on the iPhone, the toolbar is slightly shorter to accomodate the smaller height of the screen.</p>
<div class="fragment"><div class="line">- (void)willAnimateRotationToInterfaceOrientation:(UIInterfaceOrientation)toInterfaceOrientation</div>
<div class="line">                                         duration:(NSTimeInterval)duration {</div>
<div class="line">  [super willAnimateRotationToInterfaceOrientation:toInterfaceOrientation duration:duration];</div>
<div class="line"></div>
<div class="line">  CGRect toolbarFrame = <span class="keyword">self</span>.toolbar.frame;</div>
<div class="line">  toolbarFrame.size.height = <a class="code" href="Common-Metrics.html#gNIToolbarHeightForOrientation">NIToolbarHeightForOrientation</a>(toInterfaceOrientation);</div>
<div class="line">  toolbarFrame.origin.y = <span class="keyword">self</span>.view.bounds.size.height - toolbarFrame.size.height;</div>
<div class="line">  <span class="keyword">self</span>.toolbar.frame = toolbarFrame;</div>
<div class="line">}</div>
</div><!-- fragment --> <h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gNIMinimumTapDimension"></a>
<div class="memitem">
      <h3 class="memname">NIMinimumTapDimension</h3>
<div class="memdoc">

<p class="abstract">The recommended number of points for a minimum tappable area. </p>
<div class="declaration">
CGFloat NIMinimumTapDimension:;</td></tr>
</div>
<h5>Discussion</h5>
<p>Value: 44 </p>

</div>
</div>
<a class="anchor" id="gNIToolbarHeightForOrientation"></a>
<div class="memitem">
      <h3 class="memname">NIToolbarHeightForOrientation</h3>
<div class="memdoc">

<p class="abstract">Fetch the height of a toolbar in a given orientation. </p>
<div class="declaration">
CGFloat NIToolbarHeightForOrientation:(UIInterfaceOrientation)orientation;</td></tr>
</div>
<h5>Discussion</h5>
<p>On the iPhone:</p>
<ul>
<li>Portrait: 44</li>
<li>Landscape: 33</li>
</ul>
<p>On the iPad: always 44 </p>

</div>
</div>
<a class="anchor" id="gNIStatusBarAnimationCurve"></a>
<div class="memitem">
      <h3 class="memname">NIStatusBarAnimationCurve</h3>
<div class="memdoc">

<p class="abstract">The animation curve used when changing the status bar's visibility. </p>
<div class="declaration">
UIViewAnimationCurve NIStatusBarAnimationCurve:;</td></tr>
</div>
<h5>Discussion</h5>
<p>This is the curve of the animation used by <code>-[[UIApplication sharedApplication] setStatusBarHidden:withAnimation:].</code></p>
<p>Value: UIViewAnimationCurveEaseIn </p>

</div>
</div>
<a class="anchor" id="gNIStatusBarAnimationDuration"></a>
<div class="memitem">
      <h3 class="memname">NIStatusBarAnimationDuration</h3>
<div class="memdoc">

<p class="abstract">The animation duration used when changing the status bar's visibility. </p>
<div class="declaration">
NSTimeInterval NIStatusBarAnimationDuration:;</td></tr>
</div>
<h5>Discussion</h5>
<p>This is the duration of the animation used by <code>-[[UIApplication sharedApplication] setStatusBarHidden:withAnimation:].</code></p>
<p>Value: 0.3 seconds </p>

</div>
</div>
<a class="anchor" id="gNIStatusBarBoundsChangeAnimationCurve"></a>
<div class="memitem">
      <h3 class="memname">NIStatusBarBoundsChangeAnimationCurve</h3>
<div class="memdoc">

<p class="abstract">The animation curve used when the status bar's bounds change (when a call is received, for example). </p>
<div class="declaration">
UIViewAnimationCurve NIStatusBarBoundsChangeAnimationCurve:;</td></tr>
</div>
<h5>Discussion</h5>
<p>Value: UIViewAnimationCurveEaseInOut </p>

</div>
</div>
<a class="anchor" id="gNIStatusBarBoundsChangeAnimationDuration"></a>
<div class="memitem">
      <h3 class="memname">NIStatusBarBoundsChangeAnimationDuration</h3>
<div class="memdoc">

<p class="abstract">The animation duration used when the status bar's bounds change (when a call is received, for example). </p>
<div class="declaration">
NSTimeInterval NIStatusBarBoundsChangeAnimationDuration:;</td></tr>
</div>
<h5>Discussion</h5>
<p>Value: 0.35 seconds </p>

</div>
</div>
<a class="anchor" id="gNIStatusBarHeight"></a>
<div class="memitem">
      <h3 class="memname">NIStatusBarHeight</h3>
<div class="memdoc">

<p class="abstract">Get the status bar's current height. </p>
<div class="declaration">
CGFloat NIStatusBarHeight:;</td></tr>
</div>
<h5>Discussion</h5>
<p>If the status bar is hidden this will return 0.</p>
<p>This is generally 20 when the status bar is its normal height. </p>

</div>
</div>
<a class="anchor" id="gNIDeviceRotationDuration"></a>
<div class="memitem">
      <h3 class="memname">NIDeviceRotationDuration</h3>
<div class="memdoc">

<p class="abstract">The animation duration when the device is rotating to a new orientation. </p>
<div class="declaration">
NSTimeInterval NIDeviceRotationDuration:(BOOL)isFlippingUpsideDown;</td></tr>
</div>
<h5>Discussion</h5>
<p>Value: 0.4 seconds if the device is being rotated 90 degrees. 0.8 seconds if the device is being rotated 180 degrees.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">isFlippingUpsideDown</td><td>YES if the device is being flipped upside down. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="gNICellContentPadding"></a>
<div class="memitem">
      <h3 class="memname">NICellContentPadding</h3>
<div class="memdoc">

<p class="abstract">The padding around a standard cell in a table view. </p>
<div class="declaration">
UIEdgeInsets NICellContentPadding:;</td></tr>
</div>
<h5>Discussion</h5>
<p>Value: 10 pixels on all sides. </p>

</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>