|
1 /* |
|
2 * Copyright (c) 2004 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: Localization data identifiers. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 #ifndef PIMLOCALIZATIONIDS_H |
|
21 #define PIMLOCALIZATIONIDS_H |
|
22 |
|
23 // INCLUDE FILES |
|
24 #include "pimtypes.h" |
|
25 |
|
26 /** |
|
27 * @file |
|
28 * This file contains constants that map the lists provided by adapters |
|
29 * with label sets provided with the localization module. A constant may |
|
30 * apply to one or several related lists. |
|
31 * |
|
32 * There are two types of IDs: |
|
33 * @li Localization IDs |
|
34 * @li List name IDs |
|
35 * Both of them are of type TPIMLocalizationDataID. |
|
36 * |
|
37 * Localization IDs define a set of localized labels for fields, attributes |
|
38 * and array elements and a default name for the list. |
|
39 * |
|
40 * List name IDs specify a name among a set of localized labels defined by |
|
41 * a localization ID. The default list name can be thus overridden using |
|
42 * a list name ID. A localization set may or may not define several list name |
|
43 * IDs. If only single name is defined for a localization set, it may not be |
|
44 * documented but it can be used using the localization operations that rely |
|
45 * on the default list name id. |
|
46 * |
|
47 * Naming: |
|
48 * @li Localization IDs are of form \c KPIMLocalizationIDXXX. |
|
49 * @li List name IDs are of form \c KPIMListNameIdYYY. |
|
50 */ |
|
51 |
|
52 // CONSTANTS |
|
53 |
|
54 |
|
55 // Localization data IDs |
|
56 |
|
57 /** |
|
58 * Localization data identifier for Contacts Model contact list. The labels |
|
59 * associated with this identifier apply only on that list. |
|
60 */ |
|
61 const TPIMLocalizationDataID KPIMLocalizationIdContacts = 1; |
|
62 |
|
63 /** |
|
64 * Localization data identifier for SIM contact list. The labels associated |
|
65 * with this identifier apply only on that list. |
|
66 * |
|
67 * NOTE: Currently unused, defined for future purposes. |
|
68 */ |
|
69 const TPIMLocalizationDataID KPIMLocalizationIdSIM = 2; |
|
70 |
|
71 /** |
|
72 * Localization data identifier for all Agenda Event lists (Meeting, Memo and |
|
73 * Anniversary). The labels are valid for any of those lists. Each of the lists |
|
74 * uses only a subset of the labels associated with this identifier. |
|
75 */ |
|
76 const TPIMLocalizationDataID KPIMLocalizationIdEvent = 3; |
|
77 |
|
78 /** |
|
79 * Localization data identifier for Agenda to-do list. The labels associated |
|
80 * with this identifier apply only on that list. |
|
81 */ |
|
82 const TPIMLocalizationDataID KPIMLocalizationIdToDo = 4; |
|
83 |
|
84 |
|
85 // List name IDs |
|
86 // NOTE! It is essential that these IDs are sequential and start from zero. |
|
87 |
|
88 /** |
|
89 * List name identifier for "Appointment" Agenda Event list. |
|
90 * Applies with the localization data identifier \c KPIMLocalizationIdEvent. |
|
91 */ |
|
92 const TPIMLocalizationDataID KPIMListNameIdAppointment = 0; |
|
93 |
|
94 /** |
|
95 * List name identifier for "Event" Agenda Event list. |
|
96 * Applies with the localization data identifier \c KPIMLocalizationIdEvent. |
|
97 */ |
|
98 const TPIMLocalizationDataID KPIMListNameIdEvent = 1; |
|
99 |
|
100 /** |
|
101 * List name identifier for "Anniversary" Agenda Event list. |
|
102 * Applies with the localization data identifier \c KPIMLocalizationIdEvent. |
|
103 */ |
|
104 const TPIMLocalizationDataID KPIMListNameIdAnniversary = 2; |
|
105 |
|
106 |
|
107 #endif // PIMLOCALIZATIONIDS_H |
|
108 |
|
109 |
|
110 // End of File |