use a smaller step size when using the scroll wheel

[dolphin.git] / src / tooltipmanager.cpp

diff --git a/src/tooltipmanager.cpp b/src/tooltipmanager.cpp
index 71c29e51b7f001c05f3cfcd23c2b8131a7d22226..eb1e52ec11bdd3b2188250534758ec07181840ce 100644 (file)
--- a/src/tooltipmanager.cpp
+++ b/src/tooltipmanager.cpp
@@ -25,12 +25,20 @@
 
 #include <kicon.h>
 #include <ktooltip.h>
 
 #include <kicon.h>
 #include <ktooltip.h>

+#include <kio/previewjob.h>

 
 #include <QApplication>
 #include <QDesktopWidget>
 
 #include <QApplication>
 #include <QDesktopWidget>

+#include <QScrollBar>

 #include <QTimer>
 #include <QToolTip>
 
 #include <QTimer>
 #include <QToolTip>
 

+const int PREVIEW_WIDTH = 256;
+const int PREVIEW_HEIGHT = 256;
+const int ICON_WIDTH = 128;
+const int ICON_HEIGHT = 128;
+const int PREVIEW_DELAY = 250;
+

 K_GLOBAL_STATIC(DolphinBalloonTooltipDelegate, g_delegate)
 
 ToolTipManager::ToolTipManager(QAbstractItemView* parent,
 K_GLOBAL_STATIC(DolphinBalloonTooltipDelegate, g_delegate)
 
 ToolTipManager::ToolTipManager(QAbstractItemView* parent,


@@ -40,8 +48,16 @@ ToolTipManager::ToolTipManager(QAbstractItemView* parent,
     m_dolphinModel(0),
     m_proxyModel(model),
     m_timer(0),
     m_dolphinModel(0),
     m_proxyModel(model),
     m_timer(0),

+    m_previewTimer(0),
+    m_waitOnPreviewTimer(0),

     m_item(),
     m_item(),

-    m_itemRect()
+    m_itemRect(),
+    m_preview(false),
+    m_generatingPreview(false),
+    m_previewIsLate(false),
+    m_previewPass(0),
+    m_emptyRenderedKToolTipItem(0),
+    m_pix()

 {
     KToolTip::setToolTipDelegate(g_delegate);
 
 {
     KToolTip::setToolTipDelegate(g_delegate);
 


@@ -54,7 +70,25 @@ ToolTipManager::ToolTipManager(QAbstractItemView* parent,
     m_timer = new QTimer(this);
     m_timer->setSingleShot(true);
     connect(m_timer, SIGNAL(timeout()),
     m_timer = new QTimer(this);
     m_timer->setSingleShot(true);
     connect(m_timer, SIGNAL(timeout()),

-            this, SLOT(showToolTip()));
+            this, SLOT(prepareToolTip()));
+
+    m_previewTimer = new QTimer(this);
+    m_previewTimer->setSingleShot(true);
+    connect(m_previewTimer, SIGNAL(timeout()),
+            this, SLOT(startPreviewJob()));
+
+    m_waitOnPreviewTimer = new QTimer(this);
+    m_waitOnPreviewTimer->setSingleShot(true);
+    connect(m_waitOnPreviewTimer, SIGNAL(timeout()),
+            this, SLOT(prepareToolTip()));
+
+    // When the mousewheel is used, the items don't get a hovered indication
+    // (Qt-issue #200665). To assure that the tooltip still gets hidden,
+    // the scrollbars are observed.
+    connect(parent->horizontalScrollBar(), SIGNAL(valueChanged(int)),
+            this, SLOT(hideTip()));
+    connect(parent->verticalScrollBar(), SIGNAL(valueChanged(int)),
+            this, SLOT(hideTip()));

 
     m_view->viewport()->installEventFilter(this);
 }
 
     m_view->viewport()->installEventFilter(this);
 }


@@ -79,7 +113,10 @@ bool ToolTipManager::eventFilter(QObject* watched, QEvent* event)
 
 void ToolTipManager::requestToolTip(const QModelIndex& index)
 {
 
 void ToolTipManager::requestToolTip(const QModelIndex& index)
 {

-    if (index.column() == DolphinModel::Name) {
+    // only request a tooltip for the name column and when no selection or
+    // drag & drop operation is done (indicated by the left mouse button)
+    if ((index.column() == DolphinModel::Name) && !(QApplication::mouseButtons() & Qt::LeftButton)) {
+        m_waitOnPreviewTimer->stop();

         KToolTip::hideTip();
 
         m_itemRect = m_view->visualRect(index);
         KToolTip::hideTip();
 
         m_itemRect = m_view->visualRect(index);


@@ -89,6 +126,13 @@ void ToolTipManager::requestToolTip(const QModelIndex& index)
         const QModelIndex dirIndex = m_proxyModel->mapToSource(index);
         m_item = m_dolphinModel->itemForIndex(dirIndex);
 
         const QModelIndex dirIndex = m_proxyModel->mapToSource(index);
         m_item = m_dolphinModel->itemForIndex(dirIndex);
 

+        // only start the previewJob when the mouse has been over this item for 200 milliseconds,
+        // this prevents a lot of useless preview jobs when passing rapidly over a lot of items
+        m_previewTimer->start(200);
+        m_preview = false;
+        m_previewIsLate = false;
+        m_previewPass = 0;
+

         m_timer->start(500);
     } else {
         hideToolTip();
         m_timer->start(500);
     } else {
         hideToolTip();


@@ -98,16 +142,66 @@ void ToolTipManager::requestToolTip(const QModelIndex& index)
 void ToolTipManager::hideToolTip()
 {
     m_timer->stop();
 void ToolTipManager::hideToolTip()
 {
     m_timer->stop();

+    m_previewTimer->stop();
+    m_waitOnPreviewTimer->stop();
+    m_previewIsLate = false;

     KToolTip::hideTip();
 }
 
     KToolTip::hideTip();
 }
 

-void ToolTipManager::showToolTip()
+void ToolTipManager::prepareToolTip()

 {
 {

-    // TODO - create tip during requestTip(...) - this makes it more likely that the previews
-    // job will have completed by the time the tooltip is shown, resulting in less flicker.
-    // The memory management will be more intricate, though.
-    DolphinToolTipItem *tip = new DolphinToolTipItem(m_item);
+    if (m_generatingPreview) {
+        if (m_previewPass == 1) {
+            // We waited 250msec and the preview is still not finished,
+            // so show the toolTip with a transparent image of maximal width.
+            // When the preview finishes, m_previewIsLate will cause
+            // a direct update of the tooltip, via m_emptyRenderedKToolTipItem.
+            QPixmap paddedImage(QSize(PREVIEW_WIDTH, 32));
+            m_previewIsLate = true;
+            paddedImage.fill(Qt::transparent);
+            KToolTipItem* toolTip = new KToolTipItem(paddedImage, m_item.getToolTipText());
+            m_emptyRenderedKToolTipItem = toolTip; // make toolTip accessible everywhere
+            showToolTip(toolTip);
+        }
+        
+        ++m_previewPass;
+        m_waitOnPreviewTimer->start(250);
+    } else {
+        // The preview generation has finished, find out under which circumstances.
+        if (m_preview && m_previewIsLate) {
+            // We got a preview, but it is late, the tooltip has already been shown.
+            // So update the tooltip directly.
+            if (m_emptyRenderedKToolTipItem != 0) {
+                m_emptyRenderedKToolTipItem->setData(Qt::DecorationRole, KIcon(m_pix));
+            }
+            return;
+        }
+
+        KIcon icon;
+        if (m_preview) {
+            // We got a preview.
+            icon = KIcon(m_pix);
+        } else {
+            // No preview, so use an icon.
+            // Force a 128x128 icon, a 256x256 one is far too big.
+            icon = KIcon(KIcon(m_item.iconName()).pixmap(ICON_WIDTH, ICON_HEIGHT));
+        }

 
 

+        KToolTipItem* toolTip = new KToolTipItem(icon, m_item.getToolTipText());
+        showToolTip(toolTip);
+    }
+}
+
+void ToolTipManager::showToolTip(KToolTipItem* tip)
+{
+    if (QApplication::mouseButtons() & Qt::LeftButton) {
+        delete tip;
+        tip = 0;
+        // m_emptyRenderedKToolTipItem is an alias for tip.
+        m_emptyRenderedKToolTipItem = 0;
+        return;
+    }
+    

     KStyleOptionToolTip option;
     // TODO: get option content from KToolTip or add KToolTip::sizeHint() method
     option.direction      = QApplication::layoutDirection();
     KStyleOptionToolTip option;
     // TODO: get option content from KToolTip or add KToolTip::sizeHint() method
     option.direction      = QApplication::layoutDirection();


@@ -119,7 +213,17 @@ void ToolTipManager::showToolTip()
     option.state          = QStyle::State_None;
     option.decorationSize = QSize(32, 32);
 
     option.state          = QStyle::State_None;
     option.decorationSize = QSize(32, 32);
 

-    const QSize size = g_delegate->sizeHint(&option, tip);
+    QSize size;
+    if (m_previewIsLate) {
+        QPixmap paddedImage(QSize(PREVIEW_WIDTH, PREVIEW_HEIGHT));
+        KToolTipItem* maxiTip = new KToolTipItem(paddedImage, m_item.getToolTipText());
+        size = g_delegate->sizeHint(&option, maxiTip);
+        delete maxiTip;
+        maxiTip = 0;
+    }
+    else {
+        size = g_delegate->sizeHint(&option, tip);
+    }

     const QRect desktop = QApplication::desktop()->screenGeometry(m_itemRect.bottomRight());
 
     // m_itemRect defines the area of the item, where the tooltip should be
     const QRect desktop = QApplication::desktop()->screenGeometry(m_itemRect.bottomRight());
 
     // m_itemRect defines the area of the item, where the tooltip should be


@@ -127,17 +231,79 @@ void ToolTipManager::showToolTip()
     // If the tooltip content exceeds the desktop borders, it must be assured that:
     // - the content is fully visible
     // - the content is not drawn inside m_itemRect
     // If the tooltip content exceeds the desktop borders, it must be assured that:
     // - the content is fully visible
     // - the content is not drawn inside m_itemRect

-    int x = m_itemRect.right();
-    int y = m_itemRect.bottom();
-    // TODO: handle usecase if x or y get smaller than the 
-    // desktop-left or the desktop-top
-    if (x + size.width() - 1 > desktop.right()) {
-        x = m_itemRect.left() - size.width();
+    const bool hasRoomToLeft  = (m_itemRect.left()   - size.width()  >= desktop.left());
+    const bool hasRoomToRight = (m_itemRect.right()  + size.width()  <= desktop.right());
+    const bool hasRoomAbove   = (m_itemRect.top()    - size.height() >= desktop.top());
+    const bool hasRoomBelow   = (m_itemRect.bottom() + size.height() <= desktop.bottom());    
+    if (!hasRoomAbove && !hasRoomBelow && !hasRoomToLeft && !hasRoomToRight) {
+        delete tip;
+        tip = 0;
+        return;

     }
     }

-    if (y + size.height() - 1 > desktop.bottom()) {
-        y = m_itemRect.top() - size.height();
+
+    int x = 0;   
+    int y = 0;
+    if (hasRoomBelow || hasRoomAbove) {
+        x = QCursor::pos().x() + 16; // TODO: use mouse pointer width instead of the magic value of 16
+        if (x + size.width() >= desktop.right()) {
+            x = desktop.right() - size.width();
+        }
+        y = hasRoomBelow ? m_itemRect.bottom() : m_itemRect.top() - size.height();
+    } else {
+        Q_ASSERT(hasRoomToLeft || hasRoomToRight);
+        x = hasRoomToRight ? m_itemRect.right() : m_itemRect.left() - size.width();
+        
+        // Put the tooltip at the bottom of the screen. The x-coordinate has already
+        // been adjusted, so that no overlapping with m_itemRect occurs.
+        y = desktop.bottom() - size.height();

     }
     }

+

     KToolTip::showTip(QPoint(x, y), tip);
 }
 
     KToolTip::showTip(QPoint(x, y), tip);
 }
 

+
+
+void ToolTipManager::startPreviewJob()
+{
+    m_generatingPreview = true;
+    KIO::PreviewJob* job = KIO::filePreview(KUrl::List() << m_item.url(),
+                                            PREVIEW_WIDTH,
+                                            PREVIEW_HEIGHT);
+    job->setIgnoreMaximumSize(true);
+
+    connect(job, SIGNAL(gotPreview(const KFileItem&, const QPixmap&)),
+            this, SLOT(setPreviewPix(const KFileItem&, const QPixmap&)));
+    connect(job, SIGNAL(failed(const KFileItem&)),
+            this, SLOT(previewFailed(const KFileItem&)));
+}
+
+
+void ToolTipManager::setPreviewPix(const KFileItem& item,
+                                   const QPixmap& pixmap)
+{
+    if (m_item.url() != item.url()) {
+        m_generatingPreview = false;
+        return;
+    }
+    
+    if (m_previewIsLate) {
+        // always use the maximal width
+        QPixmap paddedImage(QSize(PREVIEW_WIDTH, pixmap.height()));
+        paddedImage.fill(Qt::transparent);
+        QPainter painter(&paddedImage);
+        painter.drawPixmap((PREVIEW_WIDTH - pixmap.width()) / 2, 0, pixmap);
+        m_pix = paddedImage;
+    } else {
+        m_pix = pixmap;
+    }
+    m_preview = true;
+    m_generatingPreview = false;
+}
+
+void ToolTipManager::previewFailed(const KFileItem& item)
+{
+    Q_UNUSED(item);
+    m_generatingPreview = false;
+}
+

 #include "tooltipmanager.moc"
 #include "tooltipmanager.moc"