-/*******************************************************************************
- * 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 "filemetadatatooltip.h"
-#include <KIcon>
+#include "dolphinfilemetadatawidget.h"
+
+#include <KIO/JobUiDelegate>
#include <KIO/PreviewJob>
+#include <KConfigGroup>
+#include <KJobWidgets>
+#include <KSharedConfig>
+#include <KToolTipWidget>
+#include <KIconLoader>
#include <QApplication>
#include <QDesktopWidget>
-#include <QScrollArea>
-#include <QScrollBar>
+#include <QIcon>
+#include <QLayout>
+#include <QStyle>
#include <QTimer>
+#include <QWindow>
+
+class IconLoaderSingleton {
+public:
+ IconLoaderSingleton() = default;
-#include <views/dolphinmodel.h>
-#include <views/dolphinsortfilterproxymodel.h>
+ KIconLoader self;
+};
-ToolTipManager::ToolTipManager(QAbstractItemView* parent,
- DolphinSortFilterProxyModel* model) :
+Q_GLOBAL_STATIC(IconLoaderSingleton, iconLoader)
+
+ToolTipManager::ToolTipManager(QWidget* parent) :
QObject(parent),
- m_view(parent),
- m_dolphinModel(0),
- m_proxyModel(model),
- m_showToolTipTimer(0),
- m_contentRetrievalTimer(0),
- m_fileMetaDataToolTip(0),
+ m_showToolTipTimer(nullptr),
+ m_contentRetrievalTimer(nullptr),
+ m_transientParent(nullptr),
+ m_fileMetaDataWidget(nullptr),
m_toolTipRequested(false),
m_metaDataRequested(false),
+ m_appliedWaitCursor(false),
+ m_margin(4),
m_item(),
m_itemRect()
{
- 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 KFileMetaDataWidget at this stage does
- // not work.
+ if (parent) {
+ m_margin = qMax(m_margin, parent->style()->pixelMetric(QStyle::PM_ToolTipLabelFrameWidth));
}
- m_fileMetaDataToolTip = sharedToolTip;
- connect(m_fileMetaDataToolTip, SIGNAL(metaDataRequestFinished(KFileItemList)),
- this, SLOT(slotMetaDataRequestFinished()));
-
- m_dolphinModel = static_cast<DolphinModel*>(m_proxyModel->sourceModel());
- connect(parent, SIGNAL(entered(const QModelIndex&)),
- this, SLOT(requestToolTip(const QModelIndex&)));
- connect(parent, SIGNAL(viewportEntered()),
- this, SLOT(hideToolTip()));
- // Initialize timers
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);
- connect(m_contentRetrievalTimer, SIGNAL(timeout()), this, SLOT(startContentRetrieval()));
+ connect(m_contentRetrievalTimer, &QTimer::timeout, this, &ToolTipManager::startContentRetrieval);
Q_ASSERT(m_contentRetrievalTimer->interval() < m_showToolTipTimer->interval());
-
- // 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(hideToolTip()));
- connect(parent->verticalScrollBar(), SIGNAL(valueChanged(int)),
- this, SLOT(hideToolTip()));
-
- m_view->viewport()->installEventFilter(this);
- m_view->installEventFilter(this);
}
ToolTipManager::~ToolTipManager()
{
}
-void ToolTipManager::hideToolTip()
+void ToolTipManager::showToolTip(const KFileItem& item, const QRectF& itemRect, QWindow *transientParent)
{
- QApplication::restoreOverrideCursor();
+ hideToolTip();
- m_toolTipRequested = false;
- m_metaDataRequested = false;
- m_showToolTipTimer->stop();
- m_contentRetrievalTimer->stop();
+ m_itemRect = itemRect.toRect();
- m_fileMetaDataToolTip->setItems(KFileItemList());
- m_fileMetaDataToolTip->hide();
-}
+ m_itemRect.adjust(-m_margin, -m_margin, m_margin, m_margin);
+ m_item = item;
-bool ToolTipManager::eventFilter(QObject* watched, QEvent* event)
-{
- 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();
- }
+ 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.
+ m_fileMetaDataWidget.reset(new DolphinFileMetaDataWidget());
+ connect(m_fileMetaDataWidget.data(), &DolphinFileMetaDataWidget::metaDataRequestFinished,
+ this, &ToolTipManager::slotMetaDataRequestFinished);
+ connect(m_fileMetaDataWidget.data(), &DolphinFileMetaDataWidget::urlActivated,
+ this, &ToolTipManager::urlActivated);
- return QObject::eventFilter(watched, event);
+ m_contentRetrievalTimer->start();
+ m_showToolTipTimer->start();
+ m_toolTipRequested = true;
+ Q_ASSERT(!m_metaDataRequested);
}
-void ToolTipManager::requestToolTip(const QModelIndex& index)
+void ToolTipManager::hideToolTip(const HideBehavior behavior)
{
- hideToolTip();
+ if (m_appliedWaitCursor) {
+ QApplication::restoreOverrideCursor();
+ m_appliedWaitCursor = false;
+ }
- // 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_itemRect = m_view->visualRect(index);
- const QPoint pos = m_view->viewport()->mapToGlobal(m_itemRect.topLeft());
- m_itemRect.moveTo(pos);
-
- const QModelIndex dirIndex = m_proxyModel->mapToSource(index);
- m_item = m_dolphinModel->itemForIndex(dirIndex);
-
- // 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.
- m_contentRetrievalTimer->start();
- m_showToolTipTimer->start();
- m_toolTipRequested = true;
- Q_ASSERT(!m_metaDataRequested);
+ m_toolTipRequested = false;
+ m_metaDataRequested = false;
+ m_showToolTipTimer->stop();
+ m_contentRetrievalTimer->stop();
+ if (m_tooltipWidget) {
+ switch (behavior) {
+ case HideBehavior::Instantly:
+ m_tooltipWidget->hide();
+ break;
+ case HideBehavior::Later:
+ m_tooltipWidget->hideLater();
+ break;
+ }
}
}
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;
- m_fileMetaDataToolTip->setItems(KFileItemList() << m_item);
-
- 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()));
+ m_fileMetaDataWidget->setItems(KFileItemList() << m_item);
+ m_fileMetaDataWidget->adjustSize();
+
+ // Request a preview of the item
+ 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());
+ if (job->uiDelegate()) {
+ KJobWidgets::setWindow(job, qApp->activeWindow());
+ }
+
+ connect(job, &KIO::PreviewJob::gotPreview,
+ this, &ToolTipManager::setPreviewPix);
+ connect(job, &KIO::PreviewJob::failed,
+ this, &ToolTipManager::previewFailed);
}
if (pixmap.isNull()) {
previewFailed();
} else {
- m_fileMetaDataToolTip->setPreview(pixmap);
+ m_fileMetaDataWidget->setPreview(pixmap);
if (!m_showToolTipTimer->isActive()) {
showToolTip();
}
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();
}
}
m_metaDataRequested = false;
+
if (!m_showToolTipTimer->isActive()) {
showToolTip();
}
void ToolTipManager::showToolTip()
{
Q_ASSERT(m_toolTipRequested);
- QApplication::restoreOverrideCursor();
-
- if (QApplication::mouseButtons() & Qt::LeftButton) {
- return;
+ if (m_appliedWaitCursor) {
+ QApplication::restoreOverrideCursor();
+ 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;
}
- 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 in the bottom right corner.
- // It must be assured that:
- // - the content is fully visible
- // - the content is not drawn inside m_itemRect
- const bool hasRoomToLeft = (m_itemRect.left() - size.width() >= screen.left());
- const bool hasRoomToRight = (m_itemRect.right() + size.width() <= screen.right());
- const bool hasRoomAbove = (m_itemRect.top() - size.height() >= screen.top());
- const bool hasRoomBelow = (m_itemRect.bottom() + size.height() <= screen.bottom());
- if (!hasRoomAbove && !hasRoomBelow && !hasRoomToLeft && !hasRoomToRight) {
- return;
- }
-
- int x, y;
- if (hasRoomBelow || hasRoomAbove) {
- x = QCursor::pos().x() + 16; // TODO: use mouse pointer width instead of the magic value of 16
- if (x + size.width() >= screen.right()) {
- x = screen.right() - size.width() + 1;
- }
- if (hasRoomBelow) {
- y = m_itemRect.bottom() + 1;
- } else {
- y = m_itemRect.top() - size.height();
- }
- } else {
- Q_ASSERT(hasRoomToLeft || hasRoomToRight);
- if (hasRoomToRight) {
- x = m_itemRect.right() + 1;
- } else {
- x = 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 = 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->setGeometry(x, y, size.width(), size.height());
- m_fileMetaDataToolTip->show();
-
+ m_tooltipWidget->showBelow(m_itemRect, m_fileMetaDataWidget.data(), m_transientParent);
m_toolTipRequested = false;
}
-#include "tooltipmanager.moc"