epoc32/include/mw/mproengprofileobserver.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.
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2002-2004 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description: Profile modification observer interface.
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
williamr@2
    20
#ifndef MPROENGPROFILEOBSERVER_H
williamr@2
    21
#define MPROENGPROFILEOBSERVER_H
williamr@2
    22
williamr@2
    23
//  INCLUDES
williamr@2
    24
#include <e32def.h>
williamr@2
    25
williamr@2
    26
// FORWARD DECLARATIONS
williamr@2
    27
class MProEngProfileObserverExt;
williamr@2
    28
williamr@2
    29
// CLASS DECLARATION
williamr@2
    30
williamr@2
    31
/**
williamr@2
    32
* Profile modification observer interface.
williamr@2
    33
* Implement this interface to get notifications of changes in the data of a
williamr@2
    34
* selected profile.
williamr@2
    35
*
williamr@2
    36
*  @lib ProfileEngine.lib
williamr@2
    37
*  @since Series 60 3.1
williamr@2
    38
*/
williamr@2
    39
class MProEngProfileObserver
williamr@2
    40
    {
williamr@2
    41
    public: // New functions
williamr@2
    42
williamr@2
    43
        /**
williamr@2
    44
        * Abstract method for handling profile modification event.
williamr@2
    45
        * This method is called when one of client chosen profiles has been
williamr@2
    46
        * modified some way.
williamr@2
    47
        * @since S60 3.1
williamr@2
    48
        * @param aProfileId The ID of the profile that was modified. If there
williamr@2
    49
        * has been many simultaneous changes in Profiles data, so that one
williamr@2
    50
        * profile cannot be identified, this is KErrNotFound. In this case,
williamr@2
    51
        * client gets this notification as many times as there are profiles
williamr@2
    52
        * he has requested notifications about. The savest way is to use
williamr@2
    53
        * own handlers for every profile of interest.
williamr@2
    54
        */
williamr@2
    55
        virtual void HandleProfileModifiedL( TInt aProfileId ) = 0;
williamr@2
    56
williamr@2
    57
        /**
williamr@2
    58
         * Error handler for handling the errors in the profile modification
williamr@2
    59
         * notification process. If HandleProfileModifiedL() leaves,
williamr@2
    60
         * this method is called with the leave code. This method has
williamr@2
    61
         * default empty implementation.
williamr@2
    62
         * @since S60 3.1
williamr@2
    63
         * @param aError the code of the error which occurred during
williamr@2
    64
         *        notification process.
williamr@2
    65
         */
williamr@2
    66
        virtual void HandleProfileNotificationError(
williamr@2
    67
                TInt /* aError */ ) {};
williamr@2
    68
williamr@2
    69
    protected:
williamr@2
    70
williamr@2
    71
        /**
williamr@2
    72
        * Destructor.
williamr@2
    73
        */
williamr@2
    74
        virtual ~MProEngProfileObserver() {}
williamr@2
    75
williamr@2
    76
    private: // Extension interface
williamr@2
    77
williamr@2
    78
        /**
williamr@2
    79
        * This member is internal and not intended for use.
williamr@2
    80
        */
williamr@2
    81
        virtual MProEngProfileObserverExt* Extension() { return NULL; }
williamr@2
    82
williamr@2
    83
    };
williamr@2
    84
williamr@2
    85
#endif      // MPROENGPROFILEOBSERVER_H
williamr@2
    86
williamr@2
    87
// End of File
williamr@2
    88