aboutsummaryrefslogtreecommitdiffstats
path: root/src/libs/utils/markdownbrowser.h
blob: b36e9f650a2f23399a12ad26907bad7a8e07406c (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
// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0

#pragma once

#include "utils_global.h"

#include "filepath.h"

#include <QTextBrowser>
#include <QTextFragment>

QT_BEGIN_NAMESPACE
class QNetworkAccessManager;
class QNetworkRequest;
QT_END_NAMESPACE

namespace Utils {

class QTCREATOR_UTILS_EXPORT MarkdownBrowser : public QTextBrowser
{
    Q_OBJECT
public:
    using RequestHook = std::function<void (QNetworkRequest *)>;

    MarkdownBrowser(QWidget *parent = nullptr);

    void setMarkdown(const QString &markdown);
    QString toMarkdown() const;
    void setBasePath(const FilePath &filePath);
    void setAllowRemoteImages(bool allow);
    void setNetworkAccessManager(QNetworkAccessManager *nam);
    void setRequestHook(const RequestHook &hook);
    void setMaximumCacheSize(qsizetype maxSize);

    QSize sizeHint() const override;
    QSize minimumSizeHint() const override;

    void setMargins(const QMargins &margins);
    void setEnableCodeCopyButton(bool enable);

protected:
    void changeEvent(QEvent *event) override;
    void mousePressEvent(QMouseEvent *event) override;
    void mouseMoveEvent(QMouseEvent *event) override;

    QMimeData *createMimeDataFromSelection() const override;

private:
    void handleAnchorClicked(const QUrl &link);
    void postProcessDocument(bool firstTime);
    void highlightCodeBlock(const QString &language, QTextBlock &block);
    std::optional<std::pair<QTextFragment, QRectF>> findCopyButtonFragmentAt(const QPoint& viewportPos);

private:
    bool m_enableCodeCopyButton = false;
    std::optional<QRectF> m_cachedCopyRect;
};

} // namespace Utils