gsprofilesrv_pub/profiles_engine_wrapper_api/inc/MProEngActiveSettingsObserver.h
branchGCC_SURGE
changeset 45 f48d04161a92
parent 27 572294aa6075
parent 43 3341fe7c643a
equal deleted inserted replaced
27:572294aa6075 45:f48d04161a92
     1 /*
       
     2 * Copyright (c) 2009 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:  Abstract interface for handling the active profile events.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef MPROENGACTIVESETTINGSOBSERVER_H
       
    20 #define MPROENGACTIVESETTINGSOBSERVER_H
       
    21 
       
    22 //  INCLUDES
       
    23 #include <e32def.h>
       
    24 
       
    25 // FORWARD DECLARATIONS
       
    26 class MProEngActiveSettingsObserverExt;
       
    27 
       
    28 // CLASS DECLARATION
       
    29 
       
    30 /**
       
    31 * Active profile settings modification observer interface.
       
    32 * Implement this interface to get notifications of changes in the active profile settings
       
    33 * data.
       
    34 *
       
    35 *  @lib ProfileEngine.lib
       
    36 *  @since  10.1
       
    37 */
       
    38 class MProEngActiveSettingsObserver
       
    39     {
       
    40     public: // New functions
       
    41 
       
    42         /**
       
    43         * Abstract method for handling active profile settings modification event.
       
    44         * This method is called when the current active profile settings has been
       
    45         * modified some way. (e.g. switch active profile, change active profile)
       
    46         * 
       
    47         * @since Series 10.1
       
    48         */
       
    49         virtual void HandleActiveSettingsModifiedL() = 0;
       
    50 
       
    51         /**
       
    52          * Error handler for handling the errors in the active profile settings
       
    53          * modification notification process. If HandleActiveSettingsModifiedL()
       
    54          * leaves, this method is called with the leave code. This method has
       
    55          * default empty implementation.
       
    56          * @since 10.1
       
    57          * @param aError the code of the error which occurred during
       
    58          *        notification process.
       
    59          */
       
    60         virtual void HandleActiveSettingsNotificationError(
       
    61                 TInt /* aError */ ) {};
       
    62 
       
    63     protected:
       
    64 
       
    65         /**
       
    66         * Destructor.
       
    67         */
       
    68         virtual ~MProEngActiveSettingsObserver() {}
       
    69 
       
    70     private: // Extension interface
       
    71 
       
    72         /**
       
    73         * This member is internal and not intended for use.
       
    74         */
       
    75         virtual MProEngActiveSettingsObserverExt* Extension() { return NULL; }
       
    76 
       
    77     };
       
    78 
       
    79 #endif      // MPROENGACTIVESETTINGSOBSERVER_H
       
    80 
       
    81 // End of File
       
    82