Qt 4.8
qtextbrowser.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
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 Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/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 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
36 **
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 
49 
51 
52 QT_MODULE(Gui)
53 
54 #ifndef QT_NO_TEXTBROWSER
55 
57 
59 {
60  Q_OBJECT
61 
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  QStringList searchPaths;
67  bool openExternalLinks;
68  bool openLinks;
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 
137 
139 
140 #endif // QTEXTBROWSER_H
The QVariant class acts like a union for the most common Qt data types.
Definition: qvariant.h:92
The QKeyEvent class describes a key event.
Definition: qevent.h:224
int type
Definition: qmetatype.cpp:239
#define QT_END_NAMESPACE
This macro expands to.
Definition: qglobal.h:90
EventRef event
#define QT_MODULE(x)
Definition: qglobal.h:2783
#define QT_BEGIN_HEADER
Definition: qglobal.h:136
#define Q_GUI_EXPORT
Definition: qglobal.h:1450
The QWidget class is the base class of all user interface objects.
Definition: qwidget.h:150
#define Q_DISABLE_COPY(Class)
Disables the use of copy constructors and assignment operators for the given Class.
Definition: qglobal.h:2523
#define Q_PRIVATE_SLOT(d, signature)
Definition: qobjectdefs.h:73
#define Q_SLOTS
Definition: qobjectdefs.h:71
The QUrl class provides a convenient interface for working with URLs.
Definition: qurl.h:61
The QString class provides a Unicode character string.
Definition: qstring.h:83
#define Q_SIGNALS
Definition: qobjectdefs.h:72
QUrl source
the name of the displayed document.
Definition: qtextbrowser.h:62
#define QT_BEGIN_NAMESPACE
This macro expands to.
Definition: qglobal.h:89
#define Q_OVERRIDE(text)
Definition: qobjectdefs.h:83
const char * name
The QStringList class provides a list of strings.
Definition: qstringlist.h:66
#define Q_OBJECT
Definition: qobjectdefs.h:157
The QMouseEvent class contains parameters that describe a mouse event.
Definition: qevent.h:85
The QTextBrowser class provides a rich text browser with hypertext navigation.
Definition: qtextbrowser.h:58
#define Q_DECLARE_PRIVATE(Class)
Definition: qglobal.h:2467
The QPaintEvent class contains event parameters for paint events.
Definition: qevent.h:298
The QEvent class is the base class of all event classes.
Definition: qcoreevent.h:56
#define QT_END_HEADER
Definition: qglobal.h:137
The QFocusEvent class contains event parameters for widget focus events.
Definition: qevent.h:275
The QTextEdit class provides a widget that is used to edit and display both plain and rich text...
Definition: qtextedit.h:70
int open(const char *, int,...)