Mercurial Mercurial > oss > API_REF > Public_API / comparison
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
epoc32/include/hwrmvibrasdkcrkeys.h
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb 
     1 /*
 
     1 /*
 
     2 * Copyright (c) 2002-2007 Nokia Corporation and/or its subsidiary(-ies). 
     2 * Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
 
     3 * All rights reserved.
 
     3 * All rights reserved.
 
     4 * This component and the accompanying materials are made available
 
     4 * This component and the accompanying materials are made available
 
     5 * 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
 
     5 * under the terms of "Eclipse Public License v1.0"
 
     6 * which accompanies this distribution, and is available
 
     6 * which accompanies this distribution, and is available
 
     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
 
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
 
     8 *
 
     8 *
 
     9 * Initial Contributors:
 
     9 * Initial Contributors:
 
    10 * Nokia Corporation - initial contribution.
 
    10 * Nokia Corporation - initial contribution.
 
    11 *
 
    11 *
 
    12 * Contributors:
 
    12 * Contributors:
 
    13 *
 
    13 *
 
    14 * Description:  This file contains SDK central repository key definitions
 
    14 * Description:
 
    15 *                for the vibra
 
    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
 
    16 *
 
    28 *
 
    17 */
 
    29 */
 
    18 
    30 
       
    31 
       
    32 
       
    33 
       
    34 /**
 
       
    35  @file 
       
    36  @publishedAll
 
       
    37  @released
 
       
    38 */
 
    19 
    39 
    20 #ifndef HWRMVIBRASDKCRKEYS_H
 
    40 #ifndef HWRMVIBRASDKCRKEYS_H
 
    21 #define HWRMVIBRASDKCRKEYS_H
 
    41 #define HWRMVIBRASDKCRKEYS_H
 
    22 
    42 
    23 #include <e32std.h>
 
    43 #include <e32std.h>
 
    24 
    44 
    25 /** 
       
    26 * @file hwrmvibrasdkcrkeys.h
 
       
    27 * 
       
    28 * The API provides the vibra related Centrl Repository keys. 
       
    29 * These keys provide information on the vibra setting controlled by
 
       
    30 * Profiles, maximum vibrating time supported by the device and 
       
    31 * minimum time vibra cannot be started after it was forcibly 
       
    32 * turned off when maximum time was reached. In addition keys
 
       
    33 * provide tactile feedback setting controlled by profiles and 
       
    34 * default intensity and duration for feedback vibration.
 
       
    35 *
 
       
    36 * This interface relies on the Central Repository (CenRep) interface provided
 
       
    37 * by Symbian. 
       
    38 *
 
       
    39 * The CenRep UID is #KCRUidVibraCtrl and following keys are provided:
 
       
    40 * - #KVibraCtrlProfileVibraEnabled
 
       
    41 * - #KVibraCtrlMaxTime
 
       
    42 * - #KVibraMinOffTime
 
       
    43 */
 
       
    44 
       
    45 /**
 
    45 /**
 
    46 * CenRep UID for all vibra related settings keys provided by this API.
 
    46 * CenRep UID for all vibra related settings keys provided by this API.
 
       
    47 *
 
       
    48 * @publishedAll
 
       
    49 * @released
 
    47 */
 
    50 */
 
    48 const TUid KCRUidVibraCtrl = {0x10200C8B};
 
    51 const TUid KCRUidVibraCtrl = {0x10200C8B};
 
    49 
    52 
    50 /**
 
    53 /**
 
    51 * Vibra setting controlled by Profiles. 
    54 * Vibra setting controlled by profiles. 
    52 * 
    55 * 
    53 * Possible integer values:
 
    56 * Possible integer values:
 
    54 *
 
    57 *
 
    55 * 0 = Vibra is off in profile (default value) <br>
 
    58 * 0 = Vibra is off in profile (default value) <br>
 
    56 * 1 = Vibra is on in profile <br>
 
    59 * 1 = Vibra is on in profile <br>
 
       
    60 *
 
       
    61 * @publishedAll
 
       
    62 * @released
 
    57 */
 
    63 */
 
    58 const TUint32 KVibraCtrlProfileVibraEnabled     = 0x00000001;
 
    64 const TUint32 KVibraCtrlProfileVibraEnabled     = 0x00000001;
 
    59 
    65 
    60 /**
 
    66 /**
 
    61 * Maximum vibrating time supported by device. 
    67 * Maximum vibrating time supported by device. 
    65 * Maximum supported time is TMaxTInt microseconds in milliseconds.
 
    71 * Maximum supported time is TMaxTInt microseconds in milliseconds.
 
    66 *
 
    72 *
 
    67 * Value is read-only.
 
    73 * Value is read-only.
 
    68 *
 
    74 *
 
    69 * Default value: 10000.
 
    75 * Default value: 10000.
 
       
    76 *
 
       
    77 * @publishedAll
 
       
    78 * @released
 
    70 */
 
    79 */
 
    71 const TUint32 KVibraCtrlMaxTime                 = 0x00000002;
 
    80 const TUint32 KVibraCtrlMaxTime                 = 0x00000002;
 
    72 
    81 
    73 /**
 
    82 /**
 
    74 * Minimum time vibra cannot be started after it was
 
    83 * Minimum time vibra cannot be started after it was
 
    79 * Value is milliseconds as an integer.
 
    88 * Value is milliseconds as an integer.
 
    80 *
 
    89 *
 
    81 * Value is read-only.
 
    90 * Value is read-only.
 
    82 *
 
    91 *
 
    83 * Default value: 0
 
    92 * Default value: 0
 
       
    93 *
 
       
    94 * @publishedAll
 
       
    95 * @released
 
    84 */
 
    96 */
 
    85 const TUint32 KVibraMinOffTime                  = 0x00000003;
 
    97 const TUint32 KVibraMinOffTime                  = 0x00000003;
 
    86 
    98 
    87 /**
 
    99 /**
 
    88 * Tactile feedback setting controlled by Profiles. 
   100 * Tactile feedback setting controlled by Profiles. 
    89 * 
   101 * 
    90 * Possible integer values:
 
   102 * Possible integer values:
 
    91 *
 
   103 *
 
    92 * 0 = Tactile feedback is off in profile (default value) <br>
 
   104 * 0 = Tactile feedback is off in profile (default value) <br>
 
    93 * 1 = Tactile feedback is on in profile <br>
 
   105 * 1 = Tactile feedback is on in profile <br>
 
       
   106 *
 
       
   107 * @publishedAll
 
       
   108 * @released
 
    94 */
 
   109 */
 
    95 const TUint32 KVibraCtrlProfileFeedbackEnabled  = 0x00000004;
 
   110 const TUint32 KVibraCtrlProfileFeedbackEnabled  = 0x00000004;
 
    96 
   111 
    97 /**
 
   112 /**
 
    98 * Tactile feedback vibration default intensity. 
   113 * Tactile feedback vibration default intensity. 
   100 * Possible default intensity values are from the range -100...100.
 
   115 * Possible default intensity values are from the range -100...100.
 
   101 *
 
   116 *
 
   102 * Value is read-only.
 
   117 * Value is read-only.
 
   103 *
 
   118 *
 
   104 * Default value: 100
 
   119 * Default value: 100
 
       
   120 *
 
       
   121 * @publishedAll
 
       
   122 * @released
 
   105 */
 
   123 */
 
   106 const TUint32 KVibraCtrlFeedbackIntensity       = 0x00000005;
 
   124 const TUint32 KVibraCtrlFeedbackIntensity       = 0x00000005;
 
   107 
   125 
   108 /**
 
   126 /**
 
   109 * Tactile feedback vibration default duration. 
   127 * Tactile feedback vibration default duration. 
   111 * Value is milliseconds as an integer.
 
   129 * Value is milliseconds as an integer.
 
   112 *
 
   130 *
 
   113 * Value is read-only.
 
   131 * Value is read-only.
 
   114 *
 
   132 *
 
   115 * Default value: 20
 
   133 * Default value: 20
 
       
   134 *
 
       
   135 * @publishedAll
 
       
   136 * @released
 
   116 */
 
   137 */
 
   117 const TUint32 KVibraCtrlFeedbackDuration        = 0x00000006;
 
   138 const TUint32 KVibraCtrlFeedbackDuration        = 0x00000006;
 
       
   139 
   118 
   140 
   119 
   141 
   120 #endif  // HWRMVIBRASDKCRKEYS_H
 
   142 #endif  // HWRMVIBRASDKCRKEYS_H
 
   121             
   143             
   122 // End of File
 
   144 // End of File
API_REF/Public_API