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     EPEIncallEarVolumeSetting,

    43     EPEIncallLoudspeakerVolumeSetting,

    44     EPENetworkRegistrationStatus,

    45     EPETelephonyVariationFlags,

    46     EPEAccessoryMode,

    47     EPEEmergencyCallInfo,

    48     EPENetworkConnectionAllowedSetting

    49     };

    50 

    51 // CLASS DECLARATION

    52 

    53 /**

    54 *  MPEExternalDataHandler

    55 *  This internal interface provides for an access to Phone Engines external data

    56 *   store, i.e. settings stored in Central Repository and Publish and Subscribe.

    57 *

    58 *  @lib Phoneengine.lib

    59 */

    60 NONSHARABLE_CLASS( MPEExternalDataHandler )

    61     {

    62     public:

    63 

    64         /**

    65         * Gets the current value of the specified setting,

    66         * if the operation was successful then aValue contains the current valid

    67         * value of the setting

    68         * @param aSetting specifies the setting to be read

    69         * @param aValue the current value of the monitored setting

    70         * @return Symbian OS error code

    71         */

    72         virtual TInt Get( const TPEExternalDataId aSetting, TInt& aValue ) const = 0;

    73 

    74         /**

    75         * Gets the current value of the specified setting,

    76         * if the operation was successful then aValue contains the current valid

    77         * value of the setting

    78         * @param aSetting specifies the setting to be read

    79         * @param aValue the current value of the monitored setting

    80         * @return Symbian OS error code

    81         */

    82         virtual TInt GetText( const TPEExternalDataId aSetting, TDesC& aValue ) const = 0;

    83 

    84         /**

    85         * Sets the value of the specified setting,

    86         * @param aSetting specifies the setting to be written

    87         * @param aValue the value of the setting

    88         * @return Symbian OS error code

    89         */

    90         virtual TInt Set( const TPEExternalDataId aSetting, const TInt aValue ) = 0;

    91 

    92     };

    93 

    94 #endif  //  MPEEXTERNALDATAHANDLER_H