|
1 /* |
|
2 * Copyright (c) 2002-2004 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: Message view plug-in interface |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 #ifndef MMAILMESSAGEVIEW_H |
|
21 #define MMAILMESSAGEVIEW_H |
|
22 |
|
23 #include <e32def.h> |
|
24 #include <coedef.h> |
|
25 #include <w32std.h> |
|
26 |
|
27 |
|
28 // FORWARD DECLARATIONS |
|
29 class MMailAppUiInterface; |
|
30 class CEikMenuPane; |
|
31 class CMailMessage; |
|
32 class RFileReadStream; |
|
33 |
|
34 // CLASS DECLARATION |
|
35 |
|
36 /** |
|
37 * MMailMessageView interface. |
|
38 * |
|
39 * @since Series 60 3.0 |
|
40 */ |
|
41 class MMailMessageView |
|
42 { |
|
43 public: // destructor |
|
44 |
|
45 /** |
|
46 * Destructor. |
|
47 */ |
|
48 virtual ~MMailMessageView(){}; |
|
49 |
|
50 public: // New functions |
|
51 |
|
52 /** |
|
53 * DynInitOptionsMenuL. |
|
54 * @since Series 60 3.0 |
|
55 * @param aResourceId menu resource |
|
56 * @param aMenuPane menu pane |
|
57 */ |
|
58 virtual void DynInitMenuPaneL( |
|
59 TInt aResourceId,CEikMenuPane* aMenuPane) = 0; |
|
60 |
|
61 /** |
|
62 * HandleCommandL. |
|
63 * @since Series 60 3.0 |
|
64 * @param aCommand command id |
|
65 */ |
|
66 virtual TBool HandleCommandL(TInt aCommand) = 0; |
|
67 |
|
68 /** |
|
69 * HandleCommandL. |
|
70 * @since Series 60 3.0 |
|
71 * @param aKeyEvent key event |
|
72 * @param aType event type |
|
73 */ |
|
74 virtual TKeyResponse HandleKeyEventL( |
|
75 const TKeyEvent& aKeyEvent, |
|
76 TEventCode aType) = 0; |
|
77 |
|
78 /** |
|
79 * MessageLoadL |
|
80 * @since Series 60 3.0 |
|
81 * Called after each messag loading step so |
|
82 * that plug-in can examine message step by step. |
|
83 * Plug-in should not add any UI controls to app ui at this state. |
|
84 * @param aState message loading state. See TLoadState <CMailMessage.h> |
|
85 * @param aMessage Mail message. |
|
86 * If this function leaves, plug-in will be delete and |
|
87 * removed from the plug-in array. |
|
88 */ |
|
89 virtual void MessageLoadL(TInt aState, CMailMessage& aMessage) = 0; |
|
90 |
|
91 /** |
|
92 * ViewMessageL. |
|
93 * @since Series 60 3.0 |
|
94 * This function is called from the UI only the selected Plug-in that is |
|
95 * used for viewin the message. |
|
96 * @param aReadStream stream |
|
97 * @param aUICallBack mail viewer UI call back. |
|
98 */ |
|
99 virtual void ViewMessageL( |
|
100 RFileReadStream& aReadStream, |
|
101 MMailAppUiInterface& aUICallBack) = 0; |
|
102 |
|
103 /** |
|
104 * ViewMessageL |
|
105 * @since Series 60 3.0 |
|
106 * This function is called from the UI only the selected Plug-in that is |
|
107 * used for viewin the message. |
|
108 * @param aMessage Fully loaded mail message. |
|
109 * @param aUICallBack mail viewer UI call back. |
|
110 * @param aParams params from plug-in to mail UI. |
|
111 */ |
|
112 virtual void ViewMessageL( |
|
113 CMailMessage& aMessage, |
|
114 MMailAppUiInterface& aUICallBack, |
|
115 TUint& aParams) = 0; |
|
116 |
|
117 /** |
|
118 * ResourceFile. |
|
119 * @since Series 60 3.0 |
|
120 * @param aResourceFile name of the resource file |
|
121 * Gives the caller a resource file to load |
|
122 */ |
|
123 virtual const TDesC& ResourceFile() = 0; |
|
124 }; |
|
125 |
|
126 #endif // MMAILMESSAGEVIEW_H |
|
127 |
|
128 // End of File |