summaryrefslogtreecommitdiffstats
path: root/src/imports
diff options
context:
space:
mode:
Diffstat (limited to 'src/imports')
-rw-r--r--src/imports/utils/plugin.cpp115
-rw-r--r--src/imports/utils/qmldir4
-rw-r--r--src/imports/utils/utils.pro10
3 files changed, 114 insertions, 15 deletions
diff --git a/src/imports/utils/plugin.cpp b/src/imports/utils/plugin.cpp
index cc96fb0..4012e96 100644
--- a/src/imports/utils/plugin.cpp
+++ b/src/imports/utils/plugin.cpp
@@ -16,32 +16,135 @@
** the contact form at http://www.qt.io
**
****************************************************************************/
-#include <QtDroidUtils/qdroidutils.h>
+#include <b2qtdevice.h>
#include <QtQml>
+/*!
+ \qmlmodule B2Qt.Utils 1.0
+ \title B2Qt Utils Module
+ \ingroup qtee-qmlmodules
+ \brief A collection of utility functions, accessible from QML.
+
+ Provides various utility functions for controlling an embedded
+ device, such as display brightness, IP address and hostname, and
+ device shutdown/reboot.
+
+ Import the module as follows:
+
+ \badcode
+ import B2Qt.Utils 1.0
+ \endcode
+
+ This will give you access to the singleton QML type B2QtDevice.
+
+ \note Some functions are currently only implemented for one of
+ the platforms.
+
+ \section1 QML Types
+*/
+
+/*!
+ \qmltype B2QtDevice
+ \inqmlmodule B2Qt.Utils
+ \ingroup utils-qmltypes
+ \brief Singleton QML type providing access to utility functions.
+
+ B2QtDevice QML type is the interface to various utility
+ functions.
+
+ There is no need to create an instance of this object. To use it,
+ simply import the \c {B2Qt.Utils} module:
+
+ \qml
+ import B2Qt.Utils 1.0
+
+ Text {
+ text: qsTr("IP Address:") + B2QtDevice.ipAddress
+ }
+ \endqml
+
+ \note Some functions are currently only implemented for one of
+ the platforms.
+*/
+
+/*!
+ \qmlmethod B2Qt.Utils::B2QtDevice::reboot()
+
+ Reboots the system. Does not return.
+
+ \sa powerOff()
+*/
+
+/*!
+ \qmlmethod B2Qt.Utils::B2QtDevice::powerOff()
+
+ Shuts down the system. Does not return.
+
+ \sa reboot()
+*/
+
+/*!
+ \qmlproperty int B2Qt.Utils::B2QtDevice::masterVolume
+
+ This property holds the master volume of the device.
+ The volume can range from \c 0 to \c 100 and is linear.
+ Changing the master volume will affect all audio streams.
+
+ \note Currently implemented only for \B2QA.
+*/
+
+/*!
+ \qmlproperty int B2Qt.Utils::B2QtDevice::displayBrightness
+ This property holds the display brightness (the intensity of the backlight).
+ The value is in the range from \c 0 to \c 255, where 255 is the maximum
+ brightness, and 0 is the minimum (typically, the backlight is turned off).
+
+ \note Currently implemented only for \B2QA.
+*/
+
+/*!
+ \qmlproperty string B2Qt.Utils::B2QtDevice::ipAddress
+ \readonly
+
+ This property holds the current IP address(es) of the device
+ for all active network interfaces. If multiple IP addresses are defined,
+ this property holds a comma-separated list. The localhost (loopback)
+ IP addresses are omitted.
+
+ \sa hostname
+*/
+
+/*!
+ \qmlproperty string B2Qt.Utils::B2QtDevice::hostname
+
+ This property holds the current hostname of the device.
+
+ \sa ipAddress
+*/
+
static QObject *module_api_factory(QQmlEngine *engine, QJSEngine *scriptEngine)
{
Q_UNUSED(engine)
Q_UNUSED(scriptEngine)
- QDroidUtils *api = new QDroidUtils();
+ B2QtDevice *api = new B2QtDevice();
return api;
}
-class QDroidUtilsPlugin : public QQmlExtensionPlugin
+class B2QtUtilsPlugin : public QQmlExtensionPlugin
{
Q_OBJECT
Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QQmlExtensionInterface")
public:
- QDroidUtilsPlugin()
+ B2QtUtilsPlugin()
{
}
void registerTypes(const char *uri)
{
- Q_ASSERT(QLatin1String(uri) == "QtDroid.Utils");
- qmlRegisterSingletonType<QDroidUtils>(uri, 1, 0, "DroidUtils", module_api_factory);
+ Q_ASSERT(QLatin1String(uri) == "B2Qt.Utils");
+ qmlRegisterSingletonType<B2QtDevice>(uri, 1, 0, "B2QtDevice", module_api_factory);
}
};
diff --git a/src/imports/utils/qmldir b/src/imports/utils/qmldir
index 6db1b0f..e5e0b31 100644
--- a/src/imports/utils/qmldir
+++ b/src/imports/utils/qmldir
@@ -1,3 +1,3 @@
-module QtDroid.Utils
-plugin qtdroidutilsplugin
+module B2Qt.Utils
+plugin b2qtutilsplugin
typeinfo plugins.qmltypes
diff --git a/src/imports/utils/utils.pro b/src/imports/utils/utils.pro
index a589b46..a580643 100644
--- a/src/imports/utils/utils.pro
+++ b/src/imports/utils/utils.pro
@@ -1,14 +1,10 @@
CXX_MODULE = qml
-TARGET = qtdroidutilsplugin
-TARGETPATH = QtDroid/Utils
+TARGET = b2qtutilsplugin
+TARGETPATH = B2Qt/Utils
IMPORT_VERSION = 1.0
-QT += qml
+QT += qml b2qtutils
SOURCES += plugin.cpp
-### kludge
-INCLUDEPATH += $$PWD/../../../include
-LIBS += -L$$PWD/../../../lib -lQt5DroidUtils
-
load(qml_plugin)