mds_pub/content_listing_framework_api/inc/MCLFProcessObserver.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 MCLFPROCESSOBSERVER_H
       
    20 #define MCLFPROCESSOBSERVER_H
       
    21 
       
    22 //  INCLUDES
       
    23 #include <e32std.h>
       
    24 
       
    25 // DATA TYPES
       
    26 /**
       
    27 * Content Listing Framework process events
       
    28 */
       
    29 enum TCLFProcessEvent
       
    30     {
       
    31     /// CLF server starts update process
       
    32     ECLFUpdateStart = 0x0,
       
    33     /// CLF server update process is end
       
    34     ECLFUpdateStop = 0x1
       
    35     };
       
    36 
       
    37 // FORWARD DECLARATIONS
       
    38 class MCLFProcessObserverExt;
       
    39 
       
    40 // CLASS DECLARATION
       
    41 
       
    42 /**
       
    43 *  Process observer interface for Content Listing Framework.
       
    44 *  Implement this interface to get notified of process events. These process
       
    45 *  events are generated when update process of CLF server is started
       
    46 *  and finished.
       
    47 *
       
    48 *  @lib ContentListingFramework.lib
       
    49 *  @since S60 3.1
       
    50 */
       
    51 class MCLFProcessObserver
       
    52     {
       
    53     public: // New functions
       
    54 
       
    55         /**
       
    56         * Abstract method to handle CLF process event. This method is called
       
    57         * when process events are generated.
       
    58         * @since S60 3.1
       
    59         * @param aProcessEvent The process event that was generated.
       
    60         */
       
    61         virtual void HandleCLFProcessEventL( TCLFProcessEvent aProcessEvent ) = 0;
       
    62 
       
    63     protected:
       
    64 
       
    65         /**
       
    66         * Destructor.
       
    67         */
       
    68         virtual ~MCLFProcessObserver() {}
       
    69 
       
    70     private: // Extension interface
       
    71 
       
    72         /**
       
    73         * This member is internal and not intended for use.
       
    74         */
       
    75         virtual MCLFProcessObserverExt* Extension() { return NULL; }
       
    76 
       
    77     };
       
    78 
       
    79 #endif      // MCLFProcessObserver_H
       
    80 
       
    81 // End of File