Files
StepperView/docs/Structs/PitStopSteps.html
T
Badarinath Venkatnarayansetty fc5e74be16 Jazzy documentaion for 100% completion
2020-04-28 08:57:11 -07:00

419 lines
19 KiB
HTML
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>PitStopSteps Structure 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/PitStopSteps" class="dashAnchor"></a>
<a title="PitStopSteps Structure Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">StepperView 1.2.0 Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">StepperView Reference</a>
<img id="carat" src="../img/carat.png" />
PitStopSteps Structure Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Enums/Colors.html">Colors</a>
</li>
<li class="nav-group-task">
<a href="../Enums/Colors/GraySubType.html"> GraySubType</a>
</li>
<li class="nav-group-task">
<a href="../Enums/Colors/GreenSubType.html"> GreenSubType</a>
</li>
<li class="nav-group-task">
<a href="../Enums/Colors/BlueSubType.html"> BlueSubType</a>
</li>
<li class="nav-group-task">
<a href="../Enums/Colors/YellowSubType.html"> YellowSubType</a>
</li>
<li class="nav-group-task">
<a href="../Enums/Colors/RedSubType.html"> RedSubType</a>
</li>
<li class="nav-group-task">
<a href="../Enums/PitStopLineOptions.html">PitStopLineOptions</a>
</li>
<li class="nav-group-task">
<a href="../Enums/StepperAlignment.html">StepperAlignment</a>
</li>
<li class="nav-group-task">
<a href="../Enums/StepperIndicationType.html">StepperIndicationType</a>
</li>
<li class="nav-group-task">
<a href="../Enums/StepperLineOptions.html">StepperLineOptions</a>
</li>
<li class="nav-group-task">
<a href="../Enums/StepperMode.html">StepperMode</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Extensions/EnvironmentValues.html">EnvironmentValues</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/VerticalAlignment.html">VerticalAlignment</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/View.html">View</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Structs/AlignmentKey.html">AlignmentKey</a>
</li>
<li class="nav-group-task">
<a href="../Structs/BoundsPreferenceKey.html">BoundsPreferenceKey</a>
</li>
<li class="nav-group-task">
<a href="../Structs/CGRectData.html">CGRectData</a>
</li>
<li class="nav-group-task">
<a href="../Structs/CGRectPreferenceKey.html">CGRectPreferenceKey</a>
</li>
<li class="nav-group-task">
<a href="../Structs/CircledIconView.html">CircledIconView</a>
</li>
<li class="nav-group-task">
<a href="../Structs/HeightKey.html">HeightKey</a>
</li>
<li class="nav-group-task">
<a href="../Structs/HeightPreference.html">HeightPreference</a>
</li>
<li class="nav-group-task">
<a href="../Structs/HorizontalLineView.html">HorizontalLineView</a>
</li>
<li class="nav-group-task">
<a href="../Structs/IndicatorKey.html">IndicatorKey</a>
</li>
<li class="nav-group-task">
<a href="../Structs/IndicatorView.html">IndicatorView</a>
</li>
<li class="nav-group-task">
<a href="../Structs/LineOptionsKey.html">LineOptionsKey</a>
</li>
<li class="nav-group-task">
<a href="../Structs/NumberedCircleView.html">NumberedCircleView</a>
</li>
<li class="nav-group-task">
<a href="../Structs/PitStopLineView.html">PitStopLineView</a>
</li>
<li class="nav-group-task">
<a href="../Structs/PitStopOptionsKey.html">PitStopOptionsKey</a>
</li>
<li class="nav-group-task">
<a href="../Structs/PitStopSteps.html">PitStopSteps</a>
</li>
<li class="nav-group-task">
<a href="../Structs/PitStopView.html">PitStopView</a>
</li>
<li class="nav-group-task">
<a href="../Structs/SpacingKey.html">SpacingKey</a>
</li>
<li class="nav-group-task">
<a href="../Structs/StepIndicatorHorizontalView.html">StepIndicatorHorizontalView</a>
</li>
<li class="nav-group-task">
<a href="../Structs/StepIndicatorModeKey.html">StepIndicatorModeKey</a>
</li>
<li class="nav-group-task">
<a href="../Structs/StepIndicatorVerticalView.html">StepIndicatorVerticalView</a>
</li>
<li class="nav-group-task">
<a href="../Structs/StepperView.html">StepperView</a>
</li>
<li class="nav-group-task">
<a href="../Structs/StepsKey.html">StepsKey</a>
</li>
<li class="nav-group-task">
<a href="../Structs/TextView.html">TextView</a>
</li>
<li class="nav-group-task">
<a href="../Structs/Utils.html">Utils</a>
</li>
<li class="nav-group-task">
<a href="../Structs/VerticalHeightPreference.html">VerticalHeightPreference</a>
</li>
<li class="nav-group-task">
<a href="../Structs/VerticalLineView.html">VerticalLineView</a>
</li>
<li class="nav-group-task">
<a href="../Structs/WidthKey.html">WidthKey</a>
</li>
<li class="nav-group-task">
<a href="../Structs/WidthPreference.html">WidthPreference</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>PitStopSteps</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">@available(iOS 13.0, OSX 10.15, tvOS 13.0, watchOS 6.0, *)</span>
<span class="kd">public</span> <span class="kd">struct</span> <span class="kt">PitStopSteps</span> <span class="p">:</span> <span class="kt">Hashable</span></code></pre>
</div>
</div>
<p>Pitstop view and custom options</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:11StepperView12PitStopStepsV4view7SwiftUI03AnyB0Vvp"></a>
<a name="//apple_ref/swift/Property/view" class="dashAnchor"></a>
<a class="token" href="#/s:11StepperView12PitStopStepsV4view7SwiftUI03AnyB0Vvp">view</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>placeholder for <code>View</code> to render</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">view</span><span class="p">:</span> <span class="kt">AnyView</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11StepperView12PitStopStepsV11lineOptionsAA0cd4LineG0Ovp"></a>
<a name="//apple_ref/swift/Property/lineOptions" class="dashAnchor"></a>
<a class="token" href="#/s:11StepperView12PitStopStepsV11lineOptionsAA0cd4LineG0Ovp">lineOptions</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>options to customise pitstop line for <code>width</code> and <code>Color</code></p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">lineOptions</span><span class="p">:</span> <span class="kt"><a href="../Enums/PitStopLineOptions.html">PitStopLineOptions</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11StepperView12PitStopStepsV4view11lineOptionsAC7SwiftUI03AnyB0V_AA0cd4LineH0Otcfc"></a>
<a name="//apple_ref/swift/Method/init(view:lineOptions:)" class="dashAnchor"></a>
<a class="token" href="#/s:11StepperView12PitStopStepsV4view11lineOptionsAC7SwiftUI03AnyB0V_AA0cd4LineH0Otcfc">init(view:<wbr>lineOptions:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Initilazer to hold <code>View</code> and pit stop line Options</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">view</span><span class="p">:</span> <span class="kt">AnyView</span><span class="p">,</span> <span class="nv">lineOptions</span><span class="p">:</span> <span class="kt"><a href="../Enums/PitStopLineOptions.html">PitStopLineOptions</a></span> <span class="o">=</span> <span class="o">.</span><span class="nf">custom</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="kt"><a href="../Enums/Colors.html">Colors</a></span><span class="o">.</span><span class="nf">gray</span><span class="p">(</span><span class="o">.</span><span class="n">light</span><span class="p">)</span><span class="o">.</span><span class="n">rawValue</span><span class="p">))</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>view</em>
</code>
</td>
<td>
<div>
<p><code>View</code> to render</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>lineOptions</em>
</code>
</td>
<td>
<div>
<p>options to customise pitstop line for <code>width</code> and <code>Color</code></p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11StepperView12PitStopStepsV4hash4intoys6HasherVz_tF"></a>
<a name="//apple_ref/swift/Method/hash(into:)" class="dashAnchor"></a>
<a class="token" href="#/s:11StepperView12PitStopStepsV4hash4intoys6HasherVz_tF">hash(into:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>to generate hash</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">hash</span><span class="p">(</span><span class="n">into</span> <span class="nv">hasher</span><span class="p">:</span> <span class="k">inout</span> <span class="kt">Hasher</span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>hasher</em>
</code>
</td>
<td>
<div>
<p>hasger variable</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11StepperView12PitStopStepsV2eeoiySbAC_ACtFZ"></a>
<a name="//apple_ref/swift/Method/==(_:_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11StepperView12PitStopStepsV2eeoiySbAC_ACtFZ">==(_:<wbr>_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>equatable override</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="o">==</span> <span class="p">(</span><span class="nv">lhs</span><span class="p">:</span> <span class="kt">PitStopSteps</span><span class="p">,</span> <span class="nv">rhs</span><span class="p">:</span> <span class="kt">PitStopSteps</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>lhs</em>
</code>
</td>
<td>
<div>
<p>lhs variable for comparison</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>rhs</em>
</code>
</td>
<td>
<div>
<p>lhs variable for comparison</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/badrinathvm/StepperView" target="_blank" rel="external">badrinathvm</a>. All rights reserved. (Last updated: 2020-04-28)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>