gsprofilesrv_pub/profiles_engine_wrapper_api/inc/MProEngProfileObserver.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: Profile modification observer interface.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef MPROENGPROFILEOBSERVER_H
       
    21 #define MPROENGPROFILEOBSERVER_H
       
    22 
       
    23 //  INCLUDES
       
    24 #include <e32def.h>
       
    25 
       
    26 // FORWARD DECLARATIONS
       
    27 class MProEngProfileObserverExt;
       
    28 
       
    29 // CLASS DECLARATION
       
    30 
       
    31 /**
       
    32 * Profile modification observer interface.
       
    33 * Implement this interface to get notifications of changes in the data of a
       
    34 * selected profile.
       
    35 *
       
    36 *  @lib ProfileEngine.lib
       
    37 *  @since Series 60 3.1
       
    38 */
       
    39 class MProEngProfileObserver
       
    40     {
       
    41     public: // New functions
       
    42 
       
    43         /**
       
    44         * Abstract method for handling profile modification event.
       
    45         * This method is called when one of client chosen profiles has been
       
    46         * modified some way.
       
    47         * @since S60 3.1
       
    48         * @param aProfileId The ID of the profile that was modified. If there
       
    49         * has been many simultaneous changes in Profiles data, so that one
       
    50         * profile cannot be identified, this is KErrNotFound. In this case,
       
    51         * client gets this notification as many times as there are profiles
       
    52         * he has requested notifications about. The savest way is to use
       
    53         * own handlers for every profile of interest.
       
    54         */
       
    55         virtual void HandleProfileModifiedL( TInt aProfileId ) = 0;
       
    56 
       
    57         /**
       
    58          * Error handler for handling the errors in the profile modification
       
    59          * notification process. If HandleProfileModifiedL() leaves,
       
    60          * this method is called with the leave code. This method has
       
    61          * default empty implementation.
       
    62          * @since S60 3.1
       
    63          * @param aError the code of the error which occurred during
       
    64          *        notification process.
       
    65          */
       
    66         virtual void HandleProfileNotificationError(
       
    67                 TInt /* aError */ ) {};
       
    68 
       
    69     protected:
       
    70 
       
    71         /**
       
    72         * Destructor.
       
    73         */
       
    74         virtual ~MProEngProfileObserver() {}
       
    75 
       
    76     private: // Extension interface
       
    77 
       
    78         /**
       
    79         * This member is internal and not intended for use.
       
    80         */
       
    81         virtual MProEngProfileObserverExt* Extension() { return NULL; }
       
    82 
       
    83     };
       
    84 
       
    85 #endif      // MPROENGPROFILEOBSERVER_H
       
    86 
       
    87 // End of File
       
    88