1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/genericservices/mimerecognitionfw/inc/APMSTD.H Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,195 @@
1.4 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +#if !defined (__APMSTD_H__)
1.20 +#define __APMSTD_H__
1.21 +
1.22 +#if !defined(__E32STD_H__)
1.23 +#include <e32std.h>
1.24 +#endif
1.25 +
1.26 +/**
1.27 +@publishedAll
1.28 +@released
1.29 +*/
1.30 +const TInt KMaxDataTypeLength=256;
1.31 +
1.32 +// classes referenced
1.33 +class RReadStream;
1.34 +class RWriteStream;
1.35 +
1.36 +/** Defines the priority associated with a data type.
1.37 +
1.38 +The priority is used by a device to resolve the current preferred handler
1.39 +of a data type, in the absence of any user preferences.
1.40 +
1.41 +@publishedAll
1.42 +@released
1.43 +@see TDataTypeWithPriority */
1.44 +typedef TInt32 TDataTypePriority;
1.45 +
1.46 +/** Reserved for future use.
1.47 +
1.48 +@publishedAll
1.49 +@released */
1.50 +const TInt32 KDataTypePriorityUserSpecified=KMaxTInt16;
1.51 +
1.52 +#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
1.53 +/** This is a special priority that overrides any user settings. Applications must
1.54 +have EWriteDeviceData to use this priority. If they have not then they will be
1.55 +downgraded to KDataTypePriorityNormal.
1.56 +
1.57 +@publishedPartner
1.58 +@released
1.59 +@see TDataTypeWithPriority */
1.60 +const TInt32 KDataTypePrioritySystem = 0xFFF9;
1.61 +
1.62 +#endif //SYMBIAN_ENABLE_SPLIT_HEADERS
1.63 +
1.64 +/** Trusted applications may use this priority value to ensure
1.65 + their MIME type associations cannot be overridden by
1.66 + self signed (untrusted) applications.
1.67 +
1.68 +@publishedAll
1.69 +@released
1.70 +@see TDataTypeWithPriority */
1.71 +const TInt32 KDataTypePriorityTrustedHigh = 0xC000;
1.72 +
1.73 +/** This is Threshold priority for Un-Trusted apps i.e., for the applications which reside
1.74 +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
1.75 +than the threshold, if they claim for priority higher than the Threshold then it would be
1.76 +reduced to KDataTypeUnTrustedPriorityThreshold.
1.77 +
1.78 +@publishedAll
1.79 +@released */
1.80 +const TInt32 KDataTypeUnTrustedPriorityThreshold=KMaxTInt16;
1.81 +
1.82 +/** A priority value associated with a data (MIME) type. Associating an application
1.83 +with a data type at this priority means that this application, and no other,
1.84 +should ever handle the data type. Use sparingly.
1.85 +
1.86 +@publishedAll
1.87 +@released
1.88 +@see TDataTypeWithPriority */
1.89 +const TInt32 KDataTypePriorityHigh=10000;
1.90 +
1.91 +/** A priority value associated with a data (MIME) type. Associating an application
1.92 +with a data type at this priority means that the data type is the primary
1.93 +type for that application. For example, "text/plain" files for a text editor.
1.94 +
1.95 +@publishedAll
1.96 +@released
1.97 +@see TDataTypeWithPriority */
1.98 +const TInt32 KDataTypePriorityNormal=0;
1.99 +
1.100 +/** A priority value associated with a data (MIME) type. Associating an application
1.101 +with a data type at this priority means that the data type is a secondary
1.102 +type for that application. For example, "text/plain" files for a web browser.
1.103 +
1.104 +@publishedAll
1.105 +@released
1.106 +@see TDataTypeWithPriority */
1.107 +const TInt32 KDataTypePriorityLow=-10000;
1.108 +
1.109 +/** A priority value associated with a data (MIME) type. Associating an application
1.110 +with a data type at this priority means that the data type is a last resort
1.111 +for that application. Use sparingly.
1.112 +
1.113 +@publishedAll
1.114 +@released
1.115 +@see TDataTypeWithPriority */
1.116 +const TInt32 KDataTypePriorityLastResort=-20000;
1.117 +
1.118 +/** Reserved for future use.
1.119 +
1.120 +@publishedAll
1.121 +@released */
1.122 +const TInt32 KDataTypePriorityNotSupported=KMinTInt16;
1.123 +
1.124 +
1.125 +class TDataType
1.126 +/** A data type.
1.127 +
1.128 +The class maintains a string that describes the data type and an associated
1.129 +UID.
1.130 +
1.131 +A data type is also referred to as a MIME type.
1.132 +
1.133 +@publishedAll
1.134 +@released */
1.135 + {
1.136 +public:
1.137 + IMPORT_C TDataType();
1.138 + IMPORT_C TDataType(const TDataType& aDataType);
1.139 + IMPORT_C TDataType(const TDesC8& aDataType);
1.140 + IMPORT_C TDataType(TUid aUid);
1.141 + // enquiry
1.142 + IMPORT_C TInt operator==(const TDataType& aDataType) const;
1.143 + IMPORT_C TInt operator!=(const TDataType& aDataType) const;
1.144 + IMPORT_C TBool IsNative() const;
1.145 + //
1.146 + IMPORT_C TBuf<KMaxDataTypeLength> Des() const;
1.147 + IMPORT_C TPtrC8 Des8() const;
1.148 + IMPORT_C TUid Uid() const;
1.149 + //
1.150 + IMPORT_C void InternalizeL(RReadStream& aReadStream);
1.151 + IMPORT_C void ExternalizeL(RWriteStream& aWriteStream) const;
1.152 +private:
1.153 + void ParseDes();
1.154 +private:
1.155 + TBuf8<KMaxDataTypeLength> iDataType;
1.156 + TUid iUid;
1.157 + };
1.158 +#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
1.159 +/**
1.160 +@internalComponent
1.161 +*/
1.162 +#define KApaAppTypeDes _L8("x-epoc/x-app")
1.163 +
1.164 +/**
1.165 +@internalComponent
1.166 +*/
1.167 +_LIT8(KEpocUrlDataTypeHeader, "X-Epoc-Url/");
1.168 +
1.169 +#endif //SYMBIAN_ENABLE_SPLIT_HEADERS
1.170 +
1.171 +class TDataTypeWithPriority
1.172 +/** A data (MIME) type and a priority value for that data type.
1.173 +
1.174 +The priority is used to resolve the current preferred handler of a data type,
1.175 +in the absence of any user preferences. An AIF file can associate an application
1.176 +with a data (MIME) type that is not native to Symbian OS. A priority value
1.177 +can be specified that allows the device to choose the highest priority application
1.178 +that can handle that data type.
1.179 +
1.180 +@publishedAll
1.181 +@released
1.182 +@see TDataType
1.183 +@see TDataTypePriority */
1.184 + {
1.185 +public:
1.186 + IMPORT_C TDataTypeWithPriority();
1.187 + IMPORT_C TDataTypeWithPriority(const TDataType& aDataType, TDataTypePriority aPriority);
1.188 + //
1.189 + IMPORT_C void InternalizeL(RReadStream& aReadStream);
1.190 + IMPORT_C void ExternalizeL(RWriteStream& aWriteStream) const;
1.191 +public:
1.192 + /** The data type. */
1.193 + TDataType iDataType;
1.194 + /** The priority value. */
1.195 + TDataTypePriority iPriority;
1.196 + };
1.197 +
1.198 +#endif