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 names array interface.

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef MPROFILESNAMESARRAY_H

    21 #define MPROFILESNAMESARRAY_H

    22 

    23 //  INCLUDES

    24 #include <bamdesca.h> // MDesCArray

    25 

    26 // FORWARD DECLARATIONS

    27 class MProfileName;

    28 

    29 // CLASS DECLARATION

    30 

    31 /**

    32 *  Profile names array interface.

    33 *

    34 *  How to use:

    35 *  Get profile names array with MProfileEngine::ProfilesNamesArrayLC().

    36 *      MProfilesNamesArray* nameArray = iProfileEngine->ProfilesNamesArrayLC();

    37 *

    38 *

    39 *  @lib N/A

    40 *  @since 2.0

    41 */

    42 class MProfilesNamesArray : public MDesCArray

    43     {

    44     public: // New functions

    45 

    46         /**

    47         * Return pointer of the profile name interface.

    48         * @since 2.0

    49         * @param aIndex index of the profile.

    50         * @return Return pointer of the profile name interface.

    51         *         Pointer is NULL if profile doesn't found.

    52         */

    53         virtual const MProfileName* ProfileName( TInt aIndex ) const = 0;

    54 

    55         /**

    56         * Find profile index by ID of the profile.

    57         * @since 2.0

    58         * @param aId ID of the profile.

    59         * @return Return index of the profile. KErrNotFound if

    60         *         profile doesn't found.

    61         */

    62         virtual TInt FindById( TInt aId ) const = 0;

    63 

    64         /**

    65         * Find profile index by name of the profile.

    66         * @since 2.0

    67         * @param aProfileName name of the profile.

    68         * @return Return index of the profile. KErrNotFound if

    69         *         profile doesn't found.

    70         */

    71         virtual TInt FindByName( const TDesC& aProfileName ) const = 0;

    72 

    73     };

    74 

    75 #endif      // MPROFILESNAMESARRAY_H

    76 

    77 // End of File