epoc32/include/ct/mcttokentypefilter.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h) This is the epoc32/include tree with the "platform" subtrees removed, and all but a selected few mbg and rsg files removed.

/*
* Copyright (c) 2001-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 "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description: 
*
*/


/**
 @file
 @publishedAll
 @released    
*/
 
#ifndef __MCTTOKENTYPEFILTER_H__
#define __MCTTOKENTYPEFILTER_H__

class CCTTokenTypeInfo;


/** 
 * A filter that is used to control which token types appear in a list returned 
 * by CCTTokenTypeInfo::ListL().
 * 
 * Each possible token type is offered to the filter in turn, which returns ETrue 
 * if it is to be included. 
 * 
 * For most clients one of the following three defined subclasses will do what is wanted:
 * @li	TCTAllTokenTypes --							returns everything
 * @li	TCTFindTokenTypesByInterface --				finds token types that support all of 
 * 													a supplied set of interfaces
 * @li TCTFindTokenTypesByInterfaceAndAttribute --	finds token types that match a particular 
 * 													list of interfaces, and a particular set of 
 * 													attribute/value pairs.
 * 
 * Clients wanting more unusual matching criteria may need to write their own subclasses. 
 *
 * @since v7.0 
 */
class MCTTokenTypeFilter
	{
 public:
	/** 
	 * Tests whether the supplied token type should be included in the list.
	 *
	 * @param aTokenType	The token type to be tested.
	 * @return				ETrue, if the supplied token type should be included in the list; EFalse, otherwise. 
	 */
	virtual TBool Accept(const CCTTokenTypeInfo& aTokenType) const = 0;
	};

#endif // __MCTTOKENTYPEFILTER_H__