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