#include <qquickbuttongroup_p.h>

Inheritance diagram for QQuickButtonGroup:

Collaboration diagram for QQuickButtonGroup:

Public Slots
void	addButton (QQuickAbstractButton *button)
	\qmlmethod void QtQuick.Controls::ButtonGroup::addButton(AbstractButton button)

void	removeButton (QQuickAbstractButton *button)
	\qmlmethod void QtQuick.Controls::ButtonGroup::removeButton(AbstractButton button)

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	checkedButtonChanged ()

void	buttonsChanged ()

	Q_REVISION (2, 1) void clicked(QQuickAbstractButton *button)

	Q_REVISION (2, 3) void exclusiveChanged()

	Q_REVISION (2, 4) void checkStateChanged()

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
	QQuickButtonGroup (QObject *parent=nullptr)

	~QQuickButtonGroup ()

QQuickAbstractButton *	checkedButton () const
	\qmlproperty AbstractButton QtQuick.Controls::ButtonGroup::checkedButton

void	setCheckedButton (QQuickAbstractButton *checkedButton)

QQmlListProperty< QQuickAbstractButton >	buttons ()

bool	isExclusive () const

void	setExclusive (bool exclusive)

Qt::CheckState	checkState () const

void	setCheckState (Qt::CheckState state)

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	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

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

virtual	~QQmlParserStatus ()

Static Public Member Functions
static QQuickButtonGroupAttached *	qmlAttachedProperties (QObject *object)

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)

Protected Member Functions
void	classBegin () override
	Invoked after class creation, but before any properties have been set.

void	componentComplete () override
	Invoked after the root component that caused this instantiation has completed construction.

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	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

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)

Properties
QQuickAbstractButton *	checkedButton

QQmlListProperty< QQuickAbstractButton >	buttons
	\qmlproperty list<AbstractButton> QtQuick.Controls::ButtonGroup::buttons

bool	exclusive

Qt::CheckState	checkState

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

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

Definition at line 30 of file qquickbuttongroup_p.h.

Constructor & Destructor Documentation

◆ QQuickButtonGroup()

QQuickButtonGroup::QQuickButtonGroup ( QObject * parent = nullptr )

explicit

Definition at line 260 of file qquickbuttongroup.cpp.

◆ ~QQuickButtonGroup()

QQuickButtonGroup::~QQuickButtonGroup ( )

Definition at line 265 of file qquickbuttongroup.cpp.

Member Function Documentation

◆ addButton

void QQuickButtonGroup::addButton ( QQuickAbstractButton * button )

slot

\qmlmethod void QtQuick.Controls::ButtonGroup::addButton(AbstractButton button)

Adds a button to the button group.

Note: Manually adding objects to a button group is typically unnecessary. The \l buttons property and the \l group attached property provide a convenient and declarative syntax.

See also: buttons, group

Definition at line 428 of file qquickbuttongroup.cpp.

◆ buttons()

QQmlListProperty< QQuickAbstractButton > QQuickButtonGroup::buttons ( )

◆ buttonsChanged

void QQuickButtonGroup::buttonsChanged ( )

signal

◆ checkedButton()

QQuickAbstractButton * QQuickButtonGroup::checkedButton ( ) const

\qmlproperty AbstractButton QtQuick.Controls::ButtonGroup::checkedButton

This property holds the currently selected button in an exclusive group, or null if there is none or the group is non-exclusive.

By default, it is the first checked button added to an exclusive button group.

See also: exclusive

Definition at line 286 of file qquickbuttongroup.cpp.

◆ checkedButtonChanged

void QQuickButtonGroup::checkedButtonChanged ( )

signal

◆ checkState()

Qt::CheckState QQuickButtonGroup::checkState ( ) const

Since: QtQuick.Controls 2.4 (Qt 5.11) \qmlproperty enumeration QtQuick.Controls::ButtonGroup::checkState

This property holds the combined check state of the button group.

Available states: \value Qt.Unchecked None of the buttons are checked. \value Qt.PartiallyChecked Some of the buttons are checked. \value Qt.Checked All of the buttons are checked.

Setting the check state of a non-exclusive button group to Qt.Unchecked or Qt.Checked unchecks or checks all buttons in the group, respectively. Qt.PartiallyChecked is ignored.

Setting the check state of an exclusive button group to Qt.Unchecked unchecks the \l checkedButton. Qt.Checked and Qt.PartiallyChecked are ignored.

Definition at line 393 of file qquickbuttongroup.cpp.

◆ classBegin()

void QQuickButtonGroup::classBegin ( )

overrideprotectedvirtual

Invoked after class creation, but before any properties have been set.

Implements QQmlParserStatus.

Definition at line 475 of file qquickbuttongroup.cpp.

◆ componentComplete()

void QQuickButtonGroup::componentComplete ( )

overrideprotectedvirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

Definition at line 481 of file qquickbuttongroup.cpp.

◆ isExclusive()

bool QQuickButtonGroup::isExclusive ( ) const

Since: QtQuick.Controls 2.3 (Qt 5.10) \qmlproperty bool QtQuick.Controls::ButtonGroup::exclusive

This property holds whether the button group is exclusive. The default value is true.

If this property is true, then only one button in the group can be checked at any given time. The user can click on any button to check it, and that button will replace the existing one as the checked button in the group.

In an exclusive group, the user cannot uncheck the currently checked button by clicking on it; instead, another button in the group must be clicked to set the new checked button for that group.

In a non-exclusive group, checking and unchecking buttons does not affect the other buttons in the group. Furthermore, the value of the \l checkedButton property is null.

Definition at line 358 of file qquickbuttongroup.cpp.

◆ Q_REVISION [1/3]

QQuickButtonGroup::Q_REVISION	(	2	,
		1	)

signal

◆ Q_REVISION [2/3]

QQuickButtonGroup::Q_REVISION	(	2	,
		3	)

signal

◆ Q_REVISION [3/3]

QQuickButtonGroup::Q_REVISION	(	2	,
		4	)

signal

◆ qmlAttachedProperties()

QQuickButtonGroupAttached * QQuickButtonGroup::qmlAttachedProperties ( QObject * object )

static

Definition at line 271 of file qquickbuttongroup.cpp.

◆ removeButton

void QQuickButtonGroup::removeButton ( QQuickAbstractButton * button )

slot

\qmlmethod void QtQuick.Controls::ButtonGroup::removeButton(AbstractButton button)

Removes a button from the button group.

Note: Manually removing objects from a button group is typically unnecessary. The \l buttons property and the \l group attached property provide a convenient and declarative syntax.

See also: buttons, group

Definition at line 457 of file qquickbuttongroup.cpp.

◆ setCheckedButton()

void QQuickButtonGroup::setCheckedButton ( QQuickAbstractButton * checkedButton )

Definition at line 292 of file qquickbuttongroup.cpp.

◆ setCheckState()

void QQuickButtonGroup::setCheckState ( Qt::CheckState state )

Definition at line 399 of file qquickbuttongroup.cpp.

◆ setExclusive()

void QQuickButtonGroup::setExclusive ( bool exclusive )

Definition at line 364 of file qquickbuttongroup.cpp.

Property Documentation

◆ buttons

QQmlListProperty< QQuickAbstractButton > QQuickButtonGroup::buttons

read

\qmlproperty list<AbstractButton> QtQuick.Controls::ButtonGroup::buttons

This property holds the list of buttons.

ButtonGroup {
    buttons: column.children
}
 
Column {
    id: column
 
    RadioButton {
        checked: true
        text: qsTr("Option A")
    }
 
    RadioButton {
        text: qsTr("Option B")
    }
}

See also: group

Definition at line 34 of file qquickbuttongroup_p.h.

◆ checkedButton

QQuickAbstractButton * QQuickButtonGroup::checkedButton

readwrite

Definition at line 33 of file qquickbuttongroup_p.h.

◆ checkState

Qt::CheckState QQuickButtonGroup::checkState

readwrite

Definition at line 38 of file qquickbuttongroup_p.h.

◆ exclusive

bool QQuickButtonGroup::exclusive

readwrite

Definition at line 36 of file qquickbuttongroup_p.h.

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

qtdeclarative/src/quicktemplates/qquickbuttongroup_p.h (6f6a68182b675a8f619f434a2c8052aac61cc788)
qtdeclarative/src/quicktemplates/qquickbuttongroup.cpp (aeabdb93885e51d5c7dbecbb69af1750370a65fa)

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickButtonGroup()

◆ ~QQuickButtonGroup()

Member Function Documentation

◆ addButton

◆ buttons()

◆ buttonsChanged

◆ checkedButton()

◆ checkedButtonChanged

◆ checkState()

◆ classBegin()

◆ componentComplete()

◆ isExclusive()

◆ Q_REVISION [1/3]

◆ Q_REVISION [2/3]

◆ Q_REVISION [3/3]

◆ qmlAttachedProperties()

◆ removeButton

◆ setCheckedButton()

◆ setCheckState()

◆ setExclusive()

Property Documentation

◆ buttons

◆ checkedButton

◆ checkState

◆ exclusive