src/hbcore/feedback/hbfeedbacknamespace.cpp
author hgs
Mon, 18 Oct 2010 18:23:13 +0300
changeset 34 ed14f46c0e55
parent 2 06ff229162e9
permissions -rw-r--r--
201041
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     1
/****************************************************************************
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     2
**
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     3
** Copyright (C) 2008-2010 Nokia Corporation and/or its subsidiary(-ies).
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     4
** All rights reserved.
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     5
** Contact: Nokia Corporation (developer.feedback@nokia.com)
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     6
**
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     7
** This file is part of the HbCore module of the UI Extensions for Mobile.
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     8
**
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     9
** GNU Lesser General Public License Usage
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    10
** This file may be used under the terms of the GNU Lesser General Public
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    11
** License version 2.1 as published by the Free Software Foundation and
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    12
** appearing in the file LICENSE.LGPL included in the packaging of this file.
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    13
** Please review the following information to ensure the GNU Lesser General
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    14
** Public License version 2.1 requirements will be met:
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    15
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    16
**
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    17
** In addition, as a special exception, Nokia gives you certain additional
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    18
** rights.  These rights are described in the Nokia Qt LGPL Exception
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    19
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    20
**
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    21
** If you have questions regarding the use of this file, please contact
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    22
** Nokia at developer.feedback@nokia.com.
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    23
**
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    24
****************************************************************************/
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    25
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    26
#include <hbfeedbacknamespace.h>
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    27
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    28
/*!
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    29
    @hbcore
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    30
    \namespace HbFeedback
34
hgs
parents: 2
diff changeset
    31
    \brief The HbFeedback namespace defines the feedback effects supported
hgs
parents: 2
diff changeset
    32
    by the current feedback framework.
hgs
parents: 2
diff changeset
    33
    
hgs
parents: 2
diff changeset
    34
    As a widget developer, you may want to give feedback to the user
hgs
parents: 2
diff changeset
    35
    corresponding to how the user interacts with the device. Feedback can
hgs
parents: 2
diff changeset
    36
    be given using different modalities supported on the device, such as
hgs
parents: 2
diff changeset
    37
    tactile, audio, or visual. Tactile feedback is feedback that is 'felt'
hgs
parents: 2
diff changeset
    38
    by the user, for example vibration of the device. Extra visual feedback,
hgs
parents: 2
diff changeset
    39
    in addition to the user interface changes on the screen, can be flashing
hgs
parents: 2
diff changeset
    40
    the screen or switching extra lights on the device on or off. The feedback
hgs
parents: 2
diff changeset
    41
    mechanism of the device can be further extended by implementing other
hgs
parents: 2
diff changeset
    42
    modality plug-ins (see HbFeedbackEffectPlugin).
hgs
parents: 2
diff changeset
    43
    
2
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    44
*/
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    45
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    46
/*!
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    47
    \enum HbFeedback::Type
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    48
    The supported feedback types.
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    49
*/
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    50
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    51
/*! 
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    52
    \var HbFeedback::Type HbFeedback::TypeInstant
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    53
    Instant feedback.
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    54
*/
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    55
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    56
/*! 
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    57
    \var HbFeedback::Type HbFeedback::TypeContinuous
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    58
    Continuous feedback.
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    59
*/
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    60
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    61
/*!
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    62
    \enum HbFeedback::InstantEffect
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    63
34
hgs
parents: 2
diff changeset
    64
    Instant feedback is a fire-and-forget type of feedback which initiates a short
hgs
parents: 2
diff changeset
    65
    tactile and/or sound feedback effect. Each enumeration value corresponds
hgs
parents: 2
diff changeset
    66
    to a certain instant feedback effect.
hgs
parents: 2
diff changeset
    67
    
hgs
parents: 2
diff changeset
    68
    For many standard instant effects, there is both a 'basic' and 'sensitive'
hgs
parents: 2
diff changeset
    69
    version. The sensitive feedback effect is for situations where the triggering
hgs
parents: 2
diff changeset
    70
    action is not important, or where there can be a large number of feedback
hgs
parents: 2
diff changeset
    71
    instances within a short time. An example of a less important touch event is
hgs
parents: 2
diff changeset
    72
    when the focus is changed in a list, while an example of a situation where
hgs
parents: 2
diff changeset
    73
    lots of events could be triggered is when the device user selects text and
hgs
parents: 2
diff changeset
    74
    feedback is given for every character selected.
2
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    75
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    76
    \sa HbInstantFeedback
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    77
*/
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    78
34
hgs
parents: 2
diff changeset
    79
/*! 
hgs
parents: 2
diff changeset
    80
    \var HbFeedback::InstantEffect HbFeedback::None
hgs
parents: 2
diff changeset
    81
    No valid instant effect defined.
hgs
parents: 2
diff changeset
    82
*/
hgs
parents: 2
diff changeset
    83
hgs
parents: 2
diff changeset
    84
/*! 
hgs
parents: 2
diff changeset
    85
    \var HbFeedback::InstantEffect HbFeedback::Basic
hgs
parents: 2
diff changeset
    86
    Basic generic instant feedback for custom widget interaction.
hgs
parents: 2
diff changeset
    87
*/
hgs
parents: 2
diff changeset
    88
hgs
parents: 2
diff changeset
    89
/*! 
hgs
parents: 2
diff changeset
    90
    \var HbFeedback::InstantEffect HbFeedback::Sensitive
hgs
parents: 2
diff changeset
    91
    Sensitive generic instant feedback for custom widget interaction.
hgs
parents: 2
diff changeset
    92
*/
hgs
parents: 2
diff changeset
    93
hgs
parents: 2
diff changeset
    94
/*! 
hgs
parents: 2
diff changeset
    95
    \var HbFeedback::InstantEffect HbFeedback::BasicButton
hgs
parents: 2
diff changeset
    96
    Basic instant feedback for button interaction.
hgs
parents: 2
diff changeset
    97
*/
hgs
parents: 2
diff changeset
    98
hgs
parents: 2
diff changeset
    99
/*! 
hgs
parents: 2
diff changeset
   100
    \var HbFeedback::InstantEffect HbFeedback::SensitiveButton
hgs
parents: 2
diff changeset
   101
    Sensitive instant feedback for button interaction.
hgs
parents: 2
diff changeset
   102
*/
hgs
parents: 2
diff changeset
   103
hgs
parents: 2
diff changeset
   104
/*! 
hgs
parents: 2
diff changeset
   105
    \var HbFeedback::InstantEffect HbFeedback::BasicKeypad
hgs
parents: 2
diff changeset
   106
    Basic instant feedback for keypad interaction.
hgs
parents: 2
diff changeset
   107
*/
hgs
parents: 2
diff changeset
   108
hgs
parents: 2
diff changeset
   109
/*! 
hgs
parents: 2
diff changeset
   110
    \var HbFeedback::InstantEffect HbFeedback::SensitiveKeypad
hgs
parents: 2
diff changeset
   111
    Sensitive instant feedback for keypad interaction.
hgs
parents: 2
diff changeset
   112
*/
hgs
parents: 2
diff changeset
   113
hgs
parents: 2
diff changeset
   114
/*! 
hgs
parents: 2
diff changeset
   115
    \var HbFeedback::InstantEffect HbFeedback::BasicSlider
hgs
parents: 2
diff changeset
   116
    Basic instant feedback for moving the slider.
hgs
parents: 2
diff changeset
   117
*/
hgs
parents: 2
diff changeset
   118
hgs
parents: 2
diff changeset
   119
/*! 
hgs
parents: 2
diff changeset
   120
    \var HbFeedback::InstantEffect HbFeedback::SensitiveSlider
hgs
parents: 2
diff changeset
   121
    Sensitive instant feedback for moving the slider.
hgs
parents: 2
diff changeset
   122
*/
hgs
parents: 2
diff changeset
   123
hgs
parents: 2
diff changeset
   124
/*! 
hgs
parents: 2
diff changeset
   125
    \var HbFeedback::InstantEffect HbFeedback::BasicItem
hgs
parents: 2
diff changeset
   126
    Basic instant feedback for interacting with an item view item
hgs
parents: 2
diff changeset
   127
    (for example, a list or grid view item).
hgs
parents: 2
diff changeset
   128
*/
hgs
parents: 2
diff changeset
   129
hgs
parents: 2
diff changeset
   130
/*! 
hgs
parents: 2
diff changeset
   131
    \var HbFeedback::InstantEffect HbFeedback::SensitiveItem
hgs
parents: 2
diff changeset
   132
    Sensitive instant feedback for interacting with an item view item
hgs
parents: 2
diff changeset
   133
    (for example, a list or grid view item).
hgs
parents: 2
diff changeset
   134
*/
hgs
parents: 2
diff changeset
   135
hgs
parents: 2
diff changeset
   136
/*! 
hgs
parents: 2
diff changeset
   137
    \var HbFeedback::InstantEffect HbFeedback::ItemScroll
hgs
parents: 2
diff changeset
   138
    Instant feedback for scrolling an item view.
hgs
parents: 2
diff changeset
   139
*/
hgs
parents: 2
diff changeset
   140
hgs
parents: 2
diff changeset
   141
/*! 
hgs
parents: 2
diff changeset
   142
    \var HbFeedback::InstantEffect HbFeedback::ItemPick
hgs
parents: 2
diff changeset
   143
    Instant feedback for picking an item in an arrange mode.
hgs
parents: 2
diff changeset
   144
*/
hgs
parents: 2
diff changeset
   145
hgs
parents: 2
diff changeset
   146
/*! 
hgs
parents: 2
diff changeset
   147
    \var HbFeedback::InstantEffect HbFeedback::ItemDrop
hgs
parents: 2
diff changeset
   148
    Instant feedback for dropping an item in an arrange mode.
hgs
parents: 2
diff changeset
   149
*/
hgs
parents: 2
diff changeset
   150
hgs
parents: 2
diff changeset
   151
/*! 
hgs
parents: 2
diff changeset
   152
    \var HbFeedback::InstantEffect HbFeedback::ItemMoveOver
hgs
parents: 2
diff changeset
   153
    Instant feedback for moving an item in an arrange mode.
hgs
parents: 2
diff changeset
   154
*/
hgs
parents: 2
diff changeset
   155
hgs
parents: 2
diff changeset
   156
/*! 
hgs
parents: 2
diff changeset
   157
    \var HbFeedback::InstantEffect HbFeedback::BounceEffect
hgs
parents: 2
diff changeset
   158
    Instant feedback for a bounce effect.
hgs
parents: 2
diff changeset
   159
*/
hgs
parents: 2
diff changeset
   160
hgs
parents: 2
diff changeset
   161
/*! 
hgs
parents: 2
diff changeset
   162
    \var HbFeedback::InstantEffect HbFeedback::Checkbox
hgs
parents: 2
diff changeset
   163
    Instant feedback for selecting a checkbox item.
hgs
parents: 2
diff changeset
   164
*/
hgs
parents: 2
diff changeset
   165
hgs
parents: 2
diff changeset
   166
/*! 
hgs
parents: 2
diff changeset
   167
    \var HbFeedback::InstantEffect HbFeedback::MultipleCheckbox
hgs
parents: 2
diff changeset
   168
    Instant feedback for selecting multiple checkbox items.
hgs
parents: 2
diff changeset
   169
*/
hgs
parents: 2
diff changeset
   170
hgs
parents: 2
diff changeset
   171
/*! 
hgs
parents: 2
diff changeset
   172
    \var HbFeedback::InstantEffect HbFeedback::Editor
hgs
parents: 2
diff changeset
   173
    Instant feedback for generic editor interaction, for example
hgs
parents: 2
diff changeset
   174
    when the editor gets focus.
hgs
parents: 2
diff changeset
   175
*/
hgs
parents: 2
diff changeset
   176
hgs
parents: 2
diff changeset
   177
/*! 
hgs
parents: 2
diff changeset
   178
    \var HbFeedback::InstantEffect HbFeedback::TextSelection
hgs
parents: 2
diff changeset
   179
    Instant feedback for selecting text.
hgs
parents: 2
diff changeset
   180
*/
hgs
parents: 2
diff changeset
   181
hgs
parents: 2
diff changeset
   182
/*! 
hgs
parents: 2
diff changeset
   183
    \var HbFeedback::InstantEffect HbFeedback::BlankSelection
hgs
parents: 2
diff changeset
   184
    Instant feedback for a blank selection.
hgs
parents: 2
diff changeset
   185
*/
hgs
parents: 2
diff changeset
   186
hgs
parents: 2
diff changeset
   187
/*! 
hgs
parents: 2
diff changeset
   188
    \var HbFeedback::InstantEffect HbFeedback::LineSelection
hgs
parents: 2
diff changeset
   189
    Instant feedback for selecting a line.
hgs
parents: 2
diff changeset
   190
*/
hgs
parents: 2
diff changeset
   191
hgs
parents: 2
diff changeset
   192
/*! 
hgs
parents: 2
diff changeset
   193
    \var HbFeedback::InstantEffect HbFeedback::EmptyLineSelection
hgs
parents: 2
diff changeset
   194
    Instant feedback for selecting an empty line.
hgs
parents: 2
diff changeset
   195
*/
hgs
parents: 2
diff changeset
   196
hgs
parents: 2
diff changeset
   197
/*! 
hgs
parents: 2
diff changeset
   198
    \var HbFeedback::InstantEffect HbFeedback::PopUp
hgs
parents: 2
diff changeset
   199
    Instant feedback for a generic popup interaction.
hgs
parents: 2
diff changeset
   200
*/
hgs
parents: 2
diff changeset
   201
hgs
parents: 2
diff changeset
   202
/*! 
hgs
parents: 2
diff changeset
   203
    \var HbFeedback::InstantEffect HbFeedback::PopupOpen
hgs
parents: 2
diff changeset
   204
    Instant feedback for opening a popup.
hgs
parents: 2
diff changeset
   205
*/
hgs
parents: 2
diff changeset
   206
hgs
parents: 2
diff changeset
   207
/*! 
hgs
parents: 2
diff changeset
   208
    \var HbFeedback::InstantEffect HbFeedback::PopupClose
hgs
parents: 2
diff changeset
   209
    Instant feedback for closing a popup.
hgs
parents: 2
diff changeset
   210
*/
hgs
parents: 2
diff changeset
   211
hgs
parents: 2
diff changeset
   212
/*! 
hgs
parents: 2
diff changeset
   213
    \var HbFeedback::InstantEffect HbFeedback::Flick
hgs
parents: 2
diff changeset
   214
    Instant feedback at the start of a flick (swipe) gesture.
hgs
parents: 2
diff changeset
   215
*/
hgs
parents: 2
diff changeset
   216
hgs
parents: 2
diff changeset
   217
/*! 
hgs
parents: 2
diff changeset
   218
    \var HbFeedback::InstantEffect HbFeedback::StopFlick
hgs
parents: 2
diff changeset
   219
    Instant feedback when the user stops a flick (swipe) gesture
hgs
parents: 2
diff changeset
   220
    by tapping the scroll item view.
hgs
parents: 2
diff changeset
   221
*/
hgs
parents: 2
diff changeset
   222
hgs
parents: 2
diff changeset
   223
/*! 
hgs
parents: 2
diff changeset
   224
    \var HbFeedback::InstantEffect HbFeedback::AdvancedGestureActivate
hgs
parents: 2
diff changeset
   225
    Instant feedback when a touch gesture with more than one finger is activated:
hgs
parents: 2
diff changeset
   226
    a second touch point is detected and a pinch gesture (for example zooming)
hgs
parents: 2
diff changeset
   227
    is likely to follow.
hgs
parents: 2
diff changeset
   228
*/
hgs
parents: 2
diff changeset
   229
hgs
parents: 2
diff changeset
   230
/*! 
hgs
parents: 2
diff changeset
   231
    \var HbFeedback::InstantEffect HbFeedback::RotateStep
hgs
parents: 2
diff changeset
   232
    Instant feedback for a rotation step.
hgs
parents: 2
diff changeset
   233
*/
hgs
parents: 2
diff changeset
   234
hgs
parents: 2
diff changeset
   235
/*! 
hgs
parents: 2
diff changeset
   236
    \var HbFeedback::InstantEffect HbFeedback::LongPress
hgs
parents: 2
diff changeset
   237
    Instant feedback for a long press (tap-and-hold) gesture.
hgs
parents: 2
diff changeset
   238
*/
hgs
parents: 2
diff changeset
   239
hgs
parents: 2
diff changeset
   240
/*! 
hgs
parents: 2
diff changeset
   241
    \var HbFeedback::InstantEffect HbFeedback::PositiveTacticon
hgs
parents: 2
diff changeset
   242
    Instant feedback for a notification of a successful action.
hgs
parents: 2
diff changeset
   243
*/
hgs
parents: 2
diff changeset
   244
hgs
parents: 2
diff changeset
   245
/*! 
hgs
parents: 2
diff changeset
   246
    \var HbFeedback::InstantEffect HbFeedback::NeutralTacticon
hgs
parents: 2
diff changeset
   247
    Instant feedback for a notification.
hgs
parents: 2
diff changeset
   248
*/
hgs
parents: 2
diff changeset
   249
hgs
parents: 2
diff changeset
   250
/*! 
hgs
parents: 2
diff changeset
   251
    \var HbFeedback::InstantEffect HbFeedback::NegativeTacticon
hgs
parents: 2
diff changeset
   252
    Instant feedback for a notification of a failed action.
hgs
parents: 2
diff changeset
   253
*/
hgs
parents: 2
diff changeset
   254
hgs
parents: 2
diff changeset
   255
/*! 
hgs
parents: 2
diff changeset
   256
    \var HbFeedback::InstantEffect HbFeedback::NumberOfInstantFeedbacks
hgs
parents: 2
diff changeset
   257
    Used by the internal framework to keep track of the number of
hgs
parents: 2
diff changeset
   258
    standard instant effects.
hgs
parents: 2
diff changeset
   259
*/
hgs
parents: 2
diff changeset
   260
hgs
parents: 2
diff changeset
   261
/*! 
hgs
parents: 2
diff changeset
   262
    \var HbFeedback::InstantEffect HbFeedback::InstantUser
hgs
parents: 2
diff changeset
   263
    Start value for the range of custom instant effects.
hgs
parents: 2
diff changeset
   264
*/
hgs
parents: 2
diff changeset
   265
hgs
parents: 2
diff changeset
   266
/*! 
hgs
parents: 2
diff changeset
   267
    \var HbFeedback::InstantEffect HbFeedback::InstantMaxUser
hgs
parents: 2
diff changeset
   268
    End value for the range of custom instant effects.
hgs
parents: 2
diff changeset
   269
*/
hgs
parents: 2
diff changeset
   270
2
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   271
/*!
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   272
    \enum HbFeedback::ContinuousEffect
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   273
34
hgs
parents: 2
diff changeset
   274
    Continuous feedback is a feedback type that you can use to provide
hgs
parents: 2
diff changeset
   275
    ongoing feedback in situations where the user is performing some
hgs
parents: 2
diff changeset
   276
    longer duration touch interaction, such as dragging a slider handle
hgs
parents: 2
diff changeset
   277
    to change the slider value. You need to explicitly start and stop
hgs
parents: 2
diff changeset
   278
    a continuous feedback effect. You can update continuous feedback intensity
hgs
parents: 2
diff changeset
   279
    during the playback between values 0 and 100 with HbContinuousFeedback::setIntensity().
hgs
parents: 2
diff changeset
   280
    The feedback framework uses HbFeedback::ContinuousEffect for its
hgs
parents: 2
diff changeset
   281
    internal purposes as well, and it will also stop any continuous feedback
hgs
parents: 2
diff changeset
   282
    playback when a timeout occurs.
2
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   283
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   284
    \sa HbContinuousFeedback
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   285
*/
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   286
34
hgs
parents: 2
diff changeset
   287
/*! 
hgs
parents: 2
diff changeset
   288
    \var HbFeedback::ContinuousEffect HbFeedback::ContinuousNone
hgs
parents: 2
diff changeset
   289
    No valid continuous effect defined.
hgs
parents: 2
diff changeset
   290
*/
hgs
parents: 2
diff changeset
   291
hgs
parents: 2
diff changeset
   292
/*! 
hgs
parents: 2
diff changeset
   293
    \var HbFeedback::ContinuousEffect HbFeedback::ContinuousSmooth
hgs
parents: 2
diff changeset
   294
    Generic continuous feedback for custom widget interaction.
hgs
parents: 2
diff changeset
   295
*/
hgs
parents: 2
diff changeset
   296
hgs
parents: 2
diff changeset
   297
/*! 
hgs
parents: 2
diff changeset
   298
    \var HbFeedback::ContinuousEffect HbFeedback::ContinuousSlider
hgs
parents: 2
diff changeset
   299
    Continuous feedback for dragging the slider.
hgs
parents: 2
diff changeset
   300
*/
hgs
parents: 2
diff changeset
   301
hgs
parents: 2
diff changeset
   302
/*! 
hgs
parents: 2
diff changeset
   303
    \var HbFeedback::ContinuousEffect HbFeedback::ContinuousPopup
hgs
parents: 2
diff changeset
   304
    Continuous feedback for popup interaction.
hgs
parents: 2
diff changeset
   305
*/
hgs
parents: 2
diff changeset
   306
hgs
parents: 2
diff changeset
   307
/*! 
hgs
parents: 2
diff changeset
   308
    \var HbFeedback::ContinuousEffect HbFeedback::ContinuousInput
hgs
parents: 2
diff changeset
   309
    Continuous feedback for giving input.
hgs
parents: 2
diff changeset
   310
*/
hgs
parents: 2
diff changeset
   311
hgs
parents: 2
diff changeset
   312
/*! 
hgs
parents: 2
diff changeset
   313
    \var HbFeedback::ContinuousEffect HbFeedback::ContinuousPinch
hgs
parents: 2
diff changeset
   314
    Continuous feedback for a pinch gesture.
hgs
parents: 2
diff changeset
   315
*/
hgs
parents: 2
diff changeset
   316
hgs
parents: 2
diff changeset
   317
/*! 
hgs
parents: 2
diff changeset
   318
    \var HbFeedback::ContinuousEffect HbFeedback::NumberOfContinuousFeedbacks
hgs
parents: 2
diff changeset
   319
    Used by the internal framework to keep track of the number of
hgs
parents: 2
diff changeset
   320
    standard continuous effects.
hgs
parents: 2
diff changeset
   321
*/
hgs
parents: 2
diff changeset
   322
hgs
parents: 2
diff changeset
   323
/*! 
hgs
parents: 2
diff changeset
   324
    \var HbFeedback::ContinuousEffect HbFeedback::ContinuousUser
hgs
parents: 2
diff changeset
   325
    Start value for the range of custom continuous effects.
hgs
parents: 2
diff changeset
   326
*/
hgs
parents: 2
diff changeset
   327
hgs
parents: 2
diff changeset
   328
/*! 
hgs
parents: 2
diff changeset
   329
    \var HbFeedback::ContinuousEffect HbFeedback::ContinuousMaxUser
hgs
parents: 2
diff changeset
   330
    End value for the range of custom continuous effects.
hgs
parents: 2
diff changeset
   331
*/
hgs
parents: 2
diff changeset
   332
hgs
parents: 2
diff changeset
   333
2
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   334
/*!
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   335
    \enum HbFeedback::IntensityLevel
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   336
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   337
    A set of predefined values for continuous feedback intensity.
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   338
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   339
    \sa HbContinuousFeedback
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   340
*/
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   341
34
hgs
parents: 2
diff changeset
   342
/*! 
hgs
parents: 2
diff changeset
   343
    \var HbFeedback::IntensityLevel HbFeedback::IntensityZero
hgs
parents: 2
diff changeset
   344
    Minimum intensity, 0.
hgs
parents: 2
diff changeset
   345
*/
hgs
parents: 2
diff changeset
   346
hgs
parents: 2
diff changeset
   347
/*! 
hgs
parents: 2
diff changeset
   348
    \var HbFeedback::IntensityLevel HbFeedback::IntensitySmooth
hgs
parents: 2
diff changeset
   349
    Medium intensity, 50.
hgs
parents: 2
diff changeset
   350
*/
hgs
parents: 2
diff changeset
   351
hgs
parents: 2
diff changeset
   352
/*! 
hgs
parents: 2
diff changeset
   353
    \var HbFeedback::IntensityLevel HbFeedback::IntensityFull
hgs
parents: 2
diff changeset
   354
    Maximum intensity, 100.
hgs
parents: 2
diff changeset
   355
*/
hgs
parents: 2
diff changeset
   356
2
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   357
/*!
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   358
    \enum HbFeedback::Modality
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   359
    
34
hgs
parents: 2
diff changeset
   360
    The available modalities for feedback effects. The currently supported
hgs
parents: 2
diff changeset
   361
    modalities are audio and tactile. Effects can be played using both
hgs
parents: 2
diff changeset
   362
    modalities or only one of them.
hgs
parents: 2
diff changeset
   363
hgs
parents: 2
diff changeset
   364
    \sa HbAbstractFeedback
hgs
parents: 2
diff changeset
   365
*/
2
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   366
34
hgs
parents: 2
diff changeset
   367
/*! 
hgs
parents: 2
diff changeset
   368
    \var HbFeedback::Modality HbFeedback::All
hgs
parents: 2
diff changeset
   369
    All available modalities.
hgs
parents: 2
diff changeset
   370
*/
hgs
parents: 2
diff changeset
   371
hgs
parents: 2
diff changeset
   372
/*! 
hgs
parents: 2
diff changeset
   373
    \var HbFeedback::Modality HbFeedback::Audio
hgs
parents: 2
diff changeset
   374
    Audio modality.
hgs
parents: 2
diff changeset
   375
*/
hgs
parents: 2
diff changeset
   376
hgs
parents: 2
diff changeset
   377
/*! 
hgs
parents: 2
diff changeset
   378
    \var HbFeedback::Modality HbFeedback::Tactile
hgs
parents: 2
diff changeset
   379
    Tactile modality.
2
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   380
*/
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   381
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   382
/*!
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   383
    HbFeedback::StandardFeedbackTimeout
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   384
34
hgs
parents: 2
diff changeset
   385
    A timeout value has to be defined for each continuous feedback to avoid
hgs
parents: 2
diff changeset
   386
    situations where the continuous feedback is never stopped and unintentionally
hgs
parents: 2
diff changeset
   387
    continues to play indefinitely.
2
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   388
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   389
    The recommended standard value is 300 milliseconds.
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   390
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   391
    \sa HbContinuousFeedback
06ff229162e9 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   392
*/