phonebookengines/VirtualPhonebook/VPbkCntModel/src/CCustomFilteredContactView.cpp
branchRCL_3
changeset 63 f4a778e096c2
child 64 c1e8ba0c2b16
equal deleted inserted replaced
62:5b6f26637ad3 63:f4a778e096c2
       
     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:  Contacts Model store custom filtered contact
       
    15 *                view implementation. Derives from MVPbkContactViewBase,
       
    16 *                performs the custom filtering.
       
    17 *
       
    18 */
       
    19 
       
    20 
       
    21 #include "CCustomFilteredContactView.h"
       
    22 
       
    23 // VPbkCntModel
       
    24 #include "CContactStore.h"
       
    25 #include "CContact.h"
       
    26 #include "CCustomFilteredNativeContactView.h"
       
    27 
       
    28 // VPbkEng
       
    29 #include <MVPbkFieldTypeSelector.h>
       
    30 #include <CVPbkFilteredContactView.h>
       
    31 #include <MVPbkContactSelector.h>
       
    32 
       
    33 
       
    34 namespace VPbkCntModel {
       
    35 
       
    36 // --------------------------------------------------------------------------
       
    37 // CCustomFilteredContactView::CCustomFilteredContactView
       
    38 // --------------------------------------------------------------------------
       
    39 //
       
    40 CCustomFilteredContactView::CCustomFilteredContactView
       
    41           ( CContactStore& aContactStore,
       
    42             const MVPbkFieldTypeSelector* aFieldTypeSelector,
       
    43             MCustomContactViewObserver& aCustomContactViewObserver,
       
    44             MVPbkContactSelector* aContactSelector ) :
       
    45                 CViewBase( aContactStore ),
       
    46                 iContactStore( aContactStore ),
       
    47                 iFieldTypeSelector( aFieldTypeSelector ),
       
    48                 iCustomContactViewObserver( aCustomContactViewObserver ),
       
    49                 iContactSelector( aContactSelector )
       
    50     {
       
    51     }
       
    52 
       
    53 // --------------------------------------------------------------------------
       
    54 // CCustomFilteredContactView::ConstructL
       
    55 // --------------------------------------------------------------------------
       
    56 //
       
    57 void CCustomFilteredContactView::ConstructL(
       
    58         const CVPbkContactViewDefinition& aViewDefinition,
       
    59         MVPbkContactViewObserver& aViewObserver,                
       
    60         const MVPbkFieldTypeList& aSortOrder,
       
    61         CContactViewBase& aNativeViewBase)
       
    62     {
       
    63     // iView should be assign first because is used by base class during the 
       
    64     // construction.
       
    65     iView = &aNativeViewBase;
       
    66     ConstructL( aViewDefinition, aViewObserver, aSortOrder );
       
    67     // Set the customically filtered view parameters
       
    68     iCustomFilteredContactView->SetNativeBaseView( aNativeViewBase );
       
    69     }
       
    70 
       
    71 // --------------------------------------------------------------------------
       
    72 // CCustomFilteredContactView::SetFieldTypeSelector
       
    73 // --------------------------------------------------------------------------
       
    74 //
       
    75 void CCustomFilteredContactView::SetFieldTypeSelector( 
       
    76         const MVPbkFieldTypeSelector* aFieldTypeSelector )
       
    77     {
       
    78     iFieldTypeSelector = aFieldTypeSelector;
       
    79     }
       
    80 
       
    81 
       
    82 // --------------------------------------------------------------------------
       
    83 // CCustomFilteredContactView::~CCustomFilteredContactView
       
    84 // --------------------------------------------------------------------------
       
    85 //
       
    86 CCustomFilteredContactView::~CCustomFilteredContactView()
       
    87     {
       
    88     delete iCustomFilteredContactView;
       
    89     delete iFilteredView;
       
    90     }
       
    91 
       
    92 // --------------------------------------------------------------------------
       
    93 // CCustomFilteredContactView::ConstructL
       
    94 // --------------------------------------------------------------------------
       
    95 //
       
    96 void CCustomFilteredContactView::ConstructL( 
       
    97         const CVPbkContactViewDefinition& aViewDefinition,
       
    98         MVPbkContactViewObserver& aObserver,
       
    99         const MVPbkFieldTypeList& aSortOrder )
       
   100     {
       
   101     // Base construct has to be done first
       
   102     CViewBase::ConstructL( aViewDefinition, aSortOrder );
       
   103 
       
   104     // Construct the custom filtered native view
       
   105     iCustomFilteredContactView = CCustomFilteredNativeContactView::NewL
       
   106         ( iContactStore );
       
   107 
       
   108     // This object is the base view and contact selector
       
   109     // for the Virtual Phonebook filtered view. The base view calls
       
   110     // are handled by CViewBase.
       
   111     // The selector logic is implemented here in this class.
       
   112     iFilteredView = CVPbkFilteredContactView::NewL
       
   113         ( *this, aObserver, *this );
       
   114     iCustomFilteredContactView->SetCustomFilterView( *iFilteredView );
       
   115     }
       
   116     
       
   117 // --------------------------------------------------------------------------
       
   118 // CCustomFilteredContactView::ContactViewBase
       
   119 // --------------------------------------------------------------------------
       
   120 //
       
   121 CContactViewBase& CCustomFilteredContactView::ContactViewBase()
       
   122     {
       
   123     return *iCustomFilteredContactView;
       
   124     }
       
   125 
       
   126 // --------------------------------------------------------------------------
       
   127 // CCustomFilteredContactView::Type
       
   128 // --------------------------------------------------------------------------
       
   129 //
       
   130 TVPbkContactViewType CCustomFilteredContactView::Type() const
       
   131     {
       
   132     return EVPbkContactsView;
       
   133     }
       
   134 
       
   135 // --------------------------------------------------------------------------
       
   136 // CCustomFilteredContactView::DoInitializeViewL
       
   137 // --------------------------------------------------------------------------
       
   138 //
       
   139 void CCustomFilteredContactView::DoInitializeViewL( 
       
   140         const CVPbkContactViewDefinition& /*aViewDefinition*/,
       
   141         RContactViewSortOrder& /*aViewSortOrder*/ )
       
   142     {
       
   143     // Required view initialization is already done
       
   144     }
       
   145 
       
   146 // --------------------------------------------------------------------------
       
   147 // CCustomFilteredContactView::DoTeardownView
       
   148 // --------------------------------------------------------------------------
       
   149 //
       
   150 void CCustomFilteredContactView::DoTeardownView()
       
   151     {
       
   152     /// Do nothing
       
   153     }
       
   154 
       
   155 // --------------------------------------------------------------------------
       
   156 // CCustomFilteredContactView::DoChangeSortOrderL
       
   157 // --------------------------------------------------------------------------
       
   158 //
       
   159 TBool CCustomFilteredContactView::DoChangeSortOrderL( 
       
   160         const CVPbkContactViewDefinition& /*aViewDefinition*/,
       
   161         RContactViewSortOrder& /*aSortOrder*/ )
       
   162     {
       
   163     // Sort order not changed.
       
   164     return EFalse;
       
   165     }
       
   166 
       
   167 // --------------------------------------------------------------------------
       
   168 // CCustomFilteredContactView::IsContactIncluded
       
   169 // --------------------------------------------------------------------------
       
   170 //
       
   171 TBool CCustomFilteredContactView::IsContactIncluded
       
   172         ( const MVPbkBaseContact& aContact )
       
   173     {
       
   174     TBool ret = EFalse;
       
   175 
       
   176     // In case of an error, ignore it.
       
   177     // The contact will then not be included in the view
       
   178     TRAP_IGNORE(
       
   179         ret = IsContactIncludedL( aContact )
       
   180         );
       
   181 
       
   182     return ret;
       
   183     }
       
   184 
       
   185 // --------------------------------------------------------------------------
       
   186 // CCustomFilteredContactView::ContactSelectorExtension
       
   187 // --------------------------------------------------------------------------
       
   188 //
       
   189 TAny* CCustomFilteredContactView::ContactSelectorExtension( TUid aExtensionUid )
       
   190     {
       
   191     if( iContactSelector )
       
   192         {
       
   193         return iContactSelector->ContactSelectorExtension( aExtensionUid );
       
   194         }
       
   195     return NULL;
       
   196     }
       
   197 
       
   198 // --------------------------------------------------------------------------
       
   199 // CCustomFilteredContactView::HandleContactViewEvent
       
   200 // --------------------------------------------------------------------------
       
   201 //
       
   202 void CCustomFilteredContactView::HandleContactViewEvent
       
   203         ( const CContactViewBase& aView,
       
   204           const TContactViewEvent& aEvent )
       
   205     {
       
   206     // Notify the custom view observer first
       
   207     iCustomContactViewObserver.HandleCustomContactViewEvent( aView, aEvent );
       
   208     CViewBase::HandleContactViewEvent( aView, aEvent );
       
   209     }
       
   210 
       
   211 
       
   212 inline TBool CCustomFilteredContactView::IsContactIncludedL
       
   213         ( const MVPbkBaseContact& aContact )
       
   214     {
       
   215     TBool fieldSelectorAccepted = ETrue;
       
   216     TBool contactSelectorAccepted = ETrue;
       
   217     if ( iFieldTypeSelector )
       
   218         {
       
   219         fieldSelectorAccepted = IsContactIncludedByFieldSelectorL( aContact );
       
   220         }
       
   221     if ( iContactSelector )
       
   222         {
       
   223         contactSelectorAccepted = iContactSelector->IsContactIncluded( aContact );
       
   224         }
       
   225     // The contact is included if neither selector returns false.
       
   226     return fieldSelectorAccepted && contactSelectorAccepted;
       
   227     }
       
   228 
       
   229 inline TBool CCustomFilteredContactView::IsContactIncludedByFieldSelectorL
       
   230         ( const MVPbkBaseContact& aContact )
       
   231     {
       
   232     TBool ret = EFalse;
       
   233 
       
   234     // First we have to get the contact id
       
   235     const CViewContact& viewContact =
       
   236         static_cast<const CViewContact&>( aContact );
       
   237     TContactItemId id = viewContact.Id();
       
   238 
       
   239     // Then we have to load the native store contact
       
   240     CContactItem* item = iContactStore.NativeDatabase().ReadContactLC( id );
       
   241     // Make a VPbk store contact out of it
       
   242     CContact* contact = CContact::NewL( iContactStore, item );
       
   243     CleanupStack::Pop( item ); // ownership was taken away
       
   244     CleanupStack::PushL( contact );
       
   245 
       
   246     MVPbkStoreContactFieldCollection& fields = contact->Fields();
       
   247     TInt fieldCount = fields.FieldCount();
       
   248 
       
   249     for ( TInt i = 0; i < fieldCount; ++i )
       
   250         {
       
   251         const MVPbkStoreContactField& field = fields.FieldAt( i );
       
   252         const MVPbkFieldType* fieldType = field.BestMatchingFieldType();
       
   253         if ( fieldType && iFieldTypeSelector->IsFieldTypeIncluded( *fieldType ) )
       
   254             {
       
   255             ret = ETrue;
       
   256             break;
       
   257             }
       
   258         }
       
   259 
       
   260     CleanupStack::PopAndDestroy( contact );
       
   261 
       
   262     return ret;
       
   263     }
       
   264 
       
   265 } // namespace VPbkCntModel
       
   266 
       
   267 // End of File