epoc32/include/mw/mproengalerttoneseeker.h
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
     1.1 --- a/epoc32/include/mw/mproengalerttoneseeker.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/mproengalerttoneseeker.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,82 @@
     1.4 -mproengalerttoneseeker.h
     1.5 +/*
     1.6 +* Copyright (c) 2002-2004 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:  Abstract interface for find media files suitable to be 
    1.19 +*  				set as an alert tone in Profiles.
    1.20 +*
    1.21 +*/
    1.22 +
    1.23 +
    1.24 +
    1.25 +#ifndef MPROENGALERTTONESEEKER_H
    1.26 +#define MPROENGALERTTONESEEKER_H
    1.27 +
    1.28 +//  INCLUDES
    1.29 +#include <e32def.h>
    1.30 +
    1.31 +// FORWARD DECLARATIONS
    1.32 +class MProEngAlertToneSeekerExt;
    1.33 +class MProEngAlertToneSeekerObserver;
    1.34 +
    1.35 +// CLASS DECLARATION
    1.36 +
    1.37 +/**
    1.38 +*  This class can be used to find media files suitable to be set as an alert
    1.39 +*  tone in Profiles.
    1.40 +*
    1.41 +*  @lib ProfileEngine.lib
    1.42 +*  @since Series 60 3.1
    1.43 +*/
    1.44 +class MProEngAlertToneSeeker
    1.45 +    {
    1.46 +    public: // New functions
    1.47 +
    1.48 +        /**
    1.49 +        * Asynchronous method that searches all the tone files that can be used
    1.50 +        * as alert tones in Profiles. The resulting list of the tone paths is
    1.51 +        * delivered to the MProEngAlertToneSeekerObserver.
    1.52 +        * This is a very long lasting operation (~minutes), so this shouldn't
    1.53 +        * be performed too often.
    1.54 +        * @since S 60 3.1
    1.55 +        * @param aObserver Reference to the client-implemented observer which
    1.56 +        *        will get the list of tones after the list has been constructed.
    1.57 +        */
    1.58 +        virtual void FetchAlertToneListL(
    1.59 +                MProEngAlertToneSeekerObserver& aObserver ) = 0;
    1.60 +
    1.61 +        /**
    1.62 +         * Cancels the asynchronous fetch operation.
    1.63 +         * @since S60 3.1
    1.64 +         */
    1.65 +        virtual void CancelFetch() = 0;
    1.66 +
    1.67 +    public:
    1.68 +
    1.69 +        /**
    1.70 +        * Destructor.
    1.71 +        */
    1.72 +        virtual ~MProEngAlertToneSeeker() {}
    1.73 +
    1.74 +    private: // Extension interface
    1.75 +
    1.76 +        /**
    1.77 +        * This member is internal and not intended for use.
    1.78 +        */
    1.79 +        virtual MProEngAlertToneSeekerExt* Extension() { return NULL; }
    1.80 +
    1.81 +    };
    1.82 +
    1.83 +#endif      // MPROENGALERTTONESEEKER_H
    1.84 +
    1.85 +// End of File
    1.86 +