Commit ac4d7169 authored by hausmann@webkit.org's avatar hausmann@webkit.org

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.

git-svn-id: http://svn.webkit.org/repository/webkit/trunk@42814 268f45cc-cd09-0410-ab3c-d52691b4dbfc
parent cb3d86bb
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.
2009-04-14 Xan Lopez <xlopez@igalia.com>
Unreviewed version bump in preparation for 1.1.5 release.
......
......@@ -9,3 +9,4 @@ SUBDIRS += \
!win32: SUBDIRS += WebKitTools/DumpRenderTree/qt/DumpRenderTree.pro
include(WebKit/qt/docs/docs.pri)
......@@ -1255,18 +1255,18 @@ QVariant QWebPage::inputMethodQuery(Qt::InputMethodQuery property) const
Suppose we have a \c Thumbnail class as follows:
\snippet doc/src/snippets/webkit/webpage/main.cpp 0
\snippet webkitsnippets/webpage/main.cpp 0
The \c Thumbnail's constructor takes in a \a url. We connect our QWebPage
object's \l{QWebPage::}{loadFinished()} signal to our private slot,
\c render().
\snippet doc/src/snippets/webkit/webpage/main.cpp 1
\snippet webkitsnippets/webpage/main.cpp 1
The \c render() function shows how we can paint a thumbnail using a
QWebPage object.
\snippet doc/src/snippets/webkit/webpage/main.cpp 2
\snippet webkitsnippets/webpage/main.cpp 2
We begin by setting the \l{QWebPage::viewportSize()}{viewportSize} and
then we instantiate a QImage object, \c image, with the same size as our
......
......@@ -86,7 +86,7 @@ public:
Qt Widgets, the show() function must be invoked in order to display
QWebView. The snippet below illustrates this:
\snippet doc/src/snippets/webkit/simple/main.cpp Using QWebView
\snippet webkitsnippets/simple/main.cpp Using QWebView
Alternatively, setUrl() can also be used to load a web site. If you have
the HTML content readily available, you can use setHtml() instead.
......@@ -325,7 +325,7 @@ void QWebView::setContent(const QByteArray &data, const QString &mimeType, const
It is equivalent to
\snippet doc/src/snippets/code/src_3rdparty_webkit_WebKit_qt_Api_qwebview.cpp 0
\snippet webkitsnippets/qtwebkit_qwebview_snippet.cpp 0
*/
QWebHistory *QWebView::history() const
{
......@@ -337,7 +337,7 @@ QWebHistory *QWebView::history() const
It is equivalent to
\snippet doc/src/snippets/code/src_3rdparty_webkit_WebKit_qt_Api_qwebview.cpp 1
\snippet webkitsnippets/qtwebkit_qwebview_snippet.cpp 1
\sa QWebSettings::globalSettings()
*/
......@@ -429,7 +429,7 @@ QAction *QWebView::pageAction(QWebPage::WebAction action) const
The following example triggers the copy action and therefore copies any
selected text to the clipboard.
\snippet doc/src/snippets/code/src_3rdparty_webkit_WebKit_qt_Api_qwebview.cpp 2
\snippet webkitsnippets/qtwebkit_qwebview_snippet.cpp 2
\sa pageAction()
*/
......@@ -606,7 +606,7 @@ void QWebView::print(QPrinter *printer) const
It is equivalent to
\snippet doc/src/snippets/code/src_3rdparty_webkit_WebKit_qt_Api_qwebview.cpp 3
\snippet webkitsnippets/qtwebkit_qwebview_snippet.cpp 3
\sa reload(), pageAction(), loadFinished()
*/
......@@ -622,7 +622,7 @@ void QWebView::stop()
It is equivalent to
\snippet doc/src/snippets/code/src_3rdparty_webkit_WebKit_qt_Api_qwebview.cpp 4
\snippet webkitsnippets/qtwebkit_qwebview_snippet.cpp 4
\sa forward(), pageAction()
*/
......@@ -638,7 +638,7 @@ void QWebView::back()
It is equivalent to
\snippet doc/src/snippets/code/src_3rdparty_webkit_WebKit_qt_Api_qwebview.cpp 5
\snippet webkitsnippets/qtwebkit_qwebview_snippet.cpp 5
\sa back(), pageAction()
*/
......
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.
2009-04-23 Antonio Gomes <antonio.gomes@openbossa.org>
Reviewed by Ariya Hidayat.
......
include(../../../WebKit.pri)
unix {
QDOC = SRCDIR=$$PWD/../../.. OUTPUT_DIR=$$OUTPUT_DIR $$(QTDIR)/tools/qdoc3/qdoc3
} else {
QDOC = $$(QTDIR)\tools\qdoc3\release\qdoc3.exe
}
unix {
docs.commands = $$QDOC $$PWD/qtwebkit.qdocconf
} else {
docs.commands = \"$$QDOC $$PWD/qtwebkit.qdocconf\"
}
QMAKE_EXTRA_TARGETS += docs
/*!
\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 webkitsnippets/qtwebkit_build_snippet.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 webkitsnippets/qtwebkit_build_snippet.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 webkitsnippets/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
*/
# Run qdoc from the directory that contains this file.
project = qtwebkit
description = "Qt WebKit API Documentation"
headerdirs = $SRCDIR/WebKit/qt/Api
sourcedirs = $SRCDIR/WebKit/qt/Api $SRCDIR/WebKit/qt/docs
outputdir = $OUTPUT_DIR/doc/html
outputformats = HTML
sources.fileextensions = "*.cpp *.doc *.qdoc *.h"
exampledirs = $SRCDIR/WebKit/qt/docs
indexes = $QTDIR/doc/html/qt.index
# macros.qdocconf
macro.aring.HTML = "&aring;"
macro.Auml.HTML = "&Auml;"
macro.author = "\\bold{Author:}"
macro.br.HTML = "<br />"
macro.BR.HTML = "<br />"
macro.aacute.HTML = "&aacute;"
macro.eacute.HTML = "&eacute;"
macro.iacute.HTML = "&iacute;"
macro.gui = "\\bold"
macro.hr.HTML = "<hr />"
macro.key = "\\bold"
macro.menu = "\\bold"
macro.note = "\\bold{Note:}"
macro.oslash.HTML = "&oslash;"
macro.ouml.HTML = "&ouml;"
macro.QA = "\\e{Qt Assistant}"
macro.QD = "\\e{Qt Designer}"
macro.QL = "\\e{Qt Linguist}"
macro.param = "\\e"
macro.raisedaster.HTML = "<sup>*</sup>"
macro.reg.HTML = "<sup>&reg;</sup>"
macro.return = "Returns"
macro.starslash = "\\c{*/}"
macro.uuml.HTML = "&uuml;"
macro.mdash.HTML = "&mdash;"
# compat.qdocconf
alias.i = e
alias.include = input
macro.0 = "\\\\0"
macro.b = "\\\\b"
macro.n = "\\\\n"
macro.r = "\\\\r"
macro.i = "\\o"
macro.i11 = "\\o{1,1}"
macro.i12 = "\\o{1,2}"
macro.i13 = "\\o{1,3}"
macro.i14 = "\\o{1,4}"
macro.i15 = "\\o{1,5}"
macro.i16 = "\\o{1,6}"
macro.i17 = "\\o{1,7}"
macro.i18 = "\\o{1,8}"
macro.i19 = "\\o{1,9}"
macro.i21 = "\\o{2,1}"
macro.i31 = "\\o{3,1}"
macro.i41 = "\\o{4,1}"
macro.i51 = "\\o{5,1}"
macro.i61 = "\\o{6,1}"
macro.i71 = "\\o{7,1}"
macro.i81 = "\\o{8,1}"
macro.i91 = "\\o{9,1}"
macro.img = "\\image"
macro.endquote = "\\endquotation"
spurious = "Missing comma in .*" \
"Missing pattern .*"
# Doxygen compatibility commands
macro.see = "\\sa"
macro.function = "\\fn"
# qt-cpp-ignore.qdocconf
Cpp.ignoretokens = QAXFACTORY_EXPORT \
QDESIGNER_COMPONENTS_LIBRARY \
QDESIGNER_EXTENSION_LIBRARY \
QDESIGNER_SDK_LIBRARY \
QDESIGNER_SHARED_LIBRARY \
QDESIGNER_UILIB_LIBRARY \
QM_EXPORT_CANVAS \
QM_EXPORT_DNS \
QM_EXPORT_DOM \
QM_EXPORT_FTP \
QM_EXPORT_HTTP \
QM_EXPORT_ICONVIEW \
QM_EXPORT_NETWORK \
QM_EXPORT_OPENGL \
QM_EXPORT_SQL \
QM_EXPORT_TABLE \
QM_EXPORT_WORKSPACE \
QM_EXPORT_XML \
QT_ASCII_CAST_WARN \
QT_ASCII_CAST_WARN_CONSTRUCTOR \
QT_BEGIN_HEADER \
QT_DESIGNER_STATIC \
QT_END_HEADER \
QT_FASTCALL \
QT_WIDGET_PLUGIN_EXPORT \
Q_COMPAT_EXPORT \
Q_CORE_EXPORT \
Q_EXPLICIT \
Q_EXPORT \
Q_EXPORT_CODECS_CN \
Q_EXPORT_CODECS_JP \
Q_EXPORT_CODECS_KR \
Q_EXPORT_PLUGIN \
Q_GFX_INLINE \
Q_GUI_EXPORT \
Q_GUI_EXPORT_INLINE \
Q_GUI_EXPORT_STYLE_CDE \
Q_GUI_EXPORT_STYLE_COMPACT \
Q_GUI_EXPORT_STYLE_MAC \
Q_GUI_EXPORT_STYLE_MOTIF \
Q_GUI_EXPORT_STYLE_MOTIFPLUS \
Q_GUI_EXPORT_STYLE_PLATINUM \
Q_GUI_EXPORT_STYLE_POCKETPC \
Q_GUI_EXPORT_STYLE_SGI \
Q_GUI_EXPORT_STYLE_WINDOWS \
Q_GUI_EXPORT_STYLE_WINDOWSXP \
QHELP_EXPORT \
Q_INLINE_TEMPLATE \
Q_INTERNAL_WIN_NO_THROW \
Q_NETWORK_EXPORT \
Q_OPENGL_EXPORT \
Q_OUTOFLINE_TEMPLATE \
Q_SQL_EXPORT \
Q_SVG_EXPORT \
Q_SCRIPT_EXPORT \
Q_TESTLIB_EXPORT \
Q_TYPENAME \
Q_XML_EXPORT \
Q_XMLSTREAM_EXPORT \
Q_XMLPATTERNS_EXPORT \
QDBUS_EXPORT \
QT_BEGIN_NAMESPACE \
QT_BEGIN_INCLUDE_NAMESPACE \
QT_END_NAMESPACE \
QT_END_INCLUDE_NAMESPACE \
PHONON_EXPORT \
EXTENSIONSYSTEM_EXPORT
Cpp.ignoredirectives = Q_DECLARE_HANDLE \
Q_DECLARE_INTERFACE \
Q_DECLARE_METATYPE \
Q_DECLARE_OPERATORS_FOR_FLAGS \
Q_DECLARE_PRIVATE \
Q_DECLARE_PUBLIC \
Q_DECLARE_SHARED \
Q_DECLARE_TR_FUNCTIONS \
Q_DECLARE_TYPEINFO \
Q_DISABLE_COPY \
QT_FORWARD_DECLARE_CLASS \
Q_DUMMY_COMPARISON_OPERATOR \
Q_ENUMS \
Q_FLAGS \
Q_INTERFACES \
__attribute__ \
K_DECLARE_PRIVATE \
PHONON_OBJECT \
PHONON_HEIR
HTML.style = "" \
"h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm; }"\
"a:link { color: #004faf; text-decoration: none }"\
"a:visited { color: #672967; text-decoration: none }"\
"td.postheader { font-family: sans-serif }"\
"tr.address { font-family: sans-serif }"\
"body { background: #ffffff; color: black }"\
"table tr.odd { background: #f0f0f0; color: black; }"\
"table tr.even { background: #e4e4e4; color: black; }"\
"table.annotated th { padding: 3px; text-align: left }"\
"table.annotated td { padding: 3px; } "\
"table tr pre { padding-top: none; padding-bottom: none; padding-left: none; padding-right: none; border: none; background: none }"\
"tr.qt-style { background: #a2c511; color: black }"\
"body pre { padding: 0.2em; border: #e7e7e7 1px solid; background: #f1f1f1; color: black }"\
"span.preprocessor, span.preprocessor a { color: darkblue; }"\
"span.comment { color: darkred; font-style: italic }"\
"span.string,span.char { color: darkgreen; }"\
".title { text-align: center }"\
".subtitle { font-size: 0.8em }"\
".small-subtitle { font-size: 0.65em }"
HTML.postheader = ""
HTML.footer = ""
//! [0]
QT += webkit
//! [0]
//! [1]
#include <QtWebKit>
//! [1]
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]
}
/*
Copyright (C) 2009 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
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.
*/
#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();
}
/*
Copyright (C) 2009 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
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.
*/
#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);