summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLKeyboardEvent.h
blob: 02fbf755406d441f55c7aacddc69f6de459162be (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
//  SDLKeyboardEvent.h
//


#import "SDLEnum.h"

/**
 Enumeration listing possible keyboard events. Used in OnKeyboardInput.

 @since SmartDeviceLink 3.0
 */
typedef SDLEnum SDLKeyboardEvent SDL_SWIFT_ENUM;

/**
 The use has pressed the keyboard key (applies to both SINGLE_KEYPRESS and RESEND_CURRENT_ENTRY modes).
 */
extern SDLKeyboardEvent const SDLKeyboardEventKeypress;

/**
 The User has finished entering text from the keyboard and submitted the entry.
 */
extern SDLKeyboardEvent const SDLKeyboardEventSubmitted;

/**
 The User has pressed the HMI-defined "Cancel" button.
 */
extern SDLKeyboardEvent const SDLKeyboardEventCancelled;

/**
 The User has not finished entering text and the keyboard is aborted with the event of higher priority.
 */
extern SDLKeyboardEvent const SDLKeyboardEventAborted;

/**
 The user used voice as input for the keyboard

 @since SDL 4.0
 */
extern SDLKeyboardEvent const SDLKeyboardEventVoice;