qtoolbutton.h

Go to the documentation of this file.

// Copyright (C) 2016 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
 
#ifndef QTOOLBUTTON_H
#define QTOOLBUTTON_H
 
#include <QtWidgets/qtwidgetsglobal.h>
 
#include <QtWidgets/qabstractbutton.h>
 
QT_REQUIRE_CONFIG(toolbutton);
 
QT_BEGIN_NAMESPACE
 
class QToolButtonPrivate;
class QMenu;
class QStyleOptionToolButton;
 
class Q_WIDGETS_EXPORT QToolButton : public QAbstractButton
{
    Q_OBJECT
    Q_ENUMS(Qt::ToolButtonStyle Qt::ArrowType)
#if QT_CONFIG(menu)
    Q_PROPERTY(ToolButtonPopupMode popupMode READ popupMode WRITE setPopupMode)
#endif
    Q_PROPERTY(Qt::ToolButtonStyle toolButtonStyle READ toolButtonStyle WRITE setToolButtonStyle)
    Q_PROPERTY(bool autoRaise READ autoRaise WRITE setAutoRaise)
    Q_PROPERTY(Qt::ArrowType arrowType READ arrowType WRITE setArrowType)
 
public:
    enum ToolButtonPopupMode {
        DelayedPopup,
        MenuButtonPopup,
        InstantPopup
    };
    Q_ENUM(ToolButtonPopupMode)
 
    explicit QToolButton(QWidget *parent = nullptr);
    ~QToolButton();
 
    QSize sizeHint() const override;
    QSize minimumSizeHint() const override;
 
    Qt::ToolButtonStyle toolButtonStyle() const;
 
    Qt::ArrowType arrowType() const;
    void setArrowType(Qt::ArrowType type);
 
#if QT_CONFIG(menu)
    void setMenu(QMenu* menu);
    QMenu* menu() const;
 
    void setPopupMode(ToolButtonPopupMode mode);
    ToolButtonPopupMode popupMode() const;
#endif
 
    QAction *defaultAction() const;
 
    void setAutoRaise(bool enable);
    bool autoRaise() const;
 
public Q_SLOTS:
#if QT_CONFIG(menu)
    void showMenu();
#endif
    void setToolButtonStyle(Qt::ToolButtonStyle style);
    void setDefaultAction(QAction *);
 
Q_SIGNALS:
    void triggered(QAction *);
 
protected:
    bool event(QEvent *e) override;
    void mousePressEvent(QMouseEvent *) override;
    void mouseReleaseEvent(QMouseEvent *) override;
    void paintEvent(QPaintEvent *) override;
    void actionEvent(QActionEvent *) override;
 
    void enterEvent(QEnterEvent *) override;
    void leaveEvent(QEvent *) override;
    void timerEvent(QTimerEvent *) override;
    void changeEvent(QEvent *) override;
 
    bool hitButton(const QPoint &pos) const override;
    void checkStateSet() override;
    void nextCheckState() override;
    virtual void initStyleOption(QStyleOptionToolButton *option) const;
 
private:
    Q_DISABLE_COPY(QToolButton)
    Q_DECLARE_PRIVATE(QToolButton)
};
 
QT_END_NAMESPACE
 
#endif // QTOOLBUTTON_H