The QPlatformNativeInterface class provides an abstraction for retrieving native resource handles. More...

#include <qplatformnativeinterface.h>

Inheritance diagram for QPlatformNativeInterface:

Collaboration diagram for QPlatformNativeInterface:

Public Types
typedef void ()	NativeResourceForIntegrationFunction()

typedef void ()	NativeResourceForContextFunction(QOpenGLContext *context)

typedef void ()	NativeResourceForScreenFunction(QScreen *screen)

typedef void ()	NativeResourceForWindowFunction(QWindow *window)

typedef void ()	NativeResourceForBackingStoreFunction(QBackingStore *backingStore)

Signals
void	windowPropertyChanged (QPlatformWindow *window, const QString &propertyName)

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
virtual void *	nativeResourceForIntegration (const QByteArray &resource)

virtual void *	nativeResourceForContext (const QByteArray &resource, QOpenGLContext *context)

virtual void *	nativeResourceForScreen (const QByteArray &resource, QScreen *screen)

virtual void *	nativeResourceForWindow (const QByteArray &resource, QWindow *window)

virtual void *	nativeResourceForBackingStore (const QByteArray &resource, QBackingStore *backingStore)

virtual void *	nativeResourceForCursor (const QByteArray &resource, const QCursor &cursor)

virtual NativeResourceForIntegrationFunction	nativeResourceFunctionForIntegration (const QByteArray &resource)

virtual NativeResourceForContextFunction	nativeResourceFunctionForContext (const QByteArray &resource)

virtual NativeResourceForScreenFunction	nativeResourceFunctionForScreen (const QByteArray &resource)

virtual NativeResourceForWindowFunction	nativeResourceFunctionForWindow (const QByteArray &resource)

virtual NativeResourceForBackingStoreFunction	nativeResourceFunctionForBackingStore (const QByteArray &resource)

virtual QFunctionPointer	platformFunction (const QByteArray &function) const

virtual QVariantMap	windowProperties (QPlatformWindow *window) const
	Contains generic window properties that the platform may utilize.

virtual QVariant	windowProperty (QPlatformWindow *window, const QString &name) const
	Returns a window property with name.

virtual QVariant	windowProperty (QPlatformWindow *window, const QString &name, const QVariant &defaultValue) const
	Returns a window property with name.

virtual void	setWindowProperty (QPlatformWindow *window, const QString &name, const QVariant &value)
	Sets a window property with name to value.

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

The QPlatformNativeInterface class provides an abstraction for retrieving native resource handles.

Since: 5.0

\preliminary

Definition at line 30 of file qplatformnativeinterface.h.

Member Typedef Documentation

◆ NativeResourceForBackingStoreFunction

void *(*) QPlatformNativeInterface::NativeResourceForBackingStoreFunction(QBackingStore *backingStore)

Definition at line 48 of file qplatformnativeinterface.h.

◆ NativeResourceForContextFunction

void *(*) QPlatformNativeInterface::NativeResourceForContextFunction(QOpenGLContext *context)

Definition at line 45 of file qplatformnativeinterface.h.

◆ NativeResourceForIntegrationFunction

void *(*) QPlatformNativeInterface::NativeResourceForIntegrationFunction()

Definition at line 44 of file qplatformnativeinterface.h.

◆ NativeResourceForScreenFunction

void *(*) QPlatformNativeInterface::NativeResourceForScreenFunction(QScreen *screen)

Definition at line 46 of file qplatformnativeinterface.h.

◆ NativeResourceForWindowFunction

void *(*) QPlatformNativeInterface::NativeResourceForWindowFunction(QWindow *window)

Definition at line 47 of file qplatformnativeinterface.h.

Member Function Documentation

◆ nativeResourceForBackingStore()

void * QPlatformNativeInterface::nativeResourceForBackingStore	(	const QByteArray &	resource,
		QBackingStore *	backingStore )

virtual

Reimplemented in QWindowsDirect2DNativeInterface, QWindowsGdiNativeInterface, and QXcbNativeInterface.

Definition at line 49 of file qplatformnativeinterface.cpp.

◆ nativeResourceForContext()

void * QPlatformNativeInterface::nativeResourceForContext	(	const QByteArray &	resource,
		QOpenGLContext *	context )

virtual

Reimplemented in QAndroidPlatformNativeInterface, QEglFSIntegration, QQnxNativeInterface, QWindowsNativeInterface, and QXcbNativeInterface.

Definition at line 42 of file qplatformnativeinterface.cpp.

◆ nativeResourceForCursor()

void * QPlatformNativeInterface::nativeResourceForCursor	(	const QByteArray &	resource,
		const QCursor &	cursor )

virtual

Reimplemented in QWindowsNativeInterface, and QXcbNativeInterface.

Definition at line 57 of file qplatformnativeinterface.cpp.

◆ nativeResourceForIntegration()

void * QPlatformNativeInterface::nativeResourceForIntegration ( const QByteArray & resource )

virtual

Reimplemented in QAndroidPlatformNativeInterface, QEglFSIntegration, QOffscreenPlatformNativeInterface, QQnxNativeInterface, QtWaylandClient::QWaylandNativeInterface, QWindowsNativeInterface, and QXcbNativeInterface.

Definition at line 22 of file qplatformnativeinterface.cpp.

◆ nativeResourceForScreen()

void * QPlatformNativeInterface::nativeResourceForScreen	(	const QByteArray &	resource,
		QScreen *	screen )

virtual

Reimplemented in QEglFSIntegration, QOffscreenX11PlatformNativeInterface, QQnxNativeInterface, QtWaylandClient::QWaylandNativeInterface, QWindowsNativeInterface, and QXcbNativeInterface.

Definition at line 28 of file qplatformnativeinterface.cpp.

◆ nativeResourceForWindow()

void * QPlatformNativeInterface::nativeResourceForWindow	(	const QByteArray &	resource,
		QWindow *	window )

virtual

Reimplemented in QAndroidPlatformNativeInterface, QCocoaNativeInterface, QEglFSIntegration, QIOSIntegration, QQnxNativeInterface, QtWaylandClient::QWaylandNativeInterface, QVkKhrDisplayIntegration, QWindowsNativeInterface, and QXcbNativeInterface.

Definition at line 35 of file qplatformnativeinterface.cpp.

◆ nativeResourceFunctionForBackingStore()

QPlatformNativeInterface::NativeResourceForBackingStoreFunction QPlatformNativeInterface::nativeResourceFunctionForBackingStore ( const QByteArray & resource )

virtual

Reimplemented in QXcbNativeInterface.

Definition at line 89 of file qplatformnativeinterface.cpp.

◆ nativeResourceFunctionForContext()

QPlatformNativeInterface::NativeResourceForContextFunction QPlatformNativeInterface::nativeResourceFunctionForContext ( const QByteArray & resource )

virtual

Reimplemented in QEglFSIntegration, and QXcbNativeInterface.

Definition at line 71 of file qplatformnativeinterface.cpp.

◆ nativeResourceFunctionForIntegration()

QPlatformNativeInterface::NativeResourceForIntegrationFunction QPlatformNativeInterface::nativeResourceFunctionForIntegration ( const QByteArray & resource )

virtual

Reimplemented in QCocoaNativeInterface, QQnxNativeInterface, and QXcbNativeInterface.

Definition at line 65 of file qplatformnativeinterface.cpp.