#include <qquicklabsplatformmenuitemgroup_p.h>

Inheritance diagram for QQuickLabsPlatformMenuItemGroup:

Collaboration diagram for QQuickLabsPlatformMenuItemGroup:

Signals
void	triggered (QQuickLabsPlatformMenuItem *item)
void	hovered (QQuickLabsPlatformMenuItem *item)
void	enabledChanged ()
void	visibleChanged ()
void	exclusiveChanged ()
void	checkedItemChanged ()
void	itemsChanged ()
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
	QQuickLabsPlatformMenuItemGroup (QObject *parent=nullptr)
	A group for managing native menu items.
	~QQuickLabsPlatformMenuItemGroup ()
bool	isEnabled () const
	\qmlproperty bool Qt.labs.platform::MenuItemGroup::enabled
void	setEnabled (bool enabled)
bool	isVisible () const
	\qmlproperty bool Qt.labs.platform::MenuItemGroup::visible
void	setVisible (bool visible)
bool	isExclusive () const
	\qmlproperty bool Qt.labs.platform::MenuItemGroup::exclusive
void	setExclusive (bool exclusive)
QQuickLabsPlatformMenuItem *	checkedItem () const
	\qmlproperty MenuItem Qt.labs.platform::MenuItemGroup::checkedItem
void	setCheckedItem (QQuickLabsPlatformMenuItem *item)
QQmlListProperty< QQuickLabsPlatformMenuItem >	items ()
Q_INVOKABLE void	addItem (QQuickLabsPlatformMenuItem *item)
	\qmlmethod void Qt.labs.platform::MenuItemGroup::addItem(MenuItem item)
Q_INVOKABLE void	removeItem (QQuickLabsPlatformMenuItem *item)
	\qmlmethod void Qt.labs.platform::MenuItemGroup::removeItem(MenuItem item)
Q_INVOKABLE void	clear ()
	\qmlmethod void Qt.labs.platform::MenuItemGroup::clear()
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	isQmlObjectType () const
	Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
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`.

Properties
bool	enabled
bool	visible
bool	exclusive
QQuickLabsPlatformMenuItem *	checkedItem
QQmlListProperty< QQuickLabsPlatformMenuItem >	items
	\qmlproperty list<MenuItem> Qt.labs.platform::MenuItemGroup::items
Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
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 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 qquicklabsplatformmenuitemgroup_p.h.

Constructor & Destructor Documentation

◆ QQuickLabsPlatformMenuItemGroup()

QT_BEGIN_NAMESPACE QQuickLabsPlatformMenuItemGroup::QQuickLabsPlatformMenuItemGroup ( QObject * parent = nullptr )

explicit

A group for managing native menu items.

\qmltype MenuItemGroup
\inherits QtObject

! \nativetype QQuickLabsPlatformMenuItemGroup \inqmlmodule Qt.labs.platform

Since: 5.8

The MenuItemGroup groups native menu items together.

MenuItemGroup is exclusive by default. In an exclusive menu item group, only one item can be checked at any time; checking another item automatically unchecks the previously checked one. MenuItemGroup can be configured as non-exclusive, which is particularly useful for showing, hiding, enabling and disabling items together as a group.

The most straight-forward way to use MenuItemGroup is to assign a list of items.

Menu {
    id: verticalMenu
    title: qsTr("Vertical")
 
    MenuItemGroup {
        id: verticalGroup
        items: verticalMenu.items
    }
 
    MenuItem { text: qsTr("Top"); checkable: true }
    MenuItem { text: qsTr("Center"); checked: true }
    MenuItem { text: qsTr("Bottom"); checkable: true }
}

The same menu may sometimes contain items that should not be included in the same exclusive group. Such cases are best handled using the \l {MenuItem::group}{group} property.

Menu {
    id: horizontalMenu
    title: qsTr("Horizontal")
 
    MenuItemGroup {
        id: horizontalGroup
    }
 
    MenuItem {
        checked: true
        text: qsTr("Left")
        group: horizontalGroup
    }
    MenuItem {
        checkable: true
        text: qsTr("Center")
        group: horizontalGroup
    }
    MenuItem {
        text: qsTr("Right")
        checkable: true
        group: horizontalGroup
    }
 
    MenuItem { separator: true }
    MenuItem { text: qsTr("Justify"); checkable: true }
    MenuItem { text: qsTr("Absolute"); checkable: true }
}

More advanced use cases can be handled using the addItem() and removeItem() methods.

\labs

See also: MenuItem

\qmlsignal Qt.labs.platform::MenuItemGroup::triggered(MenuItem item)

This signal is emitted when an item in the group is triggered by the user.

See also: MenuItem::triggered()

\qmlsignal Qt.labs.platform::MenuItemGroup::hovered(MenuItem item)

This signal is emitted when an item in the group is hovered by the user.

See also: MenuItem::hovered()

Definition at line 104 of file qquicklabsplatformmenuitemgroup.cpp.

References QObjectData::parent.

◆ ~QQuickLabsPlatformMenuItemGroup()

QQuickLabsPlatformMenuItemGroup::~QQuickLabsPlatformMenuItemGroup ( )

Definition at line 109 of file qquicklabsplatformmenuitemgroup.cpp.

Member Function Documentation

◆ addItem()

void QQuickLabsPlatformMenuItemGroup::addItem ( QQuickLabsPlatformMenuItem * item )

\qmlmethod void Qt.labs.platform::MenuItemGroup::addItem(MenuItem item)

Adds an item to the group.

Definition at line 237 of file qquicklabsplatformmenuitemgroup.cpp.

References QQuickLabsPlatformMenuItem::checkedChanged(), QQuickLabsPlatformMenuItem::hovered(), QQuickLabsPlatformMenuItem::isChecked(), setCheckedItem(), and QQuickLabsPlatformMenuItem::setGroup().

Here is the call graph for this function:

◆ checkedItem()

QQuickLabsPlatformMenuItem * QQuickLabsPlatformMenuItemGroup::checkedItem ( ) const

\qmlproperty MenuItem Qt.labs.platform::MenuItemGroup::checkedItem

This property holds the currently checked item in the group, or null if no item is checked.

Definition at line 202 of file qquicklabsplatformmenuitemgroup.cpp.

◆ checkedItemChanged

void QQuickLabsPlatformMenuItemGroup::checkedItemChanged ( )

signal

◆ clear()

void QQuickLabsPlatformMenuItemGroup::clear ( )

\qmlmethod void Qt.labs.platform::MenuItemGroup::clear()

Removes all items from the group.

Definition at line 283 of file qquicklabsplatformmenuitemgroup.cpp.

References setCheckedItem().

Here is the call graph for this function:

◆ enabledChanged

void QQuickLabsPlatformMenuItemGroup::enabledChanged ( )

signal

◆ exclusiveChanged

void QQuickLabsPlatformMenuItemGroup::exclusiveChanged ( )

signal

◆ hovered

void QQuickLabsPlatformMenuItemGroup::hovered ( QQuickLabsPlatformMenuItem * item )

signal

◆ isEnabled()

bool QQuickLabsPlatformMenuItemGroup::isEnabled ( ) const

\qmlproperty bool Qt.labs.platform::MenuItemGroup::enabled

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

The enabled state of the group affects the enabled state of each item in the group, except that explicitly disabled items are not enabled even if the group is enabled.

Definition at line 122 of file qquicklabsplatformmenuitemgroup.cpp.

Referenced by QQuickLabsPlatformMenuItem::isEnabled().

Here is the caller graph for this function:

◆ isExclusive()

bool QQuickLabsPlatformMenuItemGroup::isExclusive ( ) const

\qmlproperty bool Qt.labs.platform::MenuItemGroup::exclusive

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

In an exclusive menu item group, only one item can be checked at any time; checking another item automatically unchecks the previously checked one.

Definition at line 180 of file qquicklabsplatformmenuitemgroup.cpp.

Referenced by QQuickLabsPlatformMenuItem::sync().

Here is the caller graph for this function:

◆ isVisible()

bool QQuickLabsPlatformMenuItemGroup::isVisible ( ) const

\qmlproperty bool Qt.labs.platform::MenuItemGroup::visible

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

The visibility of the group affects the visibility of each item in the group, except that explicitly hidden items are not visible even if the group is visible.

Definition at line 151 of file qquicklabsplatformmenuitemgroup.cpp.

Referenced by QQuickLabsPlatformMenuItem::isVisible().

Here is the caller graph for this function: