QtQuickView.java

Go to the documentation of this file.

// Copyright (C) 2024 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
 
package org.qtproject.qt.android;
 
import org.qtproject.qt.android.QtSignalListener;
 
import android.content.Context;
import android.util.Log;
 
import java.lang.IllegalArgumentException;
import java.lang.ref.WeakReference;
import java.security.InvalidParameterException;

public class QtQuickView extends QtView {
    private final static String TAG = "QtQuickView";
 
    private String m_qmlUri;
    private String[] m_qmlImportPaths = null;
    private QtQmlStatusChangeListener m_statusChangeListener = null;
    private QtQmlStatus m_lastStatus = QtQmlStatus.NULL;
    private boolean m_hasQueuedStatus = false;
    private WeakReference<QtQuickViewContent> m_loadedComponent;
    private QtSignalQueue m_signalQueue = new QtSignalQueue();
 
    native void createQuickView(String qmlUri, int width, int height, long parentWindowReference,
                                long viewReference, String[] qmlImportPaths);
    native void setRootObjectProperty(long windowReference, String propertyName, Object value);
    native Object getRootObjectProperty(long windowReference, String propertyName);
    native boolean addRootObjectSignalListener(long windowReference, String signalName,
                                               Class<?>[] argTypes, Object listener, int id);
    native boolean removeRootObjectSignalListener(long windowReference, int signalListenerId);
    native void invokeMethod(long windowReference, String methodName, Object[] params);

    public QtQuickView(Context context, String qmlUri, String appName)
        throws InvalidParameterException {
        this(context, qmlUri, appName, null);
    }

    public QtQuickView(Context context, String qmlUri, String appName, String[] qmlImportPaths)
            throws InvalidParameterException
    {
        super(context, appName);
        if (qmlUri == null || qmlUri.isEmpty()) {
            throw new InvalidParameterException(
                "QtQuickView: argument 'qmlUri' may not be empty or null");
        }
        m_qmlUri = qmlUri;
        m_qmlImportPaths = qmlImportPaths;
    }

    public QtQuickView(Context context)
    {
        super(context);
    }

    // TODO: QTBUG-125620 -- Refresh/reset import paths when loading a new component
    public <T extends QtQuickViewContent> void loadContent(T qmlContent, String[] qmlImportPaths)
            throws InvalidParameterException
    {
        String libName = qmlContent.getLibraryName();
        String qmlUri = qmlContent.getFilePath();
 
        if (libName == null || libName.isEmpty()) {
            throw new InvalidParameterException(
                    "QtQuickViewContent: return value of getLibraryName() may not be empty or null");
        }
 
        if (qmlUri == null || qmlUri.isEmpty()) {
            throw new InvalidParameterException(
                    "QtQuickViewContent: return value of getFilePath() may not be empty or null");
        }
 
        m_qmlUri = qmlUri;
        m_qmlImportPaths = qmlImportPaths;
 
        if (m_loadedComponent != null)
            m_loadedComponent.clear();
 
        m_loadedComponent = new WeakReference<>(qmlContent);
        qmlContent.detachView();
        qmlContent.attachView(this);
        // The first QQuickView creation happen after first libs loading
        // and windowReference() returns a reference to native QQuickView
        // instance, after that. We don't load library again if the view
        // exists.
        if (windowReference() == 0) {
            loadQtLibraries(libName);
        } else {
            createQuickView(m_qmlUri, getWidth(), getHeight(), 0, windowReference(),
                            m_qmlImportPaths);
        }
    }
 
    @Override
    void setWindowReference(long windowReference) {
        super.setWindowReference(windowReference);
        m_signalQueue.connectQueuedSignalListeners(this);
    }
 
    private boolean hasUnderlyingView() {
        return m_windowReference != 0L;
    }

    public <T extends QtQuickViewContent> void loadContent(T qmlContent)
            throws InvalidParameterException
    {
        loadContent(qmlContent, null);
    }
 
    @Override
    protected void createWindow(long parentWindowReference) {
        createQuickView(m_qmlUri, getWidth(), getHeight(), parentWindowReference, windowReference(),
                        m_qmlImportPaths);
    }

    public void setProperty(String propertyName, Object value)
    {
        setRootObjectProperty(windowReference(), propertyName, value);
    }

    // getRootObjectProperty always returns a primitive type or an Object
    // so it is safe to suppress the unchecked warning
    @SuppressWarnings("unchecked")
    public <T> T getProperty(String propertyName)
    {
        return (T)getRootObjectProperty(windowReference(), propertyName);
    }

    public <T> int connectSignalListener(String signalName, Class<T> argType,
                                         QtSignalListener<T> listener)
    {
        return connectSignalListener(signalName, new Class<?>[] { argType }, listener);
    }

    public int connectSignalListener(String signalName, Class<?>[] argTypes, Object listener)
    {
        final int id = QtQuickViewContent.generateSignalId();
        connectSignalListener(signalName, argTypes, listener, id);
        return id;
    }

    void connectSignalListener(String signalName, Class<?>[] argTypes, Object listener, int id)
    {
        if (hasUnderlyingView())
            addRootObjectSignalListener(windowReference(), signalName, argTypes, listener, id);
        else
            m_signalQueue.add(signalName, argTypes, listener, id);
    }

    public boolean disconnectSignalListener(int signalListenerId)
    {
        if (hasUnderlyingView())
            return removeRootObjectSignalListener(windowReference(), signalListenerId);
        else
            return m_signalQueue.remove(signalListenerId);
    }

    public QtQmlStatus getStatus()
    {
        return m_lastStatus;
    }

    public void setStatusChangeListener(QtQmlStatusChangeListener listener)
    {
        m_statusChangeListener = listener;
 
        if (m_hasQueuedStatus) {
            sendStatusChanged(m_lastStatus);
            m_hasQueuedStatus = false;
        }
    }

    public void invokeMethod(String methodName, Object[] params)
    {
        invokeMethod(windowReference(), methodName, params);
    }

    public void invokeMethod(String methodName)
    {
        invokeMethod(windowReference(), methodName, new Object[] {});
    }
 
    private void handleStatusChange(int status)
    {
        try {
            m_lastStatus = QtQmlStatus.fromInt(status);
        } catch (IllegalArgumentException e) {
            m_lastStatus = QtQmlStatus.NULL;
            e.printStackTrace();
        }
 
        if (m_statusChangeListener == null)
            m_hasQueuedStatus = true;
        else
            sendStatusChanged(m_lastStatus);
    }
 
    private void sendStatusChanged(QtQmlStatus status)
    {
        if (m_statusChangeListener != null) {
            QtQuickViewContent content = m_loadedComponent != null ? m_loadedComponent.get() : null;
            if (content == null)
                m_statusChangeListener.onStatusChanged(status);
            else
                m_statusChangeListener.onStatusChanged(status, content);
        }
    }
}