1 tfilterinformation.h |
1 // Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies). |
|
2 // All rights reserved. |
|
3 // This component and the accompanying materials are made available |
|
4 // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members |
|
5 // which accompanies this distribution, and is available |
|
6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". |
|
7 // |
|
8 // Initial Contributors: |
|
9 // Nokia Corporation - initial contribution. |
|
10 // |
|
11 // Contributors: |
|
12 // |
|
13 // Description: |
|
14 // |
|
15 |
|
16 |
|
17 |
|
18 /** |
|
19 @file TFilterInformation.h |
|
20 @warning : This file contains Rose Model ID comments - please do not delete |
|
21 */ |
|
22 |
|
23 #ifndef __TFILTERINFORMATION_H__ |
|
24 #define __TFILTERINFORMATION_H__ |
|
25 |
|
26 |
|
27 //##ModelId=3C4C37DF0343 |
|
28 struct TFilterInformation |
|
29 /** |
|
30 This structure is used by the TFilterConfigurationIterator to hold the information of the |
|
31 current filter. This structure simply contains public members containing the following |
|
32 information, the display name, data type, version, UID, category and install status. |
|
33 @publishedAll |
|
34 @released |
|
35 @see TFilterConfigurationIterator |
|
36 */ |
|
37 { |
|
38 public: |
|
39 /** |
|
40 Public enum defining the filter categories available to the client. |
|
41 */ |
|
42 enum TFilterCategory |
|
43 { |
|
44 EImplicitFilter, |
|
45 EExplicitFilter |
|
46 }; |
|
47 |
|
48 /** |
|
49 Contains a constant reference to the descriptor containing the filter's display name |
|
50 */ |
|
51 //##ModelId=3C4C37DF03A7 |
|
52 const TDesC& iDisplayName; |
|
53 |
|
54 /** |
|
55 Contains a constant reference to the descriptor containing the filter's data type |
|
56 */ |
|
57 //##ModelId=3C4C37DF039D |
|
58 const TDesC8& iDataType; |
|
59 |
|
60 /** |
|
61 The filter's version number |
|
62 */ |
|
63 //##ModelId=3C4C37DF038B |
|
64 TInt iVersion; |
|
65 |
|
66 /** |
|
67 The filter's plugin UID |
|
68 */ |
|
69 //##ModelId=3C4C37DF0381 |
|
70 TUid iFilterUid; |
|
71 |
|
72 /** |
|
73 The filter's category |
|
74 */ |
|
75 //##ModelId=3C4C37DF0375 |
|
76 TFilterCategory iFilterCategory; |
|
77 |
|
78 /** |
|
79 The install status of the filter. Contains ETrue if installed, otherwise EFalse |
|
80 */ |
|
81 //##ModelId=3C4C37DF036B |
|
82 TBool iInstallStatus; |
|
83 |
|
84 /** |
|
85 Default constructor that simply initialises the data members. |
|
86 @param aDisplayName Reference to descriptor containing the display name |
|
87 @param aDataType Reference to descriptor containing the data type |
|
88 @param aVersion Integer of the version number |
|
89 @param aFilterUid The UID of the filter plugin |
|
90 @param aFilterCategory The category of the filter |
|
91 @param aInstallStatus The install status of the filter plugin. Contains ETrue |
|
92 if installed or EFalse otherwise. |
|
93 @pre None |
|
94 @post Object is fully constructed and initialised |
|
95 */ |
|
96 //##ModelId=3C4C37DF03B1 |
|
97 inline TFilterInformation(const TDesC& aDisplayName, const TDesC8& aDataType, |
|
98 TInt aVersion, TUid aFilterUid, |
|
99 TFilterCategory aFilterCategory, TBool aInstallStatus); |
|
100 }; |
|
101 |
|
102 // Inline constructor, initialises data members |
|
103 inline TFilterInformation::TFilterInformation(const TDesC& aDisplayName, const TDesC8& aDataType, |
|
104 TInt aVersion, TUid aFilterUid, |
|
105 TFilterCategory aFilterCategory, TBool aInstallStatus) |
|
106 :iDisplayName(aDisplayName), |
|
107 iDataType(aDataType), |
|
108 iVersion(aVersion), |
|
109 iFilterUid(aFilterUid), |
|
110 iFilterCategory(aFilterCategory), |
|
111 iInstallStatus(aInstallStatus) |
|
112 { |
|
113 } |
|
114 |
|
115 #endif // __TFILTERINFORMATION_H__ |