1 /* |
|
2 * Copyright (c) 2002 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: LandmarksUi Content File - Interface for landmark's editor items |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 |
|
21 |
|
22 |
|
23 |
|
24 #ifndef __MLMKFIELDDATA_H__ |
|
25 #define __MLMKFIELDDATA_H__ |
|
26 |
|
27 // INCLUDES |
|
28 #include <e32base.h> |
|
29 #include <EPos_Landmarks.h> |
|
30 |
|
31 // CLASS DECLARATION |
|
32 |
|
33 /** |
|
34 * Landmark editor field data abstract class. |
|
35 */ |
|
36 class MLmkFieldData |
|
37 { |
|
38 public: // destructor |
|
39 /** |
|
40 * Destructor. |
|
41 */ |
|
42 virtual ~MLmkFieldData(){} |
|
43 |
|
44 public: // Interface |
|
45 /** |
|
46 * Set label |
|
47 * Not take ownership |
|
48 * @param aLabel |
|
49 */ |
|
50 virtual void SetLabel( HBufC* aLabel ) = 0; |
|
51 |
|
52 /** |
|
53 * Return field's label |
|
54 * @return HBufC |
|
55 */ |
|
56 virtual const HBufC& Label() const = 0; |
|
57 |
|
58 /** |
|
59 * Set editor type |
|
60 * @param aType |
|
61 */ |
|
62 virtual void SetEditorType( const TUint16 aType ) = 0; |
|
63 |
|
64 /** |
|
65 * Return field's editor type |
|
66 * @return TInt |
|
67 */ |
|
68 virtual TUint16 EditorType() const = 0; |
|
69 |
|
70 /** |
|
71 * Set text data |
|
72 * @param aText |
|
73 */ |
|
74 virtual void SetTextL( const TPtrC aText ) = 0; |
|
75 |
|
76 /** |
|
77 * Set text data, take ownership |
|
78 * @param aText |
|
79 */ |
|
80 virtual void SetText( HBufC* aText ) = 0; |
|
81 |
|
82 /** |
|
83 * Return text data |
|
84 * @return TBufC |
|
85 */ |
|
86 virtual const HBufC& TextData() const = 0; |
|
87 |
|
88 /** |
|
89 * Set Integer value |
|
90 * @param aTInt |
|
91 */ |
|
92 virtual void SetInt( const TInt aTInt ) = 0; |
|
93 |
|
94 /** |
|
95 * Return field's integer value |
|
96 * @return TInt |
|
97 */ |
|
98 virtual TInt IntegerData() const = 0; |
|
99 |
|
100 /** |
|
101 * Set TReal32 value |
|
102 * @param aTReal |
|
103 */ |
|
104 virtual void SetTReal( const TReal32 aTReal ) = 0; |
|
105 |
|
106 /** |
|
107 * Return field's TReal32 value |
|
108 * @return TReal |
|
109 */ |
|
110 virtual TReal32 FloatData() const = 0; |
|
111 |
|
112 /** |
|
113 * Set TReal64 value |
|
114 * @param aTReal64 |
|
115 */ |
|
116 virtual void SetTReal( const TReal64 aTReal ) = 0; |
|
117 |
|
118 /** |
|
119 * Return field's TReal64 value |
|
120 * @return TReal64 |
|
121 */ |
|
122 virtual TReal64 DoubleData() const = 0; |
|
123 |
|
124 /** |
|
125 * Return field's categories |
|
126 * @return TPosLmItemId |
|
127 */ |
|
128 virtual RArray<TPosLmItemId>& Categories() = 0; |
|
129 |
|
130 /** |
|
131 * Return TInt |
|
132 * @return TInt |
|
133 */ |
|
134 virtual TInt UniqueFieldIdentity() const = 0; |
|
135 |
|
136 /** |
|
137 * Set Field type |
|
138 * @param aFieldType |
|
139 */ |
|
140 virtual void SetFieldType( const TUint16 aFieldType ) = 0; |
|
141 |
|
142 /** |
|
143 * Return field type |
|
144 * @return TUint16 |
|
145 */ |
|
146 virtual TUint16 FieldType() const = 0; |
|
147 |
|
148 /** |
|
149 * Set PositionField id |
|
150 * @param aPositionFieldId |
|
151 */ |
|
152 virtual void SetPositionFieldId( const TUint16 aPositionFieldId ) = 0; |
|
153 |
|
154 /** |
|
155 * Return PositionField id |
|
156 * @return TUint16 |
|
157 */ |
|
158 virtual TUint16 PositionFieldId() const = 0; |
|
159 |
|
160 /** |
|
161 * Set Field length |
|
162 * @param aLength |
|
163 */ |
|
164 virtual void SetFieldLength( const TInt aLength ) = 0; |
|
165 |
|
166 /** |
|
167 * Return field length |
|
168 * @return TInt |
|
169 */ |
|
170 virtual TInt FieldLength() const = 0; |
|
171 |
|
172 /** |
|
173 * Set fields title |
|
174 * @param aTitleField |
|
175 */ |
|
176 virtual void SetTitleField( const TBool aTitleField ) = 0; |
|
177 |
|
178 /** |
|
179 * Check if field is title field |
|
180 * @return TBool |
|
181 */ |
|
182 virtual TBool IsTitleField() const = 0; |
|
183 |
|
184 /** |
|
185 * Set icon id to landmark |
|
186 * @param aIconId |
|
187 */ |
|
188 virtual void SetIconId( const TInt aIconId ) = 0; |
|
189 |
|
190 /** |
|
191 * Get landmarks icon id |
|
192 * @return TInt |
|
193 */ |
|
194 virtual TInt IconId() const = 0; |
|
195 |
|
196 /** |
|
197 * Set landmark icon path |
|
198 * @param aIconPath |
|
199 */ |
|
200 virtual void SetIconPathL( const TDesC& aIconPath ) = 0; |
|
201 |
|
202 /** |
|
203 * Get landmarks icon path |
|
204 * @return HBufC* |
|
205 */ |
|
206 virtual HBufC* IconPath() = 0; |
|
207 }; |
|
208 |
|
209 #endif // __MLMKFIELDDATA_H__ |
|
210 |
|
211 // End of File |
|