2 * Copyright (c) 2005 Nokia Corporation and/or its subsidiary(-ies).
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".
9 * Initial Contributors:
10 * Nokia Corporation - initial contribution.
14 * Description: LandmarksUi Content File - This class provides methods for fetching the ID of selected
15 * : landmark or category and the handle to database to which either
16 * : landmark or category belongs.
26 #ifndef TLMKITEMIDDBCOMBIINFO_H
27 #define TLMKITEMIDDBCOMBIINFO_H
30 #include <e32base.h> // CBase
31 #include <EPos_Landmarks.h> // Lm typedefs, constants etc.
33 class CPosLandmarkDatabase;
38 *This class provides methods for fetching the ID of selected landmark or category
39 *and the handle to database to which either landmark or category belongs.
42 class TLmkItemIdDbCombiInfo
45 public: // Constructors and destructor
47 * C++ default constructor.
48 * @return newly instantiated object
51 IMPORT_C TLmkItemIdDbCombiInfo();
56 IMPORT_C ~TLmkItemIdDbCombiInfo();
58 public: // Functions for getting/setting the info
61 *The client application executes this method to get the ID of a landmark or category
62 *@return id of the landmark or category
64 IMPORT_C TPosLmItemId GetItemId() const;
67 *The client application executes this method to get the handle to a landmark database.
68 *The client takes the ownership of database handle.
69 *The database pointer is the same for all landmarks from the same database.
70 *It is the responsibilty of the API client to manage these database pointers
71 *and delete those pointers.
73 *@return handle to database to which the landmark or category belongs
76 IMPORT_C CPosLandmarkDatabase* GetLmDb() const;
79 * This function is used to set the landmark or category id to the object of this class.
80 * Basically this function is used by the API implementation logic.
81 *@param [in] aLmItemId will contain reference to id of landmark or category
84 IMPORT_C void SetItemId( TPosLmItemId &aLmItemId);
87 * This function is used to set the landmark database handle to the object of this class.
88 * Objects of this class owns the database handle.Basically this function is used by the
89 * API implementation logic.
90 *@param [in] aDb contains the pointer to database handle
93 IMPORT_C void SetLmDb ( CPosLandmarkDatabase* aDb);
96 CPosLandmarkDatabase* iLmDb;
97 TPosLmItemId iLmItemId;
101 #endif // TLmkItemIdDbCombiInfo_H