epoc32/include/hwrmvibrasdkcrkeys.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) 2006-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:
    15 * The API provides the vibra related Central Repository keys. 
    16 * These keys provide information on the vibra setting controlled by
    17 * profiles, maximum vibrating time supported by the device and 
    18 * minimum time vibra cannot be started after it was forcibly 
    19 * turned off when maximum time was reached. In addition keys
    20 * provide tactile feedback setting controlled by profiles and 
    21 * default intensity and duration for feedback vibration.
    22 * This interface relies on the Central Repository (CenRep) interface provided
    23 * by Symbian. 
    24 * The CenRep UID is KCRUidVibraCtrl and following keys are provided:
    25 * - KVibraCtrlProfileVibraEnabled
    26 * - KVibraCtrlMaxTime
    27 * - KVibraMinOffTime
    28 *
    29 */
    30 
    31 
    32 
    33 
    34 /**
    35  @file 
    36  @publishedAll
    37  @released
    38 */
    39 
    40 #ifndef HWRMVIBRASDKCRKEYS_H
    41 #define HWRMVIBRASDKCRKEYS_H
    42 
    43 #include <e32std.h>
    44 
    45 /**
    46 * CenRep UID for all vibra related settings keys provided by this API.
    47 *
    48 * @publishedAll
    49 * @released
    50 */
    51 const TUid KCRUidVibraCtrl = {0x10200C8B};
    52 
    53 /**
    54 * Vibra setting controlled by profiles. 
    55 * 
    56 * Possible integer values:
    57 *
    58 * 0 = Vibra is off in profile (default value) <br>
    59 * 1 = Vibra is on in profile <br>
    60 *
    61 * @publishedAll
    62 * @released
    63 */
    64 const TUint32 KVibraCtrlProfileVibraEnabled     = 0x00000001;
    65 
    66 /**
    67 * Maximum vibrating time supported by device. 
    68 * 
    69 * Value is milliseconds as an integer. 
    70 * If value is zero, no maximum time is supported.
    71 * Maximum supported time is TMaxTInt microseconds in milliseconds.
    72 *
    73 * Value is read-only.
    74 *
    75 * Default value: 10000.
    76 *
    77 * @publishedAll
    78 * @released
    79 */
    80 const TUint32 KVibraCtrlMaxTime                 = 0x00000002;
    81 
    82 /**
    83 * Minimum time vibra cannot be started after it was
    84 * forcibly turned off when maximum time was reached.
    85 * This can be used to enforce vibra cooling after long 
    86 * use periods.
    87 *
    88 * Value is milliseconds as an integer.
    89 *
    90 * Value is read-only.
    91 *
    92 * Default value: 0
    93 *
    94 * @publishedAll
    95 * @released
    96 */
    97 const TUint32 KVibraMinOffTime                  = 0x00000003;
    98 
    99 /**
   100 * Tactile feedback setting controlled by Profiles. 
   101 * 
   102 * Possible integer values:
   103 *
   104 * 0 = Tactile feedback is off in profile (default value) <br>
   105 * 1 = Tactile feedback is on in profile <br>
   106 *
   107 * @publishedAll
   108 * @released
   109 */
   110 const TUint32 KVibraCtrlProfileFeedbackEnabled  = 0x00000004;
   111 
   112 /**
   113 * Tactile feedback vibration default intensity. 
   114 * 
   115 * Possible default intensity values are from the range -100...100.
   116 *
   117 * Value is read-only.
   118 *
   119 * Default value: 100
   120 *
   121 * @publishedAll
   122 * @released
   123 */
   124 const TUint32 KVibraCtrlFeedbackIntensity       = 0x00000005;
   125 
   126 /**
   127 * Tactile feedback vibration default duration. 
   128 * 
   129 * Value is milliseconds as an integer.
   130 *
   131 * Value is read-only.
   132 *
   133 * Default value: 20
   134 *
   135 * @publishedAll
   136 * @released
   137 */
   138 const TUint32 KVibraCtrlFeedbackDuration        = 0x00000006;
   139 
   140 
   141 
   142 #endif  // HWRMVIBRASDKCRKEYS_H
   143             
   144 // End of File