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: Class containing static exported functions needed by the implementation

    15 *  of components in the Landmarks subsystem.

    16 *

    17 */

    18 

    19 

    20 #ifndef POSLMIMPLEXTENSION_H

    21 #define POSLMIMPLEXTENSION_H

    22 

    23 //  INCLUDES

    24 #include <e32base.h>

    25 

    26 #include "EPos_Landmarks.h"

    27 

    28 // FORWARD DECLARATIONS

    29 class CPosLandmarkDatabase;

    30 class CPosLandmark;

    31 class CPosLandmarkCategory;

    32 

    33 // CLASS DECLARATION

    34 

    35 /**

    36 *  Class containing static exported functions needed by the implementation

    37 *  of components in the Landmarks subsystem.

    38 *

    39 *  This class is not meant for Landmarks API clients.

    40 *

    41 *  @version $Revision: 1.4 $, $Date: 2005/02/15 13:36:27 $

    42 */

    43 class PosLmImplExtension

    44     {

    45     public:  // New functions

    46 

    47         /*

    48         * Returns the database access implementation which is used.

    49         *

    50         * @param aDatabase The landmark database to fetch ID from.

    51         * @returns The @ref CPosLandmarkDatabase implementation ID.

    52         */

    53         IMPORT_C static TUid ImplementationId(

    54         /* IN/OUT  */   const CPosLandmarkDatabase&  aDatabase

    55         );

    56 

    57         /*

    58         * Sets the partial update flag to a specified landmark.

    59         * This flag is used to indicate if only partial information is included

    60         * in the landmark object.

    61         *

    62         * @param aLandmark The landmark to set flag for.

    63         * @param aPartial @p EFalse if the landmark contains all the landmark

    64         *   information, otherwise @p ETrue.

    65         */

    66         IMPORT_C static void SetPartialL(

    67         /* IN/OUT  */   CPosLandmark &aLandmark,

    68         /* IN  */       TBool aPartial

    69         );

    70 

    71         /*

    72         * Sets the landmark id to a specified landmark.

    73         *

    74         * @param aLandmark The landmark to set id for.

    75         * @param aId The landmark id to set.

    76         */

    77         IMPORT_C static void SetLandmarkIdL(

    78         /* IN/OUT  */   CPosLandmark &aLandmark,

    79         /* IN  */       TPosLmItemId aId

    80         );

    81 

    82         /*

    83         * Sets the category id to a specified landmark category.

    84         *

    85         * @param aCategory The category to set id for.

    86         * @param aId The category id to set.

    87         */

    88         IMPORT_C static void SetCategoryIdL(

    89         /* IN/OUT  */   CPosLandmarkCategory &aCategory,

    90         /* IN  */       TPosLmItemId aId

    91         );

    92 

    93         /**

    94         * Sets a specified landmark category to be global (i.e. not only

    95         * defined in one database).

    96         *

    97         * Global categories enable a uniform categorisation across multiple

    98         * databases.

    99         *

   100         * @param aCategory The category to set global category for.

   101         * @param aGlobalCategory The global category ID or

   102         *   @p KPosLmNullGlobalCategory if the category should not be global.

   103         */

   104         IMPORT_C static void SetGlobalCategory(

   105         /* IN/OUT  */   CPosLandmarkCategory& aCategory,

   106         /* IN  */       TPosLmGlobalCategory aGlobalCategory

   107         );

   108     };

   109 

   110 #endif      // POSLMIMPLEXTENSION_H

   111 

   112 // End of File