1 /*

     2 * Copyright (c) 2003-2007 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:  Mixin-class that provides functionality for manipulating

    15 *                MuS specific settings.

    16 *  Version     : %version: 6 % << Don't touch! Updated by Synergy at check-out.

    17 *

    18 */

    19 

    20 

    21 #ifndef M_MMUSSIPPROFILEHANDLER_H

    22 #define M_MMUSSIPPROFILEHANDLER_H

    23 

    24 #include <e32def.h>

    25 #include <e32cmn.h>

    26 

    27 class CSIPProfile;

    28 

    29 /**

    30 *  MMusSIPProfileHandler class

    31 *  Mixin class for SIP profile manipulation.

    32 *  Handles SIP profile manipulations.

    33 */

    34 class MMusSIPProfileHandler

    35     {

    36 public:

    37 

    38     /**

    39      * Returns the index of the default SIP profile.

    40      * @return KErrNotFound, if one does not exist, otherwise index of the

    41      *         default SIP profile.

    42      */

    43     virtual TInt DefaultProfileIndex() = 0;

    44     

    45     /**

    46      * Returns a reference to the SIP profile array.

    47      * Note that previously returned value goes out of scope after a new

    48      * call to ProfileArrayL. So it is not advised to store return value

    49      * in long persistent variable, but rather to be used like stack

    50      * variables for safety.

    51      *

    52      * @return Reference to internally cached SIP profile array.

    53      */

    54     virtual RPointerArray<CSIPProfile>& ProfileArrayL() = 0;

    55 

    56     /**

    57      * Returns the id of the default SIP profile.

    58      * @return KErrNotFound, if one does not exist, otherwise id of the

    59      *         default SIP profile.

    60      */

    61     virtual TUint32 DefaultProfileId() = 0;

    62     

    63     /*

    64      * 

    65      * 

    66      */

    67     virtual void DisableProfileL() = 0;

    68 

    69     /**

    70      * Returns profile id based on index.

    71      * @param aIndex Profile index

    72      * @return Profile id or KUnknownProfileId if no matching profile is found.

    73      */

    74     virtual TInt ProfileIndexByIdL( TUint32 aId ) = 0;

    75 

    76     /**

    77      * Returns SIP profile index on locally cached array based on id.

    78      * @param aId Profile id

    79      * @return Profile index or KErrNotFound if no matching profile is found.

    80      */

    81     virtual TUint32 ProfileIdByIndex( TUint aIndex ) = 0;

    82     };

    83 

    84 #endif // M_MMUSSIPPROFILEHANDLER_H