epoc32/include/mw/mclfoperationobserver.h
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
     1.1 --- a/epoc32/include/mw/mclfoperationobserver.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/mclfoperationobserver.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,85 @@
     1.4 -mclfoperationobserver.h
     1.5 +/*
     1.6 +* Copyright (c) 2002-2009 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: 
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +#ifndef MCLFOPERATIONOBSERVER_H
    1.24 +#define MCLFOPERATIONOBSERVER_H
    1.25 +
    1.26 +//  INCLUDES
    1.27 +#include <e32def.h>
    1.28 +
    1.29 +// DATA TYPES
    1.30 +/**
    1.31 +* Content Listing Framework list model operation events
    1.32 +*/
    1.33 +enum TCLFOperationEvent
    1.34 +    {
    1.35 +    /// Refresh operation is completed
    1.36 +    ECLFRefreshComplete = 0x0,
    1.37 +    /// Model content is obsolated and should be refreshed
    1.38 +    ECLFModelOutdated = 0x1
    1.39 +    };
    1.40 +
    1.41 +// FORWARD DECLARATIONS
    1.42 +class MCLFOperationObserverExt;
    1.43 +
    1.44 +// CLASS DECLARATION
    1.45 +
    1.46 +/**
    1.47 +*  Operation Observer is for observing operation events of the Content Listing
    1.48 +*  Framework. Client application gets notified when asynchronous operations
    1.49 +*  are completed. For example, ECLFRefreshComplete event is received when the
    1.50 +*  asynchronous refresh operation is compeleted.
    1.51 +*
    1.52 +*  @lib ContentListingFramework.lib
    1.53 +*  @since S60 3.1
    1.54 +*/
    1.55 +class MCLFOperationObserver
    1.56 +    {
    1.57 +    public: // New functions
    1.58 +
    1.59 +        /**
    1.60 +        * Abstract method to get list model operation events. This method is
    1.61 +        * called when an event is received.
    1.62 +        * @since S60 3.1
    1.63 +        * @param aOperationEvent Operation event code of the event
    1.64 +        * @param aError System wide error code if the operation did not
    1.65 +        *        succeed.
    1.66 +        */
    1.67 +        virtual void HandleOperationEventL( TCLFOperationEvent aOperationEvent,
    1.68 +                                            TInt aError ) = 0;
    1.69 +
    1.70 +    protected:
    1.71 +
    1.72 +        /**
    1.73 +        * Destructor.
    1.74 +        */
    1.75 +        virtual ~MCLFOperationObserver() {}
    1.76 +
    1.77 +    private: // Extension interface
    1.78 +
    1.79 +        /**
    1.80 +        * This member is internal and not intended for use.
    1.81 +        */
    1.82 +        virtual MCLFOperationObserverExt* Extension() { return NULL; }
    1.83 +
    1.84 +
    1.85 +    };
    1.86 +
    1.87 +#endif      // MCLFOPERATIONOBSERVER_H
    1.88 +
    1.89 +// End of File