Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QWindowsMenu Class Reference

#include <qwindowsmenu.h>

Inheritance diagram for QWindowsMenu:
Collaboration diagram for QWindowsMenu:

Public Types

using MenuItems = QList<QWindowsMenuItem *>
Public Types inherited from QPlatformMenu
enum  MenuType { DefaultMenu = 0 , EditMenu }

Public Member Functions

 QWindowsMenu ()
 ~QWindowsMenu ()
void insertMenuItem (QPlatformMenuItem *menuItem, QPlatformMenuItem *before) override
void removeMenuItem (QPlatformMenuItem *menuItem) override
void syncMenuItem (QPlatformMenuItem *) override
void syncSeparatorsCollapsible (bool) override
void setText (const QString &text) override
void setIcon (const QIcon &icon) override
void setEnabled (bool enabled) override
bool isEnabled () const override
void setVisible (bool visible) override
QPlatformMenuItemmenuItemAt (int position) const override
QPlatformMenuItemmenuItemForTag (quintptr tag) const override
QPlatformMenuItemcreateMenuItem () const override
QPlatformMenucreateSubMenu () const override
HMENU menuHandle () const
UINT_PTR id () const
QString text () const
const MenuItemsmenuItems () const
QWindowsMenuItemitemForSubMenu (const QWindowsMenu *subMenu) const
const QWindowsMenuBarparentMenuBar () const
HMENU parentMenuBarHandle () const
const QWindowsMenuparentMenu () const
void setAsItemSubMenu (QWindowsMenuItem *item)
void notifyRemoved (QWindowsMenuItem *item)
HMENU parentMenuHandle () const
HMENU parentHandle () const
bool isVisible () const
void insertIntoMenuBar (QWindowsMenuBar *bar, bool append, int index)
bool removeFromParent ()
void formatDebug (QDebug &d) const
Public Member Functions inherited from QPlatformMenu
 QPlatformMenu ()
virtual void setTag (quintptr tag)
virtual quintptr tag () const
virtual void setMinimumWidth (int width)
virtual void setFont (const QFont &font)
virtual void setMenuType (MenuType type)
virtual void showPopup (const QWindow *parentWindow, const QRect &targetRect, const QPlatformMenuItem *item)
virtual void dismiss ()
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 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).
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.

Protected Member Functions

 QWindowsMenu (QWindowsMenu *parentMenu, HMENU menu)
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)

Additional Inherited Members

Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
Signals inherited from QPlatformMenu
void aboutToShow ()
void aboutToHide ()
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.
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< QObjectDatad_ptr
Properties inherited from QObject
QString objectName
 the name of this object

Detailed Description

Definition at line 84 of file qwindowsmenu.h.

Member Typedef Documentation

◆ MenuItems

Definition at line 88 of file qwindowsmenu.h.

Constructor & Destructor Documentation

◆ QWindowsMenu() [1/2]

QWindowsMenu::QWindowsMenu ( )

Definition at line 460 of file qwindowsmenu.cpp.

◆ ~QWindowsMenu()

QWindowsMenu::~QWindowsMenu ( )

Definition at line 472 of file qwindowsmenu.cpp.

References removeFromParent().

Here is the call graph for this function:

◆ QWindowsMenu() [2/2]

QWindowsMenu::QWindowsMenu ( QWindowsMenu * parentMenu,
HMENU menu )
explicitprotected

Definition at line 464 of file qwindowsmenu.cpp.

References QWindowsMenu().

Referenced by QWindowsMenu().

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

Member Function Documentation

◆ createMenuItem()

QPlatformMenuItem * QWindowsMenu::createMenuItem ( ) const
overridevirtual

Reimplemented from QPlatformMenu.

Definition at line 606 of file qwindowsmenu.cpp.

◆ createSubMenu()

QPlatformMenu * QWindowsMenu::createSubMenu ( ) const
overridevirtual

Reimplemented from QPlatformMenu.

Definition at line 613 of file qwindowsmenu.cpp.

◆ formatDebug()

void QWindowsMenu::formatDebug ( QDebug & d) const

Definition at line 884 of file qwindowsmenu.cpp.

Referenced by operator<<().

Here is the caller graph for this function:

◆ id()

UINT_PTR QWindowsMenu::id ( ) const
inline

Definition at line 111 of file qwindowsmenu.h.

◆ insertIntoMenuBar()

void QWindowsMenu::insertIntoMenuBar ( QWindowsMenuBar * bar,
bool append,
int index )

Definition at line 539 of file qwindowsmenu.cpp.

Referenced by setVisible().

Here is the caller graph for this function:

◆ insertMenuItem()

void QWindowsMenu::insertMenuItem ( QPlatformMenuItem * menuItem,
QPlatformMenuItem * before )
overridevirtual

Implements QPlatformMenu.

Definition at line 482 of file qwindowsmenu.cpp.

◆ isEnabled()

bool QWindowsMenu::isEnabled ( ) const
inlineoverridevirtual

Reimplemented from QPlatformMenu.

Definition at line 101 of file qwindowsmenu.h.

◆ isVisible()

bool QWindowsMenu::isVisible ( ) const
inline

Definition at line 123 of file qwindowsmenu.h.

◆ itemForSubMenu()

QWindowsMenuItem * QWindowsMenu::itemForSubMenu ( const QWindowsMenu * subMenu) const

Definition at line 532 of file qwindowsmenu.cpp.

Referenced by removeFromParent().

Here is the caller graph for this function:

◆ menuHandle()

HMENU QWindowsMenu::menuHandle ( ) const
inline

Definition at line 110 of file qwindowsmenu.h.

◆ menuItemAt()

QPlatformMenuItem * QWindowsMenu::menuItemAt ( int position) const
overridevirtual

Implements QPlatformMenu.

Definition at line 594 of file qwindowsmenu.cpp.

◆ menuItemForTag()

QPlatformMenuItem * QWindowsMenu::menuItemForTag ( quintptr tag) const
overridevirtual

Implements QPlatformMenu.

Definition at line 601 of file qwindowsmenu.cpp.

◆ menuItems()

const MenuItems & QWindowsMenu::menuItems ( ) const
inline

Definition at line 113 of file qwindowsmenu.h.

◆ notifyRemoved()

void QWindowsMenu::notifyRemoved ( QWindowsMenuItem * item)
inline

Definition at line 120 of file qwindowsmenu.h.

Referenced by QWindowsMenuItem::removeFromMenu().

Here is the caller graph for this function:

◆ parentHandle()

HMENU QWindowsMenu::parentHandle ( ) const

Definition at line 635 of file qwindowsmenu.cpp.

◆ parentMenu()

const QWindowsMenu * QWindowsMenu::parentMenu ( ) const
inline

Definition at line 118 of file qwindowsmenu.h.

◆ parentMenuBar()

const QWindowsMenuBar * QWindowsMenu::parentMenuBar ( ) const
inline

Definition at line 116 of file qwindowsmenu.h.

◆ parentMenuBarHandle()

HMENU QWindowsMenu::parentMenuBarHandle ( ) const

Definition at line 630 of file qwindowsmenu.cpp.

◆ parentMenuHandle()

HMENU QWindowsMenu::parentMenuHandle ( ) const

Definition at line 625 of file qwindowsmenu.cpp.

◆ removeFromParent()

bool QWindowsMenu::removeFromParent ( )

Definition at line 556 of file qwindowsmenu.cpp.

References itemForSubMenu(), and QWindowsMenuBar::notifyRemoved().

Referenced by ~QWindowsMenu().

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

◆ removeMenuItem()

void QWindowsMenu::removeMenuItem ( QPlatformMenuItem * menuItem)
overridevirtual

Implements QPlatformMenu.

Definition at line 491 of file qwindowsmenu.cpp.

References QWindowsMenuItem::removeFromMenu().

Here is the call graph for this function:

◆ setAsItemSubMenu()

void QWindowsMenu::setAsItemSubMenu ( QWindowsMenuItem * item)

Definition at line 620 of file qwindowsmenu.cpp.

References QWindowsMenuItem::parentMenu().

Referenced by QWindowsMenuItem::setMenu().

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

◆ setEnabled()

void QWindowsMenu::setEnabled ( bool enabled)
overridevirtual

Implements QPlatformMenu.

Definition at line 520 of file qwindowsmenu.cpp.

◆ setIcon()

void QWindowsMenu::setIcon ( const QIcon & icon)
overridevirtual

Implements QPlatformMenu.

Definition at line 514 of file qwindowsmenu.cpp.

◆ setText()

void QWindowsMenu::setText ( const QString & text)
overridevirtual

Implements QPlatformMenu.

Definition at line 497 of file qwindowsmenu.cpp.

◆ setVisible()

void QWindowsMenu::setVisible ( bool visible)
overridevirtual

Implements QPlatformMenu.

Definition at line 573 of file qwindowsmenu.cpp.

References insertIntoMenuBar(), and QWindowsMenuBar::redraw().

Here is the call graph for this function:

◆ syncMenuItem()

void QWindowsMenu::syncMenuItem ( QPlatformMenuItem * )
inlineoverridevirtual

Implements QPlatformMenu.

Definition at line 95 of file qwindowsmenu.h.

◆ syncSeparatorsCollapsible()

void QWindowsMenu::syncSeparatorsCollapsible ( bool )
inlineoverridevirtual

Implements QPlatformMenu.

Definition at line 96 of file qwindowsmenu.h.

◆ text()

QString QWindowsMenu::text ( ) const
inline

Definition at line 112 of file qwindowsmenu.h.


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