epoc32/include/mw/mproengprofilenamearrayobserver.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 name array modification observer interface.
    15 *
    16 */
    17 
    18 
    19 
    20 #ifndef MPROENGPROFILENAMEARRAYOBSERVER_H
    21 #define MPROENGPROFILENAMEARRAYOBSERVER_H
    22 
    23 //  INCLUDES
    24 #include <e32def.h>
    25 
    26 // FORWARD DECLARATIONS
    27 class MProEngProfileNameArrayObserverExt;
    28 
    29 // CLASS DECLARATION
    30 
    31 /**
    32 * Profile name array 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 MProEngProfileNameArrayObserver
    40     {
    41     public: // New functions
    42 
    43         /**
    44         * Abstract method for handling profile name array modification event.
    45         * This method is called when the contents of profile name array is
    46         * changed some way. These cases include:
    47         * - a profile has been created,
    48         * - a profile has been deleted,
    49         * - the name of a profile has been changed.
    50         * Note, that when there has been many simultaneous changes in Profiles
    51         * data so that it cannot be identified what has changed, then this
    52         * method may be called even if nothing hasn't actually changed in the
    53         * name array content.
    54         * @since S60 3.1
    55         */
    56         virtual void HandleProfileNameArrayModificationL() = 0;
    57 
    58         /**
    59          * Error handler for handling the errors in the profile name array
    60          * modification notification process.
    61          * If HandleProfileNameArrayModificationL() leaves, this method is
    62          * called with the leave code. This method has default empty
    63          * implementation.
    64          * @since S60 3.1
    65          * @param aError the code of the error which occurred during
    66          *        notification process.
    67          */
    68         virtual void HandleProfileNameArrayNotificationError(
    69                 TInt /* aError */ ) {};
    70 
    71     protected:
    72 
    73         /**
    74         * Destructor.
    75         */
    76         virtual ~MProEngProfileNameArrayObserver() {}
    77 
    78     private: // Extension interface
    79 
    80         /**
    81         * This member is internal and not intended for use.
    82         */
    83         virtual MProEngProfileNameArrayObserverExt* Extension() { return NULL; }
    84 
    85     };
    86 
    87 #endif      // MPROENGPROFILENAMEARRAYOBSERVER_H
    88 
    89 // End of File
    90