williamr@2: /*
williamr@2: * Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@2: * under the terms of the License "Eclipse Public License v1.0"
williamr@2: * which accompanies this distribution, and is available
williamr@2: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description: 
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: /**
williamr@2:  @file
williamr@4:  @publishedAll
williamr@2:  @released
williamr@2: */
williamr@2: 
williamr@2: #ifndef __CCTTOKENTYPEINFO_H__
williamr@2: #define __CCTTOKENTYPEINFO_H__
williamr@2: 
williamr@2: #include <ct/tctalltokentypes.h>
williamr@2: #include <ct/tcttokentypeattribute.h>
williamr@2: #include <ct/rcpointerarray.h>
williamr@2: class CImplementationInformation;
williamr@2: 
williamr@2: 
williamr@2: /** 
williamr@2:  * Information about a token type.
williamr@2:  *
williamr@2:  * A list of CCTTokenTypeInfo objects can be obtained using the static ListL() 
williamr@2:  * functions. Each CCTTokenTypeInfo object has a list of interfaces it supports, 
williamr@2:  * a list of TCTTokenTypeAttribute objects associated with it, and a label. Based 
williamr@2:  * on this, the client (or the user via a UI) can chose the required token type 
williamr@2:  * and load it via CCTTokenType::NewL(). 
williamr@2:  * 
williamr@2:  * @since v7.0 
williamr@2:  */
williamr@2: class CCTTokenTypeInfo : public CBase
williamr@2: 	{
williamr@2:  public:
williamr@2: 	
williamr@2: 	/** 
williamr@2: 	 * Lists all the CCTTokenTypeInfo objects that match the filter expression.
williamr@2: 	 *
williamr@2: 	 * This is the only way of creating CCTTokenTypeInfo objects. 
williamr@2:  	 *
williamr@2: 	 * @param aTokenTypes	An array to which the found token types will be appended. 
williamr@2: 	 * 						Ownership of the CCTTokenTypeInfo objects, whose pointers 
williamr@2: 	 *						are held by the array, are transferred to the caller.
williamr@2: 	 * @param aFilter		An object that is used to filter tokens, by being offered each 
williamr@2: 	 *						token in turn and declining the ones that are not required. 
williamr@2: 	 */
williamr@2: 	IMPORT_C static void ListL(RCPointerArray<CCTTokenTypeInfo>& aTokenTypes,
williamr@2: 							  const MCTTokenTypeFilter& aFilter);
williamr@2: 
williamr@2: 	/** 
williamr@2: 	 * Lists all the CCTTokenTypeInfo objects.
williamr@2: 	 *
williamr@2: 	 * This version does not take a filter, but returns all token types.
williamr@2: 	 *
williamr@2: 	 * @param aTokenTypes	An array to which the found token types will be appended. 
williamr@2: 	 * 						Ownership of the CCTTokenTypeInfo objects, whose pointers 
williamr@2: 	 *						are held by the array, are transferred to the caller. 
williamr@2: 	 */
williamr@2: 	IMPORT_C static void ListL(RCPointerArray<CCTTokenTypeInfo>& aTokenTypes);
williamr@2: 	
williamr@2: 	/** 
williamr@2: 	 * Destructor.
williamr@2: 	 *
williamr@2: 	 * Frees all resources owned by the object. 
williamr@4: 	 * @internalComponent
williamr@2: 	 */
williamr@2: 	~CCTTokenTypeInfo();
williamr@2: 
williamr@2: 	/** 
williamr@2: 	 * Gets a list of all interfaces supported by this token type.
williamr@2: 	 *
williamr@2: 	 * @return	A list of all the interfaces supported by this token type. 
williamr@2: 	 */
williamr@2: 	IMPORT_C const RArray<TUid>& Interfaces() const;
williamr@2: 
williamr@2: 	/** 
williamr@2: 	 * Gets a list of all attributes of this token type.
williamr@2: 	 *
williamr@2: 	 * @return	A list of all attributes of this token type. 
williamr@2: 	 */
williamr@2: 	IMPORT_C const RArray<TCTTokenTypeAttribute>& Attributes() const;
williamr@2: 
williamr@2: 	/** 
williamr@2: 	 * Gets a human-readable name for the token type.
williamr@2: 	 *
williamr@2: 	 * @return	A human-readable name for the token type. 
williamr@2: 	 */
williamr@2: 	IMPORT_C const TDesC& Label() const;
williamr@2: 
williamr@2: 	/** 
williamr@2: 	 * Gets the UID of this token type.
williamr@2: 	 *
williamr@2: 	 * @return	The UID of this token type. 
williamr@2: 	 */
williamr@2: 	IMPORT_C TUid Type() const;
williamr@2: 
williamr@2:  private:
williamr@2: 	/** Constructor */
williamr@2: 	CCTTokenTypeInfo(CImplementationInformation* aEcomImplementationInfo);
williamr@2: 
williamr@2:  private:
williamr@2: 	CImplementationInformation* iEcomImplementationInfo;
williamr@2: 	RArray<TUid> iInterfaces;
williamr@2: 	RArray<TCTTokenTypeAttribute> iAttributes;
williamr@2: 	};
williamr@2: 
williamr@2: #endif // __CCTTOKENTYPEINFO_H__