gsprofilesrv_plat/profiles_engine_api/inc/MProfileEngineExtended2.h
branchRCL_3
changeset 24 8ee96d21d9bf
equal deleted inserted replaced
23:8bda91a87a00 24:8ee96d21d9bf
       
     1 /*
       
     2 * Copyright (c) 2009 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:  Extended profile engine interface 2.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef __MPROFILEENGINEEXTENDED2_H__
       
    21 #define __MPROFILEENGINEEXTENDED2_H__
       
    22 
       
    23 //  INCLUDES
       
    24 #include <MProfileEngineExtended.h>
       
    25 
       
    26 // DATA TYPES
       
    27 
       
    28 // FUNCTION PROTOTYPES
       
    29 class MProfileEngineExtended2;
       
    30 /**
       
    31 * Create extended profile engine, ownership transfered.
       
    32 *
       
    33 *  @lib ProfileEng.lib
       
    34 *  @since 10.1
       
    35 */
       
    36 
       
    37 IMPORT_C MProfileEngineExtended2* CreateProfileEngineExtended2L();
       
    38 
       
    39 /**
       
    40 * Create extended profile engine, ownership transfered.
       
    41 *
       
    42 *  @param aFs An open file server session, ownership is NOT transferred.
       
    43 *  aFs must remain connected for the lifetime of the returned object.
       
    44 *  @lib ProfileEng.lib
       
    45 *  @since 10.1
       
    46 */
       
    47 IMPORT_C MProfileEngineExtended2* CreateProfileEngineExtended2L( RFs* aFs );
       
    48 
       
    49 // FORWARD DECLARATIONS
       
    50 class MProfileExtended2;
       
    51 
       
    52 // CLASS DECLARATION
       
    53 
       
    54 /**
       
    55 *  Extended profile engine interface.
       
    56 *  This interface extend MProfileEngine interface and
       
    57 *  offers methods to get profile settings and store profile settings.
       
    58 *
       
    59 *  @lib N/A
       
    60 *  @since 2.0
       
    61 */
       
    62 class MProfileEngineExtended2 : public MProfileEngineExtended
       
    63     {
       
    64     protected:  // Destructor
       
    65 
       
    66         virtual ~MProfileEngineExtended2() {};
       
    67 
       
    68     public: // New functions
       
    69 
       
    70         /**
       
    71         * Create extended profile, ownership transfered.
       
    72         * @since 2.0
       
    73         * @param aId Profile ID
       
    74         * @return Instance of the MProfileExtended
       
    75         */
       
    76         virtual MProfileExtended2* Profile2LC( TInt aId ) = 0;
       
    77 
       
    78         /**
       
    79         * Create extended profile, ownership transfered.
       
    80         * @since 2.0
       
    81         * @param aId Profile ID
       
    82         * @return Instance of the MProfileExtended
       
    83         */
       
    84         virtual MProfileExtended2* Profile2L( TInt aId ) = 0;
       
    85 
       
    86         /**
       
    87         * Store profile settings. Leaves with KErrAccessDenied if one or more
       
    88         * of the settings of the target profile is/are read-only.
       
    89         * @since 2.0
       
    90         * @param aProfile Profile
       
    91         */
       
    92         virtual void CommitChange2L( MProfileExtended2& aProfile ) = 0;
       
    93 
       
    94        
       
    95         /**
       
    96         * Returns Master volume
       
    97         * @since 10.1
       
    98         */
       
    99         virtual TInt MasterVolumeL() const = 0;
       
   100         
       
   101         /**
       
   102         * Set master volume
       
   103         * @since 10.1
       
   104         * @param aMasterVolume: new master volume to be set
       
   105         */
       
   106         virtual void SetMasterVolumeL( TInt aMasterVolume ) = 0;
       
   107         
       
   108         /**
       
   109         * Returns Master vibra
       
   110         * @since 10.1
       
   111         */
       
   112         virtual TBool MasterVibraL() const = 0;
       
   113         
       
   114         /**
       
   115         * Set master vibra
       
   116         * @since 10.1
       
   117         * @param aMasterVibra: new master vibra to be set ETrue: On EFalse: Off
       
   118         */
       
   119         virtual void SetMasterVibraL( TBool aMasterVibra ) = 0;
       
   120         
       
   121         /**
       
   122         * Returns silence mode
       
   123         * @since 10.1
       
   124         */
       
   125         virtual TBool SilenceModeL() const = 0;
       
   126         
       
   127         /**
       
   128         * Set silence mode
       
   129         * @since 10.1
       
   130         * @param aSilenceMode: new silence mode to be set ETrue: On EFalse: Off
       
   131         */
       
   132         virtual void SetSilenceModeL( TBool aSilenceMode ) = 0;
       
   133 
       
   134     };
       
   135 
       
   136 #endif      // __MPROFILEENGINEEXTENDED_H__
       
   137 
       
   138 // End of File