1 files changed, 509 insertions, 0 deletions
diff --git a/tools/assistant/tools/shared/collectionconfiguration.cpp b/tools/assistant/tools/shared/collectionconfiguration.cpp
new file mode 100644
index 0000000..d0650e4
--- /dev/null
+++ b/tools/assistant/tools/shared/collectionconfiguration.cpp
@@ -0,0 +1,509 @@
+/****************************************************************************
+**
+** 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 "collectionconfiguration.h"
+
+#include <QtHelp/QHelpEngineCore>
+
+QT_BEGIN_NAMESPACE
+
+namespace {
+    const QString ListSeparator(QLatin1String("|"));
+
+    const QString AboutIconKey(QLatin1String("AboutIcon"));
+    const QString AboutImagesKey(QLatin1String("AboutImages"));
+    const QString AboutMenuTextsKey(QLatin1String("AboutMenuTexts"));
+    const QString AboutTextsKey(QLatin1String("AboutTexts"));
+    const QString AppFontKey(QLatin1String("appFont"));
+    const QString ApplicationIconKey(QLatin1String("ApplicationIcon"));
+    const QString AppWritingSystemKey(QLatin1String("appWritingSystem"));
+    const QString BookmarksKey(QLatin1String("Bookmarks"));
+    const QString BrowserFontKey(QLatin1String("browserFont"));
+    const QString BrowserWritingSystemKey(QLatin1String("browserWritingSystem"));
+    const QString CacheDirKey(QLatin1String("CacheDirectory"));
+    const QString CacheDirRelativeToCollectionKey(QLatin1String("CacheDirRelativeToCollection"));
+    const QString CreationTimeKey(QLatin1String("CreationTime"));
+    const QString CurrentFilterKey(QLatin1String("CurrentFilter"));
+    const QString DefaultHomePageKey(QLatin1String("defaultHomepage"));
+    const QString DocUpdatePendingKey(QLatin1String("DocUpdate"));
+    const QString EnableAddressBarKey(QLatin1String("EnableAddressBar"));
+    const QString EnableDocManagerKey(QLatin1String("EnableDocumentationManager"));
+    const QString EnableFilterKey(QLatin1String("EnableFilterFunctionality"));
+    const QString FilterToolbarHiddenKey(QLatin1String("HideFilterFunctionality"));
+    const QString HideAddressBarKey(QLatin1String("HideAddressBar"));
+    const QString HomePageKey(QLatin1String("homepage"));
+    const QString LastPageKey(QLatin1String("LastTabPage"));
+    const QString LastShownPagesKey(QLatin1String("LastShownPages"));
+    const QString LastZoomFactorsKey(QLatin1String(
+#if !defined(QT_NO_WEBKIT)
+            "LastPagesZoomWebView"
+#else
+            "LastPagesZoomTextBrowser"
+#endif
+            ));
+    const QString MainWindowKey(QLatin1String("MainWindow"));
+    const QString MainWindowGeometryKey(QLatin1String("MainWindowGeometry"));
+    const QString SearchWasAttachedKey(QLatin1String("SearchWasAttached"));
+    const QString StartOptionKey(QLatin1String("StartOption"));
+    const QString UnfilteredInsertedKey(QLatin1String("UnfilteredFilterInserted"));
+    const QString UseAppFontKey(QLatin1String("useAppFont"));
+    const QString UseBrowserFontKey(QLatin1String("useBrowserFont"));
+    const QString VersionKey(QString(QLatin1String("qtVersion%1$$$%2")).
+                      arg(QLatin1String(QT_VERSION_STR)));
+    const QString WindowTitleKey(QLatin1String("WindowTitle"));
+} // anonymous namespace
+
+const QString CollectionConfiguration::DefaultZoomFactor(QLatin1String("0.0"));
+
+uint CollectionConfiguration::creationTime(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(CreationTimeKey, 0).toUInt();
+}
+
+void CollectionConfiguration::setCreationTime(QHelpEngineCore &helpEngine, uint time)
+{
+    helpEngine.setCustomValue(CreationTimeKey, time);
+}
+
+const QString CollectionConfiguration::windowTitle(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(WindowTitleKey).toString();
+}
+
+void CollectionConfiguration::setWindowTitle(QHelpEngineCore &helpEngine,
+                                       const QString &windowTitle)
+{
+    helpEngine.setCustomValue(WindowTitleKey, windowTitle);
+}
+
+
+int CollectionConfiguration::lastTabPage(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(LastPageKey, 1).toInt();
+}
+
+void CollectionConfiguration::setLastTabPage(QHelpEngineCore &helpEngine, int lastPage)
+{
+    helpEngine.setCustomValue(LastPageKey, lastPage);
+}
+
+
+const QStringList CollectionConfiguration::lastShownPages(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(LastShownPagesKey).toString().
+        split(ListSeparator, QString::SkipEmptyParts);
+}
+
+void CollectionConfiguration::setLastShownPages(QHelpEngineCore &helpEngine,
+                                          const QStringList &lastShownPages)
+{
+    helpEngine.
+        setCustomValue(LastShownPagesKey, lastShownPages.join(ListSeparator));
+}
+
+const QStringList CollectionConfiguration::lastZoomFactors(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(LastZoomFactorsKey).toString().
+        split(ListSeparator, QString::SkipEmptyParts);
+}
+
+void CollectionConfiguration::setLastZoomFactors(QHelpEngineCore &helpEngine,
+                                           const QStringList &lastZoomFactors)
+{
+    helpEngine.setCustomValue(LastZoomFactorsKey, lastZoomFactors.join(ListSeparator));
+}
+
+const QString CollectionConfiguration::currentFilter(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(CurrentFilterKey).toString();
+}
+
+void CollectionConfiguration::setCurrentFilter(QHelpEngineCore &helpEngine,
+                                         const QString &currentFilter)
+{
+    helpEngine.setCustomValue(CurrentFilterKey, currentFilter);
+}
+
+const QString CollectionConfiguration::cacheDir(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(CacheDirKey).toString();
+}
+
+bool CollectionConfiguration::cacheDirIsRelativeToCollection(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(CacheDirRelativeToCollectionKey).toBool();
+}
+
+void CollectionConfiguration::setCacheDir(QHelpEngineCore &helpEngine,
+                            const QString &cacheDir, bool relativeToCollection)
+{
+    helpEngine.setCustomValue(CacheDirKey, cacheDir);
+    helpEngine.setCustomValue(CacheDirRelativeToCollectionKey,
+                              relativeToCollection);
+}
+
+bool CollectionConfiguration::filterFunctionalityEnabled(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(EnableFilterKey, true).toBool();
+}
+
+void CollectionConfiguration::setFilterFunctionalityEnabled(QHelpEngineCore &helpEngine,
+                                                      bool enabled)
+{
+    helpEngine.setCustomValue(EnableFilterKey, enabled);
+}
+
+bool CollectionConfiguration::filterToolbarVisible(const QHelpEngineCore &helpEngine)
+{
+    return !helpEngine.customValue(FilterToolbarHiddenKey, true).toBool();
+}
+
+void CollectionConfiguration::setFilterToolbarVisible(QHelpEngineCore &helpEngine,
+                                                bool visible)
+{
+    helpEngine.setCustomValue(FilterToolbarHiddenKey, !visible);
+}
+
+bool CollectionConfiguration::addressBarEnabled(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(EnableAddressBarKey, true).toBool();
+}
+
+void CollectionConfiguration::setAddressBarEnabled(QHelpEngineCore &helpEngine,
+                                                   bool enabled)
+{
+    helpEngine.setCustomValue(EnableAddressBarKey, enabled);
+}
+
+bool CollectionConfiguration::addressBarVisible(const QHelpEngineCore &helpEngine)
+{
+    return !helpEngine.customValue(HideAddressBarKey, true).toBool();
+}
+
+void CollectionConfiguration::setAddressBarVisible(QHelpEngineCore &helpEngine,
+                                                   bool visible)
+{
+    helpEngine.setCustomValue(HideAddressBarKey, !visible);
+}
+
+bool CollectionConfiguration::documentationManagerEnabled(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(EnableDocManagerKey, true).toBool();
+}
+
+void CollectionConfiguration::setDocumentationManagerEnabled(QHelpEngineCore &helpEngine,
+                                                             bool enabled)
+{
+    helpEngine.setCustomValue(EnableDocManagerKey, enabled);
+}
+
+const QByteArray CollectionConfiguration::applicationIcon(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(ApplicationIconKey).toByteArray();
+}
+
+void CollectionConfiguration::setApplicationIcon(QHelpEngineCore &helpEngine,
+                                                 const QByteArray &icon)
+{
+    helpEngine.setCustomValue(ApplicationIconKey, icon);
+}
+
+const QByteArray CollectionConfiguration::aboutMenuTexts(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(AboutMenuTextsKey).toByteArray();
+}
+
+void CollectionConfiguration::setAboutMenuTexts(QHelpEngineCore &helpEngine,
+                                                const QByteArray &texts)
+{
+    helpEngine.setCustomValue(AboutMenuTextsKey, texts);
+}
+
+const QByteArray CollectionConfiguration::aboutIcon(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(AboutIconKey).toByteArray();
+}
+
+void CollectionConfiguration::setAboutIcon(QHelpEngineCore &helpEngine,
+                                           const QByteArray &icon)
+{
+    helpEngine.setCustomValue(AboutIconKey, icon);
+}
+
+const QByteArray CollectionConfiguration::aboutTexts(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(AboutTextsKey).toByteArray();
+}
+
+void CollectionConfiguration::setAboutTexts(QHelpEngineCore &helpEngine,
+                                            const QByteArray &texts)
+{
+    helpEngine.setCustomValue(AboutTextsKey, texts);
+}
+
+const QByteArray CollectionConfiguration::aboutImages(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(AboutImagesKey).toByteArray();
+}
+
+void CollectionConfiguration::setAboutImages(QHelpEngineCore &helpEngine,
+                                             const QByteArray &images)
+{
+    helpEngine.setCustomValue(AboutImagesKey, images);
+}
+
+const QString CollectionConfiguration::defaultHomePage(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(DefaultHomePageKey, QLatin1String("help")).
+        toString();
+}
+
+void CollectionConfiguration::setDefaultHomePage(QHelpEngineCore &helpEngine,
+                                                 const QString &page)
+{
+    helpEngine.setCustomValue(DefaultHomePageKey, page);
+}
+
+const QString CollectionConfiguration::homePage(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(HomePageKey).toString();
+}
+
+void CollectionConfiguration::setHomePage(QHelpEngineCore &helpEngine,
+                                          const QString &page)
+{
+    helpEngine.setCustomValue(HomePageKey, page);
+}
+
+int CollectionConfiguration::startOption(const QHelpEngineCore &helpEngine)
+{
+    // TODO: After moving to helpengine wrapper, put LastPages in that header file
+    //       and use it here as default value.
+    return helpEngine.customValue(StartOptionKey).toInt();
+}
+
+void CollectionConfiguration::setStartOption(QHelpEngineCore &helpEngine,
+                                             int option)
+{
+    helpEngine.setCustomValue(StartOptionKey, option);
+}
+
+bool CollectionConfiguration::docUpdatePending(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(DocUpdatePendingKey, false).toBool();
+}
+
+void CollectionConfiguration::setDocUpdatePending(QHelpEngineCore &helpEngine,
+                                                  bool pending)
+{
+    helpEngine.setCustomValue(DocUpdatePendingKey, pending);
+}
+
+const QByteArray CollectionConfiguration::bookmarks(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(BookmarksKey).toByteArray();
+}
+
+void CollectionConfiguration::setBookmarks(QHelpEngineCore &helpEngine,
+                                           const QByteArray &bookmarks)
+{
+    helpEngine.setCustomValue(BookmarksKey, bookmarks);
+}
+
+const QByteArray CollectionConfiguration::mainWindow(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(MainWindowKey).toByteArray();
+}
+
+void CollectionConfiguration::setMainWindow(QHelpEngineCore &helpEngine,
+                                            const QByteArray &mainWindow)
+{
+    helpEngine.setCustomValue(MainWindowKey, mainWindow);
+}
+
+const QByteArray CollectionConfiguration::mainWindowGeometry(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(MainWindowGeometryKey).toByteArray();
+}
+
+void CollectionConfiguration::setMainWindowGeometry(QHelpEngineCore &helpEngine,
+                                                    const QByteArray &geometry)
+{
+    helpEngine.setCustomValue(MainWindowGeometryKey, geometry);
+}
+
+bool CollectionConfiguration::usesAppFont(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(UseAppFontKey).toBool();
+}
+
+void CollectionConfiguration::setUseAppFont(QHelpEngineCore &helpEngine,
+                                            bool useAppFont)
+{
+    helpEngine.setCustomValue(UseAppFontKey, useAppFont);
+}
+
+bool CollectionConfiguration::usesBrowserFont(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(UseBrowserFontKey, false).toBool();
+}
+
+void CollectionConfiguration::setUseBrowserFont(QHelpEngineCore &helpEngine,
+                                                bool useBrowserFont)
+{
+    helpEngine.setCustomValue(UseBrowserFontKey, useBrowserFont);
+}
+
+const QFont CollectionConfiguration::appFont(const QHelpEngineCore &helpEngine)
+{
+    return qVariantValue<QFont>(helpEngine.customValue(AppFontKey));
+}
+
+void CollectionConfiguration::setAppFont(QHelpEngineCore &helpEngine,
+                                         const QFont &font)
+{
+    helpEngine.setCustomValue(AppFontKey, font);
+}
+
+QFontDatabase::WritingSystem CollectionConfiguration::appWritingSystem(const QHelpEngineCore &helpEngine)
+{
+    return static_cast<QFontDatabase::WritingSystem>(
+        helpEngine.customValue(AppWritingSystemKey).toInt());
+}
+
+void CollectionConfiguration::setAppWritingSystem(QHelpEngineCore &helpEngine,
+                                            QFontDatabase::WritingSystem system)
+{
+    helpEngine.setCustomValue(AppWritingSystemKey, system);
+}
+
+const QFont CollectionConfiguration::browserFont(const QHelpEngineCore &helpEngine)
+{
+    return qVariantValue<QFont>(helpEngine.customValue(BrowserFontKey));
+}
+
+void CollectionConfiguration::setBrowserFont(QHelpEngineCore &helpEngine,
+                                             const QFont &font)
+{
+    helpEngine.setCustomValue(BrowserFontKey, font);
+}
+
+QFontDatabase::WritingSystem CollectionConfiguration::browserWritingSystem(const QHelpEngineCore &helpEngine)
+{
+    return static_cast<QFontDatabase::WritingSystem>(
+        helpEngine.customValue(BrowserWritingSystemKey).toInt());
+}
+
+void CollectionConfiguration::setBrowserWritingSystem(QHelpEngineCore &helpEngine,
+                                            QFontDatabase::WritingSystem system)
+{
+    helpEngine.setCustomValue(BrowserWritingSystemKey, system);
+}
+
+bool CollectionConfiguration::unfilteredInserted(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(UnfilteredInsertedKey).toInt() == 1;
+}
+
+void CollectionConfiguration::setUnfilteredInserted(QHelpEngineCore &helpEngine)
+{
+    helpEngine.setCustomValue(UnfilteredInsertedKey, 1);
+}
+
+const QStringList CollectionConfiguration::qtDocInfo(const QHelpEngineCore &helpEngine,
+                                                     const QString &component)
+{
+    return helpEngine.customValue(VersionKey.arg(component)).toString().
+        split(ListSeparator);
+}
+
+void CollectionConfiguration::setQtDocInfo(QHelpEngineCore &helpEngine,
+                               const QString &component, const QStringList &doc)
+{
+    helpEngine.setCustomValue(VersionKey.arg(component),
+                              doc.join(ListSeparator));
+}
+
+bool CollectionConfiguration::searchWasAttached(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(SearchWasAttachedKey).toBool();
+}
+
+void CollectionConfiguration::setSearchWasAttached(QHelpEngineCore &helpEngine,
+                                                   bool attached)
+{
+    helpEngine.setCustomValue(SearchWasAttachedKey, attached);
+}
+
+bool CollectionConfiguration::hasFontSettings(const QHelpEngineCore &helpEngine)
+{
+    return helpEngine.customValue(UseAppFontKey).isValid();
+}
+
+bool CollectionConfiguration::isNewer(const QHelpEngineCore &newer,
+                                const QHelpEngineCore &older)
+{
+    return creationTime(newer) > creationTime(older);
+}
+
+void CollectionConfiguration::copyConfiguration(const QHelpEngineCore &source,
+                                                QHelpEngineCore &target)
+{
+    setCreationTime(target, creationTime(source));
+    setWindowTitle(target, windowTitle(source));
+    setLastShownPages(target, lastShownPages(source));
+    setLastZoomFactors(target, lastZoomFactors(source));
+    setCurrentFilter(target, currentFilter(source));
+    setCacheDir(target, cacheDir(source), cacheDirIsRelativeToCollection(source));
+    setFilterFunctionalityEnabled(target, filterFunctionalityEnabled(source));
+    setFilterToolbarVisible(target, filterToolbarVisible(source));
+    setAddressBarEnabled(target, addressBarEnabled(source));
+    setAddressBarVisible(target, addressBarVisible(source));
+    setDocumentationManagerEnabled(target, documentationManagerEnabled(source));
+    setApplicationIcon(target, applicationIcon(source));
+    setAboutMenuTexts(target, aboutMenuTexts(source));
+    setAboutIcon(target, aboutIcon(source));
+    setAboutTexts(target, aboutTexts(source));
+    setAboutImages(target, aboutImages(source));
+    setDefaultHomePage(target, defaultHomePage(source));
+}
+
+QT_END_NAMESPACE