uifw/EikStd/coctlinc/akncollectionobserver.h
changeset 0 2f259fa3e83a
equal deleted inserted replaced
-1:000000000000 0:2f259fa3e83a
       
     1 /*
       
     2 * Copyright (c) 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:  Collection observer interface.
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef M_AKNCOLLECTIONOBSERVER_H
       
    19 #define M_AKNCOLLECTIONOBSERVER_H
       
    20 
       
    21 class CAknItemActionMenu;
       
    22 
       
    23 /**
       
    24  * Collection observer.
       
    25  *
       
    26  * This interface is intended for those objects that are interested
       
    27  * of collection state and need to receive collection notifications.
       
    28  *
       
    29  * @lib eikcoctl
       
    30  * @since S60 v5.2
       
    31  */
       
    32 class MAknCollectionObserver
       
    33     {
       
    34 public:
       
    35 
       
    36     /**
       
    37      * This method is used to set the item action menu to observer.
       
    38      * 
       
    39      * @param aItemActionMenu Item action menu. 
       
    40      */
       
    41     virtual void SetItemActionMenu( CAknItemActionMenu* aItemActionMenu ) = 0;
       
    42 
       
    43     /**
       
    44      * This method is called when there are changes in collection state.
       
    45      * 
       
    46      * @param aCollectionVisible ETrue if changed collection is visible.
       
    47      */
       
    48     virtual void CollectionChanged( TBool aCollectionVisible ) = 0;
       
    49 
       
    50     /**
       
    51      * This method returns ETrue if collection observer is active.
       
    52      * 
       
    53      * @return ETrue if observer is active.
       
    54      */
       
    55     virtual TBool Active() const = 0;
       
    56 
       
    57     };
       
    58 
       
    59 #endif // M_AKNCOLLECTIONOBSERVER_H