1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2008-2010 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

     5 ** Contact: Nokia Corporation (developer.feedback@nokia.com)

     6 **

     7 ** This file is part of the HbCore module of the UI Extensions for Mobile.

     8 **

     9 ** GNU Lesser General Public License Usage

    10 ** This file may be used under the terms of the GNU Lesser General Public

    11 ** License version 2.1 as published by the Free Software Foundation and

    12 ** appearing in the file LICENSE.LGPL included in the packaging of this file.

    13 ** Please review the following information to ensure the GNU Lesser General

    14 ** Public License version 2.1 requirements will be met:

    15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    16 **

    17 ** In addition, as a special exception, Nokia gives you certain additional

    18 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    20 **

    21 ** If you have questions regarding the use of this file, please contact

    22 ** Nokia at developer.feedback@nokia.com.

    23 **

    24 ****************************************************************************/

    25 

    26 #include <hbfeedbacknamespace.h>

    27 

    28 /*!

    29     @hbcore

    30     \namespace HbFeedback

    31     \brief The HbFeedback namespace contains the feedback effects supported by the current haptic frawework.

    32 */

    33 

    34 /*!

    35     \enum HbFeedback::Type

    36     The supported feedback types.

    37 */

    38 

    39 /*! 

    40     \var HbFeedback::Type HbFeedback::TypeInstant

    41     Instant feedback.

    42 */

    43 

    44 /*! 

    45     \var HbFeedback::Type HbFeedback::TypeContinuous

    46     Continuous feedback.

    47 */

    48 

    49 /*!

    50     \enum HbFeedback::InstantEffect

    51 

    52     Instant feedback is fire&forget type of feedback which initiates a short haptic and/or sound 

    53     feedback effect. Each enumeration value corresponds to a certain instant feedback effect.

    54 

    55     \sa HbInstantFeedback

    56 */

    57 

    58 /*!

    59     \enum HbFeedback::ContinuousEffect

    60 

    61     Continuous feedback is a feedback type, which has to be explicitly started, updated and

    62     stopped by the framework and is used to provide ongoing feedback in situations in which

    63     the user is performing some longer duration touch interaction, e.g. dragging slider handle

    64     to change the slider value. Continuous feedback intensity can be updated during the playback 

    65     between values 0 and 100.

    66 

    67     \sa HbContinuousFeedback

    68 */

    69 

    70 /*!

    71     \enum HbFeedback::IntensityLevel

    72 

    73     A set of predefined values for continuous feedback intensity.

    74 

    75     \sa HbContinuousFeedback

    76 */

    77 

    78 /*!

    79     \enum HbFeedback::Modality

    80     

    81     The available modalities for feedback effects. Effects can be played using one or several 

    82     of the available modalities, e.g. haptic, audio.

    83 

    84     \sa HbInstantFeedback, HbContinuousFeedback

    85 */

    86 

    87 /*!

    88     HbFeedback::StandardFeedbackTimeout

    89 

    90     A timeout value has to be defined for each continuous feedback to avoid situations where 

    91     the continuous feedback is never stopped and unintentionally continues to play indefinetly.

    92 

    93     The recommended standard value is 300 milliseconds.

    94 

    95     \sa HbContinuousFeedback

    96 */