summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLKeypressMode.h
blob: 668f75f21ec88436b3608776deef542c96b7895c (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
//  SDLKeypressMode.h
//


#import "SDLEnum.h"

/** 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
 *
 */
typedef SDLEnum SDLKeypressMode SDL_SWIFT_ENUM;

/** SINGLE_KEYPRESS:<br>Each and every User`s keypress must be reported (new notification for every newly entered single symbol).
 *
 */
extern SDLKeypressMode const SDLKeypressModeSingleKeypress;

/** QUEUE_KEYPRESSES:<br>The whole entry is reported only after the User submits it (by ‘Search’ button click displayed on touchscreen keyboard)
 *
 */
extern SDLKeypressMode const SDLKeypressModeQueueKeypresses;

/** 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).
 *
 */
extern SDLKeypressMode const SDLKeypressModeResendCurrentEntry;