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::~CCustomFilteredContactView

    73 // --------------------------------------------------------------------------

    74 //

    75 CCustomFilteredContactView::~CCustomFilteredContactView()

    76     {

    77     delete iCustomFilteredContactView;

    78     delete iFilteredView;

    79     }

    80 

    81 // --------------------------------------------------------------------------

    82 // CCustomFilteredContactView::ConstructL

    83 // --------------------------------------------------------------------------

    84 //

    85 void CCustomFilteredContactView::ConstructL( 

    86         const CVPbkContactViewDefinition& aViewDefinition,

    87         MVPbkContactViewObserver& aObserver,

    88         const MVPbkFieldTypeList& aSortOrder )

    89     {

    90     // Base construct has to be done first

    91     CViewBase::ConstructL( aViewDefinition, aSortOrder );

    92 

    93     // Construct the custom filtered native view

    94     iCustomFilteredContactView = CCustomFilteredNativeContactView::NewL

    95         ( iContactStore );

    96 

    97     // This object is the base view and contact selector

    98     // for the Virtual Phonebook filtered view. The base view calls

    99     // are handled by CViewBase.

   100     // The selector logic is implemented here in this class.

   101     iFilteredView = CVPbkFilteredContactView::NewL

   102         ( *this, aObserver, *this );

   103     iCustomFilteredContactView->SetCustomFilterView( *iFilteredView );

   104     }

   105     

   106 // --------------------------------------------------------------------------

   107 // CCustomFilteredContactView::ContactViewBase

   108 // --------------------------------------------------------------------------

   109 //

   110 CContactViewBase& CCustomFilteredContactView::ContactViewBase()

   111     {

   112     return *iCustomFilteredContactView;

   113     }

   114 

   115 // --------------------------------------------------------------------------

   116 // CCustomFilteredContactView::Type

   117 // --------------------------------------------------------------------------

   118 //

   119 TVPbkContactViewType CCustomFilteredContactView::Type() const

   120     {

   121     return EVPbkContactsView;

   122     }

   123 

   124 // --------------------------------------------------------------------------

   125 // CCustomFilteredContactView::DoInitializeViewL

   126 // --------------------------------------------------------------------------

   127 //

   128 void CCustomFilteredContactView::DoInitializeViewL( 

   129         const CVPbkContactViewDefinition& /*aViewDefinition*/,

   130         RContactViewSortOrder& /*aViewSortOrder*/ )

   131     {

   132     // Required view initialization is already done

   133     }

   134 

   135 // --------------------------------------------------------------------------

   136 // CCustomFilteredContactView::DoTeardownView

   137 // --------------------------------------------------------------------------

   138 //

   139 void CCustomFilteredContactView::DoTeardownView()

   140     {

   141     /// Do nothing

   142     }

   143 

   144 // --------------------------------------------------------------------------

   145 // CCustomFilteredContactView::DoChangeSortOrderL

   146 // --------------------------------------------------------------------------

   147 //

   148 TBool CCustomFilteredContactView::DoChangeSortOrderL( 

   149         const CVPbkContactViewDefinition& /*aViewDefinition*/,

   150         RContactViewSortOrder& /*aSortOrder*/ )

   151     {

   152     // Sort order not changed.

   153     return EFalse;

   154     }

   155 

   156 // --------------------------------------------------------------------------

   157 // CCustomFilteredContactView::IsContactIncluded

   158 // --------------------------------------------------------------------------

   159 //

   160 TBool CCustomFilteredContactView::IsContactIncluded

   161         ( const MVPbkBaseContact& aContact )

   162     {

   163     TBool ret = EFalse;

   164 

   165     // In case of an error, ignore it.

   166     // The contact will then not be included in the view

   167     TRAP_IGNORE(

   168         ret = IsContactIncludedL( aContact )

   169         );

   170 

   171     return ret;

   172     }

   173 

   174 // --------------------------------------------------------------------------

   175 // CCustomFilteredContactView::HandleContactViewEvent

   176 // --------------------------------------------------------------------------

   177 //

   178 void CCustomFilteredContactView::HandleContactViewEvent

   179         ( const CContactViewBase& aView,

   180           const TContactViewEvent& aEvent )

   181     {

   182     // Notify the custom view observer first

   183     iCustomContactViewObserver.HandleCustomContactViewEvent( aView, aEvent );

   184     CViewBase::HandleContactViewEvent( aView, aEvent );

   185     }

   186 

   187 

   188 inline TBool CCustomFilteredContactView::IsContactIncludedL

   189         ( const MVPbkBaseContact& aContact )

   190     {

   191     TBool fieldSelectorAccepted = ETrue;

   192     TBool contactSelectorAccepted = ETrue;

   193     if ( iFieldTypeSelector )

   194         {

   195         fieldSelectorAccepted = IsContactIncludedByFieldSelectorL( aContact );

   196         }

   197     if ( iContactSelector )

   198         {

   199         contactSelectorAccepted = iContactSelector->IsContactIncluded( aContact );

   200         }

   201     // The contact is included if neither selector returns false.

   202     return fieldSelectorAccepted && contactSelectorAccepted;

   203     }

   204 

   205 inline TBool CCustomFilteredContactView::IsContactIncludedByFieldSelectorL

   206         ( const MVPbkBaseContact& aContact )

   207     {

   208     TBool ret = EFalse;

   209 

   210     // First we have to get the contact id

   211     const CViewContact& viewContact =

   212         static_cast<const CViewContact&>( aContact );

   213     TContactItemId id = viewContact.Id();

   214 

   215     // Then we have to load the native store contact

   216     CContactItem* item = iContactStore.NativeDatabase().ReadContactLC( id );

   217     // Make a VPbk store contact out of it

   218     CContact* contact = CContact::NewL( iContactStore, item );

   219     CleanupStack::Pop( item ); // ownership was taken away

   220     CleanupStack::PushL( contact );

   221 

   222     MVPbkStoreContactFieldCollection& fields = contact->Fields();

   223     TInt fieldCount = fields.FieldCount();

   224 

   225     for ( TInt i = 0; i < fieldCount; ++i )

   226         {

   227         const MVPbkStoreContactField& field = fields.FieldAt( i );

   228         const MVPbkFieldType* fieldType = field.BestMatchingFieldType();

   229         if ( fieldType && iFieldTypeSelector->IsFieldTypeIncluded( *fieldType ) )

   230             {

   231             ret = ETrue;

   232             break;

   233             }

   234         }

   235 

   236     CleanupStack::PopAndDestroy( contact );

   237 

   238     return ret;

   239     }

   240 

   241 } // namespace VPbkCntModel

   242 

   243 // End of File