epoc32/include/app/tlmkitemiddbcombiinfo.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 /*
     2 * Copyright (c) 2005 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     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".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    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.
    17 *
    18 */
    19 
    20 
    21 
    22 
    23 
    24 
    25 
    26 #ifndef TLMKITEMIDDBCOMBIINFO_H
    27 #define TLMKITEMIDDBCOMBIINFO_H
    28 
    29 //  INCLUDES
    30 #include <e32base.h>            // CBase
    31 #include <EPos_Landmarks.h>     // Lm typedefs, constants etc.
    32 
    33 class CPosLandmarkDatabase;
    34 
    35 
    36 /**
    37 *
    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.
    40 *
    41 */
    42 class TLmkItemIdDbCombiInfo
    43 {
    44 
    45    public:  // Constructors and destructor
    46         /**
    47         * C++ default constructor.
    48         * @return newly instantiated object
    49         */
    50 
    51         IMPORT_C TLmkItemIdDbCombiInfo();
    52 
    53         /**
    54         * Destructor.
    55         */
    56         IMPORT_C ~TLmkItemIdDbCombiInfo();
    57 
    58    public: // Functions for getting/setting the info
    59 
    60         /**
    61         *The client application executes this method to get the ID of a landmark or category
    62         *@return id of the landmark or category
    63         */
    64         IMPORT_C TPosLmItemId GetItemId() const;
    65 
    66         /**
    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.
    72         *
    73         *@return handle to database to which the landmark or category belongs
    74         */
    75 
    76         IMPORT_C CPosLandmarkDatabase* GetLmDb() const;
    77 
    78         /**
    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
    82         */
    83 
    84         IMPORT_C void SetItemId( TPosLmItemId &aLmItemId);
    85 
    86         /**
    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
    91         */
    92 
    93         IMPORT_C void SetLmDb ( CPosLandmarkDatabase* aDb);
    94 
    95 private: // own data
    96 	CPosLandmarkDatabase* iLmDb;
    97 	TPosLmItemId iLmItemId;
    98 };
    99 
   100 
   101 #endif // TLmkItemIdDbCombiInfo_H