1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the Qt Assistant of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #ifndef QHELPENGINE_P_H
41 #define QHELPENGINE_P_H
42 
43 //
44 //  W A R N I N G
45 //  -------------
46 //
47 // This file is not part of the Qt API. It exists for the convenience
48 // of the help generator tools. This header file may change from version
49 // to version without notice, or even be removed.
50 //
51 // We mean it.
52 //
53 
54 #include <QtCore/QHash>
55 #include <QtCore/QMap>
56 #include <QtCore/QStringList>
57 #include <QtCore/QObject>
58 
59 QT_BEGIN_NAMESPACE
60 
61 class QSqlQuery;
62 
63 class QHelpEngineCore;
64 class QHelpDBReader;
65 class QHelpContentModel;
66 class QHelpContentWidget;
67 class QHelpIndexModel;
68 class QHelpIndexWidget;
69 class QHelpSearchEngine;
70 class QHelpCollectionHandler;
71 class QHelpFilterEngine;
72 
73 class QHelpEngineCorePrivate : public QObject
74 {
75     Q_OBJECT
76 
77 public:
78     virtual ~QHelpEngineCorePrivate();
79 
80     virtual void init(const QString &collectionFile,
81         QHelpEngineCore *helpEngineCore);
82 
83     bool setup();
84 
85     QHelpCollectionHandler *collectionHandler = nullptr;
86     QHelpFilterEngine *filterEngine = nullptr;
87     QString currentFilter;
88     QString error;
89     bool needsSetup = true;
90     bool autoSaveFilter = true;
91     bool usesFilterEngine = false;
92 
93 protected:
94     QHelpEngineCore *q;
95 
96 private slots:
97     void errorReceived(const QString &msg);
98 };
99 
100 class QHelpEnginePrivate : public QHelpEngineCorePrivate
101 {
102     Q_OBJECT
103 
104 public:
105     void init(const QString &collectionFile,
106         QHelpEngineCore *helpEngineCore) override;
107 
108     QHelpContentModel *contentModel = nullptr;
109     QHelpContentWidget *contentWidget = nullptr;
110 
111     QHelpIndexModel *indexModel = nullptr;
112     QHelpIndexWidget *indexWidget = nullptr;
113 
114     QHelpSearchEngine *searchEngine = nullptr;
115 
116     friend class QHelpContentProvider;
117     friend class QHelpContentModel;
118     friend class QHelpIndexProvider;
119     friend class QHelpIndexModel;
120 
121 public slots:
122     void setContentsWidgetBusy();
123     void unsetContentsWidgetBusy();
124     void setIndexWidgetBusy();
125     void unsetIndexWidgetBusy();
126 
127 private slots:
128     void scheduleApplyCurrentFilter();
129     void applyCurrentFilter();
130 
131 private:
132     bool m_isApplyCurrentFilterScheduled = false;
133 
134 };
135 
136 QT_END_NAMESPACE
137 
138 #endif
139