1.1 --- a/epoc32/include/bamdesca.h Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/bamdesca.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,135 @@
1.4 -bamdesca.h
1.5 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.6 +// All rights reserved.
1.7 +// This component and the accompanying materials are made available
1.8 +// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
1.9 +// which accompanies this distribution, and is available
1.10 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.11 +//
1.12 +// Initial Contributors:
1.13 +// Nokia Corporation - initial contribution.
1.14 +//
1.15 +// Contributors:
1.16 +//
1.17 +// Description:
1.18 +// Started by DavidW, March 1996
1.19 +// Mixin descriptor array
1.20 +//
1.21 +//
1.22 +
1.23 +#if !defined(__BAMDESCA_H__)
1.24 +#define __BAMDESCA_H__
1.25 +
1.26 +#if !defined(__E32STD_H__)
1.27 +#include <e32std.h>
1.28 +#endif
1.29 +
1.30 +
1.31 +
1.32 +class MDesC8Array
1.33 +/**
1.34 +Interface class for 8 bit descriptor arrays.
1.35 +It should be inherited by classes which implement this protocol.
1.36 +
1.37 +This protocol is implemented by class CDesC8Array and the concrete class CPtrC8Array.
1.38 +@publishedAll
1.39 +@released
1.40 +*/
1.41 + {
1.42 +public:
1.43 + /** Destructor. */
1.44 + virtual ~MDesC8Array() {}
1.45 + /** Requirements
1.46 +
1.47 + Returns the number of descriptor elements in a descriptor array.
1.48 +
1.49 + @return The number of descriptor elements in a descriptor array. */
1.50 + virtual TInt MdcaCount() const =0;
1.51 +
1.52 + /** Requirements
1.53 +
1.54 + Indexes into a descriptor array.
1.55 +
1.56 + @param aIndex The position of the descriptor element within a descriptor array.
1.57 + The position is relative to zero; i.e. zero implies the first descriptor element
1.58 + in a descriptor array.
1.59 + @return An 8 bit non-modifiable pointer descriptor representing the descriptor
1.60 + element located at position aIndex within a descriptor array. */
1.61 + virtual TPtrC8 MdcaPoint(TInt aIndex) const =0;
1.62 + };
1.63 +
1.64 +
1.65 +class MDesC16Array
1.66 +/**
1.67 +Interface class for 16 bit descriptor arrays. It should be inherited by classes
1.68 +which implement this protocol.
1.69 +This protocol is implemented by class CDesC16Array and the concrete class
1.70 +CPtrC16Array.
1.71 +@publishedAll
1.72 +@released
1.73 +*/
1.74 + {
1.75 +public:
1.76 + /** Destructor. */
1.77 + virtual ~MDesC16Array() {}
1.78 +
1.79 + /** Requirements
1.80 +
1.81 + Returns the number of descriptor elements in a descriptor array.
1.82 +
1.83 + @return The number of descriptor elements in a descriptor array. */
1.84 + virtual TInt MdcaCount() const =0;
1.85 + /** Requirements
1.86 +
1.87 + Indexes into a descriptor array.
1.88 +
1.89 + @param aIndex The position of the descriptor element within a descriptor array.
1.90 + The position is relative to zero; i.e. zero implies the first descriptor element
1.91 + in a descriptor array.
1.92 + @return A 16 bit non-modifiable pointer descriptor representing the descriptor
1.93 + element located at position aIndex within a descriptor array. */
1.94 + virtual TPtrC16 MdcaPoint(TInt aIndex) const =0;
1.95 + };
1.96 +
1.97 +
1.98 +// The definitions below are macros rather than typedefs to avoid generating
1.99 +// warning C4097 every time the generic mixin class is used in a class
1.100 +// definition.
1.101 +
1.102 +#if defined(_UNICODE)
1.103 +/**
1.104 +Build independent interface class for descriptor arrays.
1.105 +
1.106 +A 16 bit build variant is generated for a Unicode build and an 8 bit build
1.107 +variant generated for a non-Unicode build.
1.108 +
1.109 +This build independent type should always be used unless an explicit 8 bit
1.110 +or 16 bit build variant is required.
1.111 +
1.112 +@see MDesC16Array
1.113 +@see MDesC8Array
1.114 +@publishedAll
1.115 +@released
1.116 +*/
1.117 +#define MDesCArray MDesC16Array
1.118 +//typedef MDesC16Array MDesCArray;
1.119 +#else
1.120 +/**
1.121 +Build independent interface class for descriptor arrays.
1.122 +
1.123 +A 16 bit build variant is generated for a Unicode build and an 8 bit build
1.124 +variant generated for a non-Unicode build.
1.125 +
1.126 +This build independent type should always be used unless an explicit 8 bit
1.127 +or 16 bit build variant is required.
1.128 +
1.129 +@see MDesC16Array
1.130 +@see MDesC8Array
1.131 +@publishedAll
1.132 +@released
1.133 +*/
1.134 +#define MDesCArray MDesC8Array
1.135 +//typedef MDesC8Array MDesCArray;
1.136 +#endif
1.137 +
1.138 +
1.139 +#endif // __BAMDESCA_H__