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 }

Public Slots
void	setEnabled (bool)

void	setDisabled (bool b)

void	setVisible (bool)

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

void	setExclusionPolicy (ExclusionPolicy policy)

Public Slots inherited from QObject
void	deleteLater ()

Signals
void	triggered (QAction *)

void	hovered (QAction *)

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

void	objectNameChanged (const QString &objectName, QPrivateSignal)

Public Member Functions
	QActionGroup (QObject *parent)

	~QActionGroup ()

QAction *	addAction (QAction *a)

QAction *	addAction (const QString &text)

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

void	removeAction (QAction *a)

QList< QAction * >	actions () const

QAction *	checkedAction () const

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

bool	isEnabled () const

bool	isVisible () const

ExclusionPolicy	exclusionPolicy () const

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

virtual	~QObject ()

virtual bool	event (QEvent *event)

virtual bool	eventFilter (QObject watched, QEvent event)

QString	objectName () const

void	setObjectName (const QString &name)

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const

bool	isWindowType () const

bool	signalsBlocked () const noexcept

bool	blockSignals (bool b) noexcept

QThread *	thread () const

void	moveToThread (QThread *thread)

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

void	killTimer (int id)

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

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

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

const QObjectList &	children () const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

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

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

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

void	dumpObjectTree () const

void	dumpObjectInfo () const

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

QVariant	property (const char *name) const

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const

bool	inherits (const char *classname) const

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

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

int	senderSignalIndex () const

int	receivers (const char *signal) const

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

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

Properties
QActionGroup::ExclusionPolicy	exclusionPolicy
	This property holds the group exclusive checking policy. More...

bool	enabled
	whether the action group is enabled More...

bool	visible
	whether the action group is visible More...

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

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)

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

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

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

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

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

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

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

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

static bool	disconnect (const QMetaObject::Connection &)

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

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

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

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

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

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

	QObjectList

Detailed Description

The 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 52 of file qactiongroup.h.

Member Enumeration Documentation

◆ ExclusionPolicy

enum 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 62 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 137 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 142 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 236 of file qactiongroup.cpp.

Here is the caller graph for this function:

◆ 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 209 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 195 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 162 of file qactiongroup.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkedAction()

QAction * QActionGroup::checkedAction ( ) const

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

Definition at line 331 of file qactiongroup.cpp.

Here is the caller graph for this function:

◆ exclusionPolicy()

QActionGroup::ExclusionPolicy QActionGroup::exclusionPolicy ( ) const

Definition at line 289 of file qactiongroup.cpp.

◆ hovered

void QActionGroup::hovered ( QAction * )

signal

◆ isEnabled()

bool QActionGroup::isEnabled ( ) const

Definition at line 321 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 264 of file qactiongroup.cpp.

Here is the caller graph for this function:

◆ isVisible()

bool QActionGroup::isVisible ( ) const

Definition at line 356 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 220 of file qactiongroup.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 87 of file qactiongroup.h.

◆ setEnabled

void QActionGroup::setEnabled ( bool b )

slot

Definition at line 312 of file qactiongroup.cpp.

Here is the caller graph for this function:

◆ setExclusionPolicy

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

slot

Definition at line 283 of file qactiongroup.cpp.

Here is the caller graph for this function:

◆ 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 251 of file qactiongroup.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setVisible

void QActionGroup::setVisible ( bool b )

slot

Definition at line 346 of file qactiongroup.cpp.

◆ triggered

void QActionGroup::triggered ( QAction * )

signal

Here is the caller graph for this function:

Property Documentation

◆ enabled

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 108 of file qactiongroup.h.

◆ 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 108 of file qactiongroup.h.

◆ visible

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 108 of file qactiongroup.h.

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

src/gui/kernel/qactiongroup.h
src/gui/kernel/qactiongroup.cpp

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