← Back to branch summary

~rpadovani/webbrowser-app/settings-page

« back to all changes in this revision

Viewing changes to doc/WebView.qdoc

  • Committer: Olivier Tilloy
  • Date: 2014-05-30 16:16:56 UTC
  • mto: This revision was merged to the branch mainline in revision 565.
  • Revision ID: olivier.tilloy@canonical.com-20140530161656-2bq64chv2s9jz1ox
Initial QML module documentation for Ubuntu.Web 0.2.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/WebView.qdoc
 
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
    \qmltype WebView
 
21
    \inqmlmodule Ubuntu.Web 0.2
 
22
    \ingroup ubuntu
 
23
    \brief A webview that can be used to render web content in an application.
 
24
 
 
25
    Here is a very simple example of how to use a WebView to render a web page:
 
26
    \qml
 
27
        import QtQuick 2.0
 
28
        import Ubuntu.Web 0.2
 
29
 
 
30
        WebView {
 
31
            url: "http://ubuntu.com"
 
32
        }
 
33
    \endqml
 
34
 
 
35
    The \c WebView component defaults to using a \l {SharedWebContext}
 
36
    {shared \c WebContext} that is shared across all \c WebView instances
 
37
    in a given application.
 
38
 
 
39
    \sa SharedWebContext
 
40
 */
 
41
 
 
42
// TODO: document relevant properties and methods