1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the QtGui 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 http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://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 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file. Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #ifndef QTEXTBROWSER_H
43 #define QTEXTBROWSER_H
44
45 #include <QtGui/qtextedit.h>
46 #include <QtCore/qurl.h>
47
48 QT_BEGIN_HEADER
49
50 QT_BEGIN_NAMESPACE
51
QT_MODULE(Gui)52 QT_MODULE(Gui)
53
54 #ifndef QT_NO_TEXTBROWSER
55
56 class QTextBrowserPrivate;
57
58 class Q_GUI_EXPORT QTextBrowser : public QTextEdit
59 {
60 Q_OBJECT
61
62 Q_PROPERTY(QUrl source READ source WRITE setSource)
63 Q_OVERRIDE(bool modified SCRIPTABLE false)
64 Q_OVERRIDE(bool readOnly DESIGNABLE false SCRIPTABLE false)
65 Q_OVERRIDE(bool undoRedoEnabled DESIGNABLE false SCRIPTABLE false)
66 Q_PROPERTY(QStringList searchPaths READ searchPaths WRITE setSearchPaths)
67 Q_PROPERTY(bool openExternalLinks READ openExternalLinks WRITE setOpenExternalLinks)
68 Q_PROPERTY(bool openLinks READ openLinks WRITE setOpenLinks)
69
70 public:
71 explicit QTextBrowser(QWidget* parent = 0);
72 virtual ~QTextBrowser();
73
74 QUrl source() const;
75
76 QStringList searchPaths() const;
77 void setSearchPaths(const QStringList &paths);
78
79 virtual QVariant loadResource(int type, const QUrl &name);
80
81 bool isBackwardAvailable() const;
82 bool isForwardAvailable() const;
83 void clearHistory();
84 QString historyTitle(int) const;
85 QUrl historyUrl(int) const;
86 int backwardHistoryCount() const;
87 int forwardHistoryCount() const;
88
89 bool openExternalLinks() const;
90 void setOpenExternalLinks(bool open);
91
92 bool openLinks() const;
93 void setOpenLinks(bool open);
94
95 public Q_SLOTS:
96 virtual void setSource(const QUrl &name);
97 virtual void backward();
98 virtual void forward();
99 virtual void home();
100 virtual void reload();
101
102 Q_SIGNALS:
103 void backwardAvailable(bool);
104 void forwardAvailable(bool);
105 void historyChanged();
106 void sourceChanged(const QUrl &);
107 void highlighted(const QUrl &);
108 void highlighted(const QString &);
109 void anchorClicked(const QUrl &);
110
111 protected:
112 bool event(QEvent *e);
113 virtual void keyPressEvent(QKeyEvent *ev);
114 virtual void mouseMoveEvent(QMouseEvent *ev);
115 virtual void mousePressEvent(QMouseEvent *ev);
116 virtual void mouseReleaseEvent(QMouseEvent *ev);
117 virtual void focusOutEvent(QFocusEvent *ev);
118 virtual bool focusNextPrevChild(bool next);
119 virtual void paintEvent(QPaintEvent *e);
120
121 #if defined(QT3_SUPPORT)
122 public:
123 QT3_SUPPORT_CONSTRUCTOR QTextBrowser(QWidget *parent, const char *name);
124 #endif
125
126 private:
127 Q_DISABLE_COPY(QTextBrowser)
128 Q_DECLARE_PRIVATE(QTextBrowser)
129 Q_PRIVATE_SLOT(d_func(), void _q_documentModified())
130 Q_PRIVATE_SLOT(d_func(), void _q_activateAnchor(const QString &))
131 Q_PRIVATE_SLOT(d_func(), void _q_highlightLink(const QString &))
132 };
133
134 #endif // QT_NO_TEXTBROWSER
135
136 QT_END_NAMESPACE
137
138 QT_END_HEADER
139
140 #endif // QTEXTBROWSER_H
141