epoc32/include/hwrmlogicalactuators.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     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 "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:  Enumerations of logical actuators and actuator events.
    15 *
    16 */
    17 
    18 
    19 #ifndef T_HWRMLOGICALACTUATORS_H
    20 #define T_HWRMLOGICALACTUATORS_H
    21 
    22 #include <e32std.h>
    23 
    24  /**
    25  * @enum THWRMLogicalActuators
    26  * 
    27  * Logical actuators types, that can be used for Haptics client objects.
    28  * Logical actuator is mapped to physical actuator according to
    29  * system configuration.
    30  */
    31 enum THWRMLogicalActuators
    32     {
    33     /**    
    34     * Client wants any kind of haptic feedback.
    35     */    
    36     EHWRMLogicalActuatorAny = 1, 
    37     
    38     /**
    39     * Client wants strong haptic feedback, which shakes the whole device.
    40     */ 
    41     EHWRMLogicalActuatorDevice = 2, 
    42     
    43     /**
    44     * Clients wants haptic feedback to primary display.
    45     */
    46     EHWRMLogicalActuatorPrimaryDisplay = 4, 
    47     
    48     /**
    49     * Clients wants haptic feedback to secondary display.
    50     */
    51     EHWRMLogicalActuatorSecondaryDisplay = 8, 
    52     
    53     /**
    54     * Clients wants haptic feedback for gaming.
    55     */
    56     EHWRMLogicalActuatorGame = 16, 
    57     
    58     /**
    59     * Clients wants haptic feedback for gaming on the left side of device.
    60     */
    61     EHWRMLogicalActuatorGameLeft = 32, 
    62     
    63     /**
    64     * Clients wants haptic feedback for gaming on the right side of device.
    65     */
    66     EHWRMLogicalActuatorGameRight = 64, 
    67     
    68     /** 
    69     * Clients wants haptic feedback for external actuator, e.g. USB actuator.
    70     */
    71     EHWRMLogicalActuatorExternalVibra = 128,  
    72     
    73     /** 
    74     * For sanity checks only e.g. when enumerating logical actuators.
    75     */
    76     EHWRMLogicalActuatorLast = 256
    77     };
    78 
    79 #endif // T_HWRMLOGICALACTUATORS_H