summaryrefslogtreecommitdiffstats
path: root/examples/corelib/platform/androidnotifier/doc
diff options
context:
space:
mode:
authorAssam Boudjelthia <assam.boudjelthia@qt.io>2021-05-11 20:55:25 +0300
committerAssam Boudjelthia <assam.boudjelthia@qt.io>2021-06-04 22:21:12 +0300
commit107a8058aec8712f228569ac5f0ed5db30318e53 (patch)
treeb6337f662088bfc390798ec8e0a483b6c95508a0 /examples/corelib/platform/androidnotifier/doc
parentc6e13056b57810260ac4099fef6fbdc5ff354824 (diff)
Move notification example from androidextras to qtbase
Refactor android notification example to fit in qtbase. The example demonstrates how to use JNI and work with Java APIs and add custom Java code to a Qt app targeting Android. Task-number: QTBUG-84382 Change-Id: I5fcbbf77b36eb47a0acaa13835ef3d773e63885c Reviewed-by: Rami Potinkara <rami.potinkara@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Ville Voutilainen <ville.voutilainen@qt.io>
Diffstat (limited to 'examples/corelib/platform/androidnotifier/doc')
-rw-r--r--examples/corelib/platform/androidnotifier/doc/images/androidnotifier.pngbin0 -> 48263 bytes
-rw-r--r--examples/corelib/platform/androidnotifier/doc/src/androidnotifier-example.qdoc84
2 files changed, 84 insertions, 0 deletions
diff --git a/examples/corelib/platform/androidnotifier/doc/images/androidnotifier.png b/examples/corelib/platform/androidnotifier/doc/images/androidnotifier.png
new file mode 100644
index 0000000000..36a4a50c47
--- /dev/null
+++ b/examples/corelib/platform/androidnotifier/doc/images/androidnotifier.png
Binary files differ
diff --git a/examples/corelib/platform/androidnotifier/doc/src/androidnotifier-example.qdoc b/examples/corelib/platform/androidnotifier/doc/src/androidnotifier-example.qdoc
new file mode 100644
index 0000000000..b1e4243d56
--- /dev/null
+++ b/examples/corelib/platform/androidnotifier/doc/src/androidnotifier-example.qdoc
@@ -0,0 +1,84 @@
+/****************************************************************************
+**
+** Copyright (C) 2021 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \title Qt Android Notifier
+ \example platform/androidnotifier
+ \brief Demonstrates calling Java code from Qt in an Android application.
+
+ \image androidnotifier.png
+
+ This example demonstrates how to add a custom Java class to an Android
+ application, and how to call it using the JNI convenience APIs in Qt.
+
+ Click on one of the smiley faces to send a notification in the status bar
+ of the Android screen.
+
+ \include examples-run.qdocinc
+
+ \section1 Calling Java Methods from C++ Code
+
+ We define a custom Java class called \c NotificationClient in the
+ NotificationClient.java file:
+
+ \quotefromfile platform/androidnotifier/android/src/org/qtproject/example/androidnotifier/NotificationClient.java
+ \skipto org.qtproject.example.androidnotifier
+ \printuntil /^\}/
+
+ In the NotificationClient C++ class header file, \c notificationclient.h, we
+ declare a simple C++ API to display notifications on an Android device. It
+ consists of a single string property, \c notification, and a slot,
+ \c updateAndroidNotification(), that calls the Java code:
+
+ \snippet platform/androidnotifier/notificationclient.h Qt Notification Class
+
+ We connect the \c notificationChanged() signal to the
+ \c updateAndroidNotification() slot to update the notification text when the
+ \c notification text changes:
+
+ \snippet platform/androidnotifier/notificationclient.cpp notification changed signal
+
+ The \c updateAndroidNotification() function calls the Java method responsible
+ for sending the notification from the Android platform APIs. First, we construct
+ a Java string \c jstring from the notification string, then pass the \c jstring
+ object as a parameter to the \c notify() method in Java:
+
+ \snippet platform/androidnotifier/notificationclient.cpp Send notification message to Java
+
+ The call to the Java meethod use \l QJniObject which relies on the Java Native
+ Interface (JNI) APIs to communicate with Java. Also, in the previous snippet,
+ we are passing the app's context object which the the static Java code can use
+ to tap into the app's specific properties and APIs.
+
+ To make sure our smiley buttons do what they are supposed to, we add the
+ the following code to change the notification text if either of them are
+ clicked:
+
+ \snippet platform/androidnotifier/main.cpp Connect button signals
+
+ \sa {Qt for Android}
+*/