diff options
author | Lars Knoll <lars.knoll@nokia.com> | 2011-09-13 20:57:01 +0200 |
---|---|---|
committer | Lars Knoll <lars.knoll@nokia.com> | 2011-09-13 20:57:01 +0200 |
commit | 7f9aac1d910101267c95a75985a71719682e4ad6 (patch) | |
tree | ab50a2d005bc0921f68dbce36416848a437c3c0d /src/assistant/help/qhelpcollectionhandler_p.h | |
parent | 4b2d6747b51137fd2fbff83c0232d155552d6332 (diff) | |
parent | 650dc4fc2856339805a80e3170f4de6ce1003588 (diff) |
Merge remote-tracking branch 'origin/refactor' into master
Conflicts:
src/assistant/help/help.pro
src/designer/src/components/formeditor/formwindow.cpp
src/designer/src/components/formeditor/formwindow_dnditem.cpp
src/designer/src/components/formeditor/layout_propertysheet.cpp
src/designer/src/components/formeditor/qdesigner_resource.cpp
src/designer/src/components/lib/lib.pro
src/designer/src/components/signalsloteditor/signalsloteditor.cpp
src/designer/src/components/signalsloteditor/signalsloteditor_tool.cpp
src/designer/src/components/widgetbox/widgetbox_dnditem.cpp
src/designer/src/components/widgetbox/widgetboxtreewidget.cpp
src/designer/src/lib/lib.pro
src/designer/src/lib/shared/qdesigner_formbuilder.cpp
src/designer/src/lib/shared/qdesigner_propertysheet.cpp
src/designer/src/lib/shared/shared.pri
src/designer/src/plugins/qdeclarativeview/qdeclarativeview.pro
src/linguist/lupdate/qdeclarative.cpp
src/linguist/shared/profileevaluator.cpp
src/linguist/shared/qph.cpp
src/linguist/shared/ts.cpp
src/qtconfig/mainwindow.cpp
src/shared/qtgradienteditor/qtcolorline.cpp
src/shared/qtgradienteditor/qtgradientwidget.cpp
sync.profile
Change-Id: I53f0ce4efae4179257cbf3aab87e1af12c3aa4ff
Diffstat (limited to 'src/assistant/help/qhelpcollectionhandler_p.h')
-rw-r--r-- | src/assistant/help/qhelpcollectionhandler_p.h | 124 |
1 files changed, 124 insertions, 0 deletions
diff --git a/src/assistant/help/qhelpcollectionhandler_p.h b/src/assistant/help/qhelpcollectionhandler_p.h new file mode 100644 index 000000000..26da50ed1 --- /dev/null +++ b/src/assistant/help/qhelpcollectionhandler_p.h @@ -0,0 +1,124 @@ +/**************************************************************************** +** +** Copyright (C) 2011 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$ +** GNU Lesser General Public License Usage +** 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. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU General +** Public License version 3.0 as published by the Free Software Foundation +** and appearing in the file LICENSE.GPL included in the packaging of this +** file. Please review the following information to ensure the GNU General +** Public License version 3.0 requirements will be met: +** http://www.gnu.org/copyleft/gpl.html. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms and +** conditions contained in a signed written agreement between you and Nokia. +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#ifndef QHELPCOLLECTIONHANDLER_H +#define QHELPCOLLECTIONHANDLER_H + +// +// W A R N I N G +// ------------- +// +// This file is not part of the Qt API. It exists for the convenience +// of the help generator tools. This header file may change from version +// to version without notice, or even be removed. +// +// We mean it. +// + +#include <QtCore/QList> +#include <QtCore/QString> +#include <QtCore/QObject> +#include <QtCore/QVariant> +#include <QtCore/QStringList> + +#include <QtSql/QSqlQuery> + +QT_BEGIN_NAMESPACE + +class QHelpCollectionHandler : public QObject +{ + Q_OBJECT + +public: + struct DocInfo + { + QString fileName; + QString folderName; + QString namespaceName; + }; + typedef QList<DocInfo> DocInfoList; + + explicit QHelpCollectionHandler(const QString &collectionFile, + QObject *parent = 0); + ~QHelpCollectionHandler(); + + QString collectionFile() const; + + bool openCollectionFile(); + bool copyCollectionFile(const QString &fileName); + + QStringList customFilters() const; + bool removeCustomFilter(const QString &filterName); + bool addCustomFilter(const QString &filterName, + const QStringList &attributes); + + DocInfoList registeredDocumentations() const; + bool registerDocumentation(const QString &fileName); + bool unregisterDocumentation(const QString &namespaceName); + + bool removeCustomValue(const QString &key); + QVariant customValue(const QString &key, const QVariant &defaultValue) const; + bool setCustomValue(const QString &key, const QVariant &value); + + bool addFilterAttributes(const QStringList &attributes); + QStringList filterAttributes() const; + QStringList filterAttributes(const QString &filterName) const; + + int registerNamespace(const QString &nspace, const QString &fileName); + bool registerVirtualFolder(const QString &folderName, int namespaceId); + void optimizeDatabase(const QString &fileName); + +signals: + void error(const QString &msg); + +private: + bool isDBOpened(); + bool createTables(QSqlQuery *query); + + bool m_dbOpened; + QString m_collectionFile; + QString m_connectionName; + mutable QSqlQuery m_query; +}; + +QT_END_NAMESPACE + +#endif //QHELPCOLLECTIONHANDLER_H |