Files
GitHawk/SwipeCellKit/docs/Protocols/SwipeTableViewCellDelegate.html
2017-06-26 11:14:21 -04:00

464 lines
24 KiB
HTML
Executable File
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en">
<head>
<title>SwipeTableViewCellDelegate Protocol Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset='utf-8'>
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Protocol/SwipeTableViewCellDelegate" class="dashAnchor"></a>
<a title="SwipeTableViewCellDelegate Protocol Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">SwipeCellKit Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/jerkoch/SwipeCellKit"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">SwipeCellKit Reference</a>
<img id="carat" src="../img/carat.png" />
SwipeTableViewCellDelegate Protocol Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="../Guides.html">Guides</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../advanced.html">Advanced</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Classes/SwipeAction.html">SwipeAction</a>
</li>
<li class="nav-group-task">
<a href="../Classes/SwipeTableViewCell.html">SwipeTableViewCell</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Enums.html">Enums</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Enums/ExpansionFulfillmentStyle.html">ExpansionFulfillmentStyle</a>
</li>
<li class="nav-group-task">
<a href="../Enums/SwipeActionStyle.html">SwipeActionStyle</a>
</li>
<li class="nav-group-task">
<a href="../Enums/SwipeActionsOrientation.html">SwipeActionsOrientation</a>
</li>
<li class="nav-group-task">
<a href="../Enums/SwipeTransitionStyle.html">SwipeTransitionStyle</a>
</li>
<li class="nav-group-task">
<a href="../Enums/SwipeVerticalAlignment.html">SwipeVerticalAlignment</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Protocols/SwipeActionTransitioning.html">SwipeActionTransitioning</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/SwipeExpanding.html">SwipeExpanding</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/SwipeTableViewCellDelegate.html">SwipeTableViewCellDelegate</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Structs.html">Structs</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Structs/ScaleAndAlphaExpansion.html">ScaleAndAlphaExpansion</a>
</li>
<li class="nav-group-task">
<a href="../Structs/ScaleTransition.html">ScaleTransition</a>
</li>
<li class="nav-group-task">
<a href="../Structs/SwipeActionTransitioningContext.html">SwipeActionTransitioningContext</a>
</li>
<li class="nav-group-task">
<a href="../Structs/SwipeExpansionAnimationTimingParameters.html">SwipeExpansionAnimationTimingParameters</a>
</li>
<li class="nav-group-task">
<a href="../Structs/SwipeExpansionStyle.html">SwipeExpansionStyle</a>
</li>
<li class="nav-group-task">
<a href="../Structs/SwipeExpansionStyle/Target.html"> Target</a>
</li>
<li class="nav-group-task">
<a href="../Structs/SwipeExpansionStyle/Trigger.html"> Trigger</a>
</li>
<li class="nav-group-task">
<a href="../Structs/SwipeExpansionStyle/CompletionAnimation.html"> CompletionAnimation</a>
</li>
<li class="nav-group-task">
<a href="../Structs/SwipeExpansionStyle/FillOptions.html"> FillOptions</a>
</li>
<li class="nav-group-task">
<a href="../Structs/SwipeTableOptions.html">SwipeTableOptions</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>SwipeTableViewCellDelegate</h1>
<div class="declaration">
<div class="language">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SwipeTableViewCellDelegate</span><span class="p">:</span> <span class="kd">class</span></code></pre>
</div>
</div>
<p>The <code>SwipeTableViewCellDelegate</code> protocol is adopted by an object that manages the display of action buttons when the cell is swiped.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:FP12SwipeCellKit26SwipeTableViewCellDelegate9tableViewFTCSo11UITableView19editActionsForRowAtV10Foundation9IndexPath3forOS_23SwipeActionsOrientation_GSqGSaCS_11SwipeAction__"></a>
<a name="//apple_ref/swift/Method/tableView(_:editActionsForRowAt:for:)" class="dashAnchor"></a>
<a class="token" href="#/s:FP12SwipeCellKit26SwipeTableViewCellDelegate9tableViewFTCSo11UITableView19editActionsForRowAtV10Foundation9IndexPath3forOS_23SwipeActionsOrientation_GSqGSaCS_11SwipeAction__">tableView(_:editActionsForRowAt:for:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Asks the delegate for the actions to display in response to a swipe in the specified row.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">tableView</span><span class="p">(</span><span class="n">_</span> <span class="nv">tableView</span><span class="p">:</span> <span class="kt">UITableView</span><span class="p">,</span> <span class="n">editActionsForRowAt</span> <span class="nv">indexPath</span><span class="p">:</span> <span class="kt">IndexPath</span><span class="p">,</span> <span class="k">for</span> <span class="nv">orientation</span><span class="p">:</span> <span class="kt"><a href="../Enums/SwipeActionsOrientation.html">SwipeActionsOrientation</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="p">[</span><span class="kt"><a href="../Classes/SwipeAction.html">SwipeAction</a></span><span class="p">]?</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>tableView</em>
</code>
</td>
<td>
<div>
<p>The table view object which owns the cell requesting this information.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>indexPath</em>
</code>
</td>
<td>
<div>
<p>The index path of the row.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>orientation</em>
</code>
</td>
<td>
<div>
<p>The side of the cell requesting this information.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>An array of <code><a href="../Classes/SwipeAction.html">SwipeAction</a></code> objects representing the actions for the row. Each action you provide is used to create a button that the user can tap. Returning <code>nil</code> will prevent swiping for the supplied orientation.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FP12SwipeCellKit26SwipeTableViewCellDelegate9tableViewFTCSo11UITableView26editActionsOptionsForRowAtV10Foundation9IndexPath3forOS_23SwipeActionsOrientation_VS_17SwipeTableOptions"></a>
<a name="//apple_ref/swift/Method/tableView(_:editActionsOptionsForRowAt:for:)" class="dashAnchor"></a>
<a class="token" href="#/s:FP12SwipeCellKit26SwipeTableViewCellDelegate9tableViewFTCSo11UITableView26editActionsOptionsForRowAtV10Foundation9IndexPath3forOS_23SwipeActionsOrientation_VS_17SwipeTableOptions">tableView(_:editActionsOptionsForRowAt:for:)</a>
</code>
<span class="declaration-note">
Default implementation
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Asks the delegate for the display options to be used while presenting the action buttons.</p>
<div class="aside aside-note">
<p class="aside-title">Note</p>
<p>If not implemented, a default <code><a href="../Structs/SwipeTableOptions.html">SwipeTableOptions</a></code> instance is used.</p>
</div>
</div>
<h4>Default Implementation</h4>
<div class="default_impl abstract">
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">tableView</span><span class="p">(</span><span class="n">_</span> <span class="nv">tableView</span><span class="p">:</span> <span class="kt">UITableView</span><span class="p">,</span> <span class="n">editActionsOptionsForRowAt</span> <span class="nv">indexPath</span><span class="p">:</span> <span class="kt">IndexPath</span><span class="p">,</span> <span class="k">for</span> <span class="nv">orientation</span><span class="p">:</span> <span class="kt"><a href="../Enums/SwipeActionsOrientation.html">SwipeActionsOrientation</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/SwipeTableOptions.html">SwipeTableOptions</a></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>tableView</em>
</code>
</td>
<td>
<div>
<p>The table view object which owns the cell requesting this information.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>indexPath</em>
</code>
</td>
<td>
<div>
<p>The index path of the row.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>orientation</em>
</code>
</td>
<td>
<div>
<p>The side of the cell requesting this information.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>A <code><a href="../Structs/SwipeTableOptions.html">SwipeTableOptions</a></code> instance which configures the behavior of the action buttons.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FP12SwipeCellKit26SwipeTableViewCellDelegate9tableViewFTCSo11UITableView21willBeginEditingRowAtV10Foundation9IndexPath3forOS_23SwipeActionsOrientation_T_"></a>
<a name="//apple_ref/swift/Method/tableView(_:willBeginEditingRowAt:for:)" class="dashAnchor"></a>
<a class="token" href="#/s:FP12SwipeCellKit26SwipeTableViewCellDelegate9tableViewFTCSo11UITableView21willBeginEditingRowAtV10Foundation9IndexPath3forOS_23SwipeActionsOrientation_T_">tableView(_:willBeginEditingRowAt:for:)</a>
</code>
<span class="declaration-note">
Default implementation
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Tells the delegate that the table view is about to go into editing mode.</p>
</div>
<h4>Default Implementation</h4>
<div class="default_impl abstract">
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">tableView</span><span class="p">(</span><span class="n">_</span> <span class="nv">tableView</span><span class="p">:</span> <span class="kt">UITableView</span><span class="p">,</span> <span class="n">willBeginEditingRowAt</span> <span class="nv">indexPath</span><span class="p">:</span> <span class="kt">IndexPath</span><span class="p">,</span> <span class="k">for</span> <span class="nv">orientation</span><span class="p">:</span> <span class="kt"><a href="../Enums/SwipeActionsOrientation.html">SwipeActionsOrientation</a></span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>tableView</em>
</code>
</td>
<td>
<div>
<p>The table view object providing this information.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>indexPath</em>
</code>
</td>
<td>
<div>
<p>The index path of the row.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>orientation</em>
</code>
</td>
<td>
<div>
<p>The side of the cell.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FP12SwipeCellKit26SwipeTableViewCellDelegate9tableViewFTCSo11UITableView18didEndEditingRowAtGSqV10Foundation9IndexPath_3forOS_23SwipeActionsOrientation_T_"></a>
<a name="//apple_ref/swift/Method/tableView(_:didEndEditingRowAt:for:)" class="dashAnchor"></a>
<a class="token" href="#/s:FP12SwipeCellKit26SwipeTableViewCellDelegate9tableViewFTCSo11UITableView18didEndEditingRowAtGSqV10Foundation9IndexPath_3forOS_23SwipeActionsOrientation_T_">tableView(_:didEndEditingRowAt:for:)</a>
</code>
<span class="declaration-note">
Default implementation
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Tells the delegate that the table view has left editing mode.</p>
</div>
<h4>Default Implementation</h4>
<div class="default_impl abstract">
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">tableView</span><span class="p">(</span><span class="n">_</span> <span class="nv">tableView</span><span class="p">:</span> <span class="kt">UITableView</span><span class="p">,</span> <span class="n">didEndEditingRowAt</span> <span class="nv">indexPath</span><span class="p">:</span> <span class="kt">IndexPath</span><span class="p">?,</span> <span class="k">for</span> <span class="nv">orientation</span><span class="p">:</span> <span class="kt"><a href="../Enums/SwipeActionsOrientation.html">SwipeActionsOrientation</a></span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>tableView</em>
</code>
</td>
<td>
<div>
<p>The table view object providing this information.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>indexPath</em>
</code>
</td>
<td>
<div>
<p>The index path of the row.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>orientation</em>
</code>
</td>
<td>
<div>
<p>The side of the cell.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2017 <a class="link" href="https://twitter.com/jerkoch" target="_blank" rel="external">Jeremy Koch</a>. All rights reserved. (Last updated: 2017-06-17)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>