epoc32/include/mw/mproengalerttoneseekerobserver.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
     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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description: Interface to get the list of the alert tones from MProEngAlertToneSeeker.
    15 *
    16 */
    17 
    18 
    19 
    20 #ifndef MPROENGALERTTONESEEKEROBSERVER_H
    21 #define MPROENGALERTTONESEEKEROBSERVER_H
    22 
    23 //  INCLUDES
    24 #include <e32def.h>
    25 
    26 // FORWARD DECLARATIONS
    27 class MProEngAlertToneSeekerObserverExt;
    28 
    29 // CLASS DECLARATION
    30 
    31 /**
    32 *  Interface to get the list of the alert tones from MProEngAlertToneSeeker.
    33 *  @lib ProfileEngine.lib
    34 *  @since Series 60 3.1
    35 */
    36 class MProEngAlertToneSeekerObserver
    37     {
    38     public: // New functions
    39 
    40         /**
    41         * Abstract method to get notification when the MProEngAlertToneSeeker
    42         * has completed the list of alert tones.
    43         * @since Series 60 3.1
    44         * @param aToneList Array containing the path names of the tones found.
    45         * The ownership of the array is transferred to the observer.
    46         */
    47         virtual void HandleAlertToneListCompletedL( MDesCArray* aToneList ) = 0;
    48 
    49         /**
    50         * Abstract method for handling errors in alert tone list creation
    51         * process. Also if HandleAlertToneListCompletedL() method leaves, the
    52         * leave code will be passed to this method.
    53         * @since Series 60 3.1
    54         * @param aError System wide error code.
    55         */
    56         virtual void HandleError( TInt aError ) = 0;
    57 
    58     protected:
    59 
    60         /**
    61         * Destructor.
    62         */
    63         virtual ~MProEngAlertToneSeekerObserver() {}
    64 
    65     private: // Extension interface
    66 
    67         /**
    68         * This member is internal and not intended for use.
    69         */
    70         virtual MProEngAlertToneSeekerObserverExt* Extension() { return NULL; }
    71 
    72     };
    73 
    74 #endif      // MPROENGALERTTONESEEKEROBSERVER_H
    75 
    76 // End of File
    77