epoc32/include/mw/mclfoperationobserver.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files

/*
* Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies). 
* All rights reserved.
* This component and the accompanying materials are made available
* 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
* which accompanies this distribution, and is available
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description: 
*
*/


#ifndef MCLFOPERATIONOBSERVER_H
#define MCLFOPERATIONOBSERVER_H

//  INCLUDES
#include <e32def.h>

// DATA TYPES
/**
* Content Listing Framework list model operation events
*/
enum TCLFOperationEvent
    {
    /// Refresh operation is completed
    ECLFRefreshComplete = 0x0,
    /// Model content is obsolated and should be refreshed
    ECLFModelOutdated = 0x1
    };

// FORWARD DECLARATIONS
class MCLFOperationObserverExt;

// CLASS DECLARATION

/**
*  Operation Observer is for observing operation events of the Content Listing
*  Framework. Client application gets notified when asynchronous operations
*  are completed. For example, ECLFRefreshComplete event is received when the
*  asynchronous refresh operation is compeleted.
*
*  @lib ContentListingFramework.lib
*  @since S60 3.1
*/
class MCLFOperationObserver
    {
    public: // New functions

        /**
        * Abstract method to get list model operation events. This method is
        * called when an event is received.
        * @since S60 3.1
        * @param aOperationEvent Operation event code of the event
        * @param aError System wide error code if the operation did not
        *        succeed.
        */
        virtual void HandleOperationEventL( TCLFOperationEvent aOperationEvent,
                                            TInt aError ) = 0;

    protected:

        /**
        * Destructor.
        */
        virtual ~MCLFOperationObserver() {}

    private: // Extension interface

        /**
        * This member is internal and not intended for use.
        */
        virtual MCLFOperationObserverExt* Extension() { return NULL; }


    };

#endif      // MCLFOPERATIONOBSERVER_H

// End of File