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
|
/****************************************************************************
**
** 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 HELPVIEWER_H
#define HELPVIEWER_H
#include <QtCore/qglobal.h>
#include <QtCore/QString>
#include <QtCore/QUrl>
#include <QtCore/QVariant>
#include <QtWidgets/QAction>
#include <QtGui/QFont>
#if defined(BROWSER_QTWEBKIT)
# include <QWebView>
#elif defined(BROWSER_QTEXTBROWSER)
# include <QtWidgets/QTextBrowser>
#endif
QT_BEGIN_NAMESPACE
class HelpEngineWrapper;
#if defined(BROWSER_QTWEBKIT)
#define TEXTBROWSER_OVERRIDE
class HelpViewer : public QWebView
#elif defined(BROWSER_QTEXTBROWSER)
#define TEXTBROWSER_OVERRIDE override
class HelpViewer : public QTextBrowser
#endif
{
Q_OBJECT
class HelpViewerPrivate;
Q_DISABLE_COPY(HelpViewer)
public:
enum FindFlag {
FindBackward = 0x01,
FindCaseSensitively = 0x02
};
Q_DECLARE_FLAGS(FindFlags, FindFlag)
HelpViewer(qreal zoom, QWidget *parent = nullptr);
~HelpViewer() override;
QFont viewerFont() const;
void setViewerFont(const QFont &font);
void scaleUp();
void scaleDown();
void resetScale();
qreal scale() const;
QString title() const;
void setTitle(const QString &title);
QUrl source() const;
void setSource(const QUrl &url) TEXTBROWSER_OVERRIDE;
QString selectedText() const;
bool isForwardAvailable() const;
bool isBackwardAvailable() const;
bool findText(const QString &text, FindFlags flags, bool incremental,
bool fromSearch);
static const QString AboutBlank;
static const QString LocalHelpFile;
static const QString PageNotFoundMessage;
static bool isLocalUrl(const QUrl &url);
static bool canOpenPage(const QString &url);
static QString mimeFromUrl(const QUrl &url);
static bool launchWithExternalApp(const QUrl &url);
public slots:
#ifndef QT_NO_CLIPBOARD
void copy();
#endif
void home() TEXTBROWSER_OVERRIDE;
void forward() TEXTBROWSER_OVERRIDE;
void backward() TEXTBROWSER_OVERRIDE;
signals:
void titleChanged();
#if !defined(BROWSER_QTEXTBROWSER)
// Provide signals present in QTextBrowser, QTextEdit for browsers that do not inherit QTextBrowser
void copyAvailable(bool yes);
void sourceChanged(const QUrl &url);
void forwardAvailable(bool enabled);
void backwardAvailable(bool enabled);
void highlighted(const QUrl &link);
void printRequested();
#elif !defined(BROWSER_QTWEBKIT)
// Provide signals present in QWebView for browsers that do not inherit QWebView
void loadStarted();
void loadFinished(bool finished);
#endif
protected:
void keyPressEvent(QKeyEvent *e) override;
void wheelEvent(QWheelEvent *event) override;
void mousePressEvent(QMouseEvent *event) override;
void mouseReleaseEvent(QMouseEvent *event) override;
private slots:
void actionChanged();
void setLoadStarted();
void setLoadFinished(bool ok);
private:
bool eventFilter(QObject *obj, QEvent *event) override;
void contextMenuEvent(QContextMenuEvent *event) override;
QVariant loadResource(int type, const QUrl &name) TEXTBROWSER_OVERRIDE;
bool handleForwardBackwardMouseButtons(QMouseEvent *e);
private:
HelpViewerPrivate *d;
};
QT_END_NAMESPACE
Q_DECLARE_METATYPE(HelpViewer*)
#endif // HELPVIEWER_H
|
