1.1 --- a/epoc32/include/mw/mproengtonesettings.h Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/mw/mproengtonesettings.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,160 @@
1.4 -mproengtonesettings.h
1.5 +/*
1.6 +* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
1.7 +* All rights reserved.
1.8 +* This component and the accompanying materials are made available
1.9 +* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
1.10 +* which accompanies this distribution, and is available
1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.12 +*
1.13 +* Initial Contributors:
1.14 +* Nokia Corporation - initial contribution.
1.15 +*
1.16 +* Contributors:
1.17 +*
1.18 +* Description: Profile tone settings interface.
1.19 +*
1.20 +*/
1.21 +
1.22 +
1.23 +
1.24 +#ifndef MPROENGTONESETTINGS_H
1.25 +#define MPROENGTONESETTINGS_H
1.26 +
1.27 +// INCLUDES
1.28 +#include <e32std.h>
1.29 +#include <profile.hrh>
1.30 +
1.31 +// FORWARD DECLARATIONS
1.32 +class MProEngToneSettingsExt;
1.33 +
1.34 +// CLASS DECLARATION
1.35 +
1.36 +/**
1.37 +* Profile tone settings interface.
1.38 +* This interface offers methods to set and get the following settings: ringing
1.39 +* type, keypad volume, ringing volume, vibrating alert, warning and game tones
1.40 +* and text-to-speech.
1.41 +*
1.42 +* @lib ProfileEngine.lib
1.43 +* @since 3.1
1.44 +*/
1.45 +class MProEngToneSettings
1.46 + {
1.47 + protected: // Destructor
1.48 +
1.49 + virtual ~MProEngToneSettings() {};
1.50 +
1.51 + public:
1.52 +
1.53 + /**
1.54 + * Returns the ringing type.
1.55 + * @since 3.1
1.56 + * @return Returns the ringing type.
1.57 + */
1.58 + virtual TProfileRingingType RingingType() const = 0;
1.59 +
1.60 + /**
1.61 + * Returns the keypad volume.
1.62 + * @since 3.1
1.63 + * @return Returns the keypad volume.
1.64 + */
1.65 + virtual TProfileKeypadVolume KeypadVolume() const = 0;
1.66 +
1.67 + /**
1.68 + * Returns the ringing volume.
1.69 + * @since 3.1
1.70 + * @return Returns the ringing volume.
1.71 + */
1.72 + virtual TProfileRingingVolume RingingVolume() const = 0;
1.73 +
1.74 + /**
1.75 + * Returns the state of vibrating alert setting.
1.76 + * @since 3.1
1.77 + * @return Returns the state of vibrating alert setting.
1.78 + */
1.79 + virtual TBool VibratingAlert() const = 0;
1.80 +
1.81 + /**
1.82 + * Returns the state of warning and game tones setting.
1.83 + * @since 3.1
1.84 + * @return Returns the state of warning and game tones setting.
1.85 + */
1.86 + virtual TBool WarningAndGameTones() const = 0;
1.87 +
1.88 + /**
1.89 + * Returns the state of text-to-speech setting.
1.90 + * @since 3.1
1.91 + * @return Returns the state of text-to-speech setting.
1.92 + */
1.93 + virtual TBool TextToSpeech() const = 0;
1.94 +
1.95 + /**
1.96 + * Sets the ringing type.
1.97 + * @since 3.1
1.98 + * @param aRingingType The new value for ringing type.
1.99 + * @return KErrNone if succesful, KErrAccessDenied if ringing type
1.100 + * setting of this profile is read-only.
1.101 + */
1.102 + virtual TInt SetRingingType( TProfileRingingType aRingingType ) = 0;
1.103 +
1.104 + /**
1.105 + * Sets the keypad volume.
1.106 + * @since 3.1
1.107 + * @param aKeypadVolume The new value for keypad tones volume.
1.108 + * @return KErrNone if succesful, KErrAccessDenied if keypad tones
1.109 + * setting of this profile is read-only.
1.110 + */
1.111 + virtual TInt SetKeypadVolume( TProfileKeypadVolume aKeypadVolume ) = 0;
1.112 +
1.113 + /**
1.114 + * Sets the ringing volume.
1.115 + * @since 3.1
1.116 + * @param aRingingVolume The new value for ringing volume.
1.117 + * @return KErrNone if succesful, KErrAccessDenied if ringing volume
1.118 + * setting of this profile is read-only.
1.119 + */
1.120 + virtual TInt SetRingingVolume(
1.121 + TProfileRingingVolume aRingingVolume ) = 0;
1.122 +
1.123 + /**
1.124 + * Sets the state of vibrating alert setting.
1.125 + * @since 3.1
1.126 + * @param aVibratingAlert The new state for the vibrating alert setting.
1.127 + * @return KErrNone if succesful, KErrAccessDenied if vibrating alert
1.128 + * setting of this profile is read-only.
1.129 + */
1.130 + virtual TInt SetVibratingAlert( TBool aVibratingAlert ) = 0;
1.131 +
1.132 + /**
1.133 + * Sets the state of warning and game tones setting.
1.134 + * @since 3.1
1.135 + * @param aWarningAndGameTones The new state for Warning and Game tones
1.136 + * setting.
1.137 + * @return KErrNone if succesful, KErrAccessDenied if warning and game
1.138 + * tones setting of this profile is read-only.
1.139 + */
1.140 + virtual TInt SetWarningAndGameTones( TBool aWarningAndGameTones ) = 0;
1.141 +
1.142 + /**
1.143 + * Sets the state of text-to-speech setting.
1.144 + * @since 3.1
1.145 + * @param aTextToSpeech The new state for text-to-speech setting.
1.146 + * @return KErrNone if succesful, KErrAccessDenied if text-to-speech
1.147 + * setting of this profile is read-only.
1.148 + */
1.149 + virtual TInt SetTextToSpeech( TBool aTextToSpeech ) = 0;
1.150 +
1.151 + private: // Extension interface
1.152 +
1.153 + /**
1.154 + * This member is internal and not intended for use.
1.155 + */
1.156 + virtual MProEngToneSettingsExt* Extension() { return NULL; }
1.157 +
1.158 + };
1.159 +
1.160 +#endif // MPROENGTONESETTINGS_H
1.161 +
1.162 +// End of File
1.163 +
1.164 +