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
|
<h1>SDLSoftButtonObject Class Reference</h1>
<h3>Section Contents</h3>
<ul>
<li><a href="#section-name">name</a></li>
<li><a href="#section-states">states</a></li>
<li><a href="#section-currentState">currentState</a></li>
<li><a href="#section-currentStateSoftButton">currentStateSoftButton</a></li>
<li><a href="#section-eventHandler">eventHandler</a></li>
<li><a href="#section--initWithName:states:initialStateName:handler:">-initWithName:states:initialStateName:handler:</a></li>
<li><a href="#section--initWithName:state:handler:">-initWithName:state:handler:</a></li>
<li><a href="#section--initWithName:text:artwork:handler:">-initWithName:text:artwork:handler:</a></li>
<li><a href="#section--transitionToStateNamed:">-transitionToStateNamed:</a></li>
<li><a href="#section--transitionToNextState">-transitionToNextState</a></li>
<li><a href="#section--stateWithName:">-stateWithName:</a></li>
</ul>
<h3>Overview</h3>
<p>A soft button wrapper object that is capable of storing and switching between states</p>
<section class="section task-group-section">
<h3 id="section-name">
name
</h3>
<p>The name of this button</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">name</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">name</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-states">
states
</h3>
<p>All states available to this button</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">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLSoftButtonState.html">SDLSoftButtonState</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">states</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">states</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLSoftButtonState.html">SDLSoftButtonState</a></span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<h3 id="section-currentState">
currentState
</h3>
<p>The name of the current state of this soft button</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"><a href="../Classes/SDLSoftButtonState.html">SDLSoftButtonState</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">currentState</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">currentState</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLSoftButtonState.html">SDLSoftButtonState</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<h3 id="section-currentStateSoftButton">
currentStateSoftButton
</h3>
<p>Describes an on-screen button which may be presented in various contexts, e.g. templates or alerts</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"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">currentStateSoftButton</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">currentStateSoftButton</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<h3 id="section-eventHandler">
eventHandler
</h3>
<p>The handler to be called when the button is in the current state and is 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">strong</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCButtonNotificationHandler">SDLRPCButtonNotificationHandler</a></span> <span class="n">_Nonnull</span> <span class="n">eventHandler</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">eventHandler</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCButtonNotificationHandler">SDLRPCButtonNotificationHandler</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<h3 id="section--initWithName:states:initialStateName:handler:">
-initWithName:states:initialStateName:handler:
</h3>
<p>Create a multi-state (or single-state, but you should use initWithName:state: instead for that case) soft button. For example, a button that changes its image or text, such as a repeat or shuffle button.</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">initWithName</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">name</span>
<span class="nf">states</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLSoftButtonState.html">SDLSoftButtonState</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">states</span>
<span class="nf">initialStateName</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">initialStateName</span>
<span class="nf">handler</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCButtonNotificationHandler">SDLRPCButtonNotificationHandler</a></span><span class="p">)</span><span class="nv">eventHandler</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">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">states</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLSoftButtonState.html">SDLSoftButtonState</a></span><span class="p">],</span> <span class="nv">initialStateName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="n">handler</span> <span class="nv">eventHandler</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCButtonNotificationHandler">SDLRPCButtonNotificationHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>name</dt>
<dd><p>The name of the button</p></dd>
<dt>states</dt>
<dd><p>The states available to the button</p></dd>
<dt>eventHandler</dt>
<dd><p>The handler to be called when the button is in the current state and is pressed</p></dd>
<dt>initialStateName</dt>
<dd><p>The first state to use</p></dd>
</dl>
<h3 id="section--initWithName:state:handler:">
-initWithName:state:handler:
</h3>
<p>Create a single-state soft button. For example, a button that brings up a Perform Interaction 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">initWithName</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">name</span>
<span class="nf">state</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLSoftButtonState.html">SDLSoftButtonState</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">state</span>
<span class="nf">handler</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCButtonNotificationHandler">SDLRPCButtonNotificationHandler</a></span><span class="p">)</span>
<span class="n"><a href="../Classes/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(py)eventHandler">eventHandler</a></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">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">state</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLSoftButtonState.html">SDLSoftButtonState</a></span><span class="p">,</span> <span class="n">handler</span> <span class="nv">eventHandler</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCButtonNotificationHandler">SDLRPCButtonNotificationHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>name</dt>
<dd><p>The name of the button</p></dd>
<dt>state</dt>
<dd><p>The single state of the button</p></dd>
<dt>eventHandler</dt>
<dd><p>The handler to be called when the button is pressed</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>The button object</p>
</div>
<h3 id="section--initWithName:text:artwork:handler:">
-initWithName:text:artwork:handler:
</h3>
<p>Create a single-state soft button. For example, a button that brings up a Perform Interaction 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">initWithName</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">name</span>
<span class="nf">text</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">text</span>
<span class="nf">artwork</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">artwork</span>
<span class="nf">handler</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCButtonNotificationHandler">SDLRPCButtonNotificationHandler</a></span><span class="p">)</span>
<span class="n"><a href="../Classes/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(py)eventHandler">eventHandler</a></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">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">text</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">artwork</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span><span class="p">?,</span> <span class="n">handler</span> <span class="nv">eventHandler</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCButtonNotificationHandler">SDLRPCButtonNotificationHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>name</dt>
<dd><p>The name of the button</p></dd>
<dt>text</dt>
<dd><p>The text to be displayed on the button</p></dd>
<dt>artwork</dt>
<dd><p>The artwork to be displayed on the button</p></dd>
<dt>eventHandler</dt>
<dd><p>The handler to be called when the button is pressed</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>The button object</p>
</div>
<h3 id="section--transitionToStateNamed:">
-transitionToStateNamed:
</h3>
<p>Transition the soft button to another state in the <code><a href="../Classes/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(py)states">states</a></code> property. The wrapper considers all transitions valid (assuming a state with that name exists).</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
<p>This method will throw an exception and crash your app (on purpose) if you attempt an invalid transition. So…don’t do that.</p>
</div>
<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">transitionToStateNamed</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">stateName</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">transition</span><span class="p">(</span><span class="n">toState</span> <span class="nv">stateName</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>stateName</dt>
<dd><p>The next state.</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>YES if a state was found with that name, NO otherwise.</p>
</div>
<h3 id="section--transitionToNextState">
-transitionToNextState
</h3>
<p>Transition the soft button to the next state of the array set when in the <code><a href="../Classes/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(py)states">states</a></code> property</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">transitionToNextState</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">transitionToNextState</span><span class="p">()</span></code></pre>
<h3 id="section--stateWithName:">
-stateWithName:
</h3>
<p>Return a state from the state array with a specific name.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLSoftButtonState.html">SDLSoftButtonState</a></span> <span class="o">*</span><span class="p">)</span><span class="nf">stateWithName</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">stateName</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">state</span><span class="p">(</span><span class="n">withName</span> <span class="nv">stateName</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt"><a href="../Classes/SDLSoftButtonState.html">SDLSoftButtonState</a></span><span class="p">?</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>stateName</dt>
<dd><p>The name of the state to return</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>The state, or nil if no state with that name exists</p>
</div>
</section>
|
