| /**************************************************************************** |
| ** |
| ** 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 QHELPSEARCHINDEXREADER_H |
| #define QHELPSEARCHINDEXREADER_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 "qhelpsearchengine.h" |
| |
| #include <QtCore/QList> |
| #include <QtCore/QMutex> |
| #include <QtCore/QThread> |
| #include <QtCore/QVector> |
| |
| QT_BEGIN_NAMESPACE |
| |
| class QHelpEngineCore; |
| |
| namespace fulltextsearch { |
| |
| class QHelpSearchIndexReader : public QThread |
| { |
| Q_OBJECT |
| |
| public: |
| ~QHelpSearchIndexReader() override; |
| |
| void cancelSearching(); |
| void search(const QString &collectionFile, |
| const QString &indexFilesFolder, |
| const QString &searchInput, |
| bool usesFilterEngine = false); |
| int searchResultCount() const; |
| QVector<QHelpSearchResult> searchResults(int start, int end) const; |
| |
| signals: |
| void searchingStarted(); |
| void searchingFinished(int searchResultCount); |
| |
| protected: |
| mutable QMutex m_mutex; |
| QVector<QHelpSearchResult> m_searchResults; |
| bool m_cancel = false; |
| QString m_collectionFile; |
| QString m_searchInput; |
| QString m_indexFilesFolder; |
| bool m_usesFilterEngine = false; |
| |
| private: |
| void run() override = 0; |
| }; |
| |
| } // namespace fulltextsearch |
| |
| QT_END_NAMESPACE |
| |
| #endif // QHELPSEARCHINDEXREADER_H |