1 /*

     2 * Copyright (c) 2007 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:  MPX back stepping utility interface definition

    15 *

    16 */

    17 

    18  

    19 #ifndef MMPXBACKSTEPPINGUTILITY_H

    20 #define MMPXBACKSTEPPINGUTILITY_H

    21 

    22 

    23 // INCLUDES

    24 #include <e32base.h>

    25 

    26 const TInt KMPXBackSteppingNotConsumed = 0;

    27 const TInt KMPXBackSteppingConsumed = 1;

    28 

    29 

    30 // CLASS DECLARATION

    31 

    32 /**

    33  *  Music Player common utility interface

    34  *

    35  *  @lib mpxbacksteppingutility.lib

    36  */

    37 NONSHARABLE_CLASS( MMPXBackSteppingUtility )

    38     {

    39 public: 

    40 

    41     /**

    42      * Retrieve a back stepping utility of this thread.  All clients in this thread

    43      * shares the same utility (singleton)

    44      * Call Close() when this object is not needed anymore.

    45      *

    46      * @since S60 3.2

    47      * @return Pointer to backstepping utility. Ownership not transferred.

    48      */

    49     IMPORT_C static MMPXBackSteppingUtility* UtilityL();

    50 

    51     /**

    52      * This method must be called when this object can be freed. This object 

    53      * will be destroyed when no one is using it.

    54      *

    55      * @since S60 3.2

    56      */

    57     virtual void Close() = 0;

    58 

    59     /**

    60      * Forwards activation event.

    61      *

    62      * @since S60 3.2

    63      * @param aState state of application like view ids

    64      * @param aEnter indicate if it is entry/exit activation

    65      * @return result code retutned by BS Service interface

    66      * @leave leaves from HandleResultL are propagated

    67      */

    68     virtual TInt ForwardActivationEventL(

    69         const TDesC8& aState,

    70         const TBool aEnter ) = 0;

    71     

    72     /**

    73      * Handles back command.

    74      *

    75      * @since S60 3.2

    76      * @param aState state of application like view ids

    77      * @return result code retutned by BS Service interface

    78      * @leave leaves from HandleResultL are propagated

    79      */

    80     virtual TInt HandleBackCommandL( const TDesC8& aState ) = 0;

    81 

    82     /**

    83      * Initializes Backstepping Service.

    84      *

    85      * @since S60 3.2

    86      * @param aUid client application UID

    87      * @leave KErrNotSupported or KErrArgument 

    88      *        (if arguments passed to BS Service are incorrect 

    89      *        or could not initialize BS)

    90      *        KErrNotFound (if there was no return value)

    91      */

    92     virtual void InitializeL( const TUid aUid ) = 0;

    93     };

    94 

    95 #endif  // MMPXBACKSTEPPINGUTILITY_H

    96 

    97 // End of File