mds_pub/content_listing_framework_api/inc/MCLFOperationObserver.h
changeset 0 c53acadfccc6
equal deleted inserted replaced
-1:000000000000 0:c53acadfccc6
       
     1 /*
       
     2 * Copyright (c) 2002-2009 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: 
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef MCLFOPERATIONOBSERVER_H
       
    20 #define MCLFOPERATIONOBSERVER_H
       
    21 
       
    22 //  INCLUDES
       
    23 #include <e32def.h>
       
    24 
       
    25 // DATA TYPES
       
    26 /**
       
    27 * Content Listing Framework list model operation events
       
    28 */
       
    29 enum TCLFOperationEvent
       
    30     {
       
    31     /// Refresh operation is completed
       
    32     ECLFRefreshComplete = 0x0,
       
    33     /// Model content is obsolated and should be refreshed
       
    34     ECLFModelOutdated = 0x1
       
    35     };
       
    36 
       
    37 // FORWARD DECLARATIONS
       
    38 class MCLFOperationObserverExt;
       
    39 
       
    40 // CLASS DECLARATION
       
    41 
       
    42 /**
       
    43 *  Operation Observer is for observing operation events of the Content Listing
       
    44 *  Framework. Client application gets notified when asynchronous operations
       
    45 *  are completed. For example, ECLFRefreshComplete event is received when the
       
    46 *  asynchronous refresh operation is compeleted.
       
    47 *
       
    48 *  @lib ContentListingFramework.lib
       
    49 *  @since S60 3.1
       
    50 */
       
    51 class MCLFOperationObserver
       
    52     {
       
    53     public: // New functions
       
    54 
       
    55         /**
       
    56         * Abstract method to get list model operation events. This method is
       
    57         * called when an event is received.
       
    58         * @since S60 3.1
       
    59         * @param aOperationEvent Operation event code of the event
       
    60         * @param aError System wide error code if the operation did not
       
    61         *        succeed.
       
    62         */
       
    63         virtual void HandleOperationEventL( TCLFOperationEvent aOperationEvent,
       
    64                                             TInt aError ) = 0;
       
    65 
       
    66     protected:
       
    67 
       
    68         /**
       
    69         * Destructor.
       
    70         */
       
    71         virtual ~MCLFOperationObserver() {}
       
    72 
       
    73     private: // Extension interface
       
    74 
       
    75         /**
       
    76         * This member is internal and not intended for use.
       
    77         */
       
    78         virtual MCLFOperationObserverExt* Extension() { return NULL; }
       
    79 
       
    80 
       
    81     };
       
    82 
       
    83 #endif      // MCLFOPERATIONOBSERVER_H
       
    84 
       
    85 // End of File