WebKit/qt/Api/qwebhistoryinterface.cpp
changeset 0 4f2f89ce4247
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/WebKit/qt/Api/qwebhistoryinterface.cpp	Fri Sep 17 09:02:29 2010 +0300
@@ -0,0 +1,127 @@
+/*
+    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.
+*/
+
+#include "config.h"
+#include "qwebhistoryinterface.h"
+
+#include <QCoreApplication>
+
+#include "PageGroup.h"
+#include "PlatformString.h"
+
+
+static QWebHistoryInterface* default_interface;
+
+static bool gRoutineAdded;
+
+static void gCleanupInterface()
+{
+    if (default_interface && !default_interface->parent())
+        delete default_interface;
+    default_interface = 0;
+}
+
+/*!
+  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.
+*/
+void QWebHistoryInterface::setDefaultInterface(QWebHistoryInterface* defaultInterface)
+{
+    if (default_interface == defaultInterface)
+        return;
+
+    if (default_interface && !default_interface->parent())
+        delete default_interface;
+
+    default_interface = defaultInterface;
+    WebCore::PageGroup::removeAllVisitedLinks();
+
+    //### enable after the introduction of a version
+    //WebCore::PageGroup::setShouldTrackVisitedLinks(true);
+
+    if (!gRoutineAdded) {
+        qAddPostRoutine(gCleanupInterface);
+        gRoutineAdded = true;
+    }
+}
+
+/*!
+  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
+*/
+QWebHistoryInterface* QWebHistoryInterface::defaultInterface()
+{
+    return default_interface;
+}
+
+/*!
+  \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.
+*/
+
+/*!
+    Constructs a new QWebHistoryInterface with parent \a parent.
+*/
+QWebHistoryInterface::QWebHistoryInterface(QObject* parent)
+    : QObject(parent)
+{
+}
+
+/*!
+    Destroys the interface.  If this is currently the default interface it will be unset.
+*/
+QWebHistoryInterface::~QWebHistoryInterface()
+{
+    if (default_interface == this)
+        default_interface = 0;
+}
+
+/*!
+  \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.
+*/