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 phone number formatter interface.

    15 *

    16 */

    17 

    18 

    19 #ifndef MPBK2PHONENUMBERFORMATTER_H

    20 #define MPBK2PHONENUMBERFORMATTER_H

    21 

    22 // CLASS DECLARATION

    23 

    24 /**

    25  * Phonebook 2 phone number formatter interface.

    26  */

    27 class MPbk2PhoneNumberFormatter

    28     {

    29     public: // Interface

    30 

    31         /**

    32          * Virtual destructor.

    33          */

    34         virtual ~MPbk2PhoneNumberFormatter()

    35             {}

    36 

    37         /**

    38          * Sets formatting buffer capacity.

    39          *

    40          * @param aMaxLength    Length of the phone number to be formatted.

    41          */

    42         virtual void SetMaxBufferLengthL(

    43                 TInt aMaxLength ) = 0;

    44 

    45         /**

    46          * Formats phone number for display. The formatting is done on

    47          * best-effort basis. If there is insufficient memory to perform the

    48          * formatting the original phone number may be returned.

    49          *

    50          * @param aOriginalPhoneNumber      The phone number to format.

    51          * @return  The formatted phone number. The return value is

    52          *          valid until this function is called again.

    53          */

    54         virtual TPtrC FormatPhoneNumberForDisplay(

    55                 const TDesC& aOriginalPhoneNumber ) = 0;

    56     };

    57 

    58 #endif // MPBK2PHONENUMBERFORMATTER_H

    59 

    60 // End of File