|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
4 ** All rights reserved. |
|
5 ** Contact: Nokia Corporation (qt-info@nokia.com) |
|
6 ** |
|
7 ** This file is part of the Qt Assistant of the Qt Toolkit. |
|
8 ** |
|
9 ** $QT_BEGIN_LICENSE:LGPL$ |
|
10 ** No Commercial Usage |
|
11 ** This file contains pre-release code and may not be distributed. |
|
12 ** You may use this file in accordance with the terms and conditions |
|
13 ** contained in the Technology Preview License Agreement accompanying |
|
14 ** this package. |
|
15 ** |
|
16 ** GNU Lesser General Public License Usage |
|
17 ** Alternatively, this file may be used under the terms of the GNU Lesser |
|
18 ** General Public License version 2.1 as published by the Free Software |
|
19 ** Foundation and appearing in the file LICENSE.LGPL included in the |
|
20 ** packaging of this file. Please review the following information to |
|
21 ** ensure the GNU Lesser General Public License version 2.1 requirements |
|
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
|
23 ** |
|
24 ** In addition, as a special exception, Nokia gives you certain additional |
|
25 ** rights. These rights are described in the Nokia Qt LGPL Exception |
|
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
|
27 ** |
|
28 ** If you have questions regarding the use of this file, please contact |
|
29 ** Nokia at qt-info@nokia.com. |
|
30 ** |
|
31 ** |
|
32 ** |
|
33 ** |
|
34 ** |
|
35 ** |
|
36 ** |
|
37 ** |
|
38 ** $QT_END_LICENSE$ |
|
39 ** |
|
40 ****************************************************************************/ |
|
41 |
|
42 #include "qhelpengine.h" |
|
43 #include "qhelpengine_p.h" |
|
44 #include "qhelpdbreader_p.h" |
|
45 #include "qhelpcontentwidget.h" |
|
46 #include "qhelpindexwidget.h" |
|
47 #include "qhelpsearchengine.h" |
|
48 #include "qhelpcollectionhandler_p.h" |
|
49 |
|
50 #include <QtCore/QDir> |
|
51 #include <QtCore/QFile> |
|
52 #include <QtCore/QLibrary> |
|
53 #include <QtCore/QPluginLoader> |
|
54 #include <QtGui/QApplication> |
|
55 #include <QtSql/QSqlQuery> |
|
56 |
|
57 QT_BEGIN_NAMESPACE |
|
58 |
|
59 QHelpEnginePrivate::QHelpEnginePrivate() |
|
60 : QHelpEngineCorePrivate() |
|
61 , contentModel(0) |
|
62 , contentWidget(0) |
|
63 , indexModel(0) |
|
64 , indexWidget(0) |
|
65 , searchEngine(0) |
|
66 { |
|
67 } |
|
68 |
|
69 QHelpEnginePrivate::~QHelpEnginePrivate() |
|
70 { |
|
71 } |
|
72 |
|
73 void QHelpEnginePrivate::init(const QString &collectionFile, |
|
74 QHelpEngineCore *helpEngineCore) |
|
75 { |
|
76 QHelpEngineCorePrivate::init(collectionFile, helpEngineCore); |
|
77 |
|
78 contentModel = new QHelpContentModel(this); |
|
79 indexModel = new QHelpIndexModel(this); |
|
80 |
|
81 connect(helpEngineCore, SIGNAL(setupFinished()), |
|
82 this, SLOT(applyCurrentFilter())); |
|
83 connect(helpEngineCore, SIGNAL(currentFilterChanged(const QString&)), |
|
84 this, SLOT(applyCurrentFilter())); |
|
85 |
|
86 } |
|
87 |
|
88 void QHelpEnginePrivate::applyCurrentFilter() |
|
89 { |
|
90 if (!error.isEmpty()) |
|
91 return; |
|
92 contentModel->createContents(currentFilter); |
|
93 indexModel->createIndex(currentFilter); |
|
94 } |
|
95 |
|
96 void QHelpEnginePrivate::setContentsWidgetBusy() |
|
97 { |
|
98 contentWidget->setCursor(Qt::WaitCursor); |
|
99 } |
|
100 |
|
101 void QHelpEnginePrivate::unsetContentsWidgetBusy() |
|
102 { |
|
103 contentWidget->unsetCursor(); |
|
104 } |
|
105 |
|
106 void QHelpEnginePrivate::setIndexWidgetBusy() |
|
107 { |
|
108 indexWidget->setCursor(Qt::WaitCursor); |
|
109 } |
|
110 |
|
111 void QHelpEnginePrivate::unsetIndexWidgetBusy() |
|
112 { |
|
113 indexWidget->unsetCursor(); |
|
114 } |
|
115 |
|
116 void QHelpEnginePrivate::stopDataCollection() |
|
117 { |
|
118 contentModel->invalidateContents(true); |
|
119 indexModel->invalidateIndex(true); |
|
120 } |
|
121 |
|
122 |
|
123 |
|
124 /*! |
|
125 \class QHelpEngine |
|
126 \since 4.4 |
|
127 \inmodule QtHelp |
|
128 \brief The QHelpEngine class provides access to contents and |
|
129 indices of the help engine. |
|
130 |
|
131 |
|
132 */ |
|
133 |
|
134 /*! |
|
135 Constructs a new help engine with the given \a parent. The help |
|
136 engine uses the information stored in the \a collectionFile for |
|
137 providing help. If the collection file does not already exist, |
|
138 it will be created. |
|
139 */ |
|
140 QHelpEngine::QHelpEngine(const QString &collectionFile, QObject *parent) |
|
141 : QHelpEngineCore(d = new QHelpEnginePrivate(), parent) |
|
142 { |
|
143 d->init(collectionFile, this); |
|
144 } |
|
145 |
|
146 /*! |
|
147 Destroys the help engine object. |
|
148 */ |
|
149 QHelpEngine::~QHelpEngine() |
|
150 { |
|
151 d->stopDataCollection(); |
|
152 } |
|
153 |
|
154 /*! |
|
155 Returns the content model. |
|
156 */ |
|
157 QHelpContentModel *QHelpEngine::contentModel() const |
|
158 { |
|
159 return d->contentModel; |
|
160 } |
|
161 |
|
162 /*! |
|
163 Returns the index model. |
|
164 */ |
|
165 QHelpIndexModel *QHelpEngine::indexModel() const |
|
166 { |
|
167 return d->indexModel; |
|
168 } |
|
169 |
|
170 /*! |
|
171 Returns the content widget. |
|
172 */ |
|
173 QHelpContentWidget *QHelpEngine::contentWidget() |
|
174 { |
|
175 if (!d->contentWidget) { |
|
176 d->contentWidget = new QHelpContentWidget(); |
|
177 d->contentWidget->setModel(d->contentModel); |
|
178 connect(d->contentModel, SIGNAL(contentsCreationStarted()), |
|
179 d, SLOT(setContentsWidgetBusy())); |
|
180 connect(d->contentModel, SIGNAL(contentsCreated()), |
|
181 d, SLOT(unsetContentsWidgetBusy())); |
|
182 } |
|
183 return d->contentWidget; |
|
184 } |
|
185 |
|
186 /*! |
|
187 Returns the index widget. |
|
188 */ |
|
189 QHelpIndexWidget *QHelpEngine::indexWidget() |
|
190 { |
|
191 if (!d->indexWidget) { |
|
192 d->indexWidget = new QHelpIndexWidget(); |
|
193 d->indexWidget->setModel(d->indexModel); |
|
194 connect(d->indexModel, SIGNAL(indexCreationStarted()), |
|
195 d, SLOT(setIndexWidgetBusy())); |
|
196 connect(d->indexModel, SIGNAL(indexCreated()), |
|
197 d, SLOT(unsetIndexWidgetBusy())); |
|
198 } |
|
199 return d->indexWidget; |
|
200 } |
|
201 |
|
202 /*! |
|
203 Returns the default search engine. |
|
204 */ |
|
205 QHelpSearchEngine* QHelpEngine::searchEngine() |
|
206 { |
|
207 if (!d->searchEngine) |
|
208 d->searchEngine = new QHelpSearchEngine(this, this); |
|
209 return d->searchEngine; |
|
210 } |
|
211 |
|
212 QT_END_NAMESPACE |