S60 3rd Edition API Reference: epos_landmarks.h Source File

00001 /*
00002 * ==============================================================================
00003 *  Name        : EPos_Landmarks.h
00004 *  Part of     : Mobile Location Framework/Landmarks
00005 *  Interface   : SDK/S60, Landmarks API
00006 *  Description : Common declarations for Landmarks API
00007 *  Version     : %version: 3 % 
00008 *
00009 *  Copyright � 2005-2006 Nokia.  All rights reserved.
00010 *  This material, including documentation and any related computer
00011 *  programs, is protected by copyright controlled by Nokia.  All
00012 *  rights are reserved.  Copying, including reproducing, storing,
00013 *  adapting or translating, any or all of this material requires the
00014 *  prior written consent of Nokia.  This material also contains
00015 *  confidential information which may not be disclosed to others
00016 *  without the prior written consent of Nokia.
00017 * ============================================================================
00018 * Template version: 4.0
00019 */
00020 
00021 #ifndef LANDMARKS_H
00022 #define LANDMARKS_H
00023 
00024 #include <e32std.h>
00025 
00031 typedef TUint32 TPosLmItemId;
00032 
00038 typedef TUint16 TPosLmGlobalCategory;
00039 
00045 enum TPosLmCollectionDataId
00046     {
00047     EPosLmCollDataNone = 0                              ,
00049     EPosLmCollDataCollectionName = 1                    ,
00051     EPosLmCollDataCollectionDescription = 2             ,
00053 
00054     EPosLmCollDataContentSpecificDataBegin = 0x8000     ,
00056     EPosLmCollDataLast = KMaxTUint16                    
00058     };
00059 
00073 enum TPosLmEventType
00074     {
00075     EPosLmEventUnknownChanges = 0  ,
00076 
00077     EPosLmEventNewDefaultDatabaseLocation = 10  ,
00081 
00082     EPosLmEventMediaRemoved = 11  ,
00087 
00088     EPosLmEventLandmarkUnknownChanges = 100 ,
00090 
00091     EPosLmEventLandmarkCreated = 101 ,
00093     EPosLmEventLandmarkDeleted = 102 ,
00095     EPosLmEventLandmarkUpdated = 103 ,
00097 
00098     EPosLmEventCategoryUnknownChanges  = 200 ,
00100 
00101     EPosLmEventCategoryCreated = 201 ,
00103     EPosLmEventCategoryDeleted = 202 ,
00105     EPosLmEventCategoryUpdated = 203 
00107     };
00108 
00114 struct TPosLmEvent
00115     {
00116     TPosLmEventType iEventType;        
00117     TPosLmItemId iLandmarkItemId;
00123     TUint8 iUnused[8];                  
00124     };
00125 
00126 
00127 // CONSTANTS
00128 const TUint32 KPosLmNullItemId = 0;
00129 const TUint16 KPosLmNullGlobalCategory = 0;
00130 
00131 const TInt KPosLmIconMaskNotUsed = -1;
00132 
00133 const TInt KPosLmMaxTextFieldLength = 255;
00134 const TInt KPosLmMaxDescriptionLength = 4095;
00135 const TInt KPosLmMaxCategoryNameLength = 124;
00136 
00137 const TUint KPosLastParsedLandmark = KMaxTUint32;
00138 
00139 // Landmark specific error codes
00140 // The 20 error codes in the range -30351 to -30370 is allocated for Landmarks
00141 // subsystem.
00142 const TInt KLandmarksErrorBase = -30351;
00143 const TInt KErrPosLmNotInitialized = KLandmarksErrorBase;
00144 const TInt KErrPosLmUnknownFormat = KLandmarksErrorBase - 1;
00145 
00146 const TInt KPosLmOperationNotComplete = 1001;
00147 
00148 // Database secure format
00149 _LIT(KPosLmDbSecureFormat, "secure[101FE978]");
00150 
00151 // Database secure policy UID
00152 const TUid KPosLmDbSecureUid = { 0x101FE978 };
00153 
00154 // Global functions
00155 
00173 IMPORT_C void ReleaseLandmarkResources(TAny* = NULL);
00174 
00175 // LANDMARKS_H
00176 #endif
00177 
00178