src/views/tooltips/tooltipmanager.cpp

   1 /*******************************************************************************
   2  *   Copyright (C) 2008 by Konstantin Heil <konst.heil@stud.uni-heidelberg.de> *
   3  *                                                                             *
   4  *   This program is free software; you can redistribute it and/or modify      *
   5  *   it under the terms of the GNU General Public License as published by      *
   6  *   the Free Software Foundation; either version 2 of the License, or         *
   7  *   (at your option) any later version.                                       *
   8  *                                                                             *
   9  *   This program is distributed in the hope that it will be useful,           *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of            *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             *
  12  *   GNU General Public License for more details.                              *
  13  *                                                                             *
  14  *   You should have received a copy of the GNU General Public License         *
  15  *   along with this program; if not, write to the                             *
  16  *   Free Software Foundation, Inc.,                                           *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA                *
  18  *******************************************************************************/
  19
  20 #include "tooltipmanager.h"
  21
  22 #include "filemetadatatooltip.h"
  23 #include <KIcon>
  24 #include <KIO/PreviewJob>
  25
  26 #include <QApplication>
  27 #include <QDesktopWidget>
  28 #include <QScrollArea>
  29 #include <QScrollBar>
  30 #include <QTimer>
  31
  32 #include <views/dolphinmodel.h>
  33 #include <views/dolphinsortfilterproxymodel.h>
  34
  35 ToolTipManager::ToolTipManager(QAbstractItemView* parent,
  36                                DolphinSortFilterProxyModel* model) :
  37     QObject(parent),
  38     m_view(parent),
  39     m_dolphinModel(0),
  40     m_proxyModel(model),
  41     m_showToolTipTimer(0),
  42     m_contentRetrievalTimer(0),
  43     m_fileMetaDataToolTip(0),
  44     m_toolTipRequested(false),
  45     m_metaDataRequested(false),
  46     m_item(),
  47     m_itemRect()
  48 {
  49     static FileMetaDataToolTip* sharedToolTip = 0;
  50     if (sharedToolTip == 0) {
  51         sharedToolTip = new FileMetaDataToolTip();
  52         // TODO: Using K_GLOBAL_STATIC would be preferable to maintain the
  53         // instance, but the cleanup of KFileMetaDataWidget at this stage does
  54         // not work.
  55     }
  56     m_fileMetaDataToolTip = sharedToolTip;
  57     connect(m_fileMetaDataToolTip, SIGNAL(metaDataRequestFinished(KFileItemList)),
  58             this, SLOT(slotMetaDataRequestFinished()));
  59
  60     m_dolphinModel = static_cast<DolphinModel*>(m_proxyModel->sourceModel());
  61     connect(parent, SIGNAL(entered(const QModelIndex&)),
  62             this, SLOT(requestToolTip(const QModelIndex&)));
  63     connect(parent, SIGNAL(viewportEntered()),
  64             this, SLOT(hideToolTip()));
  65
  66     // Initialize timers
  67     m_showToolTipTimer = new QTimer(this);
  68     m_showToolTipTimer->setSingleShot(true);
  69     m_showToolTipTimer->setInterval(500);
  70     connect(m_showToolTipTimer, SIGNAL(timeout()), this, SLOT(showToolTip()));
  71
  72     m_contentRetrievalTimer = new QTimer(this);
  73     m_contentRetrievalTimer->setSingleShot(true);
  74     m_contentRetrievalTimer->setInterval(200);
  75     connect(m_contentRetrievalTimer, SIGNAL(timeout()), this, SLOT(startContentRetrieval()));
  76
  77     Q_ASSERT(m_contentRetrievalTimer->interval() < m_showToolTipTimer->interval());
  78
  79     // When the mousewheel is used, the items don't get a hovered indication
  80     // (Qt-issue #200665). To assure that the tooltip still gets hidden,
  81     // the scrollbars are observed.
  82     connect(parent->horizontalScrollBar(), SIGNAL(valueChanged(int)),
  83             this, SLOT(hideToolTip()));
  84     connect(parent->verticalScrollBar(), SIGNAL(valueChanged(int)),
  85             this, SLOT(hideToolTip()));
  86
  87     m_view->viewport()->installEventFilter(this);
  88     m_view->installEventFilter(this);
  89 }
  90
  91 ToolTipManager::~ToolTipManager()
  92 {
  93 }
  94
  95 void ToolTipManager::hideToolTip()
  96 {
  97     QApplication::restoreOverrideCursor();
  98
  99     m_toolTipRequested = false;
 100     m_metaDataRequested = false;
 101     m_showToolTipTimer->stop();
 102     m_contentRetrievalTimer->stop();
 103
 104     m_fileMetaDataToolTip->setItems(KFileItemList());
 105     m_fileMetaDataToolTip->hide();
 106 }
 107
 108 bool ToolTipManager::eventFilter(QObject* watched, QEvent* event)
 109 {
 110     if (watched == m_view->viewport()) {
 111         switch (event->type()) {
 112         case QEvent::Leave:
 113         case QEvent::MouseButtonPress:
 114             hideToolTip();
 115             break;
 116         default:
 117             break;
 118         }
 119     } else if ((watched == m_view) && (event->type() == QEvent::KeyPress)) {
 120         hideToolTip();
 121     }
 122
 123     return QObject::eventFilter(watched, event);
 124 }
 125
 126 void ToolTipManager::requestToolTip(const QModelIndex& index)
 127 {
 128     hideToolTip();
 129
 130     // Only request a tooltip for the name column and when no selection or
 131     // drag & drop operation is done (indicated by the left mouse button)
 132     if ((index.column() == DolphinModel::Name) && !(QApplication::mouseButtons() & Qt::LeftButton)) {
 133         m_itemRect = m_view->visualRect(index);
 134         const QPoint pos = m_view->viewport()->mapToGlobal(m_itemRect.topLeft());
 135         m_itemRect.moveTo(pos);
 136
 137         const QModelIndex dirIndex = m_proxyModel->mapToSource(index);
 138         m_item = m_dolphinModel->itemForIndex(dirIndex);
 139
 140         // Only start the retrieving of the content, when the mouse has been over this
 141         // item for 200 milliseconds. This prevents a lot of useless preview jobs and
 142         // meta data retrieval, when passing rapidly over a lot of items.
 143         m_contentRetrievalTimer->start();
 144         m_showToolTipTimer->start();
 145         m_toolTipRequested = true;
 146         Q_ASSERT(!m_metaDataRequested);
 147     }
 148 }
 149
 150 void ToolTipManager::startContentRetrieval()
 151 {
 152     if (!m_toolTipRequested) {
 153         return;
 154     }
 155
 156     m_fileMetaDataToolTip->setName(m_item.text());
 157
 158     // Request the retrieval of meta-data. The slot
 159     // slotMetaDataRequestFinished() is invoked after the
 160     // meta-data have been received.
 161     m_metaDataRequested = true;
 162     m_fileMetaDataToolTip->setItems(KFileItemList() << m_item);
 163
 164     // Request a preview of the item
 165     m_fileMetaDataToolTip->setPreview(QPixmap());
 166
 167     KIO::PreviewJob* job = KIO::filePreview(KFileItemList() << m_item, 256, 256);
 168
 169     connect(job, SIGNAL(gotPreview(const KFileItem&, const QPixmap&)),
 170             this, SLOT(setPreviewPix(const KFileItem&, const QPixmap&)));
 171     connect(job, SIGNAL(failed(const KFileItem&)),
 172             this, SLOT(previewFailed()));
 173 }
 174
 175
 176 void ToolTipManager::setPreviewPix(const KFileItem& item,
 177                                    const QPixmap& pixmap)
 178 {
 179     if (!m_toolTipRequested || (m_item.url() != item.url())) {
 180         // No tooltip is requested anymore or an old preview has been received
 181         return;
 182     }
 183
 184     if (pixmap.isNull()) {
 185         previewFailed();
 186     } else {
 187         m_fileMetaDataToolTip->setPreview(pixmap);
 188         if (!m_showToolTipTimer->isActive()) {
 189             showToolTip();
 190         }
 191     }
 192 }
 193
 194 void ToolTipManager::previewFailed()
 195 {
 196     if (!m_toolTipRequested) {
 197         return;
 198     }
 199
 200     const QPixmap pixmap = KIcon(m_item.iconName()).pixmap(128, 128);
 201     m_fileMetaDataToolTip->setPreview(pixmap);
 202     if (!m_showToolTipTimer->isActive()) {
 203         showToolTip();
 204     }
 205 }
 206
 207 void ToolTipManager::slotMetaDataRequestFinished()
 208 {
 209     if (!m_toolTipRequested) {
 210         return;
 211     }
 212
 213     m_metaDataRequested = false;
 214     if (!m_showToolTipTimer->isActive()) {
 215         showToolTip();
 216     }
 217 }
 218
 219 void ToolTipManager::showToolTip()
 220 {
 221     Q_ASSERT(m_toolTipRequested);
 222     QApplication::restoreOverrideCursor();
 223
 224     if (QApplication::mouseButtons() & Qt::LeftButton) {
 225         return;
 226     }
 227
 228     if (m_fileMetaDataToolTip->preview().isNull() || m_metaDataRequested) {
 229         QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));
 230         return;
 231     }
 232
 233     const QRect screen = QApplication::desktop()->screenGeometry(QCursor::pos());
 234
 235     // Restrict tooltip size to current screen size when needed.
 236     // Because layout controlling widget doesn't respect widget's maximumSize property
 237     // (correct me if I'm wrong), we need to let layout do its work, then manually change
 238     // geometry if resulting widget doesn't fit the screen.
 239
 240     // Step #1 - make sizeHint return calculated tooltip size
 241     m_fileMetaDataToolTip->layout()->setSizeConstraint(QLayout::SetFixedSize);
 242     m_fileMetaDataToolTip->adjustSize();
 243     QSize size = m_fileMetaDataToolTip->sizeHint();
 244
 245     // Step #2 - correct tooltip size when needed
 246     if (size.width() > screen.width()) {
 247         size.setWidth(screen.width());
 248     }
 249     if (size.height() > screen.height()) {
 250         size.setHeight(screen.height());
 251     }
 252
 253     // m_itemRect defines the area of the item, where the tooltip should be
 254     // shown. Per default the tooltip is shown in the bottom right corner.
 255     // It must be assured that:
 256     // - the content is fully visible
 257     // - the content is not drawn inside m_itemRect
 258     const bool hasRoomToLeft  = (m_itemRect.left()   - size.width()  >= screen.left());
 259     const bool hasRoomToRight = (m_itemRect.right()  + size.width()  <= screen.right());
 260     const bool hasRoomAbove   = (m_itemRect.top()    - size.height() >= screen.top());
 261     const bool hasRoomBelow   = (m_itemRect.bottom() + size.height() <= screen.bottom());
 262     if (!hasRoomAbove && !hasRoomBelow && !hasRoomToLeft && !hasRoomToRight) {
 263         return;
 264     }
 265
 266     int x, y;
 267     if (hasRoomBelow || hasRoomAbove) {
 268         x = QCursor::pos().x() + 16; // TODO: use mouse pointer width instead of the magic value of 16
 269         if (x + size.width() >= screen.right()) {
 270             x = screen.right() - size.width() + 1;
 271         }
 272         if (hasRoomBelow) {
 273             y = m_itemRect.bottom() + 1;
 274         } else {
 275             y = m_itemRect.top() - size.height();
 276         }
 277     } else {
 278         Q_ASSERT(hasRoomToLeft || hasRoomToRight);
 279         if (hasRoomToRight) {
 280             x = m_itemRect.right() + 1;
 281         } else {
 282             x = m_itemRect.left() - size.width();
 283         }
 284         // Put the tooltip at the bottom of the screen. The x-coordinate has already
 285         // been adjusted, so that no overlapping with m_itemRect occurs.
 286         y = screen.bottom() - size.height() + 1;
 287     }
 288
 289     // Step #3 - Alter tooltip geometry
 290     m_fileMetaDataToolTip->setFixedSize(size);
 291     m_fileMetaDataToolTip->layout()->setSizeConstraint(QLayout::SetNoConstraint);
 292     m_fileMetaDataToolTip->setGeometry(x, y, size.width(), size.height());
 293     m_fileMetaDataToolTip->show();
 294
 295     m_toolTipRequested = false;
 296 }
 297
 298 #include "tooltipmanager.moc"