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

#include <qabstractbutton.h>

Inheritance diagram for QAbstractButton:

Collaboration diagram for QAbstractButton:

Public Slots
void	setIconSize (const QSize &size)

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

void	click ()
	Performs a click.

void	toggle ()
	Toggles the state of a checkable button.

void	setChecked (bool)

Public Slots inherited from QWidget
void	setEnabled (bool)

void	setDisabled (bool)
	Disables widget input events if disable is true; otherwise enables input events.

void	setWindowModified (bool)

void	setWindowTitle (const QString &)

void	setStyleSheet (const QString &styleSheet)

void	setFocus ()
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the \l{isActiveWindow()}{active window}.

void	update ()
	Updates the widget unless updates are disabled or the widget is hidden.

void	repaint ()
	Repaints the widget directly by calling paintEvent() immediately, unless updates are disabled or the widget is hidden.

virtual void	setVisible (bool visible)

void	setHidden (bool hidden)
	Convenience function, equivalent to setVisible(!hidden).

void	show ()
	Shows the widget and its child widgets.

void	hide ()
	Hides the widget.

void	showMinimized ()
	Shows the widget minimized, as an icon.

void	showMaximized ()
	Shows the widget maximized.

void	showFullScreen ()
	Shows the widget in full-screen mode.

void	showNormal ()
	Restores the widget after it has been maximized or minimized.

bool	close ()
	Closes this widget.

void	raise ()
	Raises this widget to the top of the parent widget's stack.

void	lower ()
	Lowers the widget to the bottom of the parent widget's stack.

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	pressed ()
	This signal is emitted when the button is pressed down.

void	released ()
	This signal is emitted when the button is released.

void	clicked (bool checked=false)
	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.

void	toggled (bool checked)
	This signal is emitted whenever a checkable button changes its state.

Signals inherited from QWidget
void	windowTitleChanged (const QString &title)
	This signal is emitted when the window's title has changed, with the new title as an argument.

void	windowIconChanged (const QIcon &icon)
	This signal is emitted when the window's icon has changed, with the new icon as an argument.

void	windowIconTextChanged (const QString &iconText)
	This signal is emitted when the window's icon text has changed, with the new iconText as an argument.

void	customContextMenuRequested (const QPoint &pos)
	This signal is emitted when the widget's \l contextMenuPolicy is Qt::CustomContextMenu, and the user has requested a context menu on the widget.

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QAbstractButton (QWidget *parent=nullptr)
	Constructs an abstract button with a parent.

	~QAbstractButton ()
	Destroys the button.

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())
	Constructs a widget which is a child of parent, with widget flags set to f.

	~QWidget ()
	Destroys the widget.

int	devType () const override

WId	winId () const
	Returns the window system identifier of the widget.

void	createWinId ()

WId	internalWinId () const

WId	effectiveWinId () const

QStyle *	style () const

void	setStyle (QStyle *)
	Sets the widget's GUI style to style.

bool	isWindow () const
	Returns `true` if the widget is an independent window, otherwise returns `false`.

bool	isModal () const

Qt::WindowModality	windowModality () const

void	setWindowModality (Qt::WindowModality windowModality)

bool	isEnabled () const

bool	isEnabledTo (const QWidget *) const
	Returns `true` if this widget would become enabled if ancestor is enabled; otherwise returns `false`.

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)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function corresponds to setMinimumSize(QSize(minw, minh)).

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function corresponds to setMaximumSize(QSize(maxw, 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)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the x (width) size increment to w and the y (height) size increment to h.

QSize	baseSize () const

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setBaseSize(QSize(basew, baseh)).

void	setFixedSize (const QSize &)
	Sets both the minimum and maximum sizes of the widget to s, thereby preventing it from ever growing or shrinking.

void	setFixedSize (int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the width of the widget to w and the height to h.

void	setFixedWidth (int w)
	Sets both the minimum and maximum width of the widget to w without changing the heights.

void	setFixedHeight (int h)
	Sets both the minimum and maximum heights of the widget to h without changing the widths.

QPointF	mapToGlobal (const QPointF &) const
	Translates the widget coordinate pos to global screen coordinates.

QPoint	mapToGlobal (const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QPointF	mapFromGlobal (const QPointF &) const
	Translates the global screen coordinate pos to widget coordinates.

QPoint	mapFromGlobal (const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QPointF	mapToParent (const QPointF &) const
	Translates the widget coordinate pos to a coordinate in the parent widget.

QPoint	mapToParent (const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QPointF	mapFromParent (const QPointF &) const
	Translates the parent widget coordinate pos to widget coordinates.

QPoint	mapFromParent (const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QPointF	mapTo (const QWidget *, const QPointF &) const
	Translates the widget coordinate pos to the coordinate system of parent.

QPoint	mapTo (const QWidget *, const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QPointF	mapFrom (const QWidget *, const QPointF &) const
	Translates the widget coordinate pos from the coordinate system of parent to this widget's coordinate system.

QPoint	mapFrom (const QWidget *, const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QWidget *	window () const
	Returns the window for this widget, i.e.

QWidget *	nativeParentWidget () const

QWidget *	topLevelWidget () const

const QPalette &	palette () const

void	setPalette (const QPalette &)

void	setBackgroundRole (QPalette::ColorRole)
	Sets the background role of the widget to role.

QPalette::ColorRole	backgroundRole () const
	Returns the background role of the widget.

void	setForegroundRole (QPalette::ColorRole)
	Sets the foreground role of the widget to role.

QPalette::ColorRole	foregroundRole () const
	Returns the foreground role.

const QFont &	font () const

void	setFont (const QFont &)

QFontMetrics	fontMetrics () const
	Returns the font metrics for the widget's current font.

QFontInfo	fontInfo () const
	Returns the font info for the widget's current font.

QCursor	cursor () const

void	setCursor (const QCursor &)

void	unsetCursor ()

void	setMouseTracking (bool enable)

bool	hasMouseTracking () const

bool	underMouse () const
	Returns `true` if the widget is under the mouse cursor; otherwise returns `false`.

void	setTabletTracking (bool enable)

bool	hasTabletTracking () const

void	setMask (const QBitmap &)
	Causes only the pixels of the widget for which bitmap has a corresponding 1 bit to be visible.

void	setMask (const QRegion &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Causes only the parts of the widget which overlap region to be visible.

QRegion	mask () const
	Returns the mask currently set on a widget.

void	clearMask ()
	Removes any mask set by setMask().

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))
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Renders the widget into the painter's QPainter::device().

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

void	grabGesture (Qt::GestureType type, Qt::GestureFlags flags=Qt::GestureFlags())
	Subscribes the widget to a given gesture with specific flags.

void	ungrabGesture (Qt::GestureType type)
	Unsubscribes the widget from a given gesture 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 &)
	Sets the window's role to role.

QString	windowRole () const
	Returns the window's role, or an empty string.

void	setWindowFilePath (const QString &filePath)

QString	windowFilePath () const

void	setWindowOpacity (qreal level)

qreal	windowOpacity () const

bool	isWindowModified () const

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 ()
	Sets the top-level widget containing this widget to be the active window.

void	clearFocus ()
	Takes keyboard input focus from the widget.

void	setFocus (Qt::FocusReason reason)
	Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the \l{isActiveWindow()}{active window}.

Qt::FocusPolicy	focusPolicy () const

void	setFocusPolicy (Qt::FocusPolicy policy)

bool	hasFocus () const

void	setFocusProxy (QWidget *)
	Sets the widget's focus proxy to widget w.

QWidget *	focusProxy () const
	Returns the focus proxy, or \nullptr if there is no focus proxy.

Qt::ContextMenuPolicy	contextMenuPolicy () const

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	grabMouse ()
	Grabs the mouse input.

void	grabMouse (const QCursor &)

void	releaseMouse ()
	Releases the mouse grab.

void	grabKeyboard ()
	Grabs the keyboard input.

void	releaseKeyboard ()
	Releases the keyboard grab.

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context=Qt::WindowShortcut)
	Adds a shortcut to Qt's shortcut system that watches for the given key sequence in the given context.

void	releaseShortcut (int id)
	Removes the shortcut with the given id from Qt's shortcut system.

void	setShortcutEnabled (int id, bool enable=true)
	If enable is true, the shortcut with the given id is enabled; otherwise the shortcut is disabled.

void	setShortcutAutoRepeat (int id, bool enable=true)

bool	updatesEnabled () const

void	setUpdatesEnabled (bool enable)

void	update (int x, int y, int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version updates a rectangle (x, y, w, h) inside the widget.

void	update (const QRect &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version updates a rectangle rect inside the widget.

void	update (const QRegion &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a region rgn inside the widget.

void	repaint (int x, int y, int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a rectangle (x, y, w, h) inside the widget.

void	repaint (const QRect &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a rectangle rect inside the widget.

void	repaint (const QRegion &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a region rgn inside the widget.

void	stackUnder (QWidget *)
	Places the widget under w in the parent widget's stack.

void	move (int x, int y)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to move(QPoint(x, y)).

void	move (const QPoint &)

void	resize (int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to resize(QSize(w, h)).

void	resize (const QSize &)

void	setGeometry (int x, int y, int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setGeometry(QRect(x, y, w, h)).

void	setGeometry (const QRect &)

QByteArray	saveGeometry () const

bool	restoreGeometry (const QByteArray &geometry)

void	adjustSize ()
	Adjusts the size of the widget to fit its contents.

bool	isVisible () const

bool	isVisibleTo (const QWidget *) const
	Returns `true` if this widget would become visible if ancestor is shown; otherwise returns `false`.

bool	isHidden () const
	Returns `true` if the widget is hidden, otherwise returns `false`.

bool	isMinimized () const

bool	isMaximized () const

bool	isFullScreen () const

Qt::WindowStates	windowState () const
	Returns the current window state.

void	setWindowState (Qt::WindowStates state)
	Sets the window state to windowState.

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)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the size policy of the widget to horizontal and vertical, with standard stretch and no height-for-width.

virtual int	heightForWidth (int) const
	Returns the preferred height for this widget, given the width w.

virtual bool	hasHeightForWidth () const

QRegion	visibleRegion () const
	Returns the unobscured region where paint events can occur.

void	setContentsMargins (int left, int top, int right, int bottom)
	Sets the margins around the contents of the widget to have the sizes left, top, right, and bottom.

void	setContentsMargins (const QMargins &margins)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

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

QRect	contentsRect () const
	Returns the area inside the widget's margins.

QLayout *	layout () const
	Returns the layout manager that is installed on this widget, or \nullptr if no layout manager is installed.

void	setLayout (QLayout *)
	Sets the layout manager for this widget to layout.

void	updateGeometry ()
	Notifies the layout system that this widget has changed and may need to change geometry.

void	setParent (QWidget *parent)
	Sets the parent of the widget to parent, and resets the window flags.

void	setParent (QWidget *parent, Qt::WindowFlags f)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function also takes widget flags, f as an argument.

void	scroll (int dx, int dy)
	Scrolls the widget including its children dx pixels to the right and dy downward.

void	scroll (int dx, int dy, const QRect &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version only scrolls r and does not move the children of the widget.

QWidget *	focusWidget () const
	Returns the last child of this widget that setFocus had been called on.

QWidget *	nextInFocusChain () const
	Returns the next widget in this widget's focus chain.

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

bool	acceptDrops () const

void	setAcceptDrops (bool on)

void	addAction (QAction *action)
	Appends the action action to this widget's list of actions.

void	addActions (const QList< QAction * > &actions)
	Appends the actions actions to this widget's list of actions.

void	insertActions (QAction before, const QList< QAction > &actions)
	Inserts the actions actions to this widget's list of actions, before the action before.

void	insertAction (QAction before, QAction action)
	Inserts the action action to this widget's list of actions, before the action before.

void	removeAction (QAction *action)
	Removes the action action from this widget's list of actions.

QList< QAction * >	actions () const
	Returns the (possibly empty) list of this widget's actions.

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
	Returns the parent of this widget, or \nullptr if it does not have any parent widget.

void	setWindowFlags (Qt::WindowFlags type)

Qt::WindowFlags	windowFlags () const
	Window flags are a combination of a type (e.g.

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

void	overrideWindowFlags (Qt::WindowFlags type)
	Sets the window flags for the widget to flags, without telling the window system.

Qt::WindowType	windowType () const
	Returns the window type of this widget.

QWidget *	childAt (int x, int y) const
	Returns the visible child widget at the position ({x}, {y}) in the widget's coordinate system.

QWidget *	childAt (const QPoint &p) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns the visible child widget at point p in the widget's own coordinate system.

void	setAttribute (Qt::WidgetAttribute, bool on=true)
	Sets the attribute attribute on this widget if on is true; otherwise clears the attribute.

bool	testAttribute (Qt::WidgetAttribute) const
	Returns `true` if attribute attribute is set on this widget; otherwise returns `false`.

QPaintEngine *	paintEngine () const override
	Returns the widget's paint engine.

void	ensurePolished () const
	Ensures that the widget and its children have been polished by QStyle (i.e., have a proper font and palette).

bool	isAncestorOf (const QWidget *child) const
	Returns `true` if this widget is a parent, (or grandparent and so on to any level), of the given child, and both widgets are within the same window; otherwise returns `false`.

bool	autoFillBackground () const

void	setAutoFillBackground (bool enabled)

QBackingStore *	backingStore () const

QWindow *	windowHandle () const
	If this is a native widget, return the associated QWindow.

QScreen *	screen () const
	Returns the screen the widget is on.

void	setScreen (QScreen *)
	Sets the screen on which the widget should be shown to screen.

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery) const
	This method is only relevant for input widgets.

Qt::InputMethodHints	inputMethodHints () const

void	setInputMethodHints (Qt::InputMethodHints hints)

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

void	killTimer (Qt::TimerId id)

template<typename T >
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

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
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

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

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

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
	\reimp

virtual bool	hitButton (const QPoint &pos) const
	Returns `true` if pos is inside the clickable button rectangle; otherwise returns `false`.

virtual void	checkStateSet ()
	This virtual handler is called when setChecked() is used, unless it is called from within nextCheckState().

virtual void	nextCheckState ()
	This virtual handler is called when a button is clicked.

bool	event (QEvent *e) override
	\reimp

void	keyPressEvent (QKeyEvent *e) override
	\reimp

void	keyReleaseEvent (QKeyEvent *e) override
	\reimp

void	mousePressEvent (QMouseEvent *e) override
	\reimp

void	mouseReleaseEvent (QMouseEvent *e) override
	\reimp

void	mouseMoveEvent (QMouseEvent *e) override
	\reimp

void	focusInEvent (QFocusEvent *e) override
	\reimp

void	focusOutEvent (QFocusEvent *e) override
	\reimp

void	changeEvent (QEvent *e) override
	\reimp

void	timerEvent (QTimerEvent *e) override
	\reimp

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

Protected Member Functions inherited from QWidget
bool	event (QEvent *event) override
	This is the main event handler; it handles event event.

virtual void	mouseDoubleClickEvent (QMouseEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive mouse double click events for the widget.

virtual void	enterEvent (QEnterEvent *event)
	This event handler can be reimplemented in a subclass to receive widget enter events which are passed in the event parameter.

virtual void	leaveEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive widget leave events which are passed in the event parameter.

virtual void	moveEvent (QMoveEvent *event)
	This event handler can be reimplemented in a subclass to receive widget move events which are passed in the event parameter.

virtual void	resizeEvent (QResizeEvent *event)
	This event handler can be reimplemented in a subclass to receive widget resize events which are passed in the event parameter.

virtual void	closeEvent (QCloseEvent *event)
	This event handler is called with the given event when Qt receives a window close request for a top-level widget from the window system.

virtual void	contextMenuEvent (QContextMenuEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive widget context menu events.

virtual void	actionEvent (QActionEvent *event)
	This event handler is called with the given event whenever the widget's actions are changed.

virtual void	showEvent (QShowEvent *event)
	This event handler can be reimplemented in a subclass to receive widget show events which are passed in the event parameter.

virtual void	hideEvent (QHideEvent *event)
	This event handler can be reimplemented in a subclass to receive widget hide events.

virtual bool	nativeEvent (const QByteArray &eventType, void message, qintptr result)
	This special event handler can be reimplemented in a subclass to receive native platform events identified by eventType which are passed in the message parameter.

int	metric (PaintDeviceMetric) const override
	Internal implementation of the virtual QPaintDevice::metric() function.

void	initPainter (QPainter *painter) const override
	Initializes the painter pen, background and font to the same as the given widget's.

QPaintDevice *	redirected (QPoint *offset) const override

QPainter *	sharedPainter () const override

virtual void	inputMethodEvent (QInputMethodEvent *)
	This event handler, for event event, can be reimplemented in a subclass to receive Input Method composition events.

void	create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true)
	Creates a new widget window.

void	destroy (bool destroyWindow=true, bool destroySubWindows=true)
	Frees up window system resources.

virtual bool	focusNextPrevChild (bool next)
	Finds a new widget to give the keyboard focus to, as appropriate for Tab and Shift+Tab, and returns `true` if it can find a new widget, or false if it can't.

bool	focusNextChild ()
	Finds a new widget to give the keyboard focus to, as appropriate for \uicontrol Tab, and returns `true` if it can find a new widget, or false if it can't.

bool	focusPreviousChild ()
	Finds a new widget to give the keyboard focus to, as appropriate for \uicontrol Shift+Tab, and returns `true` if it can find a new widget, or false if it can't.

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

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

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

QIcon	icon
	the icon shown on the button

QSize	iconSize
	the icon size used for this button.

QKeySequence	shortcut
	the mnemonic associated with the button

bool	checkable
	whether the button is checkable

bool	checked
	whether the button is checked

bool	autoRepeat
	whether autoRepeat is enabled

bool	autoExclusive
	whether auto-exclusivity is enabled

int	autoRepeatDelay
	the initial delay of auto-repetition

int	autoRepeatInterval
	the interval of auto-repetition

bool	down
	whether the button is pressed down

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

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

bool	enabled
	whether the widget is enabled

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

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

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

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

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

QPoint	pos
	the position of the widget within its parent widget

QSize	frameSize
	the size of the widget including any window frame

QSize	size
	the size of the widget excluding any window frame

int	width
	the width of the widget excluding any window frame

int	height
	the height of the widget excluding any window frame

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

QRect	childrenRect
	the bounding rectangle of the widget's children

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

QSizePolicy	sizePolicy
	the default layout behavior of the widget

QSize	minimumSize
	the widget's minimum size

QSize	maximumSize
	the widget's maximum size in pixels

int	minimumWidth
	the widget's minimum width in pixels

int	minimumHeight
	the widget's minimum height in pixels

int	maximumWidth
	the widget's maximum width in pixels

int	maximumHeight
	the widget's maximum height in pixels

QSize	sizeIncrement
	the size increment of the widget

QSize	baseSize
	the base size of the widget

QPalette	palette
	the widget's palette

QFont	font
	the font currently set for the widget

QCursor	cursor
	the cursor shape for this widget

bool	mouseTracking
	whether mouse tracking is enabled for the widget

bool	tabletTracking
	whether tablet tracking is enabled for the widget

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

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

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

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

bool	updatesEnabled
	whether updates are enabled

bool	visible
	whether the widget is visible

bool	minimized
	whether this widget is minimized (iconified)

bool	maximized
	whether this widget is maximized

bool	fullScreen
	whether the widget is shown in full screen mode

QSize	sizeHint
	the recommended size for the widget

QSize	minimumSizeHint
	the recommended minimum size for the widget

bool	acceptDrops
	whether drop events are enabled for this widget

QString	windowTitle
	the window title (caption)

QIcon	windowIcon
	the widget's icon

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

double	windowOpacity
	The level of opacity for the window.

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

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

bool	autoFillBackground
	whether the widget background is filled automatically

QString	styleSheet
	the widget's style sheet

QLocale	locale
	the widget's locale

QString	windowFilePath
	the file path associated with a widget

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

Properties inherited from QObject
QString	objectName
	the name of this object

Friends
class	QButtonGroup

Additional Inherited Members
Public Types inherited from QWidget
enum	RenderFlag { DrawWindowBackground = 0x1 , DrawChildren = 0x2 , IgnoreMask = 0x4 }
	This enum describes how to render the widget when calling QWidget::render(). More...

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 )
	Puts the second widget after the first widget in the focus order.

static void	setTabOrder (std::initializer_list< QWidget * > widgets)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

static QWidget *	mouseGrabber ()
	Returns the widget that is currently grabbing the mouse input.

static QWidget *	keyboardGrabber ()
	Returns the widget that is currently grabbing the keyboard input.

static QWidget *	find (WId)
	Returns a pointer to the widget with window identifier/handle id.

static QWidget *	createWindowContainer (QWindow window, QWidget parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())
	Creates a QWidget that makes it possible to embed window into a QWidget-based application.

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)
	\threadsafe

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::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

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

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

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

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a 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)
	Updates the widget's micro focus and informs input methods that the state specified by query has changed.

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Protected Attributes inherited from QPaintDevice
ushort	painters

Related Symbols inherited from QWidget
	setupUi (QWidget *widget)
	\macro QWIDGETSIZE_MAX

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

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

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

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

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.

button->setIcon(QIcon(":/images/print.png"));

button->setShortcut(tr("Alt+F7"));

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 22 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 436 of file qabstractbutton.cpp.

◆ ~QAbstractButton()

QAbstractButton::~QAbstractButton ( )

Destroys the button.

Definition at line 446 of file qabstractbutton.cpp.

References d.

◆ QAbstractButton() [2/2]

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

protected

Definition at line 458 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 800 of file qabstractbutton.cpp.

References Qt::ClickFocus, d, QWidget::focusPolicy, QWidget::isEnabled(), QWidget::repaint(), setDown(), and QWidget::setFocus().

Referenced by event(), and QLabel::event().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ autoExclusive()

bool QAbstractButton::autoExclusive ( ) const

Definition at line 765 of file qabstractbutton.cpp.

References d.

◆ autoRepeat()

bool QAbstractButton::autoRepeat ( ) const

Definition at line 688 of file qabstractbutton.cpp.

References d.

◆ autoRepeatDelay()

int QAbstractButton::autoRepeatDelay ( ) const

Definition at line 711 of file qabstractbutton.cpp.

References d.

◆ autoRepeatInterval()

int QAbstractButton::autoRepeatInterval ( ) const

Definition at line 734 of file qabstractbutton.cpp.

References d.

◆ changeEvent()

void QAbstractButton::changeEvent ( QEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Reimplemented in QToolButton.

Definition at line 1145 of file qabstractbutton.cpp.

References QWidget::changeEvent(), d, QEvent::EnabledChange, QWidget::isEnabled(), and QEvent::type().

Referenced by QToolButton::changeEvent().

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 QCheckBox, and QToolButton.

Definition at line 862 of file qabstractbutton.cpp.

Referenced by setChecked().

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 825 of file qabstractbutton.cpp.

References d, QWidget::isEnabled(), and nextCheckState().

Referenced by QDialog::keyPressEvent(), QPushButton::keyPressEvent(), and QAbstractButtonPrivate::moveFocus().

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()

Referenced by ButtonWidget::ButtonWidget(), MyGame::MyGame(), QPageSetupWidget::QPageSetupWidget(), QPrintPropertiesDialog::QPrintPropertiesDialog(), ScreenWidget::ScreenWidget(), Window::Window(), QDialogButtonBoxPrivate::addButton(), QFileDialogPrivate::createToolButtons(), QPrintDialogPrivate::init(), QFontDialogPrivate::init(), QDockWidgetPrivate::init(), QTabBarPrivate::init(), QColorDialogPrivate::initWidgets(), main(), and QDialogButtonBoxPrivate::removeButton().

Here is the caller graph for this function:

◆ event()

bool QAbstractButton::event ( QEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QObject.

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

Definition at line 893 of file qabstractbutton.cpp.

References animateClick(), QEvent::ContextMenu, d, QWidget::event(), QWidget::focusPolicy, QEvent::HoverEnter, QEvent::HoverLeave, QEvent::HoverMove, QWidget::isEnabled(), QEvent::MouseButtonDblClick, QEvent::MouseButtonPress, QEvent::MouseButtonRelease, QEvent::MouseMove, Qt::NoFocus, QWidget::setAttribute(), QWidget::setFocus(), QEvent::Shortcut, Qt::ShortcutFocusReason, QEvent::TabletMove, QEvent::TabletPress, QEvent::TabletRelease, QEvent::type(), Qt::WA_KeyboardFocusChange, and QWidget::window().

Referenced by QCheckBox::event(), QPushButton::event(), QRadioButton::event(), QToolButton::event(), and QDockWidgetTitleButton::event().

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 QPushButton.

Definition at line 1123 of file qabstractbutton.cpp.

References d, and QWidget::focusInEvent().

Referenced by QPushButton::focusInEvent().

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 1134 of file qabstractbutton.cpp.

References d, QWidget::focusOutEvent(), Qt::PopupFocusReason, and QFocusEvent::reason().

Referenced by QPushButton::focusOutEvent().

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 QRadioButton, QCheckBox, QPushButton, and QToolButton.

Definition at line 887 of file qabstractbutton.cpp.

References QRect::contains(), QWidget::pos, and QWidget::rect.

Referenced by QToolButton::hitButton(), mouseMoveEvent(), mousePressEvent(), and mouseReleaseEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ icon()

QIcon QAbstractButton::icon ( ) const

Definition at line 524 of file qabstractbutton.cpp.

References d.

◆ iconSize()

QSize QAbstractButton::iconSize ( ) const

Definition at line 1234 of file qabstractbutton.cpp.

References d, QStyle::pixelMetric(), QStyle::PM_ButtonIconSize, and QWidget::style().

Here is the call graph for this function:

◆ isCheckable()

bool QAbstractButton::isCheckable ( ) const

Definition at line 570 of file qabstractbutton.cpp.

References d.

Referenced by nextCheckState().

Here is the caller graph for this function:

◆ isChecked()

bool QAbstractButton::isChecked ( ) const

Definition at line 628 of file qabstractbutton.cpp.

References d.

Referenced by QQuickButtonGroupPrivate::_q_updateCurrent(), QButtonGroup::addButton(), QQuickButtonGroup::addButton(), QToolButton::checkStateSet(), QButtonGroupPrivate::detectCheckedButton(), QQuickAbstractButtonPrivate::findCheckedButton(), QQuickStyleItemButton::initStyleOption(), QQuickStyleItemCheckBox::initStyleOption(), QQuickStyleItemRadioButton::initStyleOption(), nextCheckState(), QCommandLinkButton::paintEvent(), QDockWidgetTitleButton::paintEvent(), QQuickButtonGroupPrivate::updateCheckState(), QQuickTabBarPrivate::updateCurrentIndex(), and QFontDialogPrivate::updateSample().

Here is the caller graph for this function:

◆ isDown()

bool QAbstractButton::isDown ( ) const

Definition at line 656 of file qabstractbutton.cpp.

References d.

Referenced by QQuickStyleItemButton::initStyleOption(), QQuickStyleItemCheckBox::initStyleOption(), QQuickStyleItemRadioButton::initStyleOption(), QQuickStyleItemDelayButton::initStyleOption(), QToolBoxButton::initStyleOption(), MyPushButton::paintEvent(), QCommandLinkButton::paintEvent(), QtPrivate::QCalToolButton::paintEvent(), and QDockWidgetTitleButton::paintEvent().

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 1007 of file qabstractbutton.cpp.

References QPlatformTheme::ButtonPressKeys, QKeySequence::Cancel, d, QWidget::focusNextPrevChild(), QWidget::hasFocus(), QEvent::ignore(), QKeyEvent::isAutoRepeat(), QKeyEvent::key(), Qt::Key_Down, Qt::Key_Left, Qt::Key_Right, Qt::Key_Up, Qt::NavigationModeKeypadDirectional, next, QWidget::parentWidget(), QGuiApplicationPrivate::platformTheme(), Q_FALLTHROUGH, QT_CONFIG, QWidget::repaint(), Qt::RightToLeft, and setDown().

Referenced by QPushButton::keyPressEvent().

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 1081 of file qabstractbutton.cpp.

References QPlatformTheme::ButtonPressKeys, d, QEvent::ignore(), QKeyEvent::isAutoRepeat(), QKeyEvent::key(), and QGuiApplicationPrivate::platformTheme().

Here is the call graph for this function:

◆ mouseMoveEvent()

void QAbstractButton::mouseMoveEvent ( QMouseEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Reimplemented in QCheckBox, QPushButton, and QRadioButton.

Definition at line 985 of file qabstractbutton.cpp.

References QEvent::accept(), QSinglePointEvent::buttons(), d, hitButton(), QEvent::ignore(), Qt::LeftButton, QSinglePointEvent::position(), QWidget::repaint(), setDown(), and QPointF::toPoint().

Referenced by QCheckBox::mouseMoveEvent(), QPushButton::mouseMoveEvent(), and QRadioButton::mouseMoveEvent().

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 937 of file qabstractbutton.cpp.

References QEvent::accept(), QSinglePointEvent::button(), d, hitButton(), QEvent::ignore(), Qt::LeftButton, QSinglePointEvent::position(), QWidget::repaint(), setDown(), and QPointF::toPoint().

Referenced by QToolButton::mousePressEvent().

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 956 of file qabstractbutton.cpp.

References QEvent::accept(), QSinglePointEvent::button(), d, hitButton(), QEvent::ignore(), Qt::LeftButton, QSinglePointEvent::position(), setDown(), and QPointF::toPoint().

Referenced by QToolButton::mouseReleaseEvent().

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 QCheckBox, and QToolButton.

Definition at line 873 of file qabstractbutton.cpp.

References isCheckable(), isChecked(), and setChecked().

Referenced by click(), QCheckBox::nextCheckState(), QToolButton::nextCheckState(), QAbstractButtonPrivate::notifyChecked(), and timerEvent().

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 MyPushButton, QtPrivate::QPrevNextCalButton, QCheckBox, QCommandLinkButton, QMenuBarExtension, QPushButton, QRadioButton, QToolBarExtension, QToolBoxButton, QToolButton, QtPrivate::QCalToolButton, and QDockWidgetTitleButton.

◆ pressed

void QAbstractButton::pressed ( )

signal

This signal is emitted when the button is pressed down.

See also: released(), clicked()

Referenced by QToolButtonPrivate::init().

Here is the caller graph for this function:

◆ released

void QAbstractButton::released ( )

signal

This signal is emitted when the button is released.

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

Referenced by QToolButtonPrivate::init().

Here is the caller graph for this function:

◆ setAutoExclusive()

void QAbstractButton::setAutoExclusive ( bool autoExclusive )

Definition at line 759 of file qabstractbutton.cpp.

References autoExclusive, and d.

◆ setAutoRepeat()

void QAbstractButton::setAutoRepeat ( bool autoRepeat )

Definition at line 676 of file qabstractbutton.cpp.

References autoRepeat, and d.

Referenced by QCalendarWidgetPrivate::createNavigationBar(), QTabBarPrivate::init(), and QPrintPreviewDialogPrivate::init().

Here is the caller graph for this function:

◆ setAutoRepeatDelay()

void QAbstractButton::setAutoRepeatDelay ( int autoRepeatDelay )

Definition at line 705 of file qabstractbutton.cpp.

References autoRepeatDelay, and d.

◆ setAutoRepeatInterval()

void QAbstractButton::setAutoRepeatInterval ( int autoRepeatInterval )

Definition at line 728 of file qabstractbutton.cpp.

References autoRepeatInterval, and d.

◆ setCheckable()

void QAbstractButton::setCheckable ( bool checkable )

Definition at line 560 of file qabstractbutton.cpp.

References checkable, and d.

Referenced by QToolBarExtension::QToolBarExtension(), and QToolButton::setDefaultAction().

Here is the caller graph for this function:

◆ setChecked

void QAbstractButton::setChecked ( bool checked )

slot

Definition at line 584 of file qabstractbutton.cpp.

References checked, checkStateSet(), and d.

Referenced by QQuickAbstractButton::buttonChange(), nextCheckState(), QErrorMessagePrivate::nextPending(), QCheckBox::setCheckState(), QQuickButtonGroup::setCheckState(), QToolButton::setDefaultAction(), QToolBarLayout::setExpanded(), toggle(), and QQuickTabBarPrivate::updateCurrentItem().

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 643 of file qabstractbutton.cpp.

References d, and down.

Referenced by animateClick(), QPushButton::focusOutEvent(), keyPressEvent(), mouseMoveEvent(), mousePressEvent(), and mouseReleaseEvent().

Here is the caller graph for this function:

◆ setIcon()

void QAbstractButton::setIcon ( const QIcon & icon )

Definition at line 515 of file qabstractbutton.cpp.

References d, icon, QWidget::update(), and QWidget::updateGeometry().

Referenced by QMenuBarExtension::QMenuBarExtension(), QPushButton::QPushButton(), QDialogButtonBoxPrivate::createButton(), QToolButton::setDefaultAction(), QToolBoxPrivate::Page::setIcon(), QToolBarExtension::setOrientation(), QCalendarWidgetPrivate::updateButtonIcons(), QDockWidgetPrivate::updateButtons(), and src_gui_image_qicon::wrapper0().

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 1243 of file qabstractbutton.cpp.

References d, QWidget::isVisible(), QWidget::size, QWidget::update(), and QWidget::updateGeometry().

Here is the call graph for this function:

◆ setShortcut()

void QAbstractButton::setShortcut ( const QKeySequence & key )

Definition at line 536 of file qabstractbutton.cpp.

References d, QWidget::grabShortcut(), and QWidget::releaseShortcut().

Referenced by QDialogButtonBoxPrivate::createButton(), and setText().

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 482 of file qabstractbutton.cpp.

References d, QKeySequence::mnemonic(), setShortcut(), text, QWidget::update(), and QWidget::updateGeometry().

Referenced by QCheckBox::QCheckBox(), QCommandLinkButton::QCommandLinkButton(), QPushButton::QPushButton(), QPushButton::QPushButton(), QRadioButton::QRadioButton(), QPrintDialogPrivate::_q_collapseOrExpandDialog(), QCalendarWidgetPrivate::_q_monthChanged(), QCalendarWidgetPrivate::_q_yearEditingFinished(), QMessageBox::addButton(), QQuickDialogButtonBoxPrivate::createStandardButton(), QWizardPrivate::ensureButton(), QPrintDialogPrivate::init(), QErrorMessagePrivate::retranslateStrings(), QFontDialogPrivate::retranslateStrings(), QProgressDialogPrivate::setCancelButtonText(), QToolButton::setDefaultAction(), DetailButton::setLabel(), QFileDialogPrivate::setLabelTextControl(), QToolBoxPrivate::Page::setText(), QWizardPrivate::updateButtonTexts(), QQuickDialogButtonBoxPrivate::updateLanguage(), and QCalendarWidgetPrivate::updateNavigationBar().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ shortcut()

QKeySequence QAbstractButton::shortcut ( ) const

Definition at line 545 of file qabstractbutton.cpp.

References d.

◆ text()

QString QAbstractButton::text ( ) const

Definition at line 501 of file qabstractbutton.cpp.

References d.

◆ timerEvent()

void QAbstractButton::timerEvent ( QTimerEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QObject.

Reimplemented in QToolButton.

Definition at line 1101 of file qabstractbutton.cpp.

References d, nextCheckState(), and QTimerEvent::timerId().

Referenced by QToolButton::timerEvent().

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 849 of file qabstractbutton.cpp.

References d, and setChecked().

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:

void MyWidget::reactToToggle(bool checked)
{
   if (checked) {
      // Examine the new button states.
      ...
   }
}

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()

Referenced by extension(), and QPrintDialogPrivate::init().

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ QButtonGroup

friend class QButtonGroup

friend

Definition at line 118 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 35 of file qabstractbutton.h.

Referenced by QQuickAbstractButtonPrivate::findExclusiveButtons(), QAbstractButtonPrivate::queryButtonList(), and setAutoExclusive().

◆ 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 34 of file qabstractbutton.h.

Referenced by setAutoRepeat().

◆ 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 36 of file qabstractbutton.h.

Referenced by setAutoRepeatDelay().

◆ 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 37 of file qabstractbutton.h.

Referenced by setAutoRepeatInterval().

◆ checkable

QAbstractButton::checkable

readwrite

whether the button is checkable

By default, the button is not checkable.

See also: checked

Definition at line 32 of file qabstractbutton.h.

Referenced by QAbstractButtonPrivate::moveFocus(), and setCheckable().

◆ 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 33 of file qabstractbutton.h.

Referenced by QAbstractButtonPrivate::moveFocus(), and setChecked().

◆ 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 38 of file qabstractbutton.h.

Referenced by setDown().

◆ 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 27 of file qabstractbutton.h.

Referenced by QPushButton::QPushButton(), QQC2::QCommonStyle::drawControl(), QCommonStyle::drawControl(), QCommandLinkButton::heightForWidth(), QToolBoxPrivate::Page::icon(), QToolBoxButton::initStyleOption(), QCommandLinkButton::minimumSizeHint(), QToolBoxButton::minimumSizeHint(), MyPushButton::paintEvent(), QCommandLinkButton::paintEvent(), QDockWidgetTitleButton::paintEvent(), setIcon(), QDockWidgetTitleButton::sizeHint(), QPushButton::sizeHint(), QToolBoxButton::sizeHint(), and QToolButton::sizeHint().

◆ 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 28 of file qabstractbutton.h.

Referenced by QQC2::QCommonStyle::drawControl(), QCommonStyle::drawControl(), QCommandLinkButton::heightForWidth(), QRadioButton::initStyleOption(), QCheckBox::initStyleOption(), QPushButton::initStyleOption(), QToolButton::initStyleOption(), QCommandLinkButton::minimumSizeHint(), QCommandLinkButton::paintEvent(), and QToolBoxButton::sizeHint().

◆ shortcut

QAbstractButton::shortcut

readwrite

the mnemonic associated with the button

Definition at line 30 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 26 of file qabstractbutton.h.

Referenced by QCheckBox::QCheckBox(), QCommandLinkButton::QCommandLinkButton(), QPushButton::QPushButton(), QPushButton::QPushButton(), QRadioButton::QRadioButton(), QMessageBox::addButton(), QQC2::QCommonStyle::drawControl(), QCommonStyle::drawControl(), QQuickDialogTestUtils::findDialogButton(), QErrorMessagePrivate::helperPrepareShow(), QMessageBoxPrivate::helperPrepareShow(), QToolBoxButton::initStyleOption(), QMessageBox::keyPressEvent(), QFileDialog::labelText(), MyPushButton::paintEvent(), QCommandLinkButton::paintEvent(), QWizard::setButton(), setText(), QCheckBox::sizeHint(), QCommandLinkButton::sizeHint(), QPushButton::sizeHint(), QRadioButton::sizeHint(), QToolBoxButton::sizeHint(), QToolButton::sizeHint(), and QToolBoxPrivate::Page::text().

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

qtbase/src/widgets/widgets/qabstractbutton.h (05fc3aef53348fb58be6308076e000825b704e58)
qtbase/src/widgets/widgets/qabstractbutton.cpp (4a7c76d4a5365343178ea29c8a8e9b8d8acb89b5)

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 Symbol Documentation

◆ QButtonGroup

Property Documentation

◆ autoExclusive

◆ autoRepeat

◆ autoRepeatDelay

◆ autoRepeatInterval

◆ checkable

◆ checked

◆ down

◆ icon

◆ iconSize

◆ shortcut

◆ text