gsprofilesrv_plat/profiles_engine_api/inc/MProfileEngineExtended2.h
author hgs
Tue, 25 May 2010 04:13:06 +0800
changeset 38 5a264aaf7677
parent 36 48848d132687
permissions -rw-r--r--
201019_01
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
36
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  Extended profile engine interface 2.
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
#ifndef __MPROFILEENGINEEXTENDED2_H__
hgs
parents:
diff changeset
    21
#define __MPROFILEENGINEEXTENDED2_H__
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
//  INCLUDES
hgs
parents:
diff changeset
    24
#include <MProfileEngineExtended.h>
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
// DATA TYPES
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
// FUNCTION PROTOTYPES
hgs
parents:
diff changeset
    29
class MProfileEngineExtended2;
hgs
parents:
diff changeset
    30
/**
hgs
parents:
diff changeset
    31
* Create extended profile engine, ownership transfered.
hgs
parents:
diff changeset
    32
*
hgs
parents:
diff changeset
    33
*  @lib ProfileEng.lib
hgs
parents:
diff changeset
    34
*  @since 10.1
hgs
parents:
diff changeset
    35
*/
hgs
parents:
diff changeset
    36
hgs
parents:
diff changeset
    37
IMPORT_C MProfileEngineExtended2* CreateProfileEngineExtended2L();
hgs
parents:
diff changeset
    38
hgs
parents:
diff changeset
    39
/**
hgs
parents:
diff changeset
    40
* Create extended profile engine, ownership transfered.
hgs
parents:
diff changeset
    41
*
hgs
parents:
diff changeset
    42
*  @param aFs An open file server session, ownership is NOT transferred.
hgs
parents:
diff changeset
    43
*  aFs must remain connected for the lifetime of the returned object.
hgs
parents:
diff changeset
    44
*  @lib ProfileEng.lib
hgs
parents:
diff changeset
    45
*  @since 10.1
hgs
parents:
diff changeset
    46
*/
hgs
parents:
diff changeset
    47
IMPORT_C MProfileEngineExtended2* CreateProfileEngineExtended2L( RFs* aFs );
hgs
parents:
diff changeset
    48
hgs
parents:
diff changeset
    49
// FORWARD DECLARATIONS
hgs
parents:
diff changeset
    50
class MProfileExtended2;
hgs
parents:
diff changeset
    51
hgs
parents:
diff changeset
    52
// CLASS DECLARATION
hgs
parents:
diff changeset
    53
hgs
parents:
diff changeset
    54
/**
hgs
parents:
diff changeset
    55
*  Extended profile engine interface.
hgs
parents:
diff changeset
    56
*  This interface extend MProfileEngine interface and
hgs
parents:
diff changeset
    57
*  offers methods to get profile settings and store profile settings.
hgs
parents:
diff changeset
    58
*
hgs
parents:
diff changeset
    59
*  @lib N/A
hgs
parents:
diff changeset
    60
*  @since 2.0
hgs
parents:
diff changeset
    61
*/
hgs
parents:
diff changeset
    62
class MProfileEngineExtended2 : public MProfileEngineExtended
hgs
parents:
diff changeset
    63
    {
hgs
parents:
diff changeset
    64
    protected:  // Destructor
hgs
parents:
diff changeset
    65
hgs
parents:
diff changeset
    66
        virtual ~MProfileEngineExtended2() {};
hgs
parents:
diff changeset
    67
hgs
parents:
diff changeset
    68
    public: // New functions
hgs
parents:
diff changeset
    69
hgs
parents:
diff changeset
    70
        /**
hgs
parents:
diff changeset
    71
        * Create extended profile, ownership transfered.
hgs
parents:
diff changeset
    72
        * @since 2.0
hgs
parents:
diff changeset
    73
        * @param aId Profile ID
hgs
parents:
diff changeset
    74
        * @return Instance of the MProfileExtended
hgs
parents:
diff changeset
    75
        */
hgs
parents:
diff changeset
    76
        virtual MProfileExtended2* Profile2LC( TInt aId ) = 0;
hgs
parents:
diff changeset
    77
hgs
parents:
diff changeset
    78
        /**
hgs
parents:
diff changeset
    79
        * Create extended profile, ownership transfered.
hgs
parents:
diff changeset
    80
        * @since 2.0
hgs
parents:
diff changeset
    81
        * @param aId Profile ID
hgs
parents:
diff changeset
    82
        * @return Instance of the MProfileExtended
hgs
parents:
diff changeset
    83
        */
hgs
parents:
diff changeset
    84
        virtual MProfileExtended2* Profile2L( TInt aId ) = 0;
hgs
parents:
diff changeset
    85
hgs
parents:
diff changeset
    86
        /**
hgs
parents:
diff changeset
    87
        * Store profile settings. Leaves with KErrAccessDenied if one or more
hgs
parents:
diff changeset
    88
        * of the settings of the target profile is/are read-only.
hgs
parents:
diff changeset
    89
        * @since 2.0
hgs
parents:
diff changeset
    90
        * @param aProfile Profile
hgs
parents:
diff changeset
    91
        */
hgs
parents:
diff changeset
    92
        virtual void CommitChange2L( MProfileExtended2& aProfile ) = 0;
hgs
parents:
diff changeset
    93
hgs
parents:
diff changeset
    94
       
hgs
parents:
diff changeset
    95
        /**
hgs
parents:
diff changeset
    96
        * Returns Master volume
hgs
parents:
diff changeset
    97
        * @since 10.1
hgs
parents:
diff changeset
    98
        */
hgs
parents:
diff changeset
    99
        virtual TInt MasterVolumeL() const = 0;
hgs
parents:
diff changeset
   100
        
hgs
parents:
diff changeset
   101
        /**
hgs
parents:
diff changeset
   102
        * Set master volume
hgs
parents:
diff changeset
   103
        * @since 10.1
hgs
parents:
diff changeset
   104
        * @param aMasterVolume: new master volume to be set
hgs
parents:
diff changeset
   105
        */
hgs
parents:
diff changeset
   106
        virtual void SetMasterVolumeL( TInt aMasterVolume ) = 0;
hgs
parents:
diff changeset
   107
        
hgs
parents:
diff changeset
   108
        /**
hgs
parents:
diff changeset
   109
        * Returns Master vibra
hgs
parents:
diff changeset
   110
        * @since 10.1
hgs
parents:
diff changeset
   111
        */
hgs
parents:
diff changeset
   112
        virtual TBool MasterVibraL() const = 0;
hgs
parents:
diff changeset
   113
        
hgs
parents:
diff changeset
   114
        /**
hgs
parents:
diff changeset
   115
        * Set master vibra
hgs
parents:
diff changeset
   116
        * @since 10.1
hgs
parents:
diff changeset
   117
        * @param aMasterVibra: new master vibra to be set ETrue: On EFalse: Off
hgs
parents:
diff changeset
   118
        */
hgs
parents:
diff changeset
   119
        virtual void SetMasterVibraL( TBool aMasterVibra ) = 0;
hgs
parents:
diff changeset
   120
        
hgs
parents:
diff changeset
   121
        /**
hgs
parents:
diff changeset
   122
        * Returns silence mode
hgs
parents:
diff changeset
   123
        * @since 10.1
hgs
parents:
diff changeset
   124
        */
hgs
parents:
diff changeset
   125
        virtual TBool SilenceModeL() const = 0;
hgs
parents:
diff changeset
   126
        
hgs
parents:
diff changeset
   127
        /**
hgs
parents:
diff changeset
   128
        * Set silence mode
hgs
parents:
diff changeset
   129
        * @since 10.1
hgs
parents:
diff changeset
   130
        * @param aSilenceMode: new silence mode to be set ETrue: On EFalse: Off
hgs
parents:
diff changeset
   131
        */
hgs
parents:
diff changeset
   132
        virtual void SetSilenceModeL( TBool aSilenceMode ) = 0;
hgs
parents:
diff changeset
   133
hgs
parents:
diff changeset
   134
    };
hgs
parents:
diff changeset
   135
hgs
parents:
diff changeset
   136
#endif      // __MPROFILEENGINEEXTENDED_H__
hgs
parents:
diff changeset
   137
hgs
parents:
diff changeset
   138
// End of File