1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/ct/ccttokentypeinfo.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -0,0 +1,122 @@
1.4 +/*
1.5 +* Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* All rights reserved.
1.7 +* This component and the accompanying materials are made available
1.8 +* under the terms of the License "Eclipse Public License v1.0"
1.9 +* which accompanies this distribution, and is available
1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.11 +*
1.12 +* Initial Contributors:
1.13 +* Nokia Corporation - initial contribution.
1.14 +*
1.15 +* Contributors:
1.16 +*
1.17 +* Description:
1.18 +*
1.19 +*/
1.20 +
1.21 +
1.22 +
1.23 +
1.24 +/**
1.25 + @file
1.26 + @publishedPartner
1.27 + @released
1.28 +*/
1.29 +
1.30 +#ifndef __CCTTOKENTYPEINFO_H__
1.31 +#define __CCTTOKENTYPEINFO_H__
1.32 +
1.33 +#include <ct/tctalltokentypes.h>
1.34 +#include <ct/tcttokentypeattribute.h>
1.35 +#include <ct/rcpointerarray.h>
1.36 +class CImplementationInformation;
1.37 +
1.38 +
1.39 +/**
1.40 + * Information about a token type.
1.41 + *
1.42 + * A list of CCTTokenTypeInfo objects can be obtained using the static ListL()
1.43 + * functions. Each CCTTokenTypeInfo object has a list of interfaces it supports,
1.44 + * a list of TCTTokenTypeAttribute objects associated with it, and a label. Based
1.45 + * on this, the client (or the user via a UI) can chose the required token type
1.46 + * and load it via CCTTokenType::NewL().
1.47 + *
1.48 + * @since v7.0
1.49 + */
1.50 +class CCTTokenTypeInfo : public CBase
1.51 + {
1.52 + public:
1.53 +
1.54 + /**
1.55 + * Lists all the CCTTokenTypeInfo objects that match the filter expression.
1.56 + *
1.57 + * This is the only way of creating CCTTokenTypeInfo objects.
1.58 + *
1.59 + * @param aTokenTypes An array to which the found token types will be appended.
1.60 + * Ownership of the CCTTokenTypeInfo objects, whose pointers
1.61 + * are held by the array, are transferred to the caller.
1.62 + * @param aFilter An object that is used to filter tokens, by being offered each
1.63 + * token in turn and declining the ones that are not required.
1.64 + */
1.65 + IMPORT_C static void ListL(RCPointerArray<CCTTokenTypeInfo>& aTokenTypes,
1.66 + const MCTTokenTypeFilter& aFilter);
1.67 +
1.68 + /**
1.69 + * Lists all the CCTTokenTypeInfo objects.
1.70 + *
1.71 + * This version does not take a filter, but returns all token types.
1.72 + *
1.73 + * @param aTokenTypes An array to which the found token types will be appended.
1.74 + * Ownership of the CCTTokenTypeInfo objects, whose pointers
1.75 + * are held by the array, are transferred to the caller.
1.76 + */
1.77 + IMPORT_C static void ListL(RCPointerArray<CCTTokenTypeInfo>& aTokenTypes);
1.78 +
1.79 + /**
1.80 + * Destructor.
1.81 + *
1.82 + * Frees all resources owned by the object.
1.83 + * @internalAll
1.84 + */
1.85 + ~CCTTokenTypeInfo();
1.86 +
1.87 + /**
1.88 + * Gets a list of all interfaces supported by this token type.
1.89 + *
1.90 + * @return A list of all the interfaces supported by this token type.
1.91 + */
1.92 + IMPORT_C const RArray<TUid>& Interfaces() const;
1.93 +
1.94 + /**
1.95 + * Gets a list of all attributes of this token type.
1.96 + *
1.97 + * @return A list of all attributes of this token type.
1.98 + */
1.99 + IMPORT_C const RArray<TCTTokenTypeAttribute>& Attributes() const;
1.100 +
1.101 + /**
1.102 + * Gets a human-readable name for the token type.
1.103 + *
1.104 + * @return A human-readable name for the token type.
1.105 + */
1.106 + IMPORT_C const TDesC& Label() const;
1.107 +
1.108 + /**
1.109 + * Gets the UID of this token type.
1.110 + *
1.111 + * @return The UID of this token type.
1.112 + */
1.113 + IMPORT_C TUid Type() const;
1.114 +
1.115 + private:
1.116 + /** Constructor */
1.117 + CCTTokenTypeInfo(CImplementationInformation* aEcomImplementationInfo);
1.118 +
1.119 + private:
1.120 + CImplementationInformation* iEcomImplementationInfo;
1.121 + RArray<TUid> iInterfaces;
1.122 + RArray<TCTTokenTypeAttribute> iAttributes;
1.123 + };
1.124 +
1.125 +#endif // __CCTTOKENTYPEINFO_H__