diff options
Diffstat (limited to 'docs/Classes/SDLKeyboardEvent.html')
-rw-r--r-- | docs/Classes/SDLKeyboardEvent.html | 148 |
1 files changed, 148 insertions, 0 deletions
diff --git a/docs/Classes/SDLKeyboardEvent.html b/docs/Classes/SDLKeyboardEvent.html new file mode 100644 index 000000000..98ac8c708 --- /dev/null +++ b/docs/Classes/SDLKeyboardEvent.html @@ -0,0 +1,148 @@ +<h1>SDLKeyboardEvent 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-+KEYPRESS">+KEYPRESS</a></li> + <li><a href="#section-+ENTRY_SUBMITTED">+ENTRY_SUBMITTED</a></li> + <li><a href="#section-+ENTRY_CANCELLED">+ENTRY_CANCELLED</a></li> + <li><a href="#section-+ENTRY_ABORTED">+ENTRY_ABORTED</a></li> + <li><a href="#section-+ENTRY_VOICE">+ENTRY_VOICE</a></li> +</ul> + +<h3>Overview</h3> + +<p>Enumeration listing possible keyboard events. + * + * @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">SDLKeyboardEvent</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">SDLKeyboardEvent</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + + + + + + <h3> + +KEYPRESS + </h3> + + <p>The use has pressed the keyboard key (applies to both SINGLE_KEYPRESS and RESEND_CURRENT_ENTRY modes). + *</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLKeyboardEvent</span> <span class="o">*</span><span class="p">)</span><span class="n">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">KEYPRESS</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLKeyboardEvent</span><span class="o">!</span></code></pre> + + + + + <h3> + +ENTRY_SUBMITTED + </h3> + + <p>The User has finished entering text from the keyboard and submitted the entry. + *</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLKeyboardEvent</span> <span class="o">*</span><span class="p">)</span><span class="n">ENTRY_SUBMITTED</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">ENTRY_SUBMITTED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLKeyboardEvent</span><span class="o">!</span></code></pre> + + + + + <h3> + +ENTRY_CANCELLED + </h3> + + <p>The User has pressed the HMI-defined <q>Cancel</q> button. + *</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLKeyboardEvent</span> <span class="o">*</span><span class="p">)</span><span class="n">ENTRY_CANCELLED</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">ENTRY_CANCELLED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLKeyboardEvent</span><span class="o">!</span></code></pre> + + + + + <h3> + +ENTRY_ABORTED + </h3> + + <p>The User has not finished entering text and the keyboard is aborted with the event of higher priority. + *</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLKeyboardEvent</span> <span class="o">*</span><span class="p">)</span><span class="n">ENTRY_ABORTED</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">ENTRY_ABORTED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLKeyboardEvent</span><span class="o">!</span></code></pre> + + + + + <h3> + +ENTRY_VOICE + </h3> + + <p>@since SDL 4.0</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLKeyboardEvent</span> <span class="o">*</span><span class="p">)</span><span class="n">ENTRY_VOICE</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">ENTRY_VOICE</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLKeyboardEvent</span><span class="o">!</span></code></pre> + + + + +</section> |