1 /*

     2 * Copyright (c) 2006 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:   Client string localizer interface.

    15 *

    16 */

    17 	

    18 

    19 #ifndef M_NCD_CLIENT_LOCALIZER_H

    20 #define M_NCD_CLIENT_LOCALIZER_H

    21 

    22 #include <e32cmn.h>

    23 

    24 /**

    25  * Callback interface for client string localization.

    26  *

    27  * NCD provider users (clients) must implement this interface and register

    28  * it in order to get a chance to translate server-originated

    29  * localization keys into user viewable strings.

    30  *

    31  * 

    32  */

    33 class MNcdClientLocalizer

    34     {

    35     

    36 public:

    37 

    38     /**

    39      * Called when a localization key needs to be translated into a user

    40      * viewable string.

    41      *

    42      * 

    43      * @param aLocalizationKey Localization key string as received from server.

    44      * @return Pointer to heap descriptor containing the localized string

    45      *  corresponding to the specified localization key. Ownership is

    46      *  transferred. Returns a NULL pointer if the localization key is not

    47      *  known.

    48      */

    49     virtual HBufC* LocalizeString( const TDesC& aLocalizationKey ) = 0;

    50     

    51     };

    52     

    53 #endif //  M_NCD_CLIENT_LOCALIZER_H