|
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 #ifndef C_HNMDUIDKEY_H |
|
20 #define C_HNMDUIDKEY_H |
|
21 |
|
22 #include <e32base.h> |
|
23 |
|
24 #include "hnmdbasekey.h" |
|
25 |
|
26 /** |
|
27 * Defines particular key type which is UID. |
|
28 * |
|
29 * @lib hierarchynavigatorengine |
|
30 * @since S60 v5.0 |
|
31 */ |
|
32 NONSHARABLE_CLASS( CHnMdUidKey ) : public CHnMdBaseKey |
|
33 { |
|
34 public: |
|
35 |
|
36 /** |
|
37 * Standard factory method. |
|
38 * |
|
39 * @return Fully constructed object. |
|
40 */ |
|
41 static CHnMdUidKey* NewL(); |
|
42 |
|
43 /** |
|
44 * Standard factory method. |
|
45 * |
|
46 * @return Fully constructed object. |
|
47 */ |
|
48 static CHnMdUidKey* NewLC(); |
|
49 |
|
50 /** |
|
51 * Standard factory method. |
|
52 * |
|
53 * @param aKey Reference key. |
|
54 * @return Fully constructed object. |
|
55 */ |
|
56 static CHnMdUidKey* NewL( const CHnMdUidKey* aKey ); |
|
57 |
|
58 /** |
|
59 * Standard factory method. |
|
60 * |
|
61 * @param aKey Reference key. |
|
62 * @return Fully constructed object. |
|
63 */ |
|
64 static CHnMdUidKey* NewLC( const CHnMdUidKey* aKey ); |
|
65 |
|
66 /** |
|
67 * Factory method. |
|
68 * |
|
69 * since S60 v5.0 |
|
70 * @return Fully constructed object. |
|
71 */ |
|
72 virtual CHnMdBaseKey* CopyLC(); |
|
73 |
|
74 /** |
|
75 * Standard destructor. |
|
76 */ |
|
77 virtual ~CHnMdUidKey(); |
|
78 |
|
79 /** |
|
80 * Gets key content. |
|
81 * |
|
82 * @since S60 v5.0 |
|
83 * @param aContent Output content. |
|
84 */ |
|
85 void GetKeyContent( TInt& aContent ) const; |
|
86 |
|
87 /** |
|
88 * Change to variant. |
|
89 * |
|
90 * @since S60 v5.0 |
|
91 * @param aRet Output variant. |
|
92 * |
|
93 */ |
|
94 virtual void ToVariantL( TLiwVariant& aRet ) const; |
|
95 |
|
96 protected: |
|
97 friend class HnMdKeyFactory; |
|
98 |
|
99 /** |
|
100 * Standard constructor. |
|
101 * |
|
102 * @since S60 v5.0 |
|
103 */ |
|
104 CHnMdUidKey(); |
|
105 |
|
106 /** |
|
107 * Symbian constructor for performing 2nd stage construction. |
|
108 * |
|
109 * @since S60 v5.0 |
|
110 */ |
|
111 void ConstructL(); |
|
112 |
|
113 /** |
|
114 * Symbian constructor for performing 2nd stage construction. |
|
115 * |
|
116 * @since S60 v5.0 |
|
117 * @param aKey Reference key. |
|
118 */ |
|
119 void ConstructL( const CHnMdUidKey* aKey ); |
|
120 }; |
|
121 |
|
122 #endif // C_HNMDUIDKEY_H |