|
1 /* |
|
2 * Copyright (c) 2006 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: Offers information regarding a given header to the UI. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef __MCARECORDEDCHATSPC_H__ |
|
20 #define __MCARECORDEDCHATSPC_H__ |
|
21 |
|
22 // INCLUDES |
|
23 #include "PublicEngineDefinitions.h" |
|
24 |
|
25 |
|
26 |
|
27 #include <e32std.h> |
|
28 #include <e32base.h> |
|
29 #include <bamdesca.h> // MDesCArray |
|
30 #include <badesca.h> // CDesCArray |
|
31 // FORWARD DECLARATIONS |
|
32 class RWriteStream; |
|
33 class MCAMessagesReadInterface; |
|
34 class MDesCArray; |
|
35 class MCAServerContactsArrayPC; |
|
36 |
|
37 // CLASS DECLARATION |
|
38 |
|
39 /** |
|
40 * Interface class for UI->PC communication ( UI retrieves information ). |
|
41 * Offers information regarding a given header to the UI. |
|
42 * |
|
43 * @lib wvuiprocessng.lib |
|
44 * @since 3.2 |
|
45 */ |
|
46 class MCARecordedChatsPC |
|
47 { |
|
48 public: // New functions |
|
49 |
|
50 |
|
51 /** |
|
52 * Delete one history file recognized by index. |
|
53 * @return true if the file has been deleted else return false |
|
54 */ |
|
55 virtual TBool DeleteHistoryFileL( ) = 0; |
|
56 |
|
57 |
|
58 /** |
|
59 * Deletes message container of current recorded chat |
|
60 * from engine. Used to free memory when exiting current |
|
61 * recorded chat view i.e. called from DoDeactivate method |
|
62 * of view class. |
|
63 */ |
|
64 virtual void DeleteRecordedChatContainerL() = 0; |
|
65 |
|
66 /** |
|
67 * Initialize/unitialize selected items array pointer |
|
68 * @param aArray Pointer to selected items array. |
|
69 */ |
|
70 virtual void SetSelectedItems( const CArrayFix< TInt >* aArray ) = 0; |
|
71 |
|
72 /** |
|
73 * Return whether there are selected items |
|
74 * @param true if there is atleast one valid item selected else return false |
|
75 */ |
|
76 virtual TBool ValidSelectedItems() const = 0; |
|
77 |
|
78 /** |
|
79 * return the number of selected items |
|
80 * @Return an integer: count of selected items |
|
81 */ |
|
82 virtual TInt SelectedItemsCount() const = 0; |
|
83 |
|
84 /** |
|
85 * Prepares array for sending MTMs. |
|
86 */ |
|
87 virtual void PrepareArrayForSendingMtmL() = 0; |
|
88 |
|
89 /** |
|
90 * Is index item marked or not |
|
91 * @param aIndex Item which marked status is returned |
|
92 * @return ETrue if item is marked, EFalse if not. |
|
93 */ |
|
94 virtual TBool IsMarked( TInt aIndex ) = 0; |
|
95 |
|
96 /** |
|
97 * Initialize array for deletion. Sort is from back to start. |
|
98 */ |
|
99 virtual void InitDeleteArrayL() = 0; |
|
100 |
|
101 /** |
|
102 * Method is used to launch MTM editor with given targetUid |
|
103 * @param aTargetUid id for MTM editor to be launched. |
|
104 * @param aIndex Message index which to send. |
|
105 */ |
|
106 // Code Scanner warning to be ignored |
|
107 virtual TInt SendMTML( TInt aIndex, TUid aTargetUid /*= KNullUid*/ ) = 0; |
|
108 |
|
109 /** |
|
110 * Delete history files. If there is marked items those are deleted. |
|
111 * Otherwise item which index is given is deleted. |
|
112 * @param aIndex Item index |
|
113 * @return ETrue, if deletion is ok to start, EFalse if not. |
|
114 */ |
|
115 virtual void DeleteHistoryFilesL( TInt aIndex, TBool aDeleteCurrentChat ) = 0; |
|
116 |
|
117 /** |
|
118 * Check filename for MTM messages and correct |
|
119 * it to unique if it is not. |
|
120 * @param aFilename Proposed filename and corrected after checking. |
|
121 * @param aArray Array of already existing filenames. |
|
122 */ |
|
123 virtual void CheckAndCorrectMtmFilename( TFileName& aFilename, |
|
124 MDesCArray& aArray ) = 0; |
|
125 |
|
126 |
|
127 /** |
|
128 * Get the number of stored contacts in all the lists |
|
129 * @return integer: number of stored contacts |
|
130 */ |
|
131 virtual TInt StoredContactsCount() const = 0; |
|
132 |
|
133 /** |
|
134 * To return the number of groups |
|
135 * @return integer: count of groups |
|
136 */ |
|
137 virtual TInt GroupCountL( TBool aGroupsSupported ) const = 0; |
|
138 |
|
139 /** |
|
140 * To populate the two arrays of group names and goup ids |
|
141 * @return - Fills and returns groupname along with the ID |
|
142 * Ownership is transferred to the caller |
|
143 */ |
|
144 virtual MCAServerContactsArrayPC* GetPairArrayForServerContactsArrayLC() = 0; |
|
145 |
|
146 //fix - refer Ui Spec Approved Version 1.0 (Instant Messaging NG 001 151006.pdf) |
|
147 //Section 10.2.10 Pg 131 - |
|
148 //"In case user has saved the image already or sent it by himself, |
|
149 // this option(save) is not available." |
|
150 /** |
|
151 * ReLoggingL - Relogs the messages to the file |
|
152 * @since series 60 v3.2 |
|
153 * @return void |
|
154 */ |
|
155 virtual void ReLoggingL() = 0; |
|
156 |
|
157 |
|
158 /** |
|
159 * Reset EngineLogger - Relogs the messages to the file |
|
160 * @since series 60 v3.2 |
|
161 * @return void |
|
162 */ |
|
163 virtual void ResetEngineLoggerL() = 0; |
|
164 |
|
165 public: |
|
166 |
|
167 /** |
|
168 * Destructor |
|
169 */ |
|
170 virtual ~MCARecordedChatsPC() {} |
|
171 }; |
|
172 |
|
173 #endif // __MCARECORDEDCHATSPC_H__ |
|
174 |
|
175 // End of File |