summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLKeypressMode.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Classes/SDLKeypressMode.html')
-rw-r--r--docs/Classes/SDLKeypressMode.html111
1 files changed, 111 insertions, 0 deletions
diff --git a/docs/Classes/SDLKeypressMode.html b/docs/Classes/SDLKeypressMode.html
new file mode 100644
index 000000000..de7c88ab4
--- /dev/null
+++ b/docs/Classes/SDLKeypressMode.html
@@ -0,0 +1,111 @@
+<h1>SDLKeypressMode Class Reference</h1>
+
+<h3>Section Contents</h3>
+
+<ul>
+ <li><a href="#section-+valueOf:">+valueOf:</a></li>
+ <li><a href="#section-+values">+values</a></li>
+ <li><a href="#section-+SINGLE_KEYPRESS">+SINGLE_KEYPRESS</a></li>
+ <li><a href="#section-+QUEUE_KEYPRESSES">+QUEUE_KEYPRESSES</a></li>
+ <li><a href="#section-+RESEND_CURRENT_ENTRY">+RESEND_CURRENT_ENTRY</a></li>
+</ul>
+
+<h3>Overview</h3>
+
+<p>Enumeration listing possible keyboard events.
+ * <p>
+ * <b>Note:</b> Depending on keypressMode value (from keyboardProperties structure of UI.SetGlobalProperties),<br>HMI must send the onKeyboardInput notification with the following data:<br>
+ SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.
+ * @since SmartDeviceLink 3.0
+ *</p>
+
+
+<section class="section task-group-section">
+ <h3>
+ +valueOf:
+ </h3>
+
+ <p>Undocumented</p>
+
+
+
+ <h4>Objective-C</h4>
+ <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLKeypressMode</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre>
+
+
+
+
+
+ <h3>
+ +values
+ </h3>
+
+ <p>Undocumented</p>
+
+
+
+ <h4>Objective-C</h4>
+ <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLKeypressMode</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre>
+
+
+
+
+
+ <h3>
+ +SINGLE_KEYPRESS
+ </h3>
+
+ <p>SINGLE_KEYPRESS:<br>Each and every User`s keypress must be reported (new notification for every newly entered single symbol).
+ *</p>
+
+
+
+ <h4>Objective-C</h4>
+ <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLKeypressMode</span> <span class="o">*</span><span class="p">)</span><span class="n">SINGLE_KEYPRESS</span><span class="p">;</span></code></pre>
+
+
+ <h4>Swift</h4>
+ <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="kt">SINGLE_KEYPRESS</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">SDLKeypressMode</span><span class="o">!</span></code></pre>
+
+
+
+
+ <h3>
+ +QUEUE_KEYPRESSES
+ </h3>
+
+ <p>QUEUE_KEYPRESSES:<br>The whole entry is reported only after the User submits it (by ‘Search’ button click displayed on touchscreen keyboard)
+ *</p>
+
+
+
+ <h4>Objective-C</h4>
+ <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLKeypressMode</span> <span class="o">*</span><span class="p">)</span><span class="n">QUEUE_KEYPRESSES</span><span class="p">;</span></code></pre>
+
+
+ <h4>Swift</h4>
+ <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="kt">QUEUE_KEYPRESSES</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">SDLKeypressMode</span><span class="o">!</span></code></pre>
+
+
+
+
+ <h3>
+ +RESEND_CURRENT_ENTRY
+ </h3>
+
+ <p>RESEND_CURRENT_ENTRY:<br>The whole entry must be reported each and every time the User makes a new keypress<br> (new notification with all previously entered symbols and a newly entered one appended).
+ *</p>
+
+
+
+ <h4>Objective-C</h4>
+ <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLKeypressMode</span> <span class="o">*</span><span class="p">)</span><span class="n">RESEND_CURRENT_ENTRY</span><span class="p">;</span></code></pre>
+
+
+ <h4>Swift</h4>
+ <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="kt">RESEND_CURRENT_ENTRY</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">SDLKeypressMode</span><span class="o">!</span></code></pre>
+
+
+
+
+</section>