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
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2002-2004 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* 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
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:  Abstract interface for find media files suitable to be 
williamr@2
    15
*  				set as an alert tone in Profiles.
williamr@2
    16
*
williamr@2
    17
*/
williamr@2
    18
williamr@2
    19
williamr@2
    20
williamr@2
    21
#ifndef MPROENGALERTTONESEEKER_H
williamr@2
    22
#define MPROENGALERTTONESEEKER_H
williamr@2
    23
williamr@2
    24
//  INCLUDES
williamr@2
    25
#include <e32def.h>
williamr@2
    26
williamr@2
    27
// FORWARD DECLARATIONS
williamr@2
    28
class MProEngAlertToneSeekerExt;
williamr@2
    29
class MProEngAlertToneSeekerObserver;
williamr@2
    30
williamr@2
    31
// CLASS DECLARATION
williamr@2
    32
williamr@2
    33
/**
williamr@2
    34
*  This class can be used to find media files suitable to be set as an alert
williamr@2
    35
*  tone in Profiles.
williamr@2
    36
*
williamr@2
    37
*  @lib ProfileEngine.lib
williamr@2
    38
*  @since Series 60 3.1
williamr@2
    39
*/
williamr@2
    40
class MProEngAlertToneSeeker
williamr@2
    41
    {
williamr@2
    42
    public: // New functions
williamr@2
    43
williamr@2
    44
        /**
williamr@2
    45
        * Asynchronous method that searches all the tone files that can be used
williamr@2
    46
        * as alert tones in Profiles. The resulting list of the tone paths is
williamr@2
    47
        * delivered to the MProEngAlertToneSeekerObserver.
williamr@2
    48
        * This is a very long lasting operation (~minutes), so this shouldn't
williamr@2
    49
        * be performed too often.
williamr@2
    50
        * @since S 60 3.1
williamr@2
    51
        * @param aObserver Reference to the client-implemented observer which
williamr@2
    52
        *        will get the list of tones after the list has been constructed.
williamr@2
    53
        */
williamr@2
    54
        virtual void FetchAlertToneListL(
williamr@2
    55
                MProEngAlertToneSeekerObserver& aObserver ) = 0;
williamr@2
    56
williamr@2
    57
        /**
williamr@2
    58
         * Cancels the asynchronous fetch operation.
williamr@2
    59
         * @since S60 3.1
williamr@2
    60
         */
williamr@2
    61
        virtual void CancelFetch() = 0;
williamr@2
    62
williamr@2
    63
    public:
williamr@2
    64
williamr@2
    65
        /**
williamr@2
    66
        * Destructor.
williamr@2
    67
        */
williamr@2
    68
        virtual ~MProEngAlertToneSeeker() {}
williamr@2
    69
williamr@2
    70
    private: // Extension interface
williamr@2
    71
williamr@2
    72
        /**
williamr@2
    73
        * This member is internal and not intended for use.
williamr@2
    74
        */
williamr@2
    75
        virtual MProEngAlertToneSeekerExt* Extension() { return NULL; }
williamr@2
    76
williamr@2
    77
    };
williamr@2
    78
williamr@2
    79
#endif      // MPROENGALERTTONESEEKER_H
williamr@2
    80
williamr@2
    81
// End of File
williamr@2
    82