author | Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> |
Wed, 13 Oct 2010 14:31:22 +0300 | |
branch | RCL_3 |
changeset 81 | c26cc2a7c548 |
parent 62 | 5266b1f337bd |
permissions | -rw-r--r-- |
62 | 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: Interface for phonebook services. |
|
15 |
* |
|
16 |
*/ |
|
17 |
||
18 |
||
19 |
#ifndef MPHCNTCONTACTMANAGER_H |
|
20 |
#define MPHCNTCONTACTMANAGER_H |
|
21 |
||
22 |
#include <cntdef.h> |
|
23 |
#include <VPbkContactView.hrh> |
|
24 |
||
25 |
class MVPbkContactLink; |
|
26 |
class MVPbkSingleContactOperationObserver; |
|
27 |
class MVPbkContactOperationBase; |
|
28 |
class MVPbkContactStoreList; |
|
29 |
class MVPbkContactFindObserver; |
|
30 |
class MPhCntContactMatchStrategy; |
|
31 |
class MPbk2ContactNameFormatter; |
|
32 |
class CVPbkContactIdConverter; |
|
33 |
class MVPbkContactLinkArray; |
|
34 |
class MVPbkContactFindObserver; |
|
35 |
class MPbk2ImageOperation; |
|
36 |
class MPbk2ImageGetObserver; |
|
37 |
class MVPbkFieldType; |
|
38 |
class MVPbkStoreContact; |
|
39 |
class MVPbkStoreContactField; |
|
40 |
class CVPbkFieldTypeSelector; |
|
41 |
class MPhCntStoreLoaderObserver; |
|
42 |
class CPhCntContactStoreUris; |
|
43 |
||
44 |
/** |
|
45 |
* Interface for phonebook services. |
|
46 |
* |
|
47 |
* @since S60 v3.1 |
|
48 |
* @lib PhoneCntFinder.lib |
|
49 |
*/ |
|
50 |
NONSHARABLE_CLASS( MPhCntContactManager ) |
|
51 |
{ |
|
52 |
public: |
|
53 |
||
54 |
enum TDuplicateRemovalStrategy { |
|
55 |
ERemoveDuplicates, |
|
56 |
EDontRemoveDuplicates |
|
81
c26cc2a7c548
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
62
diff
changeset
|
57 |
}; |
62 | 58 |
|
59 |
/** |
|
60 |
* Retrieves contact from phonebook. |
|
61 |
* |
|
62 |
* @since S60 v3.1 |
|
63 |
* @param aLink Link to the contact. |
|
64 |
* @param aObserver Observer for the retrieval. |
|
65 |
* @return Handle to the retrieval operation. |
|
66 |
*/ |
|
67 |
virtual MVPbkContactOperationBase* RetrieveContactL( |
|
68 |
const MVPbkContactLink& aLink, |
|
69 |
MVPbkSingleContactOperationObserver& aObserver) = 0; |
|
70 |
||
71 |
/** |
|
72 |
* Gives the list of contact stores. |
|
73 |
* |
|
74 |
* @since S60 v3.1 |
|
75 |
* @return List of contact stores. |
|
76 |
*/ |
|
77 |
virtual MVPbkContactStoreList& ContactStoresL() const = 0; |
|
78 |
||
79 |
/** |
|
80 |
* Factory method for creating contact match strategy. |
|
81 |
* |
|
82 |
* @since S60 v3.1 |
|
83 |
* @param aObserver Contact match strategy observer. |
|
81
c26cc2a7c548
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
62
diff
changeset
|
84 |
* @param aRemoveDuplicatesStrategy Contact dupe removal strategy |
c26cc2a7c548
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
62
diff
changeset
|
85 |
* |
62 | 86 |
* @return New contact match strategy instance. |
87 |
*/ |
|
88 |
virtual MPhCntContactMatchStrategy* CreateContactMatchStrategyL( |
|
89 |
MVPbkContactFindObserver& aObserver, |
|
81
c26cc2a7c548
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
62
diff
changeset
|
90 |
TDuplicateRemovalStrategy aRemoveDuplicatesStrategy )= 0; |
62 | 91 |
|
92 |
/** |
|
93 |
* Gives access to contact name formatter. |
|
94 |
* |
|
95 |
* @since S60 v3.1 |
|
96 |
* @return Contact name formatter. |
|
97 |
*/ |
|
98 |
virtual MPbk2ContactNameFormatter& ContactNameFormatter() = 0; |
|
99 |
||
100 |
/** |
|
101 |
* Converts contact ids to contact links. |
|
102 |
* |
|
103 |
* @since S60 v3.1 |
|
104 |
* @param aContactId Array of contact ids. |
|
105 |
* @return Array of contact links. Ownership given. |
|
106 |
*/ |
|
107 |
virtual MVPbkContactLinkArray* ConvertContactIdsToLinksL( |
|
108 |
const CArrayFix<TContactItemId>& aContactId ) const = 0; |
|
109 |
||
110 |
/** |
|
111 |
* Converts contact id to contact link. |
|
112 |
* |
|
113 |
* @since S60 v3.1 |
|
114 |
* @param aContactId Contact id from Contact DB. |
|
115 |
* @return Concact link, ownership is given to caller. |
|
116 |
* If the aContactId is KNullContactId then then returned value is NULL. |
|
117 |
*/ |
|
118 |
virtual MVPbkContactLink* ConvertContactIdToLinkL( |
|
119 |
TContactItemId aContactId ) const = 0; |
|
120 |
||
121 |
/** |
|
122 |
* Converts contact link to contact id. |
|
123 |
* |
|
124 |
* @since S60 v3.1 |
|
125 |
* @param aContactLink Reference to contactlink. |
|
126 |
* @return Contact id. |
|
127 |
*/ |
|
128 |
virtual TContactItemId ConvertContactLinkToContactId( |
|
129 |
const MVPbkContactLink& aContactLink ) const = 0; |
|
130 |
||
131 |
/** |
|
132 |
* Converts packed link descriptor to contact link. |
|
133 |
* |
|
134 |
* @since S60 v3.2 |
|
135 |
* @param aPackeLink Link prepresented as desctiptor. |
|
136 |
* @return Contact link. Returns null if aPackedLink length is 0. |
|
137 |
*/ |
|
138 |
virtual MVPbkContactLink* ConvertDescriptorToLinkL( |
|
139 |
const TDesC8& aPackedLink ) const = 0; |
|
140 |
||
141 |
/** |
|
142 |
* Retrieves contact, which has been assinged to speeddial position |
|
143 |
* aSpeedDialPosition. |
|
144 |
* |
|
145 |
* @since S60 v3.1 |
|
146 |
* @param aSpeedDialPosition Speed dial position. |
|
147 |
* @param aObserver Observer for operation. |
|
148 |
* @return Operation, ownership is given to caller. |
|
149 |
*/ |
|
150 |
virtual MVPbkContactOperationBase* RetrieveSpeedDialContactLinkL( |
|
151 |
const TInt aSpeedDialPosition, |
|
152 |
MVPbkContactFindObserver& aObserver ) = 0; |
|
153 |
||
154 |
/** |
|
155 |
* Indicates whether the speed dial attribute has been set for the given position. |
|
156 |
* |
|
157 |
* @since S60 v3.2 |
|
158 |
* @see MPhCntContactManager. |
|
159 |
* @param aSpeedDialPosition Speed dial position. |
|
160 |
* @param aField Field to be evaluated. |
|
161 |
* @return ETrue if aField has a matching speed dial position, |
|
162 |
* EFalse otherwise. |
|
163 |
*/ |
|
164 |
virtual TBool HasSpeedDialL( |
|
165 |
const TInt aSpeedDialPosition, |
|
166 |
const MVPbkStoreContactField& aField ) = 0; |
|
167 |
||
168 |
/** |
|
169 |
* Retrieves contacts image. To cancel the thumbnail |
|
170 |
* fetch, delete operation. |
|
171 |
* |
|
172 |
* @since S60 v3.1 |
|
173 |
* @param aContact Contact, which image is fetched. |
|
174 |
* @param aFieldType Field type. |
|
175 |
* @param aObserver Observer of the fetch. |
|
176 |
*/ |
|
177 |
virtual MPbk2ImageOperation* RetrieveImageL( |
|
178 |
MVPbkStoreContact& aStoreContact, |
|
179 |
const MVPbkFieldType& aFieldType, |
|
180 |
MPbk2ImageGetObserver& aObserver ) = 0; |
|
181 |
||
182 |
/** |
|
183 |
* Creates field type selector. |
|
184 |
* |
|
185 |
* @since S60 v3.2 |
|
186 |
*/ |
|
187 |
virtual CVPbkFieldTypeSelector* CreateFieldTypeSelectorL() const = 0; |
|
188 |
||
189 |
/** |
|
190 |
* Appends filter to selector. |
|
191 |
* |
|
192 |
* @since S60 v3.2 |
|
193 |
* @param aSelector Selector to append the filter. |
|
194 |
* @param aFilter The filter to be appended. |
|
195 |
*/ |
|
196 |
virtual void AppendFilterToSelectorL( CVPbkFieldTypeSelector& aSelector, |
|
197 |
TVPbkContactViewFilter aFilter ) = 0; |
|
198 |
||
199 |
/** |
|
200 |
* Loads the store specified in the contact link and adds the store to |
|
201 |
* the list of stores handled by this manager. |
|
202 |
* |
|
203 |
* @since S60 v9.1 |
|
204 |
* @param aContactLink A contact link containing store to load. |
|
205 |
* @param aObserver An observer for the loading process. |
|
206 |
*/ |
|
207 |
virtual void LoadContactStoreL( const TDesC8& aContactLink, |
|
208 |
MPhCntStoreLoaderObserver& aObserver ) = 0; |
|
209 |
||
210 |
/** |
|
211 |
* Loads the store specified by the URI and adds the store to |
|
212 |
* the list of stores handled by this manager. |
|
213 |
* |
|
214 |
* @since S60 v9.1 |
|
215 |
* @param aStoreUri A URI of the store to load. |
|
216 |
* @param aObserver An observer for the loading process. |
|
217 |
*/ |
|
218 |
virtual void LoadContactStoreWithUriL( |
|
219 |
const TDesC& aStoreUri, |
|
220 |
MPhCntStoreLoaderObserver& aObserver ) = 0; |
|
221 |
||
222 |
/** |
|
223 |
* Return contact store uri's. |
|
224 |
* |
|
225 |
* @since S60 v9.1 |
|
226 |
*/ |
|
227 |
virtual CPhCntContactStoreUris& ContactStoreUrisL() = 0; |
|
228 |
||
229 |
protected: |
|
230 |
||
231 |
MPhCntContactManager(){}; |
|
232 |
||
233 |
virtual ~MPhCntContactManager() {}; |
|
234 |
}; |
|
235 |
||
236 |
#endif |