Files

1032 lines
24 KiB
HTML

<!DOCTYPE HTML>
<html>
<head>
<meta http-equiv="Content-Type" content="html/html; charset=utf-8" />
<title>M13ProgressViewMetro Class Reference</title>
<meta id="xcode-display" name="xcode-display" content="render"/>
<link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" />
<link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" />
<meta name="generator" content="appledoc 2.2 (build 961)" />
</head>
<body>
<header id="top_header">
<div id="library" class="hideInXcode">
<h1><a id="libraryTitle" href="../index.html">M13ProgressSuite </a></h1>
<a id="developerHome" href="../index.html">Marxon13 Productions (Brandon McQuilkin)</a>
</div>
<div id="title" role="banner">
<h1 class="hideInXcode">M13ProgressViewMetro Class Reference</h1>
</div>
<ul id="headerButtons" role="toolbar">
<li id="toc_button">
<button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button>
</li>
<li id="jumpto_button" role="navigation">
<select id="jumpTo">
<option value="top">Jump To&#133;</option>
<option value="overview">Overview</option>
<option value="tasks">Tasks</option>
<option value="properties">Properties</option>
<option value="//api/name/animationFromValue">&nbsp;&nbsp;&nbsp;&nbsp;animationFromValue</option>
<option value="//api/name/animationShape">&nbsp;&nbsp;&nbsp;&nbsp;animationShape</option>
<option value="//api/name/animationStartTime">&nbsp;&nbsp;&nbsp;&nbsp;animationStartTime</option>
<option value="//api/name/animationToValue">&nbsp;&nbsp;&nbsp;&nbsp;animationToValue</option>
<option value="//api/name/displayLink">&nbsp;&nbsp;&nbsp;&nbsp;displayLink</option>
<option value="//api/name/dotSize">&nbsp;&nbsp;&nbsp;&nbsp;dotSize</option>
<option value="//api/name/failureColor">&nbsp;&nbsp;&nbsp;&nbsp;failureColor</option>
<option value="//api/name/metroDot">&nbsp;&nbsp;&nbsp;&nbsp;metroDot</option>
<option value="//api/name/numberOfDots">&nbsp;&nbsp;&nbsp;&nbsp;numberOfDots</option>
<option value="//api/name/successColor">&nbsp;&nbsp;&nbsp;&nbsp;successColor</option>
<option value="instance_methods">Instance Methods</option>
<option value="//api/name/beginAnimating">&nbsp;&nbsp;&nbsp;&nbsp;- beginAnimating</option>
<option value="//api/name/isAnimating">&nbsp;&nbsp;&nbsp;&nbsp;- isAnimating</option>
<option value="//api/name/performAction:animated:">&nbsp;&nbsp;&nbsp;&nbsp;- performAction:animated:</option>
<option value="//api/name/setProgress:animated:">&nbsp;&nbsp;&nbsp;&nbsp;- setProgress:animated:</option>
<option value="//api/name/stopAnimating">&nbsp;&nbsp;&nbsp;&nbsp;- stopAnimating</option>
</select>
</li>
</ul>
</header>
<nav id="tocContainer" class="isShowingTOC">
<ul id="toc" role="tree">
<li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li>
<li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Properties">Properties</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Appearance">Appearance</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Actions">Actions</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Extension Methods">Extension Methods</a></span></li>
</ul></li>
<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#properties">Properties</a></span><ul>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/animationFromValue">animationFromValue</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/animationShape">animationShape</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/animationStartTime">animationStartTime</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/animationToValue">animationToValue</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/displayLink">displayLink</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/dotSize">dotSize</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/failureColor">failureColor</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/metroDot">metroDot</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/numberOfDots">numberOfDots</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/successColor">successColor</a></span></li>
</ul></li>
<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/beginAnimating">beginAnimating</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isAnimating">isAnimating</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/performAction:animated:">performAction:animated:</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setProgress:animated:">setProgress:animated:</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/stopAnimating">stopAnimating</a></span></li>
</ul></li>
</ul>
</nav>
<article>
<div id="contents" class="isShowingTOC" role="main">
<a title="M13ProgressViewMetro Class Reference" name="top"></a>
<div class="main-navigation navigation-top">
<ul>
<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>
</ul>
</div>
<div id="header">
<div class="section-header">
<h1 class="title title-header">M13ProgressViewMetro Class Reference</h1>
</div>
</div>
<div id="container">
<div class="section section-specification"><table cellspacing="0"><tbody>
<tr>
<td class="specification-title">Inherits from</td>
<td class="specification-value"><a href="../Classes/M13ProgressView.html">M13ProgressView</a> : UIView</td>
</tr><tr>
<td class="specification-title">Declared in</td>
<td class="specification-value">M13ProgressViewMetro.h<br />M13ProgressViewMetro.m</td>
</tr>
</tbody></table></div>
<div class="section section-overview">
<a title="Overview" name="overview"></a>
<h2 class="subtitle subtitle-overview">Overview</h2>
<p>A progress view based off of Windows 8&rsquo;s progress animation.</p>
</div>
<div class="section section-tasks">
<a title="Tasks" name="tasks"></a>
<h2 class="subtitle subtitle-tasks">Tasks</h2>
<a title="Properties" name="task_Properties"></a>
<h3 class="subsubtitle task-title">Properties</h3>
<ul class="task-list">
<li>
<span class="tooltip">
<code><a href="#//api/name/numberOfDots">&nbsp;&nbsp;numberOfDots</a></code>
</span>
<span class="task-item-suffix">property</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/animationShape">&nbsp;&nbsp;animationShape</a></code>
</span>
<span class="task-item-suffix">property</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/dotSize">&nbsp;&nbsp;dotSize</a></code>
</span>
<span class="task-item-suffix">property</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/metroDot">&nbsp;&nbsp;metroDot</a></code>
</span>
<span class="task-item-suffix">property</span>
</li>
</ul>
<a title="Appearance" name="task_Appearance"></a>
<h3 class="subsubtitle task-title">Appearance</h3>
<ul class="task-list">
<li>
<span class="tooltip">
<code><a href="#//api/name/successColor">&nbsp;&nbsp;successColor</a></code>
</span>
<span class="task-item-suffix">property</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/failureColor">&nbsp;&nbsp;failureColor</a></code>
</span>
<span class="task-item-suffix">property</span>
</li>
</ul>
<a title="Actions" name="task_Actions"></a>
<h3 class="subsubtitle task-title">Actions</h3>
<ul class="task-list">
<li>
<span class="tooltip">
<code><a href="#//api/name/isAnimating">&ndash;&nbsp;isAnimating</a></code>
</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/beginAnimating">&ndash;&nbsp;beginAnimating</a></code>
</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/stopAnimating">&ndash;&nbsp;stopAnimating</a></code>
</span>
</li>
</ul>
<h3 class="subsubtitle task-title">Other Methods</h3>
<ul class="task-list">
<li>
<span class="tooltip">
<code><a href="#//api/name/performAction:animated:">&ndash;&nbsp;performAction:animated:</a></code>
</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/setProgress:animated:">&ndash;&nbsp;setProgress:animated:</a></code>
</span>
</li>
</ul>
<a title="Extension Methods" name="task_Extension Methods"></a>
<h3 class="subsubtitle task-title">Extension Methods</h3>
<ul class="task-list">
<li>
<span class="tooltip">
<code><a href="#//api/name/animationFromValue">&nbsp;&nbsp;animationFromValue</a></code>
</span>
<span class="task-item-suffix">property</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/animationToValue">&nbsp;&nbsp;animationToValue</a></code>
</span>
<span class="task-item-suffix">property</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/animationStartTime">&nbsp;&nbsp;animationStartTime</a></code>
</span>
<span class="task-item-suffix">property</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/displayLink">&nbsp;&nbsp;displayLink</a></code>
</span>
<span class="task-item-suffix">property</span>
</li>
</ul>
</div>
<div class="section section-methods">
<a title="Properties" name="properties"></a>
<h2 class="subtitle subtitle-methods">Properties</h2>
<div class="section-method">
<a name="//api/name/animationFromValue" title="animationFromValue"></a>
<h3 class="subsubtitle method-title">animationFromValue</h3>
<div class="method-subsection brief-description">
<p>The start progress for the progress animation.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) CGFloat animationFromValue</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">M13ProgressViewMetro.m</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/animationShape" title="animationShape"></a>
<h3 class="subsubtitle method-title">animationShape</h3>
<div class="method-subsection brief-description">
<p>The shape of the animation.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) M13ProgressViewMetroAnimationShape animationShape</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">M13ProgressViewMetro.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/animationStartTime" title="animationStartTime"></a>
<h3 class="subsubtitle method-title">animationStartTime</h3>
<div class="method-subsection brief-description">
<p>The start time interval for the animaiton.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) CFTimeInterval animationStartTime</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">M13ProgressViewMetro.m</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/animationToValue" title="animationToValue"></a>
<h3 class="subsubtitle method-title">animationToValue</h3>
<div class="method-subsection brief-description">
<p>The end progress for the progress animation.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) CGFloat animationToValue</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">M13ProgressViewMetro.m</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/displayLink" title="displayLink"></a>
<h3 class="subsubtitle method-title">displayLink</h3>
<div class="method-subsection brief-description">
<p>Link to the display to keep animations in sync.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, strong) CADisplayLink *displayLink</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">M13ProgressViewMetro.m</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/dotSize" title="dotSize"></a>
<h3 class="subsubtitle method-title">dotSize</h3>
<div class="method-subsection brief-description">
<p>The size of the dots</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) CGSize dotSize</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">M13ProgressViewMetro.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/failureColor" title="failureColor"></a>
<h3 class="subsubtitle method-title">failureColor</h3>
<div class="method-subsection brief-description">
<p>The color to show on failure.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, retain) UIColor *failureColor</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">M13ProgressViewMetro.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/metroDot" title="metroDot"></a>
<h3 class="subsubtitle method-title">metroDot</h3>
<div class="method-subsection brief-description">
<p>The dot to display.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, retain) M13ProgressViewMetroDot *metroDot</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">M13ProgressViewMetro.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/numberOfDots" title="numberOfDots"></a>
<h3 class="subsubtitle method-title">numberOfDots</h3>
<div class="method-subsection brief-description">
<p>The number of dots in the animation.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) NSUInteger numberOfDots</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">M13ProgressViewMetro.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/successColor" title="successColor"></a>
<h3 class="subsubtitle method-title">successColor</h3>
<div class="method-subsection brief-description">
<p>The color to show on success.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, retain) UIColor *successColor</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">M13ProgressViewMetro.h</code><br />
</div>
</div>
</div>
<div class="section section-methods">
<a title="Instance Methods" name="instance_methods"></a>
<h2 class="subtitle subtitle-methods">Instance Methods</h2>
<div class="section-method">
<a name="//api/name/beginAnimating" title="beginAnimating"></a>
<h3 class="subsubtitle method-title">beginAnimating</h3>
<div class="method-subsection brief-description">
<p>Begin the animation.</p>
</div>
<div class="method-subsection method-declaration"><code>- (void)beginAnimating</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">M13ProgressViewMetro.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/isAnimating" title="isAnimating"></a>
<h3 class="subsubtitle method-title">isAnimating</h3>
<div class="method-subsection brief-description">
<p>Wether or not the progress view animating.</p>
</div>
<div class="method-subsection method-declaration"><code>- (BOOL)isAnimating</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">M13ProgressViewMetro.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/performAction:animated:" title="performAction:animated:"></a>
<h3 class="subsubtitle method-title">performAction:animated:</h3>
<div class="method-subsection brief-description">
<p>Perform the given action if defined. Usually showing success or failure.</p>
</div>
<div class="method-subsection method-declaration"><code>- (void)performAction:(M13ProgressViewAction)<em>action</em> animated:(BOOL)<em>animated</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
<dt><em>action</em></dt>
<dd><p>The action to perform.</p></dd>
</dl>
<dl class="argument-def parameter-def">
<dt><em>animated</em></dt>
<dd><p>Wether or not to animate the change</p></dd>
</dl>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">M13ProgressView.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/setProgress:animated:" title="setProgress:animated:"></a>
<h3 class="subsubtitle method-title">setProgress:animated:</h3>
<div class="method-subsection brief-description">
<p>Set the <a href="#//api/name/progress">progress</a> of the <code>M13ProgressView</code>.</p>
</div>
<div class="method-subsection method-declaration"><code>- (void)setProgress:(CGFloat)<em>progress</em> animated:(BOOL)<em>animated</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
<dt><em>progress</em></dt>
<dd><p>The <a href="#//api/name/progress">progress</a> to show on the <a href="#//api/name/progress">progress</a> view.</p></dd>
</dl>
<dl class="argument-def parameter-def">
<dt><em>animated</em></dt>
<dd><p>Wether or not to animate the <a href="#//api/name/progress">progress</a> change.</p></dd>
</dl>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">M13ProgressView.h</code><br />
</div>
</div>
<div class="section-method">
<a name="//api/name/stopAnimating" title="stopAnimating"></a>
<h3 class="subsubtitle method-title">stopAnimating</h3>
<div class="method-subsection brief-description">
<p>End the animation.</p>
</div>
<div class="method-subsection method-declaration"><code>- (void)stopAnimating</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">M13ProgressViewMetro.h</code><br />
</div>
</div>
</div>
</div>
<div class="main-navigation navigation-bottom">
<ul>
<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>
</ul>
</div>
<div id="footer">
<hr />
<div class="footer-copyright">
<p><span class="copyright">&copy; 2014 Marxon13 Productions (Brandon McQuilkin). All rights reserved. (Last updated: 2014-05-12)</span><br />
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2 (build 961)</a>.</span></p>
</div>
</div>
</div>
</article>
<script type="text/javascript">
function jumpToChange()
{
window.location.hash = this.options[this.selectedIndex].value;
}
function toggleTOC()
{
var contents = document.getElementById('contents');
var tocContainer = document.getElementById('tocContainer');
if (this.getAttribute('class') == 'open')
{
this.setAttribute('class', '');
contents.setAttribute('class', '');
tocContainer.setAttribute('class', '');
window.name = "hideTOC";
}
else
{
this.setAttribute('class', 'open');
contents.setAttribute('class', 'isShowingTOC');
tocContainer.setAttribute('class', 'isShowingTOC');
window.name = "";
}
return false;
}
function toggleTOCEntryChildren(e)
{
e.stopPropagation();
var currentClass = this.getAttribute('class');
if (currentClass == 'children') {
this.setAttribute('class', 'children open');
}
else if (currentClass == 'children open') {
this.setAttribute('class', 'children');
}
return false;
}
function tocEntryClick(e)
{
e.stopPropagation();
return true;
}
function init()
{
var selectElement = document.getElementById('jumpTo');
selectElement.addEventListener('change', jumpToChange, false);
var tocButton = document.getElementById('table_of_contents');
tocButton.addEventListener('click', toggleTOC, false);
var taskTreeItem = document.getElementById('task_treeitem');
if (taskTreeItem.getElementsByTagName('li').length > 0)
{
taskTreeItem.setAttribute('class', 'children');
taskTreeItem.firstChild.setAttribute('class', 'disclosure');
}
var tocList = document.getElementById('toc');
var tocEntries = tocList.getElementsByTagName('li');
for (var i = 0; i < tocEntries.length; i++) {
tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false);
}
var tocLinks = tocList.getElementsByTagName('a');
for (var i = 0; i < tocLinks.length; i++) {
tocLinks[i].addEventListener('click', tocEntryClick, false);
}
if (window.name == "hideTOC") {
toggleTOC.call(tocButton);
}
}
window.onload = init;
// If showing in Xcode, hide the TOC and Header
if (navigator.userAgent.match(/xcode/i)) {
document.getElementById("contents").className = "hideInXcode"
document.getElementById("tocContainer").className = "hideInXcode"
document.getElementById("top_header").className = "hideInXcode"
}
</script>
</body>
</html>