test: epoc32/include/hwrmhapticsobserver.h@2fe1408b6811

     1 /*

     2 * Copyright (c) 2008 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:  This file contains the header of the

    15 *                MHWRMHapticsObserver class.

    16 *

    17 */

    20 #ifndef M_HWRMHAPTICSOBSERVER_H

    21 #define M_HWRMHAPTICSOBSERVER_H

    23 #include <e32base.h>

    25 /**

    26 * MHWRMHapticsObserver observer class.

    27 *

    28 * A client should derive from this abstract class to receive haptics

    29 * status notifications and notification of effect completion.

    30 *

    31 * @since S60 5.1

    32 */

    33 class MHWRMHapticsObserver

    34     {

    35 public:

    37     /**

    38     * Haptics status.

    39     */

    40     enum THWRMHapticsStatus

    41         {

    42         /**

    43          * Haptics is available for the observing client.

    44          */

    45         EHWRMHapticsStatusAvailable = 0,

    47         /**

    48          * Haptics is reserved for another client. The client making

    49          * the active reservation does not receive this notification, but

    50          * a success code for the reservation command.

    51          */

    52         EHWRMHapticsStatusReserved,

    54         /**

    55          * Haptics has been suspended for this client. This occurs, when

    56          * another client with higher priority makes reservation for

    57          * haptics, or when this client is making reservation and haptics

    58          * has already been reserved for a client with higher priority.

    59          *

    60          * In suspended state, haptics effects are not played for the

    61          * suspended client, but other commands are executed as normal.

    62          */

    63         EHWRMHapticsStatusSuspended

    64         };

    66     /**

    67     * Called when the device's haptics feature state changes

    68     *

    69     * @param aStatus Indicates haptics status.

    70     *

    71     * @since S60 5.1

    72     *

    73     * @see CHWRMHaptics::THWRMHapticsStatus

    74     */

    75     virtual void HapticsStatusChangedL( THWRMHapticsStatus aStatus ) = 0;

    77     /**

    78     * Called when effect has completed playing.

    79     *

    80     * Method reserved for future use.

    81     *

    82     * @param aError Reason of completion.

    83     * @param aEffectHandle The associated effectHandle to the effect.

    84     *

    85     * @since S60 5.1

    86     */

    87     virtual void EffectCompletedL( TInt aError, TInt aEffectHandle ) = 0;

    88     };

    90 #endif // M_HWRMHAPTICSOBSERVER_H

author	William Roberts <williamr@symbian.org>
	Tue, 16 Mar 2010 16:12:26 +0000
branch	Symbian2
changeset 2	2fe1408b6811
child 4	837f303aceeb
permissions	-rw-r--r--