williamr@2: /*
williamr@2: * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@4: * under the terms of "Eclipse Public License v1.0"
williamr@2: * which accompanies this distribution, and is available
williamr@4: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description:  Profile name interface.
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: #ifndef MPROENGPROFILENAME_H
williamr@2: #define MPROENGPROFILENAME_H
williamr@2: 
williamr@2: // INCLUDES
williamr@2: #include <e32std.h>
williamr@2: 
williamr@2: // FORWARD DECLARATIONS
williamr@2: class MProEngProfileNameExt; 
williamr@2: 
williamr@2: // CLASS DECLARATION
williamr@2: 
williamr@2: /**
williamr@2: *  Profile name interface.
williamr@2: *  This interface offers methods to get profile ID and to get and set the
williamr@2: *  profile name.
williamr@2: *
williamr@2: *  @lib N/A
williamr@2: *  @since 3.1
williamr@2: */
williamr@2: class MProEngProfileName
williamr@2:     {
williamr@2:     protected:  // Destructor
williamr@2: 
williamr@2:         virtual ~MProEngProfileName() {};
williamr@2: 
williamr@2:     public:
williamr@2:         /**
williamr@2:         * Returns ID of the profile.
williamr@2:         * @since 3.1
williamr@2:         * @return Returns ID of the profile.
williamr@2:         */
williamr@2:         virtual TInt Id() const = 0;
williamr@2: 
williamr@2:         /**
williamr@2:         * Returns the name of the profile.
williamr@2:         * @since 3.1
williamr@2:         * @return Returns name of the profile.
williamr@2:         */
williamr@2:         virtual const TDesC& Name() const = 0;
williamr@2: 
williamr@2:         /**
williamr@2:         * Set the name of the profile.
williamr@2:         * @since 3.1
williamr@2:         * @param aName Name of the profile.
williamr@2:         * @return KErrNone if succesful,
williamr@2:         *         KErrAccessDenied if name setting of this profile is read-only,
williamr@2:         *         KErrAlreadyExists if the name is already used by another
williamr@2:         *         profile.
williamr@2:         *         
williamr@2:         */
williamr@2:         virtual TInt SetNameL( const TDesC& aName ) = 0;
williamr@2: 
williamr@2:     private: // Extension interface
williamr@2: 
williamr@2:         /**
williamr@2:         * This member is internal and not intended for use.
williamr@2:         */
williamr@2:         virtual MProEngProfileNameExt* Extension() { return NULL; }
williamr@2: 
williamr@2:     };
williamr@2: 
williamr@2: #endif      // MPROENGPROFILENAME_H
williamr@2: 
williamr@2: // End of File
williamr@2: