src/views/tooltips/tooltipmanager.cpp

   1 /*
   2  * SPDX-FileCopyrightText: 2008 Konstantin Heil <konst.heil@stud.uni-heidelberg.de>
   3  *
   4  * SPDX-License-Identifier: GPL-2.0-or-later
   5  */
   6
   7 #include "tooltipmanager.h"
   8
   9 #include "dolphinfilemetadatawidget.h"
  10
  11 #include <KIO/JobUiDelegate>
  12 #include <KIO/PreviewJob>
  13 #include <KJobWidgets>
  14 #include <KToolTipWidget>
  15 #include <KIconLoader>
  16
  17 #include <QApplication>
  18 #include <QDesktopWidget>
  19 #include <QIcon>
  20 #include <QLayout>
  21 #include <QStyle>
  22 #include <QTimer>
  23 #include <QWindow>
  24
  25 class IconLoaderSingleton {
  26 public:
  27     IconLoaderSingleton() = default;
  28
  29     KIconLoader self;
  30 };
  31
  32 Q_GLOBAL_STATIC(IconLoaderSingleton, iconLoader)
  33
  34 ToolTipManager::ToolTipManager(QWidget* parent) :
  35     QObject(parent),
  36     m_showToolTipTimer(nullptr),
  37     m_contentRetrievalTimer(nullptr),
  38     m_transientParent(nullptr),
  39     m_fileMetaDataWidget(nullptr),
  40     m_toolTipRequested(false),
  41     m_metaDataRequested(false),
  42     m_appliedWaitCursor(false),
  43     m_margin(4),
  44     m_item(),
  45     m_itemRect()
  46 {
  47     if (parent) {
  48         m_margin = qMax(m_margin, parent->style()->pixelMetric(QStyle::PM_ToolTipLabelFrameWidth));
  49     }
  50
  51     m_showToolTipTimer = new QTimer(this);
  52     m_showToolTipTimer->setSingleShot(true);
  53     m_showToolTipTimer->setInterval(500);
  54     connect(m_showToolTipTimer, &QTimer::timeout, this, QOverload<>::of(&ToolTipManager::showToolTip));
  55
  56     m_contentRetrievalTimer = new QTimer(this);
  57     m_contentRetrievalTimer->setSingleShot(true);
  58     m_contentRetrievalTimer->setInterval(200);
  59     connect(m_contentRetrievalTimer, &QTimer::timeout, this, &ToolTipManager::startContentRetrieval);
  60
  61     Q_ASSERT(m_contentRetrievalTimer->interval() < m_showToolTipTimer->interval());
  62 }
  63
  64 ToolTipManager::~ToolTipManager()
  65 {
  66 }
  67
  68 void ToolTipManager::showToolTip(const KFileItem& item, const QRectF& itemRect, QWindow *transientParent)
  69 {
  70     hideToolTip();
  71
  72     m_itemRect = itemRect.toRect();
  73
  74     m_itemRect.adjust(-m_margin, -m_margin, m_margin, m_margin);
  75     m_item = item;
  76
  77     m_transientParent = transientParent;
  78
  79     // Only start the retrieving of the content, when the mouse has been over this
  80     // item for 200 milliseconds. This prevents a lot of useless preview jobs and
  81     // meta data retrieval, when passing rapidly over a lot of items.
  82     m_fileMetaDataWidget.reset(new DolphinFileMetaDataWidget());
  83     connect(m_fileMetaDataWidget.data(), &DolphinFileMetaDataWidget::metaDataRequestFinished,
  84             this, &ToolTipManager::slotMetaDataRequestFinished);
  85     connect(m_fileMetaDataWidget.data(), &DolphinFileMetaDataWidget::urlActivated,
  86             this, &ToolTipManager::urlActivated);
  87
  88     m_contentRetrievalTimer->start();
  89     m_showToolTipTimer->start();
  90     m_toolTipRequested = true;
  91     Q_ASSERT(!m_metaDataRequested);
  92 }
  93
  94 void ToolTipManager::hideToolTip(const HideBehavior behavior)
  95 {
  96     if (m_appliedWaitCursor) {
  97         QApplication::restoreOverrideCursor();
  98         m_appliedWaitCursor = false;
  99     }
 100
 101     m_toolTipRequested = false;
 102     m_metaDataRequested = false;
 103     m_showToolTipTimer->stop();
 104     m_contentRetrievalTimer->stop();
 105     if (m_tooltipWidget) {
 106         switch (behavior) {
 107         case HideBehavior::Instantly:
 108             m_tooltipWidget->hide();
 109             break;
 110         case HideBehavior::Later:
 111             m_tooltipWidget->hideLater();
 112             break;
 113         }
 114     }
 115 }
 116
 117 void ToolTipManager::startContentRetrieval()
 118 {
 119     if (!m_toolTipRequested) {
 120         return;
 121     }
 122
 123     m_fileMetaDataWidget->setName(m_item.text());
 124
 125     // Request the retrieval of meta-data. The slot
 126     // slotMetaDataRequestFinished() is invoked after the
 127     // meta-data have been received.
 128     m_metaDataRequested = true;
 129     m_fileMetaDataWidget->setItems(KFileItemList() << m_item);
 130     m_fileMetaDataWidget->adjustSize();
 131
 132     // Request a preview of the item
 133     m_fileMetaDataWidget->setPreview(QPixmap());
 134
 135     QStringList plugins = KIO::PreviewJob::availablePlugins();
 136     KIO::PreviewJob* job = new KIO::PreviewJob(KFileItemList() << m_item,
 137                                                QSize(256, 256),
 138                                                &plugins);
 139     job->setIgnoreMaximumSize(m_item.isLocalFile());
 140     if (job->uiDelegate()) {
 141         KJobWidgets::setWindow(job, qApp->activeWindow());
 142     }
 143
 144     connect(job, &KIO::PreviewJob::gotPreview,
 145             this, &ToolTipManager::setPreviewPix);
 146     connect(job, &KIO::PreviewJob::failed,
 147             this, &ToolTipManager::previewFailed);
 148 }
 149
 150
 151 void ToolTipManager::setPreviewPix(const KFileItem& item,
 152                                    const QPixmap& pixmap)
 153 {
 154     if (!m_toolTipRequested || (m_item.url() != item.url())) {
 155         // No tooltip is requested anymore or an old preview has been received
 156         return;
 157     }
 158
 159     if (pixmap.isNull()) {
 160         previewFailed();
 161     } else {
 162         m_fileMetaDataWidget->setPreview(pixmap);
 163         if (!m_showToolTipTimer->isActive()) {
 164             showToolTip();
 165         }
 166     }
 167 }
 168
 169 void ToolTipManager::previewFailed()
 170 {
 171     if (!m_toolTipRequested) {
 172         return;
 173     }
 174     QPalette pal;
 175     for (auto state : { QPalette::Active, QPalette::Inactive, QPalette::Disabled }) {
 176         pal.setBrush(state, QPalette::WindowText, pal.toolTipText());
 177         pal.setBrush(state, QPalette::Window, pal.toolTipBase());
 178     }
 179     iconLoader->self.setCustomPalette(pal);
 180     const QPixmap pixmap = KDE::icon(m_item.iconName(), &iconLoader->self).pixmap(128, 128);
 181     m_fileMetaDataWidget->setPreview(pixmap);
 182     if (!m_showToolTipTimer->isActive()) {
 183         showToolTip();
 184     }
 185 }
 186
 187 void ToolTipManager::slotMetaDataRequestFinished()
 188 {
 189     if (!m_toolTipRequested) {
 190         return;
 191     }
 192
 193     m_metaDataRequested = false;
 194
 195     if (!m_showToolTipTimer->isActive()) {
 196         showToolTip();
 197     }
 198 }
 199
 200 void ToolTipManager::showToolTip()
 201 {
 202     Q_ASSERT(m_toolTipRequested);
 203     if (m_appliedWaitCursor) {
 204         QApplication::restoreOverrideCursor();
 205         m_appliedWaitCursor = false;
 206     }
 207
 208     if (m_fileMetaDataWidget->preview().isNull() || m_metaDataRequested) {
 209         Q_ASSERT(!m_appliedWaitCursor);
 210         QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));
 211         m_appliedWaitCursor = true;
 212         return;
 213     }
 214
 215     // Adjust the size to get a proper sizeHint()
 216     m_fileMetaDataWidget->adjustSize();
 217     if (!m_tooltipWidget) {
 218         m_tooltipWidget.reset(new KToolTipWidget());
 219     }
 220     m_tooltipWidget->showBelow(m_itemRect, m_fileMetaDataWidget.data(), m_transientParent);
 221     m_toolTipRequested = false;
 222 }
 223