epoc32/include/mw/mproengalerttoneseeker.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 /*
     2 * Copyright (c) 2002-2004 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:  Abstract interface for find media files suitable to be 
    15 *  				set as an alert tone in Profiles.
    16 *
    17 */
    18 
    19 
    20 
    21 #ifndef MPROENGALERTTONESEEKER_H
    22 #define MPROENGALERTTONESEEKER_H
    23 
    24 //  INCLUDES
    25 #include <e32def.h>
    26 
    27 // FORWARD DECLARATIONS
    28 class MProEngAlertToneSeekerExt;
    29 class MProEngAlertToneSeekerObserver;
    30 
    31 // CLASS DECLARATION
    32 
    33 /**
    34 *  This class can be used to find media files suitable to be set as an alert
    35 *  tone in Profiles.
    36 *
    37 *  @lib ProfileEngine.lib
    38 *  @since Series 60 3.1
    39 */
    40 class MProEngAlertToneSeeker
    41     {
    42     public: // New functions
    43 
    44         /**
    45         * Asynchronous method that searches all the tone files that can be used
    46         * as alert tones in Profiles. The resulting list of the tone paths is
    47         * delivered to the MProEngAlertToneSeekerObserver.
    48         * This is a very long lasting operation (~minutes), so this shouldn't
    49         * be performed too often.
    50         * @since S 60 3.1
    51         * @param aObserver Reference to the client-implemented observer which
    52         *        will get the list of tones after the list has been constructed.
    53         */
    54         virtual void FetchAlertToneListL(
    55                 MProEngAlertToneSeekerObserver& aObserver ) = 0;
    56 
    57         /**
    58          * Cancels the asynchronous fetch operation.
    59          * @since S60 3.1
    60          */
    61         virtual void CancelFetch() = 0;
    62 
    63     public:
    64 
    65         /**
    66         * Destructor.
    67         */
    68         virtual ~MProEngAlertToneSeeker() {}
    69 
    70     private: // Extension interface
    71 
    72         /**
    73         * This member is internal and not intended for use.
    74         */
    75         virtual MProEngAlertToneSeekerExt* Extension() { return NULL; }
    76 
    77     };
    78 
    79 #endif      // MPROENGALERTTONESEEKER_H
    80 
    81 // End of File
    82