1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
2 // All rights reserved.
3 // This component and the accompanying materials are made available
4 // under the terms of "Eclipse Public License v1.0"
5 // which accompanies this distribution, and is available
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
8 // Initial Contributors:
9 // Nokia Corporation - initial contribution.
14 // Started by DavidW, March 1996
15 // Mixin descriptor array
19 #if !defined(__BAMDESCA_H__)
20 #define __BAMDESCA_H__
22 #if !defined(__E32STD_H__)
30 Interface class for 8 bit descriptor arrays.
31 It should be inherited by classes which implement this protocol.
33 This protocol is implemented by class CDesC8Array and the concrete class CPtrC8Array.
40 virtual ~MDesC8Array() {}
43 Returns the number of descriptor elements in a descriptor array.
45 @return The number of descriptor elements in a descriptor array. */
46 virtual TInt MdcaCount() const =0;
50 Indexes into a descriptor array.
52 @param aIndex The position of the descriptor element within a descriptor array.
53 The position is relative to zero; i.e. zero implies the first descriptor element
54 in a descriptor array.
55 @return An 8 bit non-modifiable pointer descriptor representing the descriptor
56 element located at position aIndex within a descriptor array. */
57 virtual TPtrC8 MdcaPoint(TInt aIndex) const =0;
63 Interface class for 16 bit descriptor arrays. It should be inherited by classes
64 which implement this protocol.
65 This protocol is implemented by class CDesC16Array and the concrete class
73 virtual ~MDesC16Array() {}
77 Returns the number of descriptor elements in a descriptor array.
79 @return The number of descriptor elements in a descriptor array. */
80 virtual TInt MdcaCount() const =0;
83 Indexes into a descriptor array.
85 @param aIndex The position of the descriptor element within a descriptor array.
86 The position is relative to zero; i.e. zero implies the first descriptor element
87 in a descriptor array.
88 @return A 16 bit non-modifiable pointer descriptor representing the descriptor
89 element located at position aIndex within a descriptor array. */
90 virtual TPtrC16 MdcaPoint(TInt aIndex) const =0;
94 // The definitions below are macros rather than typedefs to avoid generating
95 // warning C4097 every time the generic mixin class is used in a class
100 Build independent interface class for descriptor arrays.
102 A 16 bit build variant is generated for a Unicode build and an 8 bit build
103 variant generated for a non-Unicode build.
105 This build independent type should always be used unless an explicit 8 bit
106 or 16 bit build variant is required.
113 #define MDesCArray MDesC16Array
114 //typedef MDesC16Array MDesCArray;
117 Build independent interface class for descriptor arrays.
119 A 16 bit build variant is generated for a Unicode build and an 8 bit build
120 variant generated for a non-Unicode build.
122 This build independent type should always be used unless an explicit 8 bit
123 or 16 bit build variant is required.
130 #define MDesCArray MDesC8Array
131 //typedef MDesC8Array MDesCArray;
135 #endif // __BAMDESCA_H__