summaryrefslogtreecommitdiffstats
path: root/doc/src/bluetooth-qml.qdoc
blob: 57e4cf68bd545c7fdb3f224d7d1947d3c46d5c04 (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
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the documentation of the Qt local connectivty modules.
**
** $QT_BEGIN_LICENSE:FDL$
** GNU Free Documentation License
** 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.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms
** and conditions contained in a signed written agreement between you
** and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/


/*!

\page bluetooth-qml.html

\title Bluetooth QML API
\brief A QML API enabling basic Bluetooth operations like scanning for Devices
and connecting them.

\ingroup qtconnectivity
\ingroup qtconnectivity-qml

The Bluetooth API enables an application to scan for devices and connect and
interact with them in an easier way than the C++ Classes. However, it is a bit
more limited than the C++ API. You can always use the C++ API to create QML
plugins with the flexibility you need.

\tableofcontents

\section1 Getting Started

To import the Bluetooth types, use the following:

\snippet ../doc/src/snippets/doc_src_qtbluetooth.qml import

After importing the Bluetooth API you can use its types. This example shows how to connect to a remote RFCOMM (SPP) server using BluetoothSocket:

\snippet ../doc/src/snippets/doc_src_qtbluetooth.qml service

\section1 QML Types

\list
\annotatedlist bluetooth-qml
\endlist

\section2 Examples

    \table 80%
        \header
            \li Example
            \li Description

        \row
            \li \l{bttennis}{QML Bluetooth Tennis}
            \li The tennis game using a QML interface to the Bluetooth API. It must connect to an
            instance of the C++ \l{bttennis}{Bluetooth Tennis} game to play.
        \row
            \li \l{btscanner}{QML Bluetooth Scanner}
            \li A QML implementation of the Bluetooth device scanner.
    \endtable

*/