epoc32/include/app/MPbk2ContactNameFormatter2.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     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 MPBK2CONTACTNAMEFORMATTER2_H
    20 #define MPBK2CONTACTNAMEFORMATTER2_H
    21 
    22 
    23 /**
    24  * This class is an extension to MPbk2ContactNameFormatter.
    25  * See documentation of MPbk2ContactNameFormatter from header
    26  * MPbk2ContactNameFormatter.h
    27  * 
    28  * you can access this extension by calling
    29  * MPbk2ContactNameFormatter->ContactNameFormatterExtension()
    30  */
    31 class MPbk2ContactNameFormatter2
    32     {
    33     public: // Interface
    34 
    35         /**
    36          * Returns the title text for a contact.
    37          *
    38          * @param aContactFields    Field collection representing
    39          *                          the data in a contact.
    40          * @param aFormattingFlags Formatting flags, 
    41          *                         see TPbk2ContactTitleFormattingFlags.
    42          * @return  A buffer containing the formatted title,
    43          *          or the UnnamedText() method's result if no title 
    44          *          can be created.
    45          */
    46         virtual HBufC* GetContactTitleWithCompanyNameL(
    47                 const MVPbkBaseContactFieldCollection& aContactFields,
    48                 TUint32 aFormattingFlags ) = 0;
    49                 
    50     protected:
    51     
    52         virtual ~MPbk2ContactNameFormatter2()
    53                 {}
    54 
    55      
    56       
    57     };
    58 
    59 #endif // MPBK2CONTACTNAMEFORMATTER2_H
    60 
    61 // End of File