qabstractbutton.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 QABSTRACTBUTTON_H
#define QABSTRACTBUTTON_H
 
#include <QtWidgets/qtwidgetsglobal.h>
#include <QtGui/qicon.h>
#if QT_CONFIG(shortcut)
#  include <QtGui/qkeysequence.h>
#endif
#include <QtWidgets/qwidget.h>
 
QT_REQUIRE_CONFIG(abstractbutton);
 
QT_BEGIN_NAMESPACE
 
 
class QButtonGroup;
class QAbstractButtonPrivate;
 
class Q_WIDGETS_EXPORT QAbstractButton : public QWidget
{
    Q_OBJECT
 
    Q_PROPERTY(QString text READ text WRITE setText)
    Q_PROPERTY(QIcon icon READ icon WRITE setIcon)
    Q_PROPERTY(QSize iconSize READ iconSize WRITE setIconSize)
#ifndef QT_NO_SHORTCUT
    Q_PROPERTY(QKeySequence shortcut READ shortcut WRITE setShortcut)
#endif
    Q_PROPERTY(bool checkable READ isCheckable WRITE setCheckable)
    Q_PROPERTY(bool checked READ isChecked WRITE setChecked NOTIFY toggled USER true)
    Q_PROPERTY(bool autoRepeat READ autoRepeat WRITE setAutoRepeat)
    Q_PROPERTY(bool autoExclusive READ autoExclusive WRITE setAutoExclusive)
    Q_PROPERTY(int autoRepeatDelay READ autoRepeatDelay WRITE setAutoRepeatDelay)
    Q_PROPERTY(int autoRepeatInterval READ autoRepeatInterval WRITE setAutoRepeatInterval)
    Q_PROPERTY(bool down READ isDown WRITE setDown DESIGNABLE false)
 
public:
    explicit QAbstractButton(QWidget *parent = nullptr);
    ~QAbstractButton();
 
    void setText(const QString &text);
    QString text() const;
 
    void setIcon(const QIcon &icon);
    QIcon icon() const;
 
    QSize iconSize() const;
 
#ifndef QT_NO_SHORTCUT
    void setShortcut(const QKeySequence &key);
    QKeySequence shortcut() const;
#endif
 
    void setCheckable(bool);
    bool isCheckable() const;
 
    bool isChecked() const;
 
    void setDown(bool);
    bool isDown() const;
 
    void setAutoRepeat(bool);
    bool autoRepeat() const;
 
    void setAutoRepeatDelay(int);
    int autoRepeatDelay() const;
 
    void setAutoRepeatInterval(int);
    int autoRepeatInterval() const;
 
    void setAutoExclusive(bool);
    bool autoExclusive() const;
 
#if QT_CONFIG(buttongroup)
    QButtonGroup *group() const;
#endif
 
public Q_SLOTS:
    void setIconSize(const QSize &size);
    void animateClick();
    void click();
    void toggle();
    void setChecked(bool);
 
Q_SIGNALS:
    void pressed();
    void released();
    void clicked(bool checked = false);
    void toggled(bool checked);
 
protected:
    void paintEvent(QPaintEvent *e) override = 0;
    virtual bool hitButton(const QPoint &pos) const;
    virtual void checkStateSet();
    virtual void nextCheckState();
 
    bool event(QEvent *e) override;
    void keyPressEvent(QKeyEvent *e) override;
    void keyReleaseEvent(QKeyEvent *e) override;
    void mousePressEvent(QMouseEvent *e) override;
    void mouseReleaseEvent(QMouseEvent *e) override;
    void mouseMoveEvent(QMouseEvent *e) override;
    void focusInEvent(QFocusEvent *e) override;
    void focusOutEvent(QFocusEvent *e) override;
    void changeEvent(QEvent *e) override;
    void timerEvent(QTimerEvent *e) override;
 
 
protected:
    QAbstractButton(QAbstractButtonPrivate &dd, QWidget* parent = nullptr);
 
private:
    Q_DECLARE_PRIVATE(QAbstractButton)
    Q_DISABLE_COPY(QAbstractButton)
    friend class QButtonGroup;
};
 
QT_END_NAMESPACE
 
#endif // QABSTRACTBUTTON_H