blob: 7b330ade309f2f203bbc801d958d75cfa1f8574c (
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
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** 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.
**
****************************************************************************/
#pragma once
#include <coreplugin/helpmanager.h>
#include <QMetaType>
#include <QMutex>
#include <QObject>
#include <QUrl>
#include <QStandardItemModel>
QT_FORWARD_DECLARE_CLASS(QHelpEngine)
class BookmarkManager;
namespace Help {
namespace Internal {
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 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 QList<float> lastShownPagesZoom();
static void setLastShownPagesZoom(const QList<qreal> &zoom);
static int lastSelectedTab();
static void setLastSelectedTab(int index);
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 QAbstractItemModel *filterModel();
static void setFilterIndex(int index);
static int filterIndex();
static void updateFilterModel();
signals:
void filterIndexChanged(int index);
void fallbackFontChanged(const QFont &font);
void returnOnCloseChanged();
void scrollWheelZoomingEnabledChanged(bool enabled);
private:
static bool m_guiNeedsSetup;
static bool m_needsCollectionFile;
static QStandardItemModel *m_filterModel;
static QString m_currentFilter;
static int m_currentFilterIndex;
static QMutex m_guiMutex;
static QHelpEngine *m_guiEngine;
static QMutex m_bkmarkMutex;
static BookmarkManager *m_bookmarkManager;
};
} // Internal
} // Help
Q_DECLARE_METATYPE(Help::Internal::LocalHelpManager::HelpData)
|
