williamr@2: /*
williamr@2: * Copyright (c) 2005 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@4: * under the terms of "Eclipse Public License v1.0"
williamr@2: * which accompanies this distribution, and is available
williamr@4: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description:    LandmarksUi Content File -    This class provides methods for fetching the ID of selected
williamr@2: *			   : landmark or category and the handle to database to which either
williamr@2: *			   : landmark or category belongs.
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: #ifndef TLMKITEMIDDBCOMBIINFO_H
williamr@2: #define TLMKITEMIDDBCOMBIINFO_H
williamr@2: 
williamr@2: //  INCLUDES
williamr@2: #include <e32base.h>            // CBase
williamr@2: #include <EPos_Landmarks.h>     // Lm typedefs, constants etc.
williamr@2: 
williamr@2: class CPosLandmarkDatabase;
williamr@2: 
williamr@2: 
williamr@2: /**
williamr@2: *
williamr@2: *This class provides methods for fetching the ID of selected landmark or category
williamr@2: *and the handle to database to which either landmark or category belongs.
williamr@2: *
williamr@2: */
williamr@2: class TLmkItemIdDbCombiInfo
williamr@2: {
williamr@2: 
williamr@2:    public:  // Constructors and destructor
williamr@2:         /**
williamr@2:         * C++ default constructor.
williamr@2:         * @return newly instantiated object
williamr@2:         */
williamr@2: 
williamr@2:         IMPORT_C TLmkItemIdDbCombiInfo();
williamr@2: 
williamr@2:         /**
williamr@2:         * Destructor.
williamr@2:         */
williamr@2:         IMPORT_C ~TLmkItemIdDbCombiInfo();
williamr@2: 
williamr@2:    public: // Functions for getting/setting the info
williamr@2: 
williamr@2:         /**
williamr@2:         *The client application executes this method to get the ID of a landmark or category
williamr@2:         *@return id of the landmark or category
williamr@2:         */
williamr@2:         IMPORT_C TPosLmItemId GetItemId() const;
williamr@2: 
williamr@2:         /**
williamr@2:         *The client application executes this method to get the handle to a landmark database.
williamr@2:         *The client takes the ownership of database handle.
williamr@2: 		*The database pointer is the same for all landmarks from the same database.
williamr@2: 		*It is the responsibilty of the API client to manage these database pointers
williamr@2: 		*and delete those pointers.
williamr@2:         *
williamr@2:         *@return handle to database to which the landmark or category belongs
williamr@2:         */
williamr@2: 
williamr@2:         IMPORT_C CPosLandmarkDatabase* GetLmDb() const;
williamr@2: 
williamr@2:         /**
williamr@2:         * This function is used to set the landmark or category id to the object of this class.
williamr@2:         * Basically this function is used by the API implementation logic.
williamr@2:         *@param [in] aLmItemId will contain reference to id of landmark or category
williamr@2:         */
williamr@2: 
williamr@2:         IMPORT_C void SetItemId( TPosLmItemId &aLmItemId);
williamr@2: 
williamr@2:         /**
williamr@2:         * This function is used to set the landmark database handle to the object of this class.
williamr@2:         * Objects of this class owns the database handle.Basically this function is used by the
williamr@2:         * API implementation logic.
williamr@2:         *@param [in] aDb contains the pointer to database handle
williamr@2:         */
williamr@2: 
williamr@2:         IMPORT_C void SetLmDb ( CPosLandmarkDatabase* aDb);
williamr@2: 
williamr@2: private: // own data
williamr@2: 	CPosLandmarkDatabase* iLmDb;
williamr@2: 	TPosLmItemId iLmItemId;
williamr@2: };
williamr@2: 
williamr@2: 
williamr@2: #endif // TLmkItemIdDbCombiInfo_H