|
1 /* |
|
2 * Copyright (c) 2002 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 * Defines abstract interface for Logs event |
|
16 * |
|
17 */ |
|
18 |
|
19 |
|
20 #ifndef __MLogsEvent_H_ |
|
21 #define __MLogsEvent_H_ |
|
22 |
|
23 // INCLUDES |
|
24 #include <e32std.h> |
|
25 #include <logwrap.h> |
|
26 #include <cntdef.h> |
|
27 #include "LogsEng.hrh" |
|
28 |
|
29 #include "MLogsEventData.h" |
|
30 #include "TLogsEventStrings.h" |
|
31 |
|
32 |
|
33 // MACROS |
|
34 |
|
35 // DATA TYPES |
|
36 |
|
37 // FUNCTION PROTOTYPES |
|
38 |
|
39 // FORWARD DECLARATIONS |
|
40 |
|
41 // CLASS DECLARATION |
|
42 |
|
43 /** |
|
44 * Defines abstract interface for Logs event |
|
45 */ |
|
46 class MLogsEvent |
|
47 { |
|
48 public: |
|
49 |
|
50 virtual ~MLogsEvent() {}; |
|
51 |
|
52 public: |
|
53 |
|
54 /** |
|
55 * Time setter |
|
56 * |
|
57 * @param aTime time |
|
58 */ |
|
59 virtual void SetTime( const TTime aTime ) = 0; |
|
60 |
|
61 /** |
|
62 * Log Id setter |
|
63 * |
|
64 * @param aLogId log event id |
|
65 */ |
|
66 virtual void SetLogId( const TLogId aLogId ) = 0; |
|
67 |
|
68 /** |
|
69 * Number setter |
|
70 * |
|
71 * @param aNumber Phone number |
|
72 */ |
|
73 virtual void SetNumber( HBufC* aNumber ) = 0; |
|
74 |
|
75 |
|
76 /** |
|
77 * Remove party setter |
|
78 * |
|
79 * @param aRemoteParty Remove party name |
|
80 */ |
|
81 virtual void SetRemoteParty( HBufC* aRemoteParty ) = 0; |
|
82 |
|
83 /** |
|
84 * Direction setter |
|
85 * |
|
86 * @param aDirection direction |
|
87 */ |
|
88 virtual void SetDirection( const TLogsDirection aDirection ) = 0; |
|
89 |
|
90 /** |
|
91 * Uid setter |
|
92 * |
|
93 * @param aUid Uid |
|
94 */ |
|
95 virtual void SetEventUid( const TUid aUid ) = 0; |
|
96 |
|
97 /** |
|
98 * Event type setter |
|
99 * |
|
100 * @param aEventType event type |
|
101 */ |
|
102 virtual void SetEventType( const TLogsEventType aEventType ) = 0; |
|
103 |
|
104 /** |
|
105 * Duplicates setter |
|
106 * |
|
107 * @param aDuplicates number of duplicates |
|
108 */ |
|
109 virtual void SetDuplicates( const TInt8 aDuplicates ) = 0; |
|
110 |
|
111 /** |
|
112 * Is read/unread setter |
|
113 * |
|
114 * @param true/false |
|
115 */ |
|
116 virtual void SetIsRead(TBool aRead) = 0; |
|
117 |
|
118 /** |
|
119 * Is read/unread getter |
|
120 * |
|
121 * @return true/false |
|
122 */ |
|
123 virtual TBool IsRead() const = 0; |
|
124 |
|
125 /** |
|
126 * Time getter |
|
127 * |
|
128 * @return time |
|
129 */ |
|
130 virtual TTime Time() const = 0; |
|
131 |
|
132 /** |
|
133 * Log Id getter |
|
134 * |
|
135 * @return log event id |
|
136 */ |
|
137 virtual TLogId LogId() const = 0; |
|
138 |
|
139 /** |
|
140 * Number getter |
|
141 * |
|
142 */ |
|
143 virtual HBufC* Number() = 0; |
|
144 |
|
145 /** |
|
146 * Remote party getter |
|
147 * |
|
148 */ |
|
149 virtual HBufC* RemoteParty() = 0; |
|
150 |
|
151 /** |
|
152 * Direction getter |
|
153 * |
|
154 * @return aDirection direction |
|
155 */ |
|
156 virtual TLogsDirection Direction() const = 0; |
|
157 |
|
158 /** |
|
159 * Uid getter |
|
160 * |
|
161 * @param Uid |
|
162 */ |
|
163 virtual TUid EventUid() const = 0; |
|
164 |
|
165 /** |
|
166 * Event type getter |
|
167 * |
|
168 * @param event type |
|
169 */ |
|
170 virtual TLogsEventType EventType() const = 0; |
|
171 |
|
172 /** |
|
173 * Duplicates getter |
|
174 * |
|
175 * @param number of duplicates |
|
176 */ |
|
177 virtual TInt8 Duplicates() const = 0; |
|
178 |
|
179 /** |
|
180 * Additional LogsData object. |
|
181 * |
|
182 * @return MLogsEventData object. |
|
183 */ |
|
184 virtual MLogsEventData* LogsEventData() const = 0; |
|
185 |
|
186 /** |
|
187 * Set Additional LogsData object. |
|
188 * |
|
189 * @param pointer to eventData object |
|
190 */ |
|
191 virtual void SetLogsEventData( MLogsEventData* aLogsEventData ) = 0; |
|
192 |
|
193 /** |
|
194 * ALS flag (Alternate line service). |
|
195 * |
|
196 * @return ALS status flag. EFalse if not ALS event, ETrue if ALS event. |
|
197 */ |
|
198 virtual TBool ALS() const = 0; |
|
199 |
|
200 /** |
|
201 * Set ALS flag. |
|
202 * |
|
203 * @parama aAls als status |
|
204 */ |
|
205 virtual void SetALS( TBool aALS ) = 0; |
|
206 |
|
207 /** |
|
208 * CNAP flag (Calling name presentation service). |
|
209 * |
|
210 * @return CNAP status flag. EFalse if not CNAP event, ETrue if CNAP event. |
|
211 */ |
|
212 virtual TBool CNAP() const = 0; |
|
213 |
|
214 /** |
|
215 * Reset the event |
|
216 */ |
|
217 // virtual void Reset() = 0; |
|
218 |
|
219 |
|
220 /** |
|
221 * NEW IMPLEMENTATION |
|
222 * Construct the event |
|
223 */ |
|
224 virtual void InitializeEventL( const CLogEvent& /* aSource */, |
|
225 TLogsEventStrings /*aStrings*/, |
|
226 TLogsModel /* aModel */ ) = 0; |
|
227 |
|
228 |
|
229 |
|
230 |
|
231 //For ring duation feature |
|
232 /** |
|
233 * Return Ring Duration |
|
234 * |
|
235 * @return Ring Duration |
|
236 */ |
|
237 virtual TLogDuration RingDuration() const = 0; |
|
238 |
|
239 /** |
|
240 * Set Ring Duration |
|
241 * |
|
242 * @parama aDuration Ring duration |
|
243 */ |
|
244 virtual void SetRingDuration( TLogDuration aDuration ) = 0; |
|
245 |
|
246 /** |
|
247 * Phone number field type setter |
|
248 * |
|
249 * @param number field type |
|
250 */ |
|
251 virtual void SetNumberFieldType( const TInt aNumberFieldType ) = 0; |
|
252 |
|
253 /** |
|
254 * Return Phone number field type |
|
255 * |
|
256 * @return Phone number field type |
|
257 */ |
|
258 virtual TInt NumberFieldType() const = 0; |
|
259 }; |
|
260 |
|
261 |
|
262 #endif |
|
263 |
|
264 // End of File __MLogsEvent_H_ |