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: // This file contains the definition of the CImplementationInformation API class. sl@0: // sl@0: // sl@0: sl@0: /** sl@0: @file sl@0: @publishedAll sl@0: @released sl@0: */ sl@0: sl@0: #ifndef __IMPLEMENTATIONINFORMATION_H__ sl@0: #define __IMPLEMENTATIONINFORMATION_H__ sl@0: sl@0: // ____________________________________________________________________________ sl@0: // INCLUDES sl@0: sl@0: #include sl@0: #include sl@0: sl@0: sl@0: // ____________________________________________________________________________ sl@0: // TYPES sl@0: sl@0: /** sl@0: Simplifies the definition of extended interfaces array sl@0: @publishedPartner sl@0: @released sl@0: */ sl@0: // To be used internally by ECOM and by Phone Manufacturers sl@0: typedef RArray RExtendedInterfacesArray; sl@0: sl@0: sl@0: sl@0: // ____________________________________________________________________________ sl@0: // CLASSES sl@0: sl@0: /** sl@0: The CimplementationInformation class acts as the container for the registration sl@0: data relating to a particular interface implementation. sl@0: Note that this class is used in both the ECOM client and server side hence the sl@0: mixed API classification seen below. For the client side only the API used to sl@0: extract the registration data should be used. sl@0: */ sl@0: NONSHARABLE_CLASS(CImplementationInformation) : public CBase sl@0: { sl@0: public: // internalComponent APIs sl@0: // Internal methods used only inside ECOM , not for client use. sl@0: sl@0: static CImplementationInformation* NewLC(TBool aClientSide, sl@0: RReadStream& aStream); sl@0: sl@0: static CImplementationInformation* NewL(TUid aUid, sl@0: TInt aVersion, sl@0: HBufC* aName, sl@0: HBufC8* aDataType, sl@0: HBufC8* aOpaqueData, sl@0: TDriveUnit aDrive, sl@0: TBool aRomOnly, sl@0: TBool aRomBased); sl@0: static CImplementationInformation* NewL(TUid aUid, sl@0: TInt aVersion, sl@0: HBufC* aName, sl@0: HBufC8* aDataType, sl@0: HBufC8* aOpaqueData, sl@0: TDriveUnit aDrive, sl@0: TBool aRomOnly, sl@0: TBool aRomBased, sl@0: RExtendedInterfacesArray* aExtendedInterfaces); sl@0: sl@0: ~CImplementationInformation(); sl@0: sl@0: public: // publishedAll APIs sl@0: // Available for use by all clients sl@0: sl@0: inline const TDesC& DisplayName() const; sl@0: sl@0: inline const TDesC8& DataType() const; sl@0: inline const TDesC8& OpaqueData() const; sl@0: sl@0: inline TUid ImplementationUid() const; sl@0: inline TInt Version() const; sl@0: sl@0: inline TDriveUnit Drive() const; sl@0: sl@0: inline TBool RomOnly() const; sl@0: inline TBool RomBased() const; sl@0: sl@0: inline TVendorId VendorId() const; sl@0: sl@0: inline TBool Disabled() const; sl@0: sl@0: // This function should not be used by any ECOM client as it will have no sl@0: // effect at all on the implementation information stored in the server side sl@0: inline void SetDisabled(TBool aDisabled); sl@0: sl@0: IMPORT_C void GetExtendedInterfaceListL(RExtendedInterfacesArray& aList); sl@0: sl@0: public: // internalComponent APIs sl@0: // Internal methods used inside ECOM, not for client use. sl@0: sl@0: void ExternalizeL(TBool aClientSide,RWriteStream& aStream) const; sl@0: void InternalizeL(TBool aClientSide,RReadStream& aStream); sl@0: sl@0: void SetRomBased(TBool aRomBased); sl@0: void SetDrive(TDriveUnit aDrive); sl@0: sl@0: inline void SetVendorId(const TVendorId aVid); sl@0: sl@0: void AddExtendedInterfaceL(const TUid& aExtendedInterface); sl@0: RExtendedInterfacesArray* GetExtendedInterfaceList(); sl@0: sl@0: private: // internalComponent APIs sl@0: // Internal methods used inside ECOM, not for client use. sl@0: sl@0: CImplementationInformation(); sl@0: sl@0: CImplementationInformation(TUid aUid, sl@0: TInt aVersion, sl@0: HBufC* aName, sl@0: HBufC8* aDataType, sl@0: HBufC8* aOpaqueData, sl@0: TDriveUnit aDrive, sl@0: TBool aRomOnly, sl@0: TBool aRomBased); sl@0: sl@0: CImplementationInformation(TUid aUid, sl@0: TInt aVersion, sl@0: HBufC* aName, sl@0: HBufC8* aDataType, sl@0: HBufC8* aOpaqueData, sl@0: TDriveUnit aDrive, sl@0: TBool aRomOnly, sl@0: TBool aRomBased, sl@0: RExtendedInterfacesArray* aExtendedInterfaces); sl@0: sl@0: private: sl@0: /** The implementation UID */ sl@0: TUid iImplementationUid; sl@0: sl@0: /** The implementation version */ sl@0: TInt iVersion; sl@0: sl@0: /** This implementations human readable name intended for display in sl@0: UI implementations */ sl@0: HBufC* iDisplayName; sl@0: sl@0: /** The type of data this implementation is registered to handle : sl@0: Used for matching against the run-time cue provided by the client sl@0: during default interface implementation resolution. sl@0: */ sl@0: HBufC8* iData; sl@0: sl@0: /** Data registered for this implementation which can be used by the client sl@0: during non-default resolution operations but is ignored by the framework. sl@0: */ sl@0: HBufC8* iOpaqueData; sl@0: sl@0: /** The flag recording if this implementation is disabled or enabled */ sl@0: TBool iDisabled; sl@0: sl@0: /** The drive that this plug-in resides on */ sl@0: TDriveUnit iDrive; sl@0: sl@0: /** The flag recording whether this implementation may only be loaded sl@0: from read-only internal media */ sl@0: TBool iRomOnly; sl@0: sl@0: /** This flag records whether this implementation was discovered on sl@0: read-only internal media or that it is a later version of one that was */ sl@0: TBool iRomBased; sl@0: sl@0: /** The Vendor ID of the plug-in which this implementation belongs to*/ sl@0: TVendorId iVid; sl@0: sl@0: /** Array of extended interfaces.*/ sl@0: RExtendedInterfacesArray* iExtendedInterfaceList; sl@0: sl@0: }; // End CImplementationInformation sl@0: sl@0: sl@0: // ____________________________________________________________________________ sl@0: // TYPES sl@0: sl@0: /** sl@0: Simplifies the definition of functions which return registry information sl@0: */ sl@0: typedef RArray RImplInfoArray; sl@0: sl@0: /** sl@0: Simplifies the definition of functions which return registry information sl@0: */ sl@0: typedef RPointerArray RImplInfoPtrArray; sl@0: sl@0: sl@0: // ____________________________________________________________________________ sl@0: // INLINES sl@0: sl@0: #include sl@0: sl@0: sl@0: #endif // __IMPLEMENTATIONINFORMATION_H__