|
1 /* |
|
2 * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: Domain Central Repository definitions of Startup Services subsystem. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef STARTUPDOMAINCRKEYS_H |
|
20 #define STARTUPDOMAINCRKEYS_H |
|
21 |
|
22 #include <centralrepository.h> |
|
23 |
|
24 // ============================================================================= |
|
25 // Startup Configuration API |
|
26 // ============================================================================= |
|
27 static const TUid KCRUidStartupConf = { 0x101F8763 }; |
|
28 |
|
29 // Key values starting from 0x00000101 are reserved - do not use for this API. |
|
30 |
|
31 /** |
|
32 * Welcome note image (user selection in GS) |
|
33 * Old Shared Data constant name: KGSWelcomeNoteImage |
|
34 */ |
|
35 const TUint32 KStartupWelcomeNoteImage = 0x00000004; |
|
36 |
|
37 /** |
|
38 * Welcome note text (user selection in GS) |
|
39 * Old Shared Data constant name: KGSWelcomeNoteText |
|
40 */ |
|
41 const TUint32 KStartupWelcomeNoteText = 0x00000005; |
|
42 |
|
43 /** |
|
44 * Welcome note type (user selection in GS). |
|
45 * Old Shared Data constant name: KGSWelcomeNoteType |
|
46 */ |
|
47 const TUint32 KStartupWelcomeNoteType = 0x00000006; |
|
48 enum TStartupWelcomeNoteType |
|
49 { |
|
50 EDefaultWelcomeNote = 0, |
|
51 ETextWelcomeNote, |
|
52 EImageWelcomeNote |
|
53 }; |
|
54 |
|
55 /** |
|
56 * Operator note image. Will overrule the user selection, if defined. |
|
57 */ |
|
58 const TUint32 KStartupOperatorNoteImage = 0x00000007; |
|
59 |
|
60 /** |
|
61 * Operator note text. Will overrule the user selection, if defined. |
|
62 */ |
|
63 const TUint32 KStartupOperatorNoteText = 0x00000008; |
|
64 |
|
65 /** |
|
66 * Enable / disable startup queries (city, date, time). |
|
67 * Can be used also with Predictive Time and Country Selection |
|
68 * to disable queries that are shown when network time is unavailable. |
|
69 */ |
|
70 const TUint32 KStartupQueries = 0x0000000A; |
|
71 enum TStartupQueries |
|
72 { |
|
73 EStartupQueriesDisabled = 0, |
|
74 EStartupQueriesEnabled |
|
75 }; |
|
76 |
|
77 /** |
|
78 * Predictive Time and Country Selection. |
|
79 * When Predictive Time and Country Selection is enabled, time and country |
|
80 * information is queried from the network instead of from user. |
|
81 * If network does not support this feature, user is queried to insert |
|
82 * time, date and country manually. |
|
83 */ |
|
84 const TUint32 KPredictiveTimeAndCountrySelection = 0x0000000B; |
|
85 enum TPredictiveTime |
|
86 { |
|
87 EPredictiveTimeDisabled = 0, |
|
88 EPredictiveTimeEnabled |
|
89 }; |
|
90 |
|
91 /** |
|
92 * A string that defines the path and file name of the startup animation file. |
|
93 * This is the first animation shown during the system start-up. |
|
94 * The value is mandatory, and it has to be a file name and a path of a valid |
|
95 * animation file. |
|
96 * The animation file should be stored in a location where system applications |
|
97 * have read access. |
|
98 * Supported formats are SVG-T (.svg, .svgb), MIF (.mif) and GIF (.gif). |
|
99 * Text or embedded images in SVG-T files are not supported. |
|
100 * The length of the startup animation should be 3 seconds. |
|
101 * Example: "Z:\\resource\\apps\\startup.svg" |
|
102 */ |
|
103 const TUint32 KStartupAnimationPath = 0x0000000D; |
|
104 |
|
105 /** |
|
106 * A frame delay value in microseconds for fine-tuning the startup animation. |
|
107 * The value is only used if: |
|
108 * a) The animation file contains an animation format, which does not contain |
|
109 * frame delay information in it (MIF), or |
|
110 * b) The animation file contains a still image, and no startup tone |
|
111 * has been specified, in which case this value defines how long the image |
|
112 * is shown. |
|
113 */ |
|
114 const TUint32 KStartupAnimationFrameDelay = 0x0000000E; |
|
115 |
|
116 /** |
|
117 * Enable/disable scaling of the animation frames. |
|
118 * The value is only used if the animation format supports enabling/disabling |
|
119 * scaling. |
|
120 * One of the values of TStartupAnimationScalingValue enumeration. |
|
121 */ |
|
122 const TUint32 KStartupAnimationScaling = 0x00000017; |
|
123 enum TStartupAnimationScalingValue |
|
124 { |
|
125 EScalingDisabled = 0, |
|
126 EScalingEnabled |
|
127 }; |
|
128 |
|
129 /** |
|
130 * A string that defines the path to the startup tone MIDI file. |
|
131 * The tone is played at the same time as the startup animation is being shown. |
|
132 * The value is optional - if no tone file is defined, the default beep tone is |
|
133 * played. |
|
134 * The tone file should be stored in a location where system applications have |
|
135 * read access. |
|
136 * The startup tone should be at most 3 seconds long. The tone will be played to |
|
137 * the end before continuing with the next animation. |
|
138 * Example: "Z:\\resource\\apps\\startup.wav" |
|
139 * Old Shared Data constant name: KStartupAppTonePath |
|
140 */ |
|
141 const TUint32 KStartupTonePath = 0x00000003; |
|
142 |
|
143 /** |
|
144 * The volume level used when playing the startup tone. |
|
145 * Possible values range from 0 to 10. |
|
146 * If the ringing tone is silent, the tone is not played. |
|
147 * Old Shared Data constant name: KStartupAppToneVolume |
|
148 */ |
|
149 const TUint32 KStartupToneVolume = 0x00000002; |
|
150 |
|
151 /** |
|
152 * A string that defines the path and file name of the operator-specific startup |
|
153 * animation file. |
|
154 * The operator-specific startup animation is shown after the startup animation. |
|
155 * The value is optional. If defined, it has to be a file name and a path of a |
|
156 * valid animation file. |
|
157 * The animation file should be stored in a location where system applications |
|
158 * have read access. |
|
159 * Supported formats are SVG-T (.svg, .svgb), MIF (.mif) and GIF (.gif). |
|
160 * Text or embedded images in SVG-T files are not supported. |
|
161 * The length of the operator-specific startup animation should be 3-5 seconds. |
|
162 * Animations longer than that may cause performance problems. |
|
163 * Example: "Z:\\resource\\apps\\operatorstartup.svg" |
|
164 */ |
|
165 const TUint32 KStartupOperatorAnimationPath = 0x0000000F; |
|
166 |
|
167 /** |
|
168 * A frame delay value in microseconds for fine-tuning the operator-specific |
|
169 * startup animation. |
|
170 * The value is only used if: |
|
171 * a) The operator-specific startup animation file contains an animation format, |
|
172 * which does not contain frame delay information in it (MIF), or |
|
173 * b) The operator-specific startup animation file contains a still image, and no |
|
174 * operator-specific startup tone has been specified, in which case this value |
|
175 * defines how long the image is shown. |
|
176 */ |
|
177 const TUint32 KStartupOperatorAnimationFrameDelay = 0x00000010; |
|
178 |
|
179 /** |
|
180 * Enable/disable scaling of the animation frames. |
|
181 * The value is only used if the animation format supports enabling/disabling |
|
182 * scaling. |
|
183 * One of the values of TStartupAnimationScalingValue enumeration. |
|
184 */ |
|
185 const TUint32 KStartupOperatorAnimationScaling = 0x00000018; |
|
186 |
|
187 /** |
|
188 * A string that defines the path to the operator-specific startup tone MIDI file. |
|
189 * The tone is played at the same time as the operator-specific startup animation |
|
190 * is shown. |
|
191 * The value is optional. |
|
192 * The tone file should be stored in a location where system applications have |
|
193 * read access. |
|
194 * The operator-specific startup tone should be at most 5 seconds long. The tone |
|
195 * will be played to the end before continuing the startup. |
|
196 * Example: "Z:\\resource\\apps\\operatorstartup.wav" |
|
197 */ |
|
198 const TUint32 KStartupOperatorTonePath = 0x00000009; |
|
199 |
|
200 /** |
|
201 * The volume level used when playing the operator-specific startup tone. |
|
202 * Possible values range from 0 to 10. |
|
203 * If the ringing tone is silent, the tone is not played. |
|
204 */ |
|
205 const TUint32 KStartupOperatorToneVolume = 0x00000011; |
|
206 |
|
207 /** |
|
208 * A string that defines the path and file name of the shutdown animation file. |
|
209 * The shutdown animation is shown during the system shutdown. |
|
210 * The value is optional. If defined, it has to be a file name and a path of a |
|
211 * valid animation file. |
|
212 * The animation file should be stored in a location where system applications |
|
213 * have read access. |
|
214 * Supported formats are SVG-T (.svg, .svgb), MIF (.mif) and GIF (.gif). |
|
215 * Text or embedded images in SVG-T files are not supported. |
|
216 * The length of the shutdown animation should be at most 3 seconds. |
|
217 * Example: "Z:\\resource\\apps\\shutdown.svg" |
|
218 */ |
|
219 const TUint32 KShutdownAnimationPath = 0x00000012; |
|
220 |
|
221 /** |
|
222 * A frame delay value in microseconds for fine-tuning the shutdown animation. |
|
223 * The value is only used if: |
|
224 * a) The shutdown animation file contains an animation format, which does not |
|
225 * contain frame delay information in it (MIF), or |
|
226 * b) The shutdown animation file contains a still image, and no shutdown tone |
|
227 * has been specified, in which case this value defines how long the image |
|
228 * is shown. |
|
229 */ |
|
230 const TUint32 KShutdownAnimationFrameDelay = 0x00000013; |
|
231 |
|
232 /** |
|
233 * Enable/disable scaling of the animation frames. |
|
234 * The value is only used if the animation format supports enabling/disabling |
|
235 * scaling. |
|
236 * One of the values of TStartupAnimationScalingValue enumeration. |
|
237 */ |
|
238 const TUint32 KShutdownAnimationScaling = 0x00000019; |
|
239 |
|
240 /** |
|
241 * A string that defines the path to the shutdown tone MIDI file. |
|
242 * The tone is played at the same time as the shutdown animation is shown. |
|
243 * The value is optional. |
|
244 * The tone file should be stored in a location where system applications have |
|
245 * read access. |
|
246 * The shutdown tone should be at most 3 seconds long. The tone will be played to |
|
247 * the end before continuing the shutdown. |
|
248 * Example: "Z:\\resource\\apps\\shutdown.wav" |
|
249 */ |
|
250 const TUint32 KShutdownTonePath = 0x00000014; |
|
251 |
|
252 /** |
|
253 * The volume level used when playing the shutdown tone. |
|
254 * Possible values range from 0 to 10. |
|
255 * If the ringing tone is silent, the tone is not played. |
|
256 */ |
|
257 const TUint32 KShutdownToneVolume = 0x00000015; |
|
258 |
|
259 /** |
|
260 * Default date & time value to propose to user during first boot. |
|
261 * Format is "YYYYMMDD:HHMMSS". The month and day values are offset from zero. |
|
262 * Example: "20070000:090000" - 01.01.2007 09:00 AM. |
|
263 */ |
|
264 const TUint32 KStartupDefaultTime = 0x00000016; |
|
265 |
|
266 #endif // STARTUPDOMAINCRKEYS_H |
|
267 |
|
268 // End of File |
|
269 |