QCustomTooltip.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Widgets
File: QCustomTooltip
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <QString>
#include <QPoint>
#include <QLabel>
#include <QBasicTimer>
#include <QPointer>
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief Provides tool tips (balloon help) for any widget that usually shows up when a mouse is hovered
        over a widget for a set amount of time.
     *-----------------------------------------------------------------------------------------------**/
    class NDEVR_WIDGETS_API QCustomTooltip : public QLabel
    {
        Q_OBJECT
    public:
        QCustomTooltip(const QString &text, const QPointF &pos, QWidget* parent = nullptr);
        ~QCustomTooltip();
        void updateSize(const QPointF &pos);
        bool eventFilter(QObject *, QEvent *) override;
        void reuseTip(const QString &text, const QPointF &pos);
        void hideTip();
        void hideTipImmediately(int animation_duration = -1);
        void setTipRect(QWidget *w, const QRect &r);
        bool tipChanged(const QPointF &pos, const QString &text, QObject *o);
        void placeTip(const QPointF &pos, QWidget *w);
        static QCustomTooltip* show(const QString &text, const QPointF &pos, QWidget *w, int animation_duration = -1);
        static void hide(int animation_duration = -1);
        static bool IsShowing();
        int margin() const;
        QSize sizeHint() const override;
        void setTargetOffset(QPoint target_offset);
    protected:
        void timerEvent(QTimerEvent *e) override;
        void paintEvent(QPaintEvent *e) override;
        void mouseMoveEvent(QMouseEvent *e) override;
        void resizeEvent(QResizeEvent *e) override;
    public slots:
        void styleSheetParentDestroyed();
    private:
        QWidget *styleSheetParent;
        int animation_duration = -1;
    private:
        static QPointer<QCustomTooltip> s_instance;
        QPointer<QWidget> m_widget;
        QRect m_rect;
        QPoint m_target_offset;
        QBasicTimer m_hide_timer;
    };
}