QtQuickViewContent.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 android.util.Log;
import java.lang.ref.WeakReference;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Random;

public abstract class QtQuickViewContent
{
    private final static String TAG = "QtQuickViewContent";
 
    private WeakReference<QtQuickView> m_viewReference;
    private QtQmlStatusChangeListener m_statusChangeListener = null;
    private HashSet<Integer> m_signalListenerIds = new HashSet<>();
    private QtSignalQueue m_signalQueue = new QtSignalQueue();

    public abstract String getLibraryName();
    public abstract String getModuleName();
    public abstract String getFilePath();

    public void setStatusChangeListener(QtQmlStatusChangeListener listener)
    {
        m_statusChangeListener = listener;
        QtQuickView view = getQuickView();
        if (view != null)
            view.setStatusChangeListener(listener);
    }

    protected QtQuickView getQuickView()
    {
        if (m_viewReference != null)
            return m_viewReference.get();
        return null;
    }

    protected boolean isViewAttached() { return getQuickView() != null; }

    protected void attachView(QtQuickView view)
    {
        m_viewReference = new WeakReference<>(view);
        if (view != null) {
            view.setStatusChangeListener(m_statusChangeListener);
            m_signalQueue.connectQueuedSignalListeners(view);
        }
    }

    protected void detachView()
    {
        QtQuickView view = getQuickView();
        if (view != null) {
            for (int signalListenerId : m_signalListenerIds)
                view.disconnectSignalListener(signalListenerId);
 
            view.setStatusChangeListener(null);
            m_viewReference.clear();
            if (m_statusChangeListener != null)
                m_statusChangeListener.onStatusChanged(QtQmlStatus.NULL);
        }
    }

    protected HashMap<String, Object> attributes() { return new HashMap<>(); }

    protected void setProperty(String propertyName, Object value)
    {
        QtQuickView view = getQuickView();
        if (view == null) {
            Log.w(TAG, "Cannot set property as the QQmlComponent is not loaded in a QtQuickView.");
            return;
        }
        view.setProperty(propertyName, value);
    }

    protected <T> T getProperty(String propertyName)
    {
        QtQuickView view = getQuickView();
        if (view == null) {
            Log.w(TAG, "Cannot get property as the QQmlComponent is not loaded in a QtQuickView.");
            return null;
        }
        return view.<T>getProperty(propertyName);
    }

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

    protected int connectSignalListener(String signalName, Class<?>[] argTypes, Object listener)
    {
        final int id = QtQuickViewContent.generateSignalId();
        if (isViewAttached()) {
            QtQuickView view = getQuickView();
            view.connectSignalListener(signalName, argTypes, listener, id);
            m_signalListenerIds.add(id);
        } else {
            m_signalQueue.add(signalName, argTypes, listener, id);
        }
        return id;
    }

    public boolean disconnectSignalListener(int signalListenerId)
    {
        if (isViewAttached()) {
            QtQuickView view = getQuickView();
            m_signalListenerIds.remove(signalListenerId);
            return view.disconnectSignalListener(signalListenerId);
        } else {
            return m_signalQueue.remove(signalListenerId);
        }
    }
 
    static int generateSignalId()
    {
        Random rand = new Random();
        return rand.nextInt();
    }

    public void invokeMethod(String name, Object[] params)
    {
        QtQuickView view = getQuickView();
        if (view != null) {
            view.invokeMethod(name, params);
        } else {
            Log.w(TAG,
                  "Cannot call method " + name +
                  " as the QQmlComponent is not loaded in a QtQuickView.");
        }
    }

    public void invokeMethod(String name)
    {
        QtQuickView view = getQuickView();
        if (view != null) {
            view.invokeMethod(name);
        } else {
            Log.w(TAG,
                  "Cannot call method " + name +
                  " as the QQmlComponent is not loaded in a QtQuickView.");
        }
    }
}