src/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.h>
  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(QAbstractItemView* parent,
  48                             DolphinSortFilterProxyModel* model);
  49     virtual ~ToolTipManager();
  50
  51 public slots:
  52     /**
  53      * Hides the currently shown tooltip. Invoking this method is
  54      * only needed when the tooltip should be hidden although
  55      * an item is hovered.
  56      */
  57     void hideTip();
  58
  59 protected:
  60     virtual bool eventFilter(QObject* watched, QEvent* event);
  61
  62 private slots:
  63     void requestToolTip(const QModelIndex& index);
  64     void hideToolTip();
  65     void prepareToolTip();
  66     void startPreviewJob();
  67     void setPreviewPix(const KFileItem& item, const QPixmap& pix);
  68     void previewFailed();
  69     void showToolTip();
  70
  71 private:
  72     void showToolTipDelayed(const QPixmap& pixmap);
  73
  74 private:
  75     QAbstractItemView* m_view;
  76     DolphinModel* m_dolphinModel;
  77     DolphinSortFilterProxyModel* m_proxyModel;
  78
  79     /// Timeout from requesting a tooltip until the tooltip is shown
  80     QTimer* m_prepareToolTipTimer;
  81
  82     /// Timeout from requesting a tooltip until starting a job to
  83     /// create a preview pixmap. The preview job is started before
  84     /// m_prepareToolTipTimer has been exceeded, to have the preview
  85     /// pixmap ideally before the tooltip will be shown.
  86     QTimer* m_startPreviewJobTimer;
  87
  88     /// Don't show the tooltip, before the preview has been received. The
  89     /// time indicates the interval, when the check for a received
  90     /// is done.
  91     QTimer* m_waitOnPreviewTimer;
  92
  93     /// The tooltip is shown slightly delayed to prevent a flickering
  94     /// because of layouting the content.
  95     QTimer* m_showToolTipDelayedTimer;
  96
  97     FileMetaDataToolTip* m_fileMetaDataToolTip;
  98
  99     KFileItem m_item;
 100     QRect m_itemRect;
 101     bool m_generatingPreview;
 102     bool m_hasDefaultIcon;
 103     QPixmap m_previewPixmap;
 104 };
 105
 106 #endif