epoc32/include/hwrmlogicalactuators.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations

/*
* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies). 
* All rights reserved.
* This component and the accompanying materials are made available
* 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
* which accompanies this distribution, and is available
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:  Enumerations of logical actuators and actuator events.
*
*/


#ifndef T_HWRMLOGICALACTUATORS_H
#define T_HWRMLOGICALACTUATORS_H

#include <e32std.h>

 /**
 * @enum THWRMLogicalActuators
 * 
 * Logical actuators types, that can be used for Haptics client objects.
 * Logical actuator is mapped to physical actuator according to
 * system configuration.
 */
enum THWRMLogicalActuators
    {
    /**    
    * Client wants any kind of haptic feedback.
    */    
    EHWRMLogicalActuatorAny = 1, 
    
    /**
    * Client wants strong haptic feedback, which shakes the whole device.
    */ 
    EHWRMLogicalActuatorDevice = 2, 
    
    /**
    * Clients wants haptic feedback to primary display.
    */
    EHWRMLogicalActuatorPrimaryDisplay = 4, 
    
    /**
    * Clients wants haptic feedback to secondary display.
    */
    EHWRMLogicalActuatorSecondaryDisplay = 8, 
    
    /**
    * Clients wants haptic feedback for gaming.
    */
    EHWRMLogicalActuatorGame = 16, 
    
    /**
    * Clients wants haptic feedback for gaming on the left side of device.
    */
    EHWRMLogicalActuatorGameLeft = 32, 
    
    /**
    * Clients wants haptic feedback for gaming on the right side of device.
    */
    EHWRMLogicalActuatorGameRight = 64, 
    
    /** 
    * Clients wants haptic feedback for external actuator, e.g. USB actuator.
    */
    EHWRMLogicalActuatorExternalVibra = 128,  
    
    /** 
    * For sanity checks only e.g. when enumerating logical actuators.
    */
    EHWRMLogicalActuatorLast = 256
    };

#endif // T_HWRMLOGICALACTUATORS_H