|
1 /* |
|
2 * Copyright (c) 2002 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: Profiles engine private Central Repository keys |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 #ifndef PROFILEENGINEPRIVATECRKEYS_H |
|
21 #define PROFILEENGINEPRIVATECRKEYS_H |
|
22 |
|
23 // INCLUDES |
|
24 #include <e32std.h> |
|
25 #include <ProfileEngineInternalCRKeys.h> |
|
26 #include "ProfileEng.hrh" |
|
27 |
|
28 // CONSTANTS |
|
29 /** |
|
30 * List of IDs used for user-created profiles. Binary. |
|
31 * |
|
32 * Default value is empty (0-length byte array). |
|
33 */ |
|
34 const TUint32 KProEngUsedIds = 0x80000002; |
|
35 |
|
36 /** |
|
37 * If the current active profile is timed, this contains the ID of the previous |
|
38 * active profile (in other words, the profile which should be activated after |
|
39 * timer goes off). Integer. |
|
40 * Default value: -1 |
|
41 */ |
|
42 const TUint32 KProEngPreviousActiveId = 0x80000003; |
|
43 |
|
44 /** |
|
45 * If the current active profile is timed, this contains the scheduler handle |
|
46 * ID for the task for the profile deactivation. Integer. |
|
47 * Default value: -1 |
|
48 */ |
|
49 const TUint32 KProEngSchedulerHandleId = 0x80000004; |
|
50 |
|
51 /** |
|
52 * If the current active profile is timed, this contains the scheduler task |
|
53 * ID for the profile deactivation. Integer. |
|
54 * Default value: -1 |
|
55 */ |
|
56 const TUint32 KProEngSchedulerTaskId = 0x80000005; |
|
57 |
|
58 // |
|
59 // The rest of the constants are used with profile-specific settings. The |
|
60 // actual key for a setting of a profile must be constructed as follows: |
|
61 // |
|
62 // (PROFILE_ID << 32) & SETTING_CONSTANT |
|
63 // |
|
64 |
|
65 /** |
|
66 * Bitmask used to indicate which of the settings in Profiles are allowed to |
|
67 * be modified by the user. Integer. |
|
68 * |
|
69 * Default value: 0x000037FF for General (id == 0) profile |
|
70 * 0x000000EC for Off-line profile |
|
71 * 0x00003FFF for other profiles |
|
72 */ |
|
73 const TUint32 KProEngModifiableFlags = EProfileSettingIdModifiableFlags; |
|
74 |
|
75 /** |
|
76 * Bitmask used to indicate which of the settings in Profiles should be |
|
77 * visible to the user. Integer. |
|
78 * |
|
79 * Default value: 0x000037FF for General (id == 0) profile |
|
80 * 0x000000EC for Off-line profile |
|
81 * 0x00003FFF for other profiles |
|
82 */ |
|
83 const TUint32 KProEngVisibleFlags = EProfileSettingIdVisibleFlags; |
|
84 |
|
85 /** |
|
86 * The user-given name of the profile. String. |
|
87 * |
|
88 * Default value must be empty string. |
|
89 */ |
|
90 const TUint32 KProEngProfileName = EProfileSettingIdProfileName; |
|
91 |
|
92 /** |
|
93 * List of Contact group IDs. Binary. |
|
94 * |
|
95 * Default value must be empty. |
|
96 */ |
|
97 const TUint32 KProEngAlertForGroups = EProfileSettingIdAlertForGroups; |
|
98 |
|
99 /** |
|
100 * The path to the tone file to be used as (line 1) ringing tone. String. |
|
101 * |
|
102 * Default values: |
|
103 * |
|
104 * General (0): "Z:\\Nokia\\Sounds\\Digital\\Nokia Tune.mid" |
|
105 * Silent (1): "Z:\\Nokia\\Sounds\\Digital\\Nokia Tune.mid" |
|
106 * Meeting (2): "Z:\\Nokia\\Sounds\\Digital\\Nokia Tune.mid" |
|
107 * Outdoor (3): "Z:\\Nokia\\Sounds\\Digital\\Nokia Tune.mid" |
|
108 * Pager (4): "Z:\\Nokia\\Sounds\\Digital\\Nokia Tune.mid" |
|
109 * Off-line (5): "Z:\\resource\\No_Sound.wav |
|
110 */ |
|
111 const TUint32 KProEngRingingTone = EProfileSettingIdRingingTone; |
|
112 |
|
113 /** |
|
114 * The path to the tone file to be used as line 2 ringing tone. String. |
|
115 * |
|
116 * Default values: |
|
117 * |
|
118 * General (0): "Z:\\Nokia\\Sounds\\Digital\\Nokia Tune.mid" |
|
119 * Silent (1): "Z:\\Nokia\\Sounds\\Digital\\Nokia Tune.mid" |
|
120 * Meeting (2): "Z:\\Nokia\\Sounds\\Digital\\Nokia Tune.mid" |
|
121 * Outdoor (3): "Z:\\Nokia\\Sounds\\Digital\\Nokia Tune.mid" |
|
122 * Pager (4): "Z:\\Nokia\\Sounds\\Digital\\Nokia Tune.mid" |
|
123 * Off-line (5): "Z:\\resource\\No_Sound.wav |
|
124 */ |
|
125 const TUint32 KProEngRingingTone2 = EProfileSettingIdRingingTone2; |
|
126 |
|
127 /** |
|
128 * The path to the tone file to be used as SMS alert tone. String. |
|
129 * |
|
130 * Default values: |
|
131 * |
|
132 * General (0): "Z:\\Nokia\\Sounds\\Digital\\Message 1.mid" |
|
133 * Silent (1): "Z:\\resource\\No_Sound.wav |
|
134 * Meeting (2): "Z:\\Nokia\\Sounds\\Simple\\Beep twice.rng" |
|
135 * Outdoor (3): "Z:\\Nokia\\Sounds\\Digital\\Message 1.mid" |
|
136 * Pager (4): "Z:\\Nokia\\Sounds\\Digital\\Message 1.mid" |
|
137 * Off-line (5): "Z:\\Nokia\\Sounds\\Digital\\Message 1.mid" |
|
138 */ |
|
139 const TUint32 KProEngMsgTone = EProfileSettingIdMsgTone; |
|
140 |
|
141 /** |
|
142 * Ringing type of the profile. Integer. |
|
143 * |
|
144 * Default values: |
|
145 * |
|
146 * General (0): 0 |
|
147 * Silent (1): 4 |
|
148 * Meeting (2): 3 |
|
149 * Outdoor (3): 0 |
|
150 * Pager (4): 4 |
|
151 * Off-line (5): 0 |
|
152 */ |
|
153 const TUint32 KProEngRingingType = EProfileSettingIdRingingType; |
|
154 |
|
155 /** |
|
156 * Volume of the keypad tones of the profile. Integer. |
|
157 * |
|
158 * Default values: |
|
159 * |
|
160 * General (0): 2 |
|
161 * Silent (1): 0 |
|
162 * Meeting (2): 0 |
|
163 * Outdoor (3): 3 |
|
164 * Pager (4): 2 |
|
165 * Off-line (5): 2 |
|
166 */ |
|
167 const TUint32 KProEngKeypadVolume = EProfileSettingIdKeypadVolume; |
|
168 |
|
169 /** |
|
170 * Volume used when playing an alert tone. Integer (1-10). |
|
171 * |
|
172 * Default values: |
|
173 * |
|
174 * General (0): 7 |
|
175 * Silent (1): 1 |
|
176 * Meeting (2): 1 |
|
177 * Outdoor (3): 10 |
|
178 * Pager (4): 7 |
|
179 * Off-line (5): 7 |
|
180 */ |
|
181 const TUint32 KProEngRingingVolume = EProfileSettingIdRingingVolume; |
|
182 |
|
183 /** |
|
184 * This value indicates whether vibra should be on or off. Integer (0 or 1). |
|
185 * |
|
186 * Default values: |
|
187 * |
|
188 * General (0): 0 |
|
189 * Silent (1): 0 |
|
190 * Meeting (2): 0 |
|
191 * Outdoor (3): 1 |
|
192 * Pager (4): 1 |
|
193 * Off-line (5): 0 |
|
194 */ |
|
195 const TUint32 KProEngVibra = EProfileSettingIdVibra; |
|
196 |
|
197 /** |
|
198 * This value indicates whether Email vibra should be on or off. Integer (0 or 1). |
|
199 * |
|
200 * Default values: |
|
201 * |
|
202 * General (0): 0 |
|
203 * Silent (1): 0 |
|
204 * Meeting (2): 0 |
|
205 * Outdoor (3): 1 |
|
206 * Pager (4): 1 |
|
207 * Off-line (5): 0 |
|
208 */ |
|
209 const TUint32 KProEngEmailVibra = EProfileSettingIdEmailVibra; |
|
210 |
|
211 /** |
|
212 * This value indicates whether warning and game tones should be on or off. |
|
213 * Integer (0 or 1). |
|
214 * |
|
215 * Default values: |
|
216 * |
|
217 * General (0): 1 |
|
218 * Silent (1): 0 |
|
219 * Meeting (2): 0 |
|
220 * Outdoor (3): 1 |
|
221 * Pager (4): 1 |
|
222 * Off-line (5): 1 |
|
223 */ |
|
224 const TUint32 KProEngWarnAndGameTones = EProfileSettingIdWarnAndGameTones; |
|
225 |
|
226 /** |
|
227 * NOTE! This key is not used anymore. |
|
228 * The path to the tone file to be used as IM alert tone. String. |
|
229 * |
|
230 * Default values: |
|
231 * |
|
232 * General (0): "Z:\\Nokia\\Sounds\\Digital\\Chat alert.mid" |
|
233 * Silent (1): "Z:\\resource\\No_Sound.wav |
|
234 * Meeting (2): "Z:\\Nokia\\Sounds\\Simple\\Beep twice.rng" |
|
235 * Outdoor (3): "Z:\\Nokia\\Sounds\\Digital\\Chat alert.mid" |
|
236 * Pager (4): "Z:\\Nokia\\Sounds\\Digital\\Chat alert.mid" |
|
237 * Off-line (5): "Z:\\resource\\No_Sound.wav |
|
238 */ |
|
239 const TUint32 KProEngImTone = EProfileSettingIdImTone; |
|
240 |
|
241 /** |
|
242 * The path to the tone file to be used as E-mail alert tone. String. |
|
243 * |
|
244 * Default values: |
|
245 * |
|
246 * General (0): "Z:\\Nokia\\Sounds\\Digital\\Message 1.mid" |
|
247 * Silent (1): "Z:\\resource\\No_Sound.wav |
|
248 * Meeting (2): "Z:\\Nokia\\Sounds\\Simple\\Beep twice.rng" |
|
249 * Outdoor (3): "Z:\\Nokia\\Sounds\\Digital\\Message 1.mid" |
|
250 * Pager (4): "Z:\\Nokia\\Sounds\\Digital\\Message 1.mid" |
|
251 * Off-line (5): "Z:\\resource\\No_Sound.wav" |
|
252 */ |
|
253 const TUint32 KProEngEmailTone = EProfileSettingIdEmailTone; |
|
254 |
|
255 /** |
|
256 * The path to the tone file to be used as video call ringing tone. String. |
|
257 * |
|
258 * Default values: |
|
259 * |
|
260 * General (0): "Z:\\Nokia\\Sounds\\Digital\\Nokia Tune.mid" |
|
261 * Silent (1): "Z:\\Nokia\\Sounds\\Digital\\Nokia Tune.mid" |
|
262 * Meeting (2): "Z:\\Nokia\\Sounds\\Digital\\Nokia Tune.mid" |
|
263 * Outdoor (3): "Z:\\Nokia\\Sounds\\Digital\\Nokia Tune.mid" |
|
264 * Pager (4): "Z:\\Nokia\\Sounds\\Digital\\Nokia Tune.mid" |
|
265 * Off-line (5): "Z:\\resource\\No_Sound.wav |
|
266 */ |
|
267 const TUint32 KProEngVideoCallTone = EProfileSettingIdVideoCallTone; |
|
268 |
|
269 /** |
|
270 * NOTE! This key is not currently used as there is no Presence Application. |
|
271 * If the status message of Presence is set to depend on Profiles, this value |
|
272 * contains the status message used with the profile. String. |
|
273 * |
|
274 * Default value must be empty. |
|
275 */ |
|
276 const TUint32 KProEngStatusMsg = EProfileSettingIdStatusMsg; |
|
277 |
|
278 /** |
|
279 * NOTE! This key is not currently used as there is no Presence Application. |
|
280 * If the availability attribute of Presence is set to depend on Profiles, this |
|
281 * contains the value of the attribute. Integer. |
|
282 * |
|
283 * Default values: |
|
284 * |
|
285 * General (0): 2 |
|
286 * Silent (1): 1 |
|
287 * Meeting (2): 1 |
|
288 * Outdoor (3): 2 |
|
289 * Pager (4): 1 |
|
290 * Off-line (5): 1 |
|
291 */ |
|
292 const TUint32 KProEngAvailAttribute = EProfileSettingIdAvailAttribute; |
|
293 |
|
294 /** |
|
295 * NOTE! This key is not used anymore. |
|
296 * Volume setting used by different media playing applications. Integer. |
|
297 * |
|
298 * Default values: |
|
299 * |
|
300 * General (0): 7 |
|
301 * Silent (1): 1 |
|
302 * Meeting (2): 1 |
|
303 * Outdoor (3): 10 |
|
304 * Pager (4): 7 |
|
305 * Off-line (5): 7 |
|
306 */ |
|
307 const TUint32 KProEngMediaVolume = EProfileSettingIdMediaVolume; |
|
308 |
|
309 /** |
|
310 * This integer key indicates whether text-to-speech ringing tone is on (1) |
|
311 * or off (0). |
|
312 * |
|
313 * Default value: 0 for all profiles |
|
314 */ |
|
315 const TUint32 KProEngTextToSpeechTone = EProfileSettingIdTextToSpeechTone; |
|
316 |
|
317 /** |
|
318 * This integer key indicates if the user has changed the name of the profile. |
|
319 * This information is needed by Profiles Engine to decide whether the name |
|
320 * should be localised or not. |
|
321 * |
|
322 * Not changed: 0 |
|
323 * Changed: 1 |
|
324 * |
|
325 * Default value: 0 |
|
326 */ |
|
327 const TUint32 KProEngNameChanged = EProfileSettingIdNameChanged; |
|
328 |
|
329 /** |
|
330 * NOTE! This key is not used anymore. |
|
331 * This String key contains either the text of the call object if the selected |
|
332 * type is Text (= 2) or the path to the image file if the type is Image (= 3). |
|
333 * |
|
334 * Default value: empty string |
|
335 */ |
|
336 const TUint32 KProEngCallObjectContent = EProfileSettingIdCallObjectContent; |
|
337 |
|
338 /** |
|
339 * Contains the Push to talk ringing tone used with the profile. String. |
|
340 * |
|
341 * Default values: |
|
342 * |
|
343 * General (0): "Z:\\Nokia\\Sounds\\Digital\\Nokia Tune.mid" |
|
344 * Silent (1): "Z:\\Nokia\\Sounds\\Digital\\Nokia Tune.mid" |
|
345 * Meeting (2): "Z:\\Nokia\\Sounds\\Digital\\Nokia Tune.mid" |
|
346 * Outdoor (3): "Z:\\Nokia\\Sounds\\Digital\\Nokia Tune.mid" |
|
347 * Pager (4): "Z:\\Nokia\\Sounds\\Digital\\Nokia Tune.mid" |
|
348 * Off-line (5): "Z:\\resource\\No_Sound.wav |
|
349 */ |
|
350 const TUint32 KProEngPttTone = EProfileSettingIdPttTone; |
|
351 |
|
352 /** |
|
353 * Contains the push to talk status value of this profile. Integer. |
|
354 * |
|
355 * Possible values: |
|
356 * |
|
357 * 0 (EProfilePttActive) |
|
358 * 1 (EProfilePttSilent) |
|
359 * 2 (EProfilePttDoNotDisturb) |
|
360 * |
|
361 * Default value: 1 for all profiles |
|
362 * |
|
363 */ |
|
364 const TUint32 KProEngPttStatus = EProfileSettingIdPttStatus; |
|
365 |
|
366 /** |
|
367 * Contains the 3D effect value of this profile. Integer. |
|
368 * |
|
369 * Possible values: |
|
370 * |
|
371 * 0 (EProfile3DEffectOff) |
|
372 * 1 (EProfile3DEffectCircle) |
|
373 * 2 (EProfile3DEffectFlyby) |
|
374 * 3 (EProfile3DEffectZigZag) |
|
375 * 4 (EProfile3DEffectRandomWalk) |
|
376 * 5 (EProfile3DEffectChaos) |
|
377 * 6 (EProfile3DEffectStereoWidening) |
|
378 * |
|
379 * Default value: 0 for all profiles |
|
380 * |
|
381 */ |
|
382 const TUint32 KProEng3DToneEffect = EProfileSettingId3DEffect; |
|
383 |
|
384 /** |
|
385 * Contains the 3D echo value of this profile. Integer. |
|
386 * |
|
387 * Possible values: |
|
388 * |
|
389 * 0 (EProfile3DEchoOff) |
|
390 * 1 (EProfile3DEchoLivingRoom) |
|
391 * 2 (EProfile3DEchoCave) |
|
392 * 3 (EProfile3DEchoStoneCorridor) |
|
393 * 4 (EProfile3DEchoForest) |
|
394 * 5 (EProfile3DEchoSewerPipe) |
|
395 * |
|
396 * Default value: 0 for all profiles |
|
397 * |
|
398 */ |
|
399 const TUint32 KProEng3DToneEcho = EProfileSettingId3DEcho; |
|
400 |
|
401 /** |
|
402 * Contains the tactile feedback value of this profile. Integer. |
|
403 * |
|
404 * Possible values: |
|
405 * |
|
406 * 0 (EProfileTactileFeedbackOff) |
|
407 * 1 (EProfileTactileFeedbackLevel1) |
|
408 * 2 (EProfileTactileFeedbackLevel2) |
|
409 * 3 (EProfileTactileFeedbackLevel3) |
|
410 * |
|
411 * Default value: 0 for Silent and Public/Drive, 1 for all others |
|
412 * |
|
413 */ |
|
414 const TUint32 KProEngTactileFeedback = EProfileSettingIdTactileFeedback; |
|
415 |
|
416 /** |
|
417 * Contains the audio feedback value of this profile. Integer. |
|
418 * |
|
419 * Possible values: |
|
420 * |
|
421 * 0 (EProfileAudioFeedbackOff) |
|
422 * 1 (EProfileAudioFeedbackLevel1) |
|
423 * 2 (EProfileAudioFeedbackLevel2) |
|
424 * 3 (EProfileAudioFeedbackLevel3) |
|
425 * |
|
426 * Default value: 0 for all profiles |
|
427 * |
|
428 */ |
|
429 const TUint32 KProEngAudioFeedback = EProfileSettingIdAudioFeedback; |
|
430 |
|
431 |
|
432 /** |
|
433 * The id used for storing the default settings for user created profiles. |
|
434 */ |
|
435 const TInt KProEngDefaultProfileId = 0x007F; |
|
436 |
|
437 #endif // PROFILEENGINEPRIVATECRKEYS_H |
|
438 |
|
439 // End of File |