filemanager/GFLM/inc/MGflmItemFilter.h
changeset 0 6a9f87576119
equal deleted inserted replaced
-1:000000000000 0:6a9f87576119
       
     1 /*
       
     2 * Copyright (c) 2002-2007 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:  Defines an interface for making a custom filter to GFLM
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef MGFLMITEMFILTER_H
       
    21 #define MGFLMITEMFILTER_H
       
    22 
       
    23 
       
    24 // INCLUDES
       
    25 #include <e32def.h>
       
    26 
       
    27 
       
    28 // FORWARD DECLARATIONS
       
    29 class CGflmGroupItem;
       
    30 class CGflmDriveItem;
       
    31 
       
    32 
       
    33 // CLASS DECLARATION
       
    34 
       
    35 /**
       
    36 *  Defines an interface for making a custom filter to GFLM.
       
    37 *
       
    38 *  @lib GFLM.lib
       
    39 *  @since 2.0
       
    40 */
       
    41 class MGflmItemFilter
       
    42     {
       
    43     public: // New functions
       
    44 
       
    45         /**
       
    46         * This method is called for every item to be filtered
       
    47         * Note that the method is run in work thread space
       
    48         * @since 2.0
       
    49         * @param aItem Group item to be filtered
       
    50 		* @param aGroupId Id of the group to which the item belongs
       
    51 		* @param aDrive The drive where item is located, NULL if data is unavailable
       
    52         * @return True if item was accepted, false if not
       
    53         */
       
    54         virtual TBool FilterItemL(
       
    55             CGflmGroupItem* aItem,
       
    56             TInt aGroupId,
       
    57             CGflmDriveItem* aDrive ) = 0;
       
    58 
       
    59     };
       
    60 
       
    61 #endif      // MGFLMITEMFILTER_H
       
    62 
       
    63 // End of File