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: 4.1.3 % << 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 <sipmanagedprofile.h>

    25 

    26 /**

    27 *  MMusSIPProfileHandler class

    28 *  Mixin class for SIP profile manipulation.

    29 *  Handles SIP profile manipulations.

    30 *  @since S60 v3.2

    31 */

    32 class MMusSIPProfileHandler

    33     {

    34 public:

    35 

    36     /**

    37      * Returns the index of the default SIP profile.

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

    39      *         default SIP profile.

    40      */

    41     virtual TInt DefaultProfileIndex() = 0;

    42 

    43     /**

    44      * Returns pointer to the SIP profile array, does not change ownership.

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

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

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

    48      * variables for safety.

    49      *

    50      * @return Pointer to internally cached SIP profile array.

    51      */

    52     virtual CArrayPtr<CSIPManagedProfile>* ProfileArrayL() = 0;

    53 

    54     /**

    55      * Returns the id of the default SIP profile.

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

    57      *         default SIP profile.

    58      */

    59     virtual TUint32 DefaultProfileId() = 0;

    60     

    61     /*

    62      * 

    63      * 

    64      */

    65     virtual void DisableProfileL() = 0;

    66 

    67     /**

    68      * Returns profile id based on index.

    69      * @param aIndex Profile index

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

    71      */

    72     virtual TInt ProfileIndexByIdL( TUint32 aId ) = 0;

    73 

    74     /**

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

    76      * @param aId Profile id

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

    78      */

    79     virtual TUint32 ProfileIdByIndex( TUint aIndex ) = 0;

    80     };

    81 

    82 #endif // M_MMUSSIPPROFILEHANDLER_H