#include <qandroidplatformwindow.h>

Inheritance diagram for QAndroidPlatformWindow:

Collaboration diagram for QAndroidPlatformWindow:

Public Types
enum class	SurfaceContainer { SurfaceView , TextureView }

Public Member Functions
	QAndroidPlatformWindow (QWindow *window)

	~QAndroidPlatformWindow ()

void	lower () override
	Reimplement to be able to let Qt lower windows to the bottom of the desktop.

void	raise () override
	Reimplement to be able to let Qt raise windows to the top of the desktop.

void	setVisible (bool visible) override
	Reimplemented in subclasses to show the surface if visible is `true`, and hide it if visible is `false`.

void	setWindowState (Qt::WindowStates state) override
	Requests setting the window state of this surface to type.

void	setWindowFlags (Qt::WindowFlags flags) override
	Requests setting the window flags of this surface to flags.

Qt::WindowFlags	windowFlags () const

void	setParent (const QPlatformWindow *window) override
	This function is called to enable native child window in QPA.

WId	winId () const override
	Reimplement in subclasses to return a handle to the native window.

bool	setMouseGrabEnabled (bool grab) override

bool	setKeyboardGrabEnabled (bool grab) override

QAndroidPlatformScreen *	platformScreen () const

QMargins	safeAreaMargins () const override
	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.

void	propagateSizeHints () override
	Reimplement to propagate the size hints of the QWindow.

void	requestActivateWindow () override
	Reimplement to let Qt be able to request activation/focus for a window.

void	updateSystemUiVisibility ()

bool	isRaster () const

bool	isExposed () const override
	Returns if this window is exposed in the windowing system.

QtJniTypes::QtWindow	nativeWindow () const

virtual void	applicationStateChanged (Qt::ApplicationState)

int	nativeViewId () const

void	onSurfaceChanged (QtJniTypes::Surface surface)

Public Member Functions inherited from QPlatformWindow
	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 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 void	setWindowTitle (const QString &title)
	Reimplement to set the window title to title.

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

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 bool	registerNatives (QJniEnvironment &env)

Static Public Member Functions inherited from QPlatformWindow
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().

Static Public Member Functions inherited from QPlatformSurface
static bool	isRasterSurface (QSurface *surface)

Protected Member Functions
void	setGeometry (const QRect &rect) override
	This function is called by Qt whenever a window is moved or resized using the QWindow API.

void	lockSurface ()

void	unlockSurface ()

void	createSurface ()

void	destroySurface ()

void	setNativeGeometry (const QRect &geometry)

void	sendExpose () const

bool	blockedByModal () const

bool	isEmbeddingContainer () const

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

Protected Attributes
Qt::WindowFlags	m_windowFlags

Qt::WindowStates	m_windowState

bool	m_isRaster

int	m_nativeViewId = -1

QtJniTypes::QtWindow	m_nativeQtWindow

SurfaceContainer	m_surfaceContainerType = SurfaceContainer::SurfaceView

QtJniTypes::QtWindow	m_nativeParentQtWindow

QtJniTypes::Surface	m_androidSurfaceObject

QWaitCondition	m_surfaceWaitCondition

bool	m_surfaceCreated = false

QMutex	m_surfaceMutex

Protected Attributes inherited from QPlatformWindow
QScopedPointer< QPlatformWindowPrivate >	d_ptr

Additional Inherited Members
Static Protected Member Functions inherited from QPlatformWindow
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].

Detailed Description

Definition at line 26 of file qandroidplatformwindow.h.

Member Enumeration Documentation

◆ SurfaceContainer

enum class QAndroidPlatformWindow::SurfaceContainer

strong

Enumerator
SurfaceView
TextureView

Definition at line 29 of file qandroidplatformwindow.h.

Constructor & Destructor Documentation

◆ QAndroidPlatformWindow()

QT_BEGIN_NAMESPACE QAndroidPlatformWindow::QAndroidPlatformWindow ( QWindow * window )

explicit

Definition at line 19 of file qandroidplatformwindow.cpp.

References QHighDpi::fromNativePixels(), QPlatformWindow::initialGeometry(), nativeWindow(), ok, qCDebug, qEnvironmentVariableIntValue(), QtAndroid::qtInputDelegate(), QSurface::RasterSurface, setWindowState(), QHighDpi::toNativePixels(), Qt::Widget, window(), Qt::WindowFullScreen, Qt::WindowMaximized, and Qt::WindowNoState.

Here is the call graph for this function:

◆ ~QAndroidPlatformWindow()

QAndroidPlatformWindow::~QAndroidPlatformWindow ( )

Definition at line 83 of file qandroidplatformwindow.cpp.

References platformScreen(), QAndroidPlatformScreen::removeWindow(), and QPlatformWindow::window().

Here is the call graph for this function:

Member Function Documentation

◆ applicationStateChanged()

void QAndroidPlatformWindow::applicationStateChanged ( Qt::ApplicationState )

virtual

Reimplemented in QAndroidPlatformForeignWindow, QAndroidPlatformOpenGLWindow, and QAndroidPlatformVulkanWindow.

Definition at line 244 of file qandroidplatformwindow.cpp.

References QWindowSystemInterface::flushWindowSystemEvents(), QPlatformWindow::geometry(), QWindowSystemInterface::handleExposeEvent(), isExposed(), and QPlatformWindow::window().

Referenced by QAndroidPlatformForeignWindow::applicationStateChanged(), QAndroidPlatformOpenGLWindow::applicationStateChanged(), and QAndroidPlatformVulkanWindow::applicationStateChanged().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ blockedByModal()

bool QAndroidPlatformWindow::blockedByModal ( ) const

protected

Definition at line 322 of file qandroidplatformwindow.cpp.

References QGuiApplication::modalWindow(), and QPlatformWindow::window().

Referenced by requestActivateWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createSurface()

void QAndroidPlatformWindow::createSurface ( )

protected

Definition at line 254 of file qandroidplatformwindow.cpp.

References QPlatformWindow::format(), QPlatformWindow::geometry(), m_nativeQtWindow, m_surfaceContainerType, m_surfaceCreated, qFuzzyCompare(), rect, QPlatformWindow::window(), and Qt::WindowStaysOnTopHint.

Referenced by QAndroidPlatformOpenGLWindow::eglSurface(), and QAndroidPlatformVulkanWindow::vkSurface().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ destroySurface()

void QAndroidPlatformWindow::destroySurface ( )

protected

Definition at line 273 of file qandroidplatformwindow.cpp.

References m_nativeQtWindow, and m_surfaceCreated.

Referenced by QAndroidPlatformOpenGLWindow::~QAndroidPlatformOpenGLWindow(), and QAndroidPlatformOpenGLWindow::applicationStateChanged().

Here is the caller graph for this function:

◆ isEmbeddingContainer()

bool QAndroidPlatformWindow::isEmbeddingContainer ( ) const

protected

Definition at line 328 of file qandroidplatformwindow.cpp.

References QtAndroid::isQtApplication(), and QPlatformWindow::window().

Referenced by QAndroidPlatformForeignWindow::QAndroidPlatformForeignWindow(), QAndroidPlatformForeignWindow::~QAndroidPlatformForeignWindow(), QAndroidPlatformForeignWindow::applicationStateChanged(), QAndroidPlatformForeignWindow::setGeometry(), QAndroidPlatformForeignWindow::setVisible(), setVisible(), and QAndroidPlatformForeignWindow::winId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isExposed()

bool QAndroidPlatformWindow::isExposed ( ) const

overridevirtual

Returns if this window is exposed in the windowing system.

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

Reimplemented from QPlatformWindow.

Definition at line 237 of file qandroidplatformwindow.cpp.

References Qt::ApplicationHidden, QRect::isEmpty(), qApp, and QPlatformWindow::window().

Referenced by applicationStateChanged().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isRaster()

bool QAndroidPlatformWindow::isRaster ( ) const

inline

Definition at line 58 of file qandroidplatformwindow.h.

◆ lockSurface()

void QAndroidPlatformWindow::lockSurface ( )

inlineprotected

Definition at line 70 of file qandroidplatformwindow.h.

Referenced by QAndroidPlatformOpenGLWindow::~QAndroidPlatformOpenGLWindow(), QAndroidPlatformOpenGLWindow::applicationStateChanged(), and onSurfaceChanged().

Here is the caller graph for this function:

◆ lower()

void QAndroidPlatformWindow::lower ( )

overridevirtual

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

Reimplemented from QPlatformWindow.

Definition at line 90 of file qandroidplatformwindow.cpp.

References QAndroidPlatformScreen::lower(), m_nativeParentQtWindow, nativeViewId(), and platformScreen().

Here is the call graph for this function:

◆ nativeViewId()

int QAndroidPlatformWindow::nativeViewId ( ) const

inline

Definition at line 63 of file qandroidplatformwindow.h.

Referenced by lower(), and raise().

Here is the caller graph for this function:

◆ nativeWindow()

QtJniTypes::QtWindow QAndroidPlatformWindow::nativeWindow ( ) const

inline

Definition at line 60 of file qandroidplatformwindow.h.

Referenced by QAndroidPlatformWindow().

Here is the caller graph for this function:

◆ onSurfaceChanged()

void QAndroidPlatformWindow::onSurfaceChanged ( QtJniTypes::Surface surface )

Definition at line 299 of file qandroidplatformwindow.cpp.

References lockSurface(), m_androidSurfaceObject, m_surfaceWaitCondition, sendExpose(), QPlatformSurface::surface(), unlockSurface(), and QWaitCondition::wakeOne().

Here is the call graph for this function:

◆ platformScreen()

QAndroidPlatformScreen * QAndroidPlatformWindow::platformScreen ( ) const

Definition at line 206 of file qandroidplatformwindow.cpp.

References QScreen::handle(), and QPlatformWindow::window().

Referenced by ~QAndroidPlatformWindow(), lower(), raise(), safeAreaMargins(), setParent(), and setVisible().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ propagateSizeHints()

void QAndroidPlatformWindow::propagateSizeHints ( )

overridevirtual

Reimplement to propagate the size hints of the QWindow.

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

Reimplemented from QPlatformWindow.

Definition at line 211 of file qandroidplatformwindow.cpp.

◆ raise()

void QAndroidPlatformWindow::raise ( )

overridevirtual

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

Reimplemented from QPlatformWindow.

Definition at line 99 of file qandroidplatformwindow.cpp.

References Qt::ActiveWindowFocusReason, QWindowSystemInterface::handleFocusWindowChanged(), m_nativeParentQtWindow, nativeViewId(), platformScreen(), QAndroidPlatformScreen::raise(), updateSystemUiVisibility(), and QPlatformWindow::window().

Referenced by requestActivateWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ registerNatives()

bool QAndroidPlatformWindow::registerNatives ( QJniEnvironment & env )

static

Definition at line 370 of file qandroidplatformwindow.cpp.

References qCCritical.

Referenced by JNI_OnLoad().

Here is the caller graph for this function:

◆ requestActivateWindow()

void QAndroidPlatformWindow::requestActivateWindow ( )

overridevirtual

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 from QPlatformWindow.

Definition at line 216 of file qandroidplatformwindow.cpp.

References blockedByModal(), and raise().

Referenced by setVisible().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ safeAreaMargins()

QMargins QAndroidPlatformWindow::safeAreaMargins ( ) const

overridevirtual

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 from QPlatformWindow.

Definition at line 110 of file qandroidplatformwindow.cpp.

References QAndroidPlatformScreen::availableGeometry(), QRect::bottom(), QRect::left(), m_windowState, Qt::MaximizeUsingFullscreenGeometryHint, platformScreen(), QRect::right(), QPlatformWindow::safeAreaMargins(), QRect::top(), QPlatformWindow::window(), and Qt::WindowMaximized.

Here is the call graph for this function:

◆ sendExpose()

void QAndroidPlatformWindow::sendExpose ( ) const

protected

Definition at line 313 of file qandroidplatformwindow.cpp.

References QPlatformScreen::availableGeometry(), QPlatformWindow::geometry(), QWindowSystemInterface::handleExposeEvent(), QRect::isNull(), QPlatformWindow::screen(), and QPlatformWindow::window().

Referenced by onSurfaceChanged(), and QAndroidPlatformVulkanWindow::vkSurface().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setGeometry()

void QAndroidPlatformWindow::setGeometry ( const QRect & rect )

overrideprotectedvirtual

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 from QPlatformWindow.

Definition at line 121 of file qandroidplatformwindow.cpp.

References QWindowSystemInterface::handleGeometryChange(), rect, QPlatformWindow::setGeometry(), and QPlatformWindow::window().

Referenced by QAndroidPlatformForeignWindow::setGeometry(), QAndroidPlatformOpenGLWindow::setGeometry(), QAndroidPlatformVulkanWindow::setGeometry(), and setVisible().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setKeyboardGrabEnabled()

bool QAndroidPlatformWindow::setKeyboardGrabEnabled ( bool grab )

inlineoverridevirtual

Reimplemented from QPlatformWindow.

Definition at line 49 of file qandroidplatformwindow.h.

References Q_UNUSED.

◆ setMouseGrabEnabled()

bool QAndroidPlatformWindow::setMouseGrabEnabled ( bool grab )

inlineoverridevirtual

Reimplemented from QPlatformWindow.

Definition at line 48 of file qandroidplatformwindow.h.

References Q_UNUSED.

◆ setNativeGeometry()

void QAndroidPlatformWindow::setNativeGeometry ( const QRect & geometry )

protected

Definition at line 281 of file qandroidplatformwindow.cpp.

References QPlatformWindow::geometry(), m_nativeQtWindow, and m_surfaceCreated.

Referenced by QAndroidPlatformForeignWindow::setGeometry(), QAndroidPlatformOpenGLWindow::setGeometry(), and QAndroidPlatformVulkanWindow::setGeometry().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setParent()

void QAndroidPlatformWindow::setParent ( const QPlatformWindow * parent )

overridevirtual

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 from QPlatformWindow.

Definition at line 178 of file qandroidplatformwindow.cpp.

References QAndroidPlatformScreen::addWindow(), QtAndroid::isQtApplication(), m_nativeParentQtWindow, m_nativeQtWindow, platformScreen(), QAndroidPlatformScreen::removeWindow(), void, and QPlatformWindow::window().

Here is the call graph for this function: