wvuing/wvuieng/EngInc/MCASDCRVariator.h
changeset 0 094583676ce7
equal deleted inserted replaced
-1:000000000000 0:094583676ce7
       
     1 /*
       
     2 * Copyright (c) 2004 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:  Provides the log handling interface for the UI
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef MCASDCRVARIATOR_H
       
    20 #define MCASDCRVARIATOR_H
       
    21 
       
    22 // INCLUDES
       
    23 #include <e32std.h>
       
    24 
       
    25 // CLASS DECLARATION
       
    26 /**
       
    27  *  Variation class for Shared Data or Central Repository (persistent
       
    28  *  preference store).
       
    29  *  @lib CAEngine.lib
       
    30  *  @since 3.0
       
    31  */
       
    32 class MCASDCRVariator
       
    33     {
       
    34     public:
       
    35 
       
    36         /**
       
    37          * Get integer from persistent preference store.
       
    38          * @param aSetting The setting key
       
    39          * @param aValue The value to which to get the integer
       
    40          * @return KErrNone if successful
       
    41          * @since 3.0
       
    42          */
       
    43         virtual TInt GetInt( TInt aSetting, TInt& aValue ) = 0;
       
    44 
       
    45         /**
       
    46          * Set integer to persistent preference store.
       
    47          * @param aSetting The setting key
       
    48          * @param aValue The value to which to set
       
    49          * @return KErrNone if successful
       
    50          * @since 3.0
       
    51          */
       
    52         virtual TInt SetInt( TInt aSetting, TInt aValue ) = 0;
       
    53 
       
    54         /**
       
    55          * Get string from persistent preference store.
       
    56          * @param aSetting The setting key
       
    57          * @param aValue The value to which to get the integer
       
    58          * @return KErrNone if successful
       
    59          * @since 3.0
       
    60          */
       
    61         virtual TInt GetString( TInt aSetting, TDes& aValue ) = 0;
       
    62 
       
    63         /**
       
    64          * Set string to persistent preference store.
       
    65          * @param aSetting The setting key
       
    66          * @param aValue The value to which to set
       
    67          * @return KErrNone if successful
       
    68          * @since 3.0
       
    69          */
       
    70         virtual TInt SetString( TInt aSetting, const TDesC& aValue ) = 0;
       
    71 
       
    72         /**
       
    73          * Flush the data to the persistent preference store
       
    74          * @return KErrNone if successful
       
    75          */
       
    76         virtual TInt FlushData() = 0;
       
    77 
       
    78         /**
       
    79          * Destructor.
       
    80          */
       
    81         virtual ~MCASDCRVariator() {};
       
    82     };
       
    83 
       
    84 #endif      // MCASDCRVARIATOR_H
       
    85 
       
    86 // End of File