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
qhelpsearchresult.h
Go to the documentation of this file.
1// Copyright (C) 2024 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 QHELPSEARCHRESULT_H
5#define QHELPSEARCHRESULT_H
6
7#include <QtHelp/qhelp_global.h>
8
9#include <QtCore/qshareddata.h>
10
12
14class QString;
15class QUrl;
16
17class QHELP_EXPORT QHelpSearchResult
18{
19public:
20 QHelpSearchResult();
21 QHelpSearchResult(const QHelpSearchResult &other);
22 QHelpSearchResult(const QUrl &url, const QString &title, const QString &snippet);
23 ~QHelpSearchResult();
24
25 QHelpSearchResult &operator=(const QHelpSearchResult &other);
26
27 QString title() const;
28 QUrl url() const;
29 QString snippet() const;
30
31private:
32 QSharedDataPointer<QHelpSearchResultData> d;
33};
34
35QT_END_NAMESPACE
36
37#endif // QHELPSEARCHRESULT_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
Combined button and popup list for selecting options.