epoc32/include/mw/mproengprofileactivationobserver.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     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 activation observer interface.
    15 *
    16 */
    17 
    18 
    19 
    20 #ifndef MPROENGPROFILEACTIVATIONOBSERVER_H
    21 #define MPROENGPROFILEACTIVATIONOBSERVER_H
    22 
    23 //  INCLUDES
    24 #include <e32def.h>
    25 
    26 // FORWARD DECLARATIONS
    27 class MProEngProfileActivationObserverExt;
    28 
    29 // CLASS DECLARATION
    30 
    31 /**
    32 * Profile activation observer interface.
    33 * Implement this interface to get notifications when the current active profile
    34 * changes.
    35 *
    36 *  @lib ProfileEngine.lib
    37 *  @since Series 60 3.1
    38 */
    39 class MProEngProfileActivationObserver
    40     {
    41     public: // New functions
    42 
    43         /**
    44         * Abstract method for handling profile activation event. This method is
    45         * called always when a profile is activated, even if the current active
    46         * profile is re-activated.
    47         * @since S60 3.1
    48         * @param aProfileId The ID of the new active profile.
    49         */
    50         virtual void HandleProfileActivatedL( TInt aProfileId ) = 0;
    51                                          
    52         /**
    53          * Error handler for handling the errors in the profile activation
    54          * notification process. If HandleProfileActivatedL() leaves, this
    55          * method is called with the leave code. This method has default empty
    56          * implementation.
    57          * @since S60 3.1
    58          * @param aError the code of the error which occurred during
    59          *        notification process.
    60          */
    61         virtual void HandleProfileActivationNotificationError(
    62                 TInt /* aError */ ) {};
    63 
    64 
    65     protected:
    66 
    67         /**
    68         * Destructor.
    69         */
    70         virtual ~MProEngProfileActivationObserver() {}
    71 
    72     private: // Extension interface
    73 
    74         /**
    75         * This member is internal and not intended for use.
    76         */
    77         virtual MProEngProfileActivationObserverExt* Extension() {return NULL;}
    78 
    79     };
    80 
    81 #endif      // MPROENGPROFILEACTIVATIONOBSERVER_H
    82 
    83 // End of File
    84