mmshplugins/mmshsettingsuiplugin/inc/mmussipprofilehandler.h
changeset 2 b31261fd4e04
parent 0 f0cf47e981f9
child 32 73a1feb507fb
equal deleted inserted replaced
1:065f1826587f 2:b31261fd4e04
    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: 4.1.3 % << Don't touch! Updated by Synergy at check-out.
    16 *  Version     : %version: 6 % << Don't touch! Updated by Synergy at check-out.
    17 *
    17 *
    18 */
    18 */
    19 
    19 
    20 
    20 
    21 #ifndef M_MMUSSIPPROFILEHANDLER_H
    21 #ifndef M_MMUSSIPPROFILEHANDLER_H
    22 #define M_MMUSSIPPROFILEHANDLER_H
    22 #define M_MMUSSIPPROFILEHANDLER_H
    23 
    23 
    24 #include <sipmanagedprofile.h>
    24 #include <e32def.h>
       
    25 #include <e32cmn.h>
       
    26 
       
    27 class CSIPProfile;
    25 
    28 
    26 /**
    29 /**
    27 *  MMusSIPProfileHandler class
    30 *  MMusSIPProfileHandler class
    28 *  Mixin class for SIP profile manipulation.
    31 *  Mixin class for SIP profile manipulation.
    29 *  Handles SIP profile manipulations.
    32 *  Handles SIP profile manipulations.
    30 *  @since S60 v3.2
       
    31 */
    33 */
    32 class MMusSIPProfileHandler
    34 class MMusSIPProfileHandler
    33     {
    35     {
    34 public:
    36 public:
    35 
    37 
    37      * Returns the index of the default SIP profile.
    39      * Returns the index of the default SIP profile.
    38      * @return KErrNotFound, if one does not exist, otherwise index of the
    40      * @return KErrNotFound, if one does not exist, otherwise index of the
    39      *         default SIP profile.
    41      *         default SIP profile.
    40      */
    42      */
    41     virtual TInt DefaultProfileIndex() = 0;
    43     virtual TInt DefaultProfileIndex() = 0;
    42 
    44     
    43     /**
    45     /**
    44      * Returns pointer to the SIP profile array, does not change ownership.
    46      * Returns a reference to the SIP profile array.
    45      * 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
    46      * 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
    47      * in long persistent variable, but rather to be used like stack
    49      * in long persistent variable, but rather to be used like stack
    48      * variables for safety.
    50      * variables for safety.
    49      *
    51      *
    50      * @return Pointer to internally cached SIP profile array.
    52      * @return Reference to internally cached SIP profile array.
    51      */
    53      */
    52     virtual CArrayPtr<CSIPManagedProfile>* ProfileArrayL() = 0;
    54     virtual RPointerArray<CSIPProfile>& ProfileArrayL() = 0;
    53 
    55 
    54     /**
    56     /**
    55      * Returns the id of the default SIP profile.
    57      * Returns the id of the default SIP profile.
    56      * @return KErrNotFound, if one does not exist, otherwise id of the
    58      * @return KErrNotFound, if one does not exist, otherwise id of the
    57      *         default SIP profile.
    59      *         default SIP profile.