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.html172
1 files changed, 171 insertions, 1 deletions
diff --git a/docs/Classes/SDLMenuCell.html b/docs/Classes/SDLMenuCell.html
index 93a655725..30094a796 100644
--- a/docs/Classes/SDLMenuCell.html
+++ b/docs/Classes/SDLMenuCell.html
@@ -9,8 +9,14 @@
<li><a href="#section-handler">handler</a></li>
<li><a href="#section-subCells">subCells</a></li>
<li><a href="#section-submenuLayout">submenuLayout</a></li>
+ <li><a href="#section-uniqueTitle">uniqueTitle</a></li>
+ <li><a href="#section-secondaryText">secondaryText</a></li>
+ <li><a href="#section-tertiaryText">tertiaryText</a></li>
+ <li><a href="#section-secondaryArtwork">secondaryArtwork</a></li>
<li><a href="#section--initWithTitle:icon:voiceCommands:handler:">-initWithTitle:icon:voiceCommands:handler:</a></li>
<li><a href="#section--initWithTitle:icon:submenuLayout:subCells:">-initWithTitle:icon:submenuLayout:subCells:</a></li>
+ <li><a href="#section--initWithTitle:secondaryText:tertiaryText:icon:secondaryArtwork:voiceCommands:handler:">-initWithTitle:secondaryText:tertiaryText:icon:secondaryArtwork:voiceCommands:handler:</a></li>
+ <li><a href="#section--initWithTitle:secondaryText:tertiaryText:icon:secondaryArtwork:submenuLayout:subCells:">-initWithTitle:secondaryText:tertiaryText:icon:secondaryArtwork:submenuLayout:subCells:</a></li>
</ul>
<h3>Overview</h3>
@@ -127,6 +133,78 @@
+ <h3 id="section-uniqueTitle">
+ uniqueTitle
+ </h3>
+
+ <p>Primary text of the cell to be displayed on the module. Used to distinguish cells with the same <code><a href="../Classes/SDLMenuCell.html#/c:objc(cs)SDLMenuCell(py)title">title</a></code> but other fields are different. This is autogenerated by the screen manager. This will not be used when connected to modules supporting RPC 7.1+ because duplicate titles are supported.</p>
+
+
+
+ <h4>Objective-C</h4>
+ <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">uniqueTitle</span><span class="p">;</span></code></pre>
+
+
+ <h4>Swift</h4>
+ <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">uniqueTitle</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
+
+
+
+
+ <h3 id="section-secondaryText">
+ secondaryText
+ </h3>
+
+ <p>The cell&rsquo;s secondary text to be displayed</p>
+
+
+
+ <h4>Objective-C</h4>
+ <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">secondaryText</span><span class="p">;</span></code></pre>
+
+
+ <h4>Swift</h4>
+ <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">secondaryText</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
+
+
+
+
+ <h3 id="section-tertiaryText">
+ tertiaryText
+ </h3>
+
+ <p>The cell&rsquo;s tertiary text to be displayed</p>
+
+
+
+ <h4>Objective-C</h4>
+ <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">tertiaryText</span><span class="p">;</span></code></pre>
+
+
+ <h4>Swift</h4>
+ <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">tertiaryText</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
+
+
+
+
+ <h3 id="section-secondaryArtwork">
+ secondaryArtwork
+ </h3>
+
+ <p>The cell&rsquo;s secondary icon to be displayed</p>
+
+
+
+ <h4>Objective-C</h4>
+ <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="n">secondaryArtwork</span><span class="p">;</span></code></pre>
+
+
+ <h4>Swift</h4>
+ <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">secondaryArtwork</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
+
+
+
+
<h3 id="section--initWithTitle:icon:voiceCommands:handler:">
-initWithTitle:icon:voiceCommands:handler:
</h3>
@@ -192,7 +270,99 @@
<dt>icon</dt>
<dd><p>The cell&rsquo;s image</p></dd>
<dt>layout</dt>
- <dd><p>The layout that the subCells will be layed out in if that submenu is entered</p></dd>
+ <dd><p>The layout that the subCells will be laid out in if that submenu is entered</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:secondaryText:tertiaryText:icon:secondaryArtwork:voiceCommands:handler:">
+ -initWithTitle:secondaryText:tertiaryText:icon:secondaryArtwork:voiceCommands:handler:
+ </h3>
+
+ <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">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">secondaryText</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">secondaryText</span>
+ <span class="nf">tertiaryText</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">tertiaryText</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">secondaryArtwork</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">secondaryArtwork</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%20Definitions.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>
+ <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">secondaryText</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">tertiaryText</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">secondaryArtwork</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span><span class="p">?,</span> <span class="nv">voiceCommands</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]?,</span> <span class="nv">handler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLMenuCell.h@T@SDLMenuCellSelectionHandler">SDLMenuCellSelectionHandler</a></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>secondaryText</dt>
+ <dd><p>- secondaryText</p></dd>
+ <dt>tertiaryText</dt>
+ <dd><p>- tertiaryText</p></dd>
+ <dt>icon</dt>
+ <dd><p>The cell&rsquo;s image</p></dd>
+ <dt>secondaryArtwork</dt>
+ <dd><p>- secondaryArtwork</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:secondaryText:tertiaryText:icon:secondaryArtwork:submenuLayout:subCells:">
+ -initWithTitle:secondaryText:tertiaryText:icon:secondaryArtwork:submenuLayout: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">secondaryText</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">secondaryText</span>
+ <span class="nf">tertiaryText</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">tertiaryText</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">secondaryArtwork</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">secondaryArtwork</span>
+ <span class="nf">submenuLayout</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLMenuLayout.h@T@SDLMenuLayout">SDLMenuLayout</a></span><span class="p">)</span><span class="nv">layout</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">secondaryText</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">tertiaryText</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">secondaryArtwork</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span><span class="p">?,</span> <span class="n"><a href="../Classes/SDLMenuCell.html#/c:objc(cs)SDLMenuCell(py)submenuLayout">submenuLayout</a></span> <span class="nv">layout</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLMenuLayout.h@T@SDLMenuLayout">SDLMenuLayout</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>secondaryText</dt>
+ <dd><p>- secondaryText</p></dd>
+ <dt>tertiaryText</dt>
+ <dd><p>- tertiaryText</p></dd>
+ <dt>icon</dt>
+ <dd><p>The cell&rsquo;s image</p></dd>
+ <dt>secondaryArtwork</dt>
+ <dd><p>- secondaryArtwork</p></dd>
+ <dt>layout</dt>
+ <dd><p>The layout that the subCells will be laid out in if that submenu is entered</p></dd>
<dt>subCells</dt>
<dd><p>The subcells that will appear when the cell is selected</p></dd>
</dl>