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
4#ifndef QHELPSEARCHINDEXWRITER_H
5#define QHELPSEARCHINDEXWRITER_H
6
7//
8// W A R N I N G
9// -------------
10//
11// This file is not part of the Qt API. It exists for the convenience
12// of the help generator tools. This header file may change from version
13// to version without notice, or even be removed.
14//
15// We mean it.
16//
17
18#include <QtCore/qmutex.h>
19#include <QtCore/qthread.h>
20
22
23class QSqlDatabase;
24
25namespace fulltextsearch {
26
27// TODO: Employ QFuture / QtConcurrent::run() ?
29{
31
32public:
34
35 void cancelIndexing();
36 void updateIndex(const QString &collectionFile, const QString &indexFilesFolder, bool reindex);
37
41
42private:
43 void run() override;
44
45private:
46 QMutex m_mutex;
47
48 bool m_cancel = false;
49 bool m_reindex;
50 QString m_collectionFile;
51 QString m_indexFilesFolder;
52};
53
54} // namespace fulltextsearch
55
56QT_END_NAMESPACE
57
58#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.