summaryrefslogtreecommitdiffstats
path: root/src/designer/src/uitools/doc/src/qtuitools-index.qdoc
blob: a63de0e50a5bd42c0baa473bb9b415c4d43f829f (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
/****************************************************************************
**
** Copyright (C) 2018 The Qt Company Ltd.
** Contact: https://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 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$
**
****************************************************************************/

/*!
    \page qtuitools-index.html
    \title Qt UI Tools

    \brief Provides classes to handle forms created with Qt Designer.

    \section1 Getting Started

    Qt Designer forms are processed at run-time to produce dynamically-generated
    user interfaces. In order to generate a form at run-time, a resource
    file containing a UI file is needed. Applications that use the
    form handling classes need to be configured to be built against the
    Qt UI Tools module. This is done by including the following declaration
    in a \c qmake project file to ensure that the application is compiled
    and linked appropriately.

    \snippet quiloader/doc_src_qtuiloader.pro 0

    A form loader object, provided by the QUiLoader class, is used to construct
    the user interface. This user interface can be retrieved from any QIODevice.
    For example, a QFile object can be used to obtain a form stored in a
    project's resources. The QUiLoader::load() function takes the user interface
    description contained in the file and constructs the form widget.

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

    \snippet quiloader/doc_src_qtuiloader.cpp 1

    \section1 Licenses and Attributions

    Qt UI Tools is available under commercial licenses from \l{The Qt Company}.
    In addition, it is available under free software licenses. Since Qt 6.0,
    these free software licenses are
    \l{GNU Lesser General Public License, version 3}, or
    the \l{GNU General Public License, version 2}.
    See \l{Qt Licensing} for further details.

    \section1 API Reference
    These are links to the API reference materials.
    \list
        \li \l{Qt UI Tools C++ Classes}{C++ Classes}
    \endlist

    \section1 Examples
     \list
      \li \l{Qt UI Tools Examples}
     \endlist
*/