messagingappbase/mcesettings/inc/MceSettingsAccountManager.h
changeset 0 72b543305e3a
equal deleted inserted replaced
-1:000000000000 0:72b543305e3a
       
     1 /*
       
     2 * Copyright (c) 2002 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:  
       
    15 *     Mixed class to offer different account functions.
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 
       
    21 #ifndef __MCESETTINGSACCOUNTMANAGER_H__
       
    22 #define __MCESETTINGSACCOUNTMANAGER_H__
       
    23 
       
    24 //  INCLUDES
       
    25 
       
    26 #include <msvreg.h>     // THumanReadableName
       
    27 
       
    28 
       
    29 // FORWARD DECLARATIONS
       
    30 class CUidNameArray;
       
    31 class CMsvSession;
       
    32 
       
    33 // CLASS DECLARATION
       
    34 
       
    35 /**
       
    36 *  Mixed class to offer different account functions.
       
    37 *  Implemented by Mce application or some other class...
       
    38 */
       
    39 class MMceSettingsAccountManager
       
    40     {
       
    41     public:
       
    42         /**
       
    43         * Create new account.
       
    44         * @param aType type of the account.
       
    45         * @param aOldServiceId id of the service where old settings are copied (this is for 'create from existing')
       
    46         * @return ETrue if account created, EFalse otherwise
       
    47         */
       
    48         virtual TBool CreateNewAccountL( TUid aType, TMsvId aOldServiceId ) = 0;
       
    49 
       
    50         /**
       
    51         * Edit account.
       
    52         * @param aId id of the account to be edited.
       
    53         */
       
    54         virtual void EditAccountL( TMsvId aId ) = 0;
       
    55 
       
    56         /**
       
    57         * Returns array of accounts of desired type.
       
    58         * Callers responsibility to destroy array!
       
    59         * @param aType type of the account.
       
    60         */
       
    61         virtual CUidNameArray* MtmAccountsL( TUid aType ) = 0;
       
    62 
       
    63         /**
       
    64         * Can create create new account of aMtm.
       
    65         * @param aMtm Mtm uid.
       
    66         * @return EFalse if new accounts cannot be created for mtm aMtm.
       
    67         */
       
    68         virtual TBool CanCreateNewAccountL( TUid aMtm ) = 0;
       
    69 
       
    70         /**
       
    71         * Delete account.
       
    72         * @param aId id of the account to be deleted.
       
    73         */
       
    74         virtual void DeleteAccountL( TMsvId aId ) = 0;
       
    75 
       
    76         /**
       
    77          * Returns session used.
       
    78          * @return reference to object of CMsvSession class.
       
    79          */
       
    80         virtual CMsvSession& Session() = 0;
       
    81 
       
    82         /**
       
    83          * Returns ETrue if aMtm is installed in the device.
       
    84          * @param aMtm: Mtm uid to be checked.
       
    85          * @return EFalse if aMtm is not installed, ETrue if it is installed.
       
    86          */
       
    87         virtual TBool IsPresent( TUid aMtm ) const = 0;
       
    88 
       
    89         /**
       
    90          * Returns human readable name of mtm.
       
    91          * @param aMtm: Mtm uid
       
    92          * @return human readable name of mtm.
       
    93          */
       
    94         virtual THumanReadableName MtmName( TUid aMtm ) const = 0;
       
    95         
       
    96         
       
    97         /**
       
    98         * Called by General settings dialog when message store
       
    99         *   change is started / ended. 
       
   100         * @param aChangeEnded: EFalse when change started
       
   101         *                      ETrue when change ended
       
   102         * @since S60 3.2
       
   103         */
       
   104         virtual void SetChangeMessageStore( TBool aChangeEnded ) = 0;
       
   105     };
       
   106 
       
   107 
       
   108 #endif
       
   109 
       
   110 // End of file