epoc32/include/hwrmhaptics.h
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
     1.1 --- a/epoc32/include/hwrmhaptics.h	Wed Mar 31 12:27:01 2010 +0100
     1.2 +++ b/epoc32/include/hwrmhaptics.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -2,9 +2,9 @@
     1.4  * Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies). 
     1.5  * All rights reserved.
     1.6  * This component and the accompanying materials are made available
     1.7 -* 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
     1.8 +* under the terms of "Eclipse Public License v1.0"
     1.9  * which accompanies this distribution, and is available
    1.10 -* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.12  *
    1.13  * Initial Contributors:
    1.14  * Nokia Corporation - initial contribution.
    1.15 @@ -95,11 +95,11 @@
    1.16   *
    1.17   * if( EHWRMLogicalActuatorDevice & suppAct )
    1.18   *     {
    1.19 - *     haptics->OpenActuatorL( EHWRMLogicalActuatorDevice )
    1.20 + *     haptics->OpenActuatorL( EHWRMLogicalActuatorDevice );
    1.21   *     }
    1.22   * else if ( EHWRMLogicalActuatorAny & suppAct )
    1.23   *     {
    1.24 - *     haptics->OpenActuatorL( EHWRMLogicalActuatorAny )
    1.25 + *     haptics->OpenActuatorL( EHWRMLogicalActuatorAny );
    1.26   *     }
    1.27   *
    1.28   *
    1.29 @@ -113,12 +113,12 @@
    1.30   *
    1.31   * // --> now playing effects is possible
    1.32   *
    1.33 - * THWRMHapticsPeriodicEffect periodicEff;
    1.34 + * CHWRMHaptics::THWRMHapticsPeriodicEffect periodicEff;
    1.35   *
    1.36   * periodicEff.iDuration = 5000;
    1.37   * periodicEff.iMagnitude = 5000;
    1.38   * periodicEff.iPeriod = minPeriod;
    1.39 - * periodicEff.iStyle = EHWRMHapticsStyleSharp;
    1.40 + * periodicEff.iStyle = CHWRMHaptics::EHWRMHapticsStyleSharp;
    1.41   * periodicEff.iAttackTime = 250;
    1.42   * periodicEff.iAttackLevel = 10000;
    1.43   * periodicEff.iFadeTime = 250;
    1.44 @@ -752,8 +752,8 @@
    1.45      * priority client succeeds in playing its effects.
    1.46      *
    1.47      * Calling this method is equal to call ReserveHapticsL(EFalse),
    1.48 -    * i.e. CCoeEnv background/foreground status is always used
    1.49 -    * to control further reservations.
    1.50 +    * i.e. foreground status is always used to control further reservations.
    1.51 +    * However, this is a future feature, and not implemented in current version.
    1.52      */
    1.53      virtual void ReserveHapticsL() = 0;
    1.54  
    1.55 @@ -773,7 +773,10 @@
    1.56      * Note also that even if haptics is reserved by some client, a higher 
    1.57      * priority client succeeds in playing its effects.
    1.58      *
    1.59 -    * @param aForceNoCCoeEnv If EFalse, then reservation requires that
    1.60 +    * @param aForceNoCCoeEnv (Note: This is a future feature, and not
    1.61 +    *                        implemented in current version.  You can think of
    1.62 +    *                        it ETrue always.)
    1.63 +    *                        If EFalse, then reservation requires that
    1.64      *                        this client has the keyboard focus at the time of
    1.65      *                        reservation and haptics is automatically
    1.66      *                        released and re-reserved based on the keyboard
    1.67 @@ -786,7 +789,8 @@
    1.68      *                        background status of the client. Only trusted
    1.69      *                        clients are allowed to set this flag to ETrue.
    1.70      *                        The client application is considered trusted if 
    1.71 -    *                it has a priority defined in haptics policy file.                              *                The policy files can be modified by S60 licensees.
    1.72 +    *                        it has a priority defined in haptics policy file. 
    1.73 +    *                        The policy files can be modified by S60 licensees. 
    1.74      *
    1.75      * @leave KErrAccessDenied Parameter aForceNoCCoeEnv is ETrue
    1.76      *                         and client is not trusted.