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 <KFileItem>
  24
  25 #include <QObject>
  26 #include <QRect>
  27
  28 class DolphinFileMetaDataWidget;
  29 class KToolTipWidget;
  30 class QTimer;
  31 class QWindow;
  32
  33 /**
  34  * @brief Manages the tooltips for an item view.
  35  *
  36  * When hovering an item, a tooltip is shown after
  37  * a short timeout. The tooltip is hidden again when the
  38  * viewport is hovered or the item view has been left.
  39  */
  40 class ToolTipManager : public QObject
  41 {
  42     Q_OBJECT
  43
  44 public:
  45     enum class HideBehavior {
  46         Instantly,
  47         Later
  48     };
  49
  50     explicit ToolTipManager(QWidget* parent);
  51     ~ToolTipManager() override;
  52
  53     /**
  54      * Triggers the showing of the tooltip for the item \p item
  55      * where the item has the maximum boundaries of \p itemRect.
  56      * The tooltip manager takes care that the tooltip is shown
  57      * slightly delayed and with a proper \p transientParent.
  58      */
  59     void showToolTip(const KFileItem& item, const QRectF& itemRect, QWindow *transientParent);
  60
  61     /**
  62      * Hides the currently shown tooltip.
  63      */
  64     void hideToolTip(const HideBehavior behavior = HideBehavior::Later);
  65
  66 signals:
  67     /**
  68      * Is emitted when the user clicks a tag or a link
  69      * in the metadata widget.
  70      */
  71     void urlActivated(const QUrl& url);
  72
  73 private slots:
  74     void startContentRetrieval();
  75     void setPreviewPix(const KFileItem& item, const QPixmap& pix);
  76     void previewFailed();
  77     void slotMetaDataRequestFinished();
  78     void showToolTip();
  79
  80 private:
  81     /// Timeout from requesting a tooltip until the tooltip
  82     /// should be shown
  83     QTimer* m_showToolTipTimer;
  84
  85     /// Timeout from requesting a tooltip until the retrieving of
  86     /// the tooltip content like preview and meta data gets started.
  87     QTimer* m_contentRetrievalTimer;
  88
  89     /// Transient parent of the tooltip, mandatory on Wayland.
  90     QWindow* m_transientParent;
  91
  92     QScopedPointer<KToolTipWidget> m_tooltipWidget;
  93     QScopedPointer<DolphinFileMetaDataWidget> m_fileMetaDataWidget;
  94
  95     bool m_toolTipRequested;
  96     bool m_metaDataRequested;
  97     bool m_appliedWaitCursor;
  98     int m_margin;
  99     KFileItem m_item;
 100     QRect m_itemRect;
 101 };
 102
 103 #endif