summaryrefslogtreecommitdiffstats
path: root/src/assistant/help/qhelpsearchenginecore.h
blob: d820a8f3d818d653fca47de97ad1753d9f7e899e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

#ifndef QHELPSEARCHENGINECORE_H
#define QHELPSEARCHENGINECORE_H

#include <QtHelp/qhelp_global.h>
#include <QtHelp/qhelpsearchresult.h>

#include <QtCore/qobject.h>
#include <QtCore/qshareddata.h>

QT_BEGIN_NAMESPACE

class QHelpEngineCore;
class QHelpSearchEngineCorePrivate;

class QHELP_EXPORT QHelpSearchEngineCore : public QObject
{
    Q_OBJECT

public:
    explicit QHelpSearchEngineCore(QHelpEngineCore *helpEngine);
    ~QHelpSearchEngineCore();

    int searchResultCount() const;
    QList<QHelpSearchResult> searchResults(int start, int end) const;
    QString searchInput() const;

    void reindexDocumentation();
    void cancelIndexing();

    void search(const QString &searchInput);
    void cancelSearching(); // TODO: is it needed?

    void scheduleIndexDocumentation();

Q_SIGNALS:
    void indexingStarted();
    void indexingFinished();

    void searchingStarted();
    void searchingFinished(int searchResultCount);

private:
    QHelpSearchEngineCorePrivate *d;
};

QT_END_NAMESPACE

#endif // QHELPSEARCHENGINECORE_H