epoc32/include/mw/mproengprofilename.h
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
     1.1 --- a/epoc32/include/mw/mproengprofilename.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/mproengprofilename.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,84 @@
     1.4 -mproengprofilename.h
     1.5 +/*
     1.6 +* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:  Profile name interface.
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +
    1.24 +#ifndef MPROENGPROFILENAME_H
    1.25 +#define MPROENGPROFILENAME_H
    1.26 +
    1.27 +// INCLUDES
    1.28 +#include <e32std.h>
    1.29 +
    1.30 +// FORWARD DECLARATIONS
    1.31 +class MProEngProfileNameExt; 
    1.32 +
    1.33 +// CLASS DECLARATION
    1.34 +
    1.35 +/**
    1.36 +*  Profile name interface.
    1.37 +*  This interface offers methods to get profile ID and to get and set the
    1.38 +*  profile name.
    1.39 +*
    1.40 +*  @lib N/A
    1.41 +*  @since 3.1
    1.42 +*/
    1.43 +class MProEngProfileName
    1.44 +    {
    1.45 +    protected:  // Destructor
    1.46 +
    1.47 +        virtual ~MProEngProfileName() {};
    1.48 +
    1.49 +    public:
    1.50 +        /**
    1.51 +        * Returns ID of the profile.
    1.52 +        * @since 3.1
    1.53 +        * @return Returns ID of the profile.
    1.54 +        */
    1.55 +        virtual TInt Id() const = 0;
    1.56 +
    1.57 +        /**
    1.58 +        * Returns the name of the profile.
    1.59 +        * @since 3.1
    1.60 +        * @return Returns name of the profile.
    1.61 +        */
    1.62 +        virtual const TDesC& Name() const = 0;
    1.63 +
    1.64 +        /**
    1.65 +        * Set the name of the profile.
    1.66 +        * @since 3.1
    1.67 +        * @param aName Name of the profile.
    1.68 +        * @return KErrNone if succesful,
    1.69 +        *         KErrAccessDenied if name setting of this profile is read-only,
    1.70 +        *         KErrAlreadyExists if the name is already used by another
    1.71 +        *         profile.
    1.72 +        *         
    1.73 +        */
    1.74 +        virtual TInt SetNameL( const TDesC& aName ) = 0;
    1.75 +
    1.76 +    private: // Extension interface
    1.77 +
    1.78 +        /**
    1.79 +        * This member is internal and not intended for use.
    1.80 +        */
    1.81 +        virtual MProEngProfileNameExt* Extension() { return NULL; }
    1.82 +
    1.83 +    };
    1.84 +
    1.85 +#endif      // MPROENGPROFILENAME_H
    1.86 +
    1.87 +// End of File
    1.88 +