// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.eclipse.org/legal/epl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

//

#ifndef __CNTDEF_H__

#define __CNTDEF_H__

#include <e32base.h>

#if !( defined __SYMBIAN_CNTMODEL_HIDE_DBMS__ )

#include <d32dbms.h>

#else

#include <s32std.h>

#include <f32file.h>

#endif

#include <cntdef.hrh>

// Constants

/**

@publishedAll 

@released

*/

const TInt KSpeedDialPhoneLength = 64;

/**

@publishedAll

@released

*/

const TInt KCntMinSpeedDialIndex = 1;

/**

@publishedAll

@released

*/

const TInt KCntMaxSpeedDialIndex = 9;

/**

Phone Match Length

@publishedAll

@released

*/

const TInt KMaxPhoneMatchLength = 15;

/**

@publishedAll

@released

*/

const TInt KLowerSevenDigits = 7;

/**

Used for firstname, lastname, companyname, secondname and their

associated pronunciation fields and e-mail address

@publishedAll

@released

*/

const TInt KCntMaxTextFieldLength=255;

// Type definitions

/**

@publishedAll

@released

*/

typedef TBuf<KSpeedDialPhoneLength> TSpeedDialPhoneNumber;

/** Contact item ID. These are used to uniquely identify contact items within a

contacts database. Contact items include contact cards, contact card templates,

contact card groups and own cards. Contact item IDs are also used to uniquely

identify agents.

@publishedAll

@released

*/

typedef TInt32 TContactItemId;

/** A UID which identifies a contact item field's type. The possible values are

defined as UIDs in cntdef.h.

@publishedAll

@released

*/

typedef TUid TFieldType;

/** A contact item field's storage type.

This is an unsigned integer value which identifies the type of data stored

in a contact item field. The possible values are defined in cntdef.hrh as:

- KStorageTypeText (used by CContactTextFields)

- KStorageTypeStore (used by CContactStoreFields)

- KStorageTypeContactItemId (used by CContactAgentFields)

- KStorageTypeDateTime (used by CContactDateFields)

Note that numeric fields are not supported. Numbers (e.g. telephone

numbers) are stored in the database using text fields.

@publishedAll

@released

*/

typedef TUint TStorageType;

/** Machine identifier.

This is used when synchronising the contact database to identify the

machine with which the database has been synchronised.

@see CContactDatabase::SetLastSyncDateL()

@see CContactDatabase::GetLastSyncDateL().

@publishedAll

@released

*/

typedef TInt32 TContactSyncId;

/** Stores the value of KUidContactsDbFile as an integer.

@publishedAll

@released

*/

const TInt KUidContactsDbFileValue=0x100065FF;

/**

The third UID of the contacts database file, c:\\system\\data\\contacts.cdb.

This should be used by file recogniser implementations.

@publishedAll

@released

*/

const TUid KUidContactsDbFile={KUidContactsDbFileValue};

/** NULL contact item ID. Indicates that no contact item is present.

@publishedAll

@released

*/

const TContactItemId KNullContactId=-1;

/**

The ID of the system template.

@publishedAll

@released

*/

const TContactItemId KGoldenTemplateId=0;

/** Identifies a vCard that has been pasted from the clipboard into the Contacts application.

@publishedAll

@released

*/

const TUid KClipboardUidTypeVCard={0x100038f6};

/** Identifies a contact card (CContactCard).

@publishedAll

@released

*/

const TUid KUidContactCard={KUidContactCardValue};

/** Identifies a contact group (CContactGroup).

@publishedAll

@released

*/

const TUid KUidContactGroup={KUidContactGroupValue};

/** Identifies the system template (CContactTemplate).

@publishedAll

@released

*/

const TUid KUidContactTemplate={KUidContactTemplateValue};

/** Identifies an own card (CContactOwnCard).

@publishedAll

@released

*/

const TUid KUidContactOwnCard={KUidContactOwnCardValue}; 

/** Identifies a non-system template (CContactCardTemplate). 

@publishedAll

@released

*/

const TUid KUidContactCardTemplate={KUidContactCardTemplateValue};

/** The UID that identifies ICC entries. These are a special type of

contact item that are stored in the SIM (ICC) card on the phone.

@publishedAll

@released

*/

const TUid KUidContactICCEntry={KUidContactICCEntryValue};

/** Identifies any CContactItem-derived class (all of the above).

@publishedAll

@released

*/

const TUid KUidContactItem={0x10005673};

/** This identifies the CContactCard and CContactGroup classes.

It is used internally by the contacts model.

@publishedAll

@released

*/

const TUid KUidContactCardOrGroup={0x10005F71};

/*

 * Speed-dial UIDs.

 * These are used to indicate the speed-dial position for a particular field.

 * They are added to the content type of a phone number field set as a

 * speed-dial using CContactDatabase::SetFieldAsSpeedDialL().

 */

/** Field maps to the first speed dial position.

@publishedAll

@released

*/

const TUid KUidSpeedDialOne={KUidSpeedDialOneValue};

/** Field maps to the second speed dial position.

@publishedAll

@released

*/

const TUid KUidSpeedDialTwo={KUidSpeedDialTwoValue};

/** Field maps to the third speed dial position.

@publishedAll

@released

*/

const TUid KUidSpeedDialThree={KUidSpeedDialThreeValue};

/** Field maps to the fourth speed dial position.

@publishedAll

@released

*/

const TUid KUidSpeedDialFour={KUidSpeedDialFourValue};

/** Field maps to the fifth speed dial position.

@publishedAll

@released

*/

const TUid KUidSpeedDialFive={KUidSpeedDialFiveValue};

/** Field maps to the sixth speed dial position.

@publishedAll

@released

*/

const TUid KUidSpeedDialSix={KUidSpeedDialSixValue};

/** Field maps to the seventh speed dial position.

@publishedAll

@released

*/

const TUid KUidSpeedDialSeven={KUidSpeedDialSevenValue};

/** Field maps to the eighth speed dial position.

@publishedAll

@released

*/

const TUid KUidSpeedDialEight={KUidSpeedDialEightValue};

/** Field maps to the ninth speed dial position.

@publishedAll

@released

*/

const TUid KUidSpeedDialNine={KUidSpeedDialNineValue};

/*

 * Contact field type UIDs.

 */

/** Address field.

@publishedAll

@released

*/

const TUid KUidContactFieldAddress={KUidContactFieldAddressValue};

/** Post office box field.

@publishedAll

@released

*/

const TUid KUidContactFieldPostOffice={KUidContactFieldPostOfficeValue};

/** Extended address field.

@publishedAll

@released

*/

const TUid KUidContactFieldExtendedAddress={KUidContactFieldExtendedAddressValue};

/** Locality field.

@publishedAll

@released

*/

const TUid KUidContactFieldLocality={KUidContactFieldLocalityValue};

/** Region field.

@publishedAll

@released

*/

const TUid KUidContactFieldRegion={KUidContactFieldRegionValue};

/** Post code field.

@publishedAll

@released

*/

const TUid KUidContactFieldPostcode={KUidContactFieldPostCodeValue};

/** Country field.

@publishedAll

@released

*/

const TUid KUidContactFieldCountry={KUidContactFieldCountryValue};

/** Company name field.

@publishedAll

@released

*/

const TUid KUidContactFieldCompanyName={KUidContactFieldCompanyNameValue};

/** Company name pronunciation field.

@publishedAll

@released

*/

const TUid KUidContactFieldCompanyNamePronunciation={KUidContactFieldCompanyNamePronunciationValue};

/** Phone number field.

@publishedAll

@released

*/

const TUid KUidContactFieldPhoneNumber={KUidContactFieldPhoneNumberValue};

/** Given name field.

@publishedAll

@released

*/

const TUid KUidContactFieldGivenName={KUidContactFieldGivenNameValue};

/** Family name field.

@publishedAll

@released

*/

const TUid KUidContactFieldFamilyName={KUidContactFieldFamilyNameValue};

/** Given name pronunciation field.

@publishedAll

@released

*/

const TUid KUidContactFieldGivenNamePronunciation={KUidContactFieldGivenNamePronunciationValue};

/** Family name pronunciation field.

@publishedAll

@released

*/

const TUid KUidContactFieldFamilyNamePronunciation={KUidContactFieldFamilyNamePronunciationValue};

/** Middle name field.

@publishedAll

@released

*/

const TUid KUidContactFieldAdditionalName={KUidContactFieldAdditionalNameValue};

/** Name suffix field.

@publishedAll

@released

*/

const TUid KUidContactFieldSuffixName={KUidContactFieldSuffixNameValue};

/** Name prefix field.

@publishedAll

@released

*/

const TUid KUidContactFieldPrefixName={KUidContactFieldPrefixNameValue};

/** Hidden field.

@publishedAll

@released

*/

const TUid KUidContactFieldHidden={KUidContactFieldHiddenValue};

/** Hidden field.

@publishedAll

@released

*/

const TUid KUidContactFieldDefinedText={KUidContactFieldDefinedTextValue};

/** Email address field.

@publishedAll

@released

*/

const TUid KUidContactFieldEMail={KUidContactFieldEMailValue};

/** Telephone number used for a messaging service.

@publishedAll

@released

*/

const TUid KUidContactFieldMsg={KUidContactFieldMsgValue};

/** Telephone number used for SMS messages.

@publishedAll

@released

*/

const TUid KUidContactFieldSms={KUidContactFieldSmsValue};

/** Fax number field.

@publishedAll

@released

*/

const TUid KUidContactFieldFax={KUidContactFieldFaxValue};

/** Comment field.

@publishedAll

@released

*/

const TUid KUidContactFieldNote={KUidContactFieldNoteValue};

/** Comment field.

@publishedAll

@released

*/

const TUid KUidContactStorageInline={KUidContactFieldStorageInlineValue};

/** Birthday field.

@publishedAll

@released

*/

const TUid KUidContactFieldBirthday={KUidContactFieldBirthdayValue};

/** URL field.

@publishedAll

@released

*/

const TUid KUidContactFieldUrl={KUidContactFieldUrlValue};

/** Template label field (a label which is used to refer to a template, for instance "work

template", "personal template").

@publishedAll

@released

*/

const TUid KUidContactFieldTemplateLabel={KUidContactFieldTemplateLabelValue};

/** A picture field, for instance a logo or a photo.

@publishedAll

@released

*/

const TUid KUidContactFieldPicture={KUidContactFieldPictureValue};

/** Used internally by the contacts model.

@publishedAll

@released

*/

const TUid KUidContactFieldDTMF={KUidContactFieldDTMFValue};

/** Identifies a ring tone field. This is a ring tone that is associated with a contact item.

@publishedAll

@released

*/

const TUid KUidContactFieldRingTone={KUidContactFieldRingToneValue};

/** Identifies a job title field.

@publishedAll

@released

*/

const TUid KUidContactFieldJobTitle={KUidContactFieldJobTitleValue};

/** Identifies an instant messaging address field.

@publishedAll

@released

*/

const TUid KUidContactFieldIMAddress = { KUidContactFieldIMAddressValue };

/** Identifies a USIM second name field. This field is provided to

store an additional representation of the contact's name, such as a

nickname or a different representation. An example could be a Japanese

contact which has a romanised name and an alternative representation using

kanji (pictogram) characters.

@publishedAll

@released

*/

const TUid KUidContactFieldSecondName = { KUidContactFieldSecondNameValue };

/** Identifies a SIP identity field.

@publishedAll

@released

*/

const TUid KUidContactFieldSIPID = { KUidContactFieldSIPIDValue };

/** Identifies a Assistant field.

@publishedAll

@released

*/

const TUid KUidContactFieldAssistant = { KUidContactFieldAssistantValue };

/** Identifies an Anniversary field.

@publishedAll

@released

*/

const TUid KUidContactFieldAnniversary = { KUidContactFieldAnniversaryValue };

/** Identifies a Spouse field.

@publishedAll

@released

*/

const TUid KUidContactFieldSpouse = { KUidContactFieldSpouseValue };

/** Identifies a Children field.

@publishedAll

@released

*/

const TUid KUidContactFieldChildren = { KUidContactFieldChildrenValue };

/** Identifies a Class field.

@publishedAll

@released

*/

const TUid KUidContactFieldClass = { KUidContactFieldClassValue };

/** Identifies a Department field.

@publishedAll

@released

*/

const TUid KUidContactFieldDepartmentName = { KUidContactFieldDepartmentNameValue };

/*

* CContactICCEntry (Telephony specific) UIDs.

 */

/** Identifies an ICC slot contact field in the contact item.

@publishedAll

@released

*/

const TUid KUidContactFieldICCSlot={KUidContactFieldICCSlotValue};

/** Identifies an ICC Phonebook contact field in the contact item.

@publishedAll

@released

*/

const TUid KUidContactFieldICCPhonebook={KUidContactFieldICCPhonebookValue};

/** Identifies an ICC Group contact field in the contact item.

@publishedAll

@released

*/

const TUid KUidContactFieldICCGroup={KUidContactFieldICCGroupValue};

/** Identifies a voice dial field. This is a voice recording associated with a telephone number

field in the item.

@publishedAll

@released

*/

const TUid KUidContactsVoiceDialField={KUidContactsVoiceDialFieldValue};

/** Identifies a Geo field in the contact item. 

@publishedAll

@released

*/

const TUid KUidContactFieldGEO={KUidContactFieldGEOValue};

/** Indicates no field present.

@publishedAll

@released

*/

const TUid KUidContactFieldNone={KUidContactFieldNoneValue};

/** Used in field type matching to indicate that all field types match.

@publishedAll

@released

*/

const TInt32 KUidContactFieldMatchAllValue=0x110FFF22;

/** Used in field type matching to indicate that all field types match.

@publishedAll

@released

*/

const TUid KUidContactFieldMatchAll={KUidContactFieldMatchAllValue};

/*

 * Contact field type vCard mappings.

 * The vCard mapping describes how the field should be handled by the

 * vCard import/export code.

 */

/** Field type maps to the Post office box field in an ADR vCard property value.

@publishedAll

@released

*/

const TUid KUidContactFieldVCardMapPOSTOFFICE={KIntContactFieldVCardMapPOSTOFFICE};

/** Field type maps to the Extended address field in an ADR vCard property value.

@publishedAll

@released