mmshplugins/mmshsettingsuiplugin/inc/mmussipprofilehandler.h
branchRCL_3
changeset 33 bc78a40cd63c
parent 32 73a1feb507fb
equal deleted inserted replaced
32:73a1feb507fb 33:bc78a40cd63c
    11 *
    11 *
    12 * Contributors:
    12 * Contributors:
    13 *
    13 *
    14 * Description:  Mixin-class that provides functionality for manipulating
    14 * Description:  Mixin-class that provides functionality for manipulating
    15 *                MuS specific settings.
    15 *                MuS specific settings.
       
    16 *  Version     : %version: 6 % << Don't touch! Updated by Synergy at check-out.
    16 *
    17 *
    17 */
    18 */
    18 
    19 
    19 
    20 
    20 #ifndef M_MMUSSIPPROFILEHANDLER_H
    21 #ifndef M_MMUSSIPPROFILEHANDLER_H
    21 #define M_MMUSSIPPROFILEHANDLER_H
    22 #define M_MMUSSIPPROFILEHANDLER_H
    22 
    23 
    23 #include <sipmanagedprofile.h>
    24 #include <e32def.h>
       
    25 #include <e32cmn.h>
       
    26 
       
    27 class CSIPProfile;
    24 
    28 
    25 /**
    29 /**
    26 *  MMusSIPProfileHandler class
    30 *  MMusSIPProfileHandler class
    27 *  Mixin class for SIP profile manipulation.
    31 *  Mixin class for SIP profile manipulation.
    28 *  Handles SIP profile manipulations.
    32 *  Handles SIP profile manipulations.
    29 *  @since S60 v3.2
       
    30 */
    33 */
    31 class MMusSIPProfileHandler
    34 class MMusSIPProfileHandler
    32     {
    35     {
    33 public:
    36 public:
    34 
    37 
    36      * Returns the index of the default SIP profile.
    39      * Returns the index of the default SIP profile.
    37      * @return KErrNotFound, if one does not exist, otherwise index of the
    40      * @return KErrNotFound, if one does not exist, otherwise index of the
    38      *         default SIP profile.
    41      *         default SIP profile.
    39      */
    42      */
    40     virtual TInt DefaultProfileIndex() = 0;
    43     virtual TInt DefaultProfileIndex() = 0;
    41 
    44     
    42     /**
    45     /**
    43      * Returns pointer to the SIP profile array, does not change ownership.
    46      * Returns a reference to the SIP profile array.
    44      * Note that previously returned value goes out of scope after a new
    47      * Note that previously returned value goes out of scope after a new
    45      * call to ProfileArrayL. So it is not advised to store return value
    48      * call to ProfileArrayL. So it is not advised to store return value
    46      * in long persistent variable, but rather to be used like stack
    49      * in long persistent variable, but rather to be used like stack
    47      * variables for safety.
    50      * variables for safety.
    48      *
    51      *
    49      * @return Pointer to internally cached SIP profile array.
    52      * @return Reference to internally cached SIP profile array.
    50      */
    53      */
    51     virtual CArrayPtr<CSIPManagedProfile>* ProfileArrayL() = 0;
    54     virtual RPointerArray<CSIPProfile>& ProfileArrayL() = 0;
    52 
    55 
    53     /**
    56     /**
    54      * Returns the id of the default SIP profile.
    57      * Returns the id of the default SIP profile.
    55      * @return KErrNotFound, if one does not exist, otherwise id of the
    58      * @return KErrNotFound, if one does not exist, otherwise id of the
    56      *         default SIP profile.
    59      *         default SIP profile.
    57      */
    60      */
    58     virtual TUint32 DefaultProfileId() = 0;
    61     virtual TUint32 DefaultProfileId() = 0;
       
    62     
       
    63     /*
       
    64      * 
       
    65      * 
       
    66      */
       
    67     virtual void DisableProfileL() = 0;
    59 
    68 
    60     /**
    69     /**
    61      * Returns profile id based on index.
    70      * Returns profile id based on index.
    62      * @param aIndex Profile index
    71      * @param aIndex Profile index
    63      * @return Profile id or KUnknownProfileId if no matching profile is found.
    72      * @return Profile id or KUnknownProfileId if no matching profile is found.