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: //
sl@0: 
sl@0: #if !defined (__APMSTD_H__)
sl@0: #define __APMSTD_H__
sl@0: 
sl@0: #if !defined(__E32STD_H__)
sl@0: #include <e32std.h>
sl@0: #endif
sl@0: 
sl@0: /**
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: const TInt KMaxDataTypeLength=256;
sl@0: 
sl@0: // classes referenced
sl@0: class RReadStream;
sl@0: class RWriteStream;
sl@0: 
sl@0: /** Defines the priority associated with a data type.
sl@0: 
sl@0: The priority is used by a device to resolve the current preferred handler 
sl@0: of a data type, in the absence of any user preferences.
sl@0: 
sl@0: @publishedAll
sl@0: @released
sl@0: @see TDataTypeWithPriority */
sl@0: typedef TInt32 TDataTypePriority;
sl@0: 
sl@0: /** Reserved for future use. 
sl@0: 
sl@0: @publishedAll
sl@0: @released */
sl@0: const TInt32 KDataTypePriorityUserSpecified=KMaxTInt16;
sl@0: 
sl@0: #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
sl@0: /** This is a special priority that overrides any user settings. Applications must
sl@0: have EWriteDeviceData to use this priority. If they have not then they will be
sl@0: downgraded to KDataTypePriorityNormal.
sl@0: 
sl@0: @publishedPartner
sl@0: @released
sl@0: @see TDataTypeWithPriority */
sl@0: const TInt32 KDataTypePrioritySystem = 0xFFF9;
sl@0: 
sl@0: #endif //SYMBIAN_ENABLE_SPLIT_HEADERS
sl@0: 
sl@0: /** Trusted applications may use this priority value to ensure 
sl@0:     their MIME type associations cannot be overridden by 
sl@0:     self signed (untrusted) applications.
sl@0: 
sl@0: @publishedAll
sl@0: @released
sl@0: @see TDataTypeWithPriority */
sl@0: const TInt32 KDataTypePriorityTrustedHigh = 0xC000;
sl@0: 
sl@0: /** This is Threshold priority for Un-Trusted apps i.e., for the applications which reside 
sl@0: in \\private\\10003a3f\\import\\apps and have a SID which is in the unprotected range. This is to avoid Un-Trusted app's claiming for priority higher 
sl@0: than the threshold, if they claim for priority higher than the Threshold then it would be 
sl@0: reduced to KDataTypeUnTrustedPriorityThreshold.
sl@0: 
sl@0: @publishedAll
sl@0: @released */
sl@0: const TInt32 KDataTypeUnTrustedPriorityThreshold=KMaxTInt16;
sl@0: 
sl@0: /** A priority value associated with a data (MIME) type. Associating an application 
sl@0: with a data type at this priority means that this application, and no other, 
sl@0: should ever handle the data type. Use sparingly.
sl@0: 
sl@0: @publishedAll
sl@0: @released
sl@0: @see TDataTypeWithPriority */
sl@0: const TInt32 KDataTypePriorityHigh=10000;
sl@0: 
sl@0: /** A priority value associated with a data (MIME) type. Associating an application 
sl@0: with a data type at this priority means that the data type is the primary 
sl@0: type for that application. For example, "text/plain" files for a text editor.
sl@0: 
sl@0: @publishedAll
sl@0: @released
sl@0: @see TDataTypeWithPriority */
sl@0: const TInt32 KDataTypePriorityNormal=0;
sl@0: 
sl@0: /** A priority value associated with a data (MIME) type. Associating an application 
sl@0: with a data type at this priority means that the data type is a secondary 
sl@0: type for that application. For example, "text/plain" files for a web browser.
sl@0: 
sl@0: @publishedAll
sl@0: @released
sl@0: @see TDataTypeWithPriority */
sl@0: const TInt32 KDataTypePriorityLow=-10000;
sl@0: 
sl@0: /** A priority value associated with a data (MIME) type. Associating an application 
sl@0: with a data type at this priority means that the data type is a last resort 
sl@0: for that application. Use sparingly.
sl@0: 
sl@0: @publishedAll
sl@0: @released
sl@0: @see TDataTypeWithPriority */
sl@0: const TInt32 KDataTypePriorityLastResort=-20000;
sl@0: 
sl@0: /** Reserved for future use. 
sl@0: 
sl@0: @publishedAll
sl@0: @released */
sl@0: const TInt32 KDataTypePriorityNotSupported=KMinTInt16;
sl@0: 
sl@0: 
sl@0: class TDataType
sl@0: /** A data type.
sl@0: 
sl@0: The class maintains a string that describes the data type and an associated 
sl@0: UID.
sl@0: 
sl@0: A data type is also referred to as a MIME type. 
sl@0: 
sl@0: @publishedAll
sl@0: @released */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C TDataType();
sl@0: 	IMPORT_C TDataType(const TDataType& aDataType);
sl@0: 	IMPORT_C TDataType(const TDesC8& aDataType);
sl@0: 	IMPORT_C TDataType(TUid aUid);
sl@0: 	// enquiry
sl@0: 	IMPORT_C TInt operator==(const TDataType& aDataType) const;
sl@0: 	IMPORT_C TInt operator!=(const TDataType& aDataType) const;
sl@0: 	IMPORT_C TBool IsNative() const;
sl@0: 	// 
sl@0: 	IMPORT_C TBuf<KMaxDataTypeLength> Des() const;
sl@0: 	IMPORT_C TPtrC8 Des8() const;
sl@0: 	IMPORT_C TUid Uid() const;
sl@0: 	//
sl@0: 	IMPORT_C void InternalizeL(RReadStream& aReadStream);
sl@0: 	IMPORT_C void ExternalizeL(RWriteStream& aWriteStream) const;
sl@0: private:
sl@0: 	void ParseDes();
sl@0: private:
sl@0: 	TBuf8<KMaxDataTypeLength> iDataType;
sl@0: 	TUid iUid;
sl@0: 	};
sl@0: #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: #define KApaAppTypeDes _L8("x-epoc/x-app")
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: _LIT8(KEpocUrlDataTypeHeader, "X-Epoc-Url/");
sl@0: 
sl@0: #endif //SYMBIAN_ENABLE_SPLIT_HEADERS
sl@0: 
sl@0: class TDataTypeWithPriority
sl@0: /** A data (MIME) type and a priority value for that data type.
sl@0: 
sl@0: The priority is used to resolve the current preferred handler of a data type, 
sl@0: in the absence of any user preferences. An AIF file can associate an application 
sl@0: with a data (MIME) type that is not native to Symbian OS. A priority value 
sl@0: can be specified that allows the device to choose the highest priority application 
sl@0: that can handle that data type.
sl@0: 
sl@0: @publishedAll 
sl@0: @released 
sl@0: @see TDataType
sl@0: @see TDataTypePriority */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C TDataTypeWithPriority();
sl@0: 	IMPORT_C TDataTypeWithPriority(const TDataType& aDataType, TDataTypePriority aPriority);
sl@0: 	//
sl@0: 	IMPORT_C void InternalizeL(RReadStream& aReadStream);
sl@0: 	IMPORT_C void ExternalizeL(RWriteStream& aWriteStream) const;
sl@0: public:
sl@0: 	/** The data type. */
sl@0: 	TDataType iDataType;
sl@0: 	/** The priority value. */
sl@0: 	TDataTypePriority iPriority;
sl@0: 	};
sl@0: 
sl@0: #endif