blob: b32c40382dc5e60328b7ef45242189261cdf31f9 (
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
|
// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page qtquickwidgets-index.html
\title Qt Quick Widgets
\brief Provides a C++ widget class for displaying a Qt Quick user interface.
The Qt Quick Widgets module is a convenience wrapper for QQuickWindow.
It will automatically load and display a QML scene when given the URL of
the main \c qml file. Alternatively, you can instantiate QML objects using
QQmlComponent and place them in a manually set-up QQuickWidget.
Typical usage:
\code
QQuickWidget *view = new QQuickWidget;
view->setSource(QUrl::fromLocalFile("myqmlfile.qml"));
view->show();
\endcode
QQuickWidget also manages resizing the view and the root item. By default,
the \l {QQuickWidget::} {resizeMode} is set to
\l {QQuickWidget::} {SizeViewToRootObject}, which will
load the component and resize it to fit the view. Alternatively,
you can set \l {QQuickWidget::} {resizeMode} to
\l {QQuickWidget::SizeViewToRootObject} {SizeViewToRootObject}, which will
resize the view to the root item.
\section1 Using the Module
\include {module-use.qdocinc} {using the c++ api}
\section2 Building with CMake
\include {module-use.qdocinc} {building with cmake} {QuickWidgets}
\section2 Building with qmake quickwidgets
\include {module-use.qdocinc} {building_with_qmake} {quickwidgets}
\section1 Reference
\list
\li \l {Qt Quick Widgets C++ Classes}
\endlist
\section1 Licenses and Attributions
Qt Quick Widget is available under commercial licenses from
\l{The Qt Company}. In addition, it is available under free software
licenses. Since Qt 5.4, 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 more details.
*/
|