|
1 /* |
|
2 * Copyright (c) 2007-2008 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 "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 #ifndef C_HNMDMAPKEY_H |
|
21 #define C_HNMDMAPKEY_H |
|
22 |
|
23 #include <liwcommon.h> |
|
24 #include <e32base.h> |
|
25 |
|
26 #include "hnmdbasekey.h" |
|
27 |
|
28 /** |
|
29 * Defines particular key type which is LIW map. |
|
30 * |
|
31 * @lib hierarchynavigatorengine |
|
32 * @since S60 v5.0 |
|
33 * @ingroup group_hnutilities |
|
34 */ |
|
35 NONSHARABLE_CLASS( CHnMdMapKey ) : public CHnMdBaseKey |
|
36 { |
|
37 friend class HnMdKeyFactory; |
|
38 |
|
39 public: |
|
40 |
|
41 /** |
|
42 * Standard factory method. |
|
43 * |
|
44 * @since S60 v5.0 |
|
45 * @return Fully constructed object. |
|
46 */ |
|
47 static CHnMdMapKey* NewL(); |
|
48 |
|
49 /** |
|
50 * Standard factory method. |
|
51 * |
|
52 * @since S60 v5.0 |
|
53 * @return Fully constructed object. |
|
54 */ |
|
55 static CHnMdMapKey* NewLC(); |
|
56 |
|
57 /** |
|
58 * Standard factory method. |
|
59 * |
|
60 * @since S60 v5.0 |
|
61 * @param aKey Reference key. |
|
62 * @return Fully constructed object. |
|
63 */ |
|
64 static CHnMdMapKey* NewL( const CHnMdMapKey* aKey ); |
|
65 |
|
66 /** |
|
67 * Standard factory method. |
|
68 * |
|
69 * @since S60 v5.0 |
|
70 * @param aKey Reference key. |
|
71 * @return Fully constructed object. |
|
72 */ |
|
73 static CHnMdMapKey* NewLC( const CHnMdMapKey* aKey ); |
|
74 |
|
75 /** |
|
76 * Factory method. |
|
77 * |
|
78 * since S60 v5.0 |
|
79 * @return Fully constructed object. |
|
80 */ |
|
81 virtual CHnMdBaseKey* CopyLC(); |
|
82 |
|
83 /** |
|
84 * Standard destructor. |
|
85 * |
|
86 * @since S60 v5.0 |
|
87 */ |
|
88 virtual ~CHnMdMapKey(); |
|
89 |
|
90 /** |
|
91 * Change to variant. |
|
92 * |
|
93 * @since S60 v5.0 |
|
94 * @param aRet Output variant. |
|
95 */ |
|
96 virtual void ToVariantL( TLiwVariant& aRet ) const; |
|
97 |
|
98 protected: |
|
99 |
|
100 /** |
|
101 * Standard constructor. |
|
102 * |
|
103 * @since S60 v5.0 |
|
104 */ |
|
105 CHnMdMapKey(); |
|
106 |
|
107 /** |
|
108 * Symbian constructor for performing 2nd stage construction. |
|
109 * |
|
110 * @since S60 v5.0 |
|
111 */ |
|
112 void ConstructL(); |
|
113 |
|
114 /** |
|
115 * Symbian constructor for performing 2nd stage construction. |
|
116 * |
|
117 * @since S60 v5.0 |
|
118 * @param aKey Reference key. |
|
119 */ |
|
120 void ConstructL( const CHnMdMapKey* aKey ); |
|
121 |
|
122 /** |
|
123 * Evaluates the key value. |
|
124 * |
|
125 * @since S60 v5.0 |
|
126 * @param aParamList List of parameters. |
|
127 * @param aPos Position in the param list. Default is 0. |
|
128 */ |
|
129 void EvaluateKeyValueL( const CLiwGenericParamList& aParamList, |
|
130 TInt aPos ); |
|
131 |
|
132 private: |
|
133 |
|
134 /** |
|
135 * Variant. |
|
136 */ |
|
137 TLiwVariant iVariantContent; |
|
138 |
|
139 }; |
|
140 |
|
141 #endif // C_HNMDMAPKEY_H |