Initial support for S60 softkey icons.

The logic for resolving the icon size in landscape mode for S60 5.0
(5800XM) is somewhat fragile, but better way is not yet know.

Also the 50% transparent mask what CBA implementation tries to create
for pressed down CB Abuttons fails for some reason. When button is
pressed down there are drawing artifacts in softkey images.

These issues will be tried to resolve with later commits

Task-number: QTBUG-7314

Review-By: Sami Merila

3 files changed, 180 insertions, 25 deletions

diff --git a/src/3rdparty/s60/eiksoftkeyimage.h b/src/3rdparty/s60/eiksoftkeyimage.h
new file mode 100644
index 0000000..84f6108a
--- /dev/null
+++ b/src/3rdparty/s60/eiksoftkeyimage.h
@@ -0,0 +1,112 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+
+/*
+* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:  Changes cba button's label to image.
+*
+*/
+
+#ifndef EIKSOFTKEYIMAGE_H
+#define EIKSOFTKEYIMAGE_H
+
+// FORWARD DECLARATIONS
+class CEikButtonGroupContainer;
+
+// CLASS DECLARATION
+
+/**
+*  Changes cba button's label to image.
+*
+*  @lib EIKCOCTL
+*  @since 2.0
+*/
+class EikSoftkeyImage
+    {
+    public:
+
+        /**
+        * Set image to cba button by replacing label
+        * @since 2.0
+        * @param aButtonGroupContainer Button container
+        * @param aImage Image to button,
+        *               Takes Images ownership
+        * @param aLeft  Boolean: left or right button.
+        *                        If true, then change left,
+        *                        if false, change right
+        */
+        IMPORT_C static void SetImage(CEikButtonGroupContainer* aButtonGroupContainer, CEikImage& aImage, TBool aLeft);
+
+        /**
+        * Change to cba button image back to label
+        * @since 2.0
+        * @param aButtonGroupContainer Button container
+        * @param aLeft Boolean: left or right button.
+        *                        If true, then change left,
+        *                        if false, change right
+        */
+        IMPORT_C static void SetLabel(CEikButtonGroupContainer* aButtonGroupContainer, TBool aLeft);
+
+    private:
+
+        /**
+        * C++ default constructor.
+        */
+        EikSoftkeyImage() {};
+
+
+    };
+
+#endif      // EIKSOFTKEYIMAGE_H
+
+// End of File
+
diff --git a/src/gui/kernel/qsoftkeymanager_s60.cpp b/src/gui/kernel/qsoftkeymanager_s60.cpp
index 67ed8b0..a72d16c 100644
--- a/src/gui/kernel/qsoftkeymanager_s60.cpp
+++ b/src/gui/kernel/qsoftkeymanager_s60.cpp
@@ -49,7 +49,7 @@
 #include "private/qsoftkeymanager_p.h"
 #include "private/qsoftkeymanager_s60_p.h"
 #include "private/qobject_p.h"
-//#include <eiksoftkeyimage.h>
+#include <eiksoftkeyimage.h>
 #include <eikcmbut.h>
 
 #ifndef QT_NO_SOFTKEYMANAGER
@@ -64,6 +64,8 @@ QSoftKeyManagerPrivateS60::QSoftKeyManagerPrivateS60()
 {
     cachedCbaIconSize[0] = QSize(0,0);
     cachedCbaIconSize[1] = QSize(0,0);
+    cachedCbaIconSize[2] = QSize(0,0);
+    cachedCbaIconSize[3] = QSize(0,0);
     skipNextUpdate = false;
 }
 
@@ -149,6 +151,39 @@ void QSoftKeyManagerPrivateS60::setNativeSoftkey(CEikButtonGroupContainer &cba,
     QT_TRAP_THROWING(cba.SetCommandL(position, command, text));
 }
 
+QPoint QSoftKeyManagerPrivateS60::softkeyIconPosition(int position, QSize sourceSize, QSize targetSize)
+{
+    QPoint iconPosition(0,0);
+    switch( AknLayoutUtils::CbaLocation() )
+        {
+        case AknLayoutUtils::EAknCbaLocationBottom:
+            // RSK must be moved to right, LSK in on correct position by default
+            if (position == RSK_POSITION)
+                iconPosition.setX(targetSize.width() - sourceSize.width());
+            break;
+        case AknLayoutUtils::EAknCbaLocationRight:
+        case AknLayoutUtils::EAknCbaLocationLeft:
+            // Already in correct position
+        default:
+            break;
+        }
+
+    // Align horizontally to center
+    iconPosition.setY((targetSize.height() - sourceSize.height()) >> 1);
+    return iconPosition;
+}
+
+QPixmap QSoftKeyManagerPrivateS60::prepareSoftkeyPixmap(QPixmap src, int position, QSize targetSize)
+{
+    QPixmap target(targetSize);
+    target.fill(Qt::transparent);
+    QPainter p;
+    p.begin(&target);
+    p.drawPixmap(softkeyIconPosition(position, src.size(), targetSize), src);
+    p.end();
+    return target;
+}
+
 bool QSoftKeyManagerPrivateS60::isOrientationLandscape()
 {
     // Hard to believe that there is no public API in S60 to
@@ -158,15 +193,11 @@ bool QSoftKeyManagerPrivateS60::isOrientationLandscape()
 
 QSize QSoftKeyManagerPrivateS60::cbaIconSize(CEikButtonGroupContainer *cba, int position)
 {
-    Q_UNUSED(cba);
-    Q_UNUSED(position);
 
-    // Will be implemented when EikSoftkeyImage usage license wise is OK
-/*
-    const int index = isOrientationLandscape() ? 0 : 1;
+    int index = position;
+    index += isOrientationLandscape() ? 0 : 1;
     if(cachedCbaIconSize[index].isNull()) {
         // Only way I figured out to get CBA icon size without RnD SDK, was
-        // Only way I figured out to get CBA icon size without RnD SDK, was
         // to set some dummy icon to CBA first and then ask CBA button CCoeControl::Size()
         // The returned value is cached to avoid unnecessary icon setting every time.
         const bool left = (position == LSK_POSITION);
@@ -178,38 +209,49 @@ QSize QSoftKeyManagerPrivateS60::cbaIconSize(CEikButtonGroupContainer *cba, int
             setNativeSoftkey(*cba, position, command, KNullDesC());
             cachedCbaIconSize[index] = qt_TSize2QSize(cba->ControlOrNull(command)->Size());
             EikSoftkeyImage::SetLabel(cba, left);
+
+            if(cachedCbaIconSize[index] == QSize(138,72)) {
+                // Hack for S60 5.0 (5800) landscape orientation, which return wrong icon size
+                cachedCbaIconSize[index] = QSize(60,60);
+            }
         }
     }
 
     return cachedCbaIconSize[index];
-*/
-    return QSize();
 }
 
 bool QSoftKeyManagerPrivateS60::setSoftkeyImage(CEikButtonGroupContainer *cba,
                                             QAction &action, int position)
 {
     bool ret = false;
-    Q_UNUSED(cba);
-    Q_UNUSED(action);
-    Q_UNUSED(position);
 
-    // Will be implemented when EikSoftkeyImage usage license wise is OK
-    /*
     const bool left = (position == LSK_POSITION);
     if(position == LSK_POSITION || position == RSK_POSITION) {
         QIcon icon = action.icon();
         if (!icon.isNull()) {
-            QPixmap pm = icon.pixmap(cbaIconSize(cba, position));
-            pm = pm.scaled(cbaIconSize(cba, position));
-            QBitmap mask = pm.mask();
-            if (mask.isNull()) {
-                mask = QBitmap(pm.size());
-                mask.fill(Qt::color1);
+            // Get size of CBA icon area based on button position and orientation
+            QSize requiredIconSize = cbaIconSize(cba, position);
+            // Get pixmap out of icon based on preferred size, the aspect ratio is kept
+            QPixmap pmWihtAspectRatio = icon.pixmap(requiredIconSize);
+            // Native softkeys require that pixmap size is exactly the same as requiredIconSize
+            // prepareSoftkeyPixmap creates a new pixmap with requiredIconSize and blits the 'pmWihtAspectRatio'
+            // to correct location of it
+            QPixmap softkeyPixmap = prepareSoftkeyPixmap(pmWihtAspectRatio, position, requiredIconSize);
+            QBitmap softkeyMask = softkeyPixmap.mask();
+            if (softkeyMask.isNull()) {
+                softkeyMask = QBitmap(softkeyPixmap.size());
+                softkeyMask.fill(Qt::color1);
+            }
+
+            // Softkey mask in > SV_S60_5_1 has to be inverted
+            if(QSysInfo::s60Version() > QSysInfo::SV_S60_5_1) {
+                QImage maskImage = softkeyMask.toImage();
+                maskImage.invertPixels();
+                softkeyMask = QPixmap::fromImage(maskImage);
             }
 
-            CFbsBitmap* nBitmap = pm.toSymbianCFbsBitmap();
-            CFbsBitmap* nMask = mask.toSymbianCFbsBitmap();
+            CFbsBitmap* nBitmap = softkeyPixmap.toSymbianCFbsBitmap();
+            CFbsBitmap* nMask = softkeyMask.toSymbianCFbsBitmap();
 
             CEikImage* myimage = new (ELeave) CEikImage;
             myimage->SetPicture( nBitmap, nMask ); // nBitmap and nMask ownership transfered
@@ -221,7 +263,6 @@ bool QSoftKeyManagerPrivateS60::setSoftkeyImage(CEikButtonGroupContainer *cba,
             EikSoftkeyImage::SetLabel(cba, left);
         }
     }
-    */
     return ret;
 }
 
@@ -272,6 +313,7 @@ bool QSoftKeyManagerPrivateS60::setRightSoftkey(CEikButtonGroupContainer &cba)
         if (windowType != Qt::Dialog && windowType != Qt::Popup) {
             QString text(QSoftKeyManager::tr("Exit"));
             TPtrC nativeText = qt_QString2TPtrC(text);
+            EikSoftkeyImage::SetLabel(&cba, false);
             setNativeSoftkey(cba, RSK_POSITION, EAknSoftkeyExit, nativeText);
             return true;
         }
@@ -303,7 +345,6 @@ void QSoftKeyManagerPrivateS60::setSoftkeys(CEikButtonGroupContainer &cba)
 
 void QSoftKeyManagerPrivateS60::updateSoftKeys_sys()
 {
-    //bool status = CCoeEnv::Static()->AppUi()->IsDisplayingMenuOrDialog();
     if (skipCbaUpdate())
         return;
 
diff --git a/src/gui/kernel/qsoftkeymanager_s60_p.h b/src/gui/kernel/qsoftkeymanager_s60_p.h
index 46e3596..f8bd6d9 100644
--- a/src/gui/kernel/qsoftkeymanager_s60_p.h
+++ b/src/gui/kernel/qsoftkeymanager_s60_p.h
@@ -84,6 +84,8 @@ private:
     QAction *highestPrioritySoftkey(QAction::SoftKeyRole role);
     static bool actionPriorityMoreThan(const QAction* item1, const QAction* item2);
     void setNativeSoftkey(CEikButtonGroupContainer &cba, TInt position, TInt command, const TDesC& text);
+    QPoint softkeyIconPosition(int position, QSize sourceSize, QSize targetSize);
+    QPixmap prepareSoftkeyPixmap(QPixmap src, int position, QSize targetSize);
     bool isOrientationLandscape();
     QSize cbaIconSize(CEikButtonGroupContainer *cba, int position);
     bool setSoftkeyImage(CEikButtonGroupContainer *cba, QAction &action, int position);
@@ -95,7 +97,7 @@ private:
 
 private:
     QHash<int, QAction*> realSoftKeyActions;
-    QSize cachedCbaIconSize[2];
+    QSize cachedCbaIconSize[4];
     bool skipNextUpdate;
 };