profilesservices/ProfileEngine/EngInc/MProfilesLocalFeatures.h
branchRCL_3
changeset 8 f62c3a3d66b8
parent 4 3f8368f032cf
child 10 c8b9b0986973
equal deleted inserted replaced
4:3f8368f032cf 8:f62c3a3d66b8
     1 /*
       
     2 * Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  Interface for locally variated features of Profiles.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef __MPROFILESLOCALFEATURES_H__
       
    21 #define __MPROFILESLOCALFEATURES_H__
       
    22 
       
    23 // CLASS DECLARATION
       
    24 
       
    25 /**
       
    26 *  Profiles local feature variation interface.
       
    27 *  MProfilesLocalFeatures offers simple interface to get locally variated
       
    28 *  features of Profiles.
       
    29 *  How to use:
       
    30 *  Get local features object with MProfileEngineExtended::LocalFeaturesL().
       
    31 *     MProfilesLocalFeatures& features = iProfileEngine->LocalFeatures();
       
    32 *  Check whether a feature is supported (use the ID:s defined in
       
    33 *  ProfilesVariant.hrh):
       
    34 *     if( features.IsFeatureSupported( KFeatureIdSomeFeature ) )
       
    35 *         {
       
    36 *         // do stuff
       
    37 *         }
       
    38 *
       
    39 *  @lib N/A
       
    40 *  @since 2.6
       
    41 */
       
    42 class MProfilesLocalFeatures
       
    43     {
       
    44     protected:  // Destructor
       
    45 
       
    46         virtual ~MProfilesLocalFeatures() {};
       
    47 
       
    48     public: // New functions
       
    49 
       
    50         /**
       
    51         * Checks if the given feature is supported or not.
       
    52         * @since 2.6
       
    53         * @return ETrue if the feature is supported, EFalse otherwise.
       
    54         */
       
    55         virtual TBool IsFeatureSupported( TInt aFeatureId ) const = 0;
       
    56 
       
    57         /**
       
    58          * Checks if the given MIME-type is explicitly blocked from using as
       
    59          * an alert tone.
       
    60          * @since 3.1
       
    61          * @param aMimeType the MIME-type to be checked.
       
    62          * @return ETrue if the MIME-type is blocked, EFalse otherwise.
       
    63          */
       
    64         virtual TBool IsBlockedType( const TDesC& aMimeType ) = 0;
       
    65 
       
    66         /**
       
    67          * Checks if the given MIME-type is explicitly blocked from using as
       
    68          * an alert tone if the alert tone file of the type is unprotected.
       
    69          * @since 3.1
       
    70          * @param aMimeType the MIME-type to be checked.
       
    71          * @return ETrue if the MIME-type is blocked if the alert tone file is
       
    72          *         unprotected, EFalse otherwise.
       
    73          */
       
    74         virtual TBool IsBlockedUnprotectedType( const TDesC& aMimeType ) = 0;
       
    75 
       
    76         /**
       
    77          * Checks if the given MIME-type is explicitly blocked from using as
       
    78          * an alert tone if the alert tone file of the type is protected.
       
    79          * @since 3.1
       
    80          * @param aMimeType the MIME-type to be checked.
       
    81          * @return ETrue if the MIME-type is blocked if the alert tone file is
       
    82          *         protected, EFalse otherwise.
       
    83          */
       
    84         virtual TBool IsBlockedProtectedType( const TDesC& aMimeType ) = 0;
       
    85 
       
    86         /**
       
    87          * Checks if the given MIME-type is explicitly blocked from demo
       
    88          * playing.
       
    89          * @since 3.1
       
    90          * @param aMimeType the MIME-type to be checked.
       
    91          * @return ETrue if the MIME-type is blocked from demo-playing,
       
    92          *         EFalse otherwise.
       
    93          */
       
    94         virtual TBool IsBlockedDemoPlayType( const TDesC& aMimeType ) = 0;
       
    95 
       
    96         /**
       
    97          * Checks if the given MIME-type is explicitly excluded from the tone
       
    98          * selection list. Also when tried to be set as alert tones through
       
    99          * other means, should behave as the tone would be in blocked type list.
       
   100          * @since 3.1
       
   101          * @param aMimeType the MIME-type to be checked.
       
   102          * @return ETrue if the MIME-type is excluded from the tone selection
       
   103          *         list, EFalse otherwise.
       
   104          */
       
   105         virtual TBool IsExcludedType( const TDesC& aMimeType ) = 0;
       
   106     };
       
   107 
       
   108 #endif      //  __MPROFILESLOCALFEATURES_H__
       
   109 
       
   110 // End of File