meetingrequest/mrcalremoteattachment/api/inc/mcalremoteattachmentinfo.h
branchRCL_3
changeset 12 4ce476e64c59
child 16 b5fbb9b25d57
equal deleted inserted replaced
11:0396474f30f5 12:4ce476e64c59
       
     1 /*
       
     2 * Copyright (c) 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:  Build information file for project esmrgui
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef MCALREMOTEATTACHMENTINFO_H
       
    19 #define MCALREMOTEATTACHMENTINFO_H
       
    20 
       
    21 #include <e32base.h>
       
    22 #include <mcalremoteattachment.h>
       
    23 
       
    24 /**
       
    25  * MCalRemoteAttachmentInfo encapsulates calendar entry attachment information.
       
    26  */
       
    27 class MCalRemoteAttachmentInfo
       
    28     {
       
    29 public: // Construction and destruction
       
    30 
       
    31      /**
       
    32       * C++ Destructor
       
    33       */
       
    34     virtual ~MCalRemoteAttachmentInfo() {};
       
    35 
       
    36 public:
       
    37     /**
       
    38      * Creates new CESMRAttachment object and
       
    39      * adds it to the array owned by this class
       
    40      *
       
    41      * @param aAttachmentIdentifier Attachment identifier
       
    42 	 * @param aAttachmentLabel Attachment label
       
    43      * @param aAttachmentSizeInBytes of attachment
       
    44      * @param aState state of attachment download
       
    45      */
       
    46     virtual void AddAttachmentInfoL(
       
    47             const TDesC& aAttachmentIdentifier,
       
    48 			const TDesC& aAttachmentLabel,
       
    49             TInt aAttachmentSizeInBytes,
       
    50             MCalRemoteAttachment::TCalRemoteAttachmentState aState ) = 0;
       
    51 
       
    52     /**
       
    53      * Adds MCalRemoteAttachment to the array owned by this class. Ownership is
       
    54 	 * transferred from the caller. 
       
    55      *
       
    56      * @param aAttachment object to be added to the array
       
    57      */
       
    58      virtual void AddAttachmentInfoL(
       
    59              MCalRemoteAttachment* aAttachment ) = 0;
       
    60 
       
    61      /**
       
    62       * Counts number of MCalRemoteAttachment objects in array
       
    63       * @return number of objects in array
       
    64       */
       
    65      virtual TInt AttachmentCount() const = 0;
       
    66 
       
    67      /**
       
    68       * Returns MCalRemoteAttachment from array index
       
    69       *
       
    70       *@param aIndex index of MCalRemoteAttachment to be returned
       
    71       *@return object in the index
       
    72       */
       
    73      virtual const MCalRemoteAttachment& AttachmentL(
       
    74              TInt aIndex ) const = 0;
       
    75 
       
    76      /**
       
    77       * Removes MCalRemoteAttachment from array index
       
    78       *
       
    79       *@param aIndex index of MCalRemoteAttachment to be removed from array
       
    80       */
       
    81      virtual void RemoveAttachmentAtL(
       
    82              TInt aIndex ) = 0;
       
    83 
       
    84      /**
       
    85       * Removes MCalRemoteAttachment from array index
       
    86       *
       
    87       *@param aIndex index of MCalRemoteAttachment to be removed from array
       
    88       */
       
    89      virtual void RemoveAttachmentL(
       
    90              MCalRemoteAttachment& aAttachment ) = 0;
       
    91      
       
    92      /**
       
    93       * Fetches attachment array.
       
    94       * @return attachment array.
       
    95       */
       
    96      virtual const RPointerArray<MCalRemoteAttachment>& Attachments() const = 0;
       
    97      
       
    98      /**
       
    99       * Returns an extension point for this interface or NULL.
       
   100       *
       
   101       * @param aExtensionUid Uid of extension
       
   102       * @return Extension point or NULL
       
   103       */
       
   104      virtual TAny* CalRemoteAttachmentInfoExtension(
       
   105              TUid /*aExtensionUid*/ ) { return NULL; }
       
   106 	 };
       
   107 
       
   108 #endif // MCALREMOTEATTACHMENTINFO_H
       
   109 
       
   110 // EOF