/****************************************************************************
**
** Copyright (C) 2019 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} and \l {Qt for iOS}{iOS};
  On iOS the policy dictates that all web content is displayed using the operating system's web view.

  On Windows and Linux, Qt \WebView depends on the \l{Qt WebEngine} module to render
  content.

  On \macos, the system web view is used in the same manner as iOS.

  \section1 Prerequisites

  To make the Qt WebView module function correctly across all platforms, it's necessary
  to call \l {qtwebview-initialize}{QtWebView::initialize}() before creating the
  QGuiApplication instance and before window's QPlatformOpenGLContext is created.

  \section1 Using The Module

  \section2 QML API

  The QML types in Qt WebView are available through the QtWebView import. To use the types,
  add the following import statement to your .qml file:

  \badcode
  import QtWebView
  \endcode

  \section2 C++ API

  Using the C++ API requires linking against the module library, either directly or through other dependencies.

  \section3 Building with CMake

  Use the \c find_package() command to locate WebView component in the Qt6 package:

  \badcode
  find_package(Qt6 COMPONENTS WebView)
  target_link_libraries(target PUBLIC Qt::WebView)
  \endcode

  For more information, see the \l{Build with CMake} overview page.

  \section3 Building with qmake

  Add the webview module to the \c QT variable in the project's .pro file:

  \badcode
  QT += webview
  \endcode

  \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 Licenses

  Qt \WebView is available under commercial licenses from \l{The Qt Company}.
  In addition, it is available under the
  \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

  \list
  \li \l{Qt WebView QML Types}
  \li \l{Qt WebView C++ Classes and Namespaces}
  \endlist

*/
