summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorSimon Hausmann <simon.hausmann@nokia.com>2009-04-24 10:41:02 (GMT)
committerSimon Hausmann <simon.hausmann@nokia.com>2009-04-24 10:43:54 (GMT)
commit225b516ea21e841ee52d2f3edb426eb781ab0c8d (patch)
treec1a873d0301409279428c617d7577ab10203f1e1 /doc
parentfbdf2d74f010c85c85af4ee9ea793039cccf2354 (diff)
downloadQt-225b516ea21e841ee52d2f3edb426eb781ab0c8d.zip
Qt-225b516ea21e841ee52d2f3edb426eb781ab0c8d.tar.gz
Qt-225b516ea21e841ee52d2f3edb426eb781ab0c8d.tar.bz2
Updated WebKit from /home/shausman/src/webkit/trunk to origin/qtwebkit-4.5 ( 242472777d440a540b4bc944c84eb522388e384e )
Changes in WebKit since the last update: ++ b/ChangeLog 2009-04-24 Simon Hausmann <simon.hausmann@nokia.com> Reviewed by Ariya Hidayat. Added support for generating API docs in the Qt build using "make docs" * WebKit.pro: Include docs.pri for "make docs" target. ++ b/WebKit/qt/ChangeLog 2009-04-24 Simon Hausmann <simon.hausmann@nokia.com> Reviewed by Ariya Hidayat. Added support for generating API docs in the Qt build using "make docs" Added code snippets and overview from the Qt sources references in the API docs. * Api/qwebpage.cpp: Adjust paths to snippets. * Api/qwebview.cpp: Ditto. * docs/docs.pri: Added. * docs/qtwebkit.qdoc: Added. * docs/qtwebkit.qdocconf: Added. * docs/webkitsnippets/qtwebkit_build_snippet.qdoc: Added. * docs/webkitsnippets/qtwebkit_qwebview_snippet.cpp: Added. * docs/webkitsnippets/simple/main.cpp: Added. * docs/webkitsnippets/simple/simple.pro: Added. * docs/webkitsnippets/webpage/main.cpp: Added. * docs/webkitsnippets/webpage/webpage.pro: Added. Moved QtWebKit documentation into the WebKit project under src/3rdparty/webkit This is needed to have "make docs" inside WebKit and allows contributors to the WebKit project to write API docs. I'm doing the change in 4.5 to simplify merging with Qt 4.6. Reviewed-by: Trust me
Diffstat (limited to 'doc')
-rw-r--r--doc/src/qtwebkit.qdoc189
-rw-r--r--doc/src/snippets/code/doc_src_qtwebkit.qdoc8
-rw-r--r--doc/src/snippets/code/src_3rdparty_webkit_WebKit_qt_Api_qwebview.cpp35
-rw-r--r--doc/src/snippets/webkit/simple/main.cpp56
-rw-r--r--doc/src/snippets/webkit/simple/simple.pro2
-rw-r--r--doc/src/snippets/webkit/webpage/main.cpp62
-rw-r--r--doc/src/snippets/webkit/webpage/webpage.pro3
7 files changed, 0 insertions, 355 deletions
diff --git a/doc/src/qtwebkit.qdoc b/doc/src/qtwebkit.qdoc
deleted file mode 100644
index 0092950..0000000
--- a/doc/src/qtwebkit.qdoc
+++ /dev/null
@@ -1,189 +0,0 @@
-/*!
- \module QtWebKit
- \title QtWebKit Module
- \contentspage Qt's Modules
- \previouspage QtSvg
- \nextpage QtXml
- \ingroup architecture
- \ingroup modules
- \brief An introduction to the QtWebKit module.
-
- \keyword Browser
- \keyword Web Browser
-
- \since 4.4
-
- QtWebKit provides a Web browser engine that makes it easy to embed content
- from the World Wide Web into your Qt application. At the same time Web
- content can be enhanced with native controls.
-
- QtWebKit provides facilities for rendering of HyperText Markup Language
- (HTML), Extensible HyperText Markup Language (XHTML) and Scalable Vector
- Graphics (SVG) documents, styled using Cascading Style Sheets (CSS) and
- scripted with JavaScript.
-
- A bridge between the JavaScript execution environment and the Qt object
- model makes it possible for custom QObjects to be scripted. Integration
- with the Qt networking module enables Web pages to be transparently loaded
- from Web servers, the local file system or even the Qt resource system.
-
- In addition to providing pure rendering features, HTML documents can be
- made fully editable to the user through the use of the \c{contenteditable}
- attribute on HTML elements.
-
- QtWebKit is based on the Open Source WebKit engine. More information about
- WebKit itself can be found on the \l{WebKit Open Source Project} Web site.
-
- The QtWebKit module is part of the \l{Qt Full Framework Edition}, and the
- \l{Open Source Versions of Qt}.
-
- \note Building the QtWebKit module with debugging symbols is problematic
- on many platforms due to the size of the WebKit engine. We recommend
- building the module in release mode only for embedded platforms.
-
- \note Web site icons, also known as "FavIcons", are currently not supported
- on Windows. We plan to address this in a future release.
-
- \note WebKit has certain minimum requirements that must be met on
- Embedded Linux systems. See the \l{Qt for Embedded Linux Requirements}
- document for more information.
-
- Topics:
-
- \tableofcontents
-
- \section1 Configuring the Build Process
-
- Applications that use QtWebKit's classes need to be configured to be built
- against the QtWebKit module. The following declaration in a \c qmake
- project file ensures that an application is compiled and linked
- appropriately:
-
- \snippet doc/src/snippets/code/doc_src_qtwebkit.qdoc 0
-
- This line is necessary because only the QtCore and QtGui modules are used
- in the default build process.
-
- To include the definitions of the module's classes, use the following
- directive:
-
- \snippet doc/src/snippets/code/doc_src_qtwebkit.qdoc 1
-
- \section1 Architecture
-
- The easiest way to render content is through the QWebView 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.
-
- \snippet snippets/webkit/simple/main.cpp Using QWebView
-
- QWebView acts as a view onto Web pages, each of which is represented by an
- instance of the QWebPage class. QWebPage provides access to the document
- structure in a page, describing features such as frames, the navigation
- history, and the undo/redo stack for editable content.
-
- HTML documents can be nested using frames in a frameset. An individual
- frame in HTML is represented using the QWebFrame class. It includes the
- bridge to the JavaScript window object and can be painted using QPainter.
- Each QWebPage has one QWebFrame object as its main frame.
-
- Individual browser features, defaults and other settings can be configured
- through the QWebSettings class. It is possible to provide defaults for all
- QWebPage instances through the default settings. Individual attributes
- can be overidden by the page specific settings object.
-
- \section1 Netscape Plugin Support
-
- Since WebKit supports the Netscape Plugin API, Qt applications can display
- Web pages that embed common plugins, as long as the user has the appropriate
- binary files for those plugins installed.
-
- The following locations are searched for plugins:
-
- \table
- \header \o Linux/Unix \o Windows
- \row \o{1,3}
- \list
- \o \c{.mozilla/plugins} in the user's home directory
- \o \c{.netscape/plugins} in the user's home directory
- \o System locations, such as
- \list
- \o \c{/usr/lib/browser/plugins}
- \o \c{/usr/local/lib/mozilla/plugins}
- \o \c{/usr/lib/firefox/plugins}
- \o \c{/usr/lib64/browser-plugins}
- \o \c{/usr/lib/browser-plugins}
- \o \c{/usr/lib/mozilla/plugins}
- \o \c{/usr/local/netscape/plugins}
- \o \c{/opt/mozilla/plugins}
- \o \c{/opt/mozilla/lib/plugins}
- \o \c{/opt/netscape/plugins}
- \o \c{/opt/netscape/communicator/plugins}
- \o \c{/usr/lib/netscape/plugins}
- \o \c{/usr/lib/netscape/plugins-libc5}
- \o \c{/usr/lib/netscape/plugins-libc6}
- \o \c{/usr/lib64/netscape/plugins}
- \o \c{/usr/lib64/mozilla/plugins}
- \endlist
- \o Locations specified by environment variables:
- \list
- \o \c{$MOZILLA_HOME/plugins}
- \o \c{$MOZ_PLUGIN_PATH}
- \o \c{$QTWEBKIT_PLUGIN_PATH}
- \endlist
- \endlist
-
- \o
- \list
- \o The user's \c{Application Data\Mozilla\plugins} directory
- \o Standard system locations of plugins for Quicktime, Flash, etc.
- \endlist
-
- \row
- \raw HTML
- <th class="qt-style">Mac OS X</th>
- \endraw
- \row
- \o
- \list
- \o \c{Library/Internet Plug-Ins} in the user's home directory
- \o The system \c{/Library/Internet Plug-Ins} directory
- \endlist
- \endtable
-
- \section1 License Information
-
- This is a snapshot of the Qt port of WebKit. The exact version information
- can be found in the \c{src/3rdparty/webkit/VERSION} file supplied with Qt.
-
- Qt Commercial Edition licensees that wish to distribute applications that
- use the QtWebKit module need to be aware of their obligations under the
- GNU Lesser General Public License (LGPL).
-
- Developers using the Open Source Edition can choose to redistribute
- the module under the appropriate version of the GNU LGPL; version 2.1
- for applications and libraries licensed under the GNU GPL version 2,
- or version 3 for applications and libraries licensed under the GNU
- GPL version 2.
-
- \legalese
- WebKit 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.
- \endlegalese
-*/
diff --git a/doc/src/snippets/code/doc_src_qtwebkit.qdoc b/doc/src/snippets/code/doc_src_qtwebkit.qdoc
deleted file mode 100644
index d4fc2bd..0000000
--- a/doc/src/snippets/code/doc_src_qtwebkit.qdoc
+++ /dev/null
@@ -1,8 +0,0 @@
-//! [0]
-QT += webkit
-//! [0]
-
-
-//! [1]
-#include <QtWebKit>
-//! [1]
diff --git a/doc/src/snippets/code/src_3rdparty_webkit_WebKit_qt_Api_qwebview.cpp b/doc/src/snippets/code/src_3rdparty_webkit_WebKit_qt_Api_qwebview.cpp
deleted file mode 100644
index f04cd29..0000000
--- a/doc/src/snippets/code/src_3rdparty_webkit_WebKit_qt_Api_qwebview.cpp
+++ /dev/null
@@ -1,35 +0,0 @@
-
-void wrapInFunction()
-{
-
-//! [0]
- view->page()->history();
-//! [0]
-
-
-//! [1]
- view->page()->settings();
-//! [1]
-
-
-//! [2]
- view->triggerAction(QWebPage::Copy);
-//! [2]
-
-
-//! [3]
- view->page()->triggerPageAction(QWebPage::Stop);
-//! [3]
-
-
-//! [4]
- view->page()->triggerPageAction(QWebPage::GoBack);
-//! [4]
-
-
-//! [5]
- view->page()->triggerPageAction(QWebPage::GoForward);
-//! [5]
-
-}
-
diff --git a/doc/src/snippets/webkit/simple/main.cpp b/doc/src/snippets/webkit/simple/main.cpp
deleted file mode 100644
index a6a4fc2..0000000
--- a/doc/src/snippets/webkit/simple/main.cpp
+++ /dev/null
@@ -1,56 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
-** Contact: Qt Software Information (qt-info@nokia.com)
-**
-** This file is part of the documentation of the Qt Toolkit.
-**
-** $QT_BEGIN_LICENSE:LGPL$
-** No Commercial Usage
-** This file contains pre-release code and may not be distributed.
-** You may use this file in accordance with the terms and conditions
-** contained in the either Technology Preview License Agreement or the
-** Beta Release License Agreement.
-**
-** GNU Lesser General Public License Usage
-** Alternatively, this file may be used under the terms of the GNU Lesser
-** General Public License version 2.1 as published by the Free Software
-** Foundation and appearing in the file LICENSE.LGPL included in the
-** packaging of this file. Please review the following information to
-** ensure the GNU Lesser General Public License version 2.1 requirements
-** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
-**
-** In addition, as a special exception, Nokia gives you certain
-** additional rights. These rights are described in the Nokia Qt LGPL
-** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
-** package.
-**
-** GNU General Public License Usage
-** Alternatively, this file may be used under the terms of the GNU
-** General Public License version 3.0 as published by the Free Software
-** Foundation and appearing in the file LICENSE.GPL included in the
-** packaging of this file. Please review the following information to
-** ensure the GNU General Public License version 3.0 requirements will be
-** met: http://www.gnu.org/copyleft/gpl.html.
-**
-** If you are unsure which license is appropriate for your use, please
-** contact the sales department at qt-sales@nokia.com.
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-#include <QApplication>
-#include <QUrl>
-#include <QWebView>
-
-int main(int argc, char *argv[])
-{
- QApplication app(argc, argv);
- QWidget *parent = 0;
-//! [Using QWebView]
- QWebView *view = new QWebView(parent);
- view->load(QUrl("http://qtsoftware.com/"));
- view->show();
-//! [Using QWebView]
- return app.exec();
-}
diff --git a/doc/src/snippets/webkit/simple/simple.pro b/doc/src/snippets/webkit/simple/simple.pro
deleted file mode 100644
index 61cd3bf..0000000
--- a/doc/src/snippets/webkit/simple/simple.pro
+++ /dev/null
@@ -1,2 +0,0 @@
-QT += webkit
-SOURCES = main.cpp
diff --git a/doc/src/snippets/webkit/webpage/main.cpp b/doc/src/snippets/webkit/webpage/main.cpp
deleted file mode 100644
index b433ac2..0000000
--- a/doc/src/snippets/webkit/webpage/main.cpp
+++ /dev/null
@@ -1,62 +0,0 @@
-#include <QtGui>
-#include <QWebPage>
-#include <QWebFrame>
-
-//! [0]
-class Thumbnailer : public QObject
-{
- Q_OBJECT
-
-public:
- Thumbnailer(const QUrl &url);
-
-signals:
- void finished();
-
-private slots:
- void render();
-
-private:
- QWebPage page;
-
-};
-//! [0]
-
-int main(int argc, char *argv[])
-{
- QApplication app(argc, argv);
-
- Thumbnailer thumbnail(QUrl("http://qtsoftware.com"));
-
- QObject::connect(&thumbnail, SIGNAL(finished()),
- &app, SLOT(quit()));
-
- return app.exec();
-}
-
-//! [1]
-Thumbnailer::Thumbnailer(const QUrl &url)
-{
- page.mainFrame()->load(url);
- connect(&page, SIGNAL(loadFinished(bool)),
- this, SLOT(render()));
-}
-//! [1]
-
-//! [2]
-void Thumbnailer::render()
-{
- page.setViewportSize(page.mainFrame()->contentsSize());
- QImage image(page.viewportSize(), QImage::Format_ARGB32);
- QPainter painter(&image);
-
- page.mainFrame()->render(&painter);
- painter.end();
-
- QImage thumbnail = image.scaled(400, 400);
- thumbnail.save("thumbnail.png");
-
- emit finished();
-}
-//! [2]
-#include "main.moc"
diff --git a/doc/src/snippets/webkit/webpage/webpage.pro b/doc/src/snippets/webkit/webpage/webpage.pro
deleted file mode 100644
index fcad03b..0000000
--- a/doc/src/snippets/webkit/webpage/webpage.pro
+++ /dev/null
@@ -1,3 +0,0 @@
-CONFIG += console
-QT += webkit
-SOURCES = main.cpp \ No newline at end of file