blob: e43abec9255b647620ed84afbb8065ef8a63ca15 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Assistant of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef HELPENGINEWRAPPER_H
#define HELPENGINEWRAPPER_H
#include <QtCore/QMap>
#include <QtCore/QObject>
#include <QtCore/QString>
#include <QtCore/QStringList>
#include <QtCore/QUrl>
#include <QtGui/QFont>
#include <QtGui/QFontDatabase>
#include "qhelplink.h"
QT_BEGIN_NAMESPACE
class QFileSystemWatcher;
class QHelpContentModel;
class QHelpContentWidget;
class QHelpIndexModel;
class QHelpIndexWidget;
class QHelpSearchEngine;
class QHelpFilterEngine;
class QHelpEngineCore;
enum {
ShowHomePage = 0,
ShowBlankPage = 1,
ShowLastPages = 2
};
class HelpEngineWrapperPrivate;
class TimeoutForwarder;
class HelpEngineWrapper : public QObject
{
Q_OBJECT
Q_DISABLE_COPY(HelpEngineWrapper)
friend class TimeoutForwarder;
public:
static HelpEngineWrapper &instance(const QString &collectionFile = QString());
static void removeInstance();
// Forwarded help engine member functions, possibly enriched.
QHelpSearchEngine *searchEngine() const;
QHelpContentModel *contentModel() const;
QHelpIndexModel *indexModel() const;
QHelpContentWidget *contentWidget();
QHelpIndexWidget *indexWidget();
bool setupData();
const QStringList registeredDocumentations() const;
QString documentationFileName(const QString &namespaceName) const;
const QString collectionFile() const;
bool registerDocumentation(const QString &docFile);
bool unregisterDocumentation(const QString &namespaceName);
QUrl findFile(const QUrl &url) const;
QByteArray fileData(const QUrl &url) const;
QList<QHelpLink> documentsForIdentifier(const QString &id) const;
QString error() const;
QHelpFilterEngine *filterEngine() const;
/*
* To be called after assistant has finished looking for new documentation.
* This will mainly cause the search index to be updated, if necessary.
*/
void initialDocSetupDone();
const QStringList qtDocInfo(const QString &component) const;
void setQtDocInfo(const QString &component, const QStringList &doc);
const QString homePage() const;
void setHomePage(const QString &page);
const QString defaultHomePage() const;
void setDefaultHomePage(const QString &page);
int lastTabPage() const;
void setLastTabPage(int lastPage);
// TODO: Don't allow last pages and zoom factors to be set in isolation
// Perhaps also fill up missing elements automatically or assert.
const QStringList lastShownPages() const;
void setLastShownPages(const QStringList &lastShownPages);
const QStringList lastZoomFactors() const;
void setLastZoomFactors(const QStringList &lastZoomFactors);
const QString cacheDir() const;
bool cacheDirIsRelativeToCollection() const;
void setCacheDir(const QString &cacheDir, bool relativeToCollection);
bool filterFunctionalityEnabled() const;
void setFilterFunctionalityEnabled(bool enabled);
bool filterToolbarVisible() const;
void setFilterToolbarVisible(bool visible);
bool addressBarEnabled() const;
void setAddressBarEnabled(bool enabled);
bool addressBarVisible() const;
void setAddressBarVisible(bool visible);
bool documentationManagerEnabled() const;
void setDocumentationManagerEnabled(bool enabled);
const QByteArray aboutMenuTexts() const;
void setAboutMenuTexts(const QByteArray &texts);
const QByteArray aboutTexts() const;
void setAboutTexts(const QByteArray &texts);
const QByteArray aboutIcon() const;
void setAboutIcon(const QByteArray &icon);
const QByteArray aboutImages() const;
void setAboutImages(const QByteArray &images);
const QString windowTitle() const;
void setWindowTitle(const QString &windowTitle);
const QByteArray applicationIcon() const;
void setApplicationIcon(const QByteArray &icon);
const QByteArray mainWindow() const;
void setMainWindow(const QByteArray &mainWindow);
const QByteArray mainWindowGeometry() const;
void setMainWindowGeometry(const QByteArray &geometry);
const QByteArray bookmarks() const;
void setBookmarks(const QByteArray &bookmarks);
int startOption() const;
void setStartOption(int option);
bool hasFontSettings() const;
bool usesAppFont() const;
void setUseAppFont(bool useAppFont);
bool usesBrowserFont() const;
void setUseBrowserFont(bool useBrowserFont);
const QFont appFont() const;
void setAppFont(const QFont &font);
QFontDatabase::WritingSystem appWritingSystem() const;
void setAppWritingSystem(QFontDatabase::WritingSystem system);
const QFont browserFont() const;
void setBrowserFont(const QFont &font);
QFontDatabase::WritingSystem browserWritingSystem() const;
void setBrowserWritingSystem(QFontDatabase::WritingSystem system);
bool showTabs() const;
void setShowTabs(bool show);
bool fullTextSearchFallbackEnabled() const;
const QByteArray topicChooserGeometry() const;
void setTopicChooserGeometry(const QByteArray &geometry);
QHelpEngineCore *helpEngine() const;
signals:
// For asynchronous doc updates triggered by external actions.
void documentationRemoved(const QString &namespaceName);
void documentationUpdated(const QString &namespaceName);
// Forwarded from QHelpEngineCore.
void setupFinished();
private:
HelpEngineWrapper(const QString &collectionFile);
~HelpEngineWrapper();
static HelpEngineWrapper *helpEngineWrapper;
HelpEngineWrapperPrivate *d;
};
QT_END_NAMESPACE
#endif // HELPENGINEWRAPPER_H
|
