epoc32/include/mw/mproengprofileobserver.h
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
     1.1 --- a/epoc32/include/mw/mproengprofileobserver.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/mproengprofileobserver.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,88 @@
     1.4 -mproengprofileobserver.h
     1.5 +/*
     1.6 +* Copyright (c) 2002-2004 Nokia Corporation and/or its subsidiary(-ies).
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* 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
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description: Profile modification observer interface.
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +
    1.24 +#ifndef MPROENGPROFILEOBSERVER_H
    1.25 +#define MPROENGPROFILEOBSERVER_H
    1.26 +
    1.27 +//  INCLUDES
    1.28 +#include <e32def.h>
    1.29 +
    1.30 +// FORWARD DECLARATIONS
    1.31 +class MProEngProfileObserverExt;
    1.32 +
    1.33 +// CLASS DECLARATION
    1.34 +
    1.35 +/**
    1.36 +* Profile modification observer interface.
    1.37 +* Implement this interface to get notifications of changes in the data of a
    1.38 +* selected profile.
    1.39 +*
    1.40 +*  @lib ProfileEngine.lib
    1.41 +*  @since Series 60 3.1
    1.42 +*/
    1.43 +class MProEngProfileObserver
    1.44 +    {
    1.45 +    public: // New functions
    1.46 +
    1.47 +        /**
    1.48 +        * Abstract method for handling profile modification event.
    1.49 +        * This method is called when one of client chosen profiles has been
    1.50 +        * modified some way.
    1.51 +        * @since S60 3.1
    1.52 +        * @param aProfileId The ID of the profile that was modified. If there
    1.53 +        * has been many simultaneous changes in Profiles data, so that one
    1.54 +        * profile cannot be identified, this is KErrNotFound. In this case,
    1.55 +        * client gets this notification as many times as there are profiles
    1.56 +        * he has requested notifications about. The savest way is to use
    1.57 +        * own handlers for every profile of interest.
    1.58 +        */
    1.59 +        virtual void HandleProfileModifiedL( TInt aProfileId ) = 0;
    1.60 +
    1.61 +        /**
    1.62 +         * Error handler for handling the errors in the profile modification
    1.63 +         * notification process. If HandleProfileModifiedL() leaves,
    1.64 +         * this method is called with the leave code. This method has
    1.65 +         * default empty implementation.
    1.66 +         * @since S60 3.1
    1.67 +         * @param aError the code of the error which occurred during
    1.68 +         *        notification process.
    1.69 +         */
    1.70 +        virtual void HandleProfileNotificationError(
    1.71 +                TInt /* aError */ ) {};
    1.72 +
    1.73 +    protected:
    1.74 +
    1.75 +        /**
    1.76 +        * Destructor.
    1.77 +        */
    1.78 +        virtual ~MProEngProfileObserver() {}
    1.79 +
    1.80 +    private: // Extension interface
    1.81 +
    1.82 +        /**
    1.83 +        * This member is internal and not intended for use.
    1.84 +        */
    1.85 +        virtual MProEngProfileObserverExt* Extension() { return NULL; }
    1.86 +
    1.87 +    };
    1.88 +
    1.89 +#endif      // MPROENGPROFILEOBSERVER_H
    1.90 +
    1.91 +// End of File
    1.92 +