Files
GitHawk/SwipeCellKit/docs/Structs/SwipeExpansionStyle/FillOptions.html
2017-06-26 11:14:21 -04:00

344 lines
17 KiB
HTML
Executable File
Raw Blame History

This file contains ambiguous Unicode characters

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>FillOptions Struct 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/Struct/FillOptions" class="dashAnchor"></a>
<a title="FillOptions Struct 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" />
FillOptions Struct 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>FillOptions</h1>
<div class="declaration">
<div class="language">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">FillOptions</span></code></pre>
</div>
</div>
<p>Specifies the options for the fill completion animation.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:OVV12SwipeCellKit19SwipeExpansionStyle11FillOptions23HandlerInvocationTiming"></a>
<a name="//apple_ref/swift/Enum/HandlerInvocationTiming" class="dashAnchor"></a>
<a class="token" href="#/s:OVV12SwipeCellKit19SwipeExpansionStyle11FillOptions23HandlerInvocationTiming">HandlerInvocationTiming</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Describes when the action handler will be invoked with respect to the fill animation.</p>
<a href="../../Structs/SwipeExpansionStyle/FillOptions/HandlerInvocationTiming.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">HandlerInvocationTiming</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:ZFVV12SwipeCellKit19SwipeExpansionStyle11FillOptions9automaticFTOS_25ExpansionFulfillmentStyle6timingOS1_23HandlerInvocationTiming_S1_"></a>
<a name="//apple_ref/swift/Method/automatic(_:timing:)" class="dashAnchor"></a>
<a class="token" href="#/s:ZFVV12SwipeCellKit19SwipeExpansionStyle11FillOptions9automaticFTOS_25ExpansionFulfillmentStyle6timingOS1_23HandlerInvocationTiming_S1_">automatic(_:timing:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Returns a <code>FillOptions</code> instance with automatic fulfillemnt.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">automatic</span><span class="p">(</span><span class="n">_</span> <span class="nv">style</span><span class="p">:</span> <span class="kt"><a href="../../Enums/ExpansionFulfillmentStyle.html">ExpansionFulfillmentStyle</a></span><span class="p">,</span> <span class="nv">timing</span><span class="p">:</span> <span class="kt"><a href="../../Structs/SwipeExpansionStyle/FillOptions/HandlerInvocationTiming.html">HandlerInvocationTiming</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">FillOptions</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>style</em>
</code>
</td>
<td>
<div>
<p>The fulfillment style describing how expansion should be resolved once the action has been fulfilled.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>timing</em>
</code>
</td>
<td>
<div>
<p>The timing which specifies when the action handler will be invoked with respect to the fill animation.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>The new <code>FillOptions</code> instance.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:ZFVV12SwipeCellKit19SwipeExpansionStyle11FillOptions6manualFT6timingOS1_23HandlerInvocationTiming_S1_"></a>
<a name="//apple_ref/swift/Method/manual(timing:)" class="dashAnchor"></a>
<a class="token" href="#/s:ZFVV12SwipeCellKit19SwipeExpansionStyle11FillOptions6manualFT6timingOS1_23HandlerInvocationTiming_S1_">manual(timing:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Returns a <code>FillOptions</code> instance with manual fulfillemnt.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">manual</span><span class="p">(</span><span class="nv">timing</span><span class="p">:</span> <span class="kt"><a href="../../Structs/SwipeExpansionStyle/FillOptions/HandlerInvocationTiming.html">HandlerInvocationTiming</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">FillOptions</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>timing</em>
</code>
</td>
<td>
<div>
<p>The timing which specifies when the action handler will be invoked with respect to the fill animation.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>The new <code>FillOptions</code> instance.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vVV12SwipeCellKit19SwipeExpansionStyle11FillOptions20autoFulFillmentStyleGSqOS_25ExpansionFulfillmentStyle_"></a>
<a name="//apple_ref/swift/Property/autoFulFillmentStyle" class="dashAnchor"></a>
<a class="token" href="#/s:vVV12SwipeCellKit19SwipeExpansionStyle11FillOptions20autoFulFillmentStyleGSqOS_25ExpansionFulfillmentStyle_">autoFulFillmentStyle</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The fulfillment style describing how expansion should be resolved once the action has been fulfilled.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">autoFulFillmentStyle</span><span class="p">:</span> <span class="kt"><a href="../../Enums/ExpansionFulfillmentStyle.html">ExpansionFulfillmentStyle</a></span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vVV12SwipeCellKit19SwipeExpansionStyle11FillOptions6timingOS1_23HandlerInvocationTiming"></a>
<a name="//apple_ref/swift/Property/timing" class="dashAnchor"></a>
<a class="token" href="#/s:vVV12SwipeCellKit19SwipeExpansionStyle11FillOptions6timingOS1_23HandlerInvocationTiming">timing</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The timing which specifies when the action handler will be invoked with respect to the fill animation.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">timing</span><span class="p">:</span> <span class="kt"><a href="../../Structs/SwipeExpansionStyle/FillOptions/HandlerInvocationTiming.html">HandlerInvocationTiming</a></span></code></pre>
</div>
</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>