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
QWindowsMenuItem Class Reference

#include <qwindowsmenu.h>

+ Inheritance diagram for QWindowsMenuItem:
+ Collaboration diagram for QWindowsMenuItem:

Public Member Functions

 QWindowsMenuItem (QWindowsMenu *parentMenu=nullptr)
 
 ~QWindowsMenuItem () override
 
void setText (const QString &text) override
 
void setIcon (const QIcon &icon) override
 
void setMenu (QPlatformMenu *menu) override
 
void setVisible (bool isVisible) override
 
void setIsSeparator (bool isSeparator) override
 
void setFont (const QFont &) override
 
void setRole (MenuRole) override
 
void setCheckable (bool checkable) override
 
void setChecked (bool isChecked) override
 
void setShortcut (const QKeySequence &shortcut) override
 
void setEnabled (bool enabled) override
 
void setIconSize (int size) override
 
const QWindowsMenuparentMenu () const
 
QWindowsMenuparentMenu ()
 
HMENU parentMenuHandle () const
 
QWindowsMenusubMenu () const
 
UINT_PTR id () const
 
void setId (uint id)
 
UINT state () const
 
QString text () const
 
QString nativeText () const
 
bool isVisible () const
 
void insertIntoMenu (QWindowsMenu *menuItem, bool append, int index)
 
bool removeFromMenu ()
 
void formatDebug (QDebug &d) const
 
- Public Member Functions inherited from QPlatformMenuItem
 QPlatformMenuItem ()
 
virtual void setTag (quintptr tag)
 
virtual quintptr tag () const
 
virtual void setNativeContents (WId item)
 
virtual void setHasExclusiveGroup (bool hasExclusiveGroup)
 
- 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.
 

Additional Inherited Members

- Public Types inherited from QPlatformMenuItem
enum  MenuRole {
  NoRole = 0 , TextHeuristicRole , ApplicationSpecificRole , AboutQtRole ,
  AboutRole , PreferencesRole , QuitRole , CutRole ,
  CopyRole , PasteRole , SelectAllRole , RoleCount
}
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Signals inherited from QPlatformMenuItem
void activated ()
 
void hovered ()
 
- 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 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

Definition at line 21 of file qwindowsmenu.h.

Constructor & Destructor Documentation

◆ QWindowsMenuItem()

QWindowsMenuItem::QWindowsMenuItem ( QWindowsMenu * parentMenu = nullptr)
explicit

Definition at line 200 of file qwindowsmenu.cpp.

References parentMenu(), and qCDebug.

+ Here is the call graph for this function:

◆ ~QWindowsMenuItem()

QWindowsMenuItem::~QWindowsMenuItem ( )
override

Definition at line 208 of file qwindowsmenu.cpp.

References qCDebug, and removeFromMenu().

+ Here is the call graph for this function:

Member Function Documentation

◆ formatDebug()

void QWindowsMenuItem::formatDebug ( QDebug & d) const

Definition at line 843 of file qwindowsmenu.cpp.

References d, Qt::dec(), Qt::hex(), QKeySequence::isEmpty(), Qt::noshowbase(), Qt::showbase(), and QPlatformMenuItem::tag().

+ Here is the call graph for this function:

◆ id()

UINT_PTR QWindowsMenuItem::id ( ) const
inline

Definition at line 47 of file qwindowsmenu.h.

Referenced by setId().

+ Here is the caller graph for this function:

◆ insertIntoMenu()

void QWindowsMenuItem::insertIntoMenu ( QWindowsMenu * menuItem,
bool append,
int index )

Definition at line 417 of file qwindowsmenu.cpp.

References append(), menu, and nextId.

+ Here is the call graph for this function:

◆ isVisible()

bool QWindowsMenuItem::isVisible ( ) const
inline

Definition at line 52 of file qwindowsmenu.h.

Referenced by setVisible().

+ Here is the caller graph for this function:

◆ nativeText()

QString QWindowsMenuItem::nativeText ( ) const

Definition at line 405 of file qwindowsmenu.cpp.

References QKeySequence::isEmpty(), QKeySequence::NativeText, and QKeySequence::toString().

+ Here is the call graph for this function:

◆ parentMenu() [1/2]

QWindowsMenu * QWindowsMenuItem::parentMenu ( )
inline

Definition at line 44 of file qwindowsmenu.h.

◆ parentMenu() [2/2]

const QWindowsMenu * QWindowsMenuItem::parentMenu ( ) const
inline

Definition at line 43 of file qwindowsmenu.h.

Referenced by QWindowsMenuItem(), and removeFromMenu().

+ Here is the caller graph for this function:

◆ parentMenuHandle()

HMENU QWindowsMenuItem::parentMenuHandle ( ) const

Definition at line 386 of file qwindowsmenu.cpp.

References QWindowsMenu::menuHandle().

Referenced by setCheckable(), setChecked(), setEnabled(), setIsSeparator(), and setVisible().

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

◆ removeFromMenu()

bool QWindowsMenuItem::removeFromMenu ( )

Definition at line 445 of file qwindowsmenu.cpp.

References QWindowsMenu::menuHandle(), QWindowsMenu::notifyRemoved(), and parentMenu().

Referenced by QWindowsMenu::~QWindowsMenu(), and ~QWindowsMenuItem().

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

◆ setCheckable()

void QWindowsMenuItem::setCheckable ( bool checkable)
overridevirtual

Implements QPlatformMenuItem.

Definition at line 324 of file qwindowsmenu.cpp.

References menuItemSetState(), menuItemState(), parentMenuHandle(), qCDebug, and state().

+ Here is the call graph for this function:

◆ setChecked()

void QWindowsMenuItem::setChecked ( bool isChecked)
overridevirtual

Implements QPlatformMenuItem.

Definition at line 340 of file qwindowsmenu.cpp.

References menuItemSetChangeState(), parentMenuHandle(), and qCDebug.

+ Here is the call graph for this function:

◆ setEnabled()

void QWindowsMenuItem::setEnabled ( bool enabled)
overridevirtual

Implements QPlatformMenuItem.

Definition at line 367 of file qwindowsmenu.cpp.

References enabled, menuItemSetChangeState(), parentMenuHandle(), and qCDebug.

+ Here is the call graph for this function:

◆ setFont()

void QWindowsMenuItem::setFont ( const QFont & )
inlineoverridevirtual

Implements QPlatformMenuItem.

Definition at line 33 of file qwindowsmenu.h.

◆ setIcon()

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

Implements QPlatformMenuItem.

Definition at line 223 of file qwindowsmenu.cpp.

References QIcon::cacheKey(), icon, and qCDebug.

+ Here is the call graph for this function:

◆ setIconSize()

void QWindowsMenuItem::setIconSize ( int size)
overridevirtual

Implements QPlatformMenuItem.

Definition at line 377 of file qwindowsmenu.cpp.

◆ setId()

void QWindowsMenuItem::setId ( uint id)
inline

Definition at line 48 of file qwindowsmenu.h.

References id().

+ Here is the call graph for this function:

◆ setIsSeparator()

void QWindowsMenuItem::setIsSeparator ( bool isSeparator)
overridevirtual

Implements QPlatformMenuItem.

Definition at line 309 of file qwindowsmenu.cpp.

References isSeparator(), menuItemInfoInit(), parentMenuHandle(), and qCDebug.

+ Here is the call graph for this function:

◆ setMenu()

void QWindowsMenuItem::setMenu ( QPlatformMenu * menu)
overridevirtual

Implements QPlatformMenuItem.

Definition at line 266 of file qwindowsmenu.cpp.

References QWindowsMenu::id(), QWindowsMenu::menuHandle(), nextId, qCDebug, qStringToWChar(), and QWindowsMenu::setAsItemSubMenu().

+ Here is the call graph for this function:

◆ setRole()

void QWindowsMenuItem::setRole ( MenuRole )
inlineoverridevirtual

Implements QPlatformMenuItem.

Definition at line 34 of file qwindowsmenu.h.

◆ setShortcut()

void QWindowsMenuItem::setShortcut ( const QKeySequence & shortcut)
override

◆ setText()

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

Implements QPlatformMenuItem.

Definition at line 247 of file qwindowsmenu.cpp.

References qCDebug, and text().

+ Here is the call graph for this function:

◆ setVisible()

void QWindowsMenuItem::setVisible ( bool isVisible)
overridevirtual

Implements QPlatformMenuItem.

Definition at line 293 of file qwindowsmenu.cpp.

References QListSpecialMethodsBase< T >::indexOf(), isVisible(), QWindowsMenu::menuItems(), parentMenuHandle(), and qCDebug.

+ Here is the call graph for this function:

◆ state()

UINT QWindowsMenuItem::state ( ) const

Definition at line 391 of file qwindowsmenu.cpp.

References QGuiApplication::layoutDirection, and Qt::RightToLeft.

Referenced by setCheckable().

+ Here is the caller graph for this function:

◆ subMenu()

QWindowsMenu * QWindowsMenuItem::subMenu ( ) const
inline

Definition at line 46 of file qwindowsmenu.h.

◆ text()

QString QWindowsMenuItem::text ( ) const
inline

Definition at line 50 of file qwindowsmenu.h.

Referenced by setText().

+ Here is the caller graph for this function:

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