|
67
|
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: Access interface to list-specific localization data.
|
|
|
15 |
*
|
|
|
16 |
*/
|
|
|
17 |
|
|
|
18 |
#ifndef MPIMLOCALIZATIONDATA_H
|
|
|
19 |
#define MPIMLOCALIZATIONDATA_H
|
|
|
20 |
|
|
|
21 |
// INCLUDES
|
|
|
22 |
#include "pimtypes.h"
|
|
|
23 |
|
|
|
24 |
// CLASS DECLARATION
|
|
|
25 |
|
|
|
26 |
/**
|
|
|
27 |
* Provides localized strings for the various labels used in the PIM API
|
|
|
28 |
*/
|
|
|
29 |
class MPIMLocalizationData
|
|
|
30 |
{
|
|
|
31 |
public: // destructor
|
|
|
32 |
/**
|
|
|
33 |
* Destructor is public virtual in order to allow deletion through
|
|
|
34 |
* M-class
|
|
|
35 |
*/
|
|
|
36 |
virtual ~MPIMLocalizationData() { }
|
|
|
37 |
|
|
|
38 |
public: // New functions
|
|
|
39 |
|
|
|
40 |
/**
|
|
|
41 |
* Provides a string label associated with the given field. The caller
|
|
|
42 |
* takes ownership of the returned object.
|
|
|
43 |
*
|
|
|
44 |
* @param aField The field for which the label is being queried.
|
|
|
45 |
*
|
|
|
46 |
* @return String label for the field. The label is locale specific.
|
|
|
47 |
*/
|
|
|
48 |
virtual HBufC* GetFieldLabelL(TPIMField aField) = 0;
|
|
|
49 |
|
|
|
50 |
/**
|
|
|
51 |
* Provides a string label associated with the given attribute.
|
|
|
52 |
* The caller takes ownership of the returned object.
|
|
|
53 |
*
|
|
|
54 |
* @param aAttribute The attribute for which the label is being queried.
|
|
|
55 |
*
|
|
|
56 |
* @return String label for the attribute. The label is locale specific.
|
|
|
57 |
*/
|
|
|
58 |
virtual HBufC* GetAttributeLabelL(TPIMAttribute aAttribute) = 0;
|
|
|
59 |
|
|
|
60 |
/**
|
|
|
61 |
* Provides a string label associated with the given array element.
|
|
|
62 |
* The caller takes ownership of the returned object.
|
|
|
63 |
*
|
|
|
64 |
* @param aStringArrayField The field which has a EPIMFieldStringArray
|
|
|
65 |
* data type.
|
|
|
66 |
* @param aArrayElement The element in the array.
|
|
|
67 |
*
|
|
|
68 |
* @return String label for the array element
|
|
|
69 |
*/
|
|
|
70 |
virtual HBufC* GetArrayElementLabelL(TPIMField aStringArrayField,
|
|
|
71 |
TPIMArrayElement aArrayElement) = 0;
|
|
|
72 |
/**
|
|
|
73 |
* Provides the name of the list.
|
|
|
74 |
* The caller takes ownership of the returned object.
|
|
|
75 |
*
|
|
|
76 |
* @return the list name.
|
|
|
77 |
*/
|
|
|
78 |
virtual HBufC* GetListNameL() = 0;
|
|
|
79 |
|
|
|
80 |
};
|
|
|
81 |
|
|
|
82 |
|
|
|
83 |
|
|
|
84 |
#endif // MPIMLOCALIZATIONDATA_H
|