1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://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 http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://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 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file. Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #include "collectionconfiguration.h"
43
44 #include <QtHelp/QHelpEngineCore>
45
46 QT_BEGIN_NAMESPACE
47
48 namespace {
49 const QString AboutIconKey(QLatin1String("AboutIcon"));
50 const QString AboutImagesKey(QLatin1String("AboutImages"));
51 const QString AboutMenuTextsKey(QLatin1String("AboutMenuTexts"));
52 const QString AboutTextsKey(QLatin1String("AboutTexts"));
53 const QString ApplicationIconKey(QLatin1String("ApplicationIcon"));
54 const QString CacheDirKey(QLatin1String("CacheDirectory"));
55 const QString CacheDirRelativeToCollectionKey(QLatin1String("CacheDirRelativeToCollection"));
56 const QString CreationTimeKey(QLatin1String("CreationTime"));
57 const QString DefaultHomePageKey(QLatin1String("defaultHomepage"));
58 const QString EnableAddressBarKey(QLatin1String("EnableAddressBar"));
59 const QString EnableDocManagerKey(QLatin1String("EnableDocumentationManager"));
60 const QString EnableFilterKey(QLatin1String("EnableFilterFunctionality"));
61 const QString HideAddressBarKey(QLatin1String("HideAddressBar"));
62 const QString FilterToolbarHiddenKey(QLatin1String("HideFilterFunctionality"));
63 const QString LastPageKey(QLatin1String("LastTabPage"));
64 const QString LastRegisterTime(QLatin1String("LastRegisterTime"));
65 const QString LastShownPagesKey(QLatin1String("LastShownPages"));
66 const QString LastZoomFactorsKey(QLatin1String(
67 #if !defined(QT_NO_WEBKIT)
68 "LastPagesZoomWebView"
69 #else
70 "LastPagesZoomTextBrowser"
71 #endif
72 ));
73 const QString WindowTitleKey(QLatin1String("WindowTitle"));
74 const QString FullTextSearchFallbackKey(QLatin1String("FullTextSearchFallback"));
75 } // anonymous namespace
76
77 const QString CollectionConfiguration::DefaultZoomFactor(QLatin1String("0.0"));
78 const QString CollectionConfiguration::ListSeparator(QLatin1String("|"));
79
creationTime(const QHelpEngineCore & helpEngine)80 uint CollectionConfiguration::creationTime(const QHelpEngineCore &helpEngine)
81 {
82 return helpEngine.customValue(CreationTimeKey, 0).toUInt();
83 }
84
setCreationTime(QHelpEngineCore & helpEngine,uint time)85 void CollectionConfiguration::setCreationTime(QHelpEngineCore &helpEngine, uint time)
86 {
87 helpEngine.setCustomValue(CreationTimeKey, time);
88 }
89
windowTitle(const QHelpEngineCore & helpEngine)90 const QString CollectionConfiguration::windowTitle(const QHelpEngineCore &helpEngine)
91 {
92 return helpEngine.customValue(WindowTitleKey).toString();
93 }
94
setWindowTitle(QHelpEngineCore & helpEngine,const QString & windowTitle)95 void CollectionConfiguration::setWindowTitle(QHelpEngineCore &helpEngine,
96 const QString &windowTitle)
97 {
98 helpEngine.setCustomValue(WindowTitleKey, windowTitle);
99 }
100
filterFunctionalityEnabled(const QHelpEngineCore & helpEngine)101 bool CollectionConfiguration::filterFunctionalityEnabled(const QHelpEngineCore &helpEngine)
102 {
103 return helpEngine.customValue(EnableFilterKey, true).toBool();
104 }
105
setFilterFunctionalityEnabled(QHelpEngineCore & helpEngine,bool enabled)106 void CollectionConfiguration::setFilterFunctionalityEnabled(QHelpEngineCore &helpEngine,
107 bool enabled)
108 {
109 helpEngine.setCustomValue(EnableFilterKey, enabled);
110 }
111
filterToolbarVisible(const QHelpEngineCore & helpEngine)112 bool CollectionConfiguration::filterToolbarVisible(const QHelpEngineCore &helpEngine)
113 {
114 return !helpEngine.customValue(FilterToolbarHiddenKey, true).toBool();
115 }
116
setFilterToolbarVisible(QHelpEngineCore & helpEngine,bool visible)117 void CollectionConfiguration::setFilterToolbarVisible(QHelpEngineCore &helpEngine,
118 bool visible)
119 {
120 helpEngine.setCustomValue(FilterToolbarHiddenKey, !visible);
121 }
122
addressBarEnabled(const QHelpEngineCore & helpEngine)123 bool CollectionConfiguration::addressBarEnabled(const QHelpEngineCore &helpEngine)
124 {
125 return helpEngine.customValue(EnableAddressBarKey, true).toBool();
126 }
127
setAddressBarEnabled(QHelpEngineCore & helpEngine,bool enabled)128 void CollectionConfiguration::setAddressBarEnabled(QHelpEngineCore &helpEngine,
129 bool enabled)
130 {
131 helpEngine.setCustomValue(EnableAddressBarKey, enabled);
132 }
133
addressBarVisible(const QHelpEngineCore & helpEngine)134 bool CollectionConfiguration::addressBarVisible(const QHelpEngineCore &helpEngine)
135 {
136 return !helpEngine.customValue(HideAddressBarKey, true).toBool();
137 }
138
setAddressBarVisible(QHelpEngineCore & helpEngine,bool visible)139 void CollectionConfiguration::setAddressBarVisible(QHelpEngineCore &helpEngine,
140 bool visible)
141 {
142 helpEngine.setCustomValue(HideAddressBarKey, !visible);
143 }
144
cacheDir(const QHelpEngineCore & helpEngine)145 const QString CollectionConfiguration::cacheDir(const QHelpEngineCore &helpEngine)
146 {
147 return helpEngine.customValue(CacheDirKey).toString();
148 }
149
cacheDirIsRelativeToCollection(const QHelpEngineCore & helpEngine)150 bool CollectionConfiguration::cacheDirIsRelativeToCollection(const QHelpEngineCore &helpEngine)
151 {
152 return helpEngine.customValue(CacheDirRelativeToCollectionKey).toBool();
153 }
154
setCacheDir(QHelpEngineCore & helpEngine,const QString & cacheDir,bool relativeToCollection)155 void CollectionConfiguration::setCacheDir(QHelpEngineCore &helpEngine,
156 const QString &cacheDir, bool relativeToCollection)
157 {
158 helpEngine.setCustomValue(CacheDirKey, cacheDir);
159 helpEngine.setCustomValue(CacheDirRelativeToCollectionKey,
160 relativeToCollection);
161 }
162
documentationManagerEnabled(const QHelpEngineCore & helpEngine)163 bool CollectionConfiguration::documentationManagerEnabled(const QHelpEngineCore &helpEngine)
164 {
165 return helpEngine.customValue(EnableDocManagerKey, true).toBool();
166 }
167
setDocumentationManagerEnabled(QHelpEngineCore & helpEngine,bool enabled)168 void CollectionConfiguration::setDocumentationManagerEnabled(QHelpEngineCore &helpEngine,
169 bool enabled)
170 {
171 helpEngine.setCustomValue(EnableDocManagerKey, enabled);
172 }
173
applicationIcon(const QHelpEngineCore & helpEngine)174 const QByteArray CollectionConfiguration::applicationIcon(const QHelpEngineCore &helpEngine)
175 {
176 return helpEngine.customValue(ApplicationIconKey).toByteArray();
177 }
178
setApplicationIcon(QHelpEngineCore & helpEngine,const QByteArray & icon)179 void CollectionConfiguration::setApplicationIcon(QHelpEngineCore &helpEngine,
180 const QByteArray &icon)
181 {
182 helpEngine.setCustomValue(ApplicationIconKey, icon);
183 }
184
aboutMenuTexts(const QHelpEngineCore & helpEngine)185 const QByteArray CollectionConfiguration::aboutMenuTexts(const QHelpEngineCore &helpEngine)
186 {
187 return helpEngine.customValue(AboutMenuTextsKey).toByteArray();
188 }
189
setAboutMenuTexts(QHelpEngineCore & helpEngine,const QByteArray & texts)190 void CollectionConfiguration::setAboutMenuTexts(QHelpEngineCore &helpEngine,
191 const QByteArray &texts)
192 {
193 helpEngine.setCustomValue(AboutMenuTextsKey, texts);
194 }
195
aboutIcon(const QHelpEngineCore & helpEngine)196 const QByteArray CollectionConfiguration::aboutIcon(const QHelpEngineCore &helpEngine)
197 {
198 return helpEngine.customValue(AboutIconKey).toByteArray();
199 }
200
setAboutIcon(QHelpEngineCore & helpEngine,const QByteArray & icon)201 void CollectionConfiguration::setAboutIcon(QHelpEngineCore &helpEngine,
202 const QByteArray &icon)
203 {
204 helpEngine.setCustomValue(AboutIconKey, icon);
205 }
206
aboutTexts(const QHelpEngineCore & helpEngine)207 const QByteArray CollectionConfiguration::aboutTexts(const QHelpEngineCore &helpEngine)
208 {
209 return helpEngine.customValue(AboutTextsKey).toByteArray();
210 }
211
setAboutTexts(QHelpEngineCore & helpEngine,const QByteArray & texts)212 void CollectionConfiguration::setAboutTexts(QHelpEngineCore &helpEngine,
213 const QByteArray &texts)
214 {
215 helpEngine.setCustomValue(AboutTextsKey, texts);
216 }
217
aboutImages(const QHelpEngineCore & helpEngine)218 const QByteArray CollectionConfiguration::aboutImages(const QHelpEngineCore &helpEngine)
219 {
220 return helpEngine.customValue(AboutImagesKey).toByteArray();
221 }
222
setAboutImages(QHelpEngineCore & helpEngine,const QByteArray & images)223 void CollectionConfiguration::setAboutImages(QHelpEngineCore &helpEngine,
224 const QByteArray &images)
225 {
226 helpEngine.setCustomValue(AboutImagesKey, images);
227 }
228
defaultHomePage(const QHelpEngineCore & helpEngine)229 const QString CollectionConfiguration::defaultHomePage(const QHelpEngineCore &helpEngine)
230 {
231 return helpEngine.customValue(DefaultHomePageKey, QLatin1String("help")).
232 toString();
233 }
234
setDefaultHomePage(QHelpEngineCore & helpEngine,const QString & page)235 void CollectionConfiguration::setDefaultHomePage(QHelpEngineCore &helpEngine,
236 const QString &page)
237 {
238 helpEngine.setCustomValue(DefaultHomePageKey, page);
239 }
240
lastShownPages(const QHelpEngineCore & helpEngine)241 const QStringList CollectionConfiguration::lastShownPages(const QHelpEngineCore &helpEngine)
242 {
243 return helpEngine.customValue(LastShownPagesKey).toString().
244 split(ListSeparator, QString::SkipEmptyParts);
245 }
246
setLastShownPages(QHelpEngineCore & helpEngine,const QStringList & lastShownPages)247 void CollectionConfiguration::setLastShownPages(QHelpEngineCore &helpEngine,
248 const QStringList &lastShownPages)
249 {
250 helpEngine.setCustomValue(LastShownPagesKey,
251 lastShownPages.join(ListSeparator));
252 }
253
lastZoomFactors(const QHelpEngineCore & helpEngine)254 const QStringList CollectionConfiguration::lastZoomFactors(const QHelpEngineCore &helpEngine)
255 {
256 return helpEngine.customValue(LastZoomFactorsKey).toString().
257 split(ListSeparator, QString::SkipEmptyParts);
258 }
259
setLastZoomFactors(QHelpEngineCore & helpEngine,const QStringList & lastZoomFactors)260 void CollectionConfiguration::setLastZoomFactors(QHelpEngineCore &helpEngine,
261 const QStringList &lastZoomFactors)
262 {
263 helpEngine.setCustomValue(LastZoomFactorsKey,
264 lastZoomFactors.join(ListSeparator));
265 }
266
lastTabPage(const QHelpEngineCore & helpEngine)267 int CollectionConfiguration::lastTabPage(const QHelpEngineCore &helpEngine)
268 {
269 return helpEngine.customValue(LastPageKey, 1).toInt();
270 }
271
setLastTabPage(QHelpEngineCore & helpEngine,int lastPage)272 void CollectionConfiguration::setLastTabPage(QHelpEngineCore &helpEngine,
273 int lastPage)
274 {
275 helpEngine.setCustomValue(LastPageKey, lastPage);
276 }
277
lastRegisterTime(const QHelpEngineCore & helpEngine)278 const QDateTime CollectionConfiguration::lastRegisterTime(const QHelpEngineCore &helpEngine)
279 {
280 return helpEngine.customValue(LastRegisterTime, QDateTime()).toDateTime();
281 }
282
updateLastRegisterTime(QHelpEngineCore & helpEngine)283 void CollectionConfiguration::updateLastRegisterTime(QHelpEngineCore &helpEngine)
284 {
285 helpEngine.setCustomValue(LastRegisterTime, QDateTime::currentDateTime());
286 }
287
isNewer(const QHelpEngineCore & newer,const QHelpEngineCore & older)288 bool CollectionConfiguration::isNewer(const QHelpEngineCore &newer,
289 const QHelpEngineCore &older)
290 {
291 return creationTime(newer) > creationTime(older);
292 }
293
copyConfiguration(const QHelpEngineCore & source,QHelpEngineCore & target)294 void CollectionConfiguration::copyConfiguration(const QHelpEngineCore &source,
295 QHelpEngineCore &target)
296 {
297 setCreationTime(target, creationTime(source));
298 setWindowTitle(target, windowTitle(source));
299 target.setCurrentFilter(source.currentFilter());
300 setCacheDir(target, cacheDir(source), cacheDirIsRelativeToCollection(source));
301 setFilterFunctionalityEnabled(target, filterFunctionalityEnabled(source));
302 setFilterToolbarVisible(target, filterToolbarVisible(source));
303 setAddressBarEnabled(target, addressBarEnabled(source));
304 setAddressBarVisible(target, addressBarVisible(source));
305 setDocumentationManagerEnabled(target, documentationManagerEnabled(source));
306 setApplicationIcon(target, applicationIcon(source));
307 setAboutMenuTexts(target, aboutMenuTexts(source));
308 setAboutIcon(target, aboutIcon(source));
309 setAboutTexts(target, aboutTexts(source));
310 setAboutImages(target, aboutImages(source));
311 setDefaultHomePage(target, defaultHomePage(source));
312 setFullTextSearchFallbackEnabled(target, fullTextSearchFallbackEnabled(source));
313 }
314
fullTextSearchFallbackEnabled(const QHelpEngineCore & helpEngine)315 bool CollectionConfiguration:: fullTextSearchFallbackEnabled(
316 const QHelpEngineCore &helpEngine)
317 {
318 return helpEngine.customValue(FullTextSearchFallbackKey, false).toBool();
319 }
320
setFullTextSearchFallbackEnabled(QHelpEngineCore & helpEngine,bool on)321 void CollectionConfiguration::setFullTextSearchFallbackEnabled(
322 QHelpEngineCore &helpEngine, bool on)
323 {
324 helpEngine.setCustomValue(FullTextSearchFallbackKey, on);
325 }
326
327 QT_END_NAMESPACE
328