|
1 /* |
|
2 * Copyright (c) 2002, 2003 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: |
|
15 * Wrapper for MMS specials in TMsvEntry. |
|
16 * There is no single MMS specific flag defined, |
|
17 * the methods are rather for ease of usage. |
|
18 * There is a lot of free flags available. |
|
19 * |
|
20 */ |
|
21 |
|
22 |
|
23 |
|
24 #ifndef TMMSMSVENTRY_H |
|
25 #define TMMSMSVENTRY_H |
|
26 |
|
27 // INCLUDES |
|
28 #include <msvstd.h> |
|
29 #include "mmsconst.h" |
|
30 |
|
31 |
|
32 // CONSTANTS |
|
33 |
|
34 // MACROS |
|
35 |
|
36 // DATA TYPES |
|
37 |
|
38 // FUNCTION PROTOTYPES |
|
39 |
|
40 // FORWARD DECLARATIONS |
|
41 |
|
42 // CLASS DECLARATION |
|
43 |
|
44 /** |
|
45 * Wrapper for MMS specials in TMsvEntry. |
|
46 */ |
|
47 class TMmsMsvEntry :public TMsvEntry |
|
48 { |
|
49 public: // Constructors and destructor |
|
50 |
|
51 /** |
|
52 * C++ default constructor. |
|
53 */ |
|
54 IMPORT_C TMmsMsvEntry(); |
|
55 |
|
56 /** |
|
57 * Constructor. This causes memory copy to take place, so use rather type |
|
58 * casting when you do not need copy of the object. |
|
59 * Note that this does not copy the contents of iDetails and iDescriptor of |
|
60 * aGenericEntry.. |
|
61 * The destructor of the original CMsvEntry entry deletes the |
|
62 * buffers pointed to by the TPtrC members. |
|
63 * @param aGenericEntry an entry in the Message Server index |
|
64 */ |
|
65 IMPORT_C TMmsMsvEntry( const TMsvEntry& aGenericEntry ); |
|
66 |
|
67 |
|
68 public: // New functions |
|
69 |
|
70 /** |
|
71 * Compare operation. |
|
72 */ |
|
73 IMPORT_C TBool operator==( const TMsvEntry& aEntry ) const; |
|
74 |
|
75 /** |
|
76 * Compare operation |
|
77 */ |
|
78 IMPORT_C TBool operator==( const TMmsMsvEntry& aEntry ) const; |
|
79 |
|
80 /** |
|
81 * Subject mutator |
|
82 * @param aSubject message subject |
|
83 */ |
|
84 IMPORT_C void SetSubject( const TDesC& aSubject ); |
|
85 |
|
86 /** |
|
87 * Subject accessor |
|
88 * @return message Subject |
|
89 */ |
|
90 IMPORT_C const TDesC& Subject() const; |
|
91 |
|
92 /** |
|
93 * Attachment File name mutator |
|
94 * @param aFile attachment file name in message binary file storage |
|
95 */ |
|
96 IMPORT_C void SetAttachmentFile( const TDesC& aFile ); |
|
97 |
|
98 /** |
|
99 * Attachment File name accessor |
|
100 * @return attachment file name in message binary file storage |
|
101 */ |
|
102 IMPORT_C const TDesC& AttachmentFile() const; |
|
103 |
|
104 /** |
|
105 * If the message entry is a mobile terminated message. |
|
106 * @return ETrue if the entry is a mobile terminated message. |
|
107 */ |
|
108 inline TBool IsMobileTerminated() const; |
|
109 |
|
110 /** |
|
111 * Mutator for mobile terminated message flag. |
|
112 * @param aParam ETrue if the entry is a mobile terminated message. |
|
113 */ |
|
114 inline void SetMobileTerminated( TBool aParam ); |
|
115 |
|
116 /** |
|
117 * If the message entry is forwarded message. |
|
118 * @return ETrue if the entry is a forwarded message. |
|
119 */ |
|
120 inline TBool IsForwardedMessage() const; |
|
121 |
|
122 /** |
|
123 * Mutator for forwarded message flag. |
|
124 * @aParam aParam ETrue if the entry is a mobile terminated message. |
|
125 */ |
|
126 inline void SetForwardedMessage( TBool aParam ); |
|
127 |
|
128 // The following flags are mainly for Server MTM only. |
|
129 |
|
130 /** |
|
131 * If the message entry is m-send-req. |
|
132 * @return ETrue if the entry is m-send-req. |
|
133 */ |
|
134 inline TBool IsMSendReq() const; |
|
135 |
|
136 /** |
|
137 * If the message entry is m-notification-ind. |
|
138 * @return ETrue if the entry is m-notification-ind. |
|
139 */ |
|
140 inline TBool IsMNotificationInd() const; |
|
141 |
|
142 /** |
|
143 * If the message entry is m-retrieve-conf. |
|
144 * @return ETrue if the entry is m-retrieve-conf. |
|
145 */ |
|
146 inline TBool IsMRetrieveConf() const; |
|
147 |
|
148 /** |
|
149 * If the message entry is m-delivery-ind. |
|
150 * @return ETrue if the entry is m-notification-ind. |
|
151 */ |
|
152 inline TBool IsMDeliveryInd() const; |
|
153 |
|
154 /** |
|
155 * Mutator for m-send-req flag. |
|
156 */ |
|
157 inline void SetMSendReq( ); |
|
158 |
|
159 /** |
|
160 * Mutator for m-notification-ind. |
|
161 */ |
|
162 inline void SetMNotificationInd( ); |
|
163 |
|
164 /** |
|
165 * Mutator for m-retrieve-conf. |
|
166 */ |
|
167 inline void SetMRetrieveConf( ); |
|
168 |
|
169 /** |
|
170 * Mutator for m-delivery-ind. |
|
171 */ |
|
172 inline void SetMDeliveryInd( ); |
|
173 |
|
174 /** |
|
175 * M-NotifyResp.ind is sent for this M-Notification.ind |
|
176 * @return ETrue if response is sent. |
|
177 */ |
|
178 inline TBool MNotifyRespIndSent() const; |
|
179 |
|
180 /** |
|
181 * Mutator for M-NotifyResp.ind Sent flag |
|
182 * @param aParam ETrue if M-NotifyResp.ind is sent. |
|
183 */ |
|
184 inline void SetMNotifyRespIndSent( TBool aParam ); |
|
185 |
|
186 /** |
|
187 * Editor Oriented flag accessor. |
|
188 */ |
|
189 inline TBool EditorOriented() const; |
|
190 |
|
191 /** |
|
192 * Editor Orieneted flag mutator. |
|
193 * @param aParam flag value |
|
194 */ |
|
195 inline void SetEditorOriented (TBool aParam ); |
|
196 |
|
197 |
|
198 public: // Functions from base classes |
|
199 |
|
200 protected: // New functions |
|
201 |
|
202 protected: // Functions from base classes |
|
203 |
|
204 private: |
|
205 |
|
206 |
|
207 public: // Data |
|
208 |
|
209 protected: // Data |
|
210 |
|
211 private: // Data |
|
212 |
|
213 |
|
214 public: // Friend classes |
|
215 |
|
216 protected: // Friend classes |
|
217 |
|
218 private: // Friend classes |
|
219 |
|
220 |
|
221 }; |
|
222 |
|
223 #include "mmsmsventry.inl" |
|
224 |
|
225 #endif // TMMSMSVENTRY_H |
|
226 |
|
227 // End of File |