]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/tooltips/tooltipmanager.cpp
Fix issue that the columns "Link Destination" and "Path" are shown outside the visibl...
[dolphin.git] / src / tooltips / tooltipmanager.cpp
index 489c6c2b69d5b657c08ebdcdaf4d3c6e9dd41501..bf26908ba4c4832a291b156075f2401fa1dc47cb 100644 (file)
 
 #include "tooltipmanager.h"
 
-#include "dolphintooltip.h"
 #include "dolphinmodel.h"
 #include "dolphinsortfilterproxymodel.h"
 
+#include "filemetadatatooltip.h"
 #include <kicon.h>
-#include <tooltips/ktooltip.h>
 #include <kio/previewjob.h>
 
 #include <QApplication>
 #include <QDesktopWidget>
+#include <QScrollArea>
 #include <QScrollBar>
 #include <QTimer>
-#include <QToolTip>
-
-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,
                                DolphinSortFilterProxyModel* model) :
@@ -48,17 +41,13 @@ ToolTipManager::ToolTipManager(QAbstractItemView* parent,
     m_timer(0),
     m_previewTimer(0),
     m_waitOnPreviewTimer(0),
+    m_fileMetaDataToolTip(0),
     m_item(),
     m_itemRect(),
-    m_preview(false),
     m_generatingPreview(false),
-    m_previewIsLate(false),
-    m_previewPass(0),
-    m_emptyRenderedKToolTipItem(0),
-    m_pix()
+    m_hasDefaultIcon(false),
+    m_previewPixmap()
 {
-    KToolTip::setToolTipDelegate(g_delegate);
-
     m_dolphinModel = static_cast<DolphinModel*>(m_proxyModel->sourceModel());
     connect(parent, SIGNAL(entered(const QModelIndex&)),
             this, SLOT(requestToolTip(const QModelIndex&)));
@@ -89,6 +78,16 @@ ToolTipManager::ToolTipManager(QAbstractItemView* parent,
             this, SLOT(hideTip()));
 
     m_view->viewport()->installEventFilter(this);
+    m_view->installEventFilter(this);
+
+    static FileMetaDataToolTip* sharedToolTip = 0;
+    if (sharedToolTip == 0) {
+        sharedToolTip = new FileMetaDataToolTip();
+        // TODO: Using K_GLOBAL_STATIC would be preferable to maintain the
+        // instance, but the cleanup of KMetaDataWidget at this stage does
+        // not work.
+    }
+    m_fileMetaDataToolTip = sharedToolTip;
 }
 
 ToolTipManager::~ToolTipManager()
@@ -102,7 +101,16 @@ void ToolTipManager::hideTip()
 
 bool ToolTipManager::eventFilter(QObject* watched, QEvent* event)
 {
-    if ((watched == m_view->viewport()) && (event->type() == QEvent::Leave)) {
+    if (watched == m_view->viewport()) {
+        switch (event->type()) {
+        case QEvent::Leave:
+        case QEvent::MouseButtonPress:
+            hideToolTip();
+            break;
+        default:
+            break;
+        }
+    } else if ((watched == m_view) && (event->type() == QEvent::KeyPress)) {
         hideToolTip();
     }
 
@@ -111,11 +119,11 @@ bool ToolTipManager::eventFilter(QObject* watched, QEvent* event)
 
 void ToolTipManager::requestToolTip(const QModelIndex& index)
 {
-    // only request a tooltip for the name column and when no selection or
+    // 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();
+        hideToolTip();
 
         m_itemRect = m_view->visualRect(index);
         const QPoint pos = m_view->viewport()->mapToGlobal(m_itemRect.topLeft());
@@ -124,12 +132,11 @@ void ToolTipManager::requestToolTip(const QModelIndex& index)
         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
+        // 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_previewPixmap = QPixmap();
+        m_hasDefaultIcon = false;
 
         m_timer->start(500);
     } else {
@@ -142,84 +149,68 @@ void ToolTipManager::hideToolTip()
     m_timer->stop();
     m_previewTimer->stop();
     m_waitOnPreviewTimer->stop();
-    m_previewIsLate = false;
-    KToolTip::hideTip();
+
+    m_fileMetaDataToolTip->hide();
+    m_fileMetaDataToolTip->setItems(KFileItemList());
 }
 
 void ToolTipManager::prepareToolTip()
 {
     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));
-        }
+    if (!m_previewPixmap.isNull()) {
+        showToolTip(m_previewPixmap);
+    } else if (!m_hasDefaultIcon) {
+        const QPixmap image(KIcon(m_item.iconName()).pixmap(128, 128));
+        showToolTip(image);
+        m_hasDefaultIcon = true;
+    }
+}
 
-        KToolTipItem* toolTip = new KToolTipItem(icon, m_item.getToolTipText());
-        showToolTip(toolTip);
+void ToolTipManager::startPreviewJob()
+{
+    m_generatingPreview = true;
+    KIO::PreviewJob* job = KIO::filePreview(KFileItemList() << m_item, 256, 256);
+
+    connect(job, SIGNAL(gotPreview(const KFileItem&, const QPixmap&)),
+            this, SLOT(setPreviewPix(const KFileItem&, const QPixmap&)));
+    connect(job, SIGNAL(failed(const KFileItem&)),
+            this, SLOT(previewFailed()));
+}
+
+
+void ToolTipManager::setPreviewPix(const KFileItem& item,
+                                   const QPixmap& pixmap)
+{
+    if ((m_item.url() != item.url()) || pixmap.isNull()) {
+        // An old preview or an invalid preview has been received
+        previewFailed();
+    } else {
+        m_previewPixmap = pixmap;
+        m_generatingPreview = false;
     }
 }
 
-void ToolTipManager::showToolTip(KToolTipItem* tip)
+void ToolTipManager::previewFailed()
+{
+    m_generatingPreview = false;
+}
+
+
+void ToolTipManager::showToolTip(const QPixmap& pixmap)
 {
     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();
-    option.fontMetrics    = QFontMetrics(QToolTip::font());
-    option.activeCorner   = KStyleOptionToolTip::TopLeftCorner;
-    option.palette        = QToolTip::palette();
-    option.font           = QToolTip::font();
-    option.rect           = QRect();
-    option.state          = QStyle::State_None;
-    option.decorationSize = QSize(32, 32);
-
-    QSize size;
-    if (m_previewIsLate) {
-        QPixmap paddedImage(QSize(PREVIEW_WIDTH, PREVIEW_HEIGHT));
-        KToolTipItem maxiTip(paddedImage, m_item.getToolTipText());
-        size = g_delegate->sizeHint(option, maxiTip);
-    }
-    else if (tip != 0) {
-        size = g_delegate->sizeHint(option, *tip);
-    }
+    m_fileMetaDataToolTip->setPreview(pixmap);
+    m_fileMetaDataToolTip->setName(m_item.text());
+    m_fileMetaDataToolTip->setItems(KFileItemList() << m_item);
+
+    // Calculate the x- and y-position of the tooltip
+    const QSize size = m_fileMetaDataToolTip->sizeHint();
     const QRect desktop = QApplication::desktop()->screenGeometry(m_itemRect.bottomRight());
 
     // m_itemRect defines the area of the item, where the tooltip should be
@@ -232,11 +223,18 @@ void ToolTipManager::showToolTip(KToolTipItem* tip)
     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;
     }
 
+    // The size hint provided by the tooltip is not necessarily equal to the
+    // real size of the tooltip after showing it. As long as the tooltip is aligned
+    // on the upper-left edge, this is no problem. If the tooltip is aligned at
+    // another edge, the real size must be respected and the position
+    // corrected. Whether a correction must be done, is indicated by the variables
+    // updateWidth and updateHeight:
+    bool updateWidth = false;
+    bool updateHeight = false;
+    
     int x = 0;
     int y = 0;
     if (hasRoomBelow || hasRoomAbove) {
@@ -244,61 +242,46 @@ void ToolTipManager::showToolTip(KToolTipItem* tip)
         if (x + size.width() >= desktop.right()) {
             x = desktop.right() - size.width();
         }
-        y = hasRoomBelow ? m_itemRect.bottom() : m_itemRect.top() - size.height();
+        if (hasRoomBelow) {
+            y = m_itemRect.bottom();
+        } else {
+            y = m_itemRect.top() - size.height();
+            updateHeight = true;
+        }
     } else {
         Q_ASSERT(hasRoomToLeft || hasRoomToRight);
-        x = hasRoomToRight ? m_itemRect.right() : m_itemRect.left() - size.width();
+        if (hasRoomToRight) {
+            x = m_itemRect.right();
+        } else {
+            x = m_itemRect.left() - size.width();
+            updateWidth = true;
+        }
 
         // 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();
+        updateHeight = true;
     }
 
-    KToolTip::showTip(QPoint(x, y), tip);
-}
-
-
-
-void ToolTipManager::startPreviewJob()
-{
-    m_generatingPreview = true;
-    KIO::PreviewJob* job = KIO::filePreview(KFileItemList() << m_item,
-                                            PREVIEW_WIDTH,
-                                            PREVIEW_HEIGHT);
-
-    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;
+    if (!updateWidth && !updateHeight) {
+        // Default case: There is enough room below and right of the mouse
+        // pointer and the tooltip can be positioned there.
+        m_fileMetaDataToolTip->move(x, y);
+        m_fileMetaDataToolTip->show();
     } else {
-        m_pix = pixmap;
+        // There is not enough room to show the tooltip at the default position and
+        // it must be moved left or upwards. In this case the size hint of the
+        // tooltip is not sufficient and the real size must be respected.
+        // To prevent a flickering, the tooltip is first opened outside the visible
+        // desktop area and moved afterwards.
+        m_fileMetaDataToolTip->move(desktop.right() + 1, desktop.bottom() + 1);
+        m_fileMetaDataToolTip->show();
+
+        const QSize shownSize = m_fileMetaDataToolTip->size();
+        const int xDiff = updateWidth ? shownSize.width() - size.width() : 0;
+        const int yDiff = updateHeight ? shownSize.height() - size.height() : 0;
+        m_fileMetaDataToolTip->move(x - xDiff, y - yDiff);
     }
-    m_preview = true;
-    m_generatingPreview = false;
-}
-
-void ToolTipManager::previewFailed(const KFileItem& item)
-{
-    Q_UNUSED(item);
-    m_generatingPreview = false;
 }
 
 #include "tooltipmanager.moc"