aboutsummaryrefslogtreecommitdiffstats
path: root/src/androidextras/jni
diff options
context:
space:
mode:
Diffstat (limited to 'src/androidextras/jni')
-rw-r--r--src/androidextras/jni/qandroidjniobject.cpp39
-rw-r--r--src/androidextras/jni/qandroidjniobject.h8
2 files changed, 45 insertions, 2 deletions
diff --git a/src/androidextras/jni/qandroidjniobject.cpp b/src/androidextras/jni/qandroidjniobject.cpp
index 2448d54..43e6e70 100644
--- a/src/androidextras/jni/qandroidjniobject.cpp
+++ b/src/androidextras/jni/qandroidjniobject.cpp
@@ -464,12 +464,22 @@ QT_BEGIN_NAMESPACE
\fn QAndroidJniObject QAndroidJniObject::getObjectField(const char *fieldName) const
Retrieves the object of field \a fieldName.
+
+ \code
+ QAndroidJniObject field = jniObject.getObjectField<jstring>("FIELD_NAME");
+ \endcode
*/
/*!
\fn QAndroidJniObject QAndroidJniObject::getObjectField(const char *fieldName, const char *signature) const
Retrieves the object from the field with \a signature and \a fieldName.
+
+ \note Since \b{Qt 5.3} this function can be used without a template type.
+
+ \code
+ QAndroidJniObject field = jniObject.getObjectField("FIELD_NAME", "Ljava/lang/String;");
+ \endcode
*/
/*!
@@ -488,24 +498,42 @@ QT_BEGIN_NAMESPACE
\fn QAndroidJniObject QAndroidJniObject::getStaticObjectField(const char *className, const char *fieldName)
Retrieves the object from the field \a fieldName on the class \a className.
+
+ \code
+ QAndroidJniObject jobj = QAndroidJniObject::getStaticObjectField<jstring>("class/with/Fields", "FIELD_NAME");
+ \endcode
*/
/*!
\fn QAndroidJniObject QAndroidJniObject::getStaticObjectField(const char *className, const char *fieldName, const char *signature)
-
Retrieves the object from the field with \a signature and \a fieldName on class \a className.
+
+ \note Since \b{Qt 5.3} this function can be used without a template type.
+
+ \code
+ QAndroidJniObject jobj = QAndroidJniObject::getStaticObjectField("class/with/Fields", "FIELD_NAME", "Ljava/lang/String;");
+ \endcode
*/
/*!
\fn QAndroidJniObject QAndroidJniObject::getStaticObjectField(jclass clazz, const char *fieldName)
Retrieves the object from the field \a fieldName on \a clazz.
+
+ \code
+ QAndroidJniObject jobj = QAndroidJniObject::getStaticObjectField<jstring>(clazz, "FIELD_NAME");
+ \endcode
*/
/*!
\fn QAndroidJniObject QAndroidJniObject::getStaticObjectField(jclass clazz, const char *fieldName, const char *signature)
-
Retrieves the object from the field with \a signature and \a fieldName on \a clazz.
+
+ \note Since \b{Qt 5.3} this function can be used without a template type.
+
+ \code
+ QAndroidJniObject jobj = QAndroidJniObject::getStaticObjectField(clazz, "FIELD_NAME", "Ljava/lang/String;");
+ \endcode
*/
/*!
@@ -602,6 +630,13 @@ QT_BEGIN_NAMESPACE
free it yourself.
\snippet code/src_androidextras_qandroidjniobject.cpp QAndroidJniObject scope
+
+ \note Since \b{Qt 5.3} this function can be used without a template type, if the returned type
+ is a \c jobject.
+
+ \code
+ jobject object = jniObject.object();
+ \endcode
*/
/*!
diff --git a/src/androidextras/jni/qandroidjniobject.h b/src/androidextras/jni/qandroidjniobject.h
index a1eb4fd..9d880fa 100644
--- a/src/androidextras/jni/qandroidjniobject.h
+++ b/src/androidextras/jni/qandroidjniobject.h
@@ -64,7 +64,9 @@ public:
template <typename T>
inline T object() const { return static_cast<T>(javaObject()); }
+#ifndef Q_QDOC
inline jobject object() const { return javaObject(); }
+#endif // Q_QDOC
template <typename T>
T callMethod(const char *methodName) const;
@@ -98,9 +100,11 @@ public:
T getField(const char *fieldName) const;
template <typename T>
QAndroidJniObject getObjectField(const char *fieldName) const;
+#ifndef Q_QDOC
// ### Qt 6 remove templated version
template <typename T>
QAndroidJniObject getObjectField(const char *fieldName, const char *sig) const;
+#endif // Q_QDOC
QAndroidJniObject getObjectField(const char *fieldName, const char *sig) const;
template <typename T>
void setField(const char *fieldName, T value);
@@ -108,11 +112,13 @@ public:
void setField(const char *fieldName, const char *sig, T value);
template <typename T>
static QAndroidJniObject getStaticObjectField(const char *className, const char *fieldName);
+#ifndef Q_QDOC
// ### Qt 6 remove templated version
template <typename T>
static QAndroidJniObject getStaticObjectField(const char *className,
const char *fieldName,
const char *sig);
+#endif // Q_QDOC
static QAndroidJniObject getStaticObjectField(const char *className,
const char *fieldName,
const char *sig);
@@ -120,11 +126,13 @@ public:
static T getStaticField(const char *className, const char *fieldName);
template <typename T>
static QAndroidJniObject getStaticObjectField(jclass clazz, const char *fieldName);
+#ifndef Q_QDOC
// ### Qt 6 remove templated version
template <typename T>
static QAndroidJniObject getStaticObjectField(jclass clazz,
const char *fieldName,
const char *sig);
+#endif // Q_QDOC
static QAndroidJniObject getStaticObjectField(jclass clazz,
const char *fieldName,
const char *sig);