The QPlatformWindow class provides an abstraction for top-level windows. More...

#include <qplatformwindow.h>

Inheritance diagram for QPlatformWindow:

Collaboration diagram for QPlatformWindow:

Public Member Functions
	QPlatformWindow (QWindow *window)
	Constructs a platform window with the given top level window.
	~QPlatformWindow () override
	Virtual destructor does not delete its top level window.
virtual void	initialize ()
	Called as part of QWindow::create(), after constructing the window.
QWindow *	window () const
	Returns the window which belongs to the QPlatformWindow.
QPlatformWindow *	parent () const
	Returns the parent platform window (or \nullptr if orphan).
QPlatformScreen *	screen () const override
	Returns the platform screen handle corresponding to this platform window, or null if the window is not associated with a screen.
virtual QSurfaceFormat	format () const override
	Returns the actual surface format of the window.
virtual void	setGeometry (const QRect &rect)
	This function is called by Qt whenever a window is moved or resized using the QWindow API.
virtual QRect	geometry () const
	Returns the current geometry of a window.
virtual QRect	normalGeometry () const
	Returns the geometry of a window in 'normal' state (neither maximized, fullscreen nor minimized) for saving geometries to application settings.
virtual QMargins	frameMargins () const
virtual QMargins	safeAreaMargins () const
	The safe area margins of a window represent the area that is safe to place content within, without intersecting areas of the screen where system UI is placed, or where a screen bezel may cover the content.
virtual void	setVisible (bool visible)
	Reimplemented in subclasses to show the surface if visible is `true`, and hide it if visible is `false`.
virtual void	setWindowFlags (Qt::WindowFlags flags)
	Requests setting the window flags of this surface to flags.
virtual void	setWindowState (Qt::WindowStates state)
	Requests setting the window state of this surface to type.
virtual WId	winId () const
	Reimplement in subclasses to return a handle to the native window.
virtual void	setParent (const QPlatformWindow *window)
	This function is called to enable native child window in QPA.
virtual void	setWindowTitle (const QString &title)
	Reimplement to set the window title to title.
virtual QString	windowTitle () const
	Reimplement to return the actual window title used in the underlying windowing system unless the title set for the QWindow which belongs to this QPlatformWindow (i.e.
virtual void	setWindowFilePath (const QString &title)
	Reimplement to set the window file path to filePath.
virtual void	setWindowIcon (const QIcon &icon)
	Reimplement to set the window icon to icon.
virtual bool	close ()
	Reimplement to let the platform handle non-spontaneous window close.
virtual void	raise ()
	Reimplement to be able to let Qt raise windows to the top of the desktop.
virtual void	lower ()
	Reimplement to be able to let Qt lower windows to the bottom of the desktop.
virtual bool	isExposed () const
	Returns if this window is exposed in the windowing system.
virtual bool	isActive () const
	Returns `true` if the window should appear active from a style perspective.
virtual bool	isAncestorOf (const QPlatformWindow *child) const
	Returns `true` if the window is an ancestor of the given child.
virtual bool	isEmbedded () const
	Returns `true` if the window is a child of a non-Qt window.
virtual bool	isForeignWindow () const
virtual QPoint	mapToGlobal (const QPoint &pos) const
	Translates the window coordinate pos to global screen coordinates using native methods.
QPointF	mapToGlobalF (const QPointF &pos) const
virtual QPoint	mapFromGlobal (const QPoint &pos) const
	Translates the global screen coordinate pos to window coordinates using native methods.
QPointF	mapFromGlobalF (const QPointF &pos) const
virtual void	propagateSizeHints ()
	Reimplement to propagate the size hints of the QWindow.
virtual void	setOpacity (qreal level)
	Reimplement to be able to let Qt set the opacity level of a window.
virtual void	setMask (const QRegion &region)
	Reimplement to be able to let Qt set the mask of a window.
virtual void	requestActivateWindow ()
	Reimplement to let Qt be able to request activation/focus for a window.
virtual void	handleContentOrientationChange (Qt::ScreenOrientation orientation)
	Handle changes to the orientation of the platform window's contents.
virtual qreal	devicePixelRatio () const
	Reimplement this function in subclass to return the device pixel ratio for the window.
virtual bool	setKeyboardGrabEnabled (bool grab)
virtual bool	setMouseGrabEnabled (bool grab)
virtual bool	setWindowModified (bool modified)
	Reimplement to be able to let Qt indicate that the window has been modified.
virtual bool	windowEvent (QEvent *event)
	Reimplement this method to be able to do any platform specific event handling.
virtual bool	startSystemResize (Qt::Edges edges)
	Reimplement this method to start a system resize operation if the system supports it and return true to indicate success.
virtual bool	startSystemMove ()
	Reimplement this method to start a system move operation if the system supports it and return true to indicate success.
virtual void	setFrameStrutEventsEnabled (bool enabled)
	Reimplement this method to set whether frame strut events should be sent to enabled.
virtual bool	frameStrutEventsEnabled () const
	Reimplement this method to return whether frame strut events are enabled.
virtual void	setAlertState (bool enabled)
	Reimplement this method to set whether the window demands attention (for example, by flashing the taskbar icon) depending on enabled.
virtual bool	isAlertState () const
	Reimplement this method return whether the window is in an alert state.
virtual void	invalidateSurface ()
	Invalidates the window's surface by releasing its surface buffers.
virtual void	requestUpdate ()
	Requests an QEvent::UpdateRequest event.
bool	hasPendingUpdateRequest () const
	Returns true if the window has a pending update request.
virtual void	deliverUpdateRequest ()
	Delivers an QEvent::UpdateRequest event to the window.
virtual bool	allowsIndependentThreadedRendering () const
	Returns whether applications can render new frames from any thread without co-ordination with the main thread.
QSize	windowMinimumSize () const
	Returns the QWindow minimum size.
QSize	windowMaximumSize () const
	Returns the QWindow maximum size.
QSize	windowBaseSize () const
	Returns the QWindow base size.
QSize	windowSizeIncrement () const
	Returns the QWindow size increment.
QRect	windowGeometry () const
	Returns the QWindow geometry.
QRect	windowFrameGeometry () const
	Returns the QWindow frame geometry.
QRectF	windowClosestAcceptableGeometry (const QRectF &nativeRect) const
Public Member Functions inherited from QPlatformSurface
virtual	~QPlatformSurface ()
QSurface *	surface () const

Static Public Member Functions
static QRect	initialGeometry (const QWindow w, const QRect &initialGeometry, int defaultWidth, int defaultHeight, const QScreen *resultingScreenReturn=nullptr)
	Helper function to get initial geometry on windowing systems which do not do smart positioning and also do not provide a means of centering a transient window w.r.t.
static QRectF	closestAcceptableGeometry (const QWindow *w, const QRectF &nativeRect)
	Returns the closest acceptable geometry for a given geometry before a resize/move event for platforms that support it, for example to implement heightForWidth().

Protected Member Functions
QPlatformScreen *	screenForGeometry (const QRect &newGeometry) const
	Helper function for finding the new screen for newGeometry in response to a geometry changed event.

Static Protected Member Functions
static QString	formatWindowTitle (const QString &title, const QString &separator)
	Call this method to put together a window title composed of title separator the application display name.
static QSize	constrainWindowSize (const QSize &size)
	Returns a size with both dimensions bounded to [0, QWINDOWSIZE_MAX].

Protected Attributes
QScopedPointer< QPlatformWindowPrivate >	d_ptr

Detailed Description

The QPlatformWindow class provides an abstraction for top-level windows.

Since: 4.8

\preliminary

The QPlatformWindow abstraction is used by QWindow for all its top level windows. It is being created by calling the createPlatformWindow function in the loaded QPlatformIntegration instance.

QPlatformWindow is used to signal to the windowing system, how Qt perceives its frame. However, it is not concerned with how Qt renders into the window it represents.

Visible QWindows will always have a QPlatformWindow. However, it is not necessary for all windows to have a QBackingStore. This is the case for QOpenGLWindow. And could be the case for windows where some third party renders into it.

The platform specific window handle can be retrieved by the winId function.

QPlatformWindow is also the way QPA defines how native child windows should be supported through the setParent function.

\list 1

Mouse grab: Qt expects windows to automatically grab the mouse if the user presses a button until the button is released. Automatic grab should be released if some window is explicitly grabbed.
Enter/Leave events: If there is a window explicitly grabbing mouse events ({setMouseGrabEnabled()}), enter and leave events should only be sent to the grabbing window when mouse cursor passes over the grabbing window boundary. Other windows will not receive enter or leave events while the grab is active. While an automatic mouse grab caused by a mouse button press is active, no window will receive enter or leave events. When the last mouse button is released, the autograbbing window will receive leave event if mouse cursor is no longer within the window boundary. When any grab starts, the window under cursor will receive a leave event unless it is the grabbing window. When any grab ends, the window under cursor will receive an enter event unless it was the grabbing window.
Window positioning: When calling {QWindow::setFramePosition()}, the flag {QWindowPrivate::positionPolicy} is set to {QWindowPrivate::WindowFrameInclusive}. This means the position includes the window frame, whose size is at this point unknown and the geometry's topleft point is the position of the window frame. \endlist

Apart from the auto-tests ({tests/auto/gui/kernel/qwindow}, {tests/auto/gui/kernel/qguiapplication} and {tests/auto/widgets/kernel/qwidget}), there are a number of manual tests and examples that can help testing a platform plugin:

\list 1

{examples/qpa/windows}: Basic {QWindow} creation.
{examples/opengl/hellowindow}: Basic Open GL windows.
{tests/manual/windowflags}: Tests setting the window flags.
{tests/manual/windowgeometry} Tests setting the window geometry.
{tests/manual/windowmodality} Tests setting the window modality.
{tests/manual/widgetgrab} Tests mouse grab and dialogs. \endlist

See also: QBackingStore, QWindow

Definition at line 36 of file qplatformwindow.h.

Constructor & Destructor Documentation

◆ QPlatformWindow()

QT_BEGIN_NAMESPACE QPlatformWindow::QPlatformWindow ( QWindow * window )

explicit

Constructs a platform window with the given top level window.

Definition at line 22 of file qplatformwindow.cpp.

◆ ~QPlatformWindow()

QPlatformWindow::~QPlatformWindow ( )

override

Virtual destructor does not delete its top level window.

Definition at line 33 of file qplatformwindow.cpp.

Member Function Documentation

◆ allowsIndependentThreadedRendering()

bool QPlatformWindow::allowsIndependentThreadedRendering ( ) const

virtual

Returns whether applications can render new frames from any thread without co-ordination with the main thread.

Platform windows may set this to true during resize events for more control over submitted frames.

This function may be called from any thread.

Reimplemented in QCocoaWindow, and QtWaylandClient::QWaylandWindow.

Definition at line 802 of file qplatformwindow.cpp.

◆ close()

bool QPlatformWindow::close ( )

virtual

Reimplement to let the platform handle non-spontaneous window close.

When reimplementing make sure to call the base class implementation or QWindowSystemInterface::handleCloseEvent(), which will prompt the user to accept the window close (if needed) and then close the QWindow.

Definition at line 346 of file qplatformwindow.cpp.

◆ closestAcceptableGeometry()

QRectF QPlatformWindow::closestAcceptableGeometry	(	const QWindow *	w,
		const QRectF &	nativeRect )

static

Returns the closest acceptable geometry for a given geometry before a resize/move event for platforms that support it, for example to implement heightForWidth().

Definition at line 897 of file qplatformwindow.cpp.

◆ constrainWindowSize()

QSize QPlatformWindow::constrainWindowSize ( const QSize & size )

staticprotected

Returns a size with both dimensions bounded to [0, QWINDOWSIZE_MAX].

Definition at line 597 of file qplatformwindow.cpp.

◆ deliverUpdateRequest()

void QPlatformWindow::deliverUpdateRequest ( )

virtual

Delivers an QEvent::UpdateRequest event to the window.

QPlatformWindow subclasses can re-implement this function to provide e.g. logging or tracing of the delivery, but should always call the base class function.

Reimplemented in QCocoaWindow, and QtWaylandClient::QWaylandWindow.

Definition at line 814 of file qplatformwindow.cpp.

◆ devicePixelRatio()

qreal QPlatformWindow::devicePixelRatio ( ) const

virtual

Reimplement this function in subclass to return the device pixel ratio for the window.

This is the ratio between physical pixels and device-independent pixels.

See also: QPlatformWindow::devicePixelRatio();

Reimplemented in QCocoaWindow, QIOSWindow, QtWaylandClient::QWaylandWindow, and QWasmWindow.

Definition at line 427 of file qplatformwindow.cpp.

◆ format()

QSurfaceFormat QPlatformWindow::format ( ) const

overridevirtual

Returns the actual surface format of the window.

Implements QPlatformSurface.

Reimplemented in QAndroidPlatformOpenGLWindow, QAndroidPlatformVulkanWindow, QCocoaWindow, QDirectFbWindowEGL, QDirectFbWindowEGL, QEglFSWindow, QIOSWindow, QOffscreenWindow, QQnxEglWindow, QtWaylandClient::QWaylandBrcmEglWindow, QtWaylandClient::QWaylandWindow, QWasmWindow, QWindowsWindow, and QXcbWindow.

Definition at line 77 of file qplatformwindow.cpp.

◆ formatWindowTitle()

QString QPlatformWindow::formatWindowTitle	(	const QString &	title,
		const QString &	separator )

staticprotected

Call this method to put together a window title composed of title separator the application display name.

If the display name isn't set, and the title is empty, the raw app name is used.

Definition at line 545 of file qplatformwindow.cpp.

◆ frameMargins()

QMargins QPlatformWindow::frameMargins ( ) const

virtual

Reimplemented in QCocoaWindow, QHaikuWindow, QOffscreenWindow, QtWaylandClient::QWaylandWindow, QWasmWindow, QWindowsBaseWindow, QWindowsDesktopWindow, QWindowsWindow, and QXcbWindow.

Definition at line 127 of file qplatformwindow.cpp.

◆ frameStrutEventsEnabled()

bool QPlatformWindow::frameStrutEventsEnabled ( ) const

virtual

Reimplement this method to return whether frame strut events are enabled.

Reimplemented in QCocoaWindow, and QWindowsWindow.

Definition at line 532 of file qplatformwindow.cpp.

◆ geometry()

QRect QPlatformWindow::geometry ( ) const

virtual

Returns the current geometry of a window.

Reimplemented in QCocoaWindow, QEglFSWindow, QWindowsBaseWindow, and QWindowsWindow.

Definition at line 109 of file qplatformwindow.cpp.

◆ handleContentOrientationChange()

void QPlatformWindow::handleContentOrientationChange ( Qt::ScreenOrientation orientation )

virtual

Handle changes to the orientation of the platform window's contents.

This is a hint to the window manager in case it needs to display additional content like popups, dialogs, status bars, or similar in relation to the window.

See also: QWindow::reportContentOrientationChange()

Reimplemented in QtWaylandClient::QWaylandWindow.

Definition at line 415 of file qplatformwindow.cpp.

◆ hasPendingUpdateRequest()

bool QPlatformWindow::hasPendingUpdateRequest ( ) const

Returns true if the window has a pending update request.

See also: requestUpdate(), deliverUpdateRequest()

Definition at line 788 of file qplatformwindow.cpp.

◆ initialGeometry()

QRect QPlatformWindow::initialGeometry	(	const QWindow *	w,
		const QRect &	initialGeometry,
		int	defaultWidth,
		int	defaultHeight,
		const QScreen **	resultingScreenReturn = nullptr )

static

Helper function to get initial geometry on windowing systems which do not do smart positioning and also do not provide a means of centering a transient window w.r.t.

its parent. For example this is useful on Windows and MacOS but not X11, because an X11 window manager typically tries to layout new windows to optimize usage of the available desktop space. However if the given window already has geometry which the application has initialized, it takes priority.

initialGeometry has to be provided in native pixels. defaultWidth has to be provided in device independent pixels defaultHeight has to be provided in device independent pixels

Definition at line 696 of file qplatformwindow.cpp.

◆ initialize()

void QPlatformWindow::initialize ( )

virtual

Called as part of QWindow::create(), after constructing the window.

Platforms should prefer to do initialization here instead of in the constructor, as the platform window object will be fully constructed, and associated to the corresponding QWindow, allowing synchronous event delivery.

Reimplemented in QAndroidPlatformForeignWindow, QAndroidPlatformWindow, QCocoaWindow, QWasmWindow, and QWindowsWindow.

Definition at line 44 of file qplatformwindow.cpp.

◆ invalidateSurface()

void QPlatformWindow::invalidateSurface ( )

virtual

Invalidates the window's surface by releasing its surface buffers.

Many platforms do not support releasing the surface memory, and the default implementation does nothing.

The platform window is expected to recreate the surface again if it is needed. For instance, if an OpenGL context is made current on this window.

Reimplemented in QEglFSKmsEglDeviceWindow, QEglFSKmsEglDeviceWindow, QEglFSKmsGbmWindow, QEglFSKmsVsp2Window, QEglFSKmsVsp2Window, QEglFSWindow, QtWaylandClient::QWaylandEglWindow, QtWaylandClient::QWaylandVulkanWindow, and QWindowsWindow.

Definition at line 665 of file qplatformwindow.cpp.

◆ isActive()

bool QPlatformWindow::isActive ( ) const

virtual

Returns true if the window should appear active from a style perspective.

This function can make platform-specific isActive checks, such as checking if the QWindow is embedded in an active native window.

Reimplemented in QHaikuWindow, QtWaylandClient::QWaylandWindow, and QWindowsWindow.

Definition at line 182 of file qplatformwindow.cpp.

◆ isAlertState()

bool QPlatformWindow::isAlertState ( ) const

virtual

Reimplement this method return whether the window is in an alert state.

See also: setAlertState()

Since: 5.1

Reimplemented in QCocoaWindow, QtWaylandClient::QWaylandWindow, QWindowsWindow, and QXcbWindow.

Definition at line 623 of file qplatformwindow.cpp.

◆ isAncestorOf()

bool QPlatformWindow::isAncestorOf ( const QPlatformWindow * child ) const

virtual

Returns true if the window is an ancestor of the given child.

Platform overrides should iterate the native window hierarchy of the child, to ensure that ancestary is reflected even with native windows in the window hierarchy.

Reimplemented in QWindowsWindow.

Definition at line 194 of file qplatformwindow.cpp.

◆ isEmbedded()

bool QPlatformWindow::isEmbedded ( ) const

virtual

Returns true if the window is a child of a non-Qt window.

A embedded window has no parent platform window as reflected though parent(), but will have a native parent window.

Reimplemented in QCocoaWindow, QWindowsWindow, and QXcbWindow.

Definition at line 210 of file qplatformwindow.cpp.

◆ isExposed()

bool QPlatformWindow::isExposed ( ) const

virtual

Returns if this window is exposed in the windowing system.

An exposeEvent() is sent every time this value changes.

Reimplemented in QAndroidPlatformWindow, QCocoaWindow, QHaikuWindow, QIOSWindow, QQnxWindow, QtWaylandClient::QWaylandWindow, QWindowsWindow, and QXcbWindow.

Definition at line 171 of file qplatformwindow.cpp.

◆ isForeignWindow()

virtual bool QPlatformWindow::isForeignWindow ( ) const

inlinevirtual

Reimplemented in QAndroidPlatformForeignWindow, QCocoaWindow, QIOSWindow, QQnxForeignWindow, QWindowsForeignWindow, and QXcbForeignWindow.

Definition at line 80 of file qplatformwindow.h.

◆ lower()

void QPlatformWindow::lower ( )

virtual

Reimplement to be able to let Qt lower windows to the bottom of the desktop.

Reimplemented in QAndroidPlatformWindow, QCocoaWindow, QDirectFbWindow, QEglFSWindow, QFbWindow, QIOSWindow, QQnxWindow, QtWaylandClient::QWaylandWindow, QWasmWindow, QWindowsForeignWindow, QWindowsWindow, and QXcbWindow.

Definition at line 359 of file qplatformwindow.cpp.

◆ mapFromGlobal()

QPoint QPlatformWindow::mapFromGlobal ( const QPoint & pos ) const

virtual

Translates the global screen coordinate pos to window coordinates using native methods.

This is required for embedded windows, where the topmost QWindow coordinates are not global screen coordinates.

Returns pos if there is no platform specific implementation.

Reimplemented in QWindowsBaseWindow, QWindowsWindow, and QXcbWindow.

Definition at line 254 of file qplatformwindow.cpp.

◆ mapFromGlobalF()

QPointF QPlatformWindow::mapFromGlobalF ( const QPointF & pos ) const

Definition at line 240 of file qplatformwindow.cpp.

◆ mapToGlobal()

QPoint QPlatformWindow::mapToGlobal ( const QPoint & pos ) const

virtual

Translates the window coordinate pos to global screen coordinates using native methods.

This is required for embedded windows, where the topmost QWindow coordinates are not global screen coordinates.

Returns pos if there is no platform specific implementation.

Reimplemented in QWindowsBaseWindow, QWindowsWindow, and QXcbWindow.

Definition at line 222 of file qplatformwindow.cpp.

◆ mapToGlobalF()

QPointF QPlatformWindow::mapToGlobalF ( const QPointF & pos ) const

Definition at line 233 of file qplatformwindow.cpp.

◆ normalGeometry()

QRect QPlatformWindow::normalGeometry ( ) const

virtual

Returns the geometry of a window in 'normal' state (neither maximized, fullscreen nor minimized) for saving geometries to application settings.

Since: 5.3

Reimplemented in QCocoaWindow, QWasmWindow, and QWindowsWindow.

Definition at line 122 of file qplatformwindow.cpp.

◆ parent()

QPlatformWindow * QPlatformWindow::parent ( ) const

Returns the parent platform window (or \nullptr if orphan).

Definition at line 59 of file qplatformwindow.cpp.

◆ propagateSizeHints()

void QPlatformWindow::propagateSizeHints ( )

virtual

Reimplement to propagate the size hints of the QWindow.

The size hints include QWindow::minimumSize(), QWindow::maximumSize(), QWindow::sizeIncrement(), and QWindow::baseSize().

Reimplemented in QAndroidPlatformWindow, QCocoaWindow, QEglFSWindow, QFbWindow, QHaikuWindow, QIOSWindow, QQnxWindow, QtWaylandClient::QWaylandWindow, QWasmWindow, QWindowsWindow, and QXcbWindow.

Definition at line 367 of file qplatformwindow.cpp.

◆ raise()

void QPlatformWindow::raise ( )

virtual

Reimplement to be able to let Qt raise windows to the top of the desktop.

Reimplemented in QAndroidPlatformWindow, QCocoaWindow, QDirectFbWindow, QEglFSWindow, QFbWindow, QIOSWindow, QQnxWindow, QtWaylandClient::QWaylandWindow, QWasmWindow, QWindowsForeignWindow, QWindowsWindow, and QXcbWindow.

Definition at line 354 of file qplatformwindow.cpp.

◆ requestActivateWindow()

void QPlatformWindow::requestActivateWindow ( )

virtual

Reimplement to let Qt be able to request activation/focus for a window.

Some window systems will probably not have callbacks for this functionality, and then calling QWindowSystemInterface::handleFocusWindowChanged(QWindow *w) would be sufficient.

If the window system has some event handling/callbacks then call QWindowSystemInterface::handleFocusWindowChanged(QWindow *w) when the window system gives the notification.

Default implementation calls QWindowSystem::handleFocusWindowChanged(QWindow *w)

Reimplemented in QAndroidPlatformWindow, QCocoaWindow, QEglFSWindow, QHaikuWindow, QIOSWindow, QOffscreenWindow, QQnxWindow, QtWaylandClient::QWaylandWindow, QWasmWindow, QWindowsWindow, and QXcbWindow.

Definition at line 401 of file qplatformwindow.cpp.

◆ requestUpdate()

void QPlatformWindow::requestUpdate ( )

virtual

Requests an QEvent::UpdateRequest event.

The event will be delivered to the QWindow.

QPlatformWindow subclasses can re-implement this function to provide display refresh synchronized updates. The event should be delivered using QPlatformWindow::deliverUpdateRequest() to not get out of sync with the internal state of QWindow.

The default implementation posts an UpdateRequest event to the window after an interval that is at most 5 ms. If the window's associated screen reports a \l{QPlatformScreen::refreshRate()}{refresh rate} higher than 60 Hz, the interval is scaled down to a valid smaller than 5. The additional time is there to give the event loop a bit of idle time to gather system events.

Reimplemented in QCocoaWindow, QIOSWindow, QtWaylandClient::QWaylandWindow, QWasmWindow, and QWindowsWindow.

Definition at line 761 of file qplatformwindow.cpp.

◆ safeAreaMargins()

QMargins QPlatformWindow::safeAreaMargins ( ) const

virtual

The safe area margins of a window represent the area that is safe to place content within, without intersecting areas of the screen where system UI is placed, or where a screen bezel may cover the content.

Reimplemented in QAndroidPlatformWindow, QCocoaWindow, QIOSWindow, and QWindowsWindow.

Definition at line 137 of file qplatformwindow.cpp.

◆ screen()

QPlatformScreen * QPlatformWindow::screen ( ) const

overridevirtual

Returns the platform screen handle corresponding to this platform window, or null if the window is not associated with a screen.

Implements QPlatformSurface.

Reimplemented in QQnxWindow.

Definition at line 68 of file qplatformwindow.cpp.

◆ screenForGeometry()

QPlatformScreen * QPlatformWindow::screenForGeometry ( const QRect & newGeometry ) const

protected

Helper function for finding the new screen for newGeometry in response to a geometry changed event.

Returns the new screen if the window was moved to another virtual sibling. If the screen changes, the platform plugin should call QWindowSystemInterface::handleWindowScreenChanged().

Note: : The current screen will always be returned for child windows since they should never signal screen changes.

Since: 5.4

See also: QWindowSystemInterface::handleWindowScreenChanged()

Definition at line 571 of file qplatformwindow.cpp.

◆ setAlertState()

void QPlatformWindow::setAlertState ( bool enable )

virtual

Reimplement this method to set whether the window demands attention (for example, by flashing the taskbar icon) depending on enabled.

See also: isAlertState()

Since: 5.1

Reimplemented in QCocoaWindow, QtWaylandClient::QWaylandWindow, QWindowsWindow, and QXcbWindow.

Definition at line 610 of file qplatformwindow.cpp.

◆ setFrameStrutEventsEnabled()

void QPlatformWindow::setFrameStrutEventsEnabled ( bool enabled )

virtual

Reimplement this method to set whether frame strut events should be sent to enabled.

See also: frameStrutEventsEnabled

Reimplemented in QCocoaWindow, and QWindowsWindow.

Definition at line 522 of file qplatformwindow.cpp.

◆ setGeometry()

void QPlatformWindow::setGeometry ( const QRect & rect )

virtual

This function is called by Qt whenever a window is moved or resized using the QWindow API.

Unless you also override QPlatformWindow::geometry(), you need to call the baseclass implementation of this function in any override of QPlatformWindow::setGeometry(), as QWindow::geometry() is expected to report back the set geometry until a confirmation (or rejection) of the new geometry comes back from the window manager and is reported via QWindowSystemInterface::handleGeometryChange().

Window move/resizes can also be triggered spontaneously by the window manager, or as a response to an earlier requested move/resize via the Qt APIs. There is no need to call this function from the window manager callback, instead call QWindowSystemInterface::handleGeometryChange().

The position(x, y) part of the rect might be inclusive or exclusive of the window frame as returned by frameMargins(). You can detect this in the plugin by checking qt_window_private(window())->positionPolicy.

Reimplemented in QAndroidPlatformOpenGLWindow, QAndroidPlatformVulkanWindow, QAndroidPlatformWindow, QCocoaWindow, QDirectFbWindow, QEglFSWindow, QFbWindow, QHaikuWindow, QIOSWindow, QMinimalEglWindow, QOffscreenWindow, QQnxEglWindow, QQnxWindow, QtWaylandClient::QWaylandBrcmEglWindow, QtWaylandClient::QWaylandWindow, QVkKhrDisplayWindow, QVkKhrDisplayWindow, QWasmWindow, QWindowsForeignWindow, QWindowsWindow, and QXcbWindow.

Definition at line 100 of file qplatformwindow.cpp.

◆ setKeyboardGrabEnabled()

bool QPlatformWindow::setKeyboardGrabEnabled ( bool grab )

virtual

Reimplemented in QAndroidPlatformWindow, QCocoaWindow, QDirectFbWindow, QEglFSWindow, QFbWindow, QIOSWindow, QtWaylandClient::QWaylandWindow, QWasmWindow, QWindowsWindow, and QXcbWindow.

Definition at line 432 of file qplatformwindow.cpp.

◆ setMask()

void QPlatformWindow::setMask ( const QRegion & region )

virtual

Reimplement to be able to let Qt set the mask of a window.

Reimplemented in QCocoaWindow, QEglFSWindow, QIOSWindow, QtWaylandClient::QWaylandWindow, QWasmWindow, QWindowsWindow, and QXcbWindow.

Definition at line 382 of file qplatformwindow.cpp.

◆ setMouseGrabEnabled()

bool QPlatformWindow::setMouseGrabEnabled ( bool grab )

virtual

Reimplemented in QAndroidPlatformWindow, QCocoaWindow, QDirectFbWindow, QEglFSWindow, QFbWindow, QIOSWindow, QtWaylandClient::QWaylandWindow, QWasmWindow, QWindowsWindow, and QXcbWindow.

Definition at line 439 of file qplatformwindow.cpp.

◆ setOpacity()

void QPlatformWindow::setOpacity ( qreal level )

virtual

Reimplement to be able to let Qt set the opacity level of a window.

Reimplemented in QCocoaWindow, QDirectFbWindow, QEglFSWindow, QIOSWindow, QQnxWindow, QWasmWindow, QWindowsWindow, and QXcbWindow.

Definition at line 372 of file qplatformwindow.cpp.

◆ setParent()

void QPlatformWindow::setParent ( const QPlatformWindow * parent )

virtual

This function is called to enable native child window in QPA.

It is common not to support this feature in Window systems, but can be faked. When this function is called all geometry of this platform window will be relative to the parent.

Reimplemented in QAndroidPlatformWindow, QCocoaWindow, QIOSWindow, QQnxRasterWindow, QQnxWindow, QtWaylandClient::QWaylandWindow, QWasmWindow, QWindowsForeignWindow, QWindowsWindow, and QXcbWindow.

Definition at line 294 of file qplatformwindow.cpp.

◆ setVisible()

void QPlatformWindow::setVisible ( bool visible )

virtual

Reimplemented in subclasses to show the surface if visible is true, and hide it if visible is false.

The default implementation sends a synchronous expose event.

Reimplemented in QAndroidPlatformForeignWindow, QAndroidPlatformWindow, QCocoaWindow, QDirectFbWindow, QEglFSWindow, QFbWindow, QHaikuWindow, QIOSWindow, QOffscreenWindow, QQnxWindow, QtWaylandClient::QWaylandWindow, QWasmWindow, QWindowsForeignWindow, QWindowsWindow, and QXcbWindow.

Definition at line 148 of file qplatformwindow.cpp.

◆ setWindowFilePath()

void QPlatformWindow::setWindowFilePath ( const QString & title )

virtual

Reimplement to set the window file path to filePath.

Reimplemented in QCocoaWindow.

Definition at line 332 of file qplatformwindow.cpp.

◆ setWindowFlags()

void QPlatformWindow::setWindowFlags ( Qt::WindowFlags flags )

virtual

Requests setting the window flags of this surface to flags.

Reimplemented in QAndroidPlatformWindow, QCocoaWindow, QDirectFbWindow, QFbWindow, QHaikuWindow, QtWaylandClient::QWaylandWindow, QWasmWindow, QWindowsDirect2DWindow, QWindowsWindow, and QXcbWindow.

Definition at line 160 of file qplatformwindow.cpp.

◆ setWindowIcon()

void QPlatformWindow::setWindowIcon ( const QIcon & icon )

virtual

Reimplement to set the window icon to icon.

Reimplemented in QCocoaWindow, QtWaylandClient::QWaylandWindow, QWasmWindow, QWindowsWindow, and QXcbWindow.

Definition at line 337 of file qplatformwindow.cpp.

◆ setWindowModified()

bool QPlatformWindow::setWindowModified ( bool modified )

virtual

Reimplement to be able to let Qt indicate that the window has been modified.

Return true if the native window supports setting the modified flag, false otherwise.

Reimplemented in QCocoaWindow.

Definition at line 451 of file qplatformwindow.cpp.

◆ setWindowState()

void QPlatformWindow::setWindowState ( Qt::WindowStates state )

virtual

Requests setting the window state of this surface to type.

Qt::WindowActive can be ignored.

Reimplemented in QAndroidPlatformWindow, QCocoaWindow, QFbWindow, QHaikuWindow, QIOSWindow, QOffscreenWindow, QQnxWindow, QtWaylandClient::QWaylandWindow, QWasmWindow, QWindowsWindow, and QXcbWindow.

Definition at line 271 of file qplatformwindow.cpp.

◆ setWindowTitle()

void QPlatformWindow::setWindowTitle ( const QString & title )

virtual

Reimplement to set the window title to title.

The implementation might want to append the application display name to the window title, like Windows and Linux do.

\l QPlatformWindow::windowTitle() can be used to retrieve the actual window title.

See also: QGuiApplication::applicationDisplayName(); QPlatformWindow::windowTitle()

Reimplemented in QCocoaWindow, QHaikuWindow, QQnxWindow, QtWaylandClient::QWaylandWindow, QWasmWindow, QWindowsForeignWindow, QWindowsWindow, and QXcbWindow.

Definition at line 312 of file qplatformwindow.cpp.

◆ startSystemMove()

bool QPlatformWindow::startSystemMove ( )

virtual

Reimplement this method to start a system move operation if the system supports it and return true to indicate success.

The default implementation is empty and does nothing.

Since: 5.15

Reimplemented in QCocoaWindow, QtWaylandClient::QWaylandWindow, QWindowsWindow, and QXcbWindow.

Definition at line 510 of file qplatformwindow.cpp.

◆ startSystemResize()

bool QPlatformWindow::startSystemResize ( Qt::Edges edges )

virtual

Reimplement this method to start a system resize operation if the system supports it and return true to indicate success.

The default implementation is empty and does nothing with edges.

Since: 5.15

Reimplemented in QtWaylandClient::QWaylandWindow, QWindowsWindow, and QXcbWindow.

Definition at line 495 of file qplatformwindow.cpp.

◆ window()

QWindow * QPlatformWindow::window ( ) const

Returns the window which belongs to the QPlatformWindow.

Definition at line 51 of file qplatformwindow.cpp.

◆ windowBaseSize()

QSize QPlatformWindow::windowBaseSize ( ) const

Returns the QWindow base size.

Definition at line 853 of file qplatformwindow.cpp.

◆ windowClosestAcceptableGeometry()

QRectF QPlatformWindow::windowClosestAcceptableGeometry ( const QRectF & nativeRect ) const

Definition at line 905 of file qplatformwindow.cpp.

◆ windowEvent()

bool QPlatformWindow::windowEvent ( QEvent * event )

virtual

Reimplement this method to be able to do any platform specific event handling.

All non-synthetic events for window() are passed to this function before being sent to QWindow::event().

Return true if the event should not be passed on to the QWindow.

Subclasses should always call the base class implementation.

Reimplemented in QCocoaWindow, QtWaylandClient::QWaylandWindow, QWasmWindow, QWindowsBaseWindow, QWindowsWindow, and QXcbWindow.

Definition at line 466 of file qplatformwindow.cpp.

◆ windowFrameGeometry()

QRect QPlatformWindow::windowFrameGeometry ( ) const

Returns the QWindow frame geometry.

Definition at line 886 of file qplatformwindow.cpp.

◆ windowGeometry()

QRect QPlatformWindow::windowGeometry ( ) const

Returns the QWindow geometry.

Definition at line 878 of file qplatformwindow.cpp.

◆ windowMaximumSize()

QSize QPlatformWindow::windowMaximumSize ( ) const

Returns the QWindow maximum size.

Definition at line 845 of file qplatformwindow.cpp.

◆ windowMinimumSize()

QSize QPlatformWindow::windowMinimumSize ( ) const

Returns the QWindow minimum size.

Definition at line 837 of file qplatformwindow.cpp.

◆ windowSizeIncrement()

QSize QPlatformWindow::windowSizeIncrement ( ) const

Returns the QWindow size increment.

Definition at line 861 of file qplatformwindow.cpp.

◆ windowTitle()

QString QPlatformWindow::windowTitle ( ) const

virtual

Reimplement to return the actual window title used in the underlying windowing system unless the title set for the QWindow which belongs to this QPlatformWindow (i.e.

the window returned by \l QPlatformWindow::window) is always used without modification.

See also: QPlatformWindow::setWindowTitle()

Since: 6.9

Reimplemented in QtWaylandClient::QWaylandWindow, QWindowsWindow, and QXcbWindow.

Definition at line 324 of file qplatformwindow.cpp.

◆ winId()

WId QPlatformWindow::winId ( ) const

virtual

Reimplement in subclasses to return a handle to the native window.

Reimplemented in QAndroidPlatformForeignWindow, QAndroidPlatformWindow, QCocoaWindow, QDirectFbWindow, QEglFSWindow, QFbWindow, QHaikuWindow, QIOSWindow, QMinimalEglWindow, QOffscreenWindow, QQnxWindow, QtWaylandClient::QWaylandWindow, QWasmWindow, QWindowsBaseWindow, and QXcbWindow.

Definition at line 278 of file qplatformwindow.cpp.

Member Data Documentation

◆ d_ptr

QScopedPointer<QPlatformWindowPrivate> QPlatformWindow::d_ptr

protected

Definition at line 139 of file qplatformwindow.h.

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

qtbase/src/gui/kernel/qplatformwindow.h (4f83c8c7f3290b2923a9622098c2ed8944c81ac3)
qtbase/src/gui/kernel/qplatformwindow.cpp (2e6032188fee4430afbea377350c55dde46bfb43)

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ QPlatformWindow()

◆ ~QPlatformWindow()

Member Function Documentation

◆ allowsIndependentThreadedRendering()

◆ close()

◆ closestAcceptableGeometry()

◆ constrainWindowSize()

◆ deliverUpdateRequest()

◆ devicePixelRatio()

◆ format()

◆ formatWindowTitle()

◆ frameMargins()

◆ frameStrutEventsEnabled()

◆ geometry()

◆ handleContentOrientationChange()

◆ hasPendingUpdateRequest()

◆ initialGeometry()

◆ initialize()

◆ invalidateSurface()

◆ isActive()

◆ isAlertState()

◆ isAncestorOf()

◆ isEmbedded()

◆ isExposed()

◆ isForeignWindow()

◆ lower()

◆ mapFromGlobal()

◆ mapFromGlobalF()

◆ mapToGlobal()

◆ mapToGlobalF()

◆ normalGeometry()

◆ parent()

◆ propagateSizeHints()

◆ raise()

◆ requestActivateWindow()

◆ requestUpdate()

◆ safeAreaMargins()

◆ screen()

◆ screenForGeometry()

◆ setAlertState()

◆ setFrameStrutEventsEnabled()

◆ setGeometry()

◆ setKeyboardGrabEnabled()

◆ setMask()

◆ setMouseGrabEnabled()

◆ setOpacity()

◆ setParent()

◆ setVisible()

◆ setWindowFilePath()

◆ setWindowFlags()

◆ setWindowIcon()

◆ setWindowModified()

◆ setWindowState()

◆ setWindowTitle()

◆ startSystemMove()

◆ startSystemResize()

◆ window()

◆ windowBaseSize()

◆ windowClosestAcceptableGeometry()

◆ windowEvent()

◆ windowFrameGeometry()

◆ windowGeometry()

◆ windowMaximumSize()

◆ windowMinimumSize()

◆ windowSizeIncrement()

◆ windowTitle()

◆ winId()

Member Data Documentation

◆ d_ptr