btobexprofiles/obexreceiveservices/mtmuiinfrared/inc/irmtmuidata.h
author hgs
Fri, 28 May 2010 17:03:06 +0300
changeset 32 19bd632b5100
child 40 997690c3397a
permissions -rw-r--r--
201021
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
32
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description: 
hgs
parents:
diff changeset
    15
*     Message type module UI data part.
hgs
parents:
diff changeset
    16
*
hgs
parents:
diff changeset
    17
*
hgs
parents:
diff changeset
    18
*/
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
#ifndef CIRMTMUIDATA_H
hgs
parents:
diff changeset
    22
#define CIRMTMUIDATA_H
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
//  INCLUDES
hgs
parents:
diff changeset
    25
#include <mtudcbas.h>
hgs
parents:
diff changeset
    26
#include <obexutilsuilayer.h>
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
// FORWARD DECLARATIONS
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
hgs
parents:
diff changeset
    31
// CLASS DECLARATION
hgs
parents:
diff changeset
    32
/**
hgs
parents:
diff changeset
    33
*  CIrMtmUiData
hgs
parents:
diff changeset
    34
*  
hgs
parents:
diff changeset
    35
*/
hgs
parents:
diff changeset
    36
class CIrMtmUiData : public CBaseMtmUiData
hgs
parents:
diff changeset
    37
	{
hgs
parents:
diff changeset
    38
    public: // Constructors and destructor
hgs
parents:
diff changeset
    39
        
hgs
parents:
diff changeset
    40
        /**
hgs
parents:
diff changeset
    41
        * Two-phased constructor.
hgs
parents:
diff changeset
    42
        */
hgs
parents:
diff changeset
    43
        static CIrMtmUiData* NewL(CRegisteredMtmDll& aRegisteredDll);
hgs
parents:
diff changeset
    44
	
hgs
parents:
diff changeset
    45
        /**
hgs
parents:
diff changeset
    46
        * Destructor.
hgs
parents:
diff changeset
    47
        */
hgs
parents:
diff changeset
    48
        virtual ~CIrMtmUiData();
hgs
parents:
diff changeset
    49
hgs
parents:
diff changeset
    50
        /**
hgs
parents:
diff changeset
    51
        * By default Symbian OS constructor is private.
hgs
parents:
diff changeset
    52
        */
hgs
parents:
diff changeset
    53
        void ConstructL();
hgs
parents:
diff changeset
    54
hgs
parents:
diff changeset
    55
    public: // Functions from base classes
hgs
parents:
diff changeset
    56
hgs
parents:
diff changeset
    57
        /**
hgs
parents:
diff changeset
    58
        * From CBaseMtmUiData function query.
hgs
parents:
diff changeset
    59
        * @param aOperationId Id for function.
hgs
parents:
diff changeset
    60
        * @param aContext messaging store entry.
hgs
parents:
diff changeset
    61
        * @return TInt error code.
hgs
parents:
diff changeset
    62
        */
hgs
parents:
diff changeset
    63
	    virtual TInt OperationSupportedL(
hgs
parents:
diff changeset
    64
            TInt aOperationId, 
hgs
parents:
diff changeset
    65
            const TMsvEntry& aContext) const;
hgs
parents:
diff changeset
    66
hgs
parents:
diff changeset
    67
        /**
hgs
parents:
diff changeset
    68
        * From CBaseMtmUiData MTM capability check.
hgs
parents:
diff changeset
    69
        * @param aCapability Uid for message type.
hgs
parents:
diff changeset
    70
        * @param aResponse response for capability check.
hgs
parents:
diff changeset
    71
        * @return TInt error code.
hgs
parents:
diff changeset
    72
        */
hgs
parents:
diff changeset
    73
	    virtual TInt QueryCapability(
hgs
parents:
diff changeset
    74
            TUid aCapability, 
hgs
parents:
diff changeset
    75
            TInt& aResponse) const;
hgs
parents:
diff changeset
    76
hgs
parents:
diff changeset
    77
        /**
hgs
parents:
diff changeset
    78
        * From CBaseMtmUiData MTM related context icons.
hgs
parents:
diff changeset
    79
        * @param aContext Messaging entry refence.
hgs
parents:
diff changeset
    80
        * @param aStateFlags Flags for icon.
hgs
parents:
diff changeset
    81
        * @return TInt error code.
hgs
parents:
diff changeset
    82
        */
hgs
parents:
diff changeset
    83
	    virtual const CBitmapArray& ContextIcon(
hgs
parents:
diff changeset
    84
            const TMsvEntry& aContext, 
hgs
parents:
diff changeset
    85
            TInt aStateFlags) const;
hgs
parents:
diff changeset
    86
hgs
parents:
diff changeset
    87
        /**
hgs
parents:
diff changeset
    88
        * From CBaseMtmUiData Provide context-specific function information.
hgs
parents:
diff changeset
    89
        * @param aParent Messaging entry refence.
hgs
parents:
diff changeset
    90
        * @param aNewEntry Messaging entry refence(created entry).
hgs
parents:
diff changeset
    91
        * @param aReasonResourceId ResourceID.
hgs
parents:
diff changeset
    92
        * @return TBool inform that mtm can provice function or not.
hgs
parents:
diff changeset
    93
        */
hgs
parents:
diff changeset
    94
	    virtual TBool CanCreateEntryL(
hgs
parents:
diff changeset
    95
            const TMsvEntry& aParent, 
hgs
parents:
diff changeset
    96
            TMsvEntry& aNewEntry, 
hgs
parents:
diff changeset
    97
            TInt& aReasonResourceId) const;
hgs
parents:
diff changeset
    98
hgs
parents:
diff changeset
    99
        /**
hgs
parents:
diff changeset
   100
        * From CBaseMtmUiData Provide context-specific function information.
hgs
parents:
diff changeset
   101
        * @param aContext Messaging entry refence.
hgs
parents:
diff changeset
   102
        * @param aReasonResourceId Resource id.
hgs
parents:
diff changeset
   103
        * @return TBool inform that mtm can provice function or not.
hgs
parents:
diff changeset
   104
        */
hgs
parents:
diff changeset
   105
	    virtual TBool CanReplyToEntryL(
hgs
parents:
diff changeset
   106
            const TMsvEntry& aContext, 
hgs
parents:
diff changeset
   107
            TInt& aReasonResourceId) const;
hgs
parents:
diff changeset
   108
hgs
parents:
diff changeset
   109
        /**
hgs
parents:
diff changeset
   110
        * From CBaseMtmUiData Provide context-specific function information.
hgs
parents:
diff changeset
   111
        * @param aContext Messaging entry refence.
hgs
parents:
diff changeset
   112
        * @param aReasonResourceId Resource id.
hgs
parents:
diff changeset
   113
        * @return TBool inform that mtm can provice function or not.
hgs
parents:
diff changeset
   114
        */
hgs
parents:
diff changeset
   115
	    virtual TBool CanForwardEntryL(
hgs
parents:
diff changeset
   116
            const TMsvEntry& aContext, 
hgs
parents:
diff changeset
   117
            TInt& aReasonResourceId) const;
hgs
parents:
diff changeset
   118
hgs
parents:
diff changeset
   119
        /**
hgs
parents:
diff changeset
   120
        * From CBaseMtmUiData Provide context-specific function information.
hgs
parents:
diff changeset
   121
        * @param aContext Messaging entry refence.
hgs
parents:
diff changeset
   122
        * @param aReasonResourceId Resource id.
hgs
parents:
diff changeset
   123
        * @return TBool inform that mtm can provice function or not.
hgs
parents:
diff changeset
   124
        */
hgs
parents:
diff changeset
   125
	    virtual TBool CanEditEntryL(
hgs
parents:
diff changeset
   126
            const TMsvEntry& aContext, 
hgs
parents:
diff changeset
   127
            TInt& aReasonResourceId) const;
hgs
parents:
diff changeset
   128
hgs
parents:
diff changeset
   129
        /**
hgs
parents:
diff changeset
   130
        * From CBaseMtmUiData Provide context-specific function information.
hgs
parents:
diff changeset
   131
        * @param aContext Messaging entry refence.
hgs
parents:
diff changeset
   132
        * @param aReasonResourceId Resource id.
hgs
parents:
diff changeset
   133
        * @return TBool inform that mtm can provice function or not.
hgs
parents:
diff changeset
   134
        */
hgs
parents:
diff changeset
   135
	    virtual TBool CanViewEntryL(const TMsvEntry& aContext, 
hgs
parents:
diff changeset
   136
            TInt& aReasonResourceId) const;
hgs
parents:
diff changeset
   137
hgs
parents:
diff changeset
   138
        /**
hgs
parents:
diff changeset
   139
        * From CBaseMtmUiData Provide context-specific function information.
hgs
parents:
diff changeset
   140
        * @param aContext Messaging entry refence.
hgs
parents:
diff changeset
   141
        * @param aReasonResourceId Resource id.
hgs
parents:
diff changeset
   142
        * @return TBool inform that mtm can provice function or not.
hgs
parents:
diff changeset
   143
        */
hgs
parents:
diff changeset
   144
	    virtual TBool CanOpenEntryL(
hgs
parents:
diff changeset
   145
            const TMsvEntry& aContext, 
hgs
parents:
diff changeset
   146
            TInt& aReasonResourceId) const;
hgs
parents:
diff changeset
   147
hgs
parents:
diff changeset
   148
        /**
hgs
parents:
diff changeset
   149
        * From CBaseMtmUiData Provide context-specific function information.
hgs
parents:
diff changeset
   150
        * @param aContext Messaging entry refence.
hgs
parents:
diff changeset
   151
        * @param aReasonResourceId Resource id.
hgs
parents:
diff changeset
   152
        * @return TBool inform that mtm can provice function or not.
hgs
parents:
diff changeset
   153
        */
hgs
parents:
diff changeset
   154
	    virtual TBool CanCloseEntryL(
hgs
parents:
diff changeset
   155
            const TMsvEntry& aContext, 
hgs
parents:
diff changeset
   156
            TInt& aReasonResourceId) const;
hgs
parents:
diff changeset
   157
hgs
parents:
diff changeset
   158
        /**
hgs
parents:
diff changeset
   159
        * From CBaseMtmUiData Provide context-specific function information.
hgs
parents:
diff changeset
   160
        * @param aContext Messaging entry refence.
hgs
parents:
diff changeset
   161
        * @param aReasonResourceId Resource id.
hgs
parents:
diff changeset
   162
        * @return TBool inform that mtm can provice function or not.
hgs
parents:
diff changeset
   163
        */
hgs
parents:
diff changeset
   164
	    virtual TBool CanDeleteFromEntryL(
hgs
parents:
diff changeset
   165
            const TMsvEntry& aContext, 
hgs
parents:
diff changeset
   166
            TInt& aReasonResourceId) const;
hgs
parents:
diff changeset
   167
hgs
parents:
diff changeset
   168
        /**
hgs
parents:
diff changeset
   169
        * From CBaseMtmUiData Provide context-specific function information.
hgs
parents:
diff changeset
   170
        * @param aContext Messaging entry refence.
hgs
parents:
diff changeset
   171
        * @param aReasonResourceId Resource id.
hgs
parents:
diff changeset
   172
        * @return TBool inform that mtm can provice function or not.
hgs
parents:
diff changeset
   173
        */
hgs
parents:
diff changeset
   174
	    virtual TBool CanDeleteServiceL(
hgs
parents:
diff changeset
   175
            const TMsvEntry& aService, 
hgs
parents:
diff changeset
   176
            TInt& aReasonResourceId) const;
hgs
parents:
diff changeset
   177
hgs
parents:
diff changeset
   178
        /**
hgs
parents:
diff changeset
   179
        * From CBaseMtmUiData Provide context-specific function information.
hgs
parents:
diff changeset
   180
        * @param aContext Messaging entry refence.
hgs
parents:
diff changeset
   181
        * @param aReasonResourceId Resource id.
hgs
parents:
diff changeset
   182
        * @return TBool inform that mtm can provice function or not.
hgs
parents:
diff changeset
   183
        */
hgs
parents:
diff changeset
   184
	    virtual TBool CanCopyMoveToEntryL(
hgs
parents:
diff changeset
   185
            const TMsvEntry& aContext, 
hgs
parents:
diff changeset
   186
            TInt& aReasonResourceId) const;
hgs
parents:
diff changeset
   187
hgs
parents:
diff changeset
   188
        /**
hgs
parents:
diff changeset
   189
        * From CBaseMtmUiData Provide context-specific function information.
hgs
parents:
diff changeset
   190
        * @param aContext Messaging entry refence.
hgs
parents:
diff changeset
   191
        * @param aReasonResourceId Resource id.
hgs
parents:
diff changeset
   192
        * @return TBool inform that mtm can provice function or not.
hgs
parents:
diff changeset
   193
        */
hgs
parents:
diff changeset
   194
	    virtual TBool CanCopyMoveFromEntryL(
hgs
parents:
diff changeset
   195
            const TMsvEntry& aContext, 
hgs
parents:
diff changeset
   196
            TInt& aReasonResourceId) const;
hgs
parents:
diff changeset
   197
hgs
parents:
diff changeset
   198
        /**
hgs
parents:
diff changeset
   199
        * From CBaseMtmUiData Provide context-specific function information.
hgs
parents:
diff changeset
   200
        * @param aContext Messaging entry refence.
hgs
parents:
diff changeset
   201
        * @param aReasonResourceId Resource id.
hgs
parents:
diff changeset
   202
        * @return TBool inform that mtm can provice function or not.
hgs
parents:
diff changeset
   203
        */
hgs
parents:
diff changeset
   204
        virtual TBool CanCancelL(const TMsvEntry& aContext, 
hgs
parents:
diff changeset
   205
            TInt& aReasonResourceId) const;
hgs
parents:
diff changeset
   206
hgs
parents:
diff changeset
   207
        /**
hgs
parents:
diff changeset
   208
        * From CBaseMtmUiData Provide context-specific function information.
hgs
parents:
diff changeset
   209
        * @param aContext Messaging entry refence.
hgs
parents:
diff changeset
   210
        * @return HBufC* Statustext for sending.
hgs
parents:
diff changeset
   211
        */
hgs
parents:
diff changeset
   212
        virtual HBufC* StatusTextL(const TMsvEntry& aContext) const;
hgs
parents:
diff changeset
   213
hgs
parents:
diff changeset
   214
    protected:  // Functions from base classes
hgs
parents:
diff changeset
   215
hgs
parents:
diff changeset
   216
        /**
hgs
parents:
diff changeset
   217
        * From CBaseMtmUiData Populate icon array
hgs
parents:
diff changeset
   218
        */
hgs
parents:
diff changeset
   219
	    virtual void PopulateArraysL();
hgs
parents:
diff changeset
   220
hgs
parents:
diff changeset
   221
        /**
hgs
parents:
diff changeset
   222
        * From CBaseMtmUiData gets resource filename.
hgs
parents:
diff changeset
   223
        */
hgs
parents:
diff changeset
   224
	    virtual void GetResourceFileName(TFileName& aFileName) const;
hgs
parents:
diff changeset
   225
hgs
parents:
diff changeset
   226
    protected: 
hgs
parents:
diff changeset
   227
hgs
parents:
diff changeset
   228
        /**
hgs
parents:
diff changeset
   229
        * C++ default constructor.
hgs
parents:
diff changeset
   230
        */
hgs
parents:
diff changeset
   231
        CIrMtmUiData(CRegisteredMtmDll& aRegisteredDll);
hgs
parents:
diff changeset
   232
hgs
parents:
diff changeset
   233
    protected: // New functions
hgs
parents:
diff changeset
   234
hgs
parents:
diff changeset
   235
        /**
hgs
parents:
diff changeset
   236
        * Checks is the entry valid.
hgs
parents:
diff changeset
   237
        * @param aContext reference to the entry.
hgs
parents:
diff changeset
   238
        * @return TBool 
hgs
parents:
diff changeset
   239
        */
hgs
parents:
diff changeset
   240
	    TBool CheckEntry(const TMsvEntry& aContext) const;
hgs
parents:
diff changeset
   241
hgs
parents:
diff changeset
   242
	};
hgs
parents:
diff changeset
   243
hgs
parents:
diff changeset
   244
#endif // CIRMTMUIDATA_H
hgs
parents:
diff changeset
   245
// End of File