org.qtproject.qt.android.QtQuickView Class Reference

Inheritance diagram for org.qtproject.qt.android.QtQuickView:

Collaboration diagram for org.qtproject.qt.android.QtQuickView:

Classes
interface	SignalListener
interface	StatusChangeListener

Public Member Functions
	QtQuickView (Context context, String qmlUri, String appName) throws InvalidParameterException
	QtQuickView (Context context, String qmlUri, String appName, String[] qmlImportPaths) throws InvalidParameterException
void	setProperty (String propertyName, Object value)
boolean	disconnectSignalListener (int signalListenerId)
int	getStatus ()
void	setStatusChangeListener (StatusChangeListener listener)

Static Public Attributes
static final int	STATUS_NULL = 0
static final int	STATUS_READY = 1
static final int	STATUS_LOADING = 2
static final int	STATUS_ERROR = 3

Protected Member Functions
void	createWindow (long parentWindowReference)

Detailed Description

The QtQuickView class lets you easily add QML content to your Android app as a View. QtQuickView instantiates a QQuickView with a given QML component source URI path and embeds it inside itself. You can add it in your Android app's layout as with any other View. QtQuickView is a good choice when you want to extend your non-Qt Android app with QML content but do not want to make the entire app using the Qt framework. It brings the power of Qt Quick into your Android app, making it possible to use various Qt Quick APIs, in Android Java or Kotlin apps.

Note: This class is a technical preview. It is subject to change, and no source nor binary compatibility guarantees exist.

Known limitations:

• Only CMake is supported, not qmake.
• Only one QtQuickView can be added to your app, adding multiple outcomes unknown.

See also

Qt QQuickView

Definition at line 32 of file QtQuickView.java.

Constructor & Destructor Documentation

QtQuickView() [1/2]

org.qtproject.qt.android.QtQuickView.QtQuickView ( Context context, String qmlUri, String appName ) throws InvalidParameterException

inline

Creates a QtQuickView to load and view a QML component. Instantiating a QtQuickView will load the Qt libraries, including the app library specified by appName. Then it creates a QQuickView that loads the QML source specified by qmlUri.

Parameters

context	the parent Context
qmlUri	the URI of the main QML file
appName	the name of the Qt app library to load and start. This corresponds to the target name set in Qt app's CMakeLists.txt

Exceptions

InvalidParameterException

if either qmlUri or appName is empty or null

See also

Qt QQuickView

Definition at line 109 of file QtQuickView.java.

References context.

QtQuickView() [2/2]

org.qtproject.qt.android.QtQuickView.QtQuickView ( Context context, String qmlUri, String appName, String[] qmlImportPaths ) throws InvalidParameterException

inline

Creates a QtQuickView to load and view a QML component. Instantiating a QtQuickView will load the Qt libraries, including the app library specified by appName. Then it creates a QQuickView that loads the QML source specified by qmlUri. This overload accepts an array of strings in the case where the QML application should load QML modules from custom paths.

Parameters

context	the parent Context
qmlUri	the URI of the main QML file
appName	the name of the Qt app library to load and start. This corresponds to the target name set in the Qt app's CMakeLists.txt
qmlImportPaths	an array of strings for additional import paths to be passed to QQmlEngine, or null if additional import paths are not required

Exceptions

InvalidParameterException

if either qmlUri or appName is empty or null

See also

Qt QQmlEngine

Definition at line 129 of file QtQuickView.java.

References context.

Member Function Documentation

createWindow()

void org.qtproject.qt.android.QtQuickView.createWindow ( long parentWindowReference )

inlineprotected

Definition at line 142 of file QtQuickView.java.

disconnectSignalListener()

boolean org.qtproject.qt.android.QtQuickView.disconnectSignalListener ( int signalListenerId )

inline

Disconnects a SignalListener with a given id obtained from connectSignalListener call, from listening to a signal.

Parameters

signalListenerId

the connection id

Returns

Returns true if the connection id is valid and has been successfuly removed, otherwise returns false.

Definition at line 219 of file QtQuickView.java.

getStatus()

int org.qtproject.qt.android.QtQuickView.getStatus ( )

inline

Gets the status of the QML component.

Returns

Returns STATUS_READY when the QML component is ready. Invoking methods that operate on the QML root object (setProperty, getProperty, and addSignalListener) would succeed only if the current STATUS_READY. It can also return STATUS_NULL, STATUS_LOADING, or STATUS_ERROR based on the status of see underlaying

See also

QQuickView instance.

Definition at line 235 of file QtQuickView.java.

setProperty()

void org.qtproject.qt.android.QtQuickView.setProperty ( String propertyName, Object value )

inline

Sets the value of an existing property on the QML root object. The supported types are java.lang.Integer, java.lang.Double, java.lang.Float, java.lang.Boolean and java.lang.String. These types get converted to their corresponding QML types int, double/float, bool and string. This function does not add properties to the QML root object if they do not exist, but prints a warning.

Parameters

propertyName	the name of the existing root object property to set the value of
value	the value to set the property to

See also

QML int,

QML double/float,

QML bool,

QML string.

Definition at line 160 of file QtQuickView.java.

setStatusChangeListener()

void org.qtproject.qt.android.QtQuickView.setStatusChangeListener ( StatusChangeListener listener )

inline

Sets a StatusChangeListener to listen to status changes.

Parameters

listener

an instance of a StatusChangeListener interface

Definition at line 245 of file QtQuickView.java.

References org.qtproject.qt.android.QtQuickView.StatusChangeListener.onStatusChanged().

Here is the call graph for this function:

Member Data Documentation

STATUS_ERROR

final int org.qtproject.qt.android.QtQuickView.STATUS_ERROR = 3

static

QML loading status: One or more errors has occurred.

Definition at line 81 of file QtQuickView.java.

STATUS_LOADING

final int org.qtproject.qt.android.QtQuickView.STATUS_LOADING = 2

static

QML loading status: The QML view is loading the root object from network.

Definition at line 77 of file QtQuickView.java.

STATUS_NULL

final int org.qtproject.qt.android.QtQuickView.STATUS_NULL = 0

static

QML loading status: No source is set or the root object has not been created yet.

Definition at line 65 of file QtQuickView.java.

STATUS_READY

final int org.qtproject.qt.android.QtQuickView.STATUS_READY = 1

static

QML loading status: The QML view is loaded and the root object is available. Invoking methods that operate on the QML root object, i.e. setProperty, getProperty, and addSignalListener would succeed only if the current status is ready.

Definition at line 73 of file QtQuickView.java.

---

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

• qtdeclarative/src/quick/jar/org/qtproject/qt/android/QtQuickView.java (e05ccb11db464df76640766f42b13f1d15f07ae9)