tools/assistant/lib/qhelpengine.cpp
changeset 0 1918ee327afb
child 3 41300fa6a67c
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/tools/assistant/lib/qhelpengine.cpp	Mon Jan 11 14:00:40 2010 +0000
@@ -0,0 +1,212 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the Qt Assistant 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 Technology Preview License Agreement accompanying
+** this package.
+**
+** 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.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qhelpengine.h"
+#include "qhelpengine_p.h"
+#include "qhelpdbreader_p.h"
+#include "qhelpcontentwidget.h"
+#include "qhelpindexwidget.h"
+#include "qhelpsearchengine.h"
+#include "qhelpcollectionhandler_p.h"
+
+#include <QtCore/QDir>
+#include <QtCore/QFile>
+#include <QtCore/QLibrary>
+#include <QtCore/QPluginLoader>
+#include <QtGui/QApplication>
+#include <QtSql/QSqlQuery>
+
+QT_BEGIN_NAMESPACE
+
+QHelpEnginePrivate::QHelpEnginePrivate()
+    : QHelpEngineCorePrivate()
+    , contentModel(0)
+    , contentWidget(0)
+    , indexModel(0)
+    , indexWidget(0)
+    , searchEngine(0)
+{
+}
+
+QHelpEnginePrivate::~QHelpEnginePrivate()
+{
+}
+
+void QHelpEnginePrivate::init(const QString &collectionFile,
+                              QHelpEngineCore *helpEngineCore)
+{
+    QHelpEngineCorePrivate::init(collectionFile, helpEngineCore);
+
+    contentModel = new QHelpContentModel(this);
+    indexModel = new QHelpIndexModel(this);
+
+    connect(helpEngineCore, SIGNAL(setupFinished()),
+        this, SLOT(applyCurrentFilter()));
+    connect(helpEngineCore, SIGNAL(currentFilterChanged(const QString&)),
+        this, SLOT(applyCurrentFilter()));
+
+}
+
+void QHelpEnginePrivate::applyCurrentFilter()
+{
+    if (!error.isEmpty())
+        return;
+    contentModel->createContents(currentFilter);
+    indexModel->createIndex(currentFilter);
+}
+
+void QHelpEnginePrivate::setContentsWidgetBusy()
+{
+    contentWidget->setCursor(Qt::WaitCursor);
+}
+
+void QHelpEnginePrivate::unsetContentsWidgetBusy()
+{
+    contentWidget->unsetCursor();
+}
+
+void QHelpEnginePrivate::setIndexWidgetBusy()
+{
+    indexWidget->setCursor(Qt::WaitCursor);
+}
+
+void QHelpEnginePrivate::unsetIndexWidgetBusy()
+{
+    indexWidget->unsetCursor();
+}
+
+void QHelpEnginePrivate::stopDataCollection()
+{
+    contentModel->invalidateContents(true);
+    indexModel->invalidateIndex(true);
+}
+
+
+
+/*!
+    \class QHelpEngine
+    \since 4.4
+    \inmodule QtHelp
+    \brief The QHelpEngine class provides access to contents and
+    indices of the help engine.
+
+
+*/
+
+/*!
+    Constructs a new help engine with the given \a parent. The help
+    engine uses the information stored in the \a collectionFile for
+    providing help. If the collection file does not already exist,
+    it will be created.
+*/
+QHelpEngine::QHelpEngine(const QString &collectionFile, QObject *parent)
+    : QHelpEngineCore(d = new QHelpEnginePrivate(), parent)
+{
+    d->init(collectionFile, this);
+}
+
+/*!
+    Destroys the help engine object.
+*/
+QHelpEngine::~QHelpEngine()
+{
+    d->stopDataCollection();
+}
+
+/*!
+    Returns the content model.
+*/
+QHelpContentModel *QHelpEngine::contentModel() const
+{
+    return d->contentModel;
+}
+
+/*!
+    Returns the index model.
+*/
+QHelpIndexModel *QHelpEngine::indexModel() const
+{
+    return d->indexModel;
+}
+
+/*!
+    Returns the content widget.
+*/
+QHelpContentWidget *QHelpEngine::contentWidget()
+{
+    if (!d->contentWidget) {
+        d->contentWidget = new QHelpContentWidget();
+        d->contentWidget->setModel(d->contentModel);
+        connect(d->contentModel, SIGNAL(contentsCreationStarted()),
+            d, SLOT(setContentsWidgetBusy()));
+        connect(d->contentModel, SIGNAL(contentsCreated()),
+            d, SLOT(unsetContentsWidgetBusy()));
+    }
+    return d->contentWidget;
+}
+
+/*!
+    Returns the index widget.
+*/
+QHelpIndexWidget *QHelpEngine::indexWidget()
+{
+    if (!d->indexWidget) {
+        d->indexWidget = new QHelpIndexWidget();
+        d->indexWidget->setModel(d->indexModel);
+        connect(d->indexModel, SIGNAL(indexCreationStarted()),
+            d, SLOT(setIndexWidgetBusy()));
+        connect(d->indexModel, SIGNAL(indexCreated()),
+            d, SLOT(unsetIndexWidgetBusy()));
+    }
+    return d->indexWidget;
+}
+
+/*!
+    Returns the default search engine.
+*/
+QHelpSearchEngine* QHelpEngine::searchEngine()
+{
+    if (!d->searchEngine)
+        d->searchEngine = new QHelpSearchEngine(this, this);
+    return d->searchEngine;
+}
+
+QT_END_NAMESPACE