menucontentsrv/enginc/menuengfilter.h
changeset 0 79c6a41cd166
equal deleted inserted replaced
-1:000000000000 0:79c6a41cd166
       
     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:
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef __MENUENGFILTER_H__
       
    19 #define __MENUENGFILTER_H__
       
    20 
       
    21 // INCLUDES
       
    22 
       
    23 #include <e32base.h>
       
    24 
       
    25 // FORWARD DECLARATION
       
    26 
       
    27 class CMenuEngObject;
       
    28 
       
    29 // CLASS DECLARATION
       
    30 
       
    31 /**
       
    32 * Menu Engine Filter interface.
       
    33 * Instances of this filter can be passed to CMenuEng::GetItemsL(), to get
       
    34 * a filtered list of menu items.
       
    35 */
       
    36 NONSHARABLE_CLASS( MMenuEngFilter )
       
    37     {
       
    38 
       
    39 public:     // new methods
       
    40 
       
    41     /**
       
    42     * Filter test function.
       
    43     * @param aObject Object.
       
    44     * @return ETrue if aObject matches this filter.
       
    45     */
       
    46     virtual TBool MatchesObject( const CMenuEngObject& aObject ) const = 0;
       
    47 
       
    48     };
       
    49 
       
    50 #endif // __MENUENGFILTER_H__