[ToolTipManager] Create DolphinFileMetaDataWidget on-demand again

[dolphin.git] / src / views / tooltips / tooltipmanager.cpp

diff --git a/src/views/tooltips/tooltipmanager.cpp b/src/views/tooltips/tooltipmanager.cpp
index df89a882e6327900d11d8e0b156abdad18174fef..6372617027da3e892d6f640d088e79410cac7f0f 100644 (file)
--- a/src/views/tooltips/tooltipmanager.cpp
+++ b/src/views/tooltips/tooltipmanager.cpp
@@ -1,84 +1,93 @@
-/*******************************************************************************
- *   Copyright (C) 2008 by Konstantin Heil <konst.heil@stud.uni-heidelberg.de> *
- *                                                                             *
- *   This program is free software; you can redistribute it and/or modify      *
- *   it under the terms of the GNU General Public License as published by      *
- *   the Free Software Foundation; either version 2 of the License, or         *
- *   (at your option) any later version.                                       *
- *                                                                             *
- *   This program is distributed in the hope that it will be useful,           *
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of            *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             *
- *   GNU General Public License for more details.                              *
- *                                                                             *
- *   You should have received a copy of the GNU General Public License         *
- *   along with this program; if not, write to the                             *
- *   Free Software Foundation, Inc.,                                           *
- *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA                *
- *******************************************************************************/
+/*
+ * SPDX-FileCopyrightText: 2008 Konstantin Heil <konst.heil@stud.uni-heidelberg.de>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */

 
 #include "tooltipmanager.h"
 
 
 #include "tooltipmanager.h"
 

-#include "filemetadatatooltip.h"
-#include <KIcon>
+#include "dolphinfilemetadatawidget.h"
+
+#include <KIO/JobUiDelegate>

 #include <KIO/PreviewJob>
 #include <KIO/PreviewJob>

+#include <KConfigGroup>
+#include <KJobWidgets>
+#include <KSharedConfig>
+#include <KToolTipWidget>
+#include <KIconLoader>

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

+#include <QIcon>

 #include <QLayout>
 #include <QLayout>

-#include <QScrollArea>
-#include <QScrollBar>

 #include <QStyle>
 #include <QTimer>
 #include <QStyle>
 #include <QTimer>

+#include <QWindow>
+
+class IconLoaderSingleton {
+public:
+    IconLoaderSingleton() = default;
+
+    KIconLoader self;
+};
+
+Q_GLOBAL_STATIC(IconLoaderSingleton, iconLoader)

 
 ToolTipManager::ToolTipManager(QWidget* parent) :
     QObject(parent),
 
 ToolTipManager::ToolTipManager(QWidget* parent) :
     QObject(parent),

-    m_parentWidget(parent),
-    m_showToolTipTimer(0),
-    m_contentRetrievalTimer(0),
-    m_fileMetaDataToolTip(0),
+    m_showToolTipTimer(nullptr),
+    m_contentRetrievalTimer(nullptr),
+    m_transientParent(nullptr),

     m_toolTipRequested(false),
     m_metaDataRequested(false),
     m_appliedWaitCursor(false),
     m_toolTipRequested(false),
     m_metaDataRequested(false),
     m_appliedWaitCursor(false),

+    m_margin(4),

     m_item(),
     m_itemRect()
 {
     m_item(),
     m_itemRect()
 {

+    if (parent) {
+        m_margin = qMax(m_margin, parent->style()->pixelMetric(QStyle::PM_ToolTipLabelFrameWidth));
+    }
+

     m_showToolTipTimer = new QTimer(this);
     m_showToolTipTimer->setSingleShot(true);
     m_showToolTipTimer->setInterval(500);
     m_showToolTipTimer = new QTimer(this);
     m_showToolTipTimer->setSingleShot(true);
     m_showToolTipTimer->setInterval(500);

-    connect(m_showToolTipTimer, SIGNAL(timeout()), this, SLOT(showToolTip()));
+    connect(m_showToolTipTimer, &QTimer::timeout, this, QOverload<>::of(&ToolTipManager::showToolTip));

 
     m_contentRetrievalTimer = new QTimer(this);
     m_contentRetrievalTimer->setSingleShot(true);
     m_contentRetrievalTimer->setInterval(200);
 
     m_contentRetrievalTimer = new QTimer(this);
     m_contentRetrievalTimer->setSingleShot(true);
     m_contentRetrievalTimer->setInterval(200);

-    connect(m_contentRetrievalTimer, SIGNAL(timeout()), this, SLOT(startContentRetrieval()));
+    connect(m_contentRetrievalTimer, &QTimer::timeout, this, &ToolTipManager::startContentRetrieval);

 
     Q_ASSERT(m_contentRetrievalTimer->interval() < m_showToolTipTimer->interval());
 }
 
 ToolTipManager::~ToolTipManager()
 {
 
     Q_ASSERT(m_contentRetrievalTimer->interval() < m_showToolTipTimer->interval());
 }
 
 ToolTipManager::~ToolTipManager()
 {

-    delete m_fileMetaDataToolTip;
-    m_fileMetaDataToolTip = 0;
+    if (!m_fileMetaDatWidgetOwnershipTransferred) {
+        delete m_fileMetaDataWidget;
+    }

 }
 
 }
 

-void ToolTipManager::showToolTip(const KFileItem& item, const QRectF& itemRect)
+void ToolTipManager::showToolTip(const KFileItem& item, const QRectF& itemRect, QWindow *transientParent)

 {
 {

-    hideToolTip();
+    hideToolTip(HideBehavior::Instantly);

 
     m_itemRect = itemRect.toRect();
 
 
     m_itemRect = itemRect.toRect();
 

-    const int margin = toolTipMargin();
-    m_itemRect.adjust(-margin, -margin, margin, margin);
+    m_itemRect.adjust(-m_margin, -m_margin, m_margin, m_margin);

     m_item = item;
 
     m_item = item;
 

+    m_transientParent = transientParent;
+

     // Only start the retrieving of the content, when the mouse has been over this
     // item for 200 milliseconds. This prevents a lot of useless preview jobs and
     // meta data retrieval, when passing rapidly over a lot of items.
     // Only start the retrieving of the content, when the mouse has been over this
     // item for 200 milliseconds. This prevents a lot of useless preview jobs and
     // meta data retrieval, when passing rapidly over a lot of items.

-    Q_ASSERT(!m_fileMetaDataToolTip);
-    m_fileMetaDataToolTip = new FileMetaDataToolTip(m_parentWidget);
-    connect(m_fileMetaDataToolTip, SIGNAL(metaDataRequestFinished(KFileItemList)),
-            this, SLOT(slotMetaDataRequestFinished()));
+    if (!m_fileMetaDataWidget) {
+        m_fileMetaDataWidget = new DolphinFileMetaDataWidget();
+        connect(m_fileMetaDataWidget, &DolphinFileMetaDataWidget::metaDataRequestFinished, this, &ToolTipManager::slotMetaDataRequestFinished);
+        connect(m_fileMetaDataWidget, &DolphinFileMetaDataWidget::urlActivated, this, &ToolTipManager::urlActivated);
+    }

 
     m_contentRetrievalTimer->start();
     m_showToolTipTimer->start();
 
     m_contentRetrievalTimer->start();
     m_showToolTipTimer->start();


@@ -86,7 +95,7 @@ void ToolTipManager::showToolTip(const KFileItem& item, const QRectF& itemRect)
     Q_ASSERT(!m_metaDataRequested);
 }
 
     Q_ASSERT(!m_metaDataRequested);
 }
 

-void ToolTipManager::hideToolTip()
+void ToolTipManager::hideToolTip(const HideBehavior behavior)

 {
     if (m_appliedWaitCursor) {
         QApplication::restoreOverrideCursor();
 {
     if (m_appliedWaitCursor) {
         QApplication::restoreOverrideCursor();


@@ -97,11 +106,15 @@ void ToolTipManager::hideToolTip()
     m_metaDataRequested = false;
     m_showToolTipTimer->stop();
     m_contentRetrievalTimer->stop();
     m_metaDataRequested = false;
     m_showToolTipTimer->stop();
     m_contentRetrievalTimer->stop();

-
-    if (m_fileMetaDataToolTip) {
-        m_fileMetaDataToolTip->hide();
-        delete m_fileMetaDataToolTip;
-        m_fileMetaDataToolTip = 0;
+    if (m_tooltipWidget) {
+        switch (behavior) {
+        case HideBehavior::Instantly:
+            m_tooltipWidget->hide();
+            break;
+        case HideBehavior::Later:
+            m_tooltipWidget->hideLater();
+            break;
+        }

     }
 }
 
     }
 }
 


@@ -111,24 +124,32 @@ void ToolTipManager::startContentRetrieval()
         return;
     }
 
         return;
     }
 

-    m_fileMetaDataToolTip->setName(m_item.text());
+    m_fileMetaDataWidget->setName(m_item.text());

 
     // Request the retrieval of meta-data. The slot
     // slotMetaDataRequestFinished() is invoked after the
     // meta-data have been received.
     m_metaDataRequested = true;
 
     // Request the retrieval of meta-data. The slot
     // slotMetaDataRequestFinished() is invoked after the
     // meta-data have been received.
     m_metaDataRequested = true;

-    m_fileMetaDataToolTip->setItems(KFileItemList() << m_item);
-    m_fileMetaDataToolTip->adjustSize();
+    m_fileMetaDataWidget->setItems(KFileItemList() << m_item);
+    m_fileMetaDataWidget->adjustSize();

 
     // Request a preview of the item
 
     // Request a preview of the item

-    m_fileMetaDataToolTip->setPreview(QPixmap());
-
-    KIO::PreviewJob* job = KIO::filePreview(KFileItemList() << m_item, QSize(256, 256));
+    m_fileMetaDataWidget->setPreview(QPixmap());
+
+    const KConfigGroup globalConfig(KSharedConfig::openConfig(), "PreviewSettings");
+    const QStringList plugins = globalConfig.readEntry("Plugins", KIO::PreviewJob::defaultPlugins());
+    KIO::PreviewJob* job = new KIO::PreviewJob(KFileItemList() << m_item,
+                                               QSize(256, 256),
+                                               &plugins);
+    job->setIgnoreMaximumSize(m_item.isLocalFile() && !m_item.isSlow());
+    if (job->uiDelegate()) {
+        KJobWidgets::setWindow(job, qApp->activeWindow());
+    }

 
 

-    connect(job, SIGNAL(gotPreview(KFileItem,QPixmap)),
-            this, SLOT(setPreviewPix(KFileItem,QPixmap)));
-    connect(job, SIGNAL(failed(KFileItem)),
-            this, SLOT(previewFailed()));
+    connect(job, &KIO::PreviewJob::gotPreview,
+            this, &ToolTipManager::setPreviewPix);
+    connect(job, &KIO::PreviewJob::failed,
+            this, &ToolTipManager::previewFailed);

 }
 
 
 }
 
 


@@ -143,7 +164,7 @@ void ToolTipManager::setPreviewPix(const KFileItem& item,
     if (pixmap.isNull()) {
         previewFailed();
     } else {
     if (pixmap.isNull()) {
         previewFailed();
     } else {

-        m_fileMetaDataToolTip->setPreview(pixmap);
+        m_fileMetaDataWidget->setPreview(pixmap);

         if (!m_showToolTipTimer->isActive()) {
             showToolTip();
         }
         if (!m_showToolTipTimer->isActive()) {
             showToolTip();
         }


@@ -155,9 +176,14 @@ void ToolTipManager::previewFailed()
     if (!m_toolTipRequested) {
         return;
     }
     if (!m_toolTipRequested) {
         return;
     }

-
-    const QPixmap pixmap = KIcon(m_item.iconName()).pixmap(128, 128);
-    m_fileMetaDataToolTip->setPreview(pixmap);
+    QPalette pal;
+    for (auto state : { QPalette::Active, QPalette::Inactive, QPalette::Disabled }) {
+        pal.setBrush(state, QPalette::WindowText, pal.toolTipText());
+        pal.setBrush(state, QPalette::Window, pal.toolTipBase());
+    }
+    iconLoader->self.setCustomPalette(pal);
+    const QPixmap pixmap = KDE::icon(m_item.iconName(), &iconLoader->self).pixmap(128, 128);
+    m_fileMetaDataWidget->setPreview(pixmap);

     if (!m_showToolTipTimer->isActive()) {
         showToolTip();
     }
     if (!m_showToolTipTimer->isActive()) {
         showToolTip();
     }


@@ -184,83 +210,22 @@ void ToolTipManager::showToolTip()
         m_appliedWaitCursor = false;
     }
 
         m_appliedWaitCursor = false;
     }
 

-    if (m_fileMetaDataToolTip->preview().isNull() || m_metaDataRequested) {
+    if (m_fileMetaDataWidget->preview().isNull() || m_metaDataRequested) {

         Q_ASSERT(!m_appliedWaitCursor);
         QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));
         m_appliedWaitCursor = true;
         return;
     }
 
         Q_ASSERT(!m_appliedWaitCursor);
         QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));
         m_appliedWaitCursor = true;
         return;
     }
 

-    const QRect screen = QApplication::desktop()->screenGeometry(QCursor::pos());
-
-    // Restrict tooltip size to current screen size when needed.
-    // Because layout controlling widget doesn't respect widget's maximumSize property
-    // (correct me if I'm wrong), we need to let layout do its work, then manually change
-    // geometry if resulting widget doesn't fit the screen.
-
-    // Step #1 - make sizeHint return calculated tooltip size
-    m_fileMetaDataToolTip->layout()->setSizeConstraint(QLayout::SetFixedSize);
-    m_fileMetaDataToolTip->adjustSize();
-    QSize size = m_fileMetaDataToolTip->sizeHint();
-
-    // Step #2 - correct tooltip size when needed
-    if (size.width() > screen.width()) {
-        size.setWidth(screen.width());
-    }
-    if (size.height() > screen.height()) {
-        size.setHeight(screen.height());
-    }
-
-    // m_itemRect defines the area of the item, where the tooltip should be
-    // shown. Per default the tooltip is shown centered at the bottom.
-    // It must be assured that:
-    // - the content is fully visible
-    // - the content is not drawn inside m_itemRect
-    const int margin = toolTipMargin();
-    const bool hasRoomToLeft  = (m_itemRect.left()   - size.width()  - margin >= screen.left());
-    const bool hasRoomToRight = (m_itemRect.right()  + size.width()  + margin <= screen.right());
-    const bool hasRoomAbove   = (m_itemRect.top()    - size.height() - margin >= screen.top());
-    const bool hasRoomBelow   = (m_itemRect.bottom() + size.height() + margin <= screen.bottom());
-    if (!hasRoomAbove && !hasRoomBelow && !hasRoomToLeft && !hasRoomToRight) {
-        return;
-    }
-
-    int x, y;
-    if (hasRoomBelow || hasRoomAbove) {
-        x = qMax(screen.left(), m_itemRect.center().x() - size.width() / 2);
-        if (x + size.width() >= screen.right()) {
-            x = screen.right() - size.width() + 1;
-        }
-        if (hasRoomBelow) {
-            y = m_itemRect.bottom() + margin;
-        } else {
-            y = m_itemRect.top() - size.height() - margin;
-        }
-    } else {
-        Q_ASSERT(hasRoomToLeft || hasRoomToRight);
-        if (hasRoomToRight) {
-            x = m_itemRect.right() + margin;
-        } else {
-            x = m_itemRect.left() - size.width() - margin;
-        }
-        // 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 = screen.bottom() - size.height() + 1;
+    // Adjust the size to get a proper sizeHint()
+    m_fileMetaDataWidget->adjustSize();
+    if (!m_tooltipWidget) {
+        m_tooltipWidget.reset(new KToolTipWidget());

     }
     }

-
-    // Step #3 - Alter tooltip geometry
-    m_fileMetaDataToolTip->setFixedSize(size);
-    m_fileMetaDataToolTip->layout()->setSizeConstraint(QLayout::SetNoConstraint);
-    m_fileMetaDataToolTip->move(QPoint(x, y));
-    m_fileMetaDataToolTip->show();
+    m_tooltipWidget->showBelow(m_itemRect, m_fileMetaDataWidget, m_transientParent);
+    // At this point KToolTipWidget adopted our parent-less metadata widget.
+    m_fileMetaDatWidgetOwnershipTransferred = true;

 
     m_toolTipRequested = false;
 }
 
 
     m_toolTipRequested = false;
 }
 

-int ToolTipManager::toolTipMargin() const
-{
-    const int margin = m_parentWidget->style()->pixelMetric(QStyle::PM_ToolTipLabelFrameWidth);
-    return qMax(4, margin);
-}
-
-#include "tooltipmanager.moc"