blob: 088ec91609348d808bf53f83ab0ca1aeaebf4a6f (
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
|
<h1>SDLKeyboardDelegate Protocol Reference</h1>
<h3>Section Contents</h3>
<ul>
<li><a href="#section--userDidSubmitInput:withEvent:">-userDidSubmitInput:withEvent:</a></li>
<li><a href="#section--keyboardDidAbortWithReason:">-keyboardDidAbortWithReason:</a></li>
<li><a href="#section--customKeyboardConfiguration">-customKeyboardConfiguration</a></li>
<li><a href="#section--updateAutocompleteWithInput:autoCompleteResultsHandler:">-updateAutocompleteWithInput:autoCompleteResultsHandler:</a></li>
<li><a href="#section--updateCharacterSetWithInput:completionHandler:">-updateCharacterSetWithInput:completionHandler:</a></li>
<li><a href="#section--keyboardDidSendEvent:text:">-keyboardDidSendEvent:text:</a></li>
<li><a href="#section--keyboardDidUpdateInputMask:">-keyboardDidUpdateInputMask:</a></li>
</ul>
<h3>Overview</h3>
<p>They delegate of a keyboard popup allowing customization at runtime of the keyboard.</p>
<section class="section task-group-section">
<h3 id="section--userDidSubmitInput:withEvent:">
-userDidSubmitInput:withEvent:
</h3>
<p>The keyboard session completed with some input.</p>
<p>This will be sent upon ENTRY_SUBMITTED or ENTRY_VOICE. If the event is ENTRY_VOICE, the user requested to start a voice session in order to submit input to this keyboard. This MUST be handled by you. Start an Audio Pass Thru session if supported.</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="nf">userDidSubmitInput</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">inputText</span>
<span class="nf">withEvent</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLKeyboardEvent.h@T@SDLKeyboardEvent">SDLKeyboardEvent</a></span><span class="p">)</span><span class="nv">source</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">userDidSubmitInput</span><span class="p">(</span><span class="n">_</span> <span class="nv">inputText</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="n">withEvent</span> <span class="nv">source</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLKeyboardEvent.h@T@SDLKeyboardEvent">SDLKeyboardEvent</a></span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>inputText</dt>
<dd><p>The submitted input text on the keyboard</p></dd>
<dt>source</dt>
<dd><p>ENTRY_SUBMITTED if the user pressed the submit button on the keyboard, ENTRY_VOICE if the user requested that a voice session begin</p></dd>
</dl>
<h3 id="section--keyboardDidAbortWithReason:">
-keyboardDidAbortWithReason:
</h3>
<p>The keyboard session aborted.</p>
<p>This will be sent if the keyboard event ENTRY_CANCELLED or ENTRY_ABORTED is sent</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="nf">keyboardDidAbortWithReason</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLKeyboardEvent.h@T@SDLKeyboardEvent">SDLKeyboardEvent</a></span><span class="p">)</span><span class="nv">event</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">keyboardDidAbort</span><span class="p">(</span><span class="n">withReason</span> <span class="nv">event</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLKeyboardEvent.h@T@SDLKeyboardEvent">SDLKeyboardEvent</a></span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>event</dt>
<dd><p>ENTRY_CANCELLED if the user cancelled the keyboard input, or ENTRY_ABORTED if the system aborted the input due to a higher priority event</p></dd>
</dl>
<h3 id="section--customKeyboardConfiguration">
-customKeyboardConfiguration
</h3>
<p>Implement this in order to provide a custom keyboard configuration to just this keyboard. To apply default settings to all keyboards, see SDLScreenManager.keyboardConfiguration</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"><a href="../Classes/SDLKeyboardProperties.html">SDLKeyboardProperties</a></span> <span class="o">*</span><span class="p">)</span><span class="n">customKeyboardConfiguration</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">customKeyboardConfiguration</span><span class="p">()</span> <span class="o">-></span> <span class="kt"><a href="../Classes/SDLKeyboardProperties.html">SDLKeyboardProperties</a></span></code></pre>
<div>
<h4>Return Value</h4>
<p>The custom keyboard configuration to use.</p>
</div>
<h3 id="section--updateAutocompleteWithInput:autoCompleteResultsHandler:">
-updateAutocompleteWithInput:autoCompleteResultsHandler:
</h3>
<p>Implement this if you wish to updated the KeyboardProperties.autoCompleteList as the user updates their input. This is called upon a KEYPRESS event.</p>
<p>This allows you to present a list of options that the user can use to fill in the search / text box with suggestions you provide.</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="nf">updateAutocompleteWithInput</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">currentInputText</span>
<span class="nf">autoCompleteResultsHandler</span><span class="p">:</span>
<span class="p">(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLKeyboardDelegate.h@T@SDLKeyboardAutoCompleteResultsHandler">SDLKeyboardAutoCompleteResultsHandler</a></span><span class="p">)</span><span class="nv">resultsHandler</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">updateAutocomplete</span><span class="p">(</span><span class="n">withInput</span> <span class="nv">currentInputText</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="n">autoCompleteResultsHandler</span> <span class="nv">resultsHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLKeyboardDelegate.h@T@SDLKeyboardAutoCompleteResultsHandler">SDLKeyboardAutoCompleteResultsHandler</a></span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>currentInputText</dt>
<dd><p>The user’s full current input text</p></dd>
<dt>resultsHandler</dt>
<dd><p>A completion handler to update the autoCompleteList</p></dd>
</dl>
<h3 id="section--updateCharacterSetWithInput:completionHandler:">
-updateCharacterSetWithInput:completionHandler:
</h3>
<p>Implement this if you wish to update the limitedCharacterSet as the user updates their input. This is called upon a KEYPRESS event.</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="nf">updateCharacterSetWithInput</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">currentInputText</span>
<span class="nf">completionHandler</span><span class="p">:</span>
<span class="p">(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLKeyboardDelegate.h@T@SDLKeyboardCharacterSetCompletionHandler">SDLKeyboardCharacterSetCompletionHandler</a></span><span class="p">)</span>
<span class="n">completionHandler</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">updateCharacterSet</span><span class="p">(</span><span class="n">withInput</span> <span class="nv">currentInputText</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="k">async</span> <span class="o">-></span> <span class="p">[</span><span class="kt">String</span><span class="p">]?</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>currentInputText</dt>
<dd><p>The user’s full current input text</p></dd>
<dt>completionHandler</dt>
<dd><p>A completion handler to update the limitedCharacterSet</p></dd>
</dl>
<h3 id="section--keyboardDidSendEvent:text:">
-keyboardDidSendEvent:text:
</h3>
<p>Implement this to be notified of all events occurring on the keyboard</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="nf">keyboardDidSendEvent</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLKeyboardEvent.h@T@SDLKeyboardEvent">SDLKeyboardEvent</a></span><span class="p">)</span><span class="nv">event</span>
<span class="nf">text</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">currentInputText</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">keyboardDidSendEvent</span><span class="p">(</span><span class="n">_</span> <span class="nv">event</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLKeyboardEvent.h@T@SDLKeyboardEvent">SDLKeyboardEvent</a></span><span class="p">,</span> <span class="n">text</span> <span class="nv">currentInputText</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>event</dt>
<dd><p>The event that occurred</p></dd>
<dt>currentInputText</dt>
<dd><p>The user’s full current input text</p></dd>
</dl>
<h3 id="section--keyboardDidUpdateInputMask:">
-keyboardDidUpdateInputMask:
</h3>
<p>Implement this to be notified of input key mask update (whether or not the user has changed the input to be hidden, like passwords)</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="nf">keyboardDidUpdateInputMask</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">isEnabled</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">optional</span> <span class="kd">func</span> <span class="nf">keyboardDidUpdateInputMask</span><span class="p">(</span><span class="n">_</span> <span class="nv">isEnabled</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>isEnabled</dt>
<dd><p>- YES if the mask is enabled, NO if the mask is disabled
@added in SmartDeviceLink 7.1.0</p></dd>
</dl>
</section>
|
