blob: afb47ce1c7195d1b20fd99d728f36be3526b97e8 (
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
|
/****************************************************************************
**
** Copyright (C) 2017 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 qtwebview-index.html
\title Qt WebView
\brief A light-weight web view.
Qt WebView provides a way to display web content in a QML application without
necessarily including a full web browser stack by using native APIs where
it makes sense.
This is useful on mobile platforms such as \l {Qt for Android}{Android},
\l {Qt for iOS}{iOS}, and \l {Qt for WinRT}{WinRT}; especially
on iOS, where policy dictates that all web content is displayed using the
operating system's web view.
\section1 Prerequisites
To make the Qt WebView module function correctly across all platforms, it's necessary
to call \l {qtwebview-initialize}{QtWebView::initialize}() right after creating the
QGuiApplication instance.
\section1 QML Types
The module provides a single QML component for displaying web content in
the application: \l{WebView}.
\section1 Limitations
Due to platform limitations, overlapping the WebView with other QML components
is not supported. Doing this will have unpredictable results which may differ
from platform to platform.
\section1 Examples
Take a look at the \l{Qt WebView Examples} for a demonstration on
how the APIs can be used in applications.
\section1 API Reference
\list
\li \l{Qt WebView QML Types}
\li \l{Qt WebView C++ Classes and Namespaces}
\endlist
*/
|
