epoc32/include/mw/aiwgenericparam.hrh
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) 2003-2006 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:     AIW generic parameter definitions.
    15 *
    16 */
    17 
    18 
    19 
    20 
    21 
    22 #ifndef AIW_GENERIC_PARAM_HRH
    23 #define AIW_GENERIC_PARAM_HRH
    24 
    25 /**
    26  * Pre-defined sematic IDs for generic parameters (TAiwGenericParam).
    27  * The data type of the parameter specifies the representation of the parameter.
    28  * Use TGenericParamId instead of using TGenericParamIdValue directly.
    29  * Additional generic param definitions are possible besides this list.
    30  * @see TAiwGenericParam.
    31  */   
    32 enum TGenericParamIdValue 
    33     {
    34     EGenericParamUnspecified = 0,
    35 
    36     // General parameters
    37     EGenericParamError          = 1,  // Any error parameter
    38     EGenericParamDir            = 2,  // Any directory  
    39     EGenericParamFile           = 3,  // Any file
    40     EGenericParamURL            = 4,  // Any URL
    41     EGenericParamApplication    = 5,  // Application
    42     EGenericParamInstallPackage = 6,  // Install package
    43     EGenericParamDRMFile        = 7,
    44     EGenericParamMIMEType       = 8,
    45     EGenericParamCharSet        = 9,
    46 
    47     // NOTE: Next id is a special semantic id reserved for AIW framework. 
    48     // A consumer application should never add it to parameter list.
    49     EGenericParamServiceCommand = 10,
    50 
    51     // NOTE: Next id is to be used only internally by DocumentHandler.
    52     // Do not not use it for anything else.
    53     EGenericParamInternalFile = 11, 
    54 
    55     // Application services
    56     EGenericParamContactItem   = 20,
    57     EGenericParamCalendarItem  = 21,
    58     EGenericParamMessageItem   = 22,  
    59     EGenericParamNoteItem      = 23,
    60     EGenericParamHelpItem      = 24,
    61     EGenericParamAlarmItem     = 25,
    62     EGenericParamLogItem       = 26,
    63     EGenericParamPhoneNumber   = 27,
    64     EGenericParamAccessPoint   = 28,
    65     EGenericParamSIPAddress    = 29,
    66 
    67     EGenericParamMessageItemSMS   = 30,
    68     EGenericParamMessageItemEMail = 31,
    69     EGenericParamMessageItemMMS   = 32,
    70     
    71     EGenericParamEmailAddress = 33, 
    72     EGenericParamWVID         = 34,
    73     EGenericParamDateTime     = 35,
    74     
    75     EGenericParamMessageItemMbox = 36,  
    76 
    77     // SIM items
    78     EGenericParamSIMContactItem  = 40,
    79     EGenericParamSIMAppItem      = 41,
    80 
    81     // Browser items
    82     EGenericParamReferringURI = 50,    
    83 
    84     // Music Player items
    85     EGenericParamPlayerInitMode = 60,
    86     EGenericParamAlbumItems     = 61,
    87     EGenericParamAlbumName      = 62,
    88 
    89     // Print parameters
    90     EGenericParamPrintXMLFile = 70,
    91 
    92     // Call parameters
    93     EGenericParamCallDialDataV1 = 80,
    94     EGenericParamCallDialData   = 81,
    95 
    96     // Sprint media gallery provider specific
    97     EGenricParamMGItemType                 = 90, 
    98     EGeneriParamMGMediaType                = 91,
    99     EGeneriParamMGViewType                 = 92,
   100     EGenericParamMGSubviewtype             = 93,
   101     EGenericParamMGMarked                  = 94,
   102     EGenericParamCdmaExtendedAMSData       = 95,
   103     EGenericParamCdmaExtendedLightSurfData = 96,
   104 
   105     EGenericParamSilentDownload  = 110,
   106     EGenericParamSuppressLaunch  = 111,
   107     EGenericParamSuppressNextUrl = 112,
   108 
   109     EGenericParamPoCData       = 120,
   110     EGenericParamPoCLaunchView = 121,
   111 
   112     EGenericParamAllowMove = 130,
   113     EGenericParamAllowSave = 131, 
   114     
   115     EGenericParamFileSaved = 140,
   116     
   117     EGenericParamLocation = 150,
   118     
   119     EGenericParamFotaPkgId = 160,
   120     
   121     EGenericParamMMSSizeLimit = 170,
   122     EGenericParamResolution   = 171,
   123     
   124     EGenericParamSuppressDownloadConfirmation = 180,
   125     EGenericParamDownloadId                   = 181,
   126     
   127     EGenericParamPassword     = 190,
   128     EGenericParamUserName     = 191,
   129     EGenericParamBookmarkName = 192,
   130     
   131     EGenericParamContactSelectionData = 200,
   132     EGenericParamContactLinkArray     = 201,
   133     EGenericParamContactStoreUriArray = 202,
   134     EGenericParamSelectedCount        = 203,
   135     EGenericParamContactAssignData    = 204,
   136 /*<branchInfo originator="gronoff" since="07-10-2008" category="new_feature" error=”none”>
   137 <PF5250_OFF_CYCLE_SW_INT>
   138 </branchInfo>*/
   139 // BRANCH 07-10-2008 : gronoff
   140     EGenericParamContactFieldData      = 205,
   141 // BRANCH_END 07-10-2008 : gronoff    
   142     EGenericParamLandmark             = 210,
   143     EGenericParamLandmarkDatabase     = 211,
   144     EGenericParamLandmarkId           = 212,
   145     EGenericParamLandmarkIdList       = 213,
   146     EGenericParamMnCommonOptions      = 214,
   147     EGenericParamMnMapViewOptions     = 215,
   148     EGenericParamMnGeocodingOptions   = 216,
   149     EGenericParamRequestText          = 217,
   150     
   151     // Enterprise telephony parameters
   152     EGenericParamModeActivation       = 220,
   153     EGenericParamDisplayString        = 221,
   154     
   155     EGenericParamSpeedDialIndex       = 230,
   156     
   157     // In-device search parameters
   158     EGenericParamKeywords             = 240,
   159     EGenericParamCallAppLocName       = 241,
   160     EGenericParamStartOption          = 242,
   161     EGenericParamSearchContent        = 243,
   162     
   163     EGenericParamTerminate            = 250,
   164     
   165     //For Image viewer slideshow support
   166     EGenericParamSlideshow			  = 251,
   167     
   168     //For Search functionality
   169     EGenericParamSearchDomain		  = 260,
   170     EGenericParamSearchSubject		  = 261,
   171     EGenericParamSearchProvider		  = 262,
   172     EGenericParamSearchOptions		  = 263    
   173 /*<branchInfo originator="juhuusit" since="07-04-10" category="new_feature" error=”none”>
   174 <MCSS_5132_OFF_CYCLE_SW_INT>
   175 </branchInfo>*/
   176 // BRANCH 07-04-10 : juhuusit
   177     ,
   178     EGenericParamDialMenuServiceEntry   = 270,
   179     EGenericParamDialMenuServiceOptions = 271
   180 // BRANCH_END 07-04-10 : juhuusit
   181 
   182 
   183 /*<branchInfo originator="gronoff" since="08-28-08" category="new_feature" error=”none”>
   184 <PF5250_OFF_CYCLE_SW_INT>
   185 </branchInfo>*/
   186 // BRANCH 08-28-08: gronoff
   187     ,
   188     EGenericParamCNAP									= 290,
   189     
   190     EGenericParamXSpId                  = 1919,
   191     EGenericParamFirstName              = 1920,
   192     EGenericParamLastName               = 1921,
   193     EGenericParamNickname               = 1922
   194 // BRANCH_END 08-28-08: gronoff
   195     };
   196 
   197 
   198 // String constants for above sematic ids to be used in content matching.
   199 
   200 #define EGenericParamUnspecifiedStr    "0"
   201 #define EGenericParamErrorStr          "1"
   202 #define EGenericParamDirStr            "2"
   203 #define EGenericParamFileStr           "3"
   204 #define EGenericParamURLStr            "4"
   205 #define EGenericParamApplicationStr    "5"
   206 #define EGenericParamInstallPackageStr "6"
   207 #define EGenericParamDRMFileStr        "7"
   208 #define EGenericParamMIMETypeStr       "8"
   209 #define EGenericParamCharSetStr        "9"
   210 #define EGenericParamServiceCommandStr "10"
   211 #define EGenericParamInternalFileStr   "11"
   212 
   213 #define EGenericParamContactItemStr    "20"
   214 #define EGenericParamCalendarItemStr   "21"
   215 #define EGenericParamMessageItemStr    "22"
   216 #define EGenericParamNoteItemStr       "23"
   217 #define EGenericParamHelpItemStr       "24"
   218 #define EGenericParamAlarmItemStr      "25"
   219 #define EGenericParamLogItemStr        "26"
   220 #define EGenericParamPhoneNumberStr    "27"
   221 #define EGenericParamAccessPointStr    "28"
   222 #define EGenericParamSIPAddressStr     "29"
   223 
   224 #define EGenericParamMessageItemSMSStr   "30"
   225 #define EGenericParamMessageItemEMailStr "31"
   226 #define EGenericParamMessageItemMMSStr   "32"
   227 
   228 #define EGenericParamEmailAddressStr    "33"
   229 #define EGenericParamWVIDStr            "34"
   230 #define EGenericParamDateTimeStr        "35"
   231 
   232 #define EGenericParamMessageItemMboxStr "36"
   233 
   234 #define EGenericParamSIMContactItemStr "40"
   235 #define EGenericParamSIMAppItemStr     "41"
   236 
   237 #define EGenericParamReferringURIStr   "50"    
   238 
   239 #define EGenericParamPlayerInitModeStr "60"
   240 #define EGenericParamAlbumItemsStr     "61"
   241 #define EGenericParamAlbumNameStr      "62"
   242 
   243 #define EGenericParamPrintXMLFileStr   "70"
   244 
   245 #define EGenericParamCallDialDataV1Str "80"
   246 #define EGenericParamCallDialDataStr   "81"
   247 
   248 #define EGenricParamMGItemTypeStr                 "90" 
   249 #define EGeneriParamMGMediaTypeStr                "91"
   250 #define EGeneriParamMGViewTypeStr                 "92"
   251 #define EGenericParamMGSubviewtypeStr             "93"
   252 #define EGenericParamMGMarkedStr                  "94"
   253 #define EGenericParamCdmaExtendedAMSDataStr       "95"
   254 #define EGenericParamCdmaExtendedLightSurfDataStr "96"
   255 
   256 #define EGenericParamSilentDownloadStr  "110"
   257 #define EGenericParamSuppressLaunchStr  "111"
   258 #define EGenericParamSuppressNextUrlStr "112"
   259 
   260 #define EGenericParamPoCDataStr       "120"
   261 #define EGenericParamPoCLaunchViewStr "121"    
   262 
   263 #define EGenericParamAllowMoveStr      "130"
   264 #define EGenericParamAllowSaveStr      "131"
   265 
   266 #define EGenericParamFileSavedStr      "140"
   267 
   268 #define EGenericParamLocationStr       "150"
   269 
   270 #define EGenericParamFotaPkgIdStr      "160"
   271 
   272 #define EGenericParamMMSSizeLimitStr   "170"
   273 #define EGenericParamResolutionStr     "171"
   274 
   275 #define EGenericParamSuppressDownloadConfirmationStr "180"
   276 #define EGenericParamDownloadIdStr                   "181" 
   277      
   278 #define EGenericParamPasswordStr       "190"
   279 #define EGenericParamUserNameStr       "191"
   280 #define EGenericParamBookmarkNameStr   "192"    
   281 
   282 #define EGenericParamContactSelectionDataStr    "200"
   283 #define EGenericParamContactLinkArrayStr        "201"
   284 #define EGenericParamContactStoreUriArrayStr    "202"
   285 #define EGenericParamSelectedCountStr           "203"
   286 #define EGenericParamContactAssignDataStr       "204"
   287 
   288 #define EGenericParamLandmarkStr                "210"
   289 #define EGenericParamLandmarkDatabaseStr        "211"
   290 #define EGenericParamLandmarkIdStr              "212"
   291 #define EGenericParamLandmarkIdListStr          "213"
   292 #define EGenericParamMnCommonOptionsStr         "214"
   293 #define EGenericParamMnMapViewOptionsStr        "215"
   294 #define EGenericParamMnGeocodingOptionsStr      "216"
   295 #define EGenericParamRequestTextStr             "217"
   296 
   297 #define EGenericParamModeActivationStr          "220"
   298 #define EGenericParamDisplayStringStr           "221"
   299 
   300 #define EGenericParamSpeedDialIndexStr          "230"
   301 
   302 #define EGenericParamKeywordsStr                "240"
   303 #define EGenericParamCallAppLocNameStr          "241"
   304 #define EGenericParamStartOptionStr             "242"
   305 #define EGenericParamSearchContentStr           "243"
   306 
   307 #define EGenericParamTerminateStr               "250"
   308 #define EGenericParamSlideshowStr               "251"
   309 
   310 #define EGenericParamSearchDomainStr            "260"
   311 #define EGenericParamSearchSubjectStr			"261"
   312 #define EGenericParamSearchProviderStr			"262"
   313 #define EGenericParamSearchOptionsStr			"263"
   314 
   315 /*<branchInfo originator="juhuusit" since="07-04-10" category="new_feature" error=”none”>
   316 <MCSS_5132_OFF_CYCLE_SW_INT>
   317 </branchInfo>*/
   318 // BRANCH 07-04-10 : juhuusit
   319 #define EGenericParamDialMenuServiceEntryStr            "270"
   320 #define EGenericParamDialMenuServiceOptionsStr          "271"
   321 // BRANCH_END 07-04-10 : juhuusit
   322 
   323 /*<branchInfo originator="gronoff" since="08-28-08" category="new_feature" error=”none”>
   324 <PF5250_OFF_CYCLE_SW_INT>
   325 </branchInfo>*/
   326 // BRANCH 08-28-08: gronoff
   327 
   328 #define EGenericParamCNAPStr										"290"
   329 
   330 #define EGenericParamXSpIdEntryStr              "1919"
   331 #define EGenericParamFirstNameEntryStr          "1920"
   332 #define EGenericParamLastNameEntryStr           "1921"
   333 #define EGenericParamNicknameEntryStr           "1922"
   334 // BRANCH_END 08-28-08: gronoff
   335 
   336 #endif // AIW_GENERIC_PARAM_HRH
   337 
   338 // End of file
   339