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