1 /*

     2 * Copyright (c) 2005-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:  Phonebook 2 contact name formatter interface.

    15 *

    16 */

    17 

    18 

    19 #ifndef MPBK2CONTACTNAMEFORMATTER3_H

    20 #define MPBK2CONTACTNAMEFORMATTER3_H

    21 

    22 //Use this UID to access field property interface extension 3. Used as

    23 //a parameter to ContactNameFormatterExtension() method.

    24 const TUid MPbk2ContactNameFormatterExtension3Uid = { 3 };

    25 

    26 /**

    27  * This class is an extension to MPbk2ContactNameFormatter.

    28  * See documentation of MPbk2ContactNameFormatter from header

    29  * MPbk2ContactNameFormatter.h

    30  * 

    31  * you can access this extension by calling

    32  * MPbk2ContactNameFormatter->ContactNameFormatterExtension()

    33  */

    34 class MPbk2ContactNameFormatter3

    35     {

    36     public: // Interface

    37 

    38         /**

    39          * Return iterator that contains all fields that are used for making

    40          * the formatted name.

    41          *

    42          * @param   aFieldTypeList  Field type list that is used to store

    43          *                          field types for the iterator. The list

    44          *                          will be resetted before use.

    45          * @param   aContactFields  Field collection representing

    46          *                          the data in a contact.

    47          * @return  Iterator for fields that are used for the formated title.

    48          */

    49         virtual CVPbkBaseContactFieldTypeListIterator* TitleWithCompanyNameFieldsLC(

    50                 CVPbkFieldTypeRefsList& aFieldTypeList,

    51                 const MVPbkBaseContactFieldCollection& aContactFields ) = 0;

    52                 

    53     protected:

    54     

    55         virtual ~MPbk2ContactNameFormatter3()

    56                 {}

    57 

    58      

    59       

    60     };

    61 

    62 #endif // MPBK2CONTACTNAMEFORMATTER3_H

    63 

    64 // End of File