API_REF/Public_API: comparison epoc32/include/app/cntdb.h

equal deleted inserted replaced

-:e1b950c65cb4
+:837f303aceeb
 // 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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
+// under the terms of "Eclipse Public License v1.0"
 // which accompanies this distribution, and is available
-// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
+// at the URL "http://www.eclipse.org/legal/epl-v10.html".
 //
 // Initial Contributors:
 // Nokia Corporation - initial contribution.
 //
 // Contributors:
 class MLplPersistenceLayerFactory;
 class CContactOpenOperation;
 class CDataBaseChangeObserver;
 class CContactConverter;
+#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
+class CContactSynchroniser;
+#endif
 // Constants
+/**
+Maximum string length used to separate the fields in the text definition.
+@see TContactTextDefItem
+@publishedAll
+@released
+*/
 const TInt KMaxContactTextSeperator=4;
+/**
+Constant used during sorting and searching of contacts.
+@publishedAll
+@released
+*/
 const TInt KTextFieldMinimalLength=64;
+/**
+Maximum number of fields that can be set as filterable fields by licensees.
+@publishedAll
+@released
+*/
 const TInt KMaxCustomFilterableFields=4;
+#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
+/** @internalComponent */
 const TInt KMajorVersion=1;
+/** @internalComponent */
 const TInt KMinorVersion=0;
+/** @internalComponent */
 const TInt KBuildNumber=40;
+#endif //SYMBIAN_ENABLE_SPLIT_HEADERS
 //
 // Classes used for compact
 //
 	IMPORT_C virtual void MContactUiActive_Reserved1();
 	};
 class CContactActiveBase : public CBase, public MContactUiActive
 /**
-@internalTechnology
+@publishedAll
+@released
 */
 	{
 public:
 	~CContactActiveBase();
 	void SetObserver(MContactUiCompactObserver *aObserver);
 	void Cancel();
 	TInt StepsTogo() const;
 	TInt Step();
 	TInt Error() const;
 	void SetContactDatabase(CContactDatabase* aContactDatabase);
-	void SetFileManager(RCntModel& aCntSvr);
+	void SetFileManagerL(RCntModel& aCntSvr);
 #ifndef __SYMBIAN_CNTMODEL_USE_SQLITE__
-protected:
-	void ConstructL();
-	static TInt CompactCallBack(TAny *aThis);
 protected:
 	MContactUiCompactObserver *iObserver;
 	RCntModel* iCntSvr;
 	CIdle *iIdle;
 	TInt iStep;
 public:
 #if !( defined __SYMBIAN_CNTMODEL_HIDE_DBMS__ && defined __SYMBIAN_CNTMODEL_USE_SQLITE__ )
 void ConstructL(RDbNamedDatabase /* &aDataBase */) {};
 #endif
 	};
 class TContactTextDefItem
 /** An item in a text definition.
 @deprecated
 */
 	virtual void HandleSortEventL(TInt aContactsSorted, TInt aContactsTotal)=0;
 	};
+#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
 class MConverterCallBack
 /**
 Interface class for providing Intra-Contact Properties during a PBAP specific contacts export.
-@prototype
+@released
 @internalTechnology
 */
 {
 	public:
 	/**
 	PBAP clients are supposed to provide any information regarding the contact item represented by aContactId.
 	This information should be in form of standard vCard property, all such properties should be appended to the array aPropertyList.
 	*/
 	virtual	void AddIntraContactPropertiesL(const TContactItemId& aContactId, CArrayPtr<CParserProperty>* aPropertyList) = 0;
 };
+#else
+class MConverterCallBack;
+#endif //SYMBIAN_ENABLE_SPLIT_HEADERS
 enum TVCardVersion
 /**
 Specifies type of export of contact items.
 PBAP clients should use EPBAPVCard21 and EPBAPVCard30.
-@prototype
+@publishedAll
-@internalTechnology
+@released
 */
 	{
 	EVCardUDEF = -1,
 	EVCard21 = 0,
 	EVCard30,
 		/** Allows for a multi-threaded program to access the contact database from multiple
 		threads but note that the contacts model provides no synchronisation support
 		for such use. */
 		EMultiThread
 		};
+#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
 /**
 @internalComponent
 */
 	enum TSortDataSource
 		{
 		ENoOrder,
 		EUsesIdentityTableOnly,
 		EUsesAllTables,
 		EIdentityTableNotUsed //Not used
 		};
+#endif
 public:
 	IMPORT_C static CContactDatabase* OpenL(TThreadAccess aAccess=ESingleThread);
 	IMPORT_C static CContactDatabase* OpenL(const TDesC& aFileName,TThreadAccess aAccess=ESingleThread);
 	IMPORT_C static CContactDatabase* CreateL(TThreadAccess aAccess=ESingleThread);
 	IMPORT_C static CContactDatabase* CreateL(const TDesC& aFileName,TThreadAccess aAccess=ESingleThread);
 	void OpenDatabaseAsyncL(TRequestStatus& aStatus, const TDesC& aFileName = KNullDesC);
 	static void CleanupLastLockedContact(TAny *aDatabase);
 private:
-	CContactConverter& CContactDatabase::ConverterL(const TUid& aFormat);
+	CContactConverter& ConverterL(const TUid& aFormat);
-	CContactConverter& CContactDatabase::ConverterL(const TUid& aFormat, const TInt64 aContactFieldFilter, MConverterCallBack* aCallback, const TVCardVersion aVersion,const TBool aExportTel);
+	CContactConverter& ConverterL(const TUid& aFormat, const TInt64 aContactFieldFilter, MConverterCallBack* aCallback, const TVCardVersion aVersion,const TBool aExportTel);
 	static void CleanupDatabaseRollback(TAny *aDatabase);
 	CContactIdArray* SortLC(const CArrayFix<TSortPref>* aSortOrder, const CContactIdArray* aIdArray);
 	TBool CheckType(TUid aUid) const;
 	void SortDuplicatesL(const CArrayFix<TSortPref>& aSortOrder,CSortArray& aList,TInt aPos);
 	MLplPersistenceLayerFactory* FactoryL();
 private:
 	CContactItem* doCreateContactGroupLC(const TDesC& aGroupLabel = KNullDesC);
 	void AddCntToOpenedGroupL(TContactItemId aItemId, CContactItem& aGroup);
-	void ReadTemplateIds();
+	void ReadTemplateIdsL();
 	void AddToTemplateListL(const TContactItemId aNewTemplateId);
 	void RemoveFromTemplateList(const TContactItemId aOldTemplateId);
 	TBool SystemTemplateFieldsValid(const CContactItem& aContact);
 	void RespondToEventL(const TContactDbObserverEventType aEventType, const TContactItemId aContactId);
 	void HandleDbObserverEventGroupOrContactChangedL(const TContactItemId aContactId);
 	TTime iSyncDate;	//was TInt64 iMachineUniqueId;
 	TCollationMethod iCollateMethod; //remains: used for sorting contacts
 	TInt iAsyncActivityCount;
 	CContactSynchroniser* iContactSynchroniser; //a handle to the synchroniser plugin
-	CArrayFix<TSortPref>* iSortOrder; // holds a sort order passed into SortL(), as in cntmodelv1,
+	CArrayFix<TSortPref>* iSortOrder;	// holds a sort order passed into SortL(), as in cntmodelv1,
-									  // for delayed deletion to maintain backwards compatibility
+										// for delayed deletion to maintain backwards compatibility
 	};
 class CContactChangeNotifier : public CBase
 /** Receives events reporting changes to a contact database.
 	CContactDatabase &iDatabase;
 	MContactDbObserver* iObserver;
 	};
-/** The UID of the default vCard converter implemented by an ECom plugin. */
+/** The UID of the default vCard converter implemented by an ECom plugin.
+@publishedAll
+@released
+*/
 #define KUidEComCntVCardConverterDefaultImplementation  0x102035F9
 /** The UID of the default vCard converter plugin implementation. This
-implementation is independent of the plugin framework used. */
+implementation is independent of the plugin framework used.
+@publishedAll
+@released
+*/
 #define KUidVCardConvDefaultImpl 	KUidEComCntVCardConverterDefaultImplementation
-/** The UID of the vCard converter ECom plugin interface. */
+#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
+/** The UID of the vCard converter ECom plugin interface.
+@released
+@internalTechnology
+*/
 const TUid KUidEcomCntVCardConverterInterface = {0x102035F7};
-/** The UID of the phone number parser ECom plugin interface. */
+/** The UID of the phone number parser ECom plugin interface.
+@released
+@internalTechnology
+*/
 const TUid KUidEcomCntPhoneNumberParserInterface = {0x102035FA};
 /** The UID of PBAP vCard Converter plugin Implementation.
-@prototype
 @internalTechnology
+@released
 */
 #define KUidPBAPVCardConvImpl 0xA00015C1
+#endif //SYMBIAN_ENABLE_SPLIT_HEADERS
 class TPluginParameters
 /**
 Class used to pack the extra arguments required for a PBAP conveter,
 PBAP client provides these arguments using overloaded CContactDatabase::ExportSelectedContacts.
-@prototype
+@publishedAll
-@internalComponent
+@released
 */
 {
 public:
 	TPluginParameters(TInt64 aContactFieldFilter, MConverterCallBack* aCallback, TVCardVersion aVersion, TBool aExportTel);
 	TInt64 GetFilter()const;
 class CContactConverter : public CBase
 /** Provides functionality to import and export vCards.
 One or more vCards can be imported from a read stream (the vCards are converted
 into contact items and added to the database). Also, contact items can be exported as vCards.
+@publishedAll
-@publishedPartner
 @released
 */
 	{
 public:
 	virtual CArrayPtr<CContactItem>*  ImportL(CContactDatabase& aDb,RReadStream& aReadStream,TBool& aImportSuccessful,TInt aOptions,TBool aImportSingle)=0;
 class CContactEcomConverter : public CContactConverter
 /**
 It provides Ecom Framework based facilities to resolve and load the appropriate implementations at run-time.
 The framework supplies a default resolver for selecting appropriate implementations.
-@publishedPartner
+@publishedAll
 @released
 */
 	{
 public:
 	static CContactEcomConverter* NewL(TUid aImplementationUid);
 /** The destruction of the interface implementation referred to by iDtor_ID_Key */
 	{
 	REComSession::DestroyedImplementation(iDtor_ID_Key);
 	}
+#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
 class CContactPhoneNumberParser : public CBase
 /** Provides functionality to extract the real phone number from a contact's phone number field.
 @publishedPartner
 @released
 */
 inline CContactEcomPhoneNumberParser::~CContactEcomPhoneNumberParser()
 /** The destruction of the interface implementation referred to by iDtor_ID_Key */
 	{
 	REComSession::DestroyedImplementation(iDtor_ID_Key);
 	}
+#endif //SYMBIAN_ENABLE_SPLIT_HEADERS
 inline TInt CContactDatabase::TemplateCount() const
 /** Gets the number of contact card templates that exist in the database.
 This does not include the system template.
 @deprecated

branch	Symbian3
changeset 4	837f303aceeb
parent 3	e1b950c65cb4