mirror of
https://github.com/zhigang1992/GitHawk.git
synced 2026-06-06 06:29:32 +08:00
435 lines
22 KiB
HTML
Executable File
435 lines
22 KiB
HTML
Executable File
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<title>SwipeTableOptions 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/SwipeTableOptions" class="dashAnchor"></a>
|
||
<a title="SwipeTableOptions 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" />
|
||
SwipeTableOptions 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>SwipeTableOptions</h1>
|
||
<div class="declaration">
|
||
<div class="language">
|
||
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">SwipeTableOptions</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
<p>The <code>SwipeTableOptions</code> class provides options for transistion and expansion behavior for swiped cell.</p>
|
||
|
||
</section>
|
||
<section class="section task-group-section">
|
||
<div class="task-group">
|
||
<ul>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:vV12SwipeCellKit17SwipeTableOptions15transitionStyleOS_20SwipeTransitionStyle"></a>
|
||
<a name="//apple_ref/swift/Property/transitionStyle" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:vV12SwipeCellKit17SwipeTableOptions15transitionStyleOS_20SwipeTransitionStyle">transitionStyle</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>The transition style. Transition is the style of how the action buttons are exposed during the swipe.</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">var</span> <span class="nv">transitionStyle</span><span class="p">:</span> <span class="kt"><a href="../Enums/SwipeTransitionStyle.html">SwipeTransitionStyle</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">border</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:vV12SwipeCellKit17SwipeTableOptions14expansionStyleGSqVS_19SwipeExpansionStyle_"></a>
|
||
<a name="//apple_ref/swift/Property/expansionStyle" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:vV12SwipeCellKit17SwipeTableOptions14expansionStyleGSqVS_19SwipeExpansionStyle_">expansionStyle</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>The expansion style. Expansion is the behavior when the cell is swiped past a defined threshold.</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">var</span> <span class="nv">expansionStyle</span><span class="p">:</span> <span class="kt"><a href="../Structs/SwipeExpansionStyle.html">SwipeExpansionStyle</a></span><span class="p">?</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:vV12SwipeCellKit17SwipeTableOptions17expansionDelegateGSqPS_14SwipeExpanding__"></a>
|
||
<a name="//apple_ref/swift/Property/expansionDelegate" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:vV12SwipeCellKit17SwipeTableOptions17expansionDelegateGSqPS_14SwipeExpanding__">expansionDelegate</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>The object that is notified when expansion changes.</p>
|
||
<div class="aside aside-note">
|
||
<p class="aside-title">Note</p>
|
||
If an <code>expansionDelegate</code> is not provided, and the expanding action is configured with a clear background, the system automatically uses the default <code><a href="../Structs/ScaleAndAlphaExpansion.html">ScaleAndAlphaExpansion</a></code> to show/hide underlying actions.
|
||
|
||
</div>
|
||
|
||
</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">var</span> <span class="nv">expansionDelegate</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SwipeExpanding.html">SwipeExpanding</a></span><span class="p">?</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:vV12SwipeCellKit17SwipeTableOptions15backgroundColorGSqCSo7UIColor_"></a>
|
||
<a name="//apple_ref/swift/Property/backgroundColor" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:vV12SwipeCellKit17SwipeTableOptions15backgroundColorGSqCSo7UIColor_">backgroundColor</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>The background color behind the action buttons.</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">var</span> <span class="nv">backgroundColor</span><span class="p">:</span> <span class="kt">UIColor</span><span class="p">?</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:vV12SwipeCellKit17SwipeTableOptions18maximumButtonWidthGSqV12CoreGraphics7CGFloat_"></a>
|
||
<a name="//apple_ref/swift/Property/maximumButtonWidth" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:vV12SwipeCellKit17SwipeTableOptions18maximumButtonWidthGSqV12CoreGraphics7CGFloat_">maximumButtonWidth</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>The largest allowable button width.</p>
|
||
<div class="aside aside-note">
|
||
<p class="aside-title">Note</p>
|
||
By default, the value is set to the table view divided by the number of action buttons minus some additional padding. If the value is set to 0, then word wrapping will not occur and the buttons will grow as large as needed to fit the entire title/image.
|
||
|
||
</div>
|
||
|
||
</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">var</span> <span class="nv">maximumButtonWidth</span><span class="p">:</span> <span class="kt">CGFloat</span><span class="p">?</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:vV12SwipeCellKit17SwipeTableOptions18minimumButtonWidthGSqV12CoreGraphics7CGFloat_"></a>
|
||
<a name="//apple_ref/swift/Property/minimumButtonWidth" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:vV12SwipeCellKit17SwipeTableOptions18minimumButtonWidthGSqV12CoreGraphics7CGFloat_">minimumButtonWidth</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>The smallest allowable button width.</p>
|
||
<div class="aside aside-note">
|
||
<p class="aside-title">Note</p>
|
||
By default, the system chooses an appropriate size.
|
||
|
||
</div>
|
||
|
||
</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">var</span> <span class="nv">minimumButtonWidth</span><span class="p">:</span> <span class="kt">CGFloat</span><span class="p">?</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:vV12SwipeCellKit17SwipeTableOptions23buttonVerticalAlignmentOS_22SwipeVerticalAlignment"></a>
|
||
<a name="//apple_ref/swift/Property/buttonVerticalAlignment" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:vV12SwipeCellKit17SwipeTableOptions23buttonVerticalAlignmentOS_22SwipeVerticalAlignment">buttonVerticalAlignment</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>The vertical alignment mode used for when a button image and title are present.</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">var</span> <span class="nv">buttonVerticalAlignment</span><span class="p">:</span> <span class="kt"><a href="../Enums/SwipeVerticalAlignment.html">SwipeVerticalAlignment</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">centerFirstBaseline</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:vV12SwipeCellKit17SwipeTableOptions13buttonPaddingGSqV12CoreGraphics7CGFloat_"></a>
|
||
<a name="//apple_ref/swift/Property/buttonPadding" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:vV12SwipeCellKit17SwipeTableOptions13buttonPaddingGSqV12CoreGraphics7CGFloat_">buttonPadding</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>The amount of space, in points, between the border and the button image or title.</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">var</span> <span class="nv">buttonPadding</span><span class="p">:</span> <span class="kt">CGFloat</span><span class="p">?</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:vV12SwipeCellKit17SwipeTableOptions13buttonSpacingGSqV12CoreGraphics7CGFloat_"></a>
|
||
<a name="//apple_ref/swift/Property/buttonSpacing" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:vV12SwipeCellKit17SwipeTableOptions13buttonSpacingGSqV12CoreGraphics7CGFloat_">buttonSpacing</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>The amount of space, in points, between the button image and the button title.</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">var</span> <span class="nv">buttonSpacing</span><span class="p">:</span> <span class="kt">CGFloat</span><span class="p">?</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:FV12SwipeCellKit17SwipeTableOptionscFT_S0_"></a>
|
||
<a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:FV12SwipeCellKit17SwipeTableOptionscFT_S0_">init()</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>Constructs a new <code>SwipeTableOptions</code> instance with default options.</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="nf">init</span><span class="p">()</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="footer">
|
||
<p>© 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>
|