qquicktooltip_p.h

Go to the documentation of this file.

// Copyright (C) 2017 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
// Qt-Security score:significant reason:default
 
#ifndef QQUICKTOOLTIP_P_H
#define QQUICKTOOLTIP_P_H
 
//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//
 
#include <QtQml/qqmlparserstatus.h>
#include <QtQuick/private/qquickattachedpropertypropagator_p.h>
#include <QtQuickTemplates2/private/qquickpopup_p.h>
 
QT_BEGIN_NAMESPACE
 
class QQuickToolTipPrivate;
class QQuickToolTipAttached;
class QQuickToolTipAttachedPrivate;
 
class Q_QUICKTEMPLATES2_EXPORT QQuickToolTip : public QQuickPopup
{
    Q_OBJECT
    Q_PROPERTY(int delay READ delay WRITE setDelay NOTIFY delayChanged FINAL)
    Q_PROPERTY(int timeout READ timeout WRITE setTimeout NOTIFY timeoutChanged FINAL)
    Q_PROPERTY(QString text READ text WRITE setText NOTIFY textChanged FINAL)
    QML_NAMED_ELEMENT(ToolTip)
    QML_ATTACHED(QQuickToolTipAttached)
    QML_ADDED_IN_VERSION(2, 0)
 
public:
    explicit QQuickToolTip(QQuickItem *parent = nullptr);
 
    QString text() const;
    void setText(const QString &text);
 
    int delay() const;
    void setDelay(int delay);
 
    int timeout() const;
    void setTimeout(int timeout);
 
    void setVisible(bool visible) override;
 
    static QQuickToolTipAttached *qmlAttachedProperties(QObject *object);
 
    enum Policy {
        Automatic,
        Manual
    };
    Q_ENUM(Policy);
 
Q_SIGNALS:
    void textChanged();
    void delayChanged();
    void timeoutChanged();
 
public Q_SLOTS:
    Q_REVISION(2, 5) void show(const QString &text, int ms = -1);
    Q_REVISION(2, 5) void hide();
 
protected:
    QFont defaultFont() const override;
 
    void itemChange(QQuickItem::ItemChange change, const QQuickItem::ItemChangeData &data) override;
    void timerEvent(QTimerEvent *event) override;
 
#if QT_CONFIG(accessibility)
    QAccessible::Role accessibleRole() const override;
    void accessibilityActiveChanged(bool active) override;
#endif
 
private:
    Q_DISABLE_COPY(QQuickToolTip)
    Q_DECLARE_PRIVATE(QQuickToolTip)
};
 
class Q_QUICKTEMPLATES2_EXPORT QQuickToolTipAttached
    : public QtPrivate::QQuickAttachedPropertyPropagator
    , public QQmlParserStatus
{
    Q_OBJECT
    QML_ANONYMOUS
    Q_INTERFACES(QQmlParserStatus)
    Q_PROPERTY(QString text READ text WRITE setText NOTIFY textChanged FINAL)
    Q_PROPERTY(int delay READ delay WRITE setDelay NOTIFY delayChanged FINAL)
    Q_PROPERTY(int timeout READ timeout WRITE setTimeout NOTIFY timeoutChanged FINAL)
    Q_PROPERTY(bool visible READ isVisible WRITE setVisible NOTIFY visibleChanged FINAL)
    Q_PROPERTY(QQuickToolTip *toolTip READ toolTip CONSTANT FINAL)
    Q_PROPERTY(QQuickToolTip::Policy policy READ policy WRITE setVisiblePolicy
        RESET resetVisiblePolicy NOTIFY policyChanged FINAL)
 
public:
    explicit QQuickToolTipAttached(QObject *parent = nullptr);
 
    QString text() const;
    void setText(const QString &text);
 
    int delay() const;
    void setDelay(int delay);
 
    int timeout() const;
    void setTimeout(int timeout);
 
    bool isVisible() const;
    void setVisible(bool visible);
 
    QQuickToolTip *toolTip() const;
 
    QQuickToolTip::Policy policy() const;
    void setVisiblePolicy(QQuickToolTip::Policy policy);
    void resetVisiblePolicy();
 
Q_SIGNALS:
    void textChanged();
    void delayChanged();
    void timeoutChanged();
    void visibleChanged();
    void policyChanged();
 
public Q_SLOTS:
    void show(const QString &text, int ms = -1);
    void hide();
 
private:
    void attachedParentChange(QQuickAttachedPropertyPropagator *newParent,
        QQuickAttachedPropertyPropagator *oldParent) override;
 
    void classBegin() override;
    void componentComplete() override;
 
    Q_DISABLE_COPY(QQuickToolTipAttached)
    Q_DECLARE_PRIVATE(QQuickToolTipAttached)
};
 
QT_END_NAMESPACE
 
#endif // QQUICKTOOLTIP_P_H