QTextBrowser Class

Member Function Documentation

QTextBrowser::QTextBrowser(QWidget *parent = nullptr)

Constructs an empty QTextBrowser with parent parent.

[signal] void QTextBrowser::anchorClicked(const QUrl &link)

This signal is emitted when the user clicks an anchor. The URL referred to by the anchor is passed in link.

Note that the browser will automatically handle navigation to the location specified by link unless the openLinks property is set to false or you call setSource() in a slot connected. This mechanism is used to override the default navigation features of the browser.

[virtual slot] void QTextBrowser::backward()

Changes the document displayed to the previous document in the list of documents built by navigating links. Does nothing if there is no previous document.

See also forward() and backwardAvailable().

[signal] void QTextBrowser::backwardAvailable(bool available)

This signal is emitted when the availability of backward() changes. available is false when the user is at home(); otherwise it is true.

[virtual slot] void QTextBrowser::forward()

Changes the document displayed to the next document in the list of documents built by navigating links. Does nothing if there is no next document.

See also backward() and forwardAvailable().

[signal] void QTextBrowser::forwardAvailable(bool available)

This signal is emitted when the availability of forward() changes. available is true after the user navigates backward() and false when the user navigates or goes forward().

[signal] void QTextBrowser::highlighted(const QUrl &link)

This signal is emitted when the user has selected but not activated an anchor in the document. The URL referred to by the anchor is passed in link.

Note: Signal highlighted is overloaded in this class. To connect to this signal by using the function pointer syntax, Qt provides a convenient helper for obtaining the function pointer as shown in this example:

connect(textBrowser, QOverload<const QUrl &>::of(&QTextBrowser::highlighted),
    [=](const QUrl &link){ /* ... */ });

[signal] void QTextBrowser::historyChanged()

This signal is emitted when the history changes.

This function was introduced in Qt 4.4.

See also historyTitle() and historyUrl().

[virtual slot] void QTextBrowser::home()

Changes the document displayed to be the first document from the history.

[virtual slot] void QTextBrowser::reload()

Reloads the current set source.

[slot] void QTextBrowser::setSource(const QUrl &url, QTextDocument::ResourceType type)

Attempts to load the document at the given url with the specified type.

If type is UnknownResource (the default), the document type will be detected: that is, if the url ends with an extension of .md, .mkd or .markdown, the document will be loaded via QTextDocument::setMarkdown(); otherwise it will be loaded via QTextDocument::setHtml(). This detection can be bypassed by specifying the type explicitly.

Note: Setter function for property source.

[signal] void QTextBrowser::sourceChanged(const QUrl &src)

This signal is emitted when the source has changed, src being the new source.

Source changes happen both programmatically when calling setSource(), forward(), backward() or home() or when the user clicks on links or presses the equivalent key sequences.

int QTextBrowser::backwardHistoryCount() const

Returns the number of locations backward in the history.

This function was introduced in Qt 4.4.

void QTextBrowser::clearHistory()

Clears the history of visited documents and disables the forward and backward navigation.

This function was introduced in Qt 4.2.

See also backward() and forward().

[protected] void QTextBrowser::doSetSource(const QUrl &url, QTextDocument::ResourceType type = QTextDocument::UnknownResource)

Attempts to load the document at the given url with the specified type.

setSource() calls doSetSource. In Qt 5, setSource(const QUrl &url) was virtual. In Qt 6, doSetSource() is virtual instead, so that it can be overridden in subclasses.

[override virtual protected] bool QTextBrowser::event(QEvent *e)

Reimplements: QAbstractScrollArea::event(QEvent *event).

[override virtual protected] bool QTextBrowser::focusNextPrevChild(bool next)

Reimplements: QTextEdit::focusNextPrevChild(bool next).

[override virtual protected] void QTextBrowser::focusOutEvent(QFocusEvent *ev)

Reimplements: QTextEdit::focusOutEvent(QFocusEvent *e).

int QTextBrowser::forwardHistoryCount() const

Returns the number of locations forward in the history.

This function was introduced in Qt 4.4.

QString QTextBrowser::historyTitle(int i) const

Returns the documentTitle() of the HistoryItem.

backaction.setToolTip(browser.historyTitle(-1));
forwardaction.setToolTip(browser.historyTitle(+1));

This function was introduced in Qt 4.4.

QUrl QTextBrowser::historyUrl(int i) const

Returns the url of the HistoryItem.

This function was introduced in Qt 4.4.

bool QTextBrowser::isBackwardAvailable() const

Returns true if the text browser can go backward in the document history using backward().

This function was introduced in Qt 4.2.

See also backwardAvailable() and backward().

bool QTextBrowser::isForwardAvailable() const

Returns true if the text browser can go forward in the document history using forward().

This function was introduced in Qt 4.2.

See also forwardAvailable() and forward().

[override virtual protected] void QTextBrowser::keyPressEvent(QKeyEvent *ev)

Reimplements: QTextEdit::keyPressEvent(QKeyEvent *e).

The event ev is used to provide the following keyboard shortcuts:

[override virtual] QVariant QTextBrowser::loadResource(int type, const QUrl &name)

Reimplements: QTextEdit::loadResource(int type, const QUrl &name).

This function is called when the document is loaded and for each image in the document. The type indicates the type of resource to be loaded. An invalid QVariant is returned if the resource cannot be loaded.

The default implementation ignores type and tries to locate the resources by interpreting name as a file name. If it is not an absolute path it tries to find the file in the paths of the searchPaths property and in the same directory as the current source. On success, the result is a QVariant that stores a QByteArray with the contents of the file.

If you reimplement this function, you can return other QVariant types. The table below shows which variant types are supported depending on the resource type:

[override virtual protected] void QTextBrowser::mouseMoveEvent(QMouseEvent *e)

Reimplements: QTextEdit::mouseMoveEvent(QMouseEvent *e).

[override virtual protected] void QTextBrowser::mousePressEvent(QMouseEvent *e)

Reimplements: QTextEdit::mousePressEvent(QMouseEvent *e).

[override virtual protected] void QTextBrowser::mouseReleaseEvent(QMouseEvent *e)

Reimplements: QTextEdit::mouseReleaseEvent(QMouseEvent *e).

[override virtual protected] void QTextBrowser::paintEvent(QPaintEvent *e)

Reimplements: QTextEdit::paintEvent(QPaintEvent *event).