summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLMenuCell.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Classes/SDLMenuCell.html')
-rw-r--r--docs/Classes/SDLMenuCell.html75
1 files changed, 71 insertions, 4 deletions
diff --git a/docs/Classes/SDLMenuCell.html b/docs/Classes/SDLMenuCell.html
index bd379a6fb..28a65362c 100644
--- a/docs/Classes/SDLMenuCell.html
+++ b/docs/Classes/SDLMenuCell.html
@@ -10,6 +10,7 @@
<li><a href="#section-subCells">subCells</a></li>
<li><a href="#section--initWithTitle:icon:voiceCommands:handler:">-initWithTitle:icon:voiceCommands:handler:</a></li>
<li><a href="#section--initWithTitle:subCells:">-initWithTitle:subCells:</a></li>
+ <li><a href="#section--initWithTitle:icon:subCells:">-initWithTitle:icon:subCells:</a></li>
</ul>
<h3>Overview</h3>
@@ -114,12 +115,16 @@
-initWithTitle:icon:voiceCommands:handler:
</h3>
- <p>Undocumented</p>
+ <p>Create a menu cell that has no subcells.</p>
<h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTitle</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">title</span> <span class="nf">icon</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">icon</span> <span class="nf">voiceCommands</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n">NSString</span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">voiceCommands</span> <span class="nf">handler</span><span class="p">:(</span><span class="n"><a href="../Type Definitions.html#/c:SDLMenuCell.h@T@SDLMenuCellSelectionHandler">SDLMenuCellSelectionHandler</a></span><span class="p">)</span><span class="nv">handler</span><span class="p">;</span></code></pre>
+ <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span>
+<span class="nf">initWithTitle</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">title</span>
+ <span class="nf">icon</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">icon</span>
+<span class="nf">voiceCommands</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n">NSString</span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">voiceCommands</span>
+ <span class="nf">handler</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type Definitions.html#/c:SDLMenuCell.h@T@SDLMenuCellSelectionHandler">SDLMenuCellSelectionHandler</a></span><span class="p">)</span><span class="nv">handler</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
@@ -127,17 +132,34 @@
+ <h4>Parameters</h4>
+ <dl>
+ <dt>title</dt>
+ <dd><p>The cell&rsquo;s primary text</p></dd>
+ <dt>icon</dt>
+ <dd><p>The cell&rsquo;s image</p></dd>
+ <dt>voiceCommands</dt>
+ <dd><p>Voice commands that will activate the menu cell</p></dd>
+ <dt>handler</dt>
+ <dd><p>The code that will be run when the menu cell is selected</p></dd>
+ </dl>
+ <div>
+ <h4>Return Value</h4>
+ <p>The menu cell</p>
+ </div>
<h3 id="section--initWithTitle:subCells:">
-initWithTitle:subCells:
</h3>
- <p>Undocumented</p>
+ <p>Create a menu cell that has subcells and when selected will go into a deeper part of the menu</p>
<h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTitle</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">title</span> <span class="nf">subCells</span><span class="p">:(</span><span class="n">NSArray</span><span class="o">&lt;</span><span class="n">SDLMenuCell</span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">subCells</span><span class="p">;</span></code></pre>
+ <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTitle</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">title</span>
+ <span class="nf">subCells</span><span class="p">:</span>
+ <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n">SDLMenuCell</span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">subCells</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
@@ -145,5 +167,50 @@
+ <h4>Parameters</h4>
+ <dl>
+ <dt>title</dt>
+ <dd><p>The cell&rsquo;s primary text</p></dd>
+ <dt>subCells</dt>
+ <dd><p>The subcells that will appear when the cell is selected</p></dd>
+ </dl>
+ <div>
+ <h4>Return Value</h4>
+ <p>The menu cell</p>
+ </div>
+
+ <h3 id="section--initWithTitle:icon:subCells:">
+ -initWithTitle:icon:subCells:
+ </h3>
+
+ <p>Create a menu cell that has subcells and when selected will go into a deeper part of the menu</p>
+
+
+
+ <h4>Objective-C</h4>
+ <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTitle</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">title</span>
+ <span class="nf">icon</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">icon</span>
+ <span class="nf">subCells</span><span class="p">:</span>
+ <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n">SDLMenuCell</span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">subCells</span><span class="p">;</span></code></pre>
+
+
+ <h4>Swift</h4>
+ <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">title</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">icon</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span><span class="p">?,</span> <span class="nv">subCells</span><span class="p">:</span> <span class="p">[</span><span class="kt">SDLMenuCell</span><span class="p">])</span></code></pre>
+
+
+
+ <h4>Parameters</h4>
+ <dl>
+ <dt>title</dt>
+ <dd><p>The cell&rsquo;s primary text</p></dd>
+ <dt>icon</dt>
+ <dd><p>The cell&rsquo;s image</p></dd>
+ <dt>subCells</dt>
+ <dd><p>The subcells that will appear when the cell is selected</p></dd>
+ </dl>
+ <div>
+ <h4>Return Value</h4>
+ <p>The menu cell</p>
+ </div>
</section>