phoneengine/phonemodel/inc/mpeexternaldatahandler.h
changeset 37 ba76fc04e6c2
child 51 f39ed5e045e0
equal deleted inserted replaced
36:2eacb6118286 37:ba76fc04e6c2
       
     1 /*
       
     2 * Copyright (c) 2005 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:  This file defines the protocol independent interface
       
    15 *                of the Phone Engine external data store framework for
       
    16 *                Phone Engine submodule use.
       
    17 *
       
    18 */
       
    19 
       
    20 
       
    21 #ifndef MPEEXTERNALDATAHANDLER_H
       
    22 #define MPEEXTERNALDATAHANDLER_H
       
    23 
       
    24 //  INCLUDE FILES
       
    25 #include <pevirtualengine.h>
       
    26 
       
    27 // FORWARD DECLARATIONS
       
    28 // None
       
    29 
       
    30 // DATA TYPES
       
    31 enum TPEExternalDataId
       
    32     {
       
    33     EPEAudioOutputPreference,
       
    34     EPEAutomaticAnswerHeadsetSetting,
       
    35     EPEAutomaticAnswerLoopsetSetting,
       
    36     EPEAutomaticAnswerCarkitSetting,
       
    37     EPEAutomaticAnswerMusicStandSetting,
       
    38     EPEAutomaticAnswerWirelessCarkitSetting,
       
    39     EPECallDurationDisplaySetting,
       
    40     EPEDialPrefixChangeSetting,
       
    41     EPEDialPrefixTextSetting,  
       
    42     EPETelephonyVariationFlags,
       
    43     EPEAccessoryMode,
       
    44     EPEEmergencyCallInfo,
       
    45     EPENetworkConnectionAllowedSetting
       
    46     };
       
    47 
       
    48 // CLASS DECLARATION
       
    49 
       
    50 /**
       
    51 *  MPEExternalDataHandler
       
    52 *  This internal interface provides for an access to Phone Engines external data
       
    53 *   store, i.e. settings stored in Central Repository and Publish and Subscribe.
       
    54 *
       
    55 *  @lib Phoneengine.lib
       
    56 */
       
    57 NONSHARABLE_CLASS( MPEExternalDataHandler )
       
    58     {
       
    59     public:
       
    60 
       
    61         /**
       
    62         * Gets the current value of the specified setting,
       
    63         * if the operation was successful then aValue contains the current valid
       
    64         * value of the setting
       
    65         * @param aSetting specifies the setting to be read
       
    66         * @param aValue the current value of the monitored setting
       
    67         * @return Symbian OS error code
       
    68         */
       
    69         virtual TInt Get( const TPEExternalDataId aSetting, TInt& aValue ) const = 0;
       
    70 
       
    71         /**
       
    72         * Gets the current value of the specified setting,
       
    73         * if the operation was successful then aValue contains the current valid
       
    74         * value of the setting
       
    75         * @param aSetting specifies the setting to be read
       
    76         * @param aValue the current value of the monitored setting
       
    77         * @return Symbian OS error code
       
    78         */
       
    79         virtual TInt GetText( const TPEExternalDataId aSetting, TDesC& aValue ) const = 0;
       
    80 
       
    81         /**
       
    82         * Sets the value of the specified setting,
       
    83         * @param aSetting specifies the setting to be written
       
    84         * @param aValue the value of the setting
       
    85         * @return Symbian OS error code
       
    86         */
       
    87         virtual TInt Set( const TPEExternalDataId aSetting, const TInt aValue ) = 0;
       
    88 
       
    89     };
       
    90 
       
    91 #endif  //  MPEEXTERNALDATAHANDLER_H