Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QWindowsMenuBar Class Reference

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
 
QPlatformMenumenuForTag (quintptr tag) const override
 
QPlatformMenucreateMenu () const override
 
HMENU menuBarHandle () const
 
const Menusmenus () 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 QWindowparentWindow () 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< QStringbindableObjectName ()
 
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).
 
QThreadthread () 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 >
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 >
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () 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 QWindowsMenuBarmenuBarOf (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
QObjectsender () 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< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

Windows native menu bar.

\list

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 158 of file qwindowsmenu.h.

Member Typedef Documentation

◆ Menus

Definition at line 162 of file qwindowsmenu.h.

Constructor & Destructor Documentation

◆ QWindowsMenuBar()

QWindowsMenuBar::QWindowsMenuBar ( )

Definition at line 704 of file qwindowsmenu.cpp.

References qCDebug.

◆ ~QWindowsMenuBar()

QWindowsMenuBar::~QWindowsMenuBar ( )
override

Definition at line 709 of file qwindowsmenu.cpp.

References QList< T >::at(), qCDebug, QWindowsMenu::removeFromParent(), and QList< T >::size().

+ Here is the call graph for this function:

Member Function Documentation

◆ createMenu()

QPlatformMenu * QWindowsMenuBar::createMenu ( ) const
overridevirtual

Reimplemented from QPlatformMenuBar.

Definition at line 784 of file qwindowsmenu.cpp.

References qCDebug.

◆ formatDebug()

void QWindowsMenuBar::formatDebug ( QDebug & d) const

Definition at line 900 of file qwindowsmenu.cpp.

References d, and formatTextSequence().

+ Here is the call graph for this function:

◆ handleReparent()

void QWindowsMenuBar::handleReparent ( QWindow * newParentWindow)
overridevirtual

Implements QPlatformMenuBar.

Definition at line 739 of file qwindowsmenu.cpp.

References install(), menuBarPropertyName, and qCDebug.

+ Here is the call graph for this function:

◆ insertMenu()

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

Implements QPlatformMenuBar.

Definition at line 718 of file qwindowsmenu.cpp.

References insertBefore(), menu, qCDebug, and QList< T >::size().

+ Here is the call graph for this function:

◆ install()

void QWindowsMenuBar::install ( QWindowsWindow * window)

Definition at line 759 of file qwindowsmenu.cpp.

References QWindowsContext::forceNcCalcSize(), and window().

Referenced by handleReparent().

+ 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 175 of file qwindowsmenu.h.

Referenced by QWindowsMenu::insertIntoMenuBar(), QWindowsMenu::parentHandle(), and QWindowsMenu::parentMenuBarHandle().

+ Here is the caller graph for this function:

◆ menuBarOf()

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

Definition at line 752 of file qwindowsmenu.cpp.

References QVariant::canConvert(), and menuBarPropertyName.

Referenced by QWindowCreationContext::QWindowCreationContext(), and QWindowsIntegration::createPlatformWindow().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ menuForTag()

QPlatformMenu * QWindowsMenuBar::menuForTag ( quintptr tag) const
overridevirtual

Implements QPlatformMenuBar.

Definition at line 779 of file qwindowsmenu.cpp.

References tag, and traverseMenus().

+ Here is the call graph for this function:

◆ menus()

const Menus & QWindowsMenuBar::menus ( ) const
inline

Definition at line 176 of file qwindowsmenu.h.

Referenced by QWindowsMenu::insertIntoMenuBar(), and QWindowsMenu::setVisible().

+ Here is the caller graph for this function:

◆ notifyAboutToShow()

bool QWindowsMenuBar::notifyAboutToShow ( HMENU hmenu)

Definition at line 801 of file qwindowsmenu.cpp.

References QMenu::aboutToShow(), emit, findMenuByHandle(), and menu.

+ Here is the call graph for this function:

◆ notifyRemoved()

void QWindowsMenuBar::notifyRemoved ( QWindowsMenu * menu)
inline

Definition at line 179 of file qwindowsmenu.h.

References menu, and QList< T >::removeOne().

Referenced by QWindowsMenu::removeFromParent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ notifyTriggered()

bool QWindowsMenuBar::notifyTriggered ( uint id)

Definition at line 791 of file qwindowsmenu.cpp.

References emit, findMenuItemById(), and qCDebug.

+ Here is the call graph for this function:

◆ redraw()

void QWindowsMenuBar::redraw ( ) const

Definition at line 819 of file qwindowsmenu.cpp.

References window().

Referenced by QWindowsMenu::setVisible().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ removeMenu()

void QWindowsMenuBar::removeMenu ( QPlatformMenu * menu)
overridevirtual

Implements QPlatformMenuBar.

Definition at line 726 of file qwindowsmenu.cpp.

References indexOf(), menu, and qCDebug.

+ Here is the call graph for this function:

◆ syncMenu()

void QWindowsMenuBar::syncMenu ( QPlatformMenu * )
inlineoverridevirtual

Implements QPlatformMenuBar.

Definition at line 169 of file qwindowsmenu.h.


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