1.1 --- a/epoc32/include/app/tlmkitemiddbcombiinfo.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/app/tlmkitemiddbcombiinfo.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,101 @@
     1.4 -tlmkitemiddbcombiinfo.h
     1.5 +/*
     1.6 +* Copyright (c) 2005 Nokia Corporation and/or its subsidiary(-ies).
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:    LandmarksUi Content File -    This class provides methods for fetching the ID of selected
    1.19 +*			   : landmark or category and the handle to database to which either
    1.20 +*			   : landmark or category belongs.
    1.21 +*
    1.22 +*/
    1.23 +
    1.24 +
    1.25 +
    1.26 +
    1.27 +
    1.28 +
    1.29 +
    1.30 +#ifndef TLMKITEMIDDBCOMBIINFO_H
    1.31 +#define TLMKITEMIDDBCOMBIINFO_H
    1.32 +
    1.33 +//  INCLUDES
    1.34 +#include <e32base.h>            // CBase
    1.35 +#include <EPos_Landmarks.h>     // Lm typedefs, constants etc.
    1.36 +
    1.37 +class CPosLandmarkDatabase;
    1.38 +
    1.39 +
    1.40 +/**
    1.41 +*
    1.42 +*This class provides methods for fetching the ID of selected landmark or category
    1.43 +*and the handle to database to which either landmark or category belongs.
    1.44 +*
    1.45 +*/
    1.46 +class TLmkItemIdDbCombiInfo
    1.47 +{
    1.48 +
    1.49 +   public:  // Constructors and destructor
    1.50 +        /**
    1.51 +        * C++ default constructor.
    1.52 +        * @return newly instantiated object
    1.53 +        */
    1.54 +
    1.55 +        IMPORT_C TLmkItemIdDbCombiInfo();
    1.56 +
    1.57 +        /**
    1.58 +        * Destructor.
    1.59 +        */
    1.60 +        IMPORT_C ~TLmkItemIdDbCombiInfo();
    1.61 +
    1.62 +   public: // Functions for getting/setting the info
    1.63 +
    1.64 +        /**
    1.65 +        *The client application executes this method to get the ID of a landmark or category
    1.66 +        *@return id of the landmark or category
    1.67 +        */
    1.68 +        IMPORT_C TPosLmItemId GetItemId() const;
    1.69 +
    1.70 +        /**
    1.71 +        *The client application executes this method to get the handle to a landmark database.
    1.72 +        *The client takes the ownership of database handle.
    1.73 +		*The database pointer is the same for all landmarks from the same database.
    1.74 +		*It is the responsibilty of the API client to manage these database pointers
    1.75 +		*and delete those pointers.
    1.76 +        *
    1.77 +        *@return handle to database to which the landmark or category belongs
    1.78 +        */
    1.79 +
    1.80 +        IMPORT_C CPosLandmarkDatabase* GetLmDb() const;
    1.81 +
    1.82 +        /**
    1.83 +        * This function is used to set the landmark or category id to the object of this class.
    1.84 +        * Basically this function is used by the API implementation logic.
    1.85 +        *@param [in] aLmItemId will contain reference to id of landmark or category
    1.86 +        */
    1.87 +
    1.88 +        IMPORT_C void SetItemId( TPosLmItemId &aLmItemId);
    1.89 +
    1.90 +        /**
    1.91 +        * This function is used to set the landmark database handle to the object of this class.
    1.92 +        * Objects of this class owns the database handle.Basically this function is used by the
    1.93 +        * API implementation logic.
    1.94 +        *@param [in] aDb contains the pointer to database handle
    1.95 +        */
    1.96 +
    1.97 +        IMPORT_C void SetLmDb ( CPosLandmarkDatabase* aDb);
    1.98 +
    1.99 +private: // own data
   1.100 +	CPosLandmarkDatabase* iLmDb;
   1.101 +	TPosLmItemId iLmItemId;
   1.102 +};
   1.103 +
   1.104 +
   1.105 +#endif // TLmkItemIdDbCombiInfo_H