aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference/modules/qt-dbus-module.qdoc
blob: dacf3f095a07d1395b600510cc5c56f78f0e82d3 (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
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qbs.
**
** $QT_BEGIN_LICENSE:FDL$
** 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 Free Documentation License Usage
** 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. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \contentspage index.html
    \qmltype Qt.dbus
    \inqmlmodule QbsModules
    \brief Provides Qt D-Bus support.

    The Qt.dbus module provides support for the Qt D-Bus module, which contains
    classes for inter-process communication over the D-Bus protocol.

    \section2 Relevant File Tags
    \target filetags-debus

    \table
    \header
        \li Tag
        \li Auto-tagged File Names
        \li Since
        \li Description
    \row
        \li \c{"qt.dbus.adaptor"}
        \li -
        \li 1.5
        \li Source files with this tag serve as inputs to the rule running the
            \c qdbusxml2cpp tool, which will create an adaptor class.
    \row
        \li \c{"qt.dbus.interface"}
        \li -
        \li 1.5
        \li Source files with this tag serve as inputs to the rule running the
            \c qdbusxml2cpp tool, which will create an interface class.
    \endtable
*/

/*!
    \qmlproperty string Qt.dbus::xml2cppName

    The base name of the \c qdbusxml2cpp tool.

    Set this property if your system uses a name different from the default
    value.

    \defaultvalue \c{"qdbusxml2cpp"}
*/

/*!
    \qmlproperty stringList Qt.dbus::xml2CppHeaderFlags

    A list of additional flags when running the \c qdbusxml2cpp tool to create
    header files.

    \defaultvalue \c []
*/

/*!
    \qmlproperty stringList Qt.dbus::xml2CppSourceFlags

    A list of additional flags when running the \c qdbusxml2cpp tool to create
    source files.

    \defaultvalue \c []
*/