1 /**************************************************************************** 2 ** 3 ** Copyright (C) 2016 The Qt Company Ltd. 4 ** Contact: https://www.qt.io/licensing/ 5 ** 6 ** This file is part of the QtWidgets module of the Qt Toolkit. 7 ** 8 ** $QT_BEGIN_LICENSE:LGPL$ 9 ** Commercial License Usage 10 ** Licensees holding valid commercial Qt licenses may use this file in 11 ** accordance with the commercial license agreement provided with the 12 ** Software or, alternatively, in accordance with the terms contained in 13 ** a written agreement between you and The Qt Company. For licensing terms 14 ** and conditions see https://www.qt.io/terms-conditions. For further 15 ** information use the contact form at https://www.qt.io/contact-us. 16 ** 17 ** GNU Lesser General Public License Usage 18 ** Alternatively, this file may be used under the terms of the GNU Lesser 19 ** General Public License version 3 as published by the Free Software 20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the 21 ** packaging of this file. Please review the following information to 22 ** ensure the GNU Lesser General Public License version 3 requirements 23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. 24 ** 25 ** GNU General Public License Usage 26 ** Alternatively, this file may be used under the terms of the GNU 27 ** General Public License version 2.0 or (at your option) the GNU General 28 ** Public license version 3 or any later version approved by the KDE Free 29 ** Qt Foundation. The licenses are as published by the Free Software 30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 31 ** included in the packaging of this file. Please review the following 32 ** information to ensure the GNU General Public License requirements will 33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and 34 ** https://www.gnu.org/licenses/gpl-3.0.html. 35 ** 36 ** $QT_END_LICENSE$ 37 ** 38 ****************************************************************************/ 39 40 #ifndef QTEXTBROWSER_H 41 #define QTEXTBROWSER_H 42 43 #include <QtWidgets/qtwidgetsglobal.h> 44 #include <QtWidgets/qtextedit.h> 45 #include <QtCore/qurl.h> 46 47 QT_REQUIRE_CONFIG(textbrowser); 48 49 QT_BEGIN_NAMESPACE 50 51 class QTextBrowserPrivate; 52 53 class Q_WIDGETS_EXPORT QTextBrowser : public QTextEdit 54 { 55 Q_OBJECT 56 57 Q_PROPERTY(QUrl source READ source WRITE setSource) 58 Q_PROPERTY(QTextDocument::ResourceType sourceType READ sourceType) 59 Q_OVERRIDE(bool modified SCRIPTABLE false) 60 Q_OVERRIDE(bool readOnly DESIGNABLE false SCRIPTABLE false) 61 Q_OVERRIDE(bool undoRedoEnabled DESIGNABLE false SCRIPTABLE false) 62 Q_PROPERTY(QStringList searchPaths READ searchPaths WRITE setSearchPaths) 63 Q_PROPERTY(bool openExternalLinks READ openExternalLinks WRITE setOpenExternalLinks) 64 Q_PROPERTY(bool openLinks READ openLinks WRITE setOpenLinks) 65 66 public: 67 explicit QTextBrowser(QWidget* parent = nullptr); 68 virtual ~QTextBrowser(); 69 70 QUrl source() const; 71 QTextDocument::ResourceType sourceType() const; 72 73 QStringList searchPaths() const; 74 void setSearchPaths(const QStringList &paths); 75 76 virtual QVariant loadResource(int type, const QUrl &name) override; 77 78 bool isBackwardAvailable() const; 79 bool isForwardAvailable() const; 80 void clearHistory(); 81 QString historyTitle(int) const; 82 QUrl historyUrl(int) const; 83 int backwardHistoryCount() const; 84 int forwardHistoryCount() const; 85 86 bool openExternalLinks() const; 87 void setOpenExternalLinks(bool open); 88 89 bool openLinks() const; 90 void setOpenLinks(bool open); 91 92 public Q_SLOTS: 93 #if QT_VERSION < QT_VERSION_CHECK(6,0,0) 94 virtual void setSource(const QUrl &name); 95 void setSource(const QUrl &name, QTextDocument::ResourceType type); 96 #else 97 void setSource(const QUrl &name, QTextDocument::ResourceType type = QTextDocument::UnknownResource); 98 #endif 99 virtual void backward(); 100 virtual void forward(); 101 virtual void home(); 102 virtual void reload(); 103 104 Q_SIGNALS: 105 void backwardAvailable(bool); 106 void forwardAvailable(bool); 107 void historyChanged(); 108 void sourceChanged(const QUrl &); 109 void highlighted(const QUrl &); 110 #if QT_DEPRECATED_SINCE(5, 15) 111 QT_DEPRECATED_VERSION_X_5_15("Use QTextBrowser::highlighted(QUrl) instead") 112 void highlighted(const QString &); 113 #endif 114 void anchorClicked(const QUrl &); 115 116 protected: 117 bool event(QEvent *e) override; 118 virtual void keyPressEvent(QKeyEvent *ev) override; 119 virtual void mouseMoveEvent(QMouseEvent *ev) override; 120 virtual void mousePressEvent(QMouseEvent *ev) override; 121 virtual void mouseReleaseEvent(QMouseEvent *ev) override; 122 virtual void focusOutEvent(QFocusEvent *ev) override; 123 virtual bool focusNextPrevChild(bool next) override; 124 virtual void paintEvent(QPaintEvent *e) override; 125 #if QT_VERSION >= QT_VERSION_CHECK(6,0,0) 126 virtual 127 #endif 128 void doSetSource(const QUrl &name, QTextDocument::ResourceType type = QTextDocument::UnknownResource); 129 130 private: 131 Q_DISABLE_COPY(QTextBrowser) 132 Q_DECLARE_PRIVATE(QTextBrowser) 133 Q_PRIVATE_SLOT(d_func(), void _q_documentModified()) 134 Q_PRIVATE_SLOT(d_func(), void _q_activateAnchor(const QString &)) 135 Q_PRIVATE_SLOT(d_func(), void _q_highlightLink(const QString &)) 136 }; 137 138 QT_END_NAMESPACE 139 140 #endif // QTEXTBROWSER_H 141