#include <qquicklabsplatformmenubar_p.h>

Inheritance diagram for QQuickLabsPlatformMenuBar:

Collaboration diagram for QQuickLabsPlatformMenuBar:

Signals
void	menusChanged ()

void	windowChanged ()

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
	QQuickLabsPlatformMenuBar (QObject *parent=nullptr)
	A native menubar.

	~QQuickLabsPlatformMenuBar ()

QPlatformMenuBar *	handle () const

QQmlListProperty< QObject >	data ()

QQmlListProperty< QQuickLabsPlatformMenu >	menus ()

QWindow *	window () const
	\qmlproperty Window Qt.labs.platform::MenuBar::window

void	setWindow (QWindow *window)

Q_INVOKABLE void	addMenu (QQuickLabsPlatformMenu *menu)
	\qmlmethod void Qt.labs.platform::MenuBar::addMenu(Menu menu)

Q_INVOKABLE void	insertMenu (int index, QQuickLabsPlatformMenu *menu)
	\qmlmethod void Qt.labs.platform::MenuBar::insertMenu(int index, Menu menu)

Q_INVOKABLE void	removeMenu (QQuickLabsPlatformMenu *menu)
	\qmlmethod void Qt.labs.platform::MenuBar::removeMenu(Menu menu)

Q_INVOKABLE void	clear ()
	\qmlmethod void Qt.labs.platform::MenuBar::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	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 ()

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.

QWindow *	findWindow () const

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)

Static Protected Member Functions
static void	data_append (QQmlListProperty< QObject > property, QObject object)

static qsizetype	data_count (QQmlListProperty< QObject > *property)

static QObject *	data_at (QQmlListProperty< QObject > *property, qsizetype index)

static void	data_clear (QQmlListProperty< QObject > *property)

static void	menus_append (QQmlListProperty< QQuickLabsPlatformMenu > property, QQuickLabsPlatformMenu menu)

static qsizetype	menus_count (QQmlListProperty< QQuickLabsPlatformMenu > *property)

static QQuickLabsPlatformMenu *	menus_at (QQmlListProperty< QQuickLabsPlatformMenu > *property, qsizetype index)

static void	menus_clear (QQmlListProperty< QQuickLabsPlatformMenu > *property)

Properties
QQmlListProperty< QObject >	data
	\qmldefault \qmlproperty list<QtObject> Qt.labs.platform::MenuBar::data

QQmlListProperty< QQuickLabsPlatformMenu >	menus
	\qmlproperty list<Menu> Qt.labs.platform::MenuBar::menus

QWindow *	window

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 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 qquicklabsplatformmenubar_p.h.

Constructor & Destructor Documentation

◆ QQuickLabsPlatformMenuBar()

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

explicit

A native menubar.

\qmltype MenuBar
\inherits QtObject

! \nativetype QQuickLabsPlatformMenuBar \inqmlmodule Qt.labs.platform

Since: 5.8

The MenuBar type provides a QML API for native platform menubars.

A menubar consists of a list of drop-down menus.

MenuBar {
    id: menuBar
 
    Menu {
        id: fileMenu
        title: qsTr("File")
        // ...
    }
 
    Menu {
        id: editMenu
        title: qsTr("&Edit")
        // ...
    }
 
    Menu {
        id: viewMenu
        title: qsTr("&View")
        // ...
    }
 
    Menu {
        id: helpMenu
        title: qsTr("&Help")
        // ...
    }
}

MenuBar is currently available on the following platforms:

\list

macOS
Android
Linux (only available on desktop environments that provide a global D-Bus menu bar)
Windows \endlist

\labs

See also: Menu

Definition at line 74 of file qquicklabsplatformmenubar.cpp.

References QObjectData::parent.

◆ ~QQuickLabsPlatformMenuBar()

QQuickLabsPlatformMenuBar::~QQuickLabsPlatformMenuBar ( )

Definition at line 84 of file qquicklabsplatformmenubar.cpp.

Member Function Documentation

◆ addMenu()

void QQuickLabsPlatformMenuBar::addMenu ( QQuickLabsPlatformMenu * menu )

\qmlmethod void Qt.labs.platform::MenuBar::addMenu(Menu menu)

Adds a menu to end of the menubar.

Definition at line 153 of file qquicklabsplatformmenubar.cpp.

◆ classBegin()

void QQuickLabsPlatformMenuBar::classBegin ( )

overrideprotectedvirtual

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

Implements QQmlParserStatus.

Definition at line 217 of file qquicklabsplatformmenubar.cpp.

◆ clear()

void QQuickLabsPlatformMenuBar::clear ( )

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

Removes all menus from the menubar.

Definition at line 200 of file qquicklabsplatformmenubar.cpp.

◆ componentComplete()

void QQuickLabsPlatformMenuBar::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 221 of file qquicklabsplatformmenubar.cpp.

References findWindow(), and setWindow().

Here is the call graph for this function:

◆ data()

QQmlListProperty< QObject > QQuickLabsPlatformMenuBar::data ( )

◆ data_append()

void QQuickLabsPlatformMenuBar::data_append	(	QQmlListProperty< QObject > *	property,
		QObject *	object )

staticprotected

Definition at line 245 of file qquicklabsplatformmenubar.cpp.

◆ data_at()

QObject * QQuickLabsPlatformMenuBar::data_at	(	QQmlListProperty< QObject > *	property,
		qsizetype	index )

staticprotected

Definition at line 261 of file qquicklabsplatformmenubar.cpp.

◆ data_clear()

void QQuickLabsPlatformMenuBar::data_clear ( QQmlListProperty< QObject > * property )

staticprotected

Definition at line 267 of file qquicklabsplatformmenubar.cpp.

◆ data_count()

qsizetype QQuickLabsPlatformMenuBar::data_count ( QQmlListProperty< QObject > * property )

staticprotected

Definition at line 255 of file qquicklabsplatformmenubar.cpp.

◆ findWindow()

QWindow * QQuickLabsPlatformMenuBar::findWindow ( ) const

protected

Definition at line 230 of file qquicklabsplatformmenubar.cpp.

Referenced by componentComplete().

Here is the caller graph for this function:

◆ handle()

QPlatformMenuBar * QQuickLabsPlatformMenuBar::handle ( ) const

Definition at line 92 of file qquicklabsplatformmenubar.cpp.

Referenced by QQuickLabsPlatformMenu::create(), and QQuickLabsPlatformMenu::sync().

Here is the caller graph for this function:

◆ insertMenu()

void QQuickLabsPlatformMenuBar::insertMenu	(	int	index,
		QQuickLabsPlatformMenu *	menu )

\qmlmethod void Qt.labs.platform::MenuBar::insertMenu(int index, Menu menu)

Inserts a menu at the specified index in the menubar.

Definition at line 163 of file qquicklabsplatformmenubar.cpp.

References QQuickLabsPlatformMenu::create(), QQuickLabsPlatformMenu::handle(), QQuickLabsPlatformMenu::setMenuBar(), and QQuickLabsPlatformMenu::sync().

Here is the call graph for this function:

◆ menus()

QQmlListProperty< QQuickLabsPlatformMenu > QQuickLabsPlatformMenuBar::menus ( )

◆ menus_append()

void QQuickLabsPlatformMenuBar::menus_append	(	QQmlListProperty< QQuickLabsPlatformMenu > *	property,
		QQuickLabsPlatformMenu *	menu )

staticprotected

Definition at line 273 of file qquicklabsplatformmenubar.cpp.

◆ menus_at()

QQuickLabsPlatformMenu * QQuickLabsPlatformMenuBar::menus_at	(	QQmlListProperty< QQuickLabsPlatformMenu > *	property,
		qsizetype	index )

staticprotected

Definition at line 285 of file qquicklabsplatformmenubar.cpp.

◆ menus_clear()

void QQuickLabsPlatformMenuBar::menus_clear ( QQmlListProperty< QQuickLabsPlatformMenu > * property )

staticprotected

Definition at line 291 of file qquicklabsplatformmenubar.cpp.

◆ menus_count()

qsizetype QQuickLabsPlatformMenuBar::menus_count ( QQmlListProperty< QQuickLabsPlatformMenu > * property )

staticprotected

Definition at line 279 of file qquicklabsplatformmenubar.cpp.

◆ menusChanged

void QQuickLabsPlatformMenuBar::menusChanged ( )

signal

◆ removeMenu()

void QQuickLabsPlatformMenuBar::removeMenu ( QQuickLabsPlatformMenu * menu )

\qmlmethod void Qt.labs.platform::MenuBar::removeMenu(Menu menu)

Removes a menu from the menubar.

Definition at line 183 of file qquicklabsplatformmenubar.cpp.

References QQuickLabsPlatformMenu::handle(), and QQuickLabsPlatformMenu::setMenuBar().

Here is the call graph for this function:

◆ setWindow()

void QQuickLabsPlatformMenuBar::setWindow ( QWindow * window )

Definition at line 136 of file qquicklabsplatformmenubar.cpp.

Referenced by componentComplete().

Here is the caller graph for this function:

◆ window()

QWindow * QQuickLabsPlatformMenuBar::window ( ) const

\qmlproperty Window Qt.labs.platform::MenuBar::window

This property holds the menubar's window.

Unless explicitly set, the window is automatically resolved by iterating the QML parent objects until a \l Window or an \l Item that has a window is found.

Definition at line 131 of file qquicklabsplatformmenubar.cpp.

◆ windowChanged

void QQuickLabsPlatformMenuBar::windowChanged ( )

signal

Property Documentation

◆ data

QQmlListProperty< QObject > QQuickLabsPlatformMenuBar::data

read

\qmldefault \qmlproperty list<QtObject> Qt.labs.platform::MenuBar::data

This default property holds the list of all objects declared as children of the menubar. The data property includes objects that are not \l Menu instances, such as \l Timer and \l QtObject.

See also: menus

Definition at line 35 of file qquicklabsplatformmenubar_p.h.

◆ menus

QQmlListProperty< QQuickLabsPlatformMenu > QQuickLabsPlatformMenuBar::menus

read

\qmlproperty list<Menu> Qt.labs.platform::MenuBar::menus

This property holds the list of menus in the menubar.

Definition at line 36 of file qquicklabsplatformmenubar_p.h.

◆ window

QWindow * QQuickLabsPlatformMenuBar::window

readwrite

Definition at line 37 of file qquicklabsplatformmenubar_p.h.

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

qtdeclarative/src/labs/platform/qquicklabsplatformmenubar_p.h (03d58031c7233e0579f463b9484af8227b0938fd)
qtdeclarative/src/labs/platform/qquicklabsplatformmenubar.cpp (a464ff5bfa15201de64d05121dc192dbd4655890)

Signals

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickLabsPlatformMenuBar()

◆ ~QQuickLabsPlatformMenuBar()

Member Function Documentation

◆ addMenu()

◆ classBegin()

◆ clear()

◆ componentComplete()

◆ data()

◆ data_append()

◆ data_at()

◆ data_clear()

◆ data_count()

◆ findWindow()

◆ handle()

◆ insertMenu()

◆ menus()

◆ menus_append()

◆ menus_at()

◆ menus_clear()

◆ menus_count()

◆ menusChanged

◆ removeMenu()

◆ setWindow()

◆ window()

◆ windowChanged

Property Documentation

◆ data

◆ menus

◆ window