Support tactile feeedback from QS60Style for QWidgets

Currently tactile feedback is not given for QWidgets running on Symbian
even if the native side supports this (Sym^3 and 5th Edition devices).

This task adds support for QWidgets having QS60Style. The tactile
feedback has been implemented as a plugin that the style loads when
instantiating itself for touch devices. NOTE that the feedback
is NOT supported by the emulated style, nor is the plugin interface
public, so it cannot be used outside of style.

The implementation is simplistic, since we only want to provide
stop-gap solution until 4.8 when real Qt feedback implementation
is ready. The implementation will only give feedback for touch-down
events for visible, interactive and enabled widgets. Sliders and
scrollbars will use sensitive feedback (slightly less aggressive)
and all others will use basic feedback. Note that Sym^3 adds tens
of different feedback categories, which this plugin ignores
as we want to share the same implementation for Sym^3 and 5th ed.

In distributed Qt package there is no tactile feedback for 5th edition,
due to package creation limitations. Support can be added manually by
re-compiling Qt on top of 5th Edition SDK.

Task-number: QT-4037
Reviewed-by: Jani Hautakangas
Reviewed-by: Janne Koskinen

10 files changed, 249 insertions, 2 deletions

diff --git a/src/gui/styles/qs60style.cpp b/src/gui/styles/qs60style.cpp
index ca3a9d0..d39a2ba 100644
--- a/src/gui/styles/qs60style.cpp
+++ b/src/gui/styles/qs60style.cpp
@@ -3424,8 +3424,11 @@ bool QS60Style::eventFilter(QObject *object, QEvent *event)
                         qobject_cast<QCheckBox *>(w))
                     d->m_pressedWidget = w;
 
-                if ( d->m_pressedWidget)
+                if (d->m_pressedWidget)
                     d->m_pressedWidget->update();
+#ifdef Q_WS_S60
+                d->touchFeedback(event, w);
+#endif
             }
             break;
         }
diff --git a/src/gui/styles/qs60style_feedbackinterface_p.h b/src/gui/styles/qs60style_feedbackinterface_p.h
new file mode 100644
index 0000000..81fcdc3
--- /dev/null
+++ b/src/gui/styles/qs60style_feedbackinterface_p.h
@@ -0,0 +1,50 @@
+/****************************************************************************
+**
+** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the QtGui module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights.  These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QObject>
+
+class TactileFeedbackInterface : public QObject
+{
+    public:
+        virtual void touchFeedback(QEvent *event, const QWidget *widget) = 0;
+};
+
+Q_DECLARE_INTERFACE(TactileFeedbackInterface, "com.trolltech.Qt.TactileFeedbackInterface/1.0")
diff --git a/src/gui/styles/qs60style_p.h b/src/gui/styles/qs60style_p.h
index b3f4160..b46f75e 100644
--- a/src/gui/styles/qs60style_p.h
+++ b/src/gui/styles/qs60style_p.h
@@ -387,6 +387,7 @@ private: //data members
 class QFocusFrame;
 class QProgressBar;
 class QS60StyleAnimation;
+class TactileFeedbackInterface;
 
 // Private class
 #ifdef Q_OS_SYMBIAN
@@ -572,6 +573,8 @@ public:
     void stopAnimation(QS60StyleEnums::SkinParts animation);
     static QS60StyleAnimation* animationDefinition(QS60StyleEnums::SkinParts part);
     static void removeAnimations();
+    //No support for tactile feedback in emulated style
+    void touchFeedback(QEvent *event, const QWidget *widget);
 
 #endif
 
@@ -626,6 +629,7 @@ private:
 #ifdef Q_WS_S60
     //list of progress bars having animation running
     QList<QProgressBar *> m_bars;
+    TactileFeedbackInterface *m_feedbackPlugin;
 #endif
 
 };
diff --git a/src/gui/styles/qs60style_s60.cpp b/src/gui/styles/qs60style_s60.cpp
index 5dda42e..a1ea308 100644
--- a/src/gui/styles/qs60style_s60.cpp
+++ b/src/gui/styles/qs60style_s60.cpp
@@ -49,6 +49,10 @@
 #include "private/qcore_symbian_p.h"
 #include "qapplication.h"
 
+#include "qpluginloader.h"
+#include "qlibraryinfo.h"
+#include "private/qs60style_feedbackinterface_p.h"
+
 #include <w32std.h>
 #include <AknsConstants.h>
 #include <aknconsts.h>
@@ -1143,13 +1147,25 @@ void QS60StylePrivate::setActiveLayout()
 
 Q_GLOBAL_STATIC(QList<QS60StyleAnimation *>, m_animations)
 
-QS60StylePrivate::QS60StylePrivate()
+QS60StylePrivate::QS60StylePrivate() : m_feedbackPlugin(0)
 {
     //Animation defaults need to be created when style is instantiated
     QS60StyleAnimation* progressBarAnimation = new QS60StyleAnimation(QS60StyleEnums::SP_QgnGrafBarWaitAnim, 7, 100);
     m_animations()->append(progressBarAnimation);
     // No need to set active layout, if dynamic metrics API is available
     setActiveLayout();
+
+    //Tactile feedback plugin is only available for touch devices.
+    if (isTouchSupported()) {
+        QString pluginsPath = QLibraryInfo::location(QLibraryInfo::PluginsPath);
+        pluginsPath += QLatin1String("/feedback/qtactilefeedback.dll");
+
+        // Create plugin loader
+        QPluginLoader pluginLoader(pluginsPath);
+        // Load plugin and store pointer to the plugin implementation
+        if (pluginLoader.load())
+            m_feedbackPlugin = qobject_cast<TactileFeedbackInterface*>(pluginLoader.instance());
+    }
 }
 
 void QS60StylePrivate::removeAnimations()
@@ -1439,6 +1455,12 @@ void QS60StylePrivate::stopAnimation(QS60StyleEnums::SkinParts animationPart)
     }
 }
 
+void QS60StylePrivate::touchFeedback(QEvent *event, const QWidget *widget)
+{
+    if (m_feedbackPlugin)
+        m_feedbackPlugin->touchFeedback(event, widget);
+}
+
 QVariant QS60StyleModeSpecifics::themeDefinition(
     QS60StyleEnums::ThemeDefinitions definition, QS60StyleEnums::SkinParts part)
 {
diff --git a/src/plugins/s60/feedback/feedback.pro b/src/plugins/s60/feedback/feedback.pro
new file mode 100644
index 0000000..32ddf6f
--- /dev/null
+++ b/src/plugins/s60/feedback/feedback.pro
@@ -0,0 +1,16 @@
+include(../../qpluginbase.pri)
+
+TARGET = qtactilefeedback$${QT_LIBINFIX}
+
+INCLUDEPATH += $$APP_LAYER_SYSTEMINCLUDE
+
+contains(S60_VERSION, 5.0)|contains(S60_VERSION, symbian3) {
+    HEADERS += qtactileFeedback.h
+    SOURCES += qtactileFeedback_s60.cpp
+
+    LIBS += -ltouchfeedback
+}
+
+load(data_caging_paths)
+
+TARGET.UID3=0x200315B4
diff --git a/src/plugins/s60/feedback/qtactileFeedback.h b/src/plugins/s60/feedback/qtactileFeedback.h
new file mode 100644
index 0000000..7c4cc29
--- /dev/null
+++ b/src/plugins/s60/feedback/qtactileFeedback.h
@@ -0,0 +1,54 @@
+/****************************************************************************
+**
+** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the QtGui module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights.  These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QEvent>
+#include <QWidget>
+
+#include "private/qs60style_feedbackinterface_p.h"
+
+class QTactileFeedback : public TactileFeedbackInterface
+{
+    Q_OBJECT
+    Q_INTERFACES(TactileFeedbackInterface)
+
+    public:
+        void touchFeedback(QEvent *event, const QWidget *widget);
+ };
diff --git a/src/plugins/s60/feedback/qtactileFeedback_s60.cpp b/src/plugins/s60/feedback/qtactileFeedback_s60.cpp
new file mode 100644
index 0000000..c2f1d34
--- /dev/null
+++ b/src/plugins/s60/feedback/qtactileFeedback_s60.cpp
@@ -0,0 +1,83 @@
+/****************************************************************************
+**
+** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the QtGui module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights.  These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QApplication>
+#include <QObject>
+#include <QSlider>
+#include <QScrollBar>
+
+#include <QtCore/qplugin.h>
+#include "qtactileFeedback.h"
+
+#include <touchfeedback.h>
+
+void QTactileFeedback::touchFeedback(QEvent *event, const QWidget *widget)
+{
+    //Lets share the global instance for touch feedback (you are NOT allowed to try and delete it!).
+    MTouchFeedback* feedback = MTouchFeedback::Instance();
+
+    //If the widget itself is not handling focus, try to use focusProxy widget.
+    const QWidget *w = ((widget->focusPolicy() == Qt::NoFocus) && (widget->focusProxy())) ? widget->focusProxy() : widget;
+
+    //Only give tactile feedback for enabled widgets that take focus.
+    if (feedback && w && w->isEnabled() && w->isWidgetType() && w->isVisible()) {
+        //Scrollbars are 'special' that they don't take focus (nor they have focusProxy), yet we'd like to have tactile feedback for them
+        if (w->focusPolicy() == Qt::NoFocus)
+            if (!qobject_cast<const QScrollBar *>(w))
+                return;
+
+        //Don't give tactile feedback for widgets that are outside topmost dialog.
+        QWidget *dialog = QApplication::activeModalWidget();
+        if (dialog) {
+            QList<const QWidget *> allChildren = dialog->findChildren<const QWidget *>();
+            if (!allChildren.contains(w))
+                return;
+        }
+
+        //Widget specific tactile feedback.
+        if (qobject_cast<const QSlider *>(w) || qobject_cast<const QScrollBar *>(w))
+            feedback->InstantFeedback(ETouchFeedbackSensitive);
+        else
+            feedback->InstantFeedback(ETouchFeedbackBasic);
+    }
+}
+
+Q_EXPORT_PLUGIN2("feedback", QTactileFeedback);
diff --git a/src/plugins/s60/s60.pro b/src/plugins/s60/s60.pro
index c999fff..ffcd170 100644
--- a/src/plugins/s60/s60.pro
+++ b/src/plugins/s60/s60.pro
@@ -6,6 +6,10 @@ symbian {
         SUBDIRS += 3_1 3_2
     }
 
+    contains(S60_VERSION, 5.0)|contains(S60_VERSION, symbian3) {
+        SUBDIRS += feedback
+    }
+
     # 5.0 is used also for Symbian3 and later
     SUBDIRS += 5_0
 }
\ No newline at end of file
diff --git a/src/s60installs/qt.iby b/src/s60installs/qt.iby
index 4afbf05..2b3be0a 100644
--- a/src/s60installs/qt.iby
+++ b/src/s60installs/qt.iby
@@ -60,6 +60,8 @@ file=ABI_DIR\BUILD_DIR\qsymbianbearer.dll    SHARED_LIB_DIR\qsymbianbearer.dll
 // so don't bother including those plugins
 file=ABI_DIR\BUILD_DIR\qts60plugin_5_0.dll   SHARED_LIB_DIR\qts60plugin_5_0.dll
 
+file=ABI_DIR\BUILD_DIR\qtactilefeedback.dll   SHARED_LIB_DIR\qtactilefeedback.dll
+
 S60_APP_RESOURCE(s60main)
 
 // imageformats stubs
@@ -105,6 +107,9 @@ data=\epoc32\data\z\resource\qt\plugins\graphicssystems\qglgraphicssystem.qtplug
 // bearer stub
 data=\epoc32\data\z\resource\qt\plugins\bearer\qsymbianbearer.qtplugin resource\qt\plugins\bearer\qsymbianbearer.qtplugin
 
+// feedback
+data=\epoc32\data\z\resource\qt\plugins\feedback\qtactilefeedback.qtplugin              resource\qt\plugins\feedback\qtactilefeedback.qtplugin
+
 // Stub sis file
 data=ZSYSTEM\install\qt_stub.sis    System\Install\qt_stub.sis
 data=ZSYSTEM\install\qtwebkit_stub.sis    System\Install\qtwebkit_stub.sis
diff --git a/src/s60installs/s60installs.pro b/src/s60installs/s60installs.pro
index 9559da6..23b3d8f 100644
--- a/src/s60installs/s60installs.pro
+++ b/src/s60installs/s60installs.pro
@@ -86,6 +86,12 @@ symbian: {
         bearer_plugin.path = c:$$QT_PLUGINS_BASE_DIR/bearer
         DEPLOYMENT += bearer_plugin
     }
+    
+    contains(S60_VERSION, 5.0)|contains(S60_VERSION, symbian3) {
+        feedback_plugin.sources = $$QT_BUILD_TREE/plugins/s60/feedback/qtactilefeedback$${QT_LIBINFIX}.dll
+        feedback_plugin.path = c:$$QT_PLUGINS_BASE_DIR/feedback
+        DEPLOYMENT += feedback_plugin
+    }
 
     qtlibraries.pkg_postrules += qts60plugindeployment