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