diff -r 000000000000 -r f979ecb2b13e pimappservices/calendar/inc/calversit.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/pimappservices/calendar/inc/calversit.h Tue Feb 02 10:12:19 2010 +0200 @@ -0,0 +1,123 @@ +// Copyright (c) 2006-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 __CALVERSIT_H__ +#define __CALVERSIT_H__ + +#include + +class CCalEntry; +class MCalDataExchangeCallBack; +class RReadStream; +class RWriteStream; + +class MAgnVersit +/** Provides an interface to decouple the static dependency of CAgnEntryModel on +Versit. + +This interface is implemented by the internal class TAgnVCalConverter, in a DLL +called agnversit.dll. Rather than statically linking against versit.dll, the +agenda engine dynamically loads agnversit.dll, to remove its dependency on Versit. +All CAgnEntryModel's vCalendar-specific functions call the corresponding functions, +below. +@internalAll +@released +*/ + { +public: + /** Imports a vCalendar consisting of one or more vCalendar entities. + + The vCalendar is read from the read stream specified and its entities are + converted into agenda entries and returned in the array aEntryArray. + + @param aFlags CAgnEntryModel::ELocalTime causes all date/times to be converted + to machine-local; CAgnEntryModel::EDefault leaves them unadjusted. + @param aReadStream The read stream which contains the vCalendar. + @param aEntryArray On return, a list of the agenda entries which were imported + from the vCalendar. The list contains the vEvents followed by the vTodos. + @param aEntryModel Pointer to the agenda entry model instance that is calling + this function. */ + virtual void ImportVCalL(TInt aFlags, RReadStream& aReadStream, RPointerArray& aEntryArray)=0; + /** Exports one or more agenda entries as vCalendar entities to the write stream + specified. + + The entries are exported either as vTodos, if they are to-dos, otherwise as + vEvents. + + @param aFlags CAgnEntryModel::ELocalTime causes all date/times to be left + as machine-local; CAgnEntryModel::EDefault causes them to be converted into + UTC. + @param aWriteStream The stream to which the agenda entries should be externalised + as vCalendar entities. + @param aEntryArray Pointer to the array of agenda entries to export. + @param aCharSet The character encoding type. + @param aEntryModel Pointer to the agenda entry model instance that is calling + this function. */ + virtual void ExportVCalL(RWriteStream& aWriteStream, const RPointerArray& aEntryArray, const Versit::TVersitCharSet aCharSet)=0; + /** Parses a vCalendar stream and updates the appropriate entries. + + /** Asynchronously imports a vCalendar consisting of one or more vCalendar entities. + + The vCalendar is read from the read stream specified and its entities are + converted into agenda entries and returned in the array aEntryArray. + @released + @param aFlags CAgnEntryModel::ELocalTime causes all date/times to be converted + to machine-local; CAgnEntryModel::EDefault leaves them unadjusted. + @param aReadStream The read stream which contains the vCalendar. + @param aEntryArray On return, a list of the agenda entries which were imported + from the vCalendar. The list contains the vEvents followed by the vTodos. + @param aEntryModel Pointer to the agenda entry model instance that is calling + this function. + @param aObserver Callback to indicate the progress of the import and when it has completed. */ + virtual void ImportVCalAsyncL(TInt aFlags, RReadStream& aReadStream, RPointerArray& aEntryArray, + MCalDataExchangeCallBack& aObserver) = 0; + + /** Asynchronously exports one or more agenda entries as vCalendar entities to the write stream + specified. + + The entries are exported either as vTodos, if they are to-dos, otherwise as + vEvents. + @released + @param aFlags CAgnEntryModel::ELocalTime causes all date/times to be left + as machine-local; CAgnEntryModel::EDefault causes them to be converted into + UTC. + @param aWriteStream The stream to which the agenda entries should be externalised + as vCalendar entities. + @param aEntryArray Pointer to the array of agenda entries to export. + @param aCharSet The character encoding type. + @param aEntryModel Pointer to the agenda entry model instance that is calling + this function. + @param aObserver Callback to indicate the progress of the import and when it has completed. */ + virtual void ExportVCalAsyncL(RWriteStream& aWriteStream, RPointerArray& aCalEntryArray, + MCalDataExchangeCallBack& aObserver, const Versit::TVersitCharSet aCharSet) = 0; + + }; + +class CAgnVersit: public CBase, public MAgnVersit +/** Provides an interface for ECom plugins +@internalAll +@released +*/ + { +public: + static CAgnVersit* NewL(); + /** Releases Ecom resources + */ + IMPORT_C virtual ~CAgnVersit(); +private: + TUid iDtor_ID_Key; + }; + +#endif // __CCALDATAEXCHANGE_H__