|
1 /* |
|
2 * Copyright (c) 2005 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 - |
|
15 * See class description below |
|
16 * |
|
17 */ |
|
18 |
|
19 |
|
20 |
|
21 |
|
22 |
|
23 |
|
24 |
|
25 #ifndef CLMKLANDMARK_H |
|
26 #define CLMKLANDMARK_H |
|
27 |
|
28 // INCLUDES |
|
29 #include <e32base.h> |
|
30 #include <badesca.h> |
|
31 #include <EPos_CPosLandmark.h> |
|
32 #include <EPos_CPosLandmarkCategory.h> |
|
33 |
|
34 // CLASS DECLARATION |
|
35 |
|
36 /** |
|
37 * This is a container class for a landmark. |
|
38 * |
|
39 * A landmark is principally a location with a name. |
|
40 * |
|
41 * The landmark object can either be created by a client or retrieved from |
|
42 * @ref CPosLandmarkDatabase. |
|
43 * |
|
44 * A landmark consists of a number of landmark attributes, e.g. landmark name, |
|
45 * landmark position, coverage area, etc. |
|
46 * |
|
47 * A landmark may also contain generic position fields. These position fields |
|
48 * are defined in LbsFields.h. Only text fields are supported. |
|
49 * |
|
50 * CLmkLandmark contains functions for setting and getting landmark attributes |
|
51 * and position fields. |
|
52 * |
|
53 * Note that CLmkLandmark is only a local representation of the landmark. To |
|
54 * update the database, call @ref CPosLandmarkDatabase::UpdateLandmarkL (or |
|
55 * @ref CPosLandmarkDatabase::AddLandmarkL for a new landmark). |
|
56 * |
|
57 * @lib eposlandmarks.lib |
|
58 * @since S60 3.0 |
|
59 * @version $Revision: 1.15 $, $Date: 2005/07/07 13:40:48 $ |
|
60 */ |
|
61 class CLmkLandmark : public CBase |
|
62 { |
|
63 |
|
64 public: // Constructors and destructor |
|
65 |
|
66 /** |
|
67 * Two-phased copy constructor. |
|
68 * |
|
69 * @param aLandmark The landmark to copy. |
|
70 * @returns A copy of the specified landmark object. |
|
71 */ |
|
72 IMPORT_C static CLmkLandmark* NewL( |
|
73 const CPosLandmark* aLandmark, |
|
74 const RPointerArray<CPosLandmarkCategory>& aCategories |
|
75 ); |
|
76 |
|
77 IMPORT_C static CLmkLandmark* CLmkLandmark::NewL( |
|
78 const CLmkLandmark& aLandmark); |
|
79 |
|
80 |
|
81 /** |
|
82 * Destructor. |
|
83 */ |
|
84 virtual ~CLmkLandmark(); |
|
85 |
|
86 public://New Functions |
|
87 |
|
88 IMPORT_C CPosLandmark* PosLandmark(); |
|
89 IMPORT_C RPointerArray<CPosLandmarkCategory>& Categories(); |
|
90 |
|
91 private: |
|
92 |
|
93 /** |
|
94 * C++ default constructor. |
|
95 */ |
|
96 CLmkLandmark(); |
|
97 |
|
98 CLmkLandmark(const CPosLandmark* aLandmark, |
|
99 const RPointerArray<CPosLandmarkCategory>& aCategories); |
|
100 |
|
101 // Prohibit copy constructor |
|
102 CLmkLandmark(const CLmkLandmark&); |
|
103 |
|
104 // Prohibit assigment operator |
|
105 CLmkLandmark& operator= (const CLmkLandmark&); |
|
106 |
|
107 void ConstructL(const CPosLandmark* aLandmark, |
|
108 const RPointerArray<CPosLandmarkCategory>& aCategories); |
|
109 |
|
110 private: // Data |
|
111 |
|
112 CPosLandmark* iLandmark; |
|
113 RPointerArray<CPosLandmarkCategory> iCategories; |
|
114 }; |
|
115 |
|
116 #endif // CLMKLANDMARK_H |
|
117 |
|
118 // End of File |