summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLTextFieldName.h
blob: 99686cc4e496ad77e17ecdeae2d71e228b77131d (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
//  SDLTextFieldName.h
//


#import "SDLEnum.h"

/**
 * Names of the text fields that can appear on a SDL display.
 *
 * @since SDL 1.0
 */
typedef SDLEnum SDLTextFieldName SDL_SWIFT_ENUM;

/**
 * @abstract The first line of the first set of main fields of the persistent display. Applies to SDLShow.
 */
extern SDLTextFieldName const SDLTextFieldNameMainField1;

/**
 * @abstract The second line of the first set of main fields of the persistent display. Applies to SDLShow.
 *
 * @since SDL 2.0
 */
extern SDLTextFieldName const SDLTextFieldNameMainField2;

/**
 * @abstract The first line of the second set of main fields of the persistent display. Applies to SDLShow.
 *
 * @since SDL 2.0
 */
extern SDLTextFieldName const SDLTextFieldNameMainField3;

/**
 * @abstract The second line of the second set of main fields of the persistent display. Applies to SDLShow.
 */
extern SDLTextFieldName const SDLTextFieldNameMainField4;

/**
 * @abstract The status bar on the NGN display. Applies to SDLShow.
 */
extern SDLTextFieldName const SDLTextFieldNameStatusBar;

/**
 * @abstract Text value for MediaClock field. Must be properly formatted according to MediaClockFormat. Applies to SDLShow.
 *
 * @discussion This field is commonly used to show elapsed or remaining time in an audio track or audio capture.
 */
extern SDLTextFieldName const SDLTextFieldNameMediaClock;

/**
 * @abstract The track field of NGN type ACMs. This field is only available for media applications on a NGN display. Applies to SDLShow.
 *
 * @discussion This field is commonly used to show the current track number
 */
extern SDLTextFieldName const SDLTextFieldNameMediaTrack;

/**
 * @abstract The first line of the alert text field. Applies to SDLAlert.
 */
extern SDLTextFieldName const SDLTextFieldNameAlertText1;

/**
 * @abstract The second line of the alert text field. Applies to SDLAlert.
 *
 * @since SDL 2.0
 */
extern SDLTextFieldName const SDLTextFieldNameAlertText2;

/**
 * @abstract The third line of the alert text field. Applies to SDLAlert.
 *
 * @since SDL 2.0
 */
extern SDLTextFieldName const SDLTextFieldNameAlertText3;

/**
 * @abstract Long form body of text that can include newlines and tabs. Applies to SDLScrollableMessage.
 *
 * @since SDL 2.0
 */
extern SDLTextFieldName const SDLTextFieldNameScrollableMessageBody;

/**
 * @abstract First line suggestion for a user response (in the case of VR enabled interaction).
 *
 * @since SDL 2.0
 */
extern SDLTextFieldName const SDLTextFieldNameInitialInteractionText;

/**
 * @abstract First line of navigation text.
 *
 * @since SDL 2.0
 */
extern SDLTextFieldName const SDLTextFieldNameNavigationText1;

/**
 * @abstract Second line of navigation text.
 *
 * @since SDL 2.0
 */
extern SDLTextFieldName const SDLTextFieldNameNavigationText2;

/**
 * @abstract Estimated Time of Arrival time for navigation.
 *
 * @since SDL 2.0
 */
extern SDLTextFieldName const SDLTextFieldNameETA;

/**
 * @abstract Total distance to destination for navigation.
 *
 * @since SDL 2.0
 */
extern SDLTextFieldName const SDLTextFieldNameTotalDistance;

/**
 * @abstract First line of text for audio pass thru.
 *
 * @since SDL 2.0
 */
extern SDLTextFieldName const SDLTextFieldNameAudioPassThruDisplayText1;

/**
 * @abstract Second line of text for audio pass thru.
 *
 * @since SDL 2.0
 */
extern SDLTextFieldName const SDLTextFieldNameAudioPassThruDisplayText2;

/**
 * @abstract Header text for slider.
 *
 * @since SDL 2.0
 */
extern SDLTextFieldName const SDLTextFieldNameSliderHeader;

/**
 * @abstract Footer text for slider
 *
 * @since SDL 2.0
 */
extern SDLTextFieldName const SDLTextFieldNameSliderFooter;

/**
 * Primary text for SDLChoice
 */
extern SDLTextFieldName const SDLTextFieldNameMenuName;

/**
 * Secondary text for SDLChoice
 */
extern SDLTextFieldName const SDLTextFieldNameSecondaryText;

/**
 * Tertiary text for SDLChoice
 */
extern SDLTextFieldName const SDLTextFieldNameTertiaryText;

/**
 * Optional text to label an app menu button (for certain touchscreen platforms)
 */
extern SDLTextFieldName const SDLTextFieldNameMenuTitle;

/**
 * Optional name / title of intended location for SDLSendLocation
 *
 * @since SDL 4.0
 */
extern SDLTextFieldName const SDLTextFieldNameLocationName;

/**
 * Optional description of intended location / establishment (if applicable) for SDLSendLocation
 *
 * @since SDL 4.0
 */
extern SDLTextFieldName const SDLTextFieldNameLocationDescription;

/**
 * Optional location address (if applicable) for SDLSendLocation
 *
 * @since SDL 4.0
 */
extern SDLTextFieldName const SDLTextFieldNameAddressLines;

/**
 * Optional hone number of intended location / establishment (if applicable) for SDLSendLocation
 *
 * @since SDL 4.0
 */
extern SDLTextFieldName const SDLTextFieldNamePhoneNumber;