#include <qplatformmenu.h>

Inheritance diagram for QPlatformMenu:

Collaboration diagram for QPlatformMenu:

Public Types
enum	MenuType { DefaultMenu = 0 , EditMenu }

Signals
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.

Public Member Functions
	QPlatformMenu ()

virtual void	insertMenuItem (QPlatformMenuItem menuItem, QPlatformMenuItem before)=0

virtual void	removeMenuItem (QPlatformMenuItem *menuItem)=0

virtual void	syncMenuItem (QPlatformMenuItem *menuItem)=0

virtual void	syncSeparatorsCollapsible (bool enable)=0

virtual void	setTag (quintptr tag)

virtual quintptr	tag () const

virtual void	setText (const QString &text)=0

virtual void	setIcon (const QIcon &icon)=0

virtual void	setEnabled (bool enabled)=0

virtual bool	isEnabled () const

virtual void	setVisible (bool visible)=0

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 ()

virtual QPlatformMenuItem *	menuItemAt (int position) const =0

virtual QPlatformMenuItem *	menuItemForTag (quintptr tag) const =0

virtual QPlatformMenuItem *	createMenuItem () const

virtual QPlatformMenu *	createSubMenu () 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	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`.

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

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
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

Definition at line 71 of file qplatformmenu.h.

Member Enumeration Documentation

◆ MenuType

enum QPlatformMenu::MenuType

Enumerator
DefaultMenu
EditMenu

Definition at line 77 of file qplatformmenu.h.

Constructor & Destructor Documentation

◆ QPlatformMenu()

QPlatformMenu::QPlatformMenu ( )

Definition at line 27 of file qplatformmenu.cpp.

Member Function Documentation

◆ aboutToHide

void QPlatformMenu::aboutToHide ( )

signal

Referenced by QWidgetPlatformMenu::QWidgetPlatformMenu(), QQuickLabsPlatformMenu::create(), QIOSMenu::dismiss(), and QWindowsPopupMenu::trackPopupMenu().

Here is the caller graph for this function:

◆ aboutToShow

void QPlatformMenu::aboutToShow ( )

signal

Referenced by QWidgetPlatformMenu::QWidgetPlatformMenu(), QDBusMenuAdaptor::AboutToShow(), QQuickLabsPlatformMenu::create(), QIOSMenu::showPopup(), and QWindowsPopupMenu::trackPopupMenu().

Here is the caller graph for this function:

◆ createMenuItem()

QPlatformMenuItem * QPlatformMenu::createMenuItem ( ) const

virtual

Reimplemented in QDBusPlatformMenu, QWindowsMenu, QGtk3Menu, and QWidgetPlatformMenu.

Definition at line 43 of file qplatformmenu.cpp.

References QGuiApplicationPrivate::platformTheme().

Referenced by QQuickLabsPlatformMenuItem::create(), and QMenuPrivate::insertActionInPlatformMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createSubMenu()

QPlatformMenu * QPlatformMenu::createSubMenu ( ) const

virtual

Reimplemented in QDBusPlatformMenu, QWindowsMenu, QGtk3Menu, and QWidgetPlatformMenu.

Definition at line 48 of file qplatformmenu.cpp.

References QGuiApplicationPrivate::platformTheme().

Referenced by QMenuPrivate::copyActionToPlatformItem(), and QQuickLabsPlatformMenu::create().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dismiss()

virtual void QPlatformMenu::dismiss ( )

inlinevirtual

Reimplemented in QDBusPlatformMenu, QCocoaMenu, QIOSMenu, QWindowsPopupMenu, QGtk3Menu, and QWidgetPlatformMenu.

Definition at line 105 of file qplatformmenu.h.

Referenced by QMenuPrivate::_q_actionTriggered(), and QQuickLabsPlatformMenu::close().

Here is the caller graph for this function:

◆ insertMenuItem()

virtual void QPlatformMenu::insertMenuItem	(	QPlatformMenuItem *	menuItem,
		QPlatformMenuItem *	before )

pure virtual

Implemented in QGtk3Menu, QWidgetPlatformMenu, QDBusPlatformMenu, QAndroidPlatformMenu, QCocoaMenu, QIOSMenu, and QWindowsMenu.

Referenced by QQuickLabsPlatformMenu::create(), QMenuPrivate::insertActionInPlatformMenu(), and QQuickLabsPlatformMenu::insertItem().

Here is the caller graph for this function:

◆ isEnabled()

virtual bool QPlatformMenu::isEnabled ( ) const

inlinevirtual

Reimplemented in QDBusPlatformMenu, QAndroidPlatformMenu, QCocoaMenu, QWindowsMenu, and QWidgetPlatformMenu.

Definition at line 91 of file qplatformmenu.h.

◆ menuItemAt()

virtual QPlatformMenuItem * QPlatformMenu::menuItemAt ( int position ) const

pure virtual

Implemented in QDBusPlatformMenu, QAndroidPlatformMenu, QCocoaMenu, QIOSMenu, QWindowsMenu, QGtk3Menu, and QWidgetPlatformMenu.

◆ menuItemForTag()

virtual QPlatformMenuItem * QPlatformMenu::menuItemForTag ( quintptr tag ) const

pure virtual

Implemented in QDBusPlatformMenu, QAndroidPlatformMenu, QCocoaMenu, QIOSMenu, QWindowsMenu, QGtk3Menu, and QWidgetPlatformMenu.

Referenced by QMenuPrivate::_q_platformMenuAboutToShow().

Here is the caller graph for this function:

◆ removeMenuItem()

virtual void QPlatformMenu::removeMenuItem ( QPlatformMenuItem * menuItem )

pure virtual

Implemented in QGtk3Menu, QWidgetPlatformMenu, QDBusPlatformMenu, QAndroidPlatformMenu, QCocoaMenu, QIOSMenu, and QWindowsMenu.

Referenced by QQuickLabsPlatformMenu::clear(), and QQuickLabsPlatformMenu::removeItem().

Here is the caller graph for this function:

◆ setEnabled()

virtual void QPlatformMenu::setEnabled ( bool enabled )

pure virtual

Implemented in QDBusPlatformMenu, QAndroidPlatformMenu, QCocoaMenu, QIOSMenu, QWindowsMenu, QGtk3Menu, and QWidgetPlatformMenu.

Referenced by QQuickLabsPlatformMenu::sync(), and QMenuPrivate::syncPlatformMenu().

Here is the caller graph for this function:

◆ setFont()

virtual void QPlatformMenu::setFont ( const QFont & font )

inlinevirtual

Reimplemented in QDBusPlatformMenu, QCocoaMenu, and QWidgetPlatformMenu.

Definition at line 94 of file qplatformmenu.h.

References font, and Q_UNUSED.

Referenced by QQuickLabsPlatformMenu::sync().

Here is the caller graph for this function:

◆ setIcon()

virtual void QPlatformMenu::setIcon ( const QIcon & icon )

pure virtual

Implemented in QCocoaMenu, QIOSMenu, QDBusPlatformMenu, QAndroidPlatformMenu, QWindowsMenu, QGtk3Menu, and QWidgetPlatformMenu.

◆ setMenuType()

virtual void QPlatformMenu::setMenuType ( MenuType type )

inlinevirtual

Reimplemented in QDBusPlatformMenu, QIOSMenu, and QWidgetPlatformMenu.

Definition at line 95 of file qplatformmenu.h.

References Q_UNUSED.

Referenced by QQuickLabsPlatformMenu::sync().

Here is the caller graph for this function:

◆ setMinimumWidth()

virtual void QPlatformMenu::setMinimumWidth ( int width )

inlinevirtual

Reimplemented in QDBusPlatformMenu, QCocoaMenu, and QWidgetPlatformMenu.

Definition at line 93 of file qplatformmenu.h.

References Q_UNUSED.

Referenced by QQuickLabsPlatformMenu::sync().

Here is the caller graph for this function:

◆ setTag()

void QPlatformMenu::setTag ( quintptr tag )

virtual

Definition at line 32 of file qplatformmenu.cpp.

References tag().

Here is the call graph for this function:

◆ setText()

virtual void QPlatformMenu::setText ( const QString & text )

pure virtual

Implemented in QIOSMenu, QDBusPlatformMenu, QAndroidPlatformMenu, QCocoaMenu, QWindowsMenu, QGtk3Menu, and QWidgetPlatformMenu.

Referenced by QQuickLabsPlatformMenu::sync().

Here is the caller graph for this function:

◆ setVisible()

virtual void QPlatformMenu::setVisible ( bool visible )

pure virtual

Implemented in QDBusPlatformMenu, QAndroidPlatformMenu, QCocoaMenu, QIOSMenu, QWindowsMenu, QGtk3Menu, and QWidgetPlatformMenu.

Referenced by QQuickLabsPlatformMenu::sync().

Here is the caller graph for this function:

◆ showPopup()

virtual void QPlatformMenu::showPopup	(	const QWindow *	parentWindow,
		const QRect &	targetRect,
		const QPlatformMenuItem *	item )

inlinevirtual

Reimplemented in QDBusPlatformMenu, QAndroidPlatformMenu, QCocoaMenu, QIOSMenu, QWindowsPopupMenu, QGtk3Menu, and QWidgetPlatformMenu.

Definition at line 97 of file qplatformmenu.h.

References item, and Q_UNUSED.

Referenced by QQuickLabsPlatformMenu::open().

Here is the caller graph for this function:

◆ syncMenuItem()

virtual void QPlatformMenu::syncMenuItem ( QPlatformMenuItem * menuItem )

pure virtual

Implemented in QIOSMenu, QWindowsMenu, QGtk3Menu, QWidgetPlatformMenu, QDBusPlatformMenu, QAndroidPlatformMenu, and QCocoaMenu.

Referenced by QMenuPrivate::_q_platformMenuAboutToShow(), and QQuickLabsPlatformMenuItem::sync().

Here is the caller graph for this function:

◆ syncSeparatorsCollapsible()

virtual void QPlatformMenu::syncSeparatorsCollapsible ( bool enable )

pure virtual

Implemented in QDBusPlatformMenu, QAndroidPlatformMenu, QCocoaMenu, QGtk3Menu, QWidgetPlatformMenu, QIOSMenu, and QWindowsMenu.

Referenced by QMenuPrivate::syncPlatformMenu().

Here is the caller graph for this function:

◆ tag()

quintptr QPlatformMenu::tag ( ) const

virtual

Definition at line 37 of file qplatformmenu.cpp.

Referenced by QWindowsMenu::formatDebug(), QDBusPlatformMenu::menuItemForTag(), QAndroidPlatformMenu::menuItemForTag(), QCocoaMenu::menuItemForTag(), QIOSMenu::menuItemForTag(), QWindowsMenu::menuItemForTag(), QGtk3Menu::menuItemForTag(), QWidgetPlatformMenu::menuItemForTag(), and setTag().

Here is the caller graph for this function:

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

qtbase/src/gui/kernel/qplatformmenu.h (05fc3aef53348fb58be6308076e000825b704e58)
qtbase/src/gui/kernel/qplatformmenu.cpp (05fc3aef53348fb58be6308076e000825b704e58)

Public Types

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ MenuType

Constructor & Destructor Documentation

◆ QPlatformMenu()

Member Function Documentation

◆ aboutToHide

◆ aboutToShow

◆ createMenuItem()

◆ createSubMenu()

◆ dismiss()

◆ insertMenuItem()

◆ isEnabled()

◆ menuItemAt()

◆ menuItemForTag()

◆ removeMenuItem()

◆ setEnabled()

◆ setFont()

◆ setIcon()

◆ setMenuType()

◆ setMinimumWidth()

◆ setTag()

◆ setText()

◆ setVisible()

◆ showPopup()

◆ syncMenuItem()

◆ syncSeparatorsCollapsible()

◆ tag()