|
554.1.8
by Olivier Tilloy
Initial QML module documentation for Ubuntu.Web 0.2. |
1 |
/*
|
2 |
* Copyright 2014 Canonical Ltd.
|
|
3 |
*
|
|
4 |
* This file is part of webbrowser-app.
|
|
5 |
*
|
|
6 |
* webbrowser-app is free software; you can redistribute it and/or modify
|
|
7 |
* it under the terms of the GNU General Public License as published by
|
|
8 |
* the Free Software Foundation; version 3.
|
|
9 |
*
|
|
10 |
* webbrowser-app is distributed in the hope that it will be useful,
|
|
11 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
12 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
13 |
* GNU General Public License for more details.
|
|
14 |
*
|
|
15 |
* You should have received a copy of the GNU General Public License
|
|
16 |
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
17 |
*/
|
|
18 |
||
19 |
/*!
|
|
20 |
\qmlmodule Ubuntu.Web 0.2
|
|
21 |
\title Ubuntu Web module
|
|
|
597.2.6
by Olivier Tilloy
Add a brief to the module’s top-level documentation page. |
22 |
\brief WebView and related components
|
23 |
||
24 |
This QML module exposes a WebView component that can be used to render
|
|
25 |
web content in an application, as well as related components.
|
|
26 |
||
27 |
This is the preferred way of rendering web content in an Ubuntu application.
|
|
28 |
The rendering is performed by \l {https://launchpad.net/oxide} {Oxide}.
|
|
29 |
The use of QtWebKit is deprecated and unsupported.
|
|
30 |
||
31 |
This is version 0.2 of the module.
|
|
32 |
||
33 |
Note that the module was previously named
|
|
34 |
\c Ubuntu.Components.Extras.Browser, the old namespace has been kept around
|
|
35 |
for backwards compatibility but its use is discouraged, please update your
|
|
36 |
applications to import \c {Ubuntu.Web 0.2}.
|
|
37 |
||
38 |
Also note that importing both \c com.canonical.Oxide (or \c QtWebKit) and
|
|
39 |
\c Ubuntu.Web in the same QML file results in an undefined behaviour,
|
|
40 |
as both expose a \c WebView type.
|
|
|
554.1.8
by Olivier Tilloy
Initial QML module documentation for Ubuntu.Web 0.2. |
41 |
*/
|