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
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* 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
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description: 
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
#ifndef MCLFOPERATIONOBSERVER_H
williamr@2
    20
#define MCLFOPERATIONOBSERVER_H
williamr@2
    21
williamr@2
    22
//  INCLUDES
williamr@2
    23
#include <e32def.h>
williamr@2
    24
williamr@2
    25
// DATA TYPES
williamr@2
    26
/**
williamr@2
    27
* Content Listing Framework list model operation events
williamr@2
    28
*/
williamr@2
    29
enum TCLFOperationEvent
williamr@2
    30
    {
williamr@2
    31
    /// Refresh operation is completed
williamr@2
    32
    ECLFRefreshComplete = 0x0,
williamr@2
    33
    /// Model content is obsolated and should be refreshed
williamr@2
    34
    ECLFModelOutdated = 0x1
williamr@2
    35
    };
williamr@2
    36
williamr@2
    37
// FORWARD DECLARATIONS
williamr@2
    38
class MCLFOperationObserverExt;
williamr@2
    39
williamr@2
    40
// CLASS DECLARATION
williamr@2
    41
williamr@2
    42
/**
williamr@2
    43
*  Operation Observer is for observing operation events of the Content Listing
williamr@2
    44
*  Framework. Client application gets notified when asynchronous operations
williamr@2
    45
*  are completed. For example, ECLFRefreshComplete event is received when the
williamr@2
    46
*  asynchronous refresh operation is compeleted.
williamr@2
    47
*
williamr@2
    48
*  @lib ContentListingFramework.lib
williamr@2
    49
*  @since S60 3.1
williamr@2
    50
*/
williamr@2
    51
class MCLFOperationObserver
williamr@2
    52
    {
williamr@2
    53
    public: // New functions
williamr@2
    54
williamr@2
    55
        /**
williamr@2
    56
        * Abstract method to get list model operation events. This method is
williamr@2
    57
        * called when an event is received.
williamr@2
    58
        * @since S60 3.1
williamr@2
    59
        * @param aOperationEvent Operation event code of the event
williamr@2
    60
        * @param aError System wide error code if the operation did not
williamr@2
    61
        *        succeed.
williamr@2
    62
        */
williamr@2
    63
        virtual void HandleOperationEventL( TCLFOperationEvent aOperationEvent,
williamr@2
    64
                                            TInt aError ) = 0;
williamr@2
    65
williamr@2
    66
    protected:
williamr@2
    67
williamr@2
    68
        /**
williamr@2
    69
        * Destructor.
williamr@2
    70
        */
williamr@2
    71
        virtual ~MCLFOperationObserver() {}
williamr@2
    72
williamr@2
    73
    private: // Extension interface
williamr@2
    74
williamr@2
    75
        /**
williamr@2
    76
        * This member is internal and not intended for use.
williamr@2
    77
        */
williamr@2
    78
        virtual MCLFOperationObserverExt* Extension() { return NULL; }
williamr@2
    79
williamr@2
    80
williamr@2
    81
    };
williamr@2
    82
williamr@2
    83
#endif      // MCLFOPERATIONOBSERVER_H
williamr@2
    84
williamr@2
    85
// End of File