epoc32/include/mw/mproengprofileobserver.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files

/*
* Copyright (c) 2002-2004 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
* which accompanies this distribution, and is available
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description: Profile modification observer interface.
*
*/



#ifndef MPROENGPROFILEOBSERVER_H
#define MPROENGPROFILEOBSERVER_H

//  INCLUDES
#include <e32def.h>

// FORWARD DECLARATIONS
class MProEngProfileObserverExt;

// CLASS DECLARATION

/**
* Profile modification observer interface.
* Implement this interface to get notifications of changes in the data of a
* selected profile.
*
*  @lib ProfileEngine.lib
*  @since Series 60 3.1
*/
class MProEngProfileObserver
    {
    public: // New functions

        /**
        * Abstract method for handling profile modification event.
        * This method is called when one of client chosen profiles has been
        * modified some way.
        * @since S60 3.1
        * @param aProfileId The ID of the profile that was modified. If there
        * has been many simultaneous changes in Profiles data, so that one
        * profile cannot be identified, this is KErrNotFound. In this case,
        * client gets this notification as many times as there are profiles
        * he has requested notifications about. The savest way is to use
        * own handlers for every profile of interest.
        */
        virtual void HandleProfileModifiedL( TInt aProfileId ) = 0;

        /**
         * Error handler for handling the errors in the profile modification
         * notification process. If HandleProfileModifiedL() leaves,
         * this method is called with the leave code. This method has
         * default empty implementation.
         * @since S60 3.1
         * @param aError the code of the error which occurred during
         *        notification process.
         */
        virtual void HandleProfileNotificationError(
                TInt /* aError */ ) {};

    protected:

        /**
        * Destructor.
        */
        virtual ~MProEngProfileObserver() {}

    private: // Extension interface

        /**
        * This member is internal and not intended for use.
        */
        virtual MProEngProfileObserverExt* Extension() { return NULL; }

    };

#endif      // MPROENGPROFILEOBSERVER_H

// End of File