Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qhelpsearchindexwriter_p.h
Go to the documentation of this file.
1// Copyright (C) 2016 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3// Qt-Security score:significant reason:default
4
5#ifndef QHELPSEARCHINDEXWRITER_H
6#define QHELPSEARCHINDEXWRITER_H
7
8//
9// W A R N I N G
10// -------------
11//
12// This file is not part of the Qt API. It exists for the convenience
13// of the help generator tools. This header file may change from version
14// to version without notice, or even be removed.
15//
16// We mean it.
17//
18
19#include <QtCore/qmutex.h>
20#include <QtCore/qthread.h>
21
23
24class QSqlDatabase;
25
26namespace fulltextsearch {
27
28// TODO: Employ QFuture / QtConcurrent::run() ?
30{
32
33public:
35
36 void cancelIndexing();
37 void updateIndex(const QString &collectionFile, const QString &indexFilesFolder, bool reindex);
38
42
43private:
44 void run() override;
45
46private:
47 QMutex m_mutex;
48
49 bool m_cancel = false;
50 bool m_reindex;
51 QString m_collectionFile;
52 QString m_indexFilesFolder;
53};
54
55} // namespace fulltextsearch
56
57QT_END_NAMESPACE
58
59#endif // QHELPSEARCHINDEXWRITER_H
std::unique_ptr< QHelpSearchIndexWriter > m_indexWriter
std::unique_ptr< QHelpSearchIndexReader > m_indexReader
QPointer< QHelpEngineCore > m_helpEngine
The QHelpSearchResult class provides the data associated with the search result.
void search(const QString &collectionFile, const QString &indexFilesFolder, const QString &searchInput, bool usesFilterEngine=false)
QList< QHelpSearchResult > searchResults(int start, int end) const
void updateIndex(const QString &collectionFile, const QString &indexFilesFolder, bool reindex)
Combined button and popup list for selecting options.