1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/app/VPbkContactViewFilterBuilder.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -0,0 +1,64 @@
     1.4 +/*
     1.5 +* Copyright (c) 2006-2007 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of "Eclipse Public License v1.0"
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description:  A factory for creating contact view filters.
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +#ifndef VPBKCONTACTVIEWFILTERBUILDER_H
    1.23 +#define VPBKCONTACTVIEWFILTERBUILDER_H
    1.24 +
    1.25 +//  INCLUDES
    1.26 +#include <e32base.h>
    1.27 +#include <vpbkcontactview.hrh>
    1.28 +
    1.29 +// FORWARD DECLARATIONS
    1.30 +class CVPbkFieldTypeSelector;
    1.31 +class CVPbkContactManager;
    1.32 +
    1.33 +// CLASS DECLARATION
    1.34 +
    1.35 +/**
    1.36 + * A factory for creating contact view filters.
    1.37 + *
    1.38 + * A contact view filter can be used in a contact view definition
    1.39 + * when the client wants to create a view that is filtered by
    1.40 + * field types i.e. only contacts that have a certain fields
    1.41 + * are included in the view.
    1.42 + *
    1.43 + * @see CVPbkContactViewDefinition::SetFieldTypeFilterL
    1.44 + * @lib VPbkEng.lib
    1.45 + */
    1.46 +class VPbkContactViewFilterBuilder
    1.47 +    {
    1.48 +    public: // Interface
    1.49 +        /**
    1.50 +         * Appends a filter for the given field type selector.
    1.51 +         *
    1.52 +         * @param aFieldTypeSelector The selector object to that is modified.
    1.53 +         * @param aFilter Defines the field types that are added to the
    1.54 +         *                selector.
    1.55 +         * @param aContactManager The contact manager.
    1.56 +         * @return A reference to the passed selector object for enabling
    1.57 +         *         chained calls.
    1.58 +         */
    1.59 +        IMPORT_C static CVPbkFieldTypeSelector& BuildContactViewFilterL(
    1.60 +                CVPbkFieldTypeSelector& aFieldTypeSelector,
    1.61 +                TVPbkContactViewFilter aFilter,
    1.62 +                CVPbkContactManager& aContactManager );
    1.63 +    };
    1.64 +
    1.65 +#endif // VPBKCONTACTVIEWFILTERBUILDER_H
    1.66 +
    1.67 +// End of File