blob: d26c1a9f51fda13f7b128645a93167140f0de010 (
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
|
/****************************************************************************
**
** 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/find/textfindconstants.h>
#include <QFont>
#include <QMenu>
#include <QPrinter>
#include <QString>
#include <QUrl>
#include <QWidget>
namespace Help {
namespace Internal {
class HelpViewer : public QWidget
{
Q_OBJECT
public:
enum class Action {
NewPage = 0x01,
ExternalWindow = 0x02
};
Q_DECLARE_FLAGS(Actions, Action)
explicit HelpViewer(QWidget *parent = nullptr);
~HelpViewer() override;
virtual QFont viewerFont() const = 0;
virtual void setViewerFont(const QFont &font) = 0;
virtual qreal scale() const = 0;
virtual void setScale(qreal scale) = 0;
virtual QString title() const = 0;
virtual QUrl source() const = 0;
// metacall in HelpPlugin::updateSideBarSource
Q_INVOKABLE virtual void setSource(const QUrl &url) = 0;
virtual void highlightId(const QString &id) { Q_UNUSED(id) }
virtual void setHtml(const QString &html) = 0;
virtual QString selectedText() const = 0;
virtual bool isForwardAvailable() const = 0;
virtual bool isBackwardAvailable() const = 0;
virtual void addBackHistoryItems(QMenu *backMenu) = 0;
virtual void addForwardHistoryItems(QMenu *forwardMenu) = 0;
void setActionVisible(Action action, bool visible);
bool isActionVisible(Action action);
virtual bool findText(const QString &text, Core::FindFlags flags,
bool incremental, bool fromSearch, bool *wrapped = nullptr) = 0;
bool handleForwardBackwardMouseButtons(QMouseEvent *e);
static bool isLocalUrl(const QUrl &url);
static bool canOpenPage(const QString &url);
static QString mimeFromUrl(const QUrl &url);
static bool launchWithExternalApp(const QUrl &url);
void home();
virtual void scaleUp() = 0;
virtual void scaleDown() = 0;
virtual void resetScale() = 0;
virtual void copy() = 0;
virtual void stop() = 0;
virtual void forward() = 0;
virtual void backward() = 0;
virtual void print(QPrinter *printer) = 0;
signals:
void sourceChanged(const QUrl &);
void titleChanged();
void printRequested();
void forwardAvailable(bool);
void backwardAvailable(bool);
void loadFinished();
void newPageRequested(const QUrl &url);
void externalPageRequested(const QUrl &url);
protected:
void slotLoadStarted();
void slotLoadFinished();
void restoreOverrideCursor();
Actions m_visibleActions = 0;
int m_loadOverrideStack = 0;
};
} // namespace Internal
} // namespace Help
|
