src/views/tooltips/tooltipmanager.h

   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 #ifndef TOOLTIPMANAGER_H
  21 #define TOOLTIPMANAGER_H
  22
  23 #include <QObject>
  24 #include <QRect>
  25
  26 #include <KFileItem>
  27
  28 class DolphinModel;
  29 class DolphinSortFilterProxyModel;
  30 class FileMetaDataToolTip;
  31 class QAbstractItemView;
  32 class QModelIndex;
  33 class QTimer;
  34
  35 /**
  36  * @brief Manages the tooltips for an item view.
  37  *
  38  * When hovering an item, a tooltip is shown after
  39  * a short timeout. The tooltip is hidden again when the
  40  * viewport is hovered or the item view has been left.
  41  */
  42 class ToolTipManager : public QObject
  43 {
  44     Q_OBJECT
  45
  46 public:
  47     explicit ToolTipManager(QWidget* parent);
  48     virtual ~ToolTipManager();
  49
  50     /**
  51      * Triggers the showing of the tooltip for the item \p item
  52      * where the item has the maximum boundaries of \p itemRect.
  53      * The tooltip manager takes care that the tooltip is shown
  54      * slightly delayed.
  55      */
  56     void showToolTip(const KFileItem& item, const QRectF& itemRect);
  57
  58     /**
  59      * Hides the currently shown tooltip.
  60      */
  61     void hideToolTip();
  62
  63 private slots:
  64     void startContentRetrieval();
  65     void setPreviewPix(const KFileItem& item, const QPixmap& pix);
  66     void previewFailed();
  67     void slotMetaDataRequestFinished();
  68     void showToolTip();
  69
  70 private:
  71     /// Timeout from requesting a tooltip until the tooltip
  72     /// should be shown
  73     QTimer* m_showToolTipTimer;
  74
  75     /// Timeout from requesting a tooltip until the retrieving of
  76     /// the tooltip content like preview and meta data gets started.
  77     QTimer* m_contentRetrievalTimer;
  78
  79     FileMetaDataToolTip* m_fileMetaDataToolTip;
  80
  81     bool m_toolTipRequested;
  82     bool m_metaDataRequested;
  83     bool m_appliedWaitCursor;
  84     int m_margin;
  85     KFileItem m_item;
  86     QRect m_itemRect;
  87 };
  88
  89 #endif