epoc32/include/mw/mproengprofilename.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
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) 2009 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 MPROENGPROFILENAME_H
    21 #define MPROENGPROFILENAME_H
    22 
    23 // INCLUDES
    24 #include <e32std.h>
    25 
    26 // FORWARD DECLARATIONS
    27 class MProEngProfileNameExt; 
    28 
    29 // CLASS DECLARATION
    30 
    31 /**
    32 *  Profile name interface.
    33 *  This interface offers methods to get profile ID and to get and set the
    34 *  profile name.
    35 *
    36 *  @lib N/A
    37 *  @since 3.1
    38 */
    39 class MProEngProfileName
    40     {
    41     protected:  // Destructor
    42 
    43         virtual ~MProEngProfileName() {};
    44 
    45     public:
    46         /**
    47         * Returns ID of the profile.
    48         * @since 3.1
    49         * @return Returns ID of the profile.
    50         */
    51         virtual TInt Id() const = 0;
    52 
    53         /**
    54         * Returns the name of the profile.
    55         * @since 3.1
    56         * @return Returns name of the profile.
    57         */
    58         virtual const TDesC& Name() const = 0;
    59 
    60         /**
    61         * Set the name of the profile.
    62         * @since 3.1
    63         * @param aName Name of the profile.
    64         * @return KErrNone if succesful,
    65         *         KErrAccessDenied if name setting of this profile is read-only,
    66         *         KErrAlreadyExists if the name is already used by another
    67         *         profile.
    68         *         
    69         */
    70         virtual TInt SetNameL( const TDesC& aName ) = 0;
    71 
    72     private: // Extension interface
    73 
    74         /**
    75         * This member is internal and not intended for use.
    76         */
    77         virtual MProEngProfileNameExt* Extension() { return NULL; }
    78 
    79     };
    80 
    81 #endif      // MPROENGPROFILENAME_H
    82 
    83 // End of File
    84