The QActionGroup class groups actions together. More...

#include <qactiongroup.h>

Inheritance diagram for QActionGroup:

Collaboration diagram for QActionGroup:

Public Types
enum class	ExclusionPolicy { None , Exclusive , ExclusiveOptional }
	This enum specifies the different policies that can be used to control how the group performs exclusive checking on checkable actions. More...

Public Slots
void	setEnabled (bool)

void	setDisabled (bool b)
	This is a convenience function for the \l enabled property, that is useful for signals–slots connections.

void	setVisible (bool)

void	setExclusive (bool)
	Enable or disable the group exclusion checking.

void	setExclusionPolicy (ExclusionPolicy policy)

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	triggered (QAction *)
	This signal is emitted when the given action in the action group is activated by the user; for example, when the user clicks a menu option or a toolbar button, or presses an action's shortcut key combination.

void	hovered (QAction *)
	This signal is emitted when the given action in the action group is highlighted by the user; for example, when the user pauses with the cursor over a menu option or a toolbar button, or presses an action's shortcut key combination.

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
	QActionGroup (QObject *parent)
	Constructs an action group for the parent object.

	~QActionGroup ()
	Destroys the action group.

QAction *	addAction (QAction *a)
	Adds the action to this group, and returns it.

QAction *	addAction (const QString &text)
	Creates and returns an action with text.

QAction *	addAction (const QIcon &icon, const QString &text)
	Creates and returns an action with text and an icon.

void	removeAction (QAction *a)
	Removes the action from this group.

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

QAction *	checkedAction () const
	Returns the currently checked action in the group, or \nullptr if none are checked.

bool	isExclusive () const
	Returns true if the group is exclusive.

bool	isEnabled () const

bool	isVisible () const

ExclusionPolicy	exclusionPolicy () const

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

Protected Member Functions
	QActionGroup (QActionGroupPrivate &dd, QObject *parent)

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
QActionGroup::ExclusionPolicy	exclusionPolicy
	This property holds the group exclusive checking policy.

bool	enabled
	whether the action group is enabled

bool	visible
	whether the action group is visible

Properties inherited from QObject
QString	objectName
	the name of this object

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

The QActionGroup class groups actions together.

Since: 6.0

\inmodule QtGui

QActionGroup is a base class for classes grouping classes inhheriting QAction objects together.

In some situations it is useful to group QAction objects together. For example, if you have a \uicontrol{Left Align} action, a \uicontrol{Right Align} action, a \uicontrol{Justify} action, and a \uicontrol{Center} action, only one of these actions should be active at any one time. One simple way of achieving this is to group the actions together in an action group, inheriting QActionGroup.

See also: QAction

Definition at line 16 of file qactiongroup.h.

Member Enumeration Documentation

◆ ExclusionPolicy

enum class QActionGroup::ExclusionPolicy

strong

This enum specifies the different policies that can be used to control how the group performs exclusive checking on checkable actions.

\value None The actions in the group can be checked independently of each other.

\value Exclusive Exactly one action can be checked at any one time. This is the default policy.

\value ExclusiveOptional At most one action can be checked at any one time. The actions can also be all unchecked.

See also: exclusionPolicy

Enumerator
None
Exclusive
ExclusiveOptional

Definition at line 26 of file qactiongroup.h.

Constructor & Destructor Documentation

◆ QActionGroup() [1/2]

QActionGroup::QActionGroup ( QObject * parent )

explicit

Constructs an action group for the parent object.

The action group is exclusive by default. Call setExclusive(false) to make the action group non-exclusive. To make the group exclusive but allow unchecking the active action call instead setExclusionPolicy(QActionGroup::ExclusionPolicy::ExclusiveOptional)

Definition at line 101 of file qactiongroup.cpp.

◆ ~QActionGroup()

QActionGroup::~QActionGroup ( )

default

Destroys the action group.

◆ QActionGroup() [2/2]

QActionGroup::QActionGroup	(	QActionGroupPrivate &	dd,
		QObject *	parent )

protected

Definition at line 106 of file qactiongroup.cpp.

Member Function Documentation

◆ actions()

QList< QAction * > QActionGroup::actions ( ) const

Returns the list of this groups's actions.

This may be empty.

Definition at line 200 of file qactiongroup.cpp.

◆ addAction() [1/3]

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

Creates and returns an action with text and an icon.

The newly created action is a child of this action group.

Normally an action is added to a group by creating it with the group as its parent, so this function is not usually used.

See also: QAction::setActionGroup()

Definition at line 173 of file qactiongroup.cpp.

◆ addAction() [2/3]

QAction * QActionGroup::addAction ( const QString & text )

Creates and returns an action with text.

The newly created action is a child of this action group.

Normally an action is added to a group by creating it with the group as parent, so this function is not usually used.

See also: QAction::setActionGroup()

Definition at line 159 of file qactiongroup.cpp.

◆ addAction() [3/3]

QAction * QActionGroup::addAction ( QAction * action )

Adds the action to this group, and returns it.

Normally an action is added to a group by creating it with the group as its parent, so this function is not usually used.

See also: QAction::setActionGroup()

Definition at line 126 of file qactiongroup.cpp.

◆ checkedAction()

QAction * QActionGroup::checkedAction ( ) const

Returns the currently checked action in the group, or \nullptr if none are checked.

Definition at line 295 of file qactiongroup.cpp.

◆ exclusionPolicy()

QActionGroup::ExclusionPolicy QActionGroup::exclusionPolicy ( ) const

Definition at line 253 of file qactiongroup.cpp.

◆ hovered

void QActionGroup::hovered ( QAction * action )

signal

This signal is emitted when the given action in the action group is highlighted by the user; for example, when the user pauses with the cursor over a menu option or a toolbar button, or presses an action's shortcut key combination.

See also: QAction::activate()

◆ isEnabled()

bool QActionGroup::isEnabled ( ) const

Definition at line 285 of file qactiongroup.cpp.

◆ isExclusive()

bool QActionGroup::isExclusive ( ) const

Returns true if the group is exclusive.

The group is exclusive if the ExclusionPolicy is either Exclusive or ExclusionOptional.

Definition at line 228 of file qactiongroup.cpp.

◆ isVisible()

bool QActionGroup::isVisible ( ) const

Definition at line 320 of file qactiongroup.cpp.

◆ removeAction()

void QActionGroup::removeAction ( QAction * action )

Removes the action from this group.

The action will have no parent as a result.

See also: QAction::setActionGroup()

Definition at line 184 of file qactiongroup.cpp.

◆ setDisabled

void QActionGroup::setDisabled ( bool b )

inlineslot

This is a convenience function for the \l enabled property, that is useful for signals–slots connections.

If b is true the action group is disabled; otherwise it is enabled.

Definition at line 51 of file qactiongroup.h.

◆ setEnabled

void QActionGroup::setEnabled ( bool b )

slot

Definition at line 276 of file qactiongroup.cpp.

◆ setExclusionPolicy

void QActionGroup::setExclusionPolicy ( QActionGroup::ExclusionPolicy policy )

slot

Definition at line 247 of file qactiongroup.cpp.

◆ setExclusive

void QActionGroup::setExclusive ( bool b )

slot

Enable or disable the group exclusion checking.

This is a convenience method that calls setExclusionPolicy(ExclusionPolicy::Exclusive) when b is true, else setExclusionPolicy(QActionGroup::ExclusionPolicy::None).

See also: QActionGroup::exclusionPolicy

Definition at line 215 of file qactiongroup.cpp.

◆ setVisible

void QActionGroup::setVisible ( bool b )

slot

Definition at line 310 of file qactiongroup.cpp.

◆ triggered

void QActionGroup::triggered ( QAction * action )

signal

This signal is emitted when the given action in the action group is activated by the user; for example, when the user clicks a menu option or a toolbar button, or presses an action's shortcut key combination.

Connect to this signal for command actions.

See also: QAction::activate()

Property Documentation

◆ enabled

bool QActionGroup::enabled

readwrite

whether the action group is enabled

Each action in the group will be enabled or disabled unless it has been explicitly disabled.

See also: QAction::setEnabled()

Definition at line 22 of file qactiongroup.h.

◆ exclusionPolicy

QActionGroup::ExclusionPolicy QActionGroup::exclusionPolicy

readwrite

This property holds the group exclusive checking policy.

If exclusionPolicy is set to Exclusive, only one checkable action in the action group can ever be active at any time. If the user chooses another checkable action in the group, the one they chose becomes active and the one that was active becomes inactive. If exclusionPolicy is set to ExclusionOptional the group is exclusive but the active checkable action in the group can be unchecked leaving the group with no actions checked.

See also: QAction::checkable

Definition at line 21 of file qactiongroup.h.

◆ visible

bool QActionGroup::visible

readwrite

whether the action group is visible

Each action in the action group will match the visible state of this group unless it has been explicitly hidden.

See also: QAction::setEnabled()

Definition at line 23 of file qactiongroup.h.

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

qtbase/src/gui/kernel/qactiongroup.h (05fc3aef53348fb58be6308076e000825b704e58)
qtbase/src/gui/kernel/qactiongroup.cpp (22761f13d342df677e653c07b3d066ed2b7354ac)

Public Types

Public Slots

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ExclusionPolicy

Constructor & Destructor Documentation

◆ QActionGroup() [1/2]

◆ ~QActionGroup()

◆ QActionGroup() [2/2]

Member Function Documentation

◆ actions()

◆ addAction() [1/3]

◆ addAction() [2/3]

◆ addAction() [3/3]

◆ checkedAction()

◆ exclusionPolicy()

◆ hovered

◆ isEnabled()

◆ isExclusive()

◆ isVisible()

◆ removeAction()

◆ setDisabled

◆ setEnabled

◆ setExclusionPolicy

◆ setExclusive

◆ setVisible

◆ triggered

Property Documentation

◆ enabled

◆ exclusionPolicy

◆ visible