epoc32/include/mw/mproengprofilename.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* 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
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:  Profile name interface.
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
williamr@2
    20
#ifndef MPROENGPROFILENAME_H
williamr@2
    21
#define MPROENGPROFILENAME_H
williamr@2
    22
williamr@2
    23
// INCLUDES
williamr@2
    24
#include <e32std.h>
williamr@2
    25
williamr@2
    26
// FORWARD DECLARATIONS
williamr@2
    27
class MProEngProfileNameExt; 
williamr@2
    28
williamr@2
    29
// CLASS DECLARATION
williamr@2
    30
williamr@2
    31
/**
williamr@2
    32
*  Profile name interface.
williamr@2
    33
*  This interface offers methods to get profile ID and to get and set the
williamr@2
    34
*  profile name.
williamr@2
    35
*
williamr@2
    36
*  @lib N/A
williamr@2
    37
*  @since 3.1
williamr@2
    38
*/
williamr@2
    39
class MProEngProfileName
williamr@2
    40
    {
williamr@2
    41
    protected:  // Destructor
williamr@2
    42
williamr@2
    43
        virtual ~MProEngProfileName() {};
williamr@2
    44
williamr@2
    45
    public:
williamr@2
    46
        /**
williamr@2
    47
        * Returns ID of the profile.
williamr@2
    48
        * @since 3.1
williamr@2
    49
        * @return Returns ID of the profile.
williamr@2
    50
        */
williamr@2
    51
        virtual TInt Id() const = 0;
williamr@2
    52
williamr@2
    53
        /**
williamr@2
    54
        * Returns the name of the profile.
williamr@2
    55
        * @since 3.1
williamr@2
    56
        * @return Returns name of the profile.
williamr@2
    57
        */
williamr@2
    58
        virtual const TDesC& Name() const = 0;
williamr@2
    59
williamr@2
    60
        /**
williamr@2
    61
        * Set the name of the profile.
williamr@2
    62
        * @since 3.1
williamr@2
    63
        * @param aName Name of the profile.
williamr@2
    64
        * @return KErrNone if succesful,
williamr@2
    65
        *         KErrAccessDenied if name setting of this profile is read-only,
williamr@2
    66
        *         KErrAlreadyExists if the name is already used by another
williamr@2
    67
        *         profile.
williamr@2
    68
        *         
williamr@2
    69
        */
williamr@2
    70
        virtual TInt SetNameL( const TDesC& aName ) = 0;
williamr@2
    71
williamr@2
    72
    private: // Extension interface
williamr@2
    73
williamr@2
    74
        /**
williamr@2
    75
        * This member is internal and not intended for use.
williamr@2
    76
        */
williamr@2
    77
        virtual MProEngProfileNameExt* Extension() { return NULL; }
williamr@2
    78
williamr@2
    79
    };
williamr@2
    80
williamr@2
    81
#endif      // MPROENGPROFILENAME_H
williamr@2
    82
williamr@2
    83
// End of File
williamr@2
    84