meetingrequest/mrcalremoteattachment/api/inc/mcalremoteattachment.h
branchRCL_3
changeset 12 4ce476e64c59
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 
       
    19 #ifndef MCALREMOTEATTACHMENT_H
       
    20 #define MCALREMOTEATTACHMENT_H
       
    21 
       
    22 #include <e32base.h>
       
    23 
       
    24 /**
       
    25  * MCalRemoteAttachment encapsulates calendar entry attachment.
       
    26  */
       
    27 class MCalRemoteAttachment
       
    28     {
       
    29 public:
       
    30     /**
       
    31      * Attachment state information
       
    32      */
       
    33     enum TCalRemoteAttachmentState
       
    34         {
       
    35         /** Unknown attachment state */
       
    36         EAttachmentStateUnknown,
       
    37         /** Attachment is now downlaoded to device */
       
    38         EAttachmentStateNotDownloaded,
       
    39         /** Attachment is downloaded to device */
       
    40         EAttachmentStateDownloaded
       
    41         };
       
    42 
       
    43 public: // Construction and destruction
       
    44 
       
    45      /**
       
    46       * C++ Destructor.
       
    47       */
       
    48       virtual ~MCalRemoteAttachment() {} ;
       
    49 
       
    50 public: // Interface
       
    51     /**
       
    52      * Sets name of attachment
       
    53      * @param aAttachmentLabel Attachment label
       
    54      */
       
    55     virtual void SetAttachmentLabelL(
       
    56             const TDesC& aAttachmentLabel ) = 0;
       
    57 
       
    58     /**
       
    59      * Gets label of attachment
       
    60      * @return Label name of attachment
       
    61      */
       
    62     virtual const TDesC& AttachmentLabel() const = 0;
       
    63 
       
    64     /**
       
    65      * Sets attachment identifier
       
    66      *
       
    67      * @param aAttachmentIdentifier Attachment identifier
       
    68      */
       
    69     virtual void SetAttachmentIdentifierL(
       
    70             const TDesC& aAttachmentIdentifier ) = 0;
       
    71 
       
    72     /**
       
    73      * Fetches attachment identifier
       
    74      *
       
    75      * @return Attachment identifier
       
    76      */
       
    77     virtual const TDesC& AttachmentIdentifier() const = 0;
       
    78 
       
    79     /**
       
    80      * Sets size of attachment
       
    81      *
       
    82      * @param aAttachmentSizeInBytes size of attachment in bytes
       
    83      */
       
    84     virtual void SetAttachmentSize(
       
    85             TInt aAttachmentSizeInBytes ) = 0;
       
    86 
       
    87     /**
       
    88      * return size of attachment in bytes
       
    89      *
       
    90      * @return size of attachment
       
    91      */
       
    92     virtual TInt AttachmentSizeInBytes() const = 0;
       
    93 
       
    94     /**
       
    95      * Sets download state of attachment
       
    96      *
       
    97      * @param aAttachmentState download state of attachment
       
    98      */
       
    99     virtual void SetAttachmentState(
       
   100             MCalRemoteAttachment::TCalRemoteAttachmentState aAttachmentState ) = 0;
       
   101 
       
   102     /**
       
   103      * Gets download state of attachment
       
   104      *
       
   105      * @return download state of attachment
       
   106      */
       
   107     virtual MCalRemoteAttachment::TCalRemoteAttachmentState 
       
   108             AttachmenState() const = 0;
       
   109 
       
   110     /**
       
   111      * Returns an extension point for this interface or NULL.
       
   112      *
       
   113      * @param aExtensionUid Uid of extension
       
   114      * @return Extension point or NULL
       
   115      */
       
   116     virtual TAny* CalRemoteAttachmentExtension(
       
   117             TUid /*aExtensionUid*/ ) { return NULL; }
       
   118     };
       
   119 
       
   120 #endif // MCALREMOTEATTACHMENT_H
       
   121 
       
   122 // EOF