1 /* |
|
2 * Copyright (c) 2007 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: Central Repository Key defintion for ordering of Location |
|
15 * based Applications and Content/Services in Location Centre. |
|
16 * |
|
17 */ |
|
18 |
|
19 |
|
20 #ifndef LCPRIVATECRKEYS_H_ |
|
21 #define LCPRIVATECRKEYS_H_ |
|
22 |
|
23 // System Includes |
|
24 #include <e32base.h> |
|
25 |
|
26 /** |
|
27 * The category UID for the keys in this header file. |
|
28 * UID of the Location Centre Central Repository Key. This key defines the |
|
29 * position of the Location based Applications and Contents/Services in |
|
30 * Location Centre and the value for Location Centre Server Shutdown timer value. |
|
31 */ |
|
32 const TUid KCRUidLocationCentre = { 0x10283137 }; |
|
33 |
|
34 |
|
35 /** |
|
36 * Enumeration list of values for the @p KCRUidLocationCentreOrder key. |
|
37 * |
|
38 * Location Centre displays the list of Location based Application and |
|
39 * Services/Contents registered with it. Each Location based Application or |
|
40 * Content/Service can be present in either the Top, Middle or Bottom portion of |
|
41 * the list. The exact location and order of display of these Applications |
|
42 * and Services/Contents depends upon whether they are pre-installed in the |
|
43 * phone image or whether they are dynamically installed. Those Applications and |
|
44 * Contents/Services which come with the phone image can occur only in the Top |
|
45 * or Bottom portion of the list while those Applications and Contents/Services |
|
46 * which are dynamically installed are shown in the Middle portion of the list. |
|
47 * |
|
48 * The enumeration @p TLcOrderValues defines the values and format of Top, Middle |
|
49 * and Bottom keys. |
|
50 */ |
|
51 enum TLcOrderValues |
|
52 { |
|
53 /** |
|
54 * Top Key for list of Location based Applications and Contents/Services which |
|
55 * are shown at the top of Location Centre list. |
|
56 * This key is a Read only key and the default values for the Keys is configured |
|
57 * by the device manufacturer while flashing the device. They cannot be dynamically |
|
58 * configured. The keys contains a UNICODE ( UCS -2 ) string which contains a |
|
59 * list of Unique Identifers for Location based Application and Contents/Services |
|
60 * in the order in which the device manufacturer wants these Applications and |
|
61 * Contents/Services to be displayed. |
|
62 * |
|
63 * The format of this Key is defined as |
|
64 * | Count | Length(1) | UID(1) | Length(2) | UID(2) | ... | Length( Count ) | UID( Count ) | |
|
65 * where, |
|
66 * Count - ( 4 bytes ) - The number of Location based Applications or Contents / Services |
|
67 * which are predefined to be displayed at the top of |
|
68 * Location Centre. |
|
69 * Length(n) - ( 4 bytes ) - Length of the UID for the Location based Application or |
|
70 * Content/Service encoded as as a string in the UNICODE ( UCS -2) |
|
71 * format. |
|
72 * String(n) - ( Length(n) * 2 bytes ) - UID of the Location based Application or Content/Service |
|
73 * encoded as a string in the UNICODE ( UCS-2 ) format. Here each character |
|
74 * of the UID takes 2 bytes. Hence, over all the length of the UID string |
|
75 * is 2 * Length(n). |
|
76 */ |
|
77 ELcTop = 0x00000001, |
|
78 |
|
79 /** |
|
80 * Middle Key for list of Location based Applications and Contents/Services which |
|
81 * are shown in the middle of Location Centre list. |
|
82 * |
|
83 * This key takes a Boolean value indicating whether there are any Location based |
|
84 * Applications or Contents/Services which have been dynamically installed or not. |
|
85 * The values which this key can take are |
|
86 * ETrue, If there are certain Location based Applications or Contents/Service |
|
87 * which have been dynamically installed on the terminal. |
|
88 * EFalse, If there are no Location based Applications or Contents/Service |
|
89 * which have been dynamically installed on the terminal. |
|
90 * The default value for this Key is EFalse. |
|
91 * |
|
92 * Incase there are any dynamically installed Applications or Contents/Services then |
|
93 * these components would be displayed in the middle of Location Centre in the order |
|
94 * of their registration. |
|
95 */ |
|
96 ELcMiddle = 0x00000002, |
|
97 |
|
98 /** |
|
99 * Bottom Key for list of Location based Applications and Contents/Services which |
|
100 * are shown at the bottom of Location Centre list. |
|
101 * This key is a Read only key and the default values for the Keys is configured |
|
102 * by the device manufacturer while flashing the device. They cannot be dynamically |
|
103 * configured. The keys contains a UNICODE ( UCS -2 ) string which contains a |
|
104 * list of Unique Identifers for Location based Application and Contents/Services |
|
105 * in the order in which the device manufacturer wants these Applications and |
|
106 * Contents/Services to be displayed. |
|
107 * |
|
108 * The format of this Key is defined as |
|
109 * | Count | Length(1) | UID(1) | Length(2) | UID(2) | ... | Length( Count ) | UID( Count ) | |
|
110 * where, |
|
111 * Count - ( 4 bytes ) - The number of Location based Applications or Contents / Services |
|
112 * which are predefined to be displayed at the bottom of |
|
113 * Location Centre. |
|
114 * Length(n) - ( 4 bytes ) - Length of the UID for the Location based Application or |
|
115 * Content/Service encoded as as a string in the UNICODE ( UCS -2) |
|
116 * format. |
|
117 * String(n) - ( Length(n) * 2 bytes ) - UID of the Location based Application or Content/Service |
|
118 * encoded as a string in the UNICODE ( UCS-2 ) format. Here each character |
|
119 * of the UID takes 2 bytes. Hence, over all the length of the UID string |
|
120 * is 2 * Length(n). |
|
121 */ |
|
122 ELcBottom = 0x00000003 |
|
123 }; |
|
124 |
|
125 /** |
|
126 * Value for Location Centre shutdown timer in milliseconds. |
|
127 */ |
|
128 const TInt KLcShutdownTimerValue = 0x00000004; |
|
129 |
|
130 #endif // LCPRIVATECRKEYS_H_ |
|
131 |
|
132 // End of File |
|