epoc32/include/app/VPbkFieldType.hrh
branchSymbian3
changeset 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/app/VPbkFieldType.hrh	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -0,0 +1,276 @@
     1.4 +/*
     1.5 +* Copyright (c) 2002-2007 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of "Eclipse Public License v1.0"
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description:  Data types for the field type system
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +#ifndef VPBKFIELDTYPE_HRH
    1.23 +#define VPBKFIELDTYPE_HRH
    1.24 +
    1.25 +/**
    1.26 + * Virtual Phonebook field data storage types.
    1.27 + * @see MVPbkContactFieldData::DataType
    1.28 + */
    1.29 +enum TVPbkFieldStorageType
    1.30 +    {
    1.31 +    /// Undefined storage
    1.32 +    EVPbkFieldStorageTypeNull = -1,
    1.33 +    /// Text storage
    1.34 +    EVPbkFieldStorageTypeText = 0,
    1.35 +    /// Binary (BLOB) storage
    1.36 +    EVPbkFieldStorageTypeBinary,
    1.37 +    /// Date/Time storage
    1.38 +    EVPbkFieldStorageTypeDateTime,
    1.39 +    /// URI storage
    1.40 +    EVPbkFieldStorageTypeUri,
    1.41 +    /// Maximum number of field storage types supported.
    1.42 +    KVPbkMaxFieldStorageTypes = 16
    1.43 +    };
    1.44 +
    1.45 +/**
    1.46 + * Virtual Phonebook field type names. Based on the Versit 2.1 & 3.0 standards.
    1.47 + * @see MVPbkFieldType::TypeName
    1.48 + */
    1.49 +enum TVPbkFieldTypeName
    1.50 +    {
    1.51 +    EVPbkVersitNameNone = 0,
    1.52 +    EVPbkVersitNameFN,
    1.53 +    EVPbkVersitNameN,
    1.54 +    EVPbkVersitNamePHOTO,
    1.55 +    EVPbkVersitNameBDAY,
    1.56 +    EVPbkVersitNameADR,
    1.57 +    EVPbkVersitNameLABEL,
    1.58 +    EVPbkVersitNameTEL,
    1.59 +    EVPbkVersitNameEMAIL,
    1.60 +    EVPbkVersitNameMAILER,
    1.61 +    EVPbkVersitNameTZ,
    1.62 +    EVPbkVersitNameGEO,
    1.63 +    EVPbkVersitNameTITLE,
    1.64 +    EVPbkVersitNameROLE,
    1.65 +    EVPbkVersitNameLOGO,
    1.66 +    EVPbkVersitNameAGENT,
    1.67 +    EVPbkVersitNameORG,
    1.68 +    EVPbkVersitNameCATEGORIES,  // Versit 3.0
    1.69 +    EVPbkVersitNameNOTE,
    1.70 +    EVPbkVersitNamePRODID,      // Versit 3.0
    1.71 +    EVPbkVersitNameREV,
    1.72 +    EVPbkVersitNameSORTSTRING,  // Versit 3.0
    1.73 +    EVPbkVersitNameSOUND,
    1.74 +    EVPbkVersitNameURL,
    1.75 +    EVPbkVersitNameUID,
    1.76 +    EVPbkVersitNameVERSION,
    1.77 +    EVPbkVersitNameCLASS,       // Versit 3.0
    1.78 +    EVPbkVersitNameKEY,
    1.79 +    EVPbkVersitNameX,
    1.80 +    EVPbkVersitNameTopContact,
    1.81 +    EVPbkVersitNameIMPP,
    1.82 +    /// Number of field type names
    1.83 +    KVPbkVersitNameCount // keep last
    1.84 +    };
    1.85 +
    1.86 +/**
    1.87 + * Virtual Phonebook field types not supported by the Versit 2.1 standard.
    1.88 + * @see MVPbkFieldType::NonVersitType
    1.89 + */
    1.90 +enum TVPbkNonVersitFieldType
    1.91 +    {
    1.92 +    EVPbkNonVersitTypeNone = 0,
    1.93 +    EVPbkNonVersitTypeDTMF,
    1.94 +    EVPbkNonVersitTypeRingTone,
    1.95 +    EVPbkNonVersitTypeLocationPrivacy,
    1.96 +    /// Generic label field type for folded view names and group labels
    1.97 +    EVPbkNonVersitTypeGenericLabel,
    1.98 +    /// Field type for caller object image
    1.99 +    EVPbkNonVersitTypeCodImage,
   1.100 +    /// Field type for caller object text
   1.101 +    EVPbkNonVersitTypeCodText,
   1.102 +    /// Number of non versit types
   1.103 +    KVPbkNonVersitTypeCount // keep last
   1.104 +    };
   1.105 +
   1.106 +/**
   1.107 + * Symbolic names for Virtual Phonebook subfield types.
   1.108 + */
   1.109 +enum TVPbkSubFieldType
   1.110 +    {
   1.111 +    EVPbkVersitSubFieldNone = 0,
   1.112 +    
   1.113 +    // Subfields for the "N" property
   1.114 +    EVPbkVersitSubFieldFamilyName = 0,
   1.115 +    EVPbkVersitSubFieldGivenName,
   1.116 +    EVPbkVersitSubFieldAdditionalName,
   1.117 +    EVPbkVersitSubFieldNamePrefix,
   1.118 +    EVPbkVersitSubFieldNameSuffix,
   1.119 +    
   1.120 +    // Subfields for the "ADR" property
   1.121 +    EVPbkVersitSubFieldPostOfficeAddress = 0,
   1.122 +    EVPbkVersitSubFieldExtendedAddress,
   1.123 +    EVPbkVersitSubFieldStreet, 
   1.124 +    EVPbkVersitSubFieldLocality, 
   1.125 +    EVPbkVersitSubFieldRegion,
   1.126 +    EVPbkVersitSubFieldPostalCode, 
   1.127 +    EVPbkVersitSubFieldCountry,
   1.128 +
   1.129 +    // Subfields for the "ORG" property
   1.130 +    EVPbkVersitSubFieldOrgName = 0,
   1.131 +    EVPbkVersitSubFieldOrgUnit,
   1.132 +
   1.133 +    // Subfields for the "SOUND" property
   1.134 +    EVPbkVersitSubFieldFamilyNamePronunciation = 0,
   1.135 +    EVPbkVersitSubFieldGivenNamePronunciation,
   1.136 +    EVPbkVersitSubFieldCompanyNamePronunciation,
   1.137 +
   1.138 +    // Subfields for the "PHOTO" property
   1.139 +    EVPbkVersitSubFieldPicture = 0
   1.140 +    };
   1.141 +
   1.142 +/**
   1.143 + * Virtual Phonebook field type parameters. Based on the Versit 2.1 standard.
   1.144 + * @see TVPbkFieldTypeParameters
   1.145 + * @see MVPbkFieldType::TypeParameters()
   1.146 + */
   1.147 +enum TVPbkFieldTypeParameter
   1.148 +    {
   1.149 +    // General parameters
   1.150 +    EVPbkVersitParamHOME,
   1.151 +    EVPbkVersitParamWORK,
   1.152 +    EVPbkVersitParamPREF,
   1.153 +    // spare for additional general parameters
   1.154 +
   1.155 +    // Address parameters
   1.156 +    EVPbkVersitParamDOM = 8,
   1.157 +    EVPbkVersitParamINTL,
   1.158 +    EVPbkVersitParamPOSTAL,
   1.159 +    EVPbkVersitParamPARCEL,
   1.160 +    // spare for additional address parameters
   1.161 +
   1.162 +    // Telephone parameters
   1.163 +    EVPbkVersitParamVOICE = 24,
   1.164 +    EVPbkVersitParamFAX,
   1.165 +    EVPbkVersitParamMSG,
   1.166 +    EVPbkVersitParamCELL,
   1.167 +    EVPbkVersitParamPAGER,
   1.168 +    EVPbkVersitParamBBS,
   1.169 +    EVPbkVersitParamMODEM,
   1.170 +    EVPbkVersitParamCAR,
   1.171 +    EVPbkVersitParamISDN,
   1.172 +    EVPbkVersitParamVIDEO,
   1.173 +    // spare for additional telephone parameters
   1.174 +
   1.175 +    // Email parameters
   1.176 +    EVPbkVersitParamAOL = 56,
   1.177 +    EVPbkVersitParamAppleLink,
   1.178 +    EVPbkVersitParamATTMail,
   1.179 +    EVPbkVersitParamCIS,
   1.180 +    EVPbkVersitParameWorld,
   1.181 +    EVPbkVersitParamINTERNET,
   1.182 +    EVPbkVersitParamIBMMail,
   1.183 +    EVPbkVersitParamMCIMail,
   1.184 +    EVPbkVersitParamPOWERSHARE,
   1.185 +    EVPbkVersitParamPRODIGY,
   1.186 +    EVPbkVersitParamTLX,
   1.187 +    EVPbkVersitParamX400,
   1.188 +    // spare for additional email parameters
   1.189 +
   1.190 +    // Key parameters
   1.191 +    EVPbkVersitParamX509 = 72,
   1.192 +    EVPbkVersitParamPGP,
   1.193 +    // spare for additional key parameters
   1.194 +
   1.195 +    // Image types
   1.196 +    EVPbkVersitParamGIF = 88,
   1.197 +    EVPbkVersitParamCGM,
   1.198 +    EVPbkVersitParamWMF,
   1.199 +    EVPbkVersitParamBMP,
   1.200 +    EVPbkVersitParamMET,
   1.201 +    EVPbkVersitParamPMB,
   1.202 +    EVPbkVersitParamDIB,
   1.203 +    EVPbkVersitParamPICT,
   1.204 +    EVPbkVersitParamTIFF,
   1.205 +    EVPbkVersitParamPS,
   1.206 +    EVPbkVersitParamPDF,
   1.207 +    EVPbkVersitParamJPEG,
   1.208 +    EVPbkVersitParamMPEG,
   1.209 +    EVPbkVersitParamMPEG2,
   1.210 +    EVPbkVersitParamAVI,
   1.211 +    EVPbkVersitParamQTIME,
   1.212 +    EVPbkVersitParamPNG,
   1.213 +    EVPbkVersitParamJP2,
   1.214 +    // spare for additional image types
   1.215 +
   1.216 +    // Sound types
   1.217 +    EVPbkVersitParamWAVE = 112,
   1.218 +    EVPbkVersitParamPCM,
   1.219 +    EVPbkVersitParamAIFF,
   1.220 +    // spare for additional sound types
   1.221 +
   1.222 +    /// SIP parameters
   1.223 +    EVPbkVersitParamVOIP = 120,
   1.224 +    EVPbkVersitParamSWIS,
   1.225 +    EVPbkVersitParamPOC,
   1.226 +    EVPbkVersitParamSIP,
   1.227 +
   1.228 +    // Reuse this first for parameters that don't match the categories above
   1.229 +    EVPbkVersitParamOther = 128,
   1.230 +
   1.231 +    /// Maximum number of versit parameters supported.
   1.232 +    KVPbkMaxVersitParams = 256 // this must be a power of 2!
   1.233 +    };
   1.234 +    
   1.235 +enum TVPbkDefaultType
   1.236 +    {
   1.237 +    /// Defaults
   1.238 +    EVPbkDefaultTypeUndefined,
   1.239 +    EVPbkDefaultTypePhoneNumber, 
   1.240 +    EVPbkDefaultTypeVideoNumber, 
   1.241 +    EVPbkDefaultTypeSms,
   1.242 +    EVPbkDefaultTypeMms, 
   1.243 +    EVPbkDefaultTypeEmail, 
   1.244 +    EVPbkDefaultTypeEmailOverSms,
   1.245 +    EVPbkDefaultTypeVoIP,
   1.246 +    EVPbkDefaultTypePOC,
   1.247 +    EVPbkDefaultTypeChat,
   1.248 +    EVPbkDefaultTypeOpenLink,
   1.249 +    
   1.250 +    // This has to be last in the enumeration
   1.251 +    EVPbkLastDefaultType                
   1.252 +    };
   1.253 +
   1.254 +enum TVPbkSpeedDialIndex
   1.255 +    {
   1.256 +    /// Speed dials
   1.257 +    EVPbkSpeedDial1 = 0,
   1.258 +    EVPbkSpeedDial2,
   1.259 +    EVPbkSpeedDial3,
   1.260 +    EVPbkSpeedDial4,
   1.261 +    EVPbkSpeedDial5,
   1.262 +    EVPbkSpeedDial6,
   1.263 +    EVPbkSpeedDial7,
   1.264 +    EVPbkSpeedDial8,
   1.265 +    EVPbkSpeedDial9
   1.266 +    };
   1.267 +
   1.268 +/**
   1.269 + * The version of the field type selector
   1.270 + */
   1.271 +enum TVPbkFieldTypeSelectorVersion
   1.272 +    {
   1.273 +    EVPbkFieldTypeSelectorV1 = 1,
   1.274 +    EVPbkFieldTypeSelectorV2 = 2
   1.275 +    };
   1.276 +
   1.277 +#endif  // VPBKFIELDTYPE_HRH
   1.278 +
   1.279 +// End of File