The QAbstractButton class is the abstract base class of button widgets, providing functionality common to buttons. More...

#include <qabstractbutton.h>

Inheritance diagram for QAbstractButton:

[legend]

Collaboration diagram for QAbstractButton:

[legend]

Public Slots
void	setIconSize (const QSize &size)

void	animateClick ()

void	click ()

void	toggle ()

void	setChecked (bool)

Public Slots inherited from QWidget
void	setEnabled (bool)

void	setDisabled (bool)

void	setWindowModified (bool)

void	setWindowTitle (const QString &)

void	setStyleSheet (const QString &styleSheet)

void	setFocus ()

void	update ()

void	repaint ()

virtual void	setVisible (bool visible)

void	setHidden (bool hidden)

void	show ()

void	hide ()

void	showMinimized ()

void	showMaximized ()

void	showFullScreen ()

void	showNormal ()

bool	close ()

void	raise ()

void	lower ()

Public Slots inherited from QObject
void	deleteLater ()

Signals
void	pressed ()

void	released ()

void	clicked (bool checked=false)

void	toggled (bool checked)

Signals inherited from QWidget
void	windowTitleChanged (const QString &title)

void	windowIconChanged (const QIcon &icon)

void	windowIconTextChanged (const QString &iconText)

void	customContextMenuRequested (const QPoint &pos)

Signals inherited from QObject
void	destroyed (QObject *=nullptr)

void	objectNameChanged (const QString &objectName, QPrivateSignal)

Public Member Functions
	QAbstractButton (QWidget *parent=nullptr)

	~QAbstractButton ()

void	setText (const QString &text)

QString	text () const

void	setIcon (const QIcon &icon)

QIcon	icon () const

QSize	iconSize () const

void	setShortcut (const QKeySequence &key)

QKeySequence	shortcut () const

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

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())

	~QWidget ()

int	devType () const override

WId	winId () const

void	createWinId ()

WId	internalWinId () const

WId	effectiveWinId () const

QStyle *	style () const

void	setStyle (QStyle *)

bool	isWindow () const

bool	isModal () const

Qt::WindowModality	windowModality () const

void	setWindowModality (Qt::WindowModality windowModality)

bool	isEnabled () const

bool	isEnabledTo (const QWidget *) const

QRect	frameGeometry () const

const QRect &	geometry () const

QRect	normalGeometry () const

int	x () const

int	y () const

QPoint	pos () const

QSize	frameSize () const

QSize	size () const

int	width () const

int	height () const

QRect	rect () const

QRect	childrenRect () const

QRegion	childrenRegion () const

QSize	minimumSize () const

QSize	maximumSize () const

int	minimumWidth () const

int	minimumHeight () const

int	maximumWidth () const

int	maximumHeight () const

void	setMinimumSize (const QSize &)

void	setMinimumSize (int minw, int minh)

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)

void	setMinimumWidth (int minw)

void	setMinimumHeight (int minh)

void	setMaximumWidth (int maxw)

void	setMaximumHeight (int maxh)

QSize	sizeIncrement () const

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)

QSize	baseSize () const

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)

void	setFixedSize (const QSize &)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFixedHeight (int h)

QPointF	mapToGlobal (const QPointF &) const

QPoint	mapToGlobal (const QPoint &) const

QPointF	mapFromGlobal (const QPointF &) const

QPoint	mapFromGlobal (const QPoint &) const

QPointF	mapToParent (const QPointF &) const

QPoint	mapToParent (const QPoint &) const

QPointF	mapFromParent (const QPointF &) const

QPoint	mapFromParent (const QPoint &) const

QPointF	mapTo (const QWidget *, const QPointF &) const

QPoint	mapTo (const QWidget *, const QPoint &) const

QPointF	mapFrom (const QWidget *, const QPointF &) const

QPoint	mapFrom (const QWidget *, const QPoint &) const

QWidget *	window () const

QWidget *	nativeParentWidget () const

QWidget *	topLevelWidget () const

const QPalette &	palette () const

void	setPalette (const QPalette &)

void	setBackgroundRole (QPalette::ColorRole)

QPalette::ColorRole	backgroundRole () const

void	setForegroundRole (QPalette::ColorRole)

QPalette::ColorRole	foregroundRole () const

const QFont &	font () const

void	setFont (const QFont &)

QFontMetrics	fontMetrics () const

QFontInfo	fontInfo () const

QCursor	cursor () const

void	setCursor (const QCursor &)

void	unsetCursor ()

void	setMouseTracking (bool enable)

bool	hasMouseTracking () const

bool	underMouse () const

void	setTabletTracking (bool enable)

bool	hasTabletTracking () const

void	setMask (const QBitmap &)

void	setMask (const QRegion &)

QRegion	mask () const

void	clearMask ()

void	render (QPaintDevice *target, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground\|DrawChildren))

void	render (QPainter *painter, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground\|DrawChildren))

Q_INVOKABLE QPixmap	grab (const QRect &rectangle=QRect(QPoint(0, 0), QSize(-1, -1)))

void	grabGesture (Qt::GestureType type, Qt::GestureFlags flags=Qt::GestureFlags())

void	ungrabGesture (Qt::GestureType type)

QString	styleSheet () const

QString	windowTitle () const

void	setWindowIcon (const QIcon &icon)

QIcon	windowIcon () const

void	setWindowIconText (const QString &)

QString	windowIconText () const

void	setWindowRole (const QString &)

QString	windowRole () const

void	setWindowFilePath (const QString &filePath)

QString	windowFilePath () const

void	setWindowOpacity (qreal level)

qreal	windowOpacity () const

bool	isWindowModified () const

QString	accessibleName () const

void	setAccessibleName (const QString &name)

QString	accessibleDescription () const

void	setAccessibleDescription (const QString &description)

void	setLayoutDirection (Qt::LayoutDirection direction)

Qt::LayoutDirection	layoutDirection () const

void	unsetLayoutDirection ()

void	setLocale (const QLocale &locale)

QLocale	locale () const

void	unsetLocale ()

bool	isRightToLeft () const

bool	isLeftToRight () const

bool	isActiveWindow () const

void	activateWindow ()

void	clearFocus ()

void	setFocus (Qt::FocusReason reason)

Qt::FocusPolicy	focusPolicy () const

void	setFocusPolicy (Qt::FocusPolicy policy)

bool	hasFocus () const

void	setFocusProxy (QWidget *)

QWidget *	focusProxy () const

Qt::ContextMenuPolicy	contextMenuPolicy () const

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	grabMouse ()

void	grabMouse (const QCursor &)

void	releaseMouse ()

void	grabKeyboard ()

void	releaseKeyboard ()

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context=Qt::WindowShortcut)

void	releaseShortcut (int id)

void	setShortcutEnabled (int id, bool enable=true)

void	setShortcutAutoRepeat (int id, bool enable=true)

bool	updatesEnabled () const

void	setUpdatesEnabled (bool enable)

void	update (int x, int y, int w, int h)

void	update (const QRect &)

void	update (const QRegion &)

void	repaint (int x, int y, int w, int h)

void	repaint (const QRect &)

void	repaint (const QRegion &)

void	stackUnder (QWidget *)

void	move (int x, int y)

void	move (const QPoint &)

void	resize (int w, int h)

void	resize (const QSize &)

void	setGeometry (int x, int y, int w, int h)

void	setGeometry (const QRect &)

QByteArray	saveGeometry () const

bool	restoreGeometry (const QByteArray &geometry)

void	adjustSize ()

bool	isVisible () const

bool	isVisibleTo (const QWidget *) const

bool	isHidden () const

bool	isMinimized () const

bool	isMaximized () const

bool	isFullScreen () const

Qt::WindowStates	windowState () const

void	setWindowState (Qt::WindowStates state)

void	overrideWindowState (Qt::WindowStates state)

virtual QSize	sizeHint () const

virtual QSize	minimumSizeHint () const

QSizePolicy	sizePolicy () const

void	setSizePolicy (QSizePolicy)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

virtual int	heightForWidth (int) const

virtual bool	hasHeightForWidth () const

QRegion	visibleRegion () const

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContentsMargins (const QMargins &margins)
	The setContentsMargins function sets the margins around the widget's contents. More...

QMargins	contentsMargins () const
	The contentsMargins function returns the widget's contents margins. More...

QRect	contentsRect () const

QLayout *	layout () const

void	setLayout (QLayout *)

void	updateGeometry ()

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, Qt::WindowFlags f)

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &)

QWidget *	focusWidget () const

QWidget *	nextInFocusChain () const

QWidget *	previousInFocusChain () const
	The previousInFocusChain function returns the previous widget in this widget's focus chain. More...

bool	acceptDrops () const

void	setAcceptDrops (bool on)

void	addAction (QAction *action)

void	addActions (const QList< QAction * > &actions)

void	insertActions (QAction before, const QList< QAction > &actions)

void	insertAction (QAction before, QAction action)

void	removeAction (QAction *action)

QList< QAction * >	actions () const

QAction *	addAction (const QString &text)

QAction *	addAction (const QIcon &icon, const QString &text)

QAction *	addAction (const QString &text, const QObject receiver, const char member, Qt::ConnectionType type=Qt::AutoConnection)

QAction *	addAction (const QIcon &icon, const QString &text, const QObject receiver, const char member, Qt::ConnectionType type=Qt::AutoConnection)

template<typename... Args, typename = compatible_action_slot_args<Args...>>
QAction *	addAction (const QString &text, Args &&...args)

template<typename... Args, typename = compatible_action_slot_args<Args...>>
QAction *	addAction (const QIcon &icon, const QString &text, Args &&...args)

QWidget *	parentWidget () const

void	setWindowFlags (Qt::WindowFlags type)

Qt::WindowFlags	windowFlags () const

void	setWindowFlag (Qt::WindowType, bool on=true)

void	overrideWindowFlags (Qt::WindowFlags type)

Qt::WindowType	windowType () const

QWidget *	childAt (int x, int y) const

QWidget *	childAt (const QPoint &p) const

void	setAttribute (Qt::WidgetAttribute, bool on=true)

bool	testAttribute (Qt::WidgetAttribute) const

QPaintEngine *	paintEngine () const override

void	ensurePolished () const

bool	isAncestorOf (const QWidget *child) const

bool	autoFillBackground () const

void	setAutoFillBackground (bool enabled)

QBackingStore *	backingStore () const

QWindow *	windowHandle () const

QScreen *	screen () const

void	setScreen (QScreen *)

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery) const

Qt::InputMethodHints	inputMethodHints () const

void	setInputMethodHints (Qt::InputMethodHints hints)

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)

virtual	~QObject ()

virtual bool	eventFilter (QObject watched, QEvent event)

QString	objectName () const

void	setObjectName (const QString &name)

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const

bool	isWindowType () const

bool	signalsBlocked () const noexcept

bool	blockSignals (bool b) noexcept

QThread *	thread () const

void	moveToThread (QThread *thread)

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)

template<typename T >
T	findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

const QObjectList &	children () const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const

void	dumpObjectInfo () const

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const

bool	inherits (const char *classname) const

Public Member Functions inherited from QPaintDevice
virtual	~QPaintDevice ()

bool	paintingActive () const

int	width () const

int	height () const

int	widthMM () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

int	physicalDpiX () const

int	physicalDpiY () const

qreal	devicePixelRatio () const

qreal	devicePixelRatioF () const

int	colorCount () const

int	depth () const

Protected Member Functions
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

	QAbstractButton (QAbstractButtonPrivate &dd, QWidget *parent=nullptr)

Protected Member Functions inherited from QWidget
virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	enterEvent (QEnterEvent *event)

virtual void	leaveEvent (QEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual void	resizeEvent (QResizeEvent *event)

virtual void	closeEvent (QCloseEvent *event)

virtual void	contextMenuEvent (QContextMenuEvent *event)

virtual void	actionEvent (QActionEvent *event)

virtual void	showEvent (QShowEvent *event)

virtual void	hideEvent (QHideEvent *event)

virtual bool	nativeEvent (const QByteArray &eventType, void message, qintptr result)

int	metric (PaintDeviceMetric) const override

void	initPainter (QPainter *painter) const override

QPaintDevice *	redirected (QPoint *offset) const override

QPainter *	sharedPainter () const override

virtual void	inputMethodEvent (QInputMethodEvent *)

void	create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true)

void	destroy (bool destroyWindow=true, bool destroySubWindows=true)

virtual bool	focusNextPrevChild (bool next)

bool	focusNextChild ()

bool	focusPreviousChild ()

	QWidget (QWidgetPrivate &d, QWidget *parent, Qt::WindowFlags f)

Protected Member Functions inherited from QObject
QObject *	sender () const

int	senderSignalIndex () const

int	receivers (const char *signal) const

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Protected Member Functions inherited from QPaintDevice
	QPaintDevice () noexcept

Properties
QString	text
	the text shown on the button More...

QIcon	icon
	the icon shown on the button More...

QSize	iconSize
	the icon size used for this button. More...

QKeySequence	shortcut
	the mnemonic associated with the button More...

bool	checkable
	whether the button is checkable More...

bool	checked
	whether the button is checked More...

bool	autoRepeat
	whether autoRepeat is enabled More...

bool	autoExclusive
	whether auto-exclusivity is enabled More...

int	autoRepeatDelay
	the initial delay of auto-repetition More...

int	autoRepeatInterval
	the interval of auto-repetition More...

bool	down
	whether the button is pressed down More...

Properties inherited from QWidget
bool	modal
	whether the widget is a modal widget More...

Qt::WindowModality	windowModality
	which windows are blocked by the modal widget More...

bool	enabled
	whether the widget is enabled More...

QRect	geometry
	the geometry of the widget relative to its parent and excluding the window frame More...

QRect	frameGeometry
	geometry of the widget relative to its parent including any window frame More...

QRect	normalGeometry
	the geometry of the widget as it will appear when shown as a normal (not maximized or full screen) top-level widget More...

int	x
	the x coordinate of the widget relative to its parent including any window frame More...

int	y
	the y coordinate of the widget relative to its parent and including any window frame More...

QPoint	pos
	the position of the widget within its parent widget More...

QSize	frameSize
	the size of the widget including any window frame More...

QSize	size
	the size of the widget excluding any window frame More...

int	width
	the width of the widget excluding any window frame More...

int	height
	the height of the widget excluding any window frame More...

QRect	rect
	the internal geometry of the widget excluding any window frame More...

QRect	childrenRect
	the bounding rectangle of the widget's children More...

QRegion	childrenRegion
	the combined region occupied by the widget's children More...

QSizePolicy	sizePolicy
	the default layout behavior of the widget More...

QSize	minimumSize
	the widget's minimum size More...

QSize	maximumSize
	the widget's maximum size in pixels More...

int	minimumWidth
	the widget's minimum width in pixels More...

int	minimumHeight
	the widget's minimum height in pixels More...

int	maximumWidth
	the widget's maximum width in pixels More...

int	maximumHeight
	the widget's maximum height in pixels More...

QSize	sizeIncrement
	the size increment of the widget More...

QSize	baseSize
	the base size of the widget More...

QPalette	palette
	the widget's palette More...

QFont	font
	the font currently set for the widget More...

QCursor	cursor
	the cursor shape for this widget More...

bool	mouseTracking
	whether mouse tracking is enabled for the widget More...

bool	tabletTracking
	whether tablet tracking is enabled for the widget More...

bool	isActiveWindow
	whether this widget's window is the active window More...

Qt::FocusPolicy	focusPolicy
	the way the widget accepts keyboard focus More...

bool	focus
	whether this widget (or its focus proxy) has the keyboard input focus More...

Qt::ContextMenuPolicy	contextMenuPolicy
	how the widget shows a context menu More...

bool	updatesEnabled
	whether updates are enabled More...

bool	visible
	whether the widget is visible More...

bool	minimized
	whether this widget is minimized (iconified) More...

bool	maximized
	whether this widget is maximized More...

bool	fullScreen
	whether the widget is shown in full screen mode More...

QSize	sizeHint
	the recommended size for the widget More...

QSize	minimumSizeHint
	the recommended minimum size for the widget More...

bool	acceptDrops
	whether drop events are enabled for this widget More...

QString	windowTitle
	the window title (caption) More...

QIcon	windowIcon
	the widget's icon More...

QString	windowIconText
	the text to be displayed on the icon of a minimized window More...

double	windowOpacity
	The level of opacity for the window. More...

bool	windowModified
	whether the document shown in the window has unsaved changes More...

QString	accessibleName
	the widget's name as seen by assistive technologies More...

QString	accessibleDescription
	the widget's description as seen by assistive technologies More...

Qt::LayoutDirection	layoutDirection
	the layout direction for this widget. More...

bool	autoFillBackground
	whether the widget background is filled automatically More...

QString	styleSheet
	the widget's style sheet More...

QLocale	locale
	the widget's locale More...

QString	windowFilePath
	the file path associated with a widget More...

Qt::InputMethodHints	inputMethodHints
	What input method specific hints the widget has. More...

Properties inherited from QObject
QString	objectName
	the name of this object More...

Friends
class	QButtonGroup

Additional Inherited Members
Public Types inherited from QWidget
enum	RenderFlag { DrawWindowBackground = 0x1 , DrawChildren = 0x2 , IgnoreMask = 0x4 }

Public Types inherited from QPaintDevice
enum	PaintDeviceMetric { PdmWidth = 1 , PdmHeight , PdmWidthMM , PdmHeightMM , PdmNumColors , PdmDepth , PdmDpiX , PdmDpiY , PdmPhysicalDpiX , PdmPhysicalDpiY , PdmDevicePixelRatio , PdmDevicePixelRatioScaled }

Static Public Member Functions inherited from QWidget
static void	setTabOrder (QWidget , QWidget )

static QWidget *	mouseGrabber ()

static QWidget *	keyboardGrabber ()

static QWidget *	find (WId)

static QWidget *	createWindowContainer (QWindow window, QWidget parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Static Public Member Functions inherited from QPaintDevice
static qreal	devicePixelRatioFScale ()

Protected Slots inherited from QWidget
void	updateMicroFocus (Qt::InputMethodQuery query=Qt::ImQueryAll)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Protected Attributes inherited from QPaintDevice
ushort	painters

Related Functions inherited from QWidget
	setupUi (QWidget *widget)

Related Functions inherited from QObject
template< class T > T	qobject_cast (const QObject *object)

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList

Detailed Description

The QAbstractButton class is the abstract base class of button widgets, providing functionality common to buttons.

\inmodule QtWidgets

This class implements an abstract button. Subclasses of this class handle user actions, and specify how the button is drawn.

QAbstractButton provides support for both push buttons and checkable (toggle) buttons. Checkable buttons are implemented in the QRadioButton and QCheckBox classes. Push buttons are implemented in the QPushButton and QToolButton classes; these also provide toggle behavior if required.

Any button can display a label containing text and an icon. setText() sets the text; setIcon() sets the icon. If a button is disabled, its label is changed to give the button a "disabled" appearance.

If the button is a text button with a string containing an ampersand ('&'), QAbstractButton automatically creates a shortcut key. For example:

The \uicontrol Alt+C shortcut is assigned to the button, i.e., when the user presses \uicontrol Alt+C the button will call animateClick(). See the \l {QShortcut::mnemonic}{QShortcut} documentation for details. To display an actual ampersand, use '&&'.

You can also set a custom shortcut key using the setShortcut() function. This is useful mostly for buttons that do not have any text, and therefore can't have any automatic shortcut.

All the buttons provided by Qt (QPushButton, QToolButton, QCheckBox, and QRadioButton) can display both \l text and \l{icon}{icons}.

A button can be made the default button in a dialog by means of QPushButton::setDefault() and QPushButton::setAutoDefault().

QAbstractButton provides most of the states used for buttons:

\list

isDown() indicates whether the button is pressed down.

isChecked() indicates whether the button is checked. Only checkable buttons can be checked and unchecked (see below).

isEnabled() indicates whether the button can be pressed by the user.
Note
As opposed to other widgets, buttons derived from QAbstractButton accept mouse and context menu events when disabled.
setAutoRepeat() sets whether the button will auto-repeat if the user holds it down. \l autoRepeatDelay and \l autoRepeatInterval define how auto-repetition is done.

setCheckable() sets whether the button is a toggle button or not.

\endlist

The difference between isDown() and isChecked() is as follows. When the user clicks a toggle button to check it, the button is first pressed then released into the checked state. When the user clicks it again (to uncheck it), the button moves first to the pressed state, then to the unchecked state (isChecked() and isDown() are both false).

QAbstractButton provides four signals:

\list 1

pressed() is emitted when the left mouse button is pressed while the mouse cursor is inside the button.

released() is emitted when the left mouse button is released.

clicked() is emitted when the button is first pressed and then released, when the shortcut key is typed, or when click() or animateClick() is called.

toggled() is emitted when the state of a toggle button changes.

\endlist

To subclass QAbstractButton, you must reimplement at least paintEvent() to draw the button's outline and its text or pixmap. It is generally advisable to reimplement sizeHint() as well, and sometimes hitButton() (to determine whether a button press is within the button). For buttons with more than two states (like tri-state buttons), you will also have to reimplement checkStateSet() and nextCheckState().

See also: QButtonGroup

Definition at line 58 of file qabstractbutton.h.

Constructor & Destructor Documentation

◆ QAbstractButton() [1/2]

QAbstractButton::QAbstractButton ( QWidget * parent = nullptr )

explicit

Constructs an abstract button with a parent.

Definition at line 469 of file qabstractbutton.cpp.

◆ ~QAbstractButton()

QAbstractButton::~QAbstractButton ( )

Destroys the button.

Definition at line 479 of file qabstractbutton.cpp.

◆ QAbstractButton() [2/2]

QAbstractButton::QAbstractButton	(	QAbstractButtonPrivate &	dd,
		QWidget *	parent = `nullptr`
	)

protected

Definition at line 491 of file qabstractbutton.cpp.

Member Function Documentation

◆ animateClick

void QAbstractButton::animateClick ( )

slot

Performs an animated click: the button is pressed immediately, and released 100ms later.

Calling this function again before the button is released resets the release timer.

All signals associated with a click are emitted as appropriate.

This function does nothing if the button is \l{setEnabled()}{disabled.}

See also: click()

Definition at line 832 of file qabstractbutton.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ autoExclusive()

bool QAbstractButton::autoExclusive ( ) const

Definition at line 797 of file qabstractbutton.cpp.

◆ autoRepeat()

bool QAbstractButton::autoRepeat ( ) const

Definition at line 720 of file qabstractbutton.cpp.

◆ autoRepeatDelay()

int QAbstractButton::autoRepeatDelay ( ) const

Definition at line 743 of file qabstractbutton.cpp.

◆ autoRepeatInterval()

int QAbstractButton::autoRepeatInterval ( ) const

Definition at line 766 of file qabstractbutton.cpp.

◆ changeEvent()

void QAbstractButton::changeEvent ( QEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Reimplemented in QToolButton.

Definition at line 1180 of file qabstractbutton.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkStateSet()

void QAbstractButton::checkStateSet ( )

protectedvirtual

This virtual handler is called when setChecked() is used, unless it is called from within nextCheckState(). It allows subclasses to reset their intermediate button states.

See also: nextCheckState()

Reimplemented in QToolButton, and QCheckBox.

Definition at line 894 of file qabstractbutton.cpp.

Here is the caller graph for this function:

◆ click

void QAbstractButton::click ( )

slot

Performs a click.

All the usual signals associated with a click are emitted as appropriate. If the button is checkable, the state of the button is toggled.

This function does nothing if the button is \l{setEnabled()}{disabled.}

See also: animateClick()

Definition at line 857 of file qabstractbutton.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clicked

void QAbstractButton::clicked ( bool checked = false )

signal

This signal is emitted when the button is activated (i.e., pressed down then released while the mouse cursor is inside the button), when the shortcut key is typed, or when click() or animateClick() is called. Notably, this signal is not emitted if you call setDown(), setChecked() or toggle().

If the button is checkable, checked is true if the button is checked, or false if the button is unchecked.

See also: pressed(), released(), toggled()

Here is the caller graph for this function:

◆ event()

bool QAbstractButton::event ( QEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Reimplemented in QDockWidgetTitleButton, QToolButton, QToolBarExtension, QRadioButton, QPushButton, QCommandLinkButton, and QCheckBox.

Definition at line 925 of file qabstractbutton.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ focusInEvent()

void QAbstractButton::focusInEvent ( QFocusEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Reimplemented in SpecialRadioButton, and QPushButton.

Definition at line 1158 of file qabstractbutton.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ focusOutEvent()

void QAbstractButton::focusOutEvent ( QFocusEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Reimplemented in QPushButton.

Definition at line 1169 of file qabstractbutton.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hitButton()

bool QAbstractButton::hitButton ( const QPoint & pos ) const

protectedvirtual

Returns true if pos is inside the clickable button rectangle; otherwise returns false.

By default, the clickable area is the entire widget. Subclasses may reimplement this function to provide support for clickable areas of different shapes and sizes.

Reimplemented in TestPushButton, TestButton, QToolButton, QPushButton, QCheckBox, TestPushButton, and QRadioButton.

Definition at line 919 of file qabstractbutton.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ icon()

QIcon QAbstractButton::icon ( ) const

Definition at line 557 of file qabstractbutton.cpp.

◆ iconSize()

QSize QAbstractButton::iconSize ( ) const

Definition at line 1269 of file qabstractbutton.cpp.

Here is the call graph for this function:

◆ isCheckable()

bool QAbstractButton::isCheckable ( ) const

Definition at line 603 of file qabstractbutton.cpp.

Here is the caller graph for this function:

◆ isChecked()

bool QAbstractButton::isChecked ( ) const

Definition at line 660 of file qabstractbutton.cpp.

Here is the caller graph for this function:

◆ isDown()

bool QAbstractButton::isDown ( ) const

Definition at line 688 of file qabstractbutton.cpp.

Here is the caller graph for this function:

◆ keyPressEvent()

void QAbstractButton::keyPressEvent ( QKeyEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Reimplemented in QPushButton.

Definition at line 1042 of file qabstractbutton.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ keyReleaseEvent()

void QAbstractButton::keyReleaseEvent ( QKeyEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 1116 of file qabstractbutton.cpp.

◆ mouseMoveEvent()

void QAbstractButton::mouseMoveEvent ( QMouseEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Reimplemented in QRadioButton, QPushButton, and QCheckBox.

Definition at line 1020 of file qabstractbutton.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mousePressEvent()

void QAbstractButton::mousePressEvent ( QMouseEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Reimplemented in QToolButton.

Definition at line 972 of file qabstractbutton.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mouseReleaseEvent()

void QAbstractButton::mouseReleaseEvent ( QMouseEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Reimplemented in QToolButton.

Definition at line 991 of file qabstractbutton.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nextCheckState()

void QAbstractButton::nextCheckState ( )

protectedvirtual

This virtual handler is called when a button is clicked. The default implementation calls setChecked(!isChecked()) if the button isCheckable(). It allows subclasses to implement intermediate button states.

See also: checkStateSet()

Reimplemented in QToolButton, and QCheckBox.

Definition at line 905 of file qabstractbutton.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ paintEvent()

void QAbstractButton::paintEvent ( QPaintEvent * e )

overrideprotectedpure virtual

\reimp

Reimplemented from QWidget.

Implemented in QT_BEGIN_NAMESPACE::CloseButton, QDockWidgetTitleButton, MyButton, QToolButton, QToolBoxButton, QToolBarExtension, QRadioButton, QPushButton, QMenuBarExtension, QCommandLinkButton, QCheckBox, and MyPushButton.

◆ pressed

void QAbstractButton::pressed ( )

signal

This signal is emitted when the button is pressed down.

See also: released(), clicked()

◆ released

void QAbstractButton::released ( )

signal

This signal is emitted when the button is released.

See also: pressed(), clicked(), toggled()

◆ setAutoExclusive()

void QAbstractButton::setAutoExclusive ( bool autoExclusive )

Definition at line 791 of file qabstractbutton.cpp.

◆ setAutoRepeat()

void QAbstractButton::setAutoRepeat ( bool autoRepeat )

Definition at line 708 of file qabstractbutton.cpp.

Here is the caller graph for this function:

◆ setAutoRepeatDelay()

void QAbstractButton::setAutoRepeatDelay ( int autoRepeatDelay )

Definition at line 737 of file qabstractbutton.cpp.

Here is the caller graph for this function:

◆ setAutoRepeatInterval()

void QAbstractButton::setAutoRepeatInterval ( int autoRepeatInterval )

Definition at line 760 of file qabstractbutton.cpp.

Here is the caller graph for this function:

◆ setCheckable()

void QAbstractButton::setCheckable ( bool checkable )

Definition at line 593 of file qabstractbutton.cpp.

Here is the caller graph for this function:

◆ setChecked

void QAbstractButton::setChecked ( bool checked )

slot

Definition at line 617 of file qabstractbutton.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDown()

void QAbstractButton::setDown ( bool down )

Definition at line 675 of file qabstractbutton.cpp.

Here is the caller graph for this function:

◆ setIcon()

void QAbstractButton::setIcon ( const QIcon & icon )

Definition at line 548 of file qabstractbutton.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setIconSize

void QAbstractButton::setIconSize ( const QSize & size )

slot

Definition at line 1278 of file qabstractbutton.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setShortcut()

void QAbstractButton::setShortcut ( const QKeySequence & key )

Definition at line 569 of file qabstractbutton.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setText()

void QAbstractButton::setText ( const QString & text )

Definition at line 515 of file qabstractbutton.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ shortcut()

QKeySequence QAbstractButton::shortcut ( ) const

Definition at line 578 of file qabstractbutton.cpp.

◆ text()

QString QAbstractButton::text ( ) const

Definition at line 534 of file qabstractbutton.cpp.

Here is the caller graph for this function:

◆ timerEvent()

void QAbstractButton::timerEvent ( QTimerEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QObject.

Reimplemented in QToolButton.

Definition at line 1136 of file qabstractbutton.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toggle

void QAbstractButton::toggle ( )

slot

Toggles the state of a checkable button.

See also: checked

Definition at line 881 of file qabstractbutton.cpp.

Here is the call graph for this function:

◆ toggled

void QAbstractButton::toggled ( bool checked )

signal

This signal is emitted whenever a checkable button changes its state. checked is true if the button is checked, or false if the button is unchecked.

This may be the result of a user action, click() slot activation, or because setChecked() is called.

The states of buttons in exclusive button groups are updated before this signal is emitted. This means that slots can act on either the "off" signal or the "on" signal emitted by the buttons in the group whose states have changed.

For example, a slot that reacts to signals emitted by newly checked buttons but which ignores signals from buttons that have been unchecked can be implemented using the following pattern:

Button groups can be created using the QButtonGroup class, and updates to the button states monitored with the \l{QButtonGroup::buttonClicked()} signal.

See also: checked, clicked()

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ QButtonGroup

friend class QButtonGroup

friend

Definition at line 154 of file qabstractbutton.h.

Property Documentation

◆ autoExclusive

QAbstractButton::autoExclusive

readwrite

whether auto-exclusivity is enabled

If auto-exclusivity is enabled, checkable buttons that belong to the same parent widget behave as if they were part of the same exclusive button group. In an exclusive button group, only one button can be checked at any time; checking another button automatically unchecks the previously checked one.

The property has no effect on buttons that belong to a button group.

autoExclusive is off by default, except for radio buttons.

See also: QRadioButton

Definition at line 157 of file qabstractbutton.h.

◆ autoRepeat

QAbstractButton::autoRepeat

readwrite

whether autoRepeat is enabled

If autoRepeat is enabled, then the pressed(), released(), and clicked() signals are emitted at regular intervals when the button is down. autoRepeat is off by default. The initial delay and the repetition interval are defined in milliseconds by \l autoRepeatDelay and \l autoRepeatInterval.

Note: If a button is pressed down by a shortcut key, then auto-repeat is enabled and timed by the system and not by this class. The pressed(), released(), and clicked() signals will be emitted like in the normal case.

Definition at line 157 of file qabstractbutton.h.

◆ autoRepeatDelay

QAbstractButton::autoRepeatDelay

readwrite

the initial delay of auto-repetition

Since: 4.2

If \l autoRepeat is enabled, then autoRepeatDelay defines the initial delay in milliseconds before auto-repetition kicks in.

See also: autoRepeat, autoRepeatInterval

Definition at line 157 of file qabstractbutton.h.

◆ autoRepeatInterval

QAbstractButton::autoRepeatInterval

readwrite

the interval of auto-repetition

Since: 4.2

If \l autoRepeat is enabled, then autoRepeatInterval defines the length of the auto-repetition interval in millisecons.

See also: autoRepeat, autoRepeatDelay

Definition at line 157 of file qabstractbutton.h.

◆ checkable

QAbstractButton::checkable

readwrite

whether the button is checkable

By default, the button is not checkable.

See also: checked

Definition at line 157 of file qabstractbutton.h.

◆ checked

QAbstractButton::checked

readwrite

whether the button is checked

Only checkable buttons can be checked. By default, the button is unchecked.

See also: checkable

Definition at line 157 of file qabstractbutton.h.

◆ down

QAbstractButton::down

readwrite

whether the button is pressed down

If this property is true, the button is pressed down. The signals pressed() and clicked() are not emitted if you set this property to true. The default is false.

Definition at line 157 of file qabstractbutton.h.

◆ icon

QAbstractButton::icon

readwrite

the icon shown on the button

The icon's default size is defined by the GUI style, but can be adjusted by setting the \l iconSize property.

Definition at line 157 of file qabstractbutton.h.

◆ iconSize

QAbstractButton::iconSize

readwrite

the icon size used for this button.

The default size is defined by the GUI style. This is a maximum size for the icons. Smaller icons will not be scaled up.

Definition at line 157 of file qabstractbutton.h.

◆ shortcut

QAbstractButton::shortcut

readwrite

the mnemonic associated with the button

Definition at line 157 of file qabstractbutton.h.

◆ text

QAbstractButton::text

readwrite

the text shown on the button

If the button has no text, the text() function will return an empty string.

If the text contains an ampersand character ('&'), a shortcut is automatically created for it. The character that follows the '&' will be used as the shortcut key. Any previous shortcut will be overwritten or cleared if no shortcut is defined by the text. See the \l {QShortcut::mnemonic}{QShortcut} documentation for details. To display an actual ampersand, use '&&'.

There is no default text.

Definition at line 157 of file qabstractbutton.h.

The documentation for this class was generated from the following files:

src/widgets/widgets/qabstractbutton.h
src/widgets/widgets/qabstractbutton.cpp

Public Slots

Signals

Public Member Functions

Protected Member Functions

Properties

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QAbstractButton() [1/2]

◆ ~QAbstractButton()

◆ QAbstractButton() [2/2]

Member Function Documentation

◆ animateClick

◆ autoExclusive()

◆ autoRepeat()

◆ autoRepeatDelay()

◆ autoRepeatInterval()

◆ changeEvent()

◆ checkStateSet()

◆ click

◆ clicked

◆ event()

◆ focusInEvent()

◆ focusOutEvent()

◆ hitButton()

◆ icon()

◆ iconSize()

◆ isCheckable()

◆ isChecked()

◆ isDown()

◆ keyPressEvent()

◆ keyReleaseEvent()

◆ mouseMoveEvent()

◆ mousePressEvent()

◆ mouseReleaseEvent()

◆ nextCheckState()

◆ paintEvent()

◆ pressed

◆ released

◆ setAutoExclusive()

◆ setAutoRepeat()

◆ setAutoRepeatDelay()

◆ setAutoRepeatInterval()

◆ setCheckable()

◆ setChecked

◆ setDown()

◆ setIcon()

◆ setIconSize

◆ setShortcut()

◆ setText()

◆ shortcut()

◆ text()

◆ timerEvent()

◆ toggle

◆ toggled

Friends And Related Function Documentation

◆ QButtonGroup

Property Documentation

◆ autoExclusive

◆ autoRepeat

◆ autoRepeatDelay

◆ autoRepeatInterval

◆ checkable

◆ checked

◆ down

◆ icon

◆ iconSize

◆ shortcut

◆ text