|
1 // Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
2 // All rights reserved. |
|
3 // This component and the accompanying materials are made available |
|
4 // under the terms of "Eclipse Public License v1.0" |
|
5 // which accompanies this distribution, and is available |
|
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
7 // |
|
8 // Initial Contributors: |
|
9 // Nokia Corporation - initial contribution. |
|
10 // |
|
11 // Contributors: |
|
12 // |
|
13 // Description: |
|
14 // tmsvbioinfo.h |
|
15 // |
|
16 /** |
|
17 * @file |
|
18 * Base classes to store additional BIO message-specific information. |
|
19 * |
|
20 * @internalTechnology |
|
21 * @released |
|
22 */ |
|
23 |
|
24 #if !defined(__TMSVBIOINFO_H__) |
|
25 #define __TMSVBIOINFO_H__ |
|
26 |
|
27 // Symbols: |
|
28 /** Space character. |
|
29 * @internalTechnology |
|
30 * @released |
|
31 */ |
|
32 #define KCharSpace ' ' |
|
33 /** Tab character. |
|
34 * @internalTechnology |
|
35 * @released |
|
36 */ |
|
37 #define KCharTab '\t' |
|
38 /** Line feed character. |
|
39 * @internalTechnology |
|
40 * @released |
|
41 */ |
|
42 #define KCharLineFeed '\n' |
|
43 |
|
44 // Define some generic error codes: |
|
45 /** BIO error code base |
|
46 * @internalTechnology |
|
47 * @released |
|
48 */ |
|
49 const TInt KBspBaseError = (-500); |
|
50 |
|
51 /** Invalid BIO message error code. |
|
52 * @internalTechnology |
|
53 * @released |
|
54 */ |
|
55 const TInt KBspInvalidMessage = (KBspBaseError); |
|
56 |
|
57 /** Invalid smart message token error code. |
|
58 * @internalTechnology |
|
59 * @released |
|
60 */ |
|
61 const TInt KBspSmartMessageInvalidToken = (KBspBaseError-1); |
|
62 |
|
63 /** No smart message parser defined error code. |
|
64 * @internalTechnology |
|
65 * @released |
|
66 */ |
|
67 const TInt KBspSmartMessageNoParserDefined = (KBspBaseError-2); |
|
68 |
|
69 /** |
|
70 * BIO client MTM UID. |
|
71 * @internalTechnology |
|
72 * @released |
|
73 */ |
|
74 const TUid KUidBIOMessageClientMtmDll = {0x1000125A}; //previously NBSC, now BIOC |
|
75 /** |
|
76 * BIO server MTM UID. |
|
77 * @internalTechnology |
|
78 * @released |
|
79 */ |
|
80 const TUid KUidBIOMessageServerMtmDll = {0x1000125C}; //previously NBSS, now BIOS |
|
81 /** |
|
82 * BIO UI MTM UID. |
|
83 * @internalTechnology |
|
84 * @released |
|
85 */ |
|
86 const TUid KUidBIOMessageUiLayerMtmDll = {0x10001265}; //previously NBUM, now BIUM |
|
87 /** |
|
88 * BIO message viewer UID. |
|
89 * @internalTechnology |
|
90 * @released |
|
91 */ |
|
92 const TUid KUidBIOMessageViewerApp = {0x10001264}; //previously NBED,now BIED |
|
93 |
|
94 /** BIO data location flag values. |
|
95 * @internalTechnology |
|
96 * @released |
|
97 * @see TMsvBIOEntry |
|
98 */ |
|
99 enum TMsvBIODataLocation |
|
100 { |
|
101 /** Unknown. */ |
|
102 EUnknown, |
|
103 /** Parser wrote data into the body text. */ |
|
104 EBodyText, // parser wrote data back into richText |
|
105 /** Parser wrote data into the parsed fields data stream. */ |
|
106 EBIODataStream, // parser wrote data into KUIDMsvBioStream |
|
107 /** Parser wrote data into an attachment file. */ |
|
108 EFile // parser wrote data into attachment file |
|
109 }; |
|
110 |
|
111 |
|
112 /** Bearer Independent Object entry. |
|
113 * Specialises the TMsvEntry message entry class to store additional |
|
114 * BIO message-specific information. |
|
115 * @internalTechnology |
|
116 * @released |
|
117 */ |
|
118 class TMsvBIOEntry : public TMsvEntry |
|
119 { |
|
120 public: |
|
121 /** Constructor. */ |
|
122 TMsvBIOEntry() : TMsvEntry() {}; |
|
123 void SetBIOParserUid(const TUid aId); |
|
124 const TUid BIOParserUid() const; |
|
125 void SetLocationOfData(const TMsvBIODataLocation aLocation); |
|
126 const TMsvBIODataLocation LocationOfData() const; |
|
127 |
|
128 private: |
|
129 TMsvBIODataLocation iLocationOfData; |
|
130 }; |
|
131 |
|
132 #include <bsp.inl> |
|
133 |
|
134 #endif //__TMSVBIOINFO_H__ |