1 /*

     2 * Copyright (c) 2002 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:  Profile name interface.

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef __MPROFILENAME_H

    21 #define __MPROFILENAME_H

    22 

    23 // INCLUDES

    24 #include <e32std.h>

    25 

    26 // CLASS DECLARATION

    27 

    28 /**

    29 *  Profile name interface.

    30 *  This interface offers methods to get profile ID and profile name.

    31 *

    32 *  @lib N/A

    33 *  @since 2.0

    34 */

    35 class MProfileName

    36     {

    37     protected:  // Destructor

    38 

    39         virtual ~MProfileName() {};

    40 

    41     public:

    42         /**

    43         * Returns ID of the profile.

    44         * @since 2.0

    45         * @return Returns ID of the profile.

    46         */

    47         virtual TInt Id() const = 0;

    48 

    49         /**

    50         * Returns name of the profile.

    51         * @since 2.0

    52         * @return Returns name of the profile.

    53         */

    54         virtual const TDesC& Name() const = 0;

    55 

    56         /**

    57         * Returns the default short name of the profile. The localised string

    58         * returned by the method has the correct layout for navi pane with 5

    59         * tabs. If user has changed the name, this method returns the same as

    60         * Name().

    61         * @since 3.1

    62         * @return Returns short name of the profile.

    63         */

    64         virtual const TDesC& ShortName() const = 0;

    65 

    66         /**

    67         * Returns the name of the profile to be used in navi pane (that is,

    68         * the localised string has correct layout for navi pane). If user has

    69         * changed the name, this method returns the same as Name().

    70         * @since 3.2

    71         * @return Returns navi name of the profile.

    72         */

    73         virtual const TDesC& NaviName() const = 0;

    74 

    75         /**

    76         * Returns the name of the profile to be used in title pane (that is,

    77         * the localised string has correct layout for title pane). If user has

    78         * changed the name, this method returns the same as Name().

    79         * @since 3.2

    80         * @return Returns title name of the profile.

    81         */

    82         virtual const TDesC& TitleName() const = 0;

    83     };

    84 

    85 #endif      // __MPROFILENAME_H

    86 

    87 // End of File