author | William Roberts <williamr@symbian.org> |
Wed, 31 Mar 2010 12:33:34 +0100 | |
branch | Symbian3 |
changeset 4 | 837f303aceeb |
parent 2 | 2fe1408b6811 |
permissions | -rw-r--r-- |
williamr@2 | 1 |
/* |
williamr@2 | 2 |
* Copyright (c) 2005 Nokia Corporation and/or its subsidiary(-ies). |
williamr@2 | 3 |
* All rights reserved. |
williamr@2 | 4 |
* This component and the accompanying materials are made available |
williamr@4 | 5 |
* under the terms of "Eclipse Public License v1.0" |
williamr@2 | 6 |
* which accompanies this distribution, and is available |
williamr@4 | 7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html". |
williamr@2 | 8 |
* |
williamr@2 | 9 |
* Initial Contributors: |
williamr@2 | 10 |
* Nokia Corporation - initial contribution. |
williamr@2 | 11 |
* |
williamr@2 | 12 |
* Contributors: |
williamr@2 | 13 |
* |
williamr@2 | 14 |
* Description: LandmarksUi Content File - This class provides methods for fetching the ID of selected |
williamr@2 | 15 |
* : landmark or category and the handle to database to which either |
williamr@2 | 16 |
* : landmark or category belongs. |
williamr@2 | 17 |
* |
williamr@2 | 18 |
*/ |
williamr@2 | 19 |
|
williamr@2 | 20 |
|
williamr@2 | 21 |
|
williamr@2 | 22 |
|
williamr@2 | 23 |
|
williamr@2 | 24 |
|
williamr@2 | 25 |
|
williamr@2 | 26 |
#ifndef TLMKITEMIDDBCOMBIINFO_H |
williamr@2 | 27 |
#define TLMKITEMIDDBCOMBIINFO_H |
williamr@2 | 28 |
|
williamr@2 | 29 |
// INCLUDES |
williamr@2 | 30 |
#include <e32base.h> // CBase |
williamr@2 | 31 |
#include <EPos_Landmarks.h> // Lm typedefs, constants etc. |
williamr@2 | 32 |
|
williamr@2 | 33 |
class CPosLandmarkDatabase; |
williamr@2 | 34 |
|
williamr@2 | 35 |
|
williamr@2 | 36 |
/** |
williamr@2 | 37 |
* |
williamr@2 | 38 |
*This class provides methods for fetching the ID of selected landmark or category |
williamr@2 | 39 |
*and the handle to database to which either landmark or category belongs. |
williamr@2 | 40 |
* |
williamr@2 | 41 |
*/ |
williamr@2 | 42 |
class TLmkItemIdDbCombiInfo |
williamr@2 | 43 |
{ |
williamr@2 | 44 |
|
williamr@2 | 45 |
public: // Constructors and destructor |
williamr@2 | 46 |
/** |
williamr@2 | 47 |
* C++ default constructor. |
williamr@2 | 48 |
* @return newly instantiated object |
williamr@2 | 49 |
*/ |
williamr@2 | 50 |
|
williamr@2 | 51 |
IMPORT_C TLmkItemIdDbCombiInfo(); |
williamr@2 | 52 |
|
williamr@2 | 53 |
/** |
williamr@2 | 54 |
* Destructor. |
williamr@2 | 55 |
*/ |
williamr@2 | 56 |
IMPORT_C ~TLmkItemIdDbCombiInfo(); |
williamr@2 | 57 |
|
williamr@2 | 58 |
public: // Functions for getting/setting the info |
williamr@2 | 59 |
|
williamr@2 | 60 |
/** |
williamr@2 | 61 |
*The client application executes this method to get the ID of a landmark or category |
williamr@2 | 62 |
*@return id of the landmark or category |
williamr@2 | 63 |
*/ |
williamr@2 | 64 |
IMPORT_C TPosLmItemId GetItemId() const; |
williamr@2 | 65 |
|
williamr@2 | 66 |
/** |
williamr@2 | 67 |
*The client application executes this method to get the handle to a landmark database. |
williamr@2 | 68 |
*The client takes the ownership of database handle. |
williamr@2 | 69 |
*The database pointer is the same for all landmarks from the same database. |
williamr@2 | 70 |
*It is the responsibilty of the API client to manage these database pointers |
williamr@2 | 71 |
*and delete those pointers. |
williamr@2 | 72 |
* |
williamr@2 | 73 |
*@return handle to database to which the landmark or category belongs |
williamr@2 | 74 |
*/ |
williamr@2 | 75 |
|
williamr@2 | 76 |
IMPORT_C CPosLandmarkDatabase* GetLmDb() const; |
williamr@2 | 77 |
|
williamr@2 | 78 |
/** |
williamr@2 | 79 |
* This function is used to set the landmark or category id to the object of this class. |
williamr@2 | 80 |
* Basically this function is used by the API implementation logic. |
williamr@2 | 81 |
*@param [in] aLmItemId will contain reference to id of landmark or category |
williamr@2 | 82 |
*/ |
williamr@2 | 83 |
|
williamr@2 | 84 |
IMPORT_C void SetItemId( TPosLmItemId &aLmItemId); |
williamr@2 | 85 |
|
williamr@2 | 86 |
/** |
williamr@2 | 87 |
* This function is used to set the landmark database handle to the object of this class. |
williamr@2 | 88 |
* Objects of this class owns the database handle.Basically this function is used by the |
williamr@2 | 89 |
* API implementation logic. |
williamr@2 | 90 |
*@param [in] aDb contains the pointer to database handle |
williamr@2 | 91 |
*/ |
williamr@2 | 92 |
|
williamr@2 | 93 |
IMPORT_C void SetLmDb ( CPosLandmarkDatabase* aDb); |
williamr@2 | 94 |
|
williamr@2 | 95 |
private: // own data |
williamr@2 | 96 |
CPosLandmarkDatabase* iLmDb; |
williamr@2 | 97 |
TPosLmItemId iLmItemId; |
williamr@2 | 98 |
}; |
williamr@2 | 99 |
|
williamr@2 | 100 |
|
williamr@2 | 101 |
#endif // TLmkItemIdDbCombiInfo_H |