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
qhelpengine.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 QHELPENGINE_H
6#define QHELPENGINE_H
7
8#include <QtHelp/qhelpenginecore.h>
9
10QT_BEGIN_NAMESPACE
11
12class QHelpContentModel;
13class QHelpContentWidget;
14class QHelpIndexModel;
15class QHelpIndexWidget;
17class QHelpSearchEngine;
18
19class QHELP_EXPORT QHelpEngine : public QHelpEngineCore
20{
21 Q_OBJECT
22
23public:
24 explicit QHelpEngine(const QString &collectionFile, QObject *parent = nullptr);
25 ~QHelpEngine();
26
27 QHelpContentModel *contentModel() const;
28 QHelpIndexModel *indexModel() const;
29
30 QHelpContentWidget *contentWidget();
31 QHelpIndexWidget *indexWidget();
32
33 QHelpSearchEngine *searchEngine();
34
35private:
36 QHelpEnginePrivate *d;
37
38 friend class HelpEngineWrapper;
39};
40
41QT_END_NAMESPACE
42
43#endif // QHELPENGINE_H
QHelpSearchEngine * searchEngine
QHelpIndexWidget * indexWidget
QHelpContentModel * contentModel
QHelpEnginePrivate(QHelpEngineCore *helpEngineCore)
QHelpEngineCore * m_helpEngineCore
bool m_isApplyCurrentFilterScheduled
QHelpIndexModel * indexModel
QHelpContentWidget * contentWidget
The QHelpEngine class provides access to contents and indices of the help engine.
Definition qhelpengine.h:20
Combined button and popup list for selecting options.