|
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: Recorded chats Array PC interface for recorded chats view |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 #ifndef MCARECORDEDCHATSARRAYPC_H__ |
|
21 #define MCARECORDEDCHATSARRAYPC_H__ |
|
22 |
|
23 // INCLUDES |
|
24 #include <e32base.h> |
|
25 #include "TEnumsPC.h" |
|
26 |
|
27 class MCARecordedChatsArrayPC |
|
28 { |
|
29 public: |
|
30 /** |
|
31 * To intialize the recorded chats array PC |
|
32 * The string loader class is used to load the defined strings |
|
33 * This requires the construction of CCAAppUi to be complete. |
|
34 * The Recorded chats array PC gets constructed before the completion of |
|
35 * app ui. Hence we call this FinalizeRecChatsArrayPCConstructionL() |
|
36 * method from the FinalizeChatConstruction method of CCAAppUI! |
|
37 */ |
|
38 virtual void FinalizeRecChatsArrayPCConstructionL() = 0; |
|
39 |
|
40 /** |
|
41 * To return to the item at the specified index in the array |
|
42 * @param aIndex: The index of item in the array |
|
43 * @return TPtrC: pointer to the item at aIndex |
|
44 */ |
|
45 virtual TPtrC16 MdcaPoint( TInt aIndex ) const = 0; |
|
46 |
|
47 /** |
|
48 * To return to the total number of items in the array |
|
49 * @return integer: count of items in the array |
|
50 */ |
|
51 virtual TInt MdcaCount( ) const = 0; |
|
52 |
|
53 /** |
|
54 * To Get the current index of an item in the array |
|
55 * @return integer: current index |
|
56 */ |
|
57 virtual TInt GetCurrentItemIndex() const = 0; |
|
58 |
|
59 /** |
|
60 * To set the current index of an item in the array |
|
61 * @param aCurIndex : integer - current index |
|
62 */ |
|
63 virtual void SetCurrentItemIndex( TInt aCurIndex ) = 0; |
|
64 |
|
65 /** |
|
66 * Set the next index of the current index of an array |
|
67 * @param aCurIndex : integer value which is the current index |
|
68 */ |
|
69 virtual void SetNextIndex( TInt aCurIndex ) = 0; |
|
70 |
|
71 /** |
|
72 * Get the next index of the current index of an array |
|
73 * @return integer: index |
|
74 */ |
|
75 virtual TInt GetNextIndex() const = 0; |
|
76 |
|
77 /** |
|
78 * Get progress count of given index of an array |
|
79 * @return integer count to be set |
|
80 */ |
|
81 virtual TInt GetProgressCount() const = 0; |
|
82 |
|
83 /** |
|
84 * Set progress count of given index of an array |
|
85 * @param aProgressCount: integer count to be set |
|
86 */ |
|
87 virtual void SetProgressCount( TInt aProgressCount ) = 0; |
|
88 |
|
89 /** |
|
90 * Returns name of recorded chat |
|
91 * @param aIndex is index of recorded chat |
|
92 * @return Reference to name of recorded chat |
|
93 */ |
|
94 virtual const TDesC& Name( TInt aIndex ) const = 0; |
|
95 |
|
96 /** |
|
97 * Returns the type of the chat data. |
|
98 * @param aIndex is the index to the header array. |
|
99 * @return Message type. |
|
100 */ |
|
101 virtual TEnumsPC::TChatType ChatType( TInt aIndex ) const = 0; |
|
102 |
|
103 /** |
|
104 * Returns time when history save started. |
|
105 * @param aIndex is the index to the header array. |
|
106 * @return Start time |
|
107 */ |
|
108 virtual TTime StartTime( TInt aIndex ) const = 0; |
|
109 |
|
110 /** |
|
111 * Returns time when history save ended. |
|
112 * @param aIndex is the header index. |
|
113 * @return End time. |
|
114 */ |
|
115 virtual TTime EndTime( TInt aIndex ) const = 0; |
|
116 |
|
117 /** |
|
118 * Returns identification information of history data |
|
119 * @param aIndex is the header index |
|
120 * @return Identication information of history data. |
|
121 */ |
|
122 virtual const TDesC& Identification( TInt aIndex ) const = 0; |
|
123 |
|
124 /* |
|
125 * Return the formatted time of saved conversation |
|
126 * @return pointer to the time |
|
127 */ |
|
128 virtual TPtr GetDateFormat() = 0 ; |
|
129 |
|
130 /* |
|
131 * Return the formatted start time of saved conversation |
|
132 * @return pointer to the time |
|
133 */ |
|
134 virtual TPtr GetStartDateFormat() = 0; |
|
135 |
|
136 /* |
|
137 * Return the formatted end time of saved conversation |
|
138 * @return pointer to the time |
|
139 */ |
|
140 virtual TPtr GetEndDateFormat() = 0; |
|
141 |
|
142 /* |
|
143 * Return the time of saved conversation |
|
144 * @return pointer to the time |
|
145 */ |
|
146 virtual TPtr Time() const = 0; |
|
147 |
|
148 /** |
|
149 * Recorded chat index by name. |
|
150 * @since series 60 v3.2 |
|
151 * @param aName Name of recorded chat. |
|
152 * @return Index of chat or KErrNotFound if |
|
153 * it was not found. |
|
154 */ |
|
155 virtual TInt Index( const TDesC& aName ) const = 0; |
|
156 |
|
157 public: |
|
158 virtual ~MCARecordedChatsArrayPC() |
|
159 { |
|
160 |
|
161 }; |
|
162 }; |
|
163 |
|
164 #endif // MCARECORDEDCHATSARRAYPC_H__ |
|
165 |
|
166 // End of File |