mobilemessaging/audiomsg/uiinc/audiomessageuidata.h
changeset 0 72b543305e3a
equal deleted inserted replaced
-1:000000000000 0:72b543305e3a
       
     1 /*
       
     2 * Copyright (c) 2005-2006 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:   UI DATA part of the Ams MTM type to Symbian OS Messaging
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef AUDIOMESSAGEUIDATA_H
       
    21 #define AUDIOMESSAGEUIDATA_H
       
    22 
       
    23 #include <mtudcbas.h>
       
    24 #include <MtmExtendedCapabilities.hrh>
       
    25 
       
    26 
       
    27 /**
       
    28  *
       
    29  *  UI DATA part of the Ams MTM type to Symbian OS Messaging
       
    30  *
       
    31  *  @lib audiomessageui.lib
       
    32  *  @since S60 v3.1
       
    33  */
       
    34 class CAudioMessageUiData :public CBaseMtmUiData
       
    35     {
       
    36     public:  // Constructors and destructor
       
    37         
       
    38         /**
       
    39           * Symbian OS constructor
       
    40           * @param aRegisteredMtmDll registry dll
       
    41           * @return a new AMS MTM UI object.
       
    42           */
       
    43         static CAudioMessageUiData* NewL(CRegisteredMtmDll& aRegisteredDll);
       
    44         
       
    45         /**
       
    46          * Destructor.
       
    47          */
       
    48         ~CAudioMessageUiData();
       
    49 
       
    50     public: // Functions from base classes
       
    51 
       
    52         /**
       
    53          * From CBaseMtmUiData - can the given operation be performed for the given entry
       
    54          */
       
    55         TInt OperationSupportedL(TInt aOperationId, const TMsvEntry& aContext) const;
       
    56         
       
    57         /**
       
    58          * From CBaseMtmUiData Capabilities - defines what we can do
       
    59          * @param aFunctionId asked capability
       
    60          * @param aResponse response depends on the capability
       
    61          * @return KErrNone if supported, otherwise KErrNotSupported
       
    62          */
       
    63         TInt QueryCapability(TUid aFunctionId, TInt& aResponse) const;
       
    64 
       
    65         /**
       
    66          * From CBaseMtmUiData
       
    67          */
       
    68         HBufC* StatusTextL(const TMsvEntry& aContext) const;
       
    69 
       
    70         /**
       
    71          * From CBaseMtmUiData - not supported in Series 60
       
    72          */
       
    73         TBool CanCreateEntryL(const TMsvEntry& aParent, 
       
    74             TMsvEntry& aNewEntry, 
       
    75             TInt& aReasonResourceId) const;
       
    76 
       
    77         /**
       
    78          * From CBaseMtmUiData
       
    79          * Check whether it is ok to reply to a message
       
    80          */
       
    81         TBool CanReplyToEntryL(const TMsvEntry& aContext, TInt& aReasonResourceId) const;
       
    82 
       
    83         /**
       
    84          * From CBaseMtmUiData - not supported in Series 60
       
    85          */
       
    86         TBool CanForwardEntryL(const TMsvEntry& aContext, TInt& aReasonResourceId) const;   
       
    87 
       
    88         /**
       
    89          * From CBaseMtmUiData - not supported in Series 60
       
    90          */
       
    91         TBool CanEditEntryL(const TMsvEntry& aContext, TInt& aReasonResourceId) const;
       
    92 
       
    93         /**
       
    94          * From CBaseMtmUiData - not supported in Series 60
       
    95          */
       
    96         TBool CanViewEntryL(const TMsvEntry& aContext, TInt& aReasonResourceId) const;
       
    97 
       
    98         /**
       
    99          * From CBaseMtmUiData - not supported in Series 60
       
   100          */
       
   101         TBool CanOpenEntryL(const TMsvEntry& aContext, TInt& aReasonResourceId) const;
       
   102 
       
   103         /**
       
   104          * From CBaseMtmUiData - not supported in Series 60
       
   105          */
       
   106         TBool CanCloseEntryL(const TMsvEntry& aContext, TInt& aReasonResourceId) const;
       
   107 
       
   108         /**
       
   109          * From CBaseMtmUiData - not supported in Series 60
       
   110          */
       
   111         TBool CanDeleteFromEntryL(const TMsvEntry& aContext, TInt& aReasonResourceId) const;
       
   112 
       
   113         /**
       
   114          * From CBaseMtmUiData - not supported in Series 60
       
   115          */
       
   116         TBool CanDeleteServiceL(const TMsvEntry& aService, TInt& aReasonResourceId) const;
       
   117 
       
   118         /**
       
   119          * From CBaseMtmUiData - not supported in Series 60
       
   120          */
       
   121         TBool CanCopyMoveToEntryL(const TMsvEntry& aContext, TInt& aReasonResourceId) const;
       
   122 
       
   123         /**
       
   124          * From CBaseMtmUiData - not supported in Series 60
       
   125          */
       
   126         TBool CanCopyMoveFromEntryL(const TMsvEntry& aContext, TInt& aReasonResourceId) const;  
       
   127 
       
   128         /**
       
   129          * From CBaseMtmUiData - not supported in Series 60
       
   130          */
       
   131         TBool CanCancelL(const TMsvEntry& aContext, TInt& aReasonResourceId) const;
       
   132 
       
   133         /**
       
   134          * From CBaseMtmUiData Icons for the entry having context.
       
   135          * @param aContext entry in question
       
   136          * @param aStateFlags
       
   137          * @return array of bitmaps
       
   138          */
       
   139         const CBitmapArray& ContextIcon(const TMsvEntry& aContext, TInt aStateFlags) const;
       
   140 
       
   141     private:
       
   142 
       
   143         /**
       
   144          * By default Symbian OS constructor is private.
       
   145          */
       
   146         void ConstructL();
       
   147 
       
   148         /**
       
   149          * C++ constructor
       
   150          * @param aRegisteredMtmDll registry dll
       
   151          */
       
   152         CAudioMessageUiData( CRegisteredMtmDll& aRegisteredDll );
       
   153 
       
   154         /**
       
   155          * From CBaseMtmUiData
       
   156          */
       
   157         virtual void PopulateArraysL();
       
   158 
       
   159         /**
       
   160          * From CBaseMtmUiData
       
   161          */
       
   162         virtual void GetResourceFileName( TFileName& aFileName ) const;
       
   163 
       
   164 
       
   165     };
       
   166 
       
   167 #endif      // AUDIOMESSAGEUIDATA_H
       
   168