epoc32/include/app/MPbk2ContactNameFormatter2.h
branchSymbian3
changeset 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/app/MPbk2ContactNameFormatter2.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -0,0 +1,61 @@
     1.4 +/*
     1.5 +* Copyright (c) 2005-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:  Phonebook 2 contact name formatter interface.
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +#ifndef MPBK2CONTACTNAMEFORMATTER2_H
    1.23 +#define MPBK2CONTACTNAMEFORMATTER2_H
    1.24 +
    1.25 +
    1.26 +/**
    1.27 + * This class is an extension to MPbk2ContactNameFormatter.
    1.28 + * See documentation of MPbk2ContactNameFormatter from header
    1.29 + * MPbk2ContactNameFormatter.h
    1.30 + * 
    1.31 + * you can access this extension by calling
    1.32 + * MPbk2ContactNameFormatter->ContactNameFormatterExtension()
    1.33 + */
    1.34 +class MPbk2ContactNameFormatter2
    1.35 +    {
    1.36 +    public: // Interface
    1.37 +
    1.38 +        /**
    1.39 +         * Returns the title text for a contact.
    1.40 +         *
    1.41 +         * @param aContactFields    Field collection representing
    1.42 +         *                          the data in a contact.
    1.43 +         * @param aFormattingFlags Formatting flags, 
    1.44 +         *                         see TPbk2ContactTitleFormattingFlags.
    1.45 +         * @return  A buffer containing the formatted title,
    1.46 +         *          or the UnnamedText() method's result if no title 
    1.47 +         *          can be created.
    1.48 +         */
    1.49 +        virtual HBufC* GetContactTitleWithCompanyNameL(
    1.50 +                const MVPbkBaseContactFieldCollection& aContactFields,
    1.51 +                TUint32 aFormattingFlags ) = 0;
    1.52 +                
    1.53 +    protected:
    1.54 +    
    1.55 +        virtual ~MPbk2ContactNameFormatter2()
    1.56 +                {}
    1.57 +
    1.58 +     
    1.59 +      
    1.60 +    };
    1.61 +
    1.62 +#endif // MPBK2CONTACTNAMEFORMATTER2_H
    1.63 +
    1.64 +// End of File