org.qtproject.qt.android.QtQuickView Class Reference

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

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

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

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 34 of file QtQuickView.java.

Constructor & Destructor Documentation

QtQuickView() [1/3]

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 64 of file QtQuickView.java.

QtQuickView() [2/3]

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 84 of file QtQuickView.java.

QtQuickView() [3/3]

org.qtproject.qt.android.QtQuickView.QtQuickView ( Context context )

inline

Creates a QtQuickView that can later load and view a QML component by calling loadComponent

Parameters

context

the parent Context

Definition at line 102 of file QtQuickView.java.

Member Function Documentation

createWindow()

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

inlineprotected

Definition at line 172 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 251 of file QtQuickView.java.

getStatus()

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

inline

Gets the status of the QML component.

Returns

Returns QtQmlStatus.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 is QtQmlStatus.READY. It can also return QtQmlStatus.NULL, QtQmlStatus.LOADING, or QtQmlStatus.ERROR based on the status of the underlaying QQuickView instance.

See also

QQuickView

Definition at line 268 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 QML's int, double/float, bool or string

See also

QML int

QML double/float

QML bool

QML string

Definition at line 192 of file QtQuickView.java.

setStatusChangeListener()

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

inline

Sets a QtQmlStatusChangeListener to listen to status changes.

Parameters

listener

an instance of a QtQmlStatusChangeListener interface

Definition at line 278 of file QtQuickView.java.

References org.qtproject.qt.android.QtQmlStatusChangeListener.onStatusChanged().

Here is the call graph for this function:

---

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

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