sl@0: // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // Started by DavidW, March 1996
sl@0: // Mixin descriptor array
sl@0: // 
sl@0: //
sl@0: 
sl@0: #if !defined(__BAMDESCA_H__)
sl@0: #define __BAMDESCA_H__
sl@0: 
sl@0: #if !defined(__E32STD_H__)
sl@0: #include <e32std.h>
sl@0: #endif
sl@0: 
sl@0: 
sl@0: 
sl@0: class MDesC8Array
sl@0: /** 
sl@0: Interface class for 8 bit descriptor arrays. 
sl@0: It should be inherited by classes which implement this protocol.
sl@0: 
sl@0: This protocol is implemented by class CDesC8Array and the concrete class CPtrC8Array. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0:     {
sl@0: public:
sl@0: 	/** Destructor. */
sl@0:     virtual ~MDesC8Array() {}
sl@0: 	/** Requirements
sl@0: 	
sl@0: 	Returns the number of descriptor elements in a descriptor array.
sl@0: 	
sl@0: 	@return The number of descriptor elements in a descriptor array. */
sl@0:     virtual TInt MdcaCount() const =0;
sl@0: 
sl@0: 	/** Requirements
sl@0: 	
sl@0: 	Indexes into a descriptor array.
sl@0: 	
sl@0: 	@param aIndex The position of the descriptor element within a descriptor array. 
sl@0: 	The position is relative to zero; i.e. zero implies the first descriptor element 
sl@0: 	in a descriptor array. 
sl@0: 	@return An 8 bit non-modifiable pointer descriptor representing the descriptor 
sl@0: 	element located at position aIndex within a descriptor array. */
sl@0:     virtual TPtrC8 MdcaPoint(TInt aIndex) const =0;
sl@0:     };
sl@0: 
sl@0: 
sl@0: class MDesC16Array
sl@0: /**
sl@0: Interface class for 16 bit descriptor arrays. It should be inherited by classes 
sl@0: which implement this protocol.
sl@0: This protocol is implemented by class CDesC16Array and the concrete class 
sl@0: CPtrC16Array. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0:     {
sl@0: public:
sl@0: 	/** Destructor. */
sl@0:     virtual ~MDesC16Array() {}
sl@0: 
sl@0: 	/** Requirements
sl@0: 	
sl@0: 	Returns the number of descriptor elements in a descriptor array.
sl@0: 	
sl@0: 	@return The number of descriptor elements in a descriptor array. */
sl@0:     virtual TInt MdcaCount() const =0;
sl@0: 	/** Requirements
sl@0: 	
sl@0: 	Indexes into a descriptor array.
sl@0: 	
sl@0: 	@param aIndex The position of the descriptor element within a descriptor array. 
sl@0: 	The position is relative to zero; i.e. zero implies the first descriptor element 
sl@0: 	in a descriptor array. 
sl@0: 	@return A 16 bit non-modifiable pointer descriptor representing the descriptor 
sl@0: 	element located at position aIndex within a descriptor array. */
sl@0:     virtual TPtrC16 MdcaPoint(TInt aIndex) const =0;
sl@0:     };
sl@0: 
sl@0: 
sl@0: // The definitions below are macros rather than typedefs to avoid generating
sl@0: // warning C4097 every time the generic mixin class is used in a class
sl@0: // definition.
sl@0: 
sl@0: #if defined(_UNICODE)
sl@0: /** 
sl@0: Build independent interface class for descriptor arrays.
sl@0: 
sl@0: A 16 bit build variant is generated for a Unicode build and an 8 bit build 
sl@0: variant generated for a non-Unicode build.
sl@0: 
sl@0: This build independent type should always be used unless an explicit 8 bit 
sl@0: or 16 bit build variant is required.
sl@0: 
sl@0: @see MDesC16Array
sl@0: @see MDesC8Array 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: #define MDesCArray MDesC16Array
sl@0: //typedef MDesC16Array MDesCArray;
sl@0: #else
sl@0: /** 
sl@0: Build independent interface class for descriptor arrays.
sl@0: 
sl@0: A 16 bit build variant is generated for a Unicode build and an 8 bit build 
sl@0: variant generated for a non-Unicode build.
sl@0: 
sl@0: This build independent type should always be used unless an explicit 8 bit 
sl@0: or 16 bit build variant is required.
sl@0: 
sl@0: @see MDesC16Array
sl@0: @see MDesC8Array
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: #define MDesCArray MDesC8Array
sl@0: //typedef MDesC8Array  MDesCArray;
sl@0: #endif
sl@0: 
sl@0: 
sl@0: #endif // __BAMDESCA_H__
sl@0: