| /**************************************************************************** |
| ** |
| ** Copyright (C) 2016 The Qt Company Ltd. |
| ** Contact: https://www.qt.io/licensing/ |
| ** |
| ** This file is part of the Qt Assistant of the Qt Toolkit. |
| ** |
| ** $QT_BEGIN_LICENSE:LGPL$ |
| ** Commercial License Usage |
| ** Licensees holding valid commercial Qt licenses may use this file in |
| ** accordance with the commercial license agreement provided with the |
| ** Software or, alternatively, in accordance with the terms contained in |
| ** a written agreement between you and The Qt Company. For licensing terms |
| ** and conditions see https://www.qt.io/terms-conditions. For further |
| ** information use the contact form at https://www.qt.io/contact-us. |
| ** |
| ** GNU Lesser General Public License Usage |
| ** Alternatively, this file may be used under the terms of the GNU Lesser |
| ** General Public License version 3 as published by the Free Software |
| ** Foundation and appearing in the file LICENSE.LGPL3 included in the |
| ** packaging of this file. Please review the following information to |
| ** ensure the GNU Lesser General Public License version 3 requirements |
| ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. |
| ** |
| ** GNU General Public License Usage |
| ** Alternatively, this file may be used under the terms of the GNU |
| ** General Public License version 2.0 or (at your option) the GNU General |
| ** Public license version 3 or any later version approved by the KDE Free |
| ** Qt Foundation. The licenses are as published by the Free Software |
| ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 |
| ** included in the packaging of this file. Please review the following |
| ** information to ensure the GNU General Public License requirements will |
| ** be met: https://www.gnu.org/licenses/gpl-2.0.html and |
| ** https://www.gnu.org/licenses/gpl-3.0.html. |
| ** |
| ** $QT_END_LICENSE$ |
| ** |
| ****************************************************************************/ |
| |
| #ifndef QHELPENGINECORE_H |
| #define QHELPENGINECORE_H |
| |
| #include <QtHelp/qhelp_global.h> |
| |
| #include <QtCore/QUrl> |
| #include <QtCore/QMap> |
| #include <QtCore/QObject> |
| #include <QtCore/QVariant> |
| |
| QT_BEGIN_NAMESPACE |
| |
| class QHelpEngineCorePrivate; |
| class QHelpFilterEngine; |
| struct QHelpLink; |
| |
| class QHELP_EXPORT QHelpEngineCore : public QObject |
| { |
| Q_OBJECT |
| Q_PROPERTY(bool autoSaveFilter READ autoSaveFilter WRITE setAutoSaveFilter) |
| Q_PROPERTY(QString collectionFile READ collectionFile WRITE setCollectionFile) |
| #if QT_DEPRECATED_SINCE(5, 15) |
| Q_PROPERTY(QString currentFilter READ currentFilter WRITE setCurrentFilter) |
| #endif |
| |
| public: |
| explicit QHelpEngineCore(const QString &collectionFile, QObject *parent = nullptr); |
| virtual ~QHelpEngineCore(); |
| |
| QHelpFilterEngine *filterEngine() const; |
| |
| bool setupData(); |
| |
| QString collectionFile() const; |
| void setCollectionFile(const QString &fileName); |
| |
| bool copyCollectionFile(const QString &fileName); |
| |
| static QString namespaceName(const QString &documentationFileName); |
| bool registerDocumentation(const QString &documentationFileName); |
| bool unregisterDocumentation(const QString &namespaceName); |
| QString documentationFileName(const QString &namespaceName); |
| QStringList registeredDocumentations() const; |
| QByteArray fileData(const QUrl &url) const; |
| |
| #if QT_DEPRECATED_SINCE(5,13) |
| QStringList customFilters() const; |
| bool removeCustomFilter(const QString &filterName); |
| bool addCustomFilter(const QString &filterName, |
| const QStringList &attributes); |
| |
| QStringList filterAttributes() const; |
| QStringList filterAttributes(const QString &filterName) const; |
| |
| QString currentFilter() const; |
| void setCurrentFilter(const QString &filterName); |
| |
| QList<QStringList> filterAttributeSets(const QString &namespaceName) const; |
| QList<QUrl> files(const QString namespaceName, |
| const QStringList &filterAttributes, |
| const QString &extensionFilter = QString()); |
| #endif |
| |
| QList<QUrl> files(const QString namespaceName, |
| const QString &filterName, |
| const QString &extensionFilter = QString()); |
| QUrl findFile(const QUrl &url) const; |
| |
| #if QT_DEPRECATED_SINCE(5, 15) |
| QT_DEPRECATED_X("Use documentsForIdentifier() instead") |
| QMap<QString, QUrl> linksForIdentifier(const QString &id) const; |
| QT_DEPRECATED_X("Use documentsForKeyword() instead") |
| QMap<QString, QUrl> linksForKeyword(const QString &keyword) const; |
| #endif |
| |
| QList<QHelpLink> documentsForIdentifier(const QString &id) const; |
| QList<QHelpLink> documentsForIdentifier(const QString &id, const QString &filterName) const; |
| QList<QHelpLink> documentsForKeyword(const QString &keyword) const; |
| QList<QHelpLink> documentsForKeyword(const QString &keyword, const QString &filterName) const; |
| |
| bool removeCustomValue(const QString &key); |
| QVariant customValue(const QString &key, |
| const QVariant &defaultValue = QVariant()) const; |
| bool setCustomValue(const QString &key, const QVariant &value); |
| |
| static QVariant metaData(const QString &documentationFileName, |
| const QString &name); |
| |
| QString error() const; |
| |
| void setAutoSaveFilter(bool save); |
| bool autoSaveFilter() const; |
| |
| void setUsesFilterEngine(bool uses); |
| bool usesFilterEngine() const; |
| |
| Q_SIGNALS: |
| void setupStarted(); |
| void setupFinished(); |
| void warning(const QString &msg); |
| |
| #if QT_DEPRECATED_SINCE(5,13) |
| void currentFilterChanged(const QString &newFilter); |
| void readersAboutToBeInvalidated(); |
| #endif |
| |
| protected: |
| QHelpEngineCore(QHelpEngineCorePrivate *helpEngineCorePrivate, |
| QObject *parent); |
| |
| private: |
| QHelpEngineCorePrivate *d; |
| friend class QHelpEngineCorePrivate; |
| }; |
| |
| QT_END_NAMESPACE |
| |
| #endif // QHELPENGINECORE_H |