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