summaryrefslogtreecommitdiffstats
path: root/src/imports/localdevice/plugin.cpp
blob: 4ede97116611ccd071934643fe609b292a72234a (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
118
119
120
121
122
123
124
125
126
127
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Device Utilities module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL$
** 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 General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include <qlocaldevice.h>
#include <QtQml>

/*!
    \qmlmodule QtDeviceUtilities.LocalDeviceSettings 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 QtDeviceUtilities.LocalDeviceSettings 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 QtDeviceUtilities.LocalDeviceSettings
    \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
    QtDeviceUtilities.LocalDeviceSettings

    \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) == "QtDeviceUtilities.LocalDeviceSettings");
        qmlRegisterSingletonType<QLocalDevice>(uri, 1, 0, "LocalDevice", module_api_factory);
    }
};

#include "plugin.moc"