upnpharvester/common/cmsettings/inc/cmsettings.h
branchIOP_Improvements
changeset 40 08b5eae9f9ff
parent 39 6369bfd1b60d
child 41 b4d83ea1d6e2
equal deleted inserted replaced
39:6369bfd1b60d 40:08b5eae9f9ff
     1 /*
       
     2 * Copyright (c) 2006-2007 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:      CM Settings class
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 
       
    22 
       
    23 
       
    24 #ifndef M_CCMSETTINGS_H
       
    25 #define M_CCMSETTINGS_H
       
    26 
       
    27 // INCLUDES
       
    28 #include <e32base.h>
       
    29 #include "cmcommon.h"
       
    30 
       
    31 // FORWARD DECLARATIONS
       
    32 class CRepository;
       
    33 class CCmDriveInfo;
       
    34 class RFs;
       
    35 
       
    36 /**
       
    37  *  Defines the cmsettings interface
       
    38  *
       
    39  *  This class defines the cmsettings interface. Provides methods to
       
    40  *  execute fill specific services
       
    41  *
       
    42  *  @lib cmsettings.lib
       
    43  *  @since S60 v3.2
       
    44  */
       
    45 class MCmSettings
       
    46     {
       
    47 
       
    48 public: // New functions
       
    49 
       
    50     /**
       
    51      * Gets the status for the Content Manager service
       
    52      *
       
    53      * @since S60 3.1
       
    54      * @param aService indicates service
       
    55      * @param aState state enum is returned here
       
    56      * @return status of the operation
       
    57      */
       
    58     virtual TInt GetServiceState( const TCmService aService,
       
    59                                    TCmServiceState& aState ) const = 0;
       
    60 
       
    61      /**
       
    62      * Sets Content Manager service state
       
    63      *
       
    64      * @since S60 3.1
       
    65      * @param aState TCmServerState to indicate state
       
    66      * @return status of the operation
       
    67      */
       
    68     virtual TInt SetServiceState( const TCmService aService,
       
    69                                    const TCmServiceState aState ) = 0;
       
    70 
       
    71     /**
       
    72      * Gets defined MMC information.
       
    73      *
       
    74      * @since S60 3.1
       
    75      * @param aName MMC card's name (max length KMaxFileName)
       
    76      * @param aId MMC car's unique id
       
    77      * @return status of the operation
       
    78      */
       
    79 //    virtual TInt GetMmcInformation( TDes& aName, TUint& aId ) const = 0;
       
    80 
       
    81 
       
    82     /**
       
    83      * Sets defined MMC information.
       
    84      *
       
    85      * @since S60 3.1
       
    86      * @param aName MMC card's name (max length KMaxFileName)
       
    87      * @param aId MMC car's unique id
       
    88      * @return status of the operation
       
    89      */
       
    90 //    virtual TInt SetMmcInformation( const TDesC& aName, const TUint aId ) = 0;
       
    91 
       
    92 
       
    93     /**
       
    94      * Gets defined IAP information.
       
    95      *
       
    96      * @since S60 3.1
       
    97      * @param aIap access point info is stored here
       
    98      * @return status of the operation
       
    99      */
       
   100    virtual TInt GetIapL( TInt& aIap ) const = 0;
       
   101 
       
   102     /**
       
   103      * Gets next runtime information for the specified service.
       
   104      *
       
   105      * @since S60 3.1
       
   106      * @param aService content manager service
       
   107      * @param aRuntime the next date and time service is run.
       
   108      * @return status of the operation
       
   109      */
       
   110     virtual TInt GetNextRuntime( const TCmService aService,
       
   111                                   TTime& aRuntime ) const = 0;
       
   112 
       
   113 
       
   114     /**
       
   115      * Sets next runtime information for the specified service.
       
   116      *
       
   117      * @since S60 3.1
       
   118      * @param aService content manager service
       
   119      * @param aNextTime the next date and time service is run.
       
   120      * @return status of the operation
       
   121      */
       
   122     virtual TInt SetNextRuntime( const TCmService aService,
       
   123                                   const TTime aRuntime ) = 0;
       
   124 
       
   125 
       
   126     /**
       
   127      * Gets device discovery delay
       
   128      *
       
   129      * @since S60 3.1
       
   130      * @param aDelay device discovery delay
       
   131      * @return status of the operation
       
   132      */
       
   133     virtual TInt GetDiscoveryDelay( TInt& aDelay ) const = 0;
       
   134 
       
   135 
       
   136     /**
       
   137      * Sets device discovery delay
       
   138      *
       
   139      * @since S60 3.1
       
   140      * @param aDelay device discovery delay
       
   141      * @return status of the operation
       
   142      */
       
   143     virtual TInt SetDiscoveryDelay( const TInt aDelay ) = 0;
       
   144 
       
   145 
       
   146     /**
       
   147      * Gets automatic sync settings
       
   148      *
       
   149      * @since S60 3.1
       
   150      * @param aAutoSync automatic sync settings
       
   151      * @return status of the operation
       
   152      */
       
   153     virtual TInt GetAutoSync( TBool& aAutoSync ) const = 0;
       
   154 
       
   155 
       
   156     /**
       
   157      * Sets automatic sync settings
       
   158      *
       
   159      * @since S60 3.1
       
   160      * @param aAutoSync automatic sync settings
       
   161      * @return status of the operation
       
   162      */
       
   163     virtual TInt SetAutoSync( const TBool aAutoSync ) = 0;
       
   164 
       
   165      /**
       
   166      * Gets memory manager status
       
   167      *
       
   168      * @since S60 3.1
       
   169      * @param aMmStatus memory manager status
       
   170      * @return status of the operation
       
   171      */
       
   172     virtual TInt GetMemoryManagerStatus( TBool& aMmStatus ) const = 0;
       
   173 
       
   174      /**
       
   175      * Sets memory manager status
       
   176      *
       
   177      * @since S60 3.1
       
   178      * @param aMmStatus memory manager status
       
   179      * @return status of the operation
       
   180      */
       
   181     virtual TInt SetMemoryManagerStatus( const TBool aMmStatus ) = 0;
       
   182 
       
   183     /**
       
   184      * Gets search item count
       
   185      *
       
   186      * @since S60 3.1
       
   187      * @param aItemCount result item count
       
   188      * @return status of the operation
       
   189      */
       
   190     virtual TInt GetSearchCount( TInt& aItemCount ) const = 0;
       
   191 
       
   192     /**
       
   193      * Gets add item count
       
   194      *
       
   195      * @since S60 3.1
       
   196      * @param aItemCount result item count
       
   197      * @return status of the operation
       
   198      */
       
   199     virtual TInt GetAddCount( TInt& aItemCount ) const = 0;
       
   200 
       
   201     /**
       
   202      * ???
       
   203      *
       
   204      * @since S60 3.1
       
   205      * @param aAppWizardState ??
       
   206      * @return TInt ???
       
   207      */
       
   208     virtual TInt GetAppWizardInformation( TInt& aAppWizardState ) const = 0;
       
   209 
       
   210     /**
       
   211      * ???
       
   212      *
       
   213      * @since S60 3.1
       
   214      * @return TInt ???
       
   215      */
       
   216     virtual TInt SetAppWizardInformation() = 0;
       
   217 
       
   218     /**
       
   219      * ???
       
   220      *
       
   221      * @since S60 3.1
       
   222      * @param aFs ??
       
   223      * @param aDrives ??
       
   224      */
       
   225     virtual void DriveListL( RFs& aFs,
       
   226                               RPointerArray<CCmDriveInfo>& aDrives ) const = 0;
       
   227 
       
   228     /**
       
   229      * Deletes the object
       
   230      *
       
   231      * @since S60 3.1
       
   232      */
       
   233 	virtual void Close() = 0;
       
   234 
       
   235     };
       
   236 
       
   237 
       
   238 #endif // M_CCMSETTINGS_H