1 /*

     2 * Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies). 

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

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

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Interface definition for ESMR iCal import exporter

    15 *

    16 */

    17 

    18 

    19 #ifndef MESMRCALIMPORTEXPORTER_H

    20 #define MESMRCALIMPORTEXPORTER_H

    21 

    22 class CCalEntry;

    23 

    24 /**

    25  *  MESMRCalImportExporter defines interface for

    26  *  importing and exporting calendar entries to / from

    27  *  iCal format.

    28  *

    29  *  @lib esmrservices.lib

    30  */

    31 class MESMRCalImportExporter

    32     {

    33 public: // Destruction

    34     /**

    35      * Virtual C++ destructor.

    36      */

    37     virtual ~MESMRCalImportExporter() { }

    38 

    39 public: // Interface

    40     /**

    41      * Exports calendar entry to iCal format. Ownership of the returned

    42      * descriptor is transferred to caller.

    43      *

    44      * @param aEntry Reference to CCalEntry object.

    45      * @return CCalEntry in iCal format.

    46      */

    47     virtual HBufC8* ExportToICal8L(

    48             CCalEntry& aEntry ) = 0;

    49 

    50     /**

    51      * Exports calendar entry to iCal format. Created object is left to

    52      * cleanup stack. Ownership of the returned descriptor is

    53      * transferred to caller.

    54      *

    55      * @param aEntry Reference to CCalEntry object.

    56      * @return CCalEntry in iCal format.

    57      */

    58     virtual HBufC8* ExportToICal8LC(

    59             CCalEntry& aEntry ) = 0;

    60 

    61     /**

    62      * Export calendar entry to iCal format. Ownership of the

    63      * returned descriptor is transferred to caller.

    64      *

    65      * @param aEntry Reference to CCalEntry object.

    66      * @return CCalEntry in iCal format.

    67      */

    68     virtual HBufC* ExportToICal16L(

    69             CCalEntry& aEntry ) = 0;

    70 

    71     /**

    72      * Export calendar entry to iCal format. Created object is left to

    73      * cleanup stack. Ownership of the returned descriptor is

    74      * transferred to caller.

    75      *

    76      * @param aEntry Reference to CCalEntry object.

    77      * @return CCalEntry in iCal format.

    78      */

    79     virtual HBufC* ExportToICal16LC(

    80             CCalEntry& aEntry ) = 0;

    81 

    82     /**

    83      * Imports iCal entry to CCalEntry. Ownership of the returned object is

    84      * transferred to caller.

    85      *

    86      * @param aICal Buffer containing entry in iCal format.

    87      * @return Pointer to imported CCalEntry object.

    88      */

    89     virtual CCalEntry* ImportFromIcalL(

    90             const TDes8& aIcal ) = 0;

    91 

    92     /**

    93      * Imports iCal entry to CCalEntry. Created object is left to

    94      * cleanup stack. Ownership of the returned object is transferred

    95      * to caller.

    96      *

    97      * @param aICal Buffer containing entry in iCal format.

    98      * @return Pointer to imported CCalEntry object.

    99      */

   100     virtual CCalEntry* ImportFromIcalLC(

   101             const TDes8& aIcal ) = 0;

   102     };

   103 

   104 #endif  // MESMRCALIMPORTEXPORTER_H