epoc32/include/app/cntitem.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 epoc32/include/cntitem.h@2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
williamr@2
     1
// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
// Persistence layer exports
williamr@2
    15
// 
williamr@2
    16
//
williamr@2
    17
williamr@2
    18
#if !defined(__CNTITEM_H__)
williamr@2
    19
#define __CNTITEM_H__
williamr@2
    20
williamr@2
    21
#if !defined(__E32BASE_H__)
williamr@2
    22
#include <e32base.h>
williamr@2
    23
#endif
williamr@2
    24
williamr@2
    25
#if !defined(__CNTDEF_H__)
williamr@2
    26
#include <cntdef.h>
williamr@2
    27
#endif
williamr@2
    28
williamr@2
    29
#if !defined(__CNTFIELD_H__)
williamr@2
    30
#include <cntfield.h>
williamr@2
    31
#endif
williamr@2
    32
williamr@2
    33
#include <cntdb.h>
williamr@2
    34
williamr@2
    35
williamr@2
    36
const TInt KUidStringLength =244;
williamr@2
    37
#define KUidStringSeparator '-'
williamr@2
    38
class CContactItemField;
williamr@2
    39
#define KContactMaxFieldNumber 32
williamr@2
    40
class CContactItemViewDef;
williamr@2
    41
class CContactItem;
williamr@2
    42
williamr@2
    43
const TInt KContactFieldSetSearchAll=-1;
williamr@2
    44
class CContactItemFieldSet : public CBase
williamr@2
    45
/** A contact item's field set. The field set owns an array of contact item fields 
williamr@2
    46
(CContactItemFields). The field set is owned by a contact item, and can be 
williamr@2
    47
retrieved using CContactItem::CardFields(). Use functions in class 
williamr@2
    48
CContactItem to add and remove fields to/from the field set.
williamr@2
    49
williamr@2
    50
A field set can contain more than one field of the same type, but this is 
williamr@2
    51
not advisable as it may cause problems when synchronising the contacts database. 
williamr@2
    52
@publishedAll
williamr@2
    53
@released
williamr@2
    54
*/
williamr@2
    55
	{
williamr@2
    56
	friend class CContactItemField;
williamr@2
    57
	friend class CContactDatabase;
williamr@2
    58
	friend class CContactTables;
williamr@2
    59
	friend class RPplContactTable;
williamr@2
    60
#ifdef __SYMBIAN_CNTMODEL_USE_SQLITE__
williamr@2
    61
    friend class TCntPersistenceUtility;
williamr@2
    62
#endif //__SYMBIAN_CNTMODEL_USE_SQLITE__	
williamr@2
    63
public:
williamr@2
    64
	IMPORT_C static CContactItemFieldSet* NewL();
williamr@2
    65
	IMPORT_C static CContactItemFieldSet* NewLC();
williamr@2
    66
	IMPORT_C ~CContactItemFieldSet();
williamr@2
    67
	inline const CContactItemField& operator[](TInt aIndex) const;
williamr@2
    68
	inline CContactItemField& operator[](TInt aIndex);
williamr@2
    69
	inline TInt Find(TFieldType aFieldType) const; // will only find the first such occurence
williamr@2
    70
	inline TInt Find(TFieldType aFieldType,TUid aMapping) const;
williamr@2
    71
	IMPORT_C TInt FindNext(TFieldType aFieldType,TInt aStartPos=KContactFieldSetSearchAll) const;
williamr@2
    72
	IMPORT_C TInt FindNext(TFieldType aFieldType,TUid aMapping,TInt aStartPos=KContactFieldSetSearchAll) const;
williamr@2
    73
	inline TInt Count() const;
williamr@2
    74
	inline void Reset();
williamr@2
    75
	IMPORT_C void UpdateFieldL(const CContactItemField& aField, TInt aMatchCount);
williamr@2
    76
	IMPORT_C void UpdateFieldSyncL(const CContactItemField& aField, TInt aMatchCount);
williamr@2
    77
	IMPORT_C CContactItemFieldSet& AddL(CContactItemField& aField);
williamr@2
    78
	IMPORT_C void Remove(TInt aIndex);
williamr@2
    79
	IMPORT_C void InsertL(TInt aIndex,CContactItemField& aField);
williamr@2
    80
	IMPORT_C void Move(TInt aFrom, TInt aTo);
williamr@2
    81
	IMPORT_C TStreamId StoreL(CStreamStore& aStore,RWriteStream& aTextStream,CStreamStore& aBlobStore);
williamr@2
    82
	TStreamId StoreL(CStreamStore& aStore,RWriteStream& aTextStream,CStreamStore& aBlobStore,CContactTables* aTables);
williamr@2
    83
	IMPORT_C void RestoreL(CStreamStore& aStore, TStreamId anId,CStreamStore* aBlobStore,const CContactItemViewDef& aViewDef,RReadStream& aReadStream);
williamr@2
    84
	IMPORT_C void RestoreL(CStreamStore& aStore, TStreamId anId,CStreamStore* aBlobStore,const CContactItemViewDef& aViewDef,const CContactItem* aTemplate, HBufC* aTextBuf);
williamr@2
    85
	TInt FieldText(TFieldType aFieldType, TDes &aText, TInt aStartPosition) const;
williamr@2
    86
	CArrayFix<TFieldHeader>* ConstructFieldHeaderArrayLC(RWriteStream& aTextStream, CStreamStore& aBlobStore);
williamr@2
    87
	TInt FieldTypeCount(const CContactItemFieldSet& aSystemTemplateFields, TInt aStartIndex, const CContactItemField& aField) const;
williamr@2
    88
	TBool ContainsFieldTypeMapping(const CContentType& aBaseFieldContentType, const TFieldType& aContactFieldType) const;
williamr@2
    89
	void ExternalizeL(RWriteStream& aStream) const;
williamr@2
    90
	void InternalizeL(RReadStream& aStream);	
williamr@2
    91
private:
williamr@2
    92
	CContactItemFieldSet();
williamr@2
    93
	void ConstructL();
williamr@2
    94
	void SetFieldId(CContactItemField& aField);
williamr@2
    95
	const CContactItemField* FindById(TInt aId) const;
williamr@2
    96
	IMPORT_C TStreamId StoreL(CStreamStore& aStore,const CContactItem* aTemplate,RWriteStream& aStream,CStreamStore& aBlobStore,CContactTables* aTables);
williamr@2
    97
	void RestoreL(CStreamStore& aStore, TStreamId anId, CStreamStore* aBlobStore,const CContactItemViewDef& aViewDef,const CContactItem* aTemplate,RReadStream& aReadStream,CContactTables* aContactsTable, RArray<TInt>* aEmailIdArray);
williamr@2
    98
	void RestoreAndAddTemplateL(CStreamStore& aStore, TStreamId aId,CStreamStore* aBlobStore,const CContactItemViewDef& aViewDef,const CContactItem* aTemplate, RReadStream& aReadStream,CContactTables* aContactsTable,RArray<TInt>* aEmailIdArray);
williamr@2
    99
	TInt MatchTemplateField(const CContentType& aContentType,TUint aUserFlags,TBool &aExactMatch) const;
williamr@2
   100
	static HBufC* LoadTextStreamLC(RReadStream& aStream);
williamr@2
   101
	void NonZeroFieldText(TFieldType aFieldType, TDes &aText) const;
williamr@2
   102
williamr@2
   103
private:
williamr@2
   104
	CArrayPtr<CContactItemField>* iFields;
williamr@2
   105
	};
williamr@2
   106
williamr@2
   107
class CContactDatabase;
williamr@2
   108
class RCntModel;
williamr@2
   109
class CContactItem : public CBase
williamr@2
   110
/** The abstract base class for contact cards, templates and groups. All contact 
williamr@2
   111
items are identified by a contact ID, (TContactItemId), have a last modified 
williamr@2
   112
date/time and own one or more fields (the field set). Contact items also 
williamr@2
   113
have an access count and attributes (e.g. hidden). Note that fields in a contact 
williamr@2
   114
item also have attributes. Attribute values specified in the contact item 
williamr@2
   115
override those in the contained fields. The access count is a record of the 
williamr@2
   116
number of objects referencing a contact item. A contact item cannot be fully 
williamr@2
   117
deleted until its access count is zero. 
williamr@2
   118
@publishedAll
williamr@2
   119
@released
williamr@2
   120
*/
williamr@2
   121
	{
williamr@2
   122
	friend class CContactCardTemplate;
williamr@2
   123
	friend class CContactItemPlusGroup;
williamr@2
   124
	friend class CContactCard;
williamr@2
   125
	friend class CContactTemplate;
williamr@2
   126
	friend class CContactGroup;
williamr@2
   127
	friend class CContactOwnCard;
williamr@2
   128
	friend class CVCardToContactsAppConverter;
williamr@2
   129
	friend class CContactICCEntry;
williamr@2
   130
	friend class RPplContactTable;
williamr@2
   131
	friend class RPplIdentityTable;
williamr@2
   132
	friend class RPplPreferencesTable;
williamr@2
   133
	friend class CPackagerTests; //Comparison test
williamr@2
   134
	friend class CPackagerCntComparator;
williamr@2
   135
	friend class CContactDatabase;
williamr@2
   136
	friend class CPplContactItemManager;
williamr@2
   137
public:
williamr@2
   138
	IMPORT_C ~CContactItem();
williamr@2
   139
	/** Gets the contact item's type.
williamr@2
   140
	
williamr@2
   141
	@return The contact item's type. */
williamr@2
   142
	virtual TUid Type() const=0;
williamr@2
   143
	static CContactItem* NewLC(RReadStream& aStream);
williamr@2
   144
	IMPORT_C static CContactItem* NewLC(TUid aType);	
williamr@2
   145
	IMPORT_C TContactItemId Id() const;
williamr@2
   146
	IMPORT_C TContactItemId TemplateRefId() const;
williamr@2
   147
	IMPORT_C TTime LastModified() const;
williamr@2
   148
	IMPORT_C void SetLastModified(const TTime& aLastModified);
williamr@2
   149
	IMPORT_C void AddFieldL(CContactItemField& aField);
williamr@2
   150
	IMPORT_C void RemoveField(TInt aFieldPos);
williamr@2
   151
	IMPORT_C void InsertFieldL(CContactItemField& aField,TInt aFieldPos);
williamr@2
   152
	IMPORT_C CContactItemFieldSet& CardFields() const;
williamr@2
   153
	IMPORT_C void SetHidden(TBool aHidden);
williamr@2
   154
	IMPORT_C void SetSystem(TBool aSystem);    	
williamr@2
   155
	IMPORT_C TBool IsHidden();
williamr@2
   156
	IMPORT_C TBool IsSystem();    	
williamr@2
   157
	IMPORT_C void UpdateFieldSet(CContactItemFieldSet* aNewFieldSet);
williamr@2
   158
	IMPORT_C void SetDeleted(TBool aDeleted);
williamr@2
   159
	IMPORT_C TBool IsDeleted() const;
williamr@2
   160
	IMPORT_C void SetTemplateRefId(TContactItemId aUid);
williamr@2
   161
	TContactItemId Agent();
williamr@2
   162
	inline TBool IsDeletable();
williamr@2
   163
	inline void IncAccessCount();
williamr@2
   164
	inline void DecAccessCount();
williamr@2
   165
	inline TInt AccessCount() const;
williamr@2
   166
	IMPORT_C void SetUidStringL(TDesC& aString);
williamr@2
   167
	IMPORT_C TPtrC UidStringL(TInt64 aMachineUniqueId) const;
williamr@2
   168
	TStreamId PopulateStoreL(CStreamStore& aStore, CArrayFix<TFieldHeader>& aFieldHeaderArray) const;
williamr@2
   169
	void AddLabelFieldL();
williamr@2
   170
	IMPORT_C void RestoreTemplateFieldsL(const CContactItemFieldSet& aSystemTemplateFields, const CContactItemFieldSet& aTemplateFields, const CContactItemViewDef& aViewDef);
williamr@2
   171
	void ClearFieldContent();
williamr@2
   172
	inline TPtrC Guid();
williamr@2
   173
	virtual void ExternalizeL(RWriteStream& aStream) const;
williamr@2
   174
	virtual void InternalizeL(RReadStream& aStream);	
williamr@2
   175
williamr@2
   176
#ifdef __SYMBIAN_CNTMODEL_USE_SQLITE__		
williamr@2
   177
	IMPORT_C void SetId(TContactItemId aId);
williamr@2
   178
	IMPORT_C TUint32 Attributes() const;
williamr@2
   179
	IMPORT_C void SetAttributes(TUint32 aAttributes);
williamr@2
   180
	IMPORT_C void SetAccessCount(TUint32 aAccessCount);
williamr@2
   181
	IMPORT_C void SetCreationDate(const TTime& aTime);
williamr@2
   182
#endif
williamr@2
   183
williamr@2
   184
public:
williamr@2
   185
	/** Contact item's attribute flags 
williamr@2
   186
		
williamr@2
   187
	These flags can be used to set the various attributes of a contact item. */ 
williamr@2
   188
	enum 
williamr@2
   189
	{
williamr@2
   190
	/** To set the contact item's system attribute. */ 
williamr@2
   191
	ESystem=0x01, 
williamr@2
   192
	/** To set the contact item's hidden attribute. */  
williamr@2
   193
	EHidden=0x02, 
williamr@2
   194
	/** To set the contact item's hidden attribute. */  
williamr@2
   195
	ECompressedGuid=0x04, 
williamr@2
   196
	/** To set the contact item's Is deleted attribute. */ 
williamr@2
   197
	EDeleted=0x08 
williamr@2
   198
	};
williamr@2
   199
protected:
williamr@2
   200
private:
williamr@2
   201
	CContactItem();
williamr@2
   202
	void ConstructL();
williamr@2
   203
	void ConstructL(const CContactItem *aTemplate);
williamr@2
   204
	void MakeUidStringL(TInt64 aMachineUniqueId);
williamr@2
   205
	IMPORT_C void SetHasCompressedGuid(TBool aCompressed);
williamr@2
   206
	TBool GuidIsCompressed() const;
williamr@2
   207
	TInt NumberOfFieldsToStore() const;
williamr@2
   208
williamr@2
   209
private:
williamr@2
   210
	CContactItemFieldSet* iFieldSet;
williamr@2
   211
	TUint32 iAttributes;
williamr@2
   212
	TContactItemId iId;
williamr@2
   213
	TContactItemId iTemplateRefId;
williamr@2
   214
	TTime iLastModified;
williamr@2
   215
	TTime iCreationDate;
williamr@2
   216
	TUint32 iAccessCount;
williamr@2
   217
	HBufC* iGuid;
williamr@2
   218
	friend class CContactDatabase;
williamr@2
   219
	};
williamr@2
   220
williamr@2
   221
class CContactItemPlusGroup : public CContactItem
williamr@2
   222
/** Abstract base class for CContactGroup, CContactCard and CContactOwnCard.
williamr@2
   223
williamr@2
   224
The purpose of this class is to avoid duplication of group functionality 
williamr@2
   225
in its derived classes. 
williamr@2
   226
@publishedAll
williamr@2
   227
@released
williamr@2
   228
*/
williamr@2
   229
	{
williamr@2
   230
public:
williamr@2
   231
	IMPORT_C const CContactIdArray* GroupsJoined() const;
williamr@2
   232
	IMPORT_C CContactIdArray* GroupsJoinedLC() const;
williamr@2
   233
protected:
williamr@2
   234
	CContactItemPlusGroup();
williamr@2
   235
	IMPORT_C ~CContactItemPlusGroup();
williamr@2
   236
public:
williamr@2
   237
	virtual void ExternalizeL(RWriteStream& aStream) const;
williamr@2
   238
	virtual void InternalizeL(RReadStream& aStream);	
williamr@2
   239
williamr@2
   240
#ifdef __SYMBIAN_CNTMODEL_USE_SQLITE__	
williamr@2
   241
	IMPORT_C void ResetGroups();
williamr@2
   242
	IMPORT_C void SetGroups(CContactIdArray* aGroups);
williamr@2
   243
#endif
williamr@2
   244
williamr@2
   245
private:
williamr@2
   246
	CContactIdArray* iGroups;
williamr@2
   247
	friend class CContactDatabase;
williamr@2
   248
	friend class RPplLookupGroupsTable;
williamr@2
   249
	friend class RPplGroupMembershipTable;
williamr@2
   250
	};
williamr@2
   251
williamr@2
   252
class CContactGroup : public CContactItemPlusGroup
williamr@2
   253
/** A contact group.
williamr@2
   254
williamr@2
   255
A contact group is a contact item which holds a set of associated contact 
williamr@2
   256
item IDs. The members of the group may be contact cards, own cards, or even 
williamr@2
   257
other groups. The group has a label which identifies the group to users, e.g. 
williamr@2
   258
"family", or "colleagues". The type of a contact group is KUidContactGroup, 
williamr@2
   259
as returned by Type().
williamr@2
   260
williamr@2
   261
Objects of this class are constructed using CContactDatabase::CreateContactGroupL() 
williamr@2
   262
or CreateContactGroupLC(). These functions create the group, optionally with 
williamr@2
   263
a label, add it to the database, and return a pointer to it.
williamr@2
   264
williamr@2
   265
To create an association between a card and a group, use CContactDatabase::AddContactToGroupL() 
williamr@2
   266
and to remove the association, use RemoveContactFromGroupL(). To find out 
williamr@2
   267
which groups a card belongs to, use CContactCard::GroupsJoinedLC() or CContactOwnCard::GroupsJoinedLC().
williamr@2
   268
williamr@2
   269
The function CContactDatabase::GetGroupIdListL() may be used to retrieve a 
williamr@2
   270
list of IDs for all groups in the database. 
williamr@2
   271
@publishedAll
williamr@2
   272
@released
williamr@2
   273
*/
williamr@2
   274
	{
williamr@2
   275
public:
williamr@2
   276
	IMPORT_C static CContactGroup* NewL();
williamr@2
   277
	IMPORT_C static CContactGroup* NewLC();
williamr@2
   278
	IMPORT_C ~CContactGroup();
williamr@2
   279
public: // from CContactItem
williamr@2
   280
	IMPORT_C TUid Type() const;
williamr@2
   281
public:
williamr@2
   282
	// default sorted item array is ascending
williamr@2
   283
	IMPORT_C CContactIdArray* ItemsContainedLC() const;
williamr@2
   284
	IMPORT_C const CContactIdArray* ItemsContained() const;
williamr@2
   285
	IMPORT_C TBool IsSystem() const;
williamr@2
   286
	IMPORT_C void SetSystem(TBool aSystem);
williamr@2
   287
	IMPORT_C TBool ContainsItem(TContactItemId aContactId);
williamr@2
   288
	IMPORT_C void SetGroupLabelL(const TDesC& aLabel);
williamr@2
   289
	IMPORT_C TPtrC GetGroupLabelL();
williamr@2
   290
	IMPORT_C TBool HasItemLabelField();
williamr@2
   291
	IMPORT_C CContactIdArray* GroupsJoinedLC() const;
williamr@2
   292
// 
williamr@2
   293
	//IMPORT_C void ReservedFunction1();
williamr@2
   294
	IMPORT_C void AddContactL(TContactItemId aContactId);
williamr@2
   295
	//IMPORT_C void ReservedFunction2();
williamr@2
   296
	IMPORT_C void RemoveContactL(TContactItemId aContactId);
williamr@2
   297
	virtual void ExternalizeL(RWriteStream& aStream) const;
williamr@2
   298
	virtual void InternalizeL(RReadStream& aStream);
williamr@2
   299
williamr@2
   300
#ifdef __SYMBIAN_CNTMODEL_USE_SQLITE__		
williamr@2
   301
	IMPORT_C void ResetItems();
williamr@2
   302
	IMPORT_C void SetItems(CContactIdArray* aItems);	
williamr@2
   303
#endif
williamr@2
   304
williamr@2
   305
private:
williamr@2
   306
	CContactGroup();
williamr@2
   307
private:
williamr@2
   308
	CContactIdArray* iItems;
williamr@2
   309
	friend class CContactDatabase;
williamr@2
   310
	friend class RPplGroupMembershipTable;
williamr@2
   311
	};
williamr@2
   312
williamr@2
   313
class CContactCardTemplate : public CContactItem
williamr@2
   314
/** A contact card template.
williamr@2
   315
williamr@2
   316
This is a contact item containing a set of fields on which new contact items can 
williamr@2
   317
be based. Templates have a label which is a string which identifies the template 
williamr@2
   318
to a user. For instance, 'work template' could indicate a template used 
williamr@2
   319
to create contact cards in the style of a work colleague. Contact card templates 
williamr@2
   320
have a type of KUidContactCardTemplate, as returned by Type().
williamr@2
   321
williamr@2
   322
Objects of this class cannot be constructed directly because its constructors 
williamr@2
   323
are protected. Instead, use either CContactDatabase::CreateContactCardTemplateL() 
williamr@2
   324
or CreateContactCardTemplateLC(). These functions create a contact card template, 
williamr@2
   325
add it to the database, and return a pointer to it.
williamr@2
   326
williamr@2
   327
The function CContactDatabase::GetCardTemplateIdListL() gets a list of the 
williamr@2
   328
IDs of all contact card templates in the database. 
williamr@2
   329
@publishedAll
williamr@2
   330
@released
williamr@2
   331
*/
williamr@2
   332
	{
williamr@2
   333
	friend class CContactDatabase;
williamr@2
   334
	friend class CContactTables;
williamr@2
   335
	friend class RPplContactTable;
williamr@2
   336
	friend class CContactItem;
williamr@2
   337
public:
williamr@2
   338
	IMPORT_C void SetTemplateLabelL(const TDesC& aLabel);
williamr@2
   339
	IMPORT_C TPtrC GetTemplateLabelL();
williamr@2
   340
protected:
williamr@2
   341
	IMPORT_C static CContactCardTemplate* NewL();
williamr@2
   342
	IMPORT_C static CContactCardTemplate* NewLC();
williamr@2
   343
	IMPORT_C static CContactCardTemplate* NewL(const CContactItem *aTemplate);
williamr@2
   344
	IMPORT_C static CContactCardTemplate* NewLC(const CContactItem *aTemplate);
williamr@2
   345
	IMPORT_C TBool HasItemLabelField();
williamr@2
   346
// 
williamr@2
   347
/**         
williamr@2
   348
    Intended usage: Reserved to preserve future BC         */
williamr@2
   349
	IMPORT_C void ReservedFunction1();
williamr@2
   350
/**          
williamr@2
   351
    Intended usage: Reserved to preserve future BC         */
williamr@2
   352
	IMPORT_C void ReservedFunction2();
williamr@2
   353
williamr@2
   354
protected: // from CContactItem
williamr@2
   355
	IMPORT_C TUid Type() const;
williamr@2
   356
private:
williamr@2
   357
	CContactCardTemplate();
williamr@2
   358
	};
williamr@2
   359
williamr@2
   360
class CContactCard : public CContactItemPlusGroup
williamr@2
   361
/** A contact card. 
williamr@2
   362
williamr@2
   363
Implements the Type() function declared in class CContactItem. 
williamr@2
   364
Contact cards may optionally be constructed from a template. 
williamr@2
   365
@publishedAll
williamr@2
   366
@released
williamr@2
   367
*/
williamr@2
   368
	{
williamr@2
   369
public:
williamr@2
   370
	IMPORT_C ~CContactCard();
williamr@2
   371
	IMPORT_C static CContactCard* NewL();
williamr@2
   372
	IMPORT_C static CContactCard* NewLC();
williamr@2
   373
	IMPORT_C static CContactCard* NewL(const CContactItem *aTemplate);
williamr@2
   374
	IMPORT_C static CContactCard* NewLC(const CContactItem *aTemplate);
williamr@2
   375
public: // from CContactItem
williamr@2
   376
	IMPORT_C TUid Type() const;
williamr@2
   377
public:
williamr@2
   378
	IMPORT_C CContactIdArray* GroupsJoinedLC() const;
williamr@2
   379
private:
williamr@2
   380
	CContactCard();
williamr@2
   381
private:
williamr@2
   382
	friend class CContactDatabase;
williamr@2
   383
	};
williamr@2
   384
williamr@2
   385
class CContactOwnCard : public CContactItemPlusGroup
williamr@2
   386
/** Own card. 
williamr@2
   387
williamr@2
   388
An own card is a contact card which contains information about the device's 
williamr@2
   389
owner. This can be sent to another compatible electronic device as a vCard. 
williamr@2
   390
The contact database recognises a single own card, referred to as the 
williamr@2
   391
current own card; its ID is returned by CContactDatabase::OwnCardId(). Like 
williamr@2
   392
a contact card, an own card can be a member of one or more contact card groups. 
williamr@2
   393
The own card type is identified by a UID of KUidContactOwnCard.
williamr@2
   394
williamr@2
   395
Own cards can be constructed using either CContactDatabase::CreateOwnCardLC() 
williamr@2
   396
or CreateOwnCardL(). These functions create an own card, based on the system 
williamr@2
   397
template, add it to the database, set it as the database's current own card 
williamr@2
   398
and return a pointer to it. To change the database's current own card, use 
williamr@2
   399
CContactDatabase::SetOwnCardL(). 
williamr@2
   400
@publishedAll
williamr@2
   401
@released
williamr@2
   402
*/
williamr@2
   403
	{
williamr@2
   404
public:
williamr@2
   405
	IMPORT_C ~CContactOwnCard();
williamr@2
   406
	IMPORT_C static CContactOwnCard* NewL();
williamr@2
   407
	IMPORT_C static CContactOwnCard* NewLC();
williamr@2
   408
	IMPORT_C static CContactOwnCard* NewL(const CContactItem *aTemplate);
williamr@2
   409
	IMPORT_C static CContactOwnCard* NewLC(const CContactItem *aTemplate);
williamr@2
   410
public: // from CContactItem
williamr@2
   411
	IMPORT_C TUid Type() const;
williamr@2
   412
public:
williamr@2
   413
	IMPORT_C CContactIdArray* GroupsJoinedLC() const;
williamr@2
   414
private:
williamr@2
   415
	CContactOwnCard();
williamr@2
   416
private:
williamr@2
   417
	friend class CContactDatabase;
williamr@2
   418
	};
williamr@2
   419
williamr@2
   420
class CContactTemplate : public CContactItem
williamr@2
   421
/** A contact item template. 
williamr@2
   422
williamr@2
   423
This is a contact item which is used to seed the initial field set for 
williamr@2
   424
other contact items.
williamr@2
   425
williamr@2
   426
Non-system (i.e. user-defined) templates are implemented 
williamr@2
   427
by the CContactCardTemplate class. CContactCardTemplate should be 
williamr@2
   428
used in preference to CContactTemplate. 
williamr@2
   429
@publishedAll
williamr@2
   430
@released
williamr@2
   431
*/
williamr@2
   432
	{
williamr@2
   433
public:
williamr@2
   434
	IMPORT_C static CContactTemplate* NewL();
williamr@2
   435
	IMPORT_C static CContactTemplate* NewLC();
williamr@2
   436
	IMPORT_C static CContactTemplate* NewL(const CContactItem *aTemplate);
williamr@2
   437
	IMPORT_C static CContactTemplate* NewLC(const CContactItem *aTemplate);
williamr@2
   438
public: // from CContactItem
williamr@2
   439
	IMPORT_C TUid Type() const;
williamr@2
   440
private:
williamr@2
   441
	CContactTemplate();
williamr@2
   442
	};
williamr@2
   443
williamr@2
   444
williamr@2
   445
class CContactICCEntry : public CContactItemPlusGroup
williamr@2
   446
/** A contact ICC entry. 
williamr@2
   447
@publishedAll
williamr@2
   448
@released
williamr@2
   449
*/
williamr@2
   450
	{
williamr@2
   451
public:
williamr@2
   452
	IMPORT_C ~CContactICCEntry();
williamr@2
   453
	IMPORT_C static CContactICCEntry* NewL(const CContactItem& aTemplate);
williamr@2
   454
	static CContactICCEntry* NewL();
williamr@2
   455
public: //from CContactItem
williamr@2
   456
	TUid Type() const;
williamr@2
   457
private:
williamr@2
   458
	CContactICCEntry();
williamr@2
   459
	};
williamr@2
   460
williamr@2
   461
williamr@2
   462
class ContactGuid
williamr@2
   463
/** A globally unique identifier enquiry utility.
williamr@2
   464
williamr@2
   465
Each contact item has a unique identifier, stored as a descriptor. It is 
williamr@2
   466
referred to as the 'UID string'. This is a combination of the unique 
williamr@2
   467
identifier of the database in which the contact item was created, the 
williamr@2
   468
contact item ID and the date/time of the contact item's creation. ContactGuid 
williamr@2
   469
provides a single static exported function to enquire whether an item was 
williamr@2
   470
created in a specified database. 
williamr@2
   471
@publishedAll
williamr@2
   472
@released
williamr@2
   473
*/
williamr@2
   474
	{
williamr@2
   475
public:
williamr@2
   476
	IMPORT_C static TContactItemId IsLocalContactUidString(const TDesC& aString, TInt64 aMachineUniqueId);
williamr@2
   477
	IMPORT_C static TBool GetCreationDate(TDes& aString, TInt64 aMachineUniqueId);
williamr@2
   478
	static HBufC* CreateGuidLC(const TDesC& aCreationDate,TContactItemId aId, TInt64 aMachineUniqueId);
williamr@2
   479
	static HBufC* CreateGuidLC(const TTime& aCreationDate,TContactItemId aId, TInt64 aMachineUniqueId);
williamr@2
   480
	static HBufC* CreateGuidLC(TContactItemId aId, TInt64 aMachineUniqueId);
williamr@2
   481
	};
williamr@2
   482
williamr@2
   483
inline const CContactItemField& CContactItemFieldSet::operator[](TInt aIndex) const
williamr@2
   484
/** Gets the field located at a specified position in the field set. 
williamr@2
   485
williamr@2
   486
@param aIndex The position of the field in the field set. This is relative to zero. 
williamr@2
   487
It must be non-negative and less than the number of objects in the array, otherwise 
williamr@2
   488
the operator raises a panic.
williamr@2
   489
williamr@2
   490
@return A const reference to an element in the array. */
williamr@2
   491
	{ return *(*iFields)[aIndex]; }
williamr@2
   492
williamr@2
   493
inline CContactItemField& CContactItemFieldSet::operator[](TInt aIndex)
williamr@2
   494
/** Gets the field located at a specified position in the field set. 
williamr@2
   495
williamr@2
   496
@param aIndex The position of the field in the field set. This is relative to zero. 
williamr@2
   497
It must be non-negative and less than the number of objects in the array, otherwise 
williamr@2
   498
the operator raises a panic.
williamr@2
   499
williamr@2
   500
@return A non-const reference to an element in the array. */
williamr@2
   501
	{ return *(*iFields)[aIndex]; }
williamr@2
   502
williamr@2
   503
inline TInt CContactItemFieldSet::Find(TFieldType aFieldType) const
williamr@2
   504
/** Finds the first field in the field set with the specified field type.
williamr@2
   505
williamr@2
   506
@param aFieldType The field type of interest.
williamr@2
   507
@return If found, the index of the field within the field set, or KErrNotFound 
williamr@2
   508
if not found. */
williamr@2
   509
	{ return FindNext(aFieldType,KContactFieldSetSearchAll); }
williamr@2
   510
williamr@2
   511
inline TInt CContactItemFieldSet::Find(TFieldType aFieldType,TUid aMapping) const
williamr@2
   512
/** Finds the first field in the field set containing both the content type mapping 
williamr@2
   513
and the field type specified.
williamr@2
   514
williamr@2
   515
@param aFieldType The field type of interest.
williamr@2
   516
@param aMapping The content type mapping of interest.
williamr@2
   517
@return If found, the index of the field within the field set, or KErrNotFound 
williamr@2
   518
if not found. */
williamr@2
   519
	{ return FindNext(aFieldType,aMapping,KContactFieldSetSearchAll); }
williamr@2
   520
williamr@2
   521
inline TInt CContactItemFieldSet::Count() const
williamr@2
   522
/** Gets the number of fields in the field set.
williamr@2
   523
williamr@2
   524
@return The number of fields in the field set. */
williamr@2
   525
	{ return iFields->Count(); }
williamr@2
   526
williamr@2
   527
inline void CContactItemFieldSet::Reset()
williamr@2
   528
/** Deletes all fields in the field set. */
williamr@2
   529
	{ iFields->ResetAndDestroy(); }
williamr@2
   530
williamr@2
   531
inline TBool CContactItem::IsDeletable()
williamr@2
   532
/** Tests whether the contact item is deletable. 
williamr@2
   533
williamr@2
   534
This is true if the item's access count is zero.
williamr@2
   535
williamr@2
   536
@return ETrue if deletable, EFalse if not deletable. */
williamr@2
   537
	{return (iAccessCount == 0);}
williamr@2
   538
williamr@2
   539
inline void CContactItem::IncAccessCount()
williamr@2
   540
/** Increments the contact item's access count. */
williamr@2
   541
	{iAccessCount++;}
williamr@2
   542
williamr@2
   543
inline void CContactItem::DecAccessCount()
williamr@2
   544
/** Decrements the contact item's access count. */
williamr@2
   545
	{if(iAccessCount) iAccessCount--;}
williamr@2
   546
williamr@2
   547
inline TInt CContactItem::AccessCount() const
williamr@2
   548
/** Gets the contact item's access count.
williamr@2
   549
williamr@2
   550
@return The item's access count. */
williamr@2
   551
	{return(iAccessCount);}
williamr@2
   552
williamr@2
   553
inline TPtrC CContactItem::Guid() 
williamr@2
   554
/** Accessor function for Contact Guid. 
williamr@2
   555
 * This is used to cache contact items that are added during a sync.
williamr@2
   556
 @return Guid    */
williamr@2
   557
 { return iGuid ? *iGuid : TPtrC(KNullDesC); }
williamr@2
   558
williamr@2
   559
#endif