Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QAndroidPlatformWindow Class Reference

#include <qandroidplatformwindow.h>

Inheritance diagram for QAndroidPlatformWindow:
Collaboration diagram for QAndroidPlatformWindow:

Public Types

enum class  SurfaceContainer { SurfaceView , TextureView }

Public Member Functions

 QAndroidPlatformWindow (QWindow *window)
void initialize () override
 Called as part of QWindow::create(), after constructing the 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
QAndroidPlatformScreenplatformScreen () 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 setSafeAreaMargins (const QMargins safeMargins)
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 ()
void updateFocusedEditText ()
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)
void lockSurface ()
void unlockSurface ()
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.
QWindowwindow () const
 Returns the window which belongs to the QPlatformWindow.
QPlatformWindowparent () const
 Returns the parent platform window (or \nullptr if orphan).
QPlatformScreenscreen () 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 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 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.
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 ()
QSurfacesurface () 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().

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 createSurface ()
void destroySurface ()
void sendExpose () const
bool blockedByModal () const
bool isEmbeddingContainer () const
virtual void clearSurface ()
Protected Member Functions inherited from QPlatformWindow
QPlatformScreenscreenForGeometry (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_androidSurfaceCreated = false
QMutex m_surfaceMutex
QMutex m_destructionMutex
QMargins m_safeAreaMargins
Protected Attributes inherited from QPlatformWindow
QScopedPointer< QPlatformWindowPrivated_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 27 of file qandroidplatformwindow.h.

Member Enumeration Documentation

◆ SurfaceContainer

Enumerator
SurfaceView 
TextureView 

Definition at line 30 of file qandroidplatformwindow.h.

Constructor & Destructor Documentation

◆ QAndroidPlatformWindow()

QAndroidPlatformWindow::QAndroidPlatformWindow ( QWindow * window)
explicit

Referenced by QAndroidPlatformVulkanWindow::QAndroidPlatformVulkanWindow().

Here is the caller graph for this function:

◆ ~QAndroidPlatformWindow()

QAndroidPlatformWindow::~QAndroidPlatformWindow ( )

Definition at line 101 of file qandroidplatformwindow.cpp.

Member Function Documentation

◆ applicationStateChanged()

void QAndroidPlatformWindow::applicationStateChanged ( Qt::ApplicationState )
virtual

Reimplemented in QAndroidPlatformForeignWindow, QAndroidPlatformOpenGLWindow, and QAndroidPlatformVulkanWindow.

Definition at line 282 of file qandroidplatformwindow.cpp.

References isExposed().

Here is the call graph for this function:

◆ blockedByModal()

bool QAndroidPlatformWindow::blockedByModal ( ) const
protected

Definition at line 337 of file qandroidplatformwindow.cpp.

Referenced by requestActivateWindow().

Here is the caller graph for this function:

◆ clearSurface()

virtual void QAndroidPlatformWindow::clearSurface ( )
inlineprotectedvirtual

Reimplemented in QAndroidPlatformOpenGLWindow, and QAndroidPlatformVulkanWindow.

Definition at line 83 of file qandroidplatformwindow.h.

Referenced by onSurfaceChanged().

Here is the caller graph for this function:

◆ createSurface()

void QAndroidPlatformWindow::createSurface ( )
protected

Definition at line 292 of file qandroidplatformwindow.cpp.

References m_androidSurfaceCreated.

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

Here is the caller graph for this function:

◆ destroySurface()

void QAndroidPlatformWindow::destroySurface ( )
protected

Definition at line 302 of file qandroidplatformwindow.cpp.

References m_androidSurfaceCreated.

Referenced by QAndroidPlatformOpenGLWindow::applicationStateChanged().

Here is the caller graph for this function:

◆ initialize()

void QAndroidPlatformWindow::initialize ( )
overridevirtual

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

Definition at line 35 of file qandroidplatformwindow.cpp.

References QtAndroid::backendRegister(), isEmbeddingContainer(), m_surfaceContainerType, QObjectData::parent, SurfaceView, and TextureView.

Here is the call graph for this function:

◆ isEmbeddingContainer()

bool QAndroidPlatformWindow::isEmbeddingContainer ( ) const
protected

Definition at line 343 of file qandroidplatformwindow.cpp.

References QtAndroid::isQtApplication().

Referenced by initialize(), setGeometry(), and setVisible().

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 275 of file qandroidplatformwindow.cpp.

Referenced by applicationStateChanged().

Here is the caller graph for this function:

◆ isRaster()

bool QAndroidPlatformWindow::isRaster ( ) const
inline

Definition at line 63 of file qandroidplatformwindow.h.

References m_isRaster.

Referenced by QAndroidPlatformScreen::addWindow().

Here is the caller graph for this function:

◆ lockSurface()

void QAndroidPlatformWindow::lockSurface ( )
inline

Definition at line 73 of file qandroidplatformwindow.h.

Referenced by QAndroidPlatformOpenGLWindow::applicationStateChanged(), QAndroidPlatformOpenGLContext::makeCurrent(), onSurfaceChanged(), and QAndroidPlatformOpenGLContext::swapBuffers().

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 109 of file qandroidplatformwindow.cpp.

◆ nativeViewId()

int QAndroidPlatformWindow::nativeViewId ( ) const
inline

Definition at line 68 of file qandroidplatformwindow.h.

References m_nativeViewId.

◆ nativeWindow()

QtJniTypes::QtWindow QAndroidPlatformWindow::nativeWindow ( ) const
inline

Definition at line 65 of file qandroidplatformwindow.h.

◆ onSurfaceChanged()

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

Definition at line 310 of file qandroidplatformwindow.cpp.

References clearSurface(), lockSurface(), sendExpose(), and unlockSurface().

Here is the call graph for this function:

◆ platformScreen()

QAndroidPlatformScreen * QAndroidPlatformWindow::platformScreen ( ) const

Definition at line 241 of file qandroidplatformwindow.cpp.

◆ 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 246 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 118 of file qandroidplatformwindow.cpp.

References updateSystemUiVisibility().

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 471 of file qandroidplatformwindow.cpp.

◆ 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 251 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 129 of file qandroidplatformwindow.cpp.

◆ sendExpose()

void QAndroidPlatformWindow::sendExpose ( ) const
protected

Definition at line 328 of file qandroidplatformwindow.cpp.

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

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 139 of file qandroidplatformwindow.cpp.

References isEmbeddingContainer().

Referenced by QAndroidPlatformVulkanWindow::setGeometry().

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 52 of file qandroidplatformwindow.h.

◆ setMouseGrabEnabled()

bool QAndroidPlatformWindow::setMouseGrabEnabled ( bool grab)
inlineoverridevirtual

Reimplemented from QPlatformWindow.

Definition at line 51 of file qandroidplatformwindow.h.

◆ 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 213 of file qandroidplatformwindow.cpp.

References QtAndroid::isQtApplication().

Here is the call graph for this function:

◆ setSafeAreaMargins()

void QAndroidPlatformWindow::setSafeAreaMargins ( const QMargins safeMargins)

Definition at line 134 of file qandroidplatformwindow.cpp.

◆ setVisible()

void QAndroidPlatformWindow::setVisible ( bool visible)
overridevirtual

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

Definition at line 160 of file qandroidplatformwindow.cpp.

References isEmbeddingContainer(), requestActivateWindow(), and updateSystemUiVisibility().

Here is the call graph for this function:

◆ setWindowFlags()

void QAndroidPlatformWindow::setWindowFlags ( Qt::WindowFlags flags)
overridevirtual

Requests setting the window flags of this surface to flags.

Reimplemented from QPlatformWindow.

Definition at line 200 of file qandroidplatformwindow.cpp.

◆ setWindowState()

void QAndroidPlatformWindow::setWindowState ( Qt::WindowStates state)
overridevirtual

Requests setting the window state of this surface to type.

Qt::WindowActive can be ignored.

Reimplemented from QPlatformWindow.

Definition at line 188 of file qandroidplatformwindow.cpp.

References updateSystemUiVisibility().

Here is the call graph for this function:

◆ unlockSurface()

void QAndroidPlatformWindow::unlockSurface ( )
inline

Definition at line 74 of file qandroidplatformwindow.h.

Referenced by QAndroidPlatformOpenGLWindow::applicationStateChanged(), QAndroidPlatformOpenGLContext::makeCurrent(), onSurfaceChanged(), and QAndroidPlatformOpenGLContext::swapBuffers().

Here is the caller graph for this function:

◆ updateFocusedEditText()

void QAndroidPlatformWindow::updateFocusedEditText ( )

Definition at line 270 of file qandroidplatformwindow.cpp.

Referenced by QAndroidPlatformScreen::topVisibleWindowChanged().

Here is the caller graph for this function:

◆ updateSystemUiVisibility()

void QAndroidPlatformWindow::updateSystemUiVisibility ( )

Definition at line 258 of file qandroidplatformwindow.cpp.

Referenced by raise(), setVisible(), setWindowState(), and QAndroidPlatformScreen::topVisibleWindowChanged().

Here is the caller graph for this function:

◆ windowFlags()

Qt::WindowFlags QAndroidPlatformWindow::windowFlags ( ) const

Definition at line 208 of file qandroidplatformwindow.cpp.

◆ winId()

WId QAndroidPlatformWindow::winId ( ) const
overridevirtual

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

Reimplemented from QPlatformWindow.

Definition at line 236 of file qandroidplatformwindow.cpp.

Member Data Documentation

◆ m_androidSurfaceCreated

bool QAndroidPlatformWindow::m_androidSurfaceCreated = false
protected

◆ m_androidSurfaceObject

QtJniTypes::Surface QAndroidPlatformWindow::m_androidSurfaceObject
protected

Definition at line 98 of file qandroidplatformwindow.h.

◆ m_destructionMutex

QMutex QAndroidPlatformWindow::m_destructionMutex
protected

Definition at line 102 of file qandroidplatformwindow.h.

◆ m_isRaster

bool QAndroidPlatformWindow::m_isRaster
protected

Definition at line 87 of file qandroidplatformwindow.h.

Referenced by isRaster().

◆ m_nativeParentQtWindow

QtJniTypes::QtWindow QAndroidPlatformWindow::m_nativeParentQtWindow
protected

Definition at line 92 of file qandroidplatformwindow.h.

◆ m_nativeQtWindow

QtJniTypes::QtWindow QAndroidPlatformWindow::m_nativeQtWindow
protected

Definition at line 90 of file qandroidplatformwindow.h.

◆ m_nativeViewId

int QAndroidPlatformWindow::m_nativeViewId = -1
protected

Definition at line 89 of file qandroidplatformwindow.h.

Referenced by nativeViewId().

◆ m_safeAreaMargins

QMargins QAndroidPlatformWindow::m_safeAreaMargins
protected

Definition at line 104 of file qandroidplatformwindow.h.

◆ m_surfaceContainerType

SurfaceContainer QAndroidPlatformWindow::m_surfaceContainerType = SurfaceContainer::SurfaceView
protected

Definition at line 91 of file qandroidplatformwindow.h.

Referenced by initialize().

◆ m_surfaceMutex

QMutex QAndroidPlatformWindow::m_surfaceMutex
protected

Definition at line 101 of file qandroidplatformwindow.h.

◆ m_surfaceWaitCondition

QWaitCondition QAndroidPlatformWindow::m_surfaceWaitCondition
protected

Definition at line 99 of file qandroidplatformwindow.h.

◆ m_windowFlags

Qt::WindowFlags QAndroidPlatformWindow::m_windowFlags
protected

Definition at line 85 of file qandroidplatformwindow.h.

◆ m_windowState

Qt::WindowStates QAndroidPlatformWindow::m_windowState
protected

Definition at line 86 of file qandroidplatformwindow.h.


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