Windows native menu bar. More...

#include <qwindowsmenu.h>

Inheritance diagram for QWindowsMenuBar:

Collaboration diagram for QWindowsMenuBar:

Public Types
using	Menus = QList<QWindowsMenu *>

Public Member Functions
	QWindowsMenuBar ()
	~QWindowsMenuBar () override
void	insertMenu (QPlatformMenu menu, QPlatformMenu before) override
void	removeMenu (QPlatformMenu *menu) override
void	syncMenu (QPlatformMenu *) override
void	handleReparent (QWindow *newParentWindow) override
QPlatformMenu *	menuForTag (quintptr tag) const override
QPlatformMenu *	createMenu () const override
HMENU	menuBarHandle () const
const Menus &	menus () const
bool	notifyTriggered (uint id)
bool	notifyAboutToShow (HMENU hmenu)
void	notifyRemoved (QWindowsMenu *menu)
void	redraw () const
void	install (QWindowsWindow *window)
void	formatDebug (QDebug &d) const
Public Member Functions inherited from QPlatformMenuBar
virtual QWindow *	parentWindow () 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	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`.

Static Public Member Functions
static QWindowsMenuBar *	menuBarOf (const QWindow *notYetCreatedWindow)
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)

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
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.
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
Properties inherited from QObject
QString	objectName
	the name of this object
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

Windows native menu bar.

\list

\l{https://docs.microsoft.com/en-us/windows/win32/menurc/about-menus}, {About Menus} \endlist

Note: The destruction order of the QWindowsMenu/Item/Bar instances is arbitrary depending on whether the application is Qt Quick or Qt Widgets, either the containers or the items might be deleted first.

Definition at line 160 of file qwindowsmenu.h.

Member Typedef Documentation

◆ Menus

using QWindowsMenuBar::Menus = QList<QWindowsMenu *>

Definition at line 164 of file qwindowsmenu.h.

Constructor & Destructor Documentation

◆ QWindowsMenuBar()

QWindowsMenuBar::QWindowsMenuBar ( )

Definition at line 706 of file qwindowsmenu.cpp.

◆ ~QWindowsMenuBar()

QWindowsMenuBar::~QWindowsMenuBar ( )

override

Definition at line 711 of file qwindowsmenu.cpp.

Member Function Documentation

◆ createMenu()

QPlatformMenu * QWindowsMenuBar::createMenu ( ) const

overridevirtual

Reimplemented from QPlatformMenuBar.

Definition at line 786 of file qwindowsmenu.cpp.

◆ formatDebug()

void QWindowsMenuBar::formatDebug ( QDebug & d ) const

Definition at line 902 of file qwindowsmenu.cpp.

Referenced by operator<<().

Here is the caller graph for this function:

◆ handleReparent()

void QWindowsMenuBar::handleReparent ( QWindow * newParentWindow )

overridevirtual

Implements QPlatformMenuBar.

Definition at line 741 of file qwindowsmenu.cpp.

◆ insertMenu()

void QWindowsMenuBar::insertMenu	(	QPlatformMenu *	menu,
		QPlatformMenu *	before )

overridevirtual

Implements QPlatformMenuBar.

Definition at line 720 of file qwindowsmenu.cpp.

◆ install()

void QWindowsMenuBar::install ( QWindowsWindow * window )

Definition at line 761 of file qwindowsmenu.cpp.

References QWindowsWindow::setMenuBar().

Referenced by QWindowsIntegration::createPlatformWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ menuBarHandle()

HMENU QWindowsMenuBar::menuBarHandle ( ) const

inline

Definition at line 177 of file qwindowsmenu.h.

◆ menuBarOf()

QWindowsMenuBar * QWindowsMenuBar::menuBarOf ( const QWindow * notYetCreatedWindow )

static

Definition at line 754 of file qwindowsmenu.cpp.

References menuBarPropertyName.

Referenced by QWindowCreationContext::QWindowCreationContext().

Here is the caller graph for this function:

◆ menuForTag()

QPlatformMenu * QWindowsMenuBar::menuForTag ( quintptr tag ) const

overridevirtual

Implements QPlatformMenuBar.

Definition at line 781 of file qwindowsmenu.cpp.

◆ menus()

const Menus & QWindowsMenuBar::menus ( ) const

inline

Definition at line 178 of file qwindowsmenu.h.

◆ notifyAboutToShow()

bool QWindowsMenuBar::notifyAboutToShow ( HMENU hmenu )

Definition at line 803 of file qwindowsmenu.cpp.

◆ notifyRemoved()

void QWindowsMenuBar::notifyRemoved ( QWindowsMenu * menu )

inline

Definition at line 181 of file qwindowsmenu.h.

Referenced by QWindowsMenu::removeFromParent().

Here is the caller graph for this function:

◆ notifyTriggered()

bool QWindowsMenuBar::notifyTriggered ( uint id )

Definition at line 793 of file qwindowsmenu.cpp.

◆ redraw()

void QWindowsMenuBar::redraw ( ) const

Definition at line 821 of file qwindowsmenu.cpp.

Referenced by QWindowsMenu::setVisible().

Here is the caller graph for this function:

◆ removeMenu()

void QWindowsMenuBar::removeMenu ( QPlatformMenu * menu )

overridevirtual

Implements QPlatformMenuBar.

Definition at line 728 of file qwindowsmenu.cpp.

◆ syncMenu()

void QWindowsMenuBar::syncMenu ( QPlatformMenu * )

inlineoverridevirtual

Implements QPlatformMenuBar.

Definition at line 171 of file qwindowsmenu.h.

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

qtbase/src/plugins/platforms/windows/qwindowsmenu.h (0a281beaa76a04665930b1e1cd5349c26ae7f0d1)
qtbase/src/plugins/platforms/windows/qwindowsmenu.cpp (1cd7e01c909499b4c4c6d7dd250cc67bbb962141)

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Menus

Constructor & Destructor Documentation

◆ QWindowsMenuBar()

◆ ~QWindowsMenuBar()

Member Function Documentation

◆ createMenu()

◆ formatDebug()

◆ handleReparent()

◆ insertMenu()

◆ install()

◆ menuBarHandle()

◆ menuBarOf()

◆ menuForTag()

◆ menus()

◆ notifyAboutToShow()

◆ notifyRemoved()

◆ notifyTriggered()

◆ redraw()

◆ removeMenu()

◆ syncMenu()