1 /*

     2 * Copyright (c) 2008-2009 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:  Haptics plugin API commands

    15 *

    16 */

    17 

    18 #ifndef HWRMHAPTICSCOMMANDS_H

    19 #define HWRMHAPTICSCOMMANDS_H

    20 

    21 /*

    22 * ==============================================================================

    23 * This file contains the following sections:

    24 *   - Command definitions for Haptics plugin API

    25 *   - Command parameter definitions for Haptics plugin API

    26 *   - Response parameter definitions for Haptics plugin API

    27 * ==============================================================================

    28 */

    29 

    30 // Include plugin service so that including only 

    31 // this header is necessary to use Haptics plugin API.

    32    

    33 #include <hwrmhapticspluginservice.h>

    34 #include <hwrmhapticsrespdata.h>

    35 

    36 // use this constant while allocating max length for RHWRMHapticsRespData

    37 const TInt KHWRMHapticsRespMaxSize = 128;

    38 

    39 /**

    40 *  Encapsulates the Haptics command enumerations.

    41 *

    42 *  @since S60 5.1

    43 */

    44 namespace HWRMHapticsCommand

    45     {

    46     // request

    47     typedef RBuf8 RHWRMHapticsReqData;

    48 

    49     // response

    50     typedef RBuf8 RHWRMHapticsRespData; 

    51     

    52     /*

    53     * ========================================================================

    54     * Command definitions

    55     * All commands contain a command id and a set of parameters.

    56     * The set of parameters is internalized into a RHWRMHapticsReqData

    57     * descriptor.

    58     *

    59     * This interface is asynchronous. A command is interpreted of being 

    60     * completed after a response for that command is received.

    61     * The actual response data is internalized into a RHWRMHapticsRespData

    62     * descriptor.

    63     * ========================================================================

    64     */

    65     enum THapticsCmd

    66         {

    67         /**

    68          * Not a valid command Id. Used only for sanity checks.

    69          */

    70         ENoCommandId = 3000,

    71         /**

    72         * Haptics command id. Used for all haptics commands.

    73         */

    74         EHapticsCmdId 

    75         };

    76     }

    77 

    78 #endif      // HWRMHAPTICSCOMMANDS_H   

    79             

    80 // End of File