This documentation may contain snippets that were automatically
translated from C++ to Python. We always welcome contributions
to the snippet translation. If you see an issue with the
translation, you can also let us know by creating a ticket on
https:/bugreports.qt.io/projects/PYSIDE
This class extends QTextEdit (in read-only mode), adding some navigation functionality so that users can follow links in hypertext documents.
If you want to provide your users with an editable rich text editor, use QTextEdit . If you want a text browser without hypertext navigation use QTextEdit , and use setReadOnly() to disable editing. If you just need to display a small piece of rich text use QLabel .
The contents of QTextEdit are set with setHtml() or setPlainText() , but QTextBrowser also implements the setSource() function, making it possible to use a named document as the source text. The name is looked up in a list of search paths and in the directory of the current document factory.
If a document name ends with an anchor (for example, “#anchor"), the text browser automatically scrolls to that position (using scrollToAnchor() ). When the user clicks on a hyperlink, the browser will call setSource() itself with the link’s href value as argument. You can track the current source by connecting to the sourceChanged() signal.
QTextBrowser provides backward() and forward() slots which you can use to implement Back and Forward buttons. The home() slot sets the text to the very first document displayed. The anchorClicked() signal is emitted when the user clicks an anchor. To override the default navigation behavior of the browser, call the setSource() function to supply new document text in a slot connected to this signal.
If you want to load documents stored in the Qt resource system use qrc as the scheme in the URL to load. For example, for the document resource path :/docs/index.html use qrc:/docs/index.html as the URL with setSource() .
Specifies whether QTextBrowser should automatically open links to external sources using QDesktopServices::openUrl() instead of emitting the anchorClicked signal. Links are considered external if their scheme is neither file or qrc.
This property holds the name of the displayed document..
This is a an invalid url if no document is displayed or if the source is unknown.
When setting this property QTextBrowser tries to find a document with the specified name in the paths of the searchPaths property and directory of the current source, unless the value is an absolute file path. It also checks for optional anchors and scrolls the document accordingly
If the first tag in the document is <qttype=detail>, the document is displayed as a popup rather than as new document in the browser window itself. Otherwise, the document is displayed normally in the text browser with the text set to the contents of the named document with QTextDocument::setHtml() or QTextDocument::setMarkdown(), depending on whether the filename ends with any of the known Markdown file extensions.
If you would like to avoid automatic type detection and specify the type explicitly, call setSource() rather than setting this property.
This property holds the type of the displayed document.
This is QTextDocument::UnknownResource if no document is displayed or if the type of the source is unknown. Otherwise it holds the type that was detected, or the type that was specified when setSource() was called.
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.
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.
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.
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() .
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.
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.