blob: 13a30555c1276f13f2f16fb99d81d4197c0be59d (
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
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#pragma once
#include <coreplugin/helpmanager.h>
#include <QMetaType>
#include <QMutex>
#include <QObject>
#include <QUrl>
QT_BEGIN_NAMESPACE
class QHelpFilterEngine;
class QHelpEngine;
QT_END_NAMESPACE
class BookmarkManager;
namespace Help {
namespace Internal {
class HelpViewer;
struct HelpViewerFactory
{
QByteArray id;
QString displayName;
std::function<HelpViewer *()> create;
};
class LocalHelpManager : public QObject
{
Q_OBJECT
public:
struct HelpData {
QUrl resolvedUrl;
QByteArray data;
QString mimeType;
};
enum StartOption {
ShowHomePage = 0,
ShowBlankPage = 1,
ShowLastPages = 2,
};
LocalHelpManager(QObject *parent = nullptr);
~LocalHelpManager() override;
static LocalHelpManager *instance();
static QString defaultHomePage();
static QString homePage();
static void setHomePage(const QString &page);
static QFont fallbackFont();
static void setFallbackFont(const QFont &font);
static int fontZoom();
static int setFontZoom(int percentage);
static bool antialias();
static void setAntialias(bool on);
static StartOption startOption();
static void setStartOption(StartOption option);
static Core::HelpManager::HelpViewerLocation contextHelpOption();
static void setContextHelpOption(Core::HelpManager::HelpViewerLocation location);
static bool returnOnClose();
static void setReturnOnClose(bool returnOnClose);
static bool isScrollWheelZoomingEnabled();
static void setScrollWheelZoomingEnabled(bool enabled);
static QStringList lastShownPages();
static void setLastShownPages(const QStringList &pages);
static int lastSelectedTab();
static void setLastSelectedTab(int index);
static HelpViewerFactory defaultViewerBackend();
static QVector<HelpViewerFactory> viewerBackends();
static HelpViewerFactory viewerBackend();
static void setViewerBackendId(const QByteArray &id);
static QByteArray viewerBackendId();
static void setupGuiHelpEngine();
static void setEngineNeedsUpdate();
static QHelpEngine& helpEngine();
static BookmarkManager& bookmarkManager();
static QByteArray loadErrorMessage(const QUrl &url, const QString &errorString);
Q_INVOKABLE static Help::Internal::LocalHelpManager::HelpData helpData(const QUrl &url);
static QHelpFilterEngine *filterEngine();
static bool canOpenOnlineHelp(const QUrl &url);
static bool openOnlineHelp(const QUrl &url);
static bool isQtUrl(const QUrl &url);
static void openQtUrl(const QUrl &url);
static QMultiMap<QString, QUrl> linksForKeyword(const QString &keyword);
static void addOnlineHelpHandler(const Core::HelpManager::OnlineHelpHandler &handler);
signals:
void fallbackFontChanged(const QFont &font);
void fontZoomChanged(int percentage);
void antialiasChanged(bool on);
void returnOnCloseChanged();
void scrollWheelZoomingEnabledChanged(bool enabled);
void contextHelpOptionChanged(Core::HelpManager::HelpViewerLocation option);
private:
static bool m_guiNeedsSetup;
static bool m_needsCollectionFile;
static QMutex m_guiMutex;
static QHelpEngine *m_guiEngine;
static QMutex m_bkmarkMutex;
static BookmarkManager *m_bookmarkManager;
static QList<Core::HelpManager::OnlineHelpHandler> m_onlineHelpHandlerList;
};
} // Internal
} // Help
Q_DECLARE_METATYPE(Help::Internal::LocalHelpManager::HelpData)
|
