summaryrefslogtreecommitdiffstats
path: root/src/imports/localdevice/plugin.cpp
blob: b69d9b45a15d982e7da24f0ff9b13f59d7f0e5ae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc
** All rights reserved.
** For any questions to Digia, please use the contact form at
** http://www.qt.io
**
** This file is part of Qt Enterprise Embedded.
**
** Licensees holding valid Qt Enterprise licenses may use this file in
** accordance with the Qt Enterprise License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.
**
** If you have questions regarding the use of this file, please use
** the contact form at http://www.qt.io
**
****************************************************************************/
#include <qlocaldevice.h>
#include <QtQml>

/*!
    \qmlmodule com.theqtcompany.localdevice 1.0
    \title Qt Local Device QML Module
    \ingroup qtee-qmlmodules
    \brief A collection of the local device related utility functions, accessible from QML.
*/

/*!
    \page b2qt-addon-utils.html
    \title Qt Local Device Module
    \ingroup qtee-modules
    \brief A collection of the local device realted utility functions, accessible from QML.

    Provides utility functions for controlling an embedded
    device, such as device shutdown/reboot.

    Import the module as follows:

    \badcode
    import com.theqtcompany.localdevice 1.0
    \endcode

    This will give you access to the singleton QML type LocalDevice.

    \note Some functions are currently only implemented for one of
          the platforms.

    \section1 QML Types

    \annotatedlist utils-qmltypes
*/

/*!
    \qmltype LocalDevice
    \inqmlmodule com.theqtcompany.localdevice
    \ingroup utils-qmltypes
    \brief Singleton QML type providing access to utility functions.

    LocalDevice 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 {LocalDevice} module:

    \qml
    com.theqtcompany.localdevice

    \endqml

    \note Some functions are currently only implemented for one of
          the platforms.
*/

/*!
    \qmlmethod LocalDevice::reboot()

    Reboots the system. Does not return.

    \sa powerOff()
*/

/*!
    \qmlmethod LocalDevice::powerOff()

    Shuts down the system. Does not return.

    \sa reboot()
*/

static QObject *module_api_factory(QQmlEngine *engine, QJSEngine *scriptEngine)
{
   Q_UNUSED(engine)
   Q_UNUSED(scriptEngine)
   QLocalDevice *api = new QLocalDevice();

   return api;
}

class B2QtUtilsPlugin : public QQmlExtensionPlugin
{
    Q_OBJECT
    Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QQmlExtensionInterface")

public:
    B2QtUtilsPlugin()
    {
    }

    void registerTypes(const char *uri)
    {
        Q_ASSERT(QLatin1String(uri) == "com.theqtcompany.localdevice");
        qmlRegisterSingletonType<QLocalDevice>(uri, 1, 0, "LocalDevice", module_api_factory);
    }
};

#include "plugin.moc"