qandroidplatformwindow.h

Go to the documentation of this file.

// Copyright (C) 2014 BogDan Vatra <bogdan@kde.org>
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
 
#ifndef ANDROIDPLATFORMWINDOW_H
#define ANDROIDPLATFORMWINDOW_H
#include <qobject.h>
#include <qrect.h>
#include <qpa/qplatformwindow.h>
#include <QtCore/qjnienvironment.h>
#include <QtCore/qjniobject.h>
#include <QtCore/qjnitypes.h>
#include <QtCore/qloggingcategory.h>
#include <QtCore/qmutex.h>
#include <QtCore/qwaitcondition.h>
#include <jni.h>
 
QT_BEGIN_NAMESPACE
 
Q_DECLARE_LOGGING_CATEGORY(lcQpaWindow)
Q_DECLARE_JNI_CLASS(QtWindow, "org/qtproject/qt/android/QtWindow")
Q_DECLARE_JNI_CLASS(Surface, "android/view/Surface")
Q_DECLARE_JNI_CLASS(Insets, "android/graphics/Insets")
 
class QAndroidPlatformScreen;
 
class QAndroidPlatformWindow: public QPlatformWindow
{
public:
    enum class SurfaceContainer {
        SurfaceView,
        TextureView
    };
 
    explicit QAndroidPlatformWindow(QWindow *window);
    void initialize() override;
 
    ~QAndroidPlatformWindow();
    void lower() override;
    void raise() override;
 
    void setVisible(bool visible) override;
 
    void setWindowState(Qt::WindowStates state) override;
    void setWindowFlags(Qt::WindowFlags flags) override;
    Qt::WindowFlags windowFlags() const;
    void setParent(const QPlatformWindow *window) override;
 
    WId winId() const override;
 
    bool setMouseGrabEnabled(bool grab) override { Q_UNUSED(grab); return false; }
    bool setKeyboardGrabEnabled(bool grab) override { Q_UNUSED(grab); return false; }
 
    QAndroidPlatformScreen *platformScreen() const;
 
    QMargins safeAreaMargins() const override;
    void setSafeAreaMargins(const QMargins safeMargins);
 
    void propagateSizeHints() override;
    void requestActivateWindow() override;
    void updateSystemUiVisibility();
    void updateFocusedEditText();
    inline bool isRaster() const { return m_isRaster; }
    bool isExposed() const override;
    QtJniTypes::QtWindow nativeWindow() const { return m_nativeQtWindow; }
 
    virtual void applicationStateChanged(Qt::ApplicationState);
    int nativeViewId() const { return m_nativeViewId; }
 
    static bool registerNatives(QJniEnvironment &env);
    void onSurfaceChanged(QtJniTypes::Surface surface);
 
    void lockSurface() { m_surfaceMutex.lock(); }
    void unlockSurface() { m_surfaceMutex.unlock(); }
 
protected:
    void setGeometry(const QRect &rect) override;
    void createSurface();
    void destroySurface();
    void sendExpose() const;
    bool blockedByModal() const;
    bool isEmbeddingContainer() const;
    virtual void clearSurface() {}
 
    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;
    // The Android Surface, accessed from multiple threads, guarded by m_surfaceMutex.
    // If the window is using QtSurface, which is a SurfaceView subclass, this Surface will be
    // automatically created by Android when QtSurface is in a layout and visible. If the
    // QtSurface is detached or hidden (app goes to background), Android will automatically
    // destroy the Surface.
    QtJniTypes::Surface m_androidSurfaceObject;
    QWaitCondition m_surfaceWaitCondition;
    bool m_androidSurfaceCreated = false;
    QMutex m_surfaceMutex;
    QMutex m_destructionMutex;
 
    QMargins m_safeAreaMargins;
 
private:
    static void setSurface(JNIEnv *env, jobject obj, jint windowId, QtJniTypes::Surface surface);
    Q_DECLARE_JNI_NATIVE_METHOD_IN_CURRENT_SCOPE(setSurface)
    static void windowFocusChanged(JNIEnv *env, jobject object, jboolean focus, jint windowId);
    Q_DECLARE_JNI_NATIVE_METHOD_IN_CURRENT_SCOPE(windowFocusChanged)
    static void safeAreaMarginsChanged(JNIEnv *env, jobject obj, QtJniTypes::Insets insets, jint  id);
    Q_DECLARE_JNI_NATIVE_METHOD_IN_CURRENT_SCOPE(safeAreaMarginsChanged)
 
    [[nodiscard]] QMutexLocker<QMutex> destructionGuard();
};
 
QT_END_NAMESPACE
#endif // ANDROIDPLATFORMWINDOW_H