summaryrefslogtreecommitdiff
path: root/src/script/doc/src/qtscript-module.qdoc
blob: 32af7846d872da884c7deb8a2644f906efc40290 (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
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $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 http://www.qt.io/terms-conditions. For further
** information use the contact form at http://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: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \module QtScript
    \title Qt Script C++ Classes
    \since 4.3
    \ingroup modules
    \qtvariable script

    \brief The Qt Script module provides classes for making Qt applications scriptable.

    The Qt Script module only provides core scripting facilities; the
    Qt Script Tools module provides additional Qt Script-related
    components that application developers may find useful.

    This module is mainly provided for backwards compatibility reasons
    with Qt 4.x and not being actively developed any further. For new
    code please consider using the QJSEngine, etc. classes in the
    Qt Qml module instead.

    To include the definitions of the module's classes, use the
    following directive:

    \snippet code/doc_src_qtscript.cpp 0

    To link against the module, add this line to your \l {qmake Manual}{qmake} \c .pro file:

    \snippet code/doc_src_qtscript.pro 1

    For detailed information on how to make your application
    scriptable with Qt Script, see \l{Making Applications
    Scriptable}.

    \section1 License Information

    Qt Commercial Edition licensees that wish to distribute applications that
    use the Qt Script module need to be aware of their obligations under the
    GNU Library General Public License (LGPL).

    Developers using the Open Source Edition can choose to redistribute
    the module under the appropriate version of the GNU LGPL.

    Commercial customers that do not want to depend on LGPL code can
    consider using the QJSEngine and QJSValue classes in the Qt Qml module.
    These classes offer a similar but more narrow scripting API that is
    sufficient for most use cases and is not dependent on LGPL code.

    \legalese
    Qt Script is licensed under the GNU Library General Public License.
    Individual contributor names and copyright dates can be found
    inline in the code.

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
    \endlegalese

*/