Swiftgram/docs/appledoc/Categories/ASControlNode+Subclassing.html

497 lines
12 KiB
HTML
Executable File

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>ASControlNode(Subclassing) Category Reference</title>
<link rel="stylesheet" href="../css/style.css">
<meta name="viewport" content="initial-scale=1, maximum-scale=1.4">
<meta name="generator" content="appledoc 2.2.1 (build 1334)">
</head>
<body class="appledoc">
<header>
<div class="container" class="hide-in-xcode">
<h1 id="library-title">
<a href="../index.html"> </a>
</h1>
<p id="developer-home">
<a href="../index.html">AsyncDisplayKit</a>
</p>
</div>
</header>
<aside>
<div class="container">
<nav>
<ul id="header-buttons" role="toolbar">
<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>
<li id="on-this-page" role="navigation">
<label>
On This Page
<div class="chevron">
<div class="chevy chevron-left"></div>
<div class="chevy chevron-right"></div>
</div>
<select id="jump-to">
<option value="top">Jump To&#133;</option>
<option value="overview">Overview</option>
<option value="tasks">Tasks</option>
<optgroup label="Properties">
<option value="//api/name/highlighted">highlighted</option>
</optgroup>
<optgroup label="Instance Methods">
<option value="//api/name/beginTrackingWithTouch:withEvent:">- beginTrackingWithTouch:withEvent:</option>
<option value="//api/name/cancelTrackingWithEvent:">- cancelTrackingWithEvent:</option>
<option value="//api/name/continueTrackingWithTouch:withEvent:">- continueTrackingWithTouch:withEvent:</option>
<option value="//api/name/endTrackingWithTouch:withEvent:">- endTrackingWithTouch:withEvent:</option>
<option value="//api/name/sendActionsForControlEvents:withEvent:">- sendActionsForControlEvents:withEvent:</option>
</optgroup>
</select>
</label>
</li>
</ul>
</nav>
</div>
</aside>
<article>
<div id="overview_contents" class="container">
<div id="content">
<main role="main">
<h1 class="title">ASControlNode(Subclassing) Category Reference</h1>
<div class="section section-specification"><table cellspacing="0"><tbody>
<tr>
<th>Declared in</th>
<td>ASControlNode+Subclasses.h</td>
</tr>
</tbody></table></div>
<div class="section section-overview">
<a title="Overview" name="overview"></a>
<h2 class="subtitle subtitle-overview">Overview</h2>
<p>The subclass header <em>ASControlNode+Subclasses</em> defines methods to be
overridden by custom nodes that subclass ASControlNode.</p>
<p>These methods should never be called directly by other classes.</p>
</div>
<div class="section section-tasks">
<a title="Tasks" name="tasks"></a>
<div class="task-list">
<div class="section-method">
<a name="//api/name/sendActionsForControlEvents:withEvent:" title="sendActionsForControlEvents:withEvent:"></a>
<h3 class="method-title"><code><a href="#//api/name/sendActionsForControlEvents:withEvent:">&ndash;&nbsp;sendActionsForControlEvents:withEvent:</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Sends action messages for the given control events.</p>
</div>
<div class="method-subsection method-declaration"><code>- (void)sendActionsForControlEvents:(ASControlNodeEvent)<em>controlEvents</em> withEvent:(nullable UIEvent *)<em>touchEvent</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<table class="argument-def parameter-def">
<tr>
<th scope="row" class="argument-name"><code>controlEvents</code></th>
<td><p>A bitmask whose set flags specify the control events for which action messages are sent. See &ldquo;Control Events&rdquo; in ASControlNode.h for bitmask constants.</p></td>
</tr>
<tr>
<th scope="row" class="argument-name"><code>touchEvent</code></th>
<td><p>An event object encapsulating the information specific to the user event.</p></td>
</tr>
</table>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>ASControlNode implements this method to send all action messages associated with controlEvents. The list of targets is constructed from prior invocations of addTarget:action:forControlEvents:.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASControlNode+Subclasses.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/beginTrackingWithTouch:withEvent:" title="beginTrackingWithTouch:withEvent:"></a>
<h3 class="method-title"><code><a href="#//api/name/beginTrackingWithTouch:withEvent:">&ndash;&nbsp;beginTrackingWithTouch:withEvent:</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Sent to the control when tracking begins.</p>
</div>
<div class="method-subsection method-declaration"><code>- (BOOL)beginTrackingWithTouch:(UITouch *)<em>touch</em> withEvent:(nullable UIEvent *)<em>touchEvent</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<table class="argument-def parameter-def">
<tr>
<th scope="row" class="argument-name"><code>touch</code></th>
<td><p>The touch on the receiving control.</p></td>
</tr>
<tr>
<th scope="row" class="argument-name"><code>touchEvent</code></th>
<td><p>An event object encapsulating the information specific to the user event.</p></td>
</tr>
</table>
</div>
<div class="method-subsection return">
<h4 class="method-subtitle parameter-title">Return Value</h4>
<p>YES if the receiver should respond continuously (respond when touch is dragged); NO otherwise.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASControlNode+Subclasses.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/continueTrackingWithTouch:withEvent:" title="continueTrackingWithTouch:withEvent:"></a>
<h3 class="method-title"><code><a href="#//api/name/continueTrackingWithTouch:withEvent:">&ndash;&nbsp;continueTrackingWithTouch:withEvent:</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Sent continuously to the control as it tracks a touch within the control&rsquo;s bounds.</p>
</div>
<div class="method-subsection method-declaration"><code>- (BOOL)continueTrackingWithTouch:(UITouch *)<em>touch</em> withEvent:(nullable UIEvent *)<em>touchEvent</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<table class="argument-def parameter-def">
<tr>
<th scope="row" class="argument-name"><code>touch</code></th>
<td><p>The touch on the receiving control.</p></td>
</tr>
<tr>
<th scope="row" class="argument-name"><code>touchEvent</code></th>
<td><p>An event object encapsulating the information specific to the user event.</p></td>
</tr>
</table>
</div>
<div class="method-subsection return">
<h4 class="method-subtitle parameter-title">Return Value</h4>
<p>YES if touch tracking should continue; NO otherwise.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASControlNode+Subclasses.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/cancelTrackingWithEvent:" title="cancelTrackingWithEvent:"></a>
<h3 class="method-title"><code><a href="#//api/name/cancelTrackingWithEvent:">&ndash;&nbsp;cancelTrackingWithEvent:</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Sent to the control when tracking should be cancelled.</p>
</div>
<div class="method-subsection method-declaration"><code>- (void)cancelTrackingWithEvent:(nullable UIEvent *)<em>touchEvent</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<table class="argument-def parameter-def">
<tr>
<th scope="row" class="argument-name"><code>touchEvent</code></th>
<td><p>An event object encapsulating the information specific to the user event. This parameter may be nil, indicating that the cancelation was caused by something other than an event, such as the display node being removed from its supernode.</p></td>
</tr>
</table>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASControlNode+Subclasses.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/endTrackingWithTouch:withEvent:" title="endTrackingWithTouch:withEvent:"></a>
<h3 class="method-title"><code><a href="#//api/name/endTrackingWithTouch:withEvent:">&ndash;&nbsp;endTrackingWithTouch:withEvent:</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Sent to the control when the last touch completely ends, telling it to stop tracking.</p>
</div>
<div class="method-subsection method-declaration"><code>- (void)endTrackingWithTouch:(nullable UITouch *)<em>touch</em> withEvent:(nullable UIEvent *)<em>touchEvent</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<table class="argument-def parameter-def">
<tr>
<th scope="row" class="argument-name"><code>touch</code></th>
<td><p>The touch that ended.</p></td>
</tr>
<tr>
<th scope="row" class="argument-name"><code>touchEvent</code></th>
<td><p>An event object encapsulating the information specific to the user event.</p></td>
</tr>
</table>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASControlNode+Subclasses.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/highlighted" title="highlighted"></a>
<h3 class="method-title"><code><a href="#//api/name/highlighted">&nbsp;&nbsp;highlighted</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Settable version of highlighted property.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, readwrite, assign, getter=isHighlighted) BOOL highlighted</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASControlNode+Subclasses.h</code></p>
</div>
</div>
</div>
</div>
</div>
</div>
</main>
<footer>
<div class="footer-copyright">
<p class="copyright">Copyright &copy; 2016 AsyncDisplayKit. All rights reserved. Updated: 2016-11-05</p>
<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p>
</div>
</footer>
</div>
</div>
</article>
<script src="../js/script.js"></script>
</body>
</html>