QtAndroidPrivate Namespace Reference

\preliminary \inmodule QtCorePrivate More...

Classes
class	ActivityResultListener
class	NewIntentListener
class	OnBindListener
class	ResumePauseListener

Enumerations
enum class	BindFlag {   None = 0x00000000 , AutoCreate = 0x00000001 , DebugUnbind = 0x00000002 , NotForeground = 0x00000004 ,   AboveClient = 0x00000008 , AllowOomManagement = 0x00000010 , WaivePriority = 0x00000020 , Important = 0x00000040 ,   AdjustWithActivity = 0x00000080 , ExternalService = -2147483648 }

Functions
Q_CORE_EXPORT QtJniTypes::Activity	activity ()
Q_CORE_EXPORT QtJniTypes::Service	service ()
Q_CORE_EXPORT QtJniTypes::Context	context ()
Q_CORE_EXPORT JavaVM *	javaVM ()
Q_CORE_EXPORT jint	initJNI (JavaVM *vm, JNIEnv *env)
Q_CORE_EXPORT jclass	findClass (const char *className, JNIEnv *env)
jobject	classLoader ()
Q_CORE_EXPORT jint	androidSdkVersion ()
bool	registerPermissionNatives (QJniEnvironment &env)
bool	registerNativeInterfaceNatives (QJniEnvironment &env)
	Posts the function runnable to the Android thread.
bool	registerExtrasNatives (QJniEnvironment &env)
Q_CORE_EXPORT void	handleActivityResult (jint requestCode, jint resultCode, jobject data)
Q_CORE_EXPORT void	registerActivityResultListener (ActivityResultListener *listener)
Q_CORE_EXPORT void	unregisterActivityResultListener (ActivityResultListener *listener)
Q_CORE_EXPORT void	handleNewIntent (JNIEnv *env, jobject intent)
Q_CORE_EXPORT void	registerNewIntentListener (NewIntentListener *listener)
Q_CORE_EXPORT void	unregisterNewIntentListener (NewIntentListener *listener)
Q_CORE_EXPORT void	handlePause ()
Q_CORE_EXPORT void	handleResume ()
Q_CORE_EXPORT void	registerResumePauseListener (ResumePauseListener *listener)
Q_CORE_EXPORT void	unregisterResumePauseListener (ResumePauseListener *listener)
Q_CORE_EXPORT void	waitForServiceSetup ()
Q_CORE_EXPORT int	acuqireServiceSetup (int flags)
Q_CORE_EXPORT void	setOnBindListener (OnBindListener *listener)
Q_CORE_EXPORT jobject	callOnBindListener (jobject intent)
Q_CORE_EXPORT bool	acquireAndroidDeadlockProtector ()
Q_CORE_EXPORT void	releaseAndroidDeadlockProtector ()
Q_CORE_EXPORT void	startIntentSender (const QJniObject &intentSender, int receiverRequestCode, QAndroidActivityResultReceiver *resultReceiver=nullptr)
Q_CORE_EXPORT void	startActivity (const QJniObject &intent, int receiverRequestCode, QAndroidActivityResultReceiver *resultReceiver=nullptr)
Q_CORE_EXPORT void	startActivity (const QAndroidIntent &intent, int receiverRequestCode, QAndroidActivityResultReceiver *resultReceiver=nullptr)
Q_CORE_EXPORT void	startActivity (const QJniObject &intent, int receiverRequestCode, std::function< void(int, int, const QJniObject &data)> callbackFunc)
Q_CORE_EXPORT bool	bindService (const QAndroidIntent &serviceIntent, const QAndroidServiceConnection &serviceConnection, BindFlags flags=BindFlag::None)

Detailed Description

\preliminary \inmodule QtCorePrivate

Since

6.2

The QtAndroidPrivate namespace provides miscellaneous functions to aid Android development. \inheaderfile QtCore/private/qandroidextras_p.h

qtcoreprivate-usage

Enumeration Type Documentation

BindFlag

enum class QtAndroidPrivate::BindFlag

strong

Since

6.2

This enum is used with QtAndroidPrivate::bindService to describe the mode in which the binding is performed.

\value None No options. \value AutoCreate Automatically creates the service as long as the binding exist. See \l {https://developer.android.com/reference/android/content/Context.html#BIND_AUTO_CREATE} {BIND_AUTO_CREATE} documentation for more details. \value DebugUnbind Include debugging help for mismatched calls to unbind. See \l {https://developer.android.com/reference/android/content/Context.html#BIND_DEBUG_UNBIND} {BIND_DEBUG_UNBIND} documentation for more details. \value NotForeground Don't allow this binding to raise the target service's process to the foreground scheduling priority. See \l {https://developer.android.com/reference/android/content/Context.html#BIND_NOT_FOREGROUND} {BIND_NOT_FOREGROUND} documentation for more details. \value AboveClient Indicates that the client application binding to this service considers the service to be more important than the app itself. See \l {https://developer.android.com/reference/android/content/Context.html#BIND_ABOVE_CLIENT} {BIND_ABOVE_CLIENT} documentation for more details. \value AllowOomManagement Allow the process hosting the bound service to go through its normal memory management. See \l {https://developer.android.com/reference/android/content/Context.html#BIND_ALLOW_OOM_MANAGEMENT} {BIND_ALLOW_OOM_MANAGEMENT} documentation for more details. \value WaivePriority Don't impact the scheduling or memory management priority of the target service's hosting process. See \l {https://developer.android.com/reference/android/content/Context.html#BIND_WAIVE_PRIORITY} {BIND_WAIVE_PRIORITY} documentation for more details. \value Important This service is assigned a higher priority so that it is available to the client when needed. See \l {https://developer.android.com/reference/android/content/Context.html#BIND_IMPORTANT} {BIND_IMPORTANT} documentation for more details. \value AdjustWithActivity If binding from an activity, allow the target service's process importance to be raised based on whether the activity is visible to the user. See \l {https://developer.android.com/reference/android/content/Context.html#BIND_ADJUST_WITH_ACTIVITY} {BIND_ADJUST_WITH_ACTIVITY} documentation for more details. \value ExternalService The service being bound is an isolated, external service. See \l {https://developer.android.com/reference/android/content/Context.html#BIND_EXTERNAL_SERVICE} {BIND_EXTERNAL_SERVICE} documentation for more details.

Enumerator
None
AutoCreate
DebugUnbind
NotForeground
AboveClient
AllowOomManagement
WaivePriority
Important
AdjustWithActivity
ExternalService

Definition at line 208 of file qandroidextras_p.h.

Function Documentation

acquireAndroidDeadlockProtector()

bool QtAndroidPrivate::acquireAndroidDeadlockProtector

(

)

Definition at line 341 of file qjnihelpers.cpp.

References g_androidDeadlockProtector.

Referenced by AndroidDeadlockProtector::acquire(), and requestPermissionsInternal().

Here is the caller graph for this function:

activity()

QtJniTypes::Activity QtAndroidPrivate::activity

(

)

Definition at line 267 of file qjnihelpers.cpp.

References g_jActivity.

Referenced by QAndroidPlatformIntegration::QAndroidPlatformIntegration(), QAndroidPlatformIntegration::createOffscreenSurface(), QAndroidPlatformIntegration::createPlatformBackingStore(), QAndroidPlatformIntegration::createPlatformOffscreenSurface(), QAndroidPlatformIntegration::hasCapability(), initJNI(), QtAndroid::isQtApplication(), QtAndroid::qtActivityDelegate(), requestPermissionsInternal(), QtAndroidInput::showSoftwareKeyboard(), startActivity(), startActivity(), startIntentSender(), and QtAndroidInput::updateHandles().

Here is the caller graph for this function:

acuqireServiceSetup()

int QtAndroidPrivate::acuqireServiceSetup

(

int

flags

)

Definition at line 317 of file qjnihelpers.cpp.

References g_serviceSetupLockers.

androidSdkVersion()

jint QtAndroidPrivate::androidSdkVersion

(

)

Definition at line 304 of file qjnihelpers.cpp.

Referenced by nativeBluetoothPermission(), nativeLocationPermission(), QAndroidSystemLocale::query(), QtAndroidAccessibility::registerNatives(), registerPermissionNatives(), and requestPermissionsInternal().

Here is the caller graph for this function:

bindService()

bool QtAndroidPrivate::bindService	(	const QAndroidIntent &	serviceIntent,
		const QAndroidServiceConnection &	serviceConnection,
		BindFlags	flags = BindFlag::None )

Since

6.2

Binds the service given by serviceIntent, serviceConnection and flags. The serviceIntent object identifies the service to connect to. The serviceConnection is a listener that receives the information as the service is started and stopped.

Returns

true on success

See \l {https://developer.android.com/reference/android/content/Context.html#bindService%28android.content.Intent,%20android.content.ServiceConnection,%20int%29} {Android documentation} documentation for more details.

See also

QAndroidIntent, QAndroidServiceConnection, BindFlag

Definition at line 1023 of file qandroidextras.cpp.

References context().

Here is the call graph for this function:

callOnBindListener()

jobject QtAndroidPrivate::callOnBindListener

(

jobject

intent

)

Definition at line 331 of file qjnihelpers.cpp.

References g_onBindListener, g_onBindListenerMutex, and lock.

Referenced by onBind().

Here is the caller graph for this function:

classLoader()

jobject QtAndroidPrivate::classLoader

(

)

Definition at line 299 of file qjnihelpers.cpp.

References g_jClassLoader.

Referenced by findClass(), and initJNI().

Here is the caller graph for this function:

context()

QtJniTypes::Context QtAndroidPrivate::context

(

)

Definition at line 283 of file qjnihelpers.cpp.

References g_jActivity, and g_jService.

Referenced by QAndroidPlatformClipboard::QAndroidPlatformClipboard(), QAndroidPlatformIntegration::QAndroidPlatformIntegration(), QAndroidPlatformServices::QAndroidPlatformServices(), bindService(), and FontProvider::fetchFont().

Here is the caller graph for this function:

findClass()

jclass QtAndroidPrivate::findClass	(	const char *	className,
		JNIEnv *	env )

className must be slash-encoded

Definition at line 364 of file qjniobject.cpp.

References classLoader(), className, QSet< T >::constEnd(), QSet< T >::constFind(), QString::fromLatin1(), getCachedClass(), it, Q_ASSERT, and qWarning.

Here is the call graph for this function:

handleActivityResult()

void QtAndroidPrivate::handleActivityResult	(	jint	requestCode,
		jint	resultCode,
		jobject	data )

Definition at line 101 of file qjnihelpers.cpp.

References i, listeners, and mutex.

Referenced by onActivityResult().

Here is the caller graph for this function:

handleNewIntent()

void QtAndroidPrivate::handleNewIntent	(	JNIEnv *	env,
		jobject	intent )

Definition at line 134 of file qjnihelpers.cpp.

References i, listeners, and mutex.

Referenced by onNewIntent().

Here is the caller graph for this function:

handlePause()

void QtAndroidPrivate::handlePause

(

)

Definition at line 167 of file qjnihelpers.cpp.

References i, listeners, and mutex.

Referenced by QtAndroid::setAndroidPlatformIntegration(), and updateApplicationState().

Here is the caller graph for this function:

handleResume()

void QtAndroidPrivate::handleResume

(

)

Definition at line 175 of file qjnihelpers.cpp.

References i, listeners, and mutex.

Referenced by QtAndroid::setAndroidPlatformIntegration(), and updateApplicationState().

Here is the caller graph for this function:

initJNI()

jint QtAndroidPrivate::initJNI	(	JavaVM *	vm,
		JNIEnv *	env )

Definition at line 183 of file qjnihelpers.cpp.

References activity(), classLoader(), g_jActivity, g_javaVM, g_jClassLoader, g_jService, methods, registerExtrasNatives(), registerNativeInterfaceNatives(), registerPermissionNatives(), service(), and updateNativeActivity().

Referenced by JNI_OnLoad().

Here is the call graph for this function:

Here is the caller graph for this function:

javaVM()

JavaVM * QtAndroidPrivate::javaVM

(

)

Definition at line 294 of file qjnihelpers.cpp.

References g_javaVM.

Referenced by QJniEnvironmentPrivateTLS::~QJniEnvironmentPrivateTLS().

Here is the caller graph for this function:

registerActivityResultListener()

void QtAndroidPrivate::registerActivityResultListener

(

ActivityResultListener *

listener

)

Definition at line 89 of file qjnihelpers.cpp.

References mutex.

Referenced by QAndroidActivityResultReceiver::QAndroidActivityResultReceiver(), and QtAndroidFileDialogHelper::QAndroidPlatformFileDialogHelper::show().

Here is the caller graph for this function:

registerExtrasNatives()

bool QtAndroidPrivate::registerExtrasNatives

(

QJniEnvironment &

env

)

Definition at line 704 of file qandroidextras.cpp.

References methods, onServiceConnected(), onServiceDisconnected(), and onTransact().

Referenced by initJNI().

Here is the call graph for this function:

Here is the caller graph for this function:

registerNativeInterfaceNatives()

bool QtAndroidPrivate::registerNativeInterfaceNatives

(

QJniEnvironment &

env

)

Posts the function runnable to the Android thread.

The function will be queued and executed on the Android UI thread. If the call is made on the Android UI thread runnable will be executed immediately. If the Android app is paused or the main Activity is null, runnable is added to the Android main thread's queue.

This call returns a QFuture<QVariant> which allows doing both synchronous and asynchronous calls, and can handle any return type. However, to get a result back from the QFuture::result(), QVariant::value() should be used.

If the runnable execution takes longer than the period of timeout, the blocking calls \l QFuture::waitForFinished() and \l QFuture::result() are ended once timeout has elapsed. However, if runnable has already started execution, it won't be cancelled.

The following example shows how to run an asynchronous call that expects a return type:

auto task = QNativeInterface::QAndroidApplication::runOnAndroidMainThread([=]() {
    QJniObject surfaceView;
    if (!surfaceView.isValid())
        qDebug() << "SurfaceView object is not valid yet";
 
    surfaceView = QJniObject("android/view/SurfaceView",
                             "(Landroid/content/Context;)V",
                             QNativeInterface::QAndroidApplication::context());
 
    return QVariant::fromValue(surfaceView);
}).then([](QFuture<QVariant> future) {
    auto surfaceView = future.result().value<QJniObject>();
    if (surfaceView.isValid())
        qDebug() << "Retrieved SurfaceView object is valid";
});

The following example shows how to run a synchronous call with a void return type:

QNativeInterface::QAndroidApplication::runOnAndroidMainThread([]() {
   QJniObject activity = QNativeInterface::QAndroidApplication::context();
   // Hide system ui elements or go full screen
   activity.callObjectMethod("getWindow", "()Landroid/view/Window;")
           .callObjectMethod("getDecorView", "()Landroid/view/View;")
           .callMethod<void>("setSystemUiVisibility", "(I)V", 0xffffffff);
}).waitForFinished();

Note

Becareful about the type of operations you do on the Android's main thread, as any long operation can block the app's UI rendering and input handling. If the function is expected to have long execution time, it's also good to use a \l QDeadlineTimer in your runnable to manage the execution and make sure it doesn't block the UI thread. Usually, any operation longer than 5 seconds might block the app's UI. For more information, see \l {Android: Keeping your app responsive}{Keeping your app responsive}.

Since

6.2

Definition at line 233 of file qandroidnativeinterface.cpp.

References methods, and qtNativeClassName.

Referenced by initJNI().

Here is the caller graph for this function:

registerNewIntentListener()

void QtAndroidPrivate::registerNewIntentListener

(

NewIntentListener *

listener

)

Definition at line 122 of file qjnihelpers.cpp.

References mutex.

Referenced by QAndroidPlatformServices::QAndroidPlatformServices(), and QMainNfcNewIntentListener::QMainNfcNewIntentListener().

Here is the caller graph for this function:

registerPermissionNatives()

bool QtAndroidPrivate::registerPermissionNatives

(

QJniEnvironment &

env

)

Definition at line 1212 of file qandroidextras.cpp.

References androidSdkVersion(), methods, qtNativeClassName, and sendRequestPermissionsResult().

Referenced by initJNI().

Here is the call graph for this function:

Here is the caller graph for this function:

registerResumePauseListener()

void QtAndroidPrivate::registerResumePauseListener

(

ResumePauseListener *

listener

)

Definition at line 155 of file qjnihelpers.cpp.

References mutex.

Referenced by QMainNfcNewIntentListener::QMainNfcNewIntentListener().

Here is the caller graph for this function:

releaseAndroidDeadlockProtector()

void QtAndroidPrivate::releaseAndroidDeadlockProtector

(

)

Definition at line 346 of file qjnihelpers.cpp.

References g_androidDeadlockProtector.

Referenced by AndroidDeadlockProtector::~AndroidDeadlockProtector().

Here is the caller graph for this function:

service()

QtJniTypes::Service QtAndroidPrivate::service

(

)

Definition at line 278 of file qjnihelpers.cpp.

References g_jService.

Referenced by QAndroidPlatformIntegration::QAndroidPlatformIntegration(), initJNI(), QtAndroid::isQtApplication(), and waitForServiceSetup().

Here is the caller graph for this function:

setOnBindListener()

void QtAndroidPrivate::setOnBindListener

(

QtAndroidPrivate::OnBindListener *

listener

)

Definition at line 323 of file qjnihelpers.cpp.

References g_onBindListener, g_onBindListenerMutex, g_serviceSetupLockers, and lock.

startActivity() [1/3]

void QtAndroidPrivate::startActivity	(	const QAndroidIntent &	intent,
		int	receiverRequestCode,
		QAndroidActivityResultReceiver *	resultReceiver = nullptr )

Since

6.2

Starts the activity given by intent and provides the result asynchronously through the resultReceiver if this is non-null.

If resultReceiver is null, then the startActivity() method in the androidActivity() will be called. Otherwise startActivityForResult() will be called.

The receiverRequestCode is a request code unique to the resultReceiver, and will be returned along with the result, making it possible to use the same receiver for more than one intent.

Definition at line 941 of file qandroidextras.cpp.

References startActivity().

Here is the call graph for this function:

startActivity() [2/3]

void QtAndroidPrivate::startActivity	(	const QJniObject &	intent,
		int	receiverRequestCode,
		QAndroidActivityResultReceiver *	resultReceiver = nullptr )

Since

6.2

Starts the activity given by intent and provides the result asynchronously through the resultReceiver if this is non-null.

If resultReceiver is null, then the startActivity() method in the androidActivity() will be called. Otherwise startActivityForResult() will be called.

The receiverRequestCode is a request code unique to the resultReceiver, and will be returned along with the result, making it possible to use the same receiver for more than one intent.

Definition at line 908 of file qandroidextras.cpp.

References activity(), and QAndroidActivityResultReceiverPrivate::get().

Referenced by startActivity(), and startActivity().

Here is the call graph for this function:

Here is the caller graph for this function:

startActivity() [3/3]

void QtAndroidPrivate::startActivity	(	const QJniObject &	intent,
		int	receiverRequestCode,
		std::function< void(int, int, const QJniObject &data)>	callbackFunc )

Since

6.2

Starts the activity given by intent, using the request code receiverRequestCode, and provides the result by calling callbackFunc.

Definition at line 954 of file qandroidextras.cpp.

References activity(), QAndroidActivityCallbackResultReceiver::instance(), and startActivity().

Here is the call graph for this function:

startIntentSender()

void QtAndroidPrivate::startIntentSender	(	const QJniObject &	intentSender,
		int	receiverRequestCode,
		QAndroidActivityResultReceiver *	resultReceiver = nullptr )

Since

6.2

Starts the activity given by intentSender and provides the result asynchronously through the resultReceiver if this is non-null.

If resultReceiver is null, then the startIntentSender() method in the androidActivity() will be called. Otherwise startIntentSenderForResult() will be called.

The receiverRequestCode is a request code unique to the resultReceiver, and will be returned along with the result, making it possible to use the same receiver for more than one intent.

Definition at line 978 of file qandroidextras.cpp.

References activity(), and QAndroidActivityResultReceiverPrivate::get().

Here is the call graph for this function:

unregisterActivityResultListener()

void QtAndroidPrivate::unregisterActivityResultListener

(

ActivityResultListener *

listener

)

Definition at line 95 of file qjnihelpers.cpp.

References mutex.

Referenced by QAndroidActivityResultReceiver::~QAndroidActivityResultReceiver(), and QtAndroidFileDialogHelper::QAndroidPlatformFileDialogHelper::hide().

Here is the caller graph for this function:

unregisterNewIntentListener()

void QtAndroidPrivate::unregisterNewIntentListener

(

NewIntentListener *

listener

)

Definition at line 128 of file qjnihelpers.cpp.

References mutex.

Referenced by QMainNfcNewIntentListener::~QMainNfcNewIntentListener().

Here is the caller graph for this function:

unregisterResumePauseListener()

void QtAndroidPrivate::unregisterResumePauseListener

(

ResumePauseListener *

listener

)

Definition at line 161 of file qjnihelpers.cpp.

References mutex.

Referenced by QMainNfcNewIntentListener::~QMainNfcNewIntentListener().

Here is the caller graph for this function:

waitForServiceSetup()

void QtAndroidPrivate::waitForServiceSetup

(

)

Definition at line 312 of file qjnihelpers.cpp.

Referenced by waitForServiceSetup().

Here is the caller graph for this function: