63
|
1 |
/*
|
|
2 |
* Copyright (c) 2002-2007 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: Composite contact view.
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
|
|
19 |
#ifndef CVPBKCOMPOSITECONTACTVIEW_H
|
|
20 |
#define CVPBKCOMPOSITECONTACTVIEW_H
|
|
21 |
|
|
22 |
// INCLUDE FILES
|
|
23 |
#include <e32base.h>
|
|
24 |
#include <MVPbkContactViewBase.h>
|
|
25 |
#include <MVPbkContactViewObserver.h>
|
|
26 |
#include <MVPbkContactViewFiltering.h>
|
|
27 |
#include <MVPbkContactViewBaseChildAccessExtension.h>
|
|
28 |
#include <VPbkContactView.hrh>
|
|
29 |
#include <CVPbkAsyncOperation.h>
|
|
30 |
#include "CVPbkEventArrayItem.h"
|
|
31 |
|
|
32 |
// FORWARD DECLARATIONS
|
|
33 |
class MVPbkContactViewSortPolicy;
|
|
34 |
class CVPbkEventArrayItem;
|
|
35 |
class MVPbkCompositeContactViewPolicy;
|
|
36 |
|
|
37 |
|
|
38 |
/**
|
|
39 |
* Virtual Phonebook abstract composite contact view.
|
|
40 |
* Composite contact views can be used to compose a view from
|
|
41 |
* multiple sub views.
|
|
42 |
*/
|
|
43 |
NONSHARABLE_CLASS(CVPbkCompositeContactView) :
|
|
44 |
public CBase,
|
|
45 |
public MVPbkContactViewBase,
|
|
46 |
public MVPbkContactViewObserver,
|
|
47 |
public MVPbkContactViewObserverExtension,
|
|
48 |
protected MVPbkContactViewFiltering,
|
|
49 |
public MVPbkContactViewBaseChildAccessExtension
|
|
50 |
{
|
|
51 |
public: // Constructors and destructor
|
|
52 |
/**
|
|
53 |
* Destructor.
|
|
54 |
*/
|
|
55 |
~CVPbkCompositeContactView();
|
|
56 |
|
|
57 |
public: // Interface
|
|
58 |
/**
|
|
59 |
* Adds subview to this composite view. Ownership is transferred
|
|
60 |
* if leave does not occur.
|
|
61 |
* NOTE: This composite view must already be an observer of aSubView
|
|
62 |
* when calling this function.
|
|
63 |
*
|
|
64 |
* @param aSubView Subview to add to this composite view.
|
|
65 |
* @param aViewId ViewId of added subview
|
|
66 |
*/
|
|
67 |
void AddSubViewL(
|
|
68 |
MVPbkContactViewBase* aSubView, TInt aViewId = KVPbkDefaultViewId);
|
|
69 |
|
|
70 |
/**
|
|
71 |
* ActualContactCountL returns the number of contact's in subviews.
|
|
72 |
* It might be that all subview events haven't
|
|
73 |
* arrived yet to this composite so ActualContactCountL is not always
|
|
74 |
* same as CompositeContactCountL
|
|
75 |
*
|
|
76 |
* @return the contact count calculated from subviews.
|
|
77 |
*/
|
|
78 |
TInt ActualContactCountL() const;
|
|
79 |
|
|
80 |
/**
|
|
81 |
* @return The number of contacts in iContactMapping
|
|
82 |
*/
|
|
83 |
inline TInt CompositeContactCountL() const;
|
|
84 |
|
|
85 |
/**
|
|
86 |
* If the parent of this view is also a composite view
|
|
87 |
* it calls this to configure this view as an internal view
|
|
88 |
* that has no external observers.
|
|
89 |
*/
|
|
90 |
void ApplyInternalCompositePolicyL();
|
|
91 |
|
|
92 |
void SetViewId(TInt aViewId);
|
|
93 |
|
|
94 |
private: // Abstract interface for composite implementations
|
|
95 |
/**
|
|
96 |
* Builds view mapping.
|
|
97 |
*/
|
|
98 |
virtual void DoBuildContactMappingL() = 0;
|
|
99 |
|
|
100 |
/**
|
|
101 |
* Handles contact addition to the view.
|
|
102 |
*
|
|
103 |
* @param aSubViewIndex Sub view index.
|
|
104 |
* @param aIndex Index of the contact in the sub view.
|
|
105 |
* @return Composite contact view index of the added contact.
|
|
106 |
*/
|
|
107 |
virtual TInt DoHandleContactAdditionL(
|
|
108 |
TInt aSubViewIndex,
|
|
109 |
TInt aIndex ) = 0;
|
|
110 |
|
|
111 |
public: // From MVPbkContactViewBase
|
|
112 |
TVPbkContactViewType Type() const;
|
|
113 |
void ChangeSortOrderL(
|
|
114 |
const MVPbkFieldTypeList& aSortOrder );
|
|
115 |
const MVPbkFieldTypeList& SortOrder() const;
|
|
116 |
void RefreshL();
|
|
117 |
TInt ContactCountL() const;
|
|
118 |
const MVPbkViewContact& ContactAtL(
|
|
119 |
TInt aIndex ) const;
|
|
120 |
MVPbkContactLink* CreateLinkLC(
|
|
121 |
TInt aIndex ) const;
|
|
122 |
TInt IndexOfLinkL(
|
|
123 |
const MVPbkContactLink& aContactLink ) const;
|
|
124 |
void AddObserverL(
|
|
125 |
MVPbkContactViewObserver& aObserver );
|
|
126 |
void RemoveObserver(
|
|
127 |
MVPbkContactViewObserver& aObserver );
|
|
128 |
TBool MatchContactStore(
|
|
129 |
const TDesC& aContactStoreUri ) const;
|
|
130 |
TBool MatchContactStoreDomain(
|
|
131 |
const TDesC& aContactStoreDomain ) const;
|
|
132 |
MVPbkContactBookmark* CreateBookmarkLC(
|
|
133 |
TInt aIndex ) const;
|
|
134 |
TInt IndexOfBookmarkL(
|
|
135 |
const MVPbkContactBookmark& aContactBookmark ) const;
|
|
136 |
MVPbkContactViewFiltering* ViewFiltering();
|
|
137 |
TAny* ContactViewBaseExtension(TUid aExtensionUid);
|
|
138 |
|
|
139 |
private: // From MVPbkContactViewObserver
|
|
140 |
void ContactViewReady(
|
|
141 |
MVPbkContactViewBase& aView );
|
|
142 |
void ContactViewUnavailable(
|
|
143 |
MVPbkContactViewBase& aView );
|
|
144 |
void ContactAddedToView(
|
|
145 |
MVPbkContactViewBase& aView,
|
|
146 |
TInt aIndex,
|
|
147 |
const MVPbkContactLink& aContactLink );
|
|
148 |
void ContactRemovedFromView(
|
|
149 |
MVPbkContactViewBase& aView,
|
|
150 |
TInt aIndex,
|
|
151 |
const MVPbkContactLink& aContactLink );
|
|
152 |
void ContactViewError(
|
|
153 |
MVPbkContactViewBase& aView,
|
|
154 |
TInt aError,
|
|
155 |
TBool aErrorNotified);
|
|
156 |
TAny* ContactViewObserverExtension( TUid aExtensionUid );
|
|
157 |
|
|
158 |
private: // From MVPbkContactViewObserverExtension
|
|
159 |
void FilteredContactRemovedFromView(
|
|
160 |
MVPbkContactViewBase& aView );
|
|
161 |
|
|
162 |
private: // From MVPbkContactViewFiltering
|
|
163 |
/// Composite implementations must implement this
|
|
164 |
virtual MVPbkContactViewBase* CreateFilteredViewLC(
|
|
165 |
MVPbkContactViewObserver& aObserver,
|
|
166 |
const MDesCArray& aFindWords,
|
|
167 |
const MVPbkContactBookmarkCollection* aAlwaysIncludedContacts ) = 0;
|
|
168 |
void UpdateFilterL(
|
|
169 |
const MDesCArray& aFindWords,
|
|
170 |
const MVPbkContactBookmarkCollection* aAlwaysIncludedContacts );
|
|
171 |
|
|
172 |
private: // From MVPbkContactViewBaseChildAccessExtension
|
|
173 |
TInt ChildViewCount() const;
|
|
174 |
MVPbkContactViewBase& ChildViewAt(TInt aIndex);
|
|
175 |
MVPbkContactViewBase* GetChildViewById(TInt aId);
|
|
176 |
TInt GetViewId();
|
|
177 |
|
|
178 |
protected: // Types
|
|
179 |
class CSubViewData;
|
|
180 |
|
|
181 |
/**
|
|
182 |
* Contact mapping structure. Mapping supports 128 subviews
|
|
183 |
* and over 8 million contacts per sub view.
|
|
184 |
*/
|
|
185 |
struct TContactMapping
|
|
186 |
{
|
|
187 |
/// Own: View index
|
|
188 |
TInt iViewIndex: 8;
|
|
189 |
/// Own: Contact index
|
|
190 |
TInt iContactIndex: 24;
|
|
191 |
};
|
|
192 |
|
|
193 |
protected: // Implementation
|
|
194 |
CVPbkCompositeContactView();
|
|
195 |
void BaseConstructL(
|
|
196 |
const MVPbkFieldTypeList& aSortOrder );
|
|
197 |
static TBool CompareMappings(
|
|
198 |
const TContactMapping& aLhs,
|
|
199 |
const TContactMapping& aRhs );
|
|
200 |
TBool IsCompositeReady() const;
|
|
201 |
/// Returns the composite's view policy.
|
|
202 |
MVPbkCompositeContactViewPolicy& CompositePolicy() const;
|
|
203 |
|
|
204 |
private: // Implementation
|
|
205 |
TInt FindSubViewIndex(MVPbkContactViewBase& aView) const;
|
|
206 |
TBool AllSubViewsKnown() const;
|
|
207 |
TBool AnySubViewReady() const;
|
|
208 |
void ResetContactMapping();
|
|
209 |
void RemoveContactMappingsFromView(MVPbkContactViewBase& aView);
|
|
210 |
void HandleContactViewReadyL( MVPbkContactViewBase& aView );
|
|
211 |
void HandleContactViewUnavailableL( MVPbkContactViewBase& aView );
|
|
212 |
TInt HandleContactRemoval(
|
|
213 |
MVPbkContactViewBase& aView,
|
|
214 |
TInt aIndex );
|
|
215 |
TInt HandleContactAddition(
|
|
216 |
MVPbkContactViewBase& aView,
|
|
217 |
TInt aIndex );
|
|
218 |
void DoAddObserverL(MVPbkContactViewObserver& aObserver);
|
|
219 |
void AddObserverError(
|
|
220 |
MVPbkContactViewObserver& aObserver,
|
|
221 |
TInt aError );
|
|
222 |
void SendViewReadyEvent();
|
|
223 |
void SendViewUnavailableEvent();
|
|
224 |
void SendViewErrorEvent( TInt aError, TBool aErrorNotified );
|
|
225 |
void UpdateSortOrderL();
|
|
226 |
|
|
227 |
protected: // Data
|
|
228 |
/// Own: Array of subviews
|
|
229 |
RPointerArray<CSubViewData> iSubViews;
|
|
230 |
/// Own: Array of contact mappings
|
|
231 |
RArray<TContactMapping> iContactMapping;
|
|
232 |
|
|
233 |
private: // Data
|
|
234 |
/// Ref: Async operation
|
|
235 |
VPbkEngUtils::CVPbkAsyncOperation iAsyncOperation;
|
|
236 |
/// Own: Sort order
|
|
237 |
MVPbkFieldTypeList* iSortOrder;
|
|
238 |
/// Own: Array of observers
|
|
239 |
RPointerArray<MVPbkContactViewObserver> iObservers;
|
|
240 |
/// Own: A policy for composite's internal functionality
|
|
241 |
MVPbkCompositeContactViewPolicy* iCompositePolicy;
|
|
242 |
/// Current view identifier
|
|
243 |
TInt iViewId;
|
|
244 |
};
|
|
245 |
|
|
246 |
inline TInt CVPbkCompositeContactView::CompositeContactCountL() const
|
|
247 |
{
|
|
248 |
return iContactMapping.Count();
|
|
249 |
}
|
|
250 |
|
|
251 |
/**
|
|
252 |
* Class to hold subview data.
|
|
253 |
*/
|
|
254 |
NONSHARABLE_CLASS( CVPbkCompositeContactView::CSubViewData ):
|
|
255 |
public CBase
|
|
256 |
{
|
|
257 |
public: // Types
|
|
258 |
/**
|
|
259 |
* View state enumeration.
|
|
260 |
*/
|
|
261 |
enum TViewState
|
|
262 |
{
|
|
263 |
ENotKnown,
|
|
264 |
EUnavailable,
|
|
265 |
EReady
|
|
266 |
};
|
|
267 |
|
|
268 |
public: // Constructors and destructor
|
|
269 |
/**
|
|
270 |
* Constructor.
|
|
271 |
*
|
|
272 |
* @param aState View state.
|
|
273 |
*/
|
|
274 |
CSubViewData(TViewState aState) : iState( aState ) {}
|
|
275 |
|
|
276 |
/**
|
|
277 |
* Destructor.
|
|
278 |
*/
|
|
279 |
~CSubViewData();
|
|
280 |
|
|
281 |
public: // Data
|
|
282 |
/// Ref: Contact view
|
|
283 |
MVPbkContactViewBase* iView;
|
|
284 |
/// Own: View state
|
|
285 |
TViewState iState;
|
|
286 |
/// Ref: Cursor pointer, used when merging
|
|
287 |
const MVPbkViewContact* iContactCursor;
|
|
288 |
/// Own: Cursor
|
|
289 |
TInt iCursor;
|
|
290 |
/// view identifier of iView member variable
|
|
291 |
TInt iViewId;
|
|
292 |
};
|
|
293 |
|
|
294 |
/**
|
|
295 |
* Internal interface for different behavior of exterior and interior
|
|
296 |
* composite views.
|
|
297 |
*/
|
|
298 |
NONSHARABLE_CLASS(MVPbkCompositeContactViewPolicy)
|
|
299 |
{
|
|
300 |
public:
|
|
301 |
/**
|
|
302 |
* Destructor
|
|
303 |
*/
|
|
304 |
virtual ~MVPbkCompositeContactViewPolicy() {}
|
|
305 |
|
|
306 |
/**
|
|
307 |
* Handles contact added & removed events.
|
|
308 |
*/
|
|
309 |
virtual void HandleViewEventsL(
|
|
310 |
CVPbkEventArrayItem::TViewEventType aEvent,
|
|
311 |
MVPbkContactViewBase& aSubview,
|
|
312 |
TInt aIndex, const
|
|
313 |
MVPbkContactLink& aContactLink ) = 0;
|
|
314 |
|
|
315 |
/**
|
|
316 |
* Reset policy if it has cached data.
|
|
317 |
*/
|
|
318 |
virtual void Reset() = 0;
|
|
319 |
|
|
320 |
/**
|
|
321 |
* Returns the contact count in composite or 0 if
|
|
322 |
* composite is not up to date with leaf views.
|
|
323 |
* @param aCompositeCount The count according to composite view.
|
|
324 |
* @return aCompositeCount or 0.
|
|
325 |
*/
|
|
326 |
virtual TInt ContactCountL() const = 0;
|
|
327 |
|
|
328 |
/**
|
|
329 |
* Returns ETrue if this is an internal composite policy
|
|
330 |
* @return ETrue if this is an internal composite policy
|
|
331 |
*/
|
|
332 |
virtual TBool InternalPolicy() const = 0;
|
|
333 |
};
|
|
334 |
|
|
335 |
/**
|
|
336 |
* An implementation for exterior composite view
|
|
337 |
*/
|
|
338 |
NONSHARABLE_CLASS(CVPbkExternalCompositeViewPolicy) :
|
|
339 |
public CBase,
|
|
340 |
public MVPbkCompositeContactViewPolicy
|
|
341 |
{
|
|
342 |
public: // Construction and destruction
|
|
343 |
static CVPbkExternalCompositeViewPolicy* NewL(
|
|
344 |
CVPbkCompositeContactView& aCompositeView,
|
|
345 |
RPointerArray<MVPbkContactViewObserver>& aObservers );
|
|
346 |
~CVPbkExternalCompositeViewPolicy();
|
|
347 |
|
|
348 |
private: // From MVPbkCompositeContactViewPolicy
|
|
349 |
void HandleViewEventsL(
|
|
350 |
CVPbkEventArrayItem::TViewEventType aEvent,
|
|
351 |
MVPbkContactViewBase& aSubview,
|
|
352 |
TInt aIndex, const
|
|
353 |
MVPbkContactLink& aContactLink );
|
|
354 |
void Reset();
|
|
355 |
TInt ContactCountL() const;
|
|
356 |
TBool InternalPolicy() const;
|
|
357 |
|
|
358 |
private: // Implementation
|
|
359 |
CVPbkExternalCompositeViewPolicy(
|
|
360 |
CVPbkCompositeContactView& aCompositeView,
|
|
361 |
RPointerArray<MVPbkContactViewObserver>& aObservers );
|
|
362 |
|
|
363 |
private: // Data
|
|
364 |
/// Ref: The parent of this policy
|
|
365 |
CVPbkCompositeContactView& iCompositeView;
|
|
366 |
/// Ref: Array of observers
|
|
367 |
RPointerArray<MVPbkContactViewObserver>& iObservers;
|
|
368 |
/// Own: Event array for 'Contact added or removed' events
|
|
369 |
RPointerArray<CVPbkEventArrayItem> iEventArray;
|
|
370 |
};
|
|
371 |
|
|
372 |
/**
|
|
373 |
* An implementation for interior composite view
|
|
374 |
*/
|
|
375 |
NONSHARABLE_CLASS(CVPbkInternalCompositeViewPolicy) :
|
|
376 |
public CBase,
|
|
377 |
public MVPbkCompositeContactViewPolicy
|
|
378 |
{
|
|
379 |
public: // Construction and destruction
|
|
380 |
static CVPbkInternalCompositeViewPolicy* NewL(
|
|
381 |
CVPbkCompositeContactView& aCompositeView,
|
|
382 |
RPointerArray<MVPbkContactViewObserver>& aObservers );
|
|
383 |
|
|
384 |
private: // From MVPbkCompositeContactViewPolicy
|
|
385 |
void HandleViewEventsL(
|
|
386 |
CVPbkEventArrayItem::TViewEventType aEvent,
|
|
387 |
MVPbkContactViewBase& aSubview,
|
|
388 |
TInt aIndex, const
|
|
389 |
MVPbkContactLink& aContactLink );
|
|
390 |
void Reset();
|
|
391 |
TInt ContactCountL() const;
|
|
392 |
TBool InternalPolicy() const;
|
|
393 |
|
|
394 |
private: // Implementation
|
|
395 |
CVPbkInternalCompositeViewPolicy(
|
|
396 |
CVPbkCompositeContactView& aCompositeView,
|
|
397 |
RPointerArray<MVPbkContactViewObserver>& aObservers );
|
|
398 |
|
|
399 |
private: // Data
|
|
400 |
/// Ref: The parent of this policy
|
|
401 |
CVPbkCompositeContactView& iCompositeView;
|
|
402 |
/// Ref: Array of observers
|
|
403 |
RPointerArray<MVPbkContactViewObserver>& iObservers;
|
|
404 |
};
|
|
405 |
|
|
406 |
#endif // CVPBKCOMPOSITECONTACTVIEW_H
|
|
407 |
|
|
408 |
// End of File
|