From f61493ee97f285e4b7257f7590f45764980ca52e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20Br=C3=BCning?= Date: Thu, 10 Apr 2014 15:49:44 +0200 Subject: First iteration of adujsting widgets docs and snipperts. * Removes inappropriate licensing info. * Corrects simple snippet. Change-Id: I9ac7738d8da22957aa32c91fdcbf81ddedefed72 Reviewed-by: Jocelyn Turcotte --- .../doc/snippets/qtwebengine_build_snippet.qdoc | 4 +-- src/webenginewidgets/doc/snippets/simple/main.cpp | 5 +++- .../doc/snippets/simple/simple.pro | 2 +- .../doc/src/qtwebenginewidgets.qdoc | 33 ++++++++-------------- 4 files changed, 18 insertions(+), 26 deletions(-) (limited to 'src/webenginewidgets/doc') diff --git a/src/webenginewidgets/doc/snippets/qtwebengine_build_snippet.qdoc b/src/webenginewidgets/doc/snippets/qtwebengine_build_snippet.qdoc index d4fc2bd85..248296588 100644 --- a/src/webenginewidgets/doc/snippets/qtwebengine_build_snippet.qdoc +++ b/src/webenginewidgets/doc/snippets/qtwebengine_build_snippet.qdoc @@ -1,8 +1,8 @@ //! [0] -QT += webkit +QT += webengine //! [0] //! [1] -#include +#include //! [1] diff --git a/src/webenginewidgets/doc/snippets/simple/main.cpp b/src/webenginewidgets/doc/snippets/simple/main.cpp index ef05fec6f..d33f14628 100644 --- a/src/webenginewidgets/doc/snippets/simple/main.cpp +++ b/src/webenginewidgets/doc/snippets/simple/main.cpp @@ -1,5 +1,5 @@ /* - Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies) + Copyright (C) 2014 Nokia Corporation and/or its subsidiary(-ies) This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public @@ -25,6 +25,9 @@ int main(int argc, char *argv[]) { QApplication app(argc, argv); QWidget *parent = 0; +//! [Initializing QWebEngineWidgets] + QWebEngineWidgets::initialize(); +//! [Initializing QWebEngineWidgets] //! [Using QWebEngineView] QWebEngineView *view = new QWebEngineView(parent); view->load(QUrl("http://qt-project.org/")); diff --git a/src/webenginewidgets/doc/snippets/simple/simple.pro b/src/webenginewidgets/doc/snippets/simple/simple.pro index 7fe095809..d18e9211f 100644 --- a/src/webenginewidgets/doc/snippets/simple/simple.pro +++ b/src/webenginewidgets/doc/snippets/simple/simple.pro @@ -1,2 +1,2 @@ -QT += webkitwidgets +QT += webenginewidgets SOURCES = main.cpp diff --git a/src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc b/src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc index 247bd6321..6c39b3a9b 100644 --- a/src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc +++ b/src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc @@ -43,7 +43,7 @@ */ /*! - \page qtwebkitwidgets-index.html + \page qtwebenginewidgets-index.html \title Qt WebEngine Widgets \ingroup modules @@ -86,6 +86,11 @@ \section1 Architecture + Before an application can use the Qt WebEngine Widgets classes, it must call + the static initialization method for the module. + + \snippet snippets/simple/main.cpp Initializing QWebEngineWidgets + The easiest way to render content is through the QWebEngineView class. As a widget it can be embedded into your forms or a graphics view, and it provides convenience functions for downloading and rendering web sites. @@ -172,8 +177,8 @@ \l{Qt WebEngine Widgets Examples} page. \section1 License Information - - This is a snapshot of the Qt port of WebEngine. The exact version information + //FIXME: check if we are allowed to use the name chromium here or if it is considered promotional use. + This is a snapshot of the integration of Chromium into Qt. The exact version information can be found in the \c{VERSION} file supplied with Qt. Qt Commercial Edition licensees that wish to distribute applications that @@ -184,24 +189,7 @@ the module under the appropriate version of the GNU LGPL. \legalese - WebEngine is licensed under the GNU Library General Public License. - Individual contributor names and copyright dates can be found - inline in the code. - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Library General Public - License as published by the Free Software Foundation; either - version 2 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Library General Public License for more details. - - You should have received a copy of the GNU Library General Public License - along with this library; see the file COPYING.LIB. If not, write to - the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, - Boston, MA 02110-1301, USA. + // FIXME: add correct licensing terms for chromium / blink. The one copied from QtWebKit does not apply. \endlegalese */ @@ -211,7 +199,8 @@ \brief Examples demonstrating the Qt WebEngine Widgets usage \ingroup all-examples - Qt provides an integrated Web browser component based on WebEngine, the popular + // FIXME: same as above - can we use Chromium / Blink? + Qt provides an integrated Web browser component based on Chromium, the popular open source browser engine. These examples and demonstrations show a range of different uses for Qt WebEngine, -- cgit v1.2.3