epoc32/include/mw/mproengalerttoneseeker.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files

/*
* Copyright (c) 2002-2004 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* 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
* which accompanies this distribution, and is available
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:  Abstract interface for find media files suitable to be 
*  				set as an alert tone in Profiles.
*
*/



#ifndef MPROENGALERTTONESEEKER_H
#define MPROENGALERTTONESEEKER_H

//  INCLUDES
#include <e32def.h>

// FORWARD DECLARATIONS
class MProEngAlertToneSeekerExt;
class MProEngAlertToneSeekerObserver;

// CLASS DECLARATION

/**
*  This class can be used to find media files suitable to be set as an alert
*  tone in Profiles.
*
*  @lib ProfileEngine.lib
*  @since Series 60 3.1
*/
class MProEngAlertToneSeeker
    {
    public: // New functions

        /**
        * Asynchronous method that searches all the tone files that can be used
        * as alert tones in Profiles. The resulting list of the tone paths is
        * delivered to the MProEngAlertToneSeekerObserver.
        * This is a very long lasting operation (~minutes), so this shouldn't
        * be performed too often.
        * @since S 60 3.1
        * @param aObserver Reference to the client-implemented observer which
        *        will get the list of tones after the list has been constructed.
        */
        virtual void FetchAlertToneListL(
                MProEngAlertToneSeekerObserver& aObserver ) = 0;

        /**
         * Cancels the asynchronous fetch operation.
         * @since S60 3.1
         */
        virtual void CancelFetch() = 0;

    public:

        /**
        * Destructor.
        */
        virtual ~MProEngAlertToneSeeker() {}

    private: // Extension interface

        /**
        * This member is internal and not intended for use.
        */
        virtual MProEngAlertToneSeekerExt* Extension() { return NULL; }

    };

#endif      // MPROENGALERTTONESEEKER_H

// End of File