gsprofilesrv_plat/profiles_engine_api/inc/MProfileTones.h
changeset 0 8c5d936e5675
equal deleted inserted replaced
-1:000000000000 0:8c5d936e5675
       
     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 tones interface.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef __MPROFILETONES_H
       
    21 #define __MPROFILETONES_H
       
    22 
       
    23 // INCLUDES
       
    24 #include <e32std.h>
       
    25 
       
    26 // FORWARD DECLARATIONS
       
    27 struct TProfileToneSettings;
       
    28 
       
    29 // CLASS DECLARATION
       
    30 
       
    31 /**
       
    32 *  Profile tones interface.
       
    33 *  This interface offers methods to get line 1 and 2 ringing tone,
       
    34 *  message alert tone and tone settings.
       
    35 *
       
    36 *  @lib N/A
       
    37 *  @since 2.0
       
    38 */
       
    39 class MProfileTones
       
    40     {
       
    41     protected:  // Destructor
       
    42 
       
    43         virtual ~MProfileTones() {};
       
    44 
       
    45     public:
       
    46 
       
    47         /**
       
    48         * Returns line 1 ringing tone file name.
       
    49         * @since 2.0
       
    50         * @return Returns line 1 ringing tone file name.
       
    51         */
       
    52         virtual const TDesC& RingingTone1() const = 0;
       
    53 
       
    54         /**
       
    55         * Returns line 2 ringing tone file name.
       
    56         * @since 2.0
       
    57         * @return Returns line 2 ringing tone file name.
       
    58         */
       
    59         virtual const TDesC& RingingTone2() const = 0;
       
    60 
       
    61         /**
       
    62         * Returns message alert tone file name.
       
    63         * @since 2.0
       
    64         * @return Returns message alert tone file name.
       
    65         */
       
    66         virtual const TDesC& MessageAlertTone() const = 0;
       
    67 
       
    68         /**
       
    69         * Returns tone settings structure.
       
    70         * @since 2.0
       
    71         * @return Returns tone settings structure.
       
    72         */
       
    73         virtual const TProfileToneSettings& ToneSettings() const = 0;
       
    74     };
       
    75 
       
    76 #endif      // __MPROFILETONES_H
       
    77 
       
    78 // End of File