TLmkItemIdDbCombiInfo Class Reference

API published in: S60 3rd Ed

Link against: lmkcommonui.lib

Capability Information

Required Capabilities

LocalServices Location NetworkServices ReadUserData WriteUserData

Exceptions

None

Other Information

None

#include <tlmkitemiddbcombiinfo.h>

Detailed Description

This class provides methods for fetching the ID of selected landmark or category and the handle to database to which either landmark or category belongs.

Public Member Functions
IMPORT_C  TLmkItemIdDbCombiInfo ()
  C++ default constructor.
IMPORT_C  ~TLmkItemIdDbCombiInfo ()
  Destructor.
IMPORT_C TPosLmItemId  GetItemId () const
  The client application executes this method to get the ID of a landmark or category.
IMPORT_C CPosLandmarkDatabase *  GetLmDb () const
  The client application executes this method to get the handle to a landmark database.
IMPORT_C void  SetItemId (TPosLmItemId &aLmItemId)
  This function is used to set the landmark or category id to the object of this class.
IMPORT_C void  SetLmDb (CPosLandmarkDatabase *aDb)
  This function is used to set the landmark database handle to the object of this class.

Constructor & Destructor Documentation

IMPORT_C TLmkItemIdDbCombiInfo::TLmkItemIdDbCombiInfo (   ) 
 

C++ default constructor.

Returns:
newly instantiated object
IMPORT_C TLmkItemIdDbCombiInfo::~TLmkItemIdDbCombiInfo (   ) 
 

Destructor.

Member Function Documentation

IMPORT_C TPosLmItemId TLmkItemIdDbCombiInfo::GetItemId (   )  const
 

The client application executes this method to get the ID of a landmark or category.

Returns:
id of the landmark or category
IMPORT_C CPosLandmarkDatabase* TLmkItemIdDbCombiInfo::GetLmDb (   )  const
 

The client application executes this method to get the handle to a landmark database.

The client takes the ownership of database handle. The database pointer is the same for all landmarks from the same database. It is the responsibilty of the API client to manage these database pointers and delete those pointers.

Returns:
handle to database to which the landmark or category belongs
IMPORT_C void TLmkItemIdDbCombiInfo::SetItemId (  TPosLmItemId &  aLmItemId  ) 
 

This function is used to set the landmark or category id to the object of this class.

Basically this function is used by the API implementation logic.

Parameters:
[in]  aLmItemId  will contain reference to id of landmark or category
IMPORT_C void TLmkItemIdDbCombiInfo::SetLmDb (  CPosLandmarkDatabase *  aDb  ) 
 

This function is used to set the landmark database handle to the object of this class.

Objects of this class owns the database handle.Basically this function is used by the API implementation logic.

Parameters:
[in]  aDb  contains the pointer to database handle
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top