summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLMenuCell.html
blob: 8efdb2275519cd27f843db38709aa5af20b4ca0a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
<h1>SDLMenuCell Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section-title">title</a></li>
  <li><a href="#section-icon">icon</a></li>
  <li><a href="#section-voiceCommands">voiceCommands</a></li>
  <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>
  <li><a href="#section--isEqualToCellWithUniqueTitle:">-isEqualToCellWithUniqueTitle:</a></li>
</ul>

<h3>Overview</h3>

<p>A menu cell item for the main menu or sub-menu.</p>


<section class="section task-group-section">
  <h3 id="section-title">
      title
  </h3>
  
  <p>The cell&rsquo;s 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">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">title</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">title</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-icon">
      icon
  </h3>
  
  <p>The cell&rsquo;s 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">icon</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</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="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-voiceCommands">
      voiceCommands
  </h3>
  
  <p>The strings the user can say to activate this voice command</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">NSArray</span><span class="o">&lt;</span><span class="n">NSString</span> <span class="o">*&gt;</span> <span class="o">*</span><span class="n">voiceCommands</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</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="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-handler">
      handler
  </h3>
  
  <p>The handler that will be called when the command is activated</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"><a href="../Type%20Definitions.html#/c:SDLMenuCell.h@T@SDLMenuCellSelectionHandler">SDLMenuCellSelectionHandler</a></span> <span class="n">handler</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLMenuCell.h@T@SDLMenuCellSelectionHandler">SDLMenuCellSelectionHandler</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-subCells">
      subCells
  </h3>
  
  <p>If this is non-nil, this cell will be a sub-menu button, displaying the subcells in a menu when pressed.</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">NSArray</span><span class="o">&lt;</span><span class="n">SDLMenuCell</span> <span class="o">*&gt;</span> <span class="o">*</span><span class="n">subCells</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">subCells</span><span class="p">:</span> <span class="p">[</span><span class="kt">SDLMenuCell</span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-submenuLayout">
      submenuLayout
  </h3>
  
  <p>The layout in which the <code><a href="../Classes/SDLMenuCell.html#/c:objc(cs)SDLMenuCell(py)subCells">subCells</a></code> will 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="../Type%20Definitions.html#/c:SDLMenuLayout.h@T@SDLMenuLayout">SDLMenuLayout</a></span> <span class="n">submenuLayout</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">submenuLayout</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="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

  
  
  
  <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>
  
  <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">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%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">icon</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>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:icon:submenuLayout:subCells:">
      -initWithTitle:icon: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">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">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">icon</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>icon</dt>
      <dd><p>The cell&rsquo;s image</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>
  <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>
  <div>
    <h4>Return Value</h4>
    <p>The menu cell</p>
  </div>
  
  <h3 id="section--isEqualToCellWithUniqueTitle:">
      -isEqualToCellWithUniqueTitle:
  </h3>
  
  <p>Check cell equality including the internally used <code><a href="../Classes/SDLMenuCell.html#/c:objc(cs)SDLMenuCell(py)uniqueTitle">uniqueTitle</a></code> property. To compare without <code><a href="../Classes/SDLMenuCell.html#/c:objc(cs)SDLMenuCell(py)uniqueTitle">uniqueTitle</a></code>, use the <code>isEqual:</code> method.</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">isEqualToCellWithUniqueTitle</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">SDLMenuCell</span> <span class="o">*</span><span class="p">)</span><span class="nv">cell</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">isEqualToCell</span><span class="p">(</span><span class="n">withUniqueTitle</span> <span class="nv">cell</span><span class="p">:</span> <span class="kt">SDLMenuCell</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>cell</dt>
      <dd><p>The other cell to compare with</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>True if the cells are equal, including the <code><a href="../Classes/SDLMenuCell.html#/c:objc(cs)SDLMenuCell(py)uniqueTitle">uniqueTitle</a></code> property, False otherwise</p>
  </div>
  
</section>