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

#include <qcocoamenu.h>

Inheritance diagram for QCocoaMenu:
Collaboration diagram for QCocoaMenu:

Public Member Functions

 QCocoaMenu ()
 ~QCocoaMenu ()
void insertMenuItem (QPlatformMenuItem *menuItem, QPlatformMenuItem *before) override
void removeMenuItem (QPlatformMenuItem *menuItem) override
void syncMenuItem (QPlatformMenuItem *menuItem) override
void setEnabled (bool enabled) override
bool isEnabled () const override
void setVisible (bool visible) override
void showPopup (const QWindow *parentWindow, const QRect &targetRect, const QPlatformMenuItem *item) override
void dismiss () override
void syncSeparatorsCollapsible (bool enable) override
void propagateEnabledState (bool enabled)
void setIcon (const QIcon &) override
void setText (const QString &text) override
void setMinimumWidth (int width) override
void setFont (const QFont &font) override
NSMenu * nsMenu () const override
void setAsDockMenu () const override
bool isVisible () const
QPlatformMenuItemmenuItemAt (int position) const override
QPlatformMenuItemmenuItemForTag (quintptr tag) const override
QList< QCocoaMenuItem * > items () const
QList< QCocoaMenuItem * > merged () const
void setAttachedItem (NSMenuItem *item)
NSMenuItem * attachedItem () const
bool isOpen () const
void setIsOpen (bool isOpen)
bool isAboutToShow () const
void setIsAboutToShow (bool isAbout)
void timerEvent (QTimerEvent *e) override
 This event handler can be reimplemented in a subclass to receive timer events for the object.
void syncMenuItem_helper (QPlatformMenuItem *menuItem, bool menubarUpdate)
void setItemTargetAction (QCocoaMenuItem *item) const
Public Member Functions inherited from QPlatformMenu
 QPlatformMenu ()
virtual void setTag (quintptr tag)
virtual quintptr tag () const
virtual void setMenuType (MenuType type)
virtual QPlatformMenuItemcreateMenuItem () const
virtual QPlatformMenucreateSubMenu () 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 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.
Public Member Functions inherited from QCocoaMenuObject
void setMenuParent (QObject *o)
QObjectmenuParent () const

Additional Inherited Members

Public Types inherited from QPlatformMenu
enum  MenuType { DefaultMenu = 0 , EditMenu }
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 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 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 qcocoamenu.h.

Constructor & Destructor Documentation

◆ QCocoaMenu()

QT_BEGIN_NAMESPACE QCocoaMenu::QCocoaMenu ( )

Definition at line 27 of file qcocoamenu.mm.

◆ ~QCocoaMenu()

QCocoaMenu::~QCocoaMenu ( )

Definition at line 39 of file qcocoamenu.mm.

References dismiss(), and isOpen().

Here is the call graph for this function:

Member Function Documentation

◆ attachedItem()

NSMenuItem * QCocoaMenu::attachedItem ( ) const

Definition at line 515 of file qcocoamenu.mm.

◆ dismiss()

void QCocoaMenu::dismiss ( )
overridevirtual

Reimplemented from QPlatformMenu.

Definition at line 436 of file qcocoamenu.mm.

Referenced by ~QCocoaMenu().

Here is the caller graph for this function:

◆ insertMenuItem()

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

Implements QPlatformMenu.

Definition at line 93 of file qcocoamenu.mm.

◆ isAboutToShow()

bool QCocoaMenu::isAboutToShow ( ) const

Definition at line 169 of file qcocoamenu.mm.

◆ isEnabled()

bool QCocoaMenu::isEnabled ( ) const
overridevirtual

Reimplemented from QPlatformMenu.

Definition at line 323 of file qcocoamenu.mm.

◆ isOpen()

bool QCocoaMenu::isOpen ( ) const

Definition at line 159 of file qcocoamenu.mm.

Referenced by ~QCocoaMenu().

Here is the caller graph for this function:

◆ isVisible()

bool QCocoaMenu::isVisible ( ) const
inline

Definition at line 50 of file qcocoamenu.h.

Referenced by QCocoaMenuBar::syncMenu_helper().

Here is the caller graph for this function:

◆ items()

QList< QCocoaMenuItem * > QCocoaMenu::items ( ) const

Definition at line 459 of file qcocoamenu.mm.

◆ menuItemAt()

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

Implements QPlatformMenu.

Definition at line 441 of file qcocoamenu.mm.

◆ menuItemForTag()

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

Implements QPlatformMenu.

Definition at line 449 of file qcocoamenu.mm.

◆ merged()

QList< QCocoaMenuItem * > QCocoaMenu::merged ( ) const

Definition at line 464 of file qcocoamenu.mm.

◆ nsMenu()

NSMenu * QCocoaMenu::nsMenu ( ) const
override

Definition at line 82 of file qcocoamenu.mm.

◆ propagateEnabledState()

void QCocoaMenu::propagateEnabledState ( bool enabled)

Definition at line 480 of file qcocoamenu.mm.

Referenced by setEnabled().

Here is the caller graph for this function:

◆ removeMenuItem()

void QCocoaMenu::removeMenuItem ( QPlatformMenuItem * menuItem)
overridevirtual

Implements QPlatformMenu.

Definition at line 179 of file qcocoamenu.mm.

◆ setAsDockMenu()

void QCocoaMenu::setAsDockMenu ( ) const
override

Definition at line 87 of file qcocoamenu.mm.

◆ setAttachedItem()

void QCocoaMenu::setAttachedItem ( NSMenuItem * item)

Definition at line 496 of file qcocoamenu.mm.

◆ setEnabled()

void QCocoaMenu::setEnabled ( bool enabled)
overridevirtual

Implements QPlatformMenu.

Definition at line 313 of file qcocoamenu.mm.

References propagateEnabledState().

Here is the call graph for this function:

◆ setFont()

void QCocoaMenu::setFont ( const QFont & font)
overridevirtual

Reimplemented from QPlatformMenu.

Definition at line 73 of file qcocoamenu.mm.

◆ setIcon()

void QCocoaMenu::setIcon ( const QIcon & )
inlineoverridevirtual

Implements QPlatformMenu.

Definition at line 41 of file qcocoamenu.h.

◆ setIsAboutToShow()

void QCocoaMenu::setIsAboutToShow ( bool isAbout)

Definition at line 174 of file qcocoamenu.mm.

◆ setIsOpen()

void QCocoaMenu::setIsOpen ( bool isOpen)

Definition at line 164 of file qcocoamenu.mm.

◆ setItemTargetAction()

void QCocoaMenu::setItemTargetAction ( QCocoaMenuItem * item) const

◆ setMinimumWidth()

void QCocoaMenu::setMinimumWidth ( int width)
overridevirtual

Reimplemented from QPlatformMenu.

Definition at line 68 of file qcocoamenu.mm.

◆ setText()

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

Implements QPlatformMenu.

Definition at line 61 of file qcocoamenu.mm.

◆ setVisible()

void QCocoaMenu::setVisible ( bool visible)
overridevirtual

Implements QPlatformMenu.

Definition at line 328 of file qcocoamenu.mm.

◆ showPopup()

void QCocoaMenu::showPopup ( const QWindow * parentWindow,
const QRect & targetRect,
const QPlatformMenuItem * item )
overridevirtual

Reimplemented from QPlatformMenu.

Definition at line 333 of file qcocoamenu.mm.

◆ syncMenuItem()

void QCocoaMenu::syncMenuItem ( QPlatformMenuItem * menuItem)
overridevirtual

Implements QPlatformMenu.

Definition at line 228 of file qcocoamenu.mm.

◆ syncMenuItem_helper()

void QCocoaMenu::syncMenuItem_helper ( QPlatformMenuItem * menuItem,
bool menubarUpdate )

Definition at line 233 of file qcocoamenu.mm.

◆ syncSeparatorsCollapsible()

void QCocoaMenu::syncSeparatorsCollapsible ( bool enable)
overridevirtual

Implements QPlatformMenu.

Definition at line 277 of file qcocoamenu.mm.

◆ timerEvent()

void QCocoaMenu::timerEvent ( QTimerEvent * event)
overridevirtual

This event handler can be reimplemented in a subclass to receive timer events for the object.

QChronoTimer provides higher-level interfaces to the timer functionality, and also more general information about timers. The timer event is passed in the event parameter.

See also
startTimer(), killTimer(), event()

Reimplemented from QObject.

Definition at line 220 of file qcocoamenu.mm.


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