blob: 1b4be734cdb7bf0c0275d81c4185c16ac86e0b0d (
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
|
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://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 http://www.qt.io/terms-conditions. For further information
** use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
#ifndef LOCALHELPMANAGER_H
#define LOCALHELPMANAGER_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;
};
LocalHelpManager(QObject *parent = 0);
~LocalHelpManager();
static LocalHelpManager *instance();
static QString defaultHomePage();
static QString homePage();
static void setHomePage(const QString &page);
void setupGuiHelpEngine();
void setEngineNeedsUpdate();
static QHelpEngine& helpEngine();
static BookmarkManager& bookmarkManager();
static QVariant engineFontSettings();
static bool isValidUrl(const QString &link);
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);
private:
bool m_guiNeedsSetup;
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)
#endif // LOCALHELPMANAGER_H
|
