1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtWidgets module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QTOOLBUTTON_H
41#define QTOOLBUTTON_H
42
43#include <QtWidgets/qtwidgetsglobal.h>
44
45#include <QtWidgets/qabstractbutton.h>
46
47QT_REQUIRE_CONFIG(toolbutton);
48
49QT_BEGIN_NAMESPACE
50
51class QToolButtonPrivate;
52class QMenu;
53class QStyleOptionToolButton;
54
55class Q_WIDGETS_EXPORT QToolButton : public QAbstractButton
56{
57 Q_OBJECT
58 Q_ENUMS(Qt::ToolButtonStyle Qt::ArrowType)
59#if QT_CONFIG(menu)
60 Q_PROPERTY(ToolButtonPopupMode popupMode READ popupMode WRITE setPopupMode)
61#endif
62 Q_PROPERTY(Qt::ToolButtonStyle toolButtonStyle READ toolButtonStyle WRITE setToolButtonStyle)
63 Q_PROPERTY(bool autoRaise READ autoRaise WRITE setAutoRaise)
64 Q_PROPERTY(Qt::ArrowType arrowType READ arrowType WRITE setArrowType)
65
66public:
67 enum ToolButtonPopupMode {
68 DelayedPopup,
69 MenuButtonPopup,
70 InstantPopup
71 };
72 Q_ENUM(ToolButtonPopupMode)
73
74 explicit QToolButton(QWidget *parent = nullptr);
75 ~QToolButton();
76
77 QSize sizeHint() const override;
78 QSize minimumSizeHint() const override;
79
80 Qt::ToolButtonStyle toolButtonStyle() const;
81
82 Qt::ArrowType arrowType() const;
83 void setArrowType(Qt::ArrowType type);
84
85#if QT_CONFIG(menu)
86 void setMenu(QMenu* menu);
87 QMenu* menu() const;
88
89 void setPopupMode(ToolButtonPopupMode mode);
90 ToolButtonPopupMode popupMode() const;
91#endif
92
93 QAction *defaultAction() const;
94
95 void setAutoRaise(bool enable);
96 bool autoRaise() const;
97
98public Q_SLOTS:
99#if QT_CONFIG(menu)
100 void showMenu();
101#endif
102 void setToolButtonStyle(Qt::ToolButtonStyle style);
103 void setDefaultAction(QAction *);
104
105Q_SIGNALS:
106 void triggered(QAction *);
107
108protected:
109 bool event(QEvent *e) override;
110 void mousePressEvent(QMouseEvent *) override;
111 void mouseReleaseEvent(QMouseEvent *) override;
112 void paintEvent(QPaintEvent *) override;
113 void actionEvent(QActionEvent *) override;
114
115 void enterEvent(QEvent *) override;
116 void leaveEvent(QEvent *) override;
117 void timerEvent(QTimerEvent *) override;
118 void changeEvent(QEvent *) override;
119
120 bool hitButton(const QPoint &pos) const override;
121 void nextCheckState() override;
122 void initStyleOption(QStyleOptionToolButton *option) const;
123
124private:
125 Q_DISABLE_COPY(QToolButton)
126 Q_DECLARE_PRIVATE(QToolButton)
127#if QT_CONFIG(menu)
128 Q_PRIVATE_SLOT(d_func(), void _q_buttonPressed())
129 Q_PRIVATE_SLOT(d_func(), void _q_buttonReleased())
130 Q_PRIVATE_SLOT(d_func(), void _q_updateButtonDown())
131 Q_PRIVATE_SLOT(d_func(), void _q_menuTriggered(QAction*))
132#endif
133 Q_PRIVATE_SLOT(d_func(), void _q_actionTriggered())
134
135};
136
137QT_END_NAMESPACE
138
139#endif // QTOOLBUTTON_H
140