summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLButtonName.h
blob: 0956c80e38bdf15919e5d2666225ba09b577511b (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
204
205
206
207
208
209
210
211
212
213
//  SDLButtonName.h
//


#import "SDLEnum.h"

/**
 * Defines logical buttons which, on a given SDL unit, would correspond to
 * either physical or soft (touchscreen) buttons. These logical buttons present
 * a standard functional abstraction which the developer can rely upon,
 * independent of the SDL unit. For example, the developer can rely upon the OK
 * button having the same meaning to the user across SDL platforms.
 *
 * The preset buttons (0-9) can typically be interpreted by the application as
 * corresponding to some user-configured choices, though the application is free
 * to interpret these button presses as it sees fit.
 *
 * The application can discover which buttons a given SDL unit implements by
 * interrogating the ButtonCapabilities parameter of the
 * RegisterAppInterface response.
 *
 * @since SDL 1.0
 */
typedef SDLEnum SDLButtonName SDL_SWIFT_ENUM;

/**
 * @abstract Represents the button usually labeled "OK". A typical use of this button is for the user to press it to make a selection.
 */
extern SDLButtonName const SDLButtonNameOk;

/**
 * @abstract Represents the seek-left button. A typical use of this button is for the user to scroll to the left through menu choices one menu item per press.
 */
extern SDLButtonName const SDLButtonNameSeekLeft;

/**
 * @abstract Represents the seek-right button. A typical use of this button is for the user to scroll to the right through menu choices one menu item per press.
 */
extern SDLButtonName const SDLButtonNameSeekRight;

/**
 * @abstract Represents a turn of the tuner knob in the clockwise direction one tick.
 */
extern SDLButtonName const SDLButtonNameTuneUp;

/**
 * @abstract Represents a turn of the tuner knob in the counter-clockwise direction one tick.
 */
extern SDLButtonName const SDLButtonNameTuneDown;

/**
 * @abstract Represents the preset 0 button.
 */
extern SDLButtonName const SDLButtonNamePreset0;

/**
 * @abstract Represents the preset 1 button.
 */
extern SDLButtonName const SDLButtonNamePreset1;

/**
 * @abstract Represents the preset 2 button.
 */
extern SDLButtonName const SDLButtonNamePreset2;

/**
 * @abstract Represents the preset 3 button.
 */
extern SDLButtonName const SDLButtonNamePreset3;

/**
 * @abstract Represents the preset 4 button.
 */
extern SDLButtonName const SDLButtonNamePreset4;

/**
 * @abstract Represents the preset 5 button.
 */
extern SDLButtonName const SDLButtonNamePreset5;

/**
 * @abstract Represents the preset 6 button.
 */
extern SDLButtonName const SDLButtonNamePreset6;

/**
 * @abstract Represents the preset 7 button.
 */
extern SDLButtonName const SDLButtonNamePreset7;

/**
 * @abstract Represents the preset 8 button.
 */
extern SDLButtonName const SDLButtonNamePreset8;

/**
 * @abstract Represents the preset 9 button.
 */
extern SDLButtonName const SDLButtonNamePreset9;

/**
 * @abstract Represents the Custom button.
 *
 */
extern SDLButtonName const SDLButtonNameCustomButton;

/**
 * @abstract Represents the SEARCH button.
 *
 */
extern SDLButtonName const SDLButtonNameSearch;

#pragma mark - Climate Buttons

/**
 * @abstract Represents AC max button *
 */
extern SDLButtonName const SDLButtonNameACMax;

/**
 * @abstract Represents AC button *
 */
extern SDLButtonName const SDLButtonNameAC;

/**
 * @abstract Represents a Recirculate button
 */
extern SDLButtonName const SDLButtonNameRecirculate;

/**
 * @abstract Represents a Fan up button
 */
extern SDLButtonName const SDLButtonNameFanUp;

/**
 * @abstract Represents a fan down button
 */
extern SDLButtonName const SDLButtonNameFanDown;

/**
 * @abstract Represents a temperature up button
 */
extern SDLButtonName const SDLButtonNameTempUp;

/**
 * @abstract Represents a temperature down button
 */
extern SDLButtonName const SDLButtonNameTempDown;

/**
 * @abstract Represents a Defrost max button.
 *
 */
extern SDLButtonName const SDLButtonNameDefrostMax;

/**
 * @abstract Represents a Defrost button.
 *
 */
extern SDLButtonName const SDLButtonNameDefrost;

/**
 * @abstract Represents a Defrost rear button.
 *
 */
extern SDLButtonName const SDLButtonNameDefrostRear;

/**
 * @abstract Represents a Upper Vent button.
 *
 */
extern SDLButtonName const SDLButtonNameUpperVent;

/**
 * @abstract Represents a Lower vent button.
 *
 */
extern SDLButtonName const SDLButtonNameLowerVent;

#pragma mark - Radio Buttons
/**
 * @abstract Represents a volume up button.
 */
extern SDLButtonName const SDLButtonNameVolumeUp;

/**
 * @abstract Represents a volume down button.
 *
 */
extern SDLButtonName const SDLButtonNameVolumeDown;

/**
 * @abstract Represents a Eject Button.
 *
 */
extern SDLButtonName const SDLButtonNameEject;

/**
 * @abstract Represents a Source button.
 *
 */
extern SDLButtonName const SDLButtonNameSource;

/**
 * @abstract Represents a SHUFFLE button.
 *
 */
extern SDLButtonName const SDLButtonNameShuffle;

/**
 * @abstract Represents a Repeat button.
 */
extern SDLButtonName const SDLButtonNameRepeat;