Import the QtWebKit documentation

This places the documentation in separates .qdoc files with the original
license header preserved. We don't want to contaminate our implementation yet
just for the documentation, so keep it separate for now.

New documentation that isn't attached to the QtWebKit LGPL license should go
inline in the code as usual.

Change-Id: I113a9ad2b826ed7cea053be065f201b637070d28
Reviewed-by: Andras Becsi <andras.becsi@digia.com>

1 files changed, 83 insertions, 0 deletions

diff --git a/src/webenginewidgets/doc/src/qwebenginehistoryinterface_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginehistoryinterface_lgpl.qdoc
new file mode 100644
index 000000000..1d17e7ce0
--- /dev/null
+++ b/src/webenginewidgets/doc/src/qwebenginehistoryinterface_lgpl.qdoc
@@ -0,0 +1,83 @@
+/*
+    Copyright (C) 2007 Staikos Computing Services Inc.  <info@staikos.net>
+
+    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.
+
+    This class provides all functionality needed for tracking global history.
+*/
+
+// The documentation in this file was imported from QtWebKit and is thus constrained
+// by its LGPL license. Documentation written from scratch for new methods should be
+// placed inline in the code as usual.
+
+/*!
+    \class QWebHistoryInterface
+    \since 4.4
+    \brief The QWebHistoryInterface class provides an interface to implement link history.
+
+    \inmodule QtWebKit
+
+    The QWebHistoryInterface is an interface that can be used to
+    keep track of visited links. It contains two pure virtual methods that
+    are called by the WebKit engine: addHistoryEntry() is used to add
+    urls that have been visited to the interface, while
+    historyContains() is used to query whether the given url has been
+    visited by the user. By default the QWebHistoryInterface is not set, so WebKit does not keep
+    track of visited links.
+
+    \note The history tracked by QWebHistoryInterface is not specific to an instance of QWebPage
+    but applies to all pages.
+*/
+
+/*!
+    \fn void QWebHistoryInterface::setDefaultInterface(QWebHistoryInterface* defaultInterface)
+    Sets a new default interface, \a defaultInterface, that will be used by all of WebKit
+    to keep track of visited links.
+
+    If an interface without a parent has already been set, the old interface will be deleted.
+    When the application exists QWebHistoryInterface will automatically delete the
+    \a defaultInterface if it does not have a parent.
+*/
+
+/*!
+    \fn QWebHistoryInterface* QWebHistoryInterface::defaultInterface()
+    Returns the default interface that will be used by WebKit. If no default interface has been set,
+    WebKit will not keep track of visited links and a null pointer will be returned.
+    \sa setDefaultInterface()
+*/
+
+/*!
+    \fn QWebHistoryInterface::QWebHistoryInterface(QObject* parent)
+    Constructs a new QWebHistoryInterface with parent \a parent.
+*/
+
+/*!
+    \fn QWebHistoryInterface::~QWebHistoryInterface()
+    Destroys the interface.  If this is currently the default interface it will be unset.
+*/
+
+/*!
+    \fn bool QWebHistoryInterface::historyContains(const QString &url) const = 0
+
+    Called by the WebKit engine to query whether a certain \a url has been visited by the user already.
+    Returns true if the \a url is part of the history of visited links; otherwise returns false.
+*/
+
+/*!
+    \fn void QWebHistoryInterface::addHistoryEntry(const QString &url) = 0
+
+    Called by WebKit to add another \a url to the list of visited pages.
+*/