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: 

    15 *     MFLDFileProcessor defines an abstract interface for processing

    16 *     files (e.g. playing sound files or displaying image files).

    17 *

    18 *

    19 */

    20 

    21 

    22 

    23 #ifndef __MFLDFILEPROCESSOR_H__

    24 #define __MFLDFILEPROCESSOR_H__

    25 

    26 // INTERNAL INCLUDES

    27 

    28 // EXTERNAL INCLUDES

    29 #include <e32base.h>

    30 

    31 // CLASS DEFINITION

    32 

    33 // FORWARD DECLARATIONS

    34 class RWindow;

    35 

    36 /**

    37 * MFLDFileProcessor defines an abstract interface for processing

    38 * files (e.g. playing sound files or displaying image files).

    39 */

    40 class MFLDFileProcessor

    41     {

    42     public:     // Constructors and destructors

    43 

    44         /**

    45         * Destructor.

    46         */

    47         virtual ~MFLDFileProcessor() {}

    48 

    49     public:     // New methods

    50 

    51         /**

    52         * Starts processing a file (e.g. playing a sound file)

    53         * @param aFileName The file name to be processed

    54         */

    55         virtual void ProcessFileL( const TDesC& aFileName, RWindow* aWindow ) = 0;

    56 

    57         /**

    58         * Cancels processing a file (e.g. stop playing a sound file)

    59         */

    60         virtual void Cancel() = 0;

    61         

    62          /**

    63         * Set the volume level on which the sound is played

    64         * @param aVolume The volume level

    65         */

    66         virtual void SetVolume( TInt aVolume ) = 0;

    67 

    68         /**

    69         * Sets the ringing type

    70         * @param aRingingType The ringing type (see enum TRingingTypes)

    71         */

    72         virtual void SetRingingType( TInt aRingingType ) = 0;

    73 

    74         /**

    75         * Sets vibrating alert on or off.

    76         * @param aVibra True: Vibra is on. False: Vibra is off.

    77         */

    78         virtual void SetVibra( TBool aVibra ) = 0;

    79         

    80           /**

    81         * Sets 3d-effects on or off.

    82         * @param a3dEffects True: 3dEffects are on. False: 3dEffects are off.

    83         */

    84         virtual void Set3dEffects( TBool a3dEffects ) = 0;

    85 

    86     };

    87 

    88 #endif      //  __MFLDFILEPROCESSOR_H__

    89 

    90 // End of File