#include <qquickactiongroup_p.h>

Inheritance diagram for QQuickActionGroup:

Collaboration diagram for QQuickActionGroup:

Public Slots
void	addAction (QQuickAction *action)
	\qmlmethod void QtQuick.Controls::ActionGroup::addAction(Action action)

void	removeAction (QQuickAction *action)
	\qmlmethod void QtQuick.Controls::ActionGroup::removeAction(Action action)

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	checkedActionChanged ()

void	actionsChanged ()

void	exclusiveChanged ()

void	enabledChanged ()

void	triggered (QQuickAction *action)

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

	~QQuickActionGroup ()

QQuickAction *	checkedAction () const
	\qmlproperty Action QtQuick.Controls::ActionGroup::checkedAction

void	setCheckedAction (QQuickAction *checkedAction)

QQmlListProperty< QQuickAction >	actions ()

bool	isExclusive () const
	\qmlproperty bool QtQuick.Controls::ActionGroup::exclusive

void	setExclusive (bool exclusive)

bool	isEnabled () const
	\qmlproperty bool QtQuick.Controls::ActionGroup::enabled

void	setEnabled (bool enabled)

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

Static Public Member Functions
static QQuickActionGroupAttached *	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)

Properties
QQuickAction *	checkedAction

QQmlListProperty< QQuickAction >	actions
	\qmlproperty list<Action> QtQuick.Controls::ActionGroup::actions \qmldefault

bool	exclusive

bool	enabled

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
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)

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 29 of file qquickactiongroup_p.h.

Constructor & Destructor Documentation

◆ QQuickActionGroup()

QQuickActionGroup::QQuickActionGroup ( QObject * parent = nullptr )

explicit

Definition at line 196 of file qquickactiongroup.cpp.

◆ ~QQuickActionGroup()

QQuickActionGroup::~QQuickActionGroup ( )

Definition at line 201 of file qquickactiongroup.cpp.

References d.

Member Function Documentation

◆ actions()

QQmlListProperty< QQuickAction > QQuickActionGroup::actions ( )

◆ actionsChanged

void QQuickActionGroup::actionsChanged ( )

signal

Referenced by addAction(), and removeAction().

Here is the caller graph for this function:

◆ addAction

void QQuickActionGroup::addAction ( QQuickAction * action )

slot

\qmlmethod void QtQuick.Controls::ActionGroup::addAction(Action action)

Adds an action to the action group.

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

See also: actions, group

Definition at line 332 of file qquickactiongroup.cpp.

References QQuickActionGroupPrivate::_q_updateCurrent(), actionsChanged(), QQuickActionGroupPrivate::actionTriggered(), QQuickAction::checkedChanged(), QObjectPrivate::connect(), d, emit, QQuickAction::enabled, QQuickAction::enabledChanged(), QQuickActionPrivate::get(), QQuickAction::isChecked(), QQuickAction::isEnabled(), setCheckedAction(), and QQuickAction::triggered().

Referenced by QQuickActionGroupPrivate::actions_append(), and QQuickActionGroupAttached::setGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkedAction()

QQuickAction * QQuickActionGroup::checkedAction ( ) const

\qmlproperty Action QtQuick.Controls::ActionGroup::checkedAction

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

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

See also: exclusive

Definition at line 222 of file qquickactiongroup.cpp.

References d.

◆ checkedActionChanged

void QQuickActionGroup::checkedActionChanged ( )

signal

Referenced by setCheckedAction().

Here is the caller graph for this function:

◆ enabledChanged

void QQuickActionGroup::enabledChanged ( )

signal

Referenced by setEnabled().

Here is the caller graph for this function:

◆ exclusiveChanged

void QQuickActionGroup::exclusiveChanged ( )

signal

Referenced by setExclusive().

Here is the caller graph for this function:

◆ isEnabled()

bool QQuickActionGroup::isEnabled ( ) const

\qmlproperty bool QtQuick.Controls::ActionGroup::enabled

This property holds whether the action group is enabled. The default value is true.

If this property is false, then all actions in the group are disabled. If this property is true, all actions in the group are enabled, unless explicitly disabled.

Definition at line 300 of file qquickactiongroup.cpp.

References d.

◆ isExclusive()

bool QQuickActionGroup::isExclusive ( ) const

\qmlproperty bool QtQuick.Controls::ActionGroup::exclusive

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

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

In an exclusive group, the user cannot uncheck the currently checked action by triggering it; instead, another action in the group must be triggered to set the new checked action for that group.

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

Definition at line 276 of file qquickactiongroup.cpp.

References d.

◆ qmlAttachedProperties()

QQuickActionGroupAttached * QQuickActionGroup::qmlAttachedProperties ( QObject * object )

static

Definition at line 207 of file qquickactiongroup.cpp.

◆ removeAction

void QQuickActionGroup::removeAction ( QQuickAction * action )

slot

\qmlmethod void QtQuick.Controls::ActionGroup::removeAction(Action action)

Removes an action from the action group.

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

See also: actions, group

Definition at line 364 of file qquickactiongroup.cpp.

References QQuickActionGroupPrivate::_q_updateCurrent(), actionsChanged(), QQuickActionGroupPrivate::actionTriggered(), QQuickAction::checkedChanged(), d, QObjectPrivate::disconnect(), emit, QQuickAction::enabled, QQuickAction::enabledChanged(), QQuickActionPrivate::get(), QQuickAction::isEnabled(), setCheckedAction(), and QQuickAction::triggered().

Here is the call graph for this function:

◆ setCheckedAction()

void QQuickActionGroup::setCheckedAction ( QQuickAction * checkedAction )

Definition at line 228 of file qquickactiongroup.cpp.

References checkedAction, checkedActionChanged(), d, emit, and QQuickAction::setChecked().

Referenced by addAction(), and removeAction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setEnabled()

void QQuickActionGroup::setEnabled ( bool enabled )

Definition at line 306 of file qquickactiongroup.cpp.

References d, emit, enabled, and enabledChanged().

Here is the call graph for this function:

◆ setExclusive()

void QQuickActionGroup::setExclusive ( bool exclusive )

Definition at line 282 of file qquickactiongroup.cpp.

References d, emit, exclusive, and exclusiveChanged().

Here is the call graph for this function:

◆ triggered

void QQuickActionGroup::triggered ( QQuickAction * action )

signal

Property Documentation

◆ actions

QQmlListProperty< QQuickAction > QQuickActionGroup::actions

read

\qmlproperty list<Action> QtQuick.Controls::ActionGroup::actions \qmldefault

This property holds the list of actions in the group.

See also: group

Definition at line 33 of file qquickactiongroup_p.h.

◆ checkedAction

QQuickAction * QQuickActionGroup::checkedAction

readwrite

Definition at line 32 of file qquickactiongroup_p.h.

Referenced by setCheckedAction().

◆ enabled

bool QQuickActionGroup::enabled

readwrite

Definition at line 35 of file qquickactiongroup_p.h.

Referenced by setEnabled().

◆ exclusive

bool QQuickActionGroup::exclusive

readwrite

Definition at line 34 of file qquickactiongroup_p.h.

Referenced by setExclusive().

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

qtdeclarative/src/quicktemplates/qquickactiongroup_p.h (6f6a68182b675a8f619f434a2c8052aac61cc788)
qtdeclarative/src/quicktemplates/qquickactiongroup.cpp (5a665bc4740106a7c3932506173229ddc8aec8be)

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickActionGroup()

◆ ~QQuickActionGroup()

Member Function Documentation

◆ actions()

◆ actionsChanged

◆ addAction

◆ checkedAction()

◆ checkedActionChanged

◆ enabledChanged

◆ exclusiveChanged

◆ isEnabled()

◆ isExclusive()

◆ qmlAttachedProperties()

◆ removeAction

◆ setCheckedAction()

◆ setEnabled()

◆ setExclusive()

◆ triggered

Property Documentation

◆ actions

◆ checkedAction

◆ enabled

◆ exclusive