summaryrefslogtreecommitdiffstats
path: root/src/imports/bluetoothsettings/plugin.cpp
blob: db180f7c3d21407f5dd9a59da474b1f2dafa7682 (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
128
129
130
131
132
133
/****************************************************************************
**
** Copyright (C) 2019 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 <QtQml/QQmlExtensionPlugin>
#include <QtQml/qqml.h>
#include <qcoreapplication.h>
#include <QQmlEngine>
#include <QQmlContext>

#include "bluetoothdevice.h"
#include "discoverymodel.h"

/*!
    \qmlmodule QtDeviceUtilities.BluetoothSettings 1.0
    \ingroup qtdevice-utilities-qml-modules
    \ingroup qmlmodules
    \title Qt Bluetooth Settings QML Types

    \brief Provides a singleton QML type for controlling bluetooth settings.

    To import and use the module's QML types, use the following statement:

    \badcode
    import QtDeviceUtilities.BluetoothSettings 1.0
    \endcode

    \note Some functions may not be available on all of the platforms.

    \section1 QML Types
*/

/*!
    \qmltype BtDevice
    \inqmlmodule QtDeviceUtilities.BluetoothSettings
    \brief A singleton QML type for controlling bluetooth settings.

    There is no need to create an instance of this object. To use it,
    simply import the \c {QtDeviceUtilities.BluetoothSettings} module.
*/

/*!
    \qmlproperty bool BtDevice::scanning

    Controls whether the Bluetooth device is scanning for remote devices.
*/

/*!
    \qmlproperty bool BtDevice::powered

    Powers the Bluetooth device on or off.
*/

/*!
    \qmlproperty object BtDevice::deviceModel
    \readonly

    Holds the device model.
*/

/*!
    \qmlmethod void BtDevice::requestPairing(string address)

    Starts the process of pairing to a remove device specified by \a address,
    and connects to it if the pairing was successful.
*/

/*!
    \qmlmethod void BtDevice::requestConnect(string address)

    Connects to a remove device specified by \a address.

    \sa requestDisconnect()
*/

/*!
    \qmlmethod void BtDevice::requestDisconnect(string address)

    Disconnects from the remove device specified by \a address.

    \sa requestConnect()
*/

QT_BEGIN_NAMESPACE

template <typename T>
QObject *instance(QQmlEngine *engine, QJSEngine *) {
    T *t = new T(engine);
    t->setObjectName(T::staticMetaObject.className());
    return t;
}

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

public:
    void registerTypes(const char *uri)
    {
        Q_ASSERT(QLatin1String(uri) == QLatin1String("QtDeviceUtilities.BluetoothSettings"));
        qmlRegisterUncreatableType<BtDeviceItem>(uri, 1, 0, "BtDeviceItem", "Cannot be instantiated directly.");
        qmlRegisterSingletonType<BluetoothDevice>(uri, 1, 0, "BtDevice", &instance<BluetoothDevice>);
    }
};

QT_END_NAMESPACE

#include "plugin.moc"