epoc32/include/ct/tctfindtokentypesbyinterfaceandattribute.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.
     1 /*
     2 * Copyright (c) 2001-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 the License "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 
    19 /**
    20  @file
    21  @publishedAll
    22  @released
    23 */
    24 
    25 #ifndef __TCTFINDTOKENTYPESBYINTERFACEANDATTRIBUTE_H__
    26 #define __TCTFINDTOKENTYPESBYINTERFACEANDATTRIBUTE_H__
    27 
    28 #include <ct/mcttokentypefilter.h>
    29 
    30 
    31 struct TCTTokenTypeAttribute;
    32 
    33 
    34 /** 
    35  * A filter that returns only those token types that match the required set of 
    36  * interfaces and attributes.
    37  * 
    38  * On construction, an array containing the required interfaces and an array 
    39  * of required attributes/values is passed in.
    40  * 
    41  * Token types will be matched if every interface in the supplied array is supported 
    42  * by the token type, and every attribute is defined and has the same value. 
    43  *
    44  * @since v7.0 
    45  */
    46 class TCTFindTokenTypesByInterfaceAndAttribute : public MCTTokenTypeFilter
    47 	{
    48  public:
    49 	/** 
    50 	 * Constructor.
    51 	 *	
    52 	 * @param aInterfaces	An array of Uids corresponding to the interfaces that the 
    53 	 * 						token type must support.
    54 	 * @param aAttributes	An array of the attributes and values that must be defined 
    55  	 * 						for the token type. 
    56  	 */
    57 	IMPORT_C TCTFindTokenTypesByInterfaceAndAttribute(const TArray<TUid> aInterfaces,
    58 													  const TArray<TCTTokenTypeAttribute> aAttributes);
    59 
    60 	/** 
    61 	 * Tests whether all the interfaces and attributes associated with the filter 
    62 	 * are supported by the token type.
    63 	 *
    64 	 * @param aTokenType	The token type to be tested.
    65 	 * @return				ETrue if all the interfaces and attributes associated with the  
    66 	 * 						filter are supported by the token type; EFalse, otherwise. 
    67 	 */
    68 	virtual TBool Accept(const CCTTokenTypeInfo& aTokenType) const;
    69 
    70  private:
    71 	const TArray<TUid> iInterfaces;
    72 	const TArray<TCTTokenTypeAttribute> iAttributes;
    73 	};
    74 
    75 
    76 #endif // __TCTFINDTOKENTYPESBYINTERFACEANDATTRIBUTE_H__