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.
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* under the terms of the License "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description: 
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
/**
williamr@2
    20
 @file
williamr@4
    21
 @publishedAll
williamr@2
    22
 @released
williamr@2
    23
*/
williamr@2
    24
williamr@2
    25
#ifndef __TCTFINDTOKENTYPESBYINTERFACEANDATTRIBUTE_H__
williamr@2
    26
#define __TCTFINDTOKENTYPESBYINTERFACEANDATTRIBUTE_H__
williamr@2
    27
williamr@2
    28
#include <ct/mcttokentypefilter.h>
williamr@2
    29
williamr@2
    30
williamr@2
    31
struct TCTTokenTypeAttribute;
williamr@2
    32
williamr@2
    33
williamr@2
    34
/** 
williamr@2
    35
 * A filter that returns only those token types that match the required set of 
williamr@2
    36
 * interfaces and attributes.
williamr@2
    37
 * 
williamr@2
    38
 * On construction, an array containing the required interfaces and an array 
williamr@2
    39
 * of required attributes/values is passed in.
williamr@2
    40
 * 
williamr@2
    41
 * Token types will be matched if every interface in the supplied array is supported 
williamr@2
    42
 * by the token type, and every attribute is defined and has the same value. 
williamr@2
    43
 *
williamr@2
    44
 * @since v7.0 
williamr@2
    45
 */
williamr@2
    46
class TCTFindTokenTypesByInterfaceAndAttribute : public MCTTokenTypeFilter
williamr@2
    47
	{
williamr@2
    48
 public:
williamr@2
    49
	/** 
williamr@2
    50
	 * Constructor.
williamr@2
    51
	 *	
williamr@2
    52
	 * @param aInterfaces	An array of Uids corresponding to the interfaces that the 
williamr@2
    53
	 * 						token type must support.
williamr@2
    54
	 * @param aAttributes	An array of the attributes and values that must be defined 
williamr@2
    55
 	 * 						for the token type. 
williamr@2
    56
 	 */
williamr@2
    57
	IMPORT_C TCTFindTokenTypesByInterfaceAndAttribute(const TArray<TUid> aInterfaces,
williamr@2
    58
													  const TArray<TCTTokenTypeAttribute> aAttributes);
williamr@2
    59
williamr@2
    60
	/** 
williamr@2
    61
	 * Tests whether all the interfaces and attributes associated with the filter 
williamr@2
    62
	 * are supported by the token type.
williamr@2
    63
	 *
williamr@2
    64
	 * @param aTokenType	The token type to be tested.
williamr@2
    65
	 * @return				ETrue if all the interfaces and attributes associated with the  
williamr@2
    66
	 * 						filter are supported by the token type; EFalse, otherwise. 
williamr@2
    67
	 */
williamr@2
    68
	virtual TBool Accept(const CCTTokenTypeInfo& aTokenType) const;
williamr@2
    69
williamr@2
    70
 private:
williamr@2
    71
	const TArray<TUid> iInterfaces;
williamr@2
    72
	const TArray<TCTTokenTypeAttribute> iAttributes;
williamr@2
    73
	};
williamr@2
    74
williamr@2
    75
williamr@2
    76
#endif // __TCTFINDTOKENTYPESBYINTERFACEANDATTRIBUTE_H__